Elements and Sections in the Process Administration Transition States XML Output File

The following table describes the elements and sections in the process administration transition states XML output file.

Table Elements and Sections in the Process Administration Transition States XML File

Description Element or Section

The <TransitionState> section contains all of the information for one transition state.

<data:TransitionState>
. . .
</data:TransitionState>

<RecordType> contains the system name of the record type (object), which never changes. This element is read-only and is ignored for upsert requests.

<data:TransitionState>
  <data:RecordType>Activity</data:RecordType>
. . .
</data:TransitionState>

<ProcessName> contains the name given to the process. This element is read-only and is ignored for upsert requests.

<data:TransitionState>
. . .
  <data:ProcessName>Activity Process
  </data:ProcessName>
. . .
</data:TransitionState>

<State> contains the transition field value that identifies the transition state. Each transition field value can be used with only one transition state in a process. For upsert operations, the value in the <State> element must match an existing picklist value in the Status field for the record type.

<data:TransitionState>
. . .
  <data:State>Deferred</data:State>
. . .
</data:TransitionState>

<Category> contains the name of the sales category that the transition state is associated with.

<data:TransitionState>
. . .
  <data:Category>Software</data:Category>
. . .
</data:TransitionState>

<Description> contains a description of the transition state.

<data:TransitionState>
. . .
  <data:Description>Test
      </data:Description>
. . .
</data:TransitionState>

<Condition> contains a condition that determines whether a record can move to the transition state.

Note: Do not use any calculated fields in the expression. Calculated fields are not supported in expressions in the Condition field on transition states.
<data:TransitionState>
. . .
  <data:Condition>[{Priority}]="3-Low"
      </data:Condition>
. . .
</data:TransitionState>

<ErrorMessage> contains the text for the error message that appears if the condition that is set up for the transition state is not met when a user tries to move a record of the record type specified in the process to the transition state.

<data:TransitionState>
. . .
      <data:ErrorMessage>
      </data:ErrorMessage>
. . .
</data:TransitionState>

<DisableUpdate> determines whether a record can be updated when the record is in this state (false). If this element is set to true, then users, including external applications, cannot update records of the record type specified in the process when the records are in the transition state.

<data:TransitionState>
. . .
  <data:DisableUpdate>true
  </data:DisableUpdate>
. . .
</data:TransitionState>

<DisableDeleteOrRemove> determines whether a record can be deleted when the record is in this state (false). If this element is set to true, then users, including external applications, cannot delete records of the record type specified in the process while the records are in the transition state.

<data:TransitionState>
. . .
  <data:DisableDeleteOrRemove>true
  </data:DisableDeleteOrRemove>
</data:TransitionState>

The <ListofFieldSetup> section contains details of the field configuration for the transition state.

<data:TransitionState>
. . .
  <data:ListofFieldSetup>
. . .
  </data:ListofFieldSetup>
</data:TransitionState>

The <FieldSetup> section contains details of the configuration for a single field.

<data:TransitionState>
. . .
  <data:ListofFieldSetup>
    <data:FieldSetup>
. . .
    </data:FieldSetup
  </data:ListofFieldSetup>
</data:TransitionState>

<FieldName> contains the system name of the field, which never changes.

<data:TransitionState>
. . .
  <data:ListofFieldSetup>
    <data:FieldSetup>
      <data:FieldName>Account Name
      </data:Fieldname>
. . .
    </data:FieldSetup
  </data:ListofFieldSetup>
</data:TransitionState>

<ReadOnly> determines if the field becomes read-only (true) or does not become read-only (false) when the record is in this transition state.

<data:TransitionState>
. . .
  <data:ListofFieldSetup>
    <data:FieldSetup>
. . .
      <data:ReadOnly>true
      </data:ReadOnly>
    </data:FieldSetup
  </data:ListofFieldSetup>
</data:TransitionState>

The <ListofRelatedAccessControl> section contains details of the access controls that are configured on the transition state for the related record types.

<data:TransitionState>
. . .
  <data:ListofRelatedAccessControl>
. . .
  </data:ListofRelatedAccessControl>
</data:TransitionState>

The <RelatedAccessControl> section contains details of the access controls for a single related record type.

<data:TransitionState>
. . .
  <data:ListofRelatedAccessControl>
    <data:RelatedAccessControl>
. . .
    </data:RelatedAccessControl>
  </data:ListofRelatedAccessControl>
</data:TransitionState>

<RecordType> contains the access object name of the related record type.

For information about access object names and their corresponding display names, see Access Objects.

<data:TransitionState>
. . .
  <data:ListofRelatedAccessControl>
    <data:RelatedAccessControl>
      <data:RecordType>Activity Book
      </data:RecordType>
. . .
    </data:RelatedAccessControl>
  </data:ListofRelatedAccessControl>
</data:TransitionState>

<DisableCreateOrAdd> determines whether new or existing records of the specified related record type can be linked to the parent record while the parent record is in this transition state (false). If this element is set to true, then users, including external applications, cannot link existing records of the specified related record type or add new records of that type to the parent record while the parent record is in this state.

<data:TransitionState>
. . .
  <data:ListofRelatedAccessControl>
    <data:RelatedAccessControl>
. . .
      <data:DisableCreateOrAdd>true
      </data:DisableCreateOrAdd>
. . .
    </data:RelatedAccessControl>
  </data:ListofRelatedAccessControl>
</data:TransitionState>

<DisableUpdate> determines whether a record of the specified related record type that is linked to a parent record can be udpdated while the parent record is in this transition state (false). If this element is set to true, then users, including external applications, cannot update records of the specified related record type that are linked to the parent record while the parent record is in this state

<data:TransitionState>
. . .
  <data:ListofRelatedAccessControl>
    <data:RelatedAccessControl>
. . .
      <data:DisableUpdate>true
      </data:DisableUpdate>
. . .
    </data:RelatedAccessControl>
  </data:ListofRelatedAccessControl>
</data:TransitionState>

<DisableDeleteOrRemove> determines whether a related record can be deleted or unlinked from the parent record when the parent record is in this state (false). If this element is set to true, then users, including external applications, cannot delete records of the specified related record type while the parent record is in this state.

<data:TransitionState>
. . .
  <data:ListofRelatedAccessControl>
    <data:RelatedAccessControl>
. . .
      <data:DisableDeleteOrRemove>false
      </data:DisableDeleteOrRemove>
    </data:RelatedAccessControl>
  </data:ListofRelatedAccessControl>
</data:TransitionState>