Documentation Center

Admin.XMLInboxConfiguration.xml

The file Admin.XMLInboxConfiguration.xml is used to configure the inbox definitions and the actions that can be executed on those inboxes.

Changelog

File versionContent Manager versionNotes
1.010.0.0n/a

Overview

This configuration file is accessible from the Content Manager web client, select Settings > XML Inbox Settings

XML elements

The Admin.XMLInboxConfiguration.xml contains the root element InboxDefinitions.

Within InboxDefinitions the XML elements configure the following:

<Actions>
The actions specify which ToStatus must be set for the items in the inbox.
  • Each action is identified by an id containing a label.
  • The ToStatus is configured using the element name of the status
<Actions>
   <Action id="Change2ToBeReviewed">
      <ToStatus ref="VSTATUSTOBEREVIEWED" />
   </Action>
   <Action id="Change2Released">
      <ToStatus ref="VSTATUSRELEASED" />
   </Action>
   ...
 </Actions>
<Inbox>
The Inbox which is identified by a name specifies the following:
  • Which users can see the inbox via the userrole
  • Which objects are part of the inbox via InboxQuery
  • Which actions can be executed via the Buttons
<Inbox name="Reviewer" userrole="Reviewer">
  <InboxQuery>
    <UserRelation field="FREVIEWER" operator="equal" value="$ME" />
    <MetaDataCondition>
      <CardType value="CTMASTERL" />
      <CardType value="CTMAPL" />
      <CardType value="CTLIBL" />
      <CardType value="CTIMGL" />
      <ISHField ref="FSTATUS" operator="equal" value="VSTATUSTOBEREVIEWED" valueoption="isrcElement" />
    </MetaDataCondition>
  </InboxQuery>
  <Buttons>
    <Button label="Release documents" action="Change2Released" />
    <Button label="Send documents back to author" action="Back2Draft" />
  </Buttons>
</Inbox>
InboxQuery
NameDescription
UserRelationOptional element that can be used to filter the users that can access the inbox to the users which are specified in the specified field.
MetaDataConditionRequired element which generates the metadata filter
MetaDataCondition\CardType

The CardType element specifying the element name of the type of the objects that must be part of the inbox

The possible values are:
  • CTMASTERL
  • CTMAPL
  • CTIMGL
  • CTLIBL
  • CTTEMPLATEL
MetaDataCondition\ISHField

The ISHField element specifying the metadata filter

MetaDataCondition\ISHField\@refThe element name of the field
MetaDataCondition\ISHField\@operatorThe operator used for the value specified:
  • in
  • notin
  • equal
  • notequal
  • lessthan
  • greaterthan
  • lessthanorequal
  • greaterthanorequal
MetaDataCondition\ISHField\@valueThe value
MetaDataCondition\ISHField\@valueoptionOptional attribute which can be used to indicate that the specified value is the element name of a LovValue (e.g. status)

<infoSharePluginConfig version="2.0">
  <!--We are supporting plugins with namespaces.-->
  <namespaces>
    <namespace prefix="ditaarch">http://dita.oasis-open.org/architecture/2005/</namespace>
  </namespaces>
  <!--Every 'write' element defines a set of plugins which will run for create, update or checkin of an object.-->
  <write ishcondition="ISHType in ('ISHMasterDoc', 'ISHModule', 'ISHLibrary')">
    <!--'Body' plugins run as a part of a main action (in the same transaction).-->
    <body>
      <!--Sequence of plugins, meaning they run in sequence.-->
      <sequence>
        <!-- ======================================================= -->
        <plugin name="CHECKREVIEWERFILLEDIN" handler="OnFieldChangeCompare" ishcondition="ISHLevel='lng'">
          <description>Checks that the 'Reviewer' is filled in when the 'FSTATUS' field is changed to 'To be Reviewed'</description>
          <workingset>
            <ishfields>
              <ishfield name="FSTATUS" level="lng" />
              <ishfield name="FREVIEWER" level="lng" />
            </ishfields>
          </workingset>
          <initialize>
            <parameters>
              <parameter name="ConditionMetadataField">FSTATUS</parameter>
              <parameter name="ConditionMetadataFieldLevel">lng</parameter>
              <parameter name="ConditionMetadataFieldValueType">element</parameter>
              <parameter name="ConditionMetadataFieldToValue">VSTATUSTOBEREVIEWED</parameter>
              <parameter name="CompareMetadataField">FREVIEWER</parameter>
              <parameter name="CompareMetadataFieldLevel">lng</parameter>
              <parameter name="CompareMetadataFieldOperator">notempty</parameter>
            </parameters>
          </initialize>
        </plugin>
...
      </sequence>
    </body>
  </write>
</infoSharePluginConfig>

Example

<InfoShareInbox version="1.0">
  <InboxDefinitions>
    <Actions>
      <Action id="Change2ToBeReviewed">
        <ToStatus ref="VSTATUSTOBEREVIEWED" />
      </Action>
      ...
    </Actions>
    <Inbox name="Reviewer" userrole="Reviewer">
      <InboxQuery>
        <UserRelation field="FREVIEWER" operator="equal" value="$ME" />
        <MetaDataCondition>
          <CardType value="CTMASTERL" />
          <CardType value="CTMAPL" />
          <CardType value="CTLIBL" />
          <CardType value="CTIMGL" />
          <ISHField ref="FSTATUS" operator="equal" value="VSTATUSTOBEREVIEWED" valueoption="isrcElement" />
        </MetaDataCondition>
      </InboxQuery>
      <Buttons>
        <Button label="Release documents" action="Change2Released" />
        <Button label="Send documents back to author" action="Back2Draft" />
      </Buttons>
    </Inbox>
    ...
  </InboxDefinitions>
</InfoShareInbox>