MaintainProgram
The MaintainProgram BR supports a policy level transaction which can be used to update activities for one or more currently active Programs at a time via the Program Screen.
|
Element/Tag |
Attributes |
Parent Element |
Description |
Element/Attribute Values |
|---|---|---|---|---|
| <MaintainProgram> | Opening element for the rule | |||
| <Program> | <MaintainProgram> | Required and Repeatable | ||
| PROGRAMACTION |
Required: Specifies the ProgramAction section of the Program Definition to get the transaction to generate from. Literal Value: Run / Reinstate / Change / Terminate / Start |
|||
| <Tests> | <Program> |
Optional: Allows for further definition of the program fields that may be updated |
||
| <Test> | <Tests> |
Repeatable: A conditional statement that tests a MathVariable or Field against another MathVariable, Field, or literal value. |
||
| <Fields> | <Program> |
Required: Common field definition |
||
| <Field > | <Fields> |
Required, Repeatable: The opening and closing tag that encompasses <From> and <To> |
||
| <FromCollection> | <Field > |
Required: Identifies the collection Program/Value from which data is copied. A collection math variable of ProgramGUIDs and Values |
||
| <To> | <Field > |
Required: Name of Program field data is being copied to. Literal field name |
||
| <OptionTextCollection> | <Field > |
Optional element: Specifies a collection of key-value pairs, where the key is an Entity GUID and the value is a supported value for the OPTIONTEXT for field defined in the <To> element. This element can only be paired with the <FromCollection> element. Note: This element and the <OptionText> element are mutually exclusive. This element is also mutually exclusive with the <From> element. MathVariable |
||
| <OptionText> |
Optional element: Identifies the source of the data that will update the OptionText for the field defined in the <To> element. Note: This element and the <OptionTextCollection> element are mutually exclusive. MathVariable |
XML Schema
<MaintainProgram>
<Program PROGRAMACTION="[Run | Reinstate | Change | Terminate | Start]">
<Tests>
<Test>[conditional statement]</Test>
</Tests>
<Fields>
<Field>
<From>[math variable]</From>
<FromCollection>[collection math variable]</FromCollection>
<To>[field name]</To>
<OptionTextCollection>[MathVariable]</OptionTextCollection>
</Field>
</Fields>
</Program>
</MaintainProgram>
XML Example
<MaintainProgram>
<Program PROGRAMACTION="Change">
<Tests>
<Test>TestValue=='5'</Test>
</Tests>
<Fields>
<Field>
<FromCollection>ProgramCollection</FromCollection>
<To>EffectiveDate</To>
</Field>
<Field>
<FromCollection>ComboSQLMV</FromCollection>
<To>ComboSQL</To>
<OptionText>ComboField2collection</OptionText>
</Field>
</Fields>
</Program>
</MaintainProgram>
