XML code for workflow definitions


The XML code that you create for defining input parameters for the Workflow Job contains information about all the input parameters defined for the TrueSight Orchestration process, as well as information for organizing these parameters on the Workflow Job panels. The following topics provide related information:

This XML code must adhere to the WorkflowDefinition.xsd XML schema, of which a copy is available in Copy-of-WorkflowDefinition-xsd-for-XML-validation.

Note

Your XML code must include all input parameters that have already been defined through the Start activity of the TrueSight Orchestration process. If you leave out any defined input parameter, misspell the name of an input parameter, or if the XML code is invalid for any other reason, the XML code is not implemented, and the input parameters are passed on to the TrueSight Server Automation Workflow Job as string-type input parameters (in accordance with the default).

Basic elements

You define your workflow using a single workflow root element. Within the workflow, you can define one or more of each of the basic elements described in the following table:

Basic elements in the XML code for workflow definitions

All defined elements are created according to the order in which they appear in your XML code. The following example XML code highlights the basic elements (with all other subordinate nodes collapsed). This example presents one page with two parameters enclosed within a group and a third parameter standing on its own.

 

<workflow xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="./WorkflowDefinition.xsd">
  <page name="_pageName1_">
     <group name="_groupName1_">
        <parameter name="_parameterName1_"...>
        </parameter>
        <parameter name="_parameterName2_"...>
        </parameter>
     </group>
     <parameter name="_parameterName3_"...>
     </parameter>
  </page>
</workflow>

Note

The XSD definition within the <workflow> tag is necessary only for the validation of the XML code after you finish authoring it.

Parameter attributes and child elements

The following table lists the parameter attributes that you can include for each parameter that you define in your XML code.

Parameter attributes in the XML code for workflow definitions

 1 If you specify an invalid default value for a Boolean type parameter, a value of false is used instead. Similarly, if you specify an invalid default value for a numeric parameter, a value of 0 is used instead. If you specify an invalid default target server, the corresponding field on the Workflow Job panel displays "invalid default value" (and you should choose a different value during job configuration).

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*