Documentation Center

Admin.XMLInboxConfiguration.xml

The file Admin.XMLInboxConfiguration.xml is used to configure the inbox definitions.

Changelog

File versionContent Manager versionNotes
1.010.0.0n/a
2.015.0.0New inbox configuration XML structure is implemented. Buttons, Actions were removed.

Overview

Since release 15.0 the configuration file is accessible from the Content Manager Organize Space, select Settings > XML Settings > Inboxes.

XML elements

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

inboxDefinitions consists of the list of inbox XML elements.

<inbox>
The Inbox which is identified by a name and ID specifies the following:
  • Which users can see the inbox via the userrole
  • Which objects are part of the inbox via inboxQuery
  • Which statuses possible to set for the items in the inbox via the toStatuses. Section toStatuses is optional.
<inbox name="Reviewer" id="REVIEWER" userrole="Reviewer">
  <inboxQuery>
    <typeFilter>
      <ishType>ISHMasterDoc</ishType>
      <ishType>ISHModule</ishType>
      <ishType>ISHLibrary</ishType>
      <ishType>ISHIllustration</ishType>
    </typeFilter>
    <metadataFilter>
      <ishfield name="FSTATUS" level="lng" ishoperator="equal" ishvaluetype="element">VSTATUSTOBEREVIEWED</ishfield>
      <ishfield name="FREVIEWER" level="lng" ishoperator="equal">$ME</ishfield>
    </metadataFilter>
  </inboxQuery>
  <toStatuses>
    <toStatus ref="VSTATUSRELEASED" label="Release documents" />
    <toStatus ref="VSTATUSDRAFT" label="Send documents back to author" />
  </toStatuses>
</inbox>

inboxQuery
NameDescription
typeFilterRequired element which generates the InfoShare type filter.
typeFilter\ishType

The ishType element specifies the type of the objects that must be part of the inbox.

The possible values are:
  • ISHMasterDoc
  • ISHModule
  • ISHIllustration
  • ISHLibrary
  • ISHTemplate
metadataFilterRequired element which generates the metadata filter.
metadataFilter\ishfield

The ishfield element specifying the metadata filter.

metadataFilter\ishfield\@nameThe element name of the field.
metadataFilter\ishfield\@levelLevel of the field :
  • logical
  • version
  • lng
metadataFilter\ishfield\@operatorThe operator used for the value specified:
  • in
  • notin
  • equal
  • notequal
  • lessthan
  • greaterthan
  • lessthanorequal
  • greaterthanorequal
metadataFilter\ishfield\@valueThe value. If there are several values, value separator is a comma-space.
Example with multi values:
<ishfield name="FSTATUS" level="lng" ishoperator="in" ishvaluetype="element">VSTATUSTRANSLATIONINREVIEW, VSTATUSTRANSLATED</ishfield>
metadataFilter\ishfield\@ishvaluetypeOptional attribute which can be used to indicate that the specified value is the element name of a LovValue (e.g. status).
The possible values are:
  • value
  • element
  • id

<inboxQuery>
  <typeFilter>
    <ishType>ISHMasterDoc</ishType>
    <ishType>ISHModule</ishType>
    <ishType>ISHLibrary</ishType>
    <ishType>ISHIllustration</ishType>
  </typeFilter>
  <metadataFilter>
    <ishfield name="FSTATUS" level="lng" ishoperator="equal" ishvaluetype="element">VSTATUSTOBEREVIEWED</ishfield>
    <ishfield name="FREVIEWER" level="lng" ishoperator="equal">$ME</ishfield>
  </metadataFilter>
</inboxQuery>
<toStatuses>
toStatuses
NameDescription
toStatusSpecify which status must be set for the items in the inbox.
toStatus\@refElement name of an existing status.
toStatus\@labelLabel of the status for the UI. This label does not need to match the label of an existing status.

<toStatuses>
  <toStatus ref="VSTATUSRELEASED" label="Release documents" />
  <toStatus ref="VSTATUSDRAFT" label="Send documents back to author" />
</toStatuses>

Example

<infoShareInboxConfig version="2.0">
  <inboxDefinitions>
    <inbox name="Reviewer" id="REVIEWER" userrole="Reviewer">
      <inboxQuery>
        <typeFilter>
          <ishType>ISHMasterDoc</ishType>
          <ishType>ISHModule</ishType>
          <ishType>ISHLibrary</ishType>
          <ishType>ISHIllustration</ishType>
        </typeFilter>
        <metadataFilter>
          <ishfield name="FSTATUS" level="lng" ishoperator="equal" ishvaluetype="element">VSTATUSTOBEREVIEWED</ishfield>
          <ishfield name="FREVIEWER" level="lng" ishoperator="equal">$ME</ishfield>
        </metadataFilter>
      </inboxQuery>
      <toStatuses>
        <toStatus ref="VSTATUSRELEASED" label="Release documents" />
        <toStatus ref="VSTATUSDRAFT" label="Send documents back to author" />
      </toStatuses>
    </inbox>
   ...
  </inboxDefinitions>
</infoShareInboxConfig>