Elements and Sections in the Process Administration XML Output File

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

Table Elements and Sections in the Process Administration XML File

Description Element or Section

The <Process> section contains all of the information for one process.

<data:Process>
. . .
</data:Process>

<RecordType> contains the system name of the record type (object), which never changes.

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

<ProcessName> contains the name given to the process.

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

<PrimaryField> contains the name of the field in the record type that is to be used as a filter to restrict the process to certain records of the record type.

Only the Activity record type supports the use of a primary field to restrict the process.

<data:Process>
. . .
  <data:PrimaryField>Category
  </data:PrimaryField>
. . .
</data:Process>

<TransitionField> contains the name of the field in the record type that determines the transition of records from one transition state to another.

The Status field must be used as the transition field for all supported record types.

<data:Process>
. . .
  <data:TransitionField>Status
  </data:TransitionField>
. . .
</data:Process>

<Description> contains the description of the process.

<data:Process>
. . .
  <data:Description>This is a test process.
  </data:Description>
. . .
</data:Process>

<Order> indicates the order of this process within the processes for the record type. The Order field is set to 1 by default, and you cannot update the field to a different value.

Note: If you specify an invalid value, such as a non-numeric string, for this element when you insert or update a process, then an error is returned.
<data:Process>
. . .
  <data:Order>1</data:Order>
. . .
</data:Process>

<Default> indicates if the process is the default process for the record type (true). The Default field is set to true by default, and you cannot update the field value to false.

<data:Process>
. . .
  <data:Default>true</data:Default>
. . .
</data:Process>

The <ListOfPrimaryValues> section contains the values in the primary field that are valid for the process. A record will be locked by the process only if the value in the primary field on the record is set to one of the values specified within the <ListOfPrimaryValues> section.

<data:Process>
. . .
  <data:ListOfPrimaryValues>
    <data:PrimaryValues>
      <data:Value>Account Call</data:Value>
    </PrimaryValues>
    <data:PrimaryValues> 
      <data:Value>Attendee Call</data:Value>
    </data:PrimaryValues>
. . .
  </data:ListOfPrimaryValues>
. . .
</data:Process>

The <ListOfTransitionStates> section contains the details of the transition states for the process.

<data:Process>
. . .
  <data:ListOfTransitionStates>
. . .
  </data:ListOfTransitionStates>
</data:Process>

The <TransitionStates> section contains the details of one transition state for the process.

<data:Process>
. . .
  <data:ListOfTransitionStates>
    <data:TransitionStates>
. . .
    </data:TransitionStates>
. . .
   </data:ListOfTransitionStates>
</data:Process>

<State> contains the transition field value that identifies this transition state. Each transition field value can be used with only one transition state in the 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:Process>
. . .
  <data:ListOfTransitionStates>
    <data:TransitionStates>
      <data:State>Deferred</data:State>
. . .
    </data:TransitionStates>
. . .
  </data:ListOfTransitionStates>
</data:Process>

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

<data:Process>
. . .
  <data:ListOfTransitionStates>
    <data:TransitionStates>
. . .
      <data:Category>Software</data:Category>
. . .
    </data:TransitionStates>
. . .
  </data:ListOfTransitionStates>
</data:Process>

<Description> contains a description of the transition state.

<data:Process>
. . .
  <data:ListOfTransitionStates>
    <data:TransitionStates>
. . .
      <data:Description>Test
      </data:Description>
. . .
    </data:TransitionStates>
. . .
  </data:ListOfTransitionStates>
</data:Process>

<Created> contains the username of the user who created the transition state, and the date and time the transition state was created.

<data:Process>
. . .
  <data:ListOfTransitionStates>
    <data:TransitionStates>
. . .
      <data:Created>ABC User 10/26/2012 
       10:12:40</data:Created>
. . .
    </data:TransitionStates>
. . .
  </data:ListOfTransitionStates>
</data:Process>

<Modified> contains the username of the user who last updated the transition state, and the date and time the transition state was last updated.

<data:Process>
. . .
  <data:ListOfTransitionStates>
    <data:TransitionStates>
. . .
      <data:Modified>ABC User 11/23/2016 
       11:27:40</data:Modified>
. . .
    </data:TransitionStates>
. . .
  </data:ListOfTransitionStates>
</data:Process>

<Condition> contains a condition that determines whether a record can move to this 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:Process>
. . .
  <data:ListOfTransitionStates>
    <data:TransitionStates>
. . .
      <data:Condition>[{Priority}]="3-Low"
      </data:Condition>
. . .
    </data:TransitionStates>
. . .
  </data:ListOfTransitionStates>
</data:Process>

<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 this transition state.

<data:Process>
. . .
  <data:ListOfTransitionStates>
    <data:TransitionStates>
. . .
      <data:ErrorMessage>
      </data:ErrorMessage>
. . .
    </data:TransitionStates>
. . .
  </data:ListOfTransitionStates>
</data:Process>

<DisableUpdate> determines whether a record can be updated when the record is in this state. 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 this transition state.

<data:Process>
. . .
  <data:ListOfTransitionStates>
    <data:TransitionStates>
. . .
      <data:DisableUpdate>
      </data:DisableUpdate>
. . .
     </data:TransitionStates>
. . .
  </data:ListOfTransitionStates>
</data:Process>

<DisableDeleteOrRemove> determines whether a record can be deleted when the record is in this state. 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 this transition state.

<data:Process>
 . .
  <data:ListOfTransitionStates>
    <data:TransitionStates>
. . .
      <data:DisableDeleteOrRemove>
      </data:DisableDeleteOrRemove>
    </data:TransitionStates>
. . .
  </data:ListOfTransitionStates>
</data:Process>