SuspendProgram

The SuspendProgram attached business rule is used to halt the Policy and Segment level program schedules without terminating the programs. Suspension means the programs' recurring activity schedule is interrupted and the programs' schedule can be reinstated in the future to continue the recurring program activity schedule or continue a different program recurring activity schedule. The result of processing this rule updates identified Programs to a Suspend status. Programs in a Terminated status prior to executing this rule are excluded from suspension. The recurring pending Program activities for each Program being suspended are shadowed. Reversal and undo processing of this rule's updates, program statuses are returned to their prior value. Activities that were shadowed by this rule are returned to their pending status

Program transactions are the transactions associated to Program Actions in the ProgramDefinition rule. These transactions include an "IsProgram" variable that can be used in the Activity's Math and in this rule's conditions.

SuspendProgram: Elements and Attributes

Elements	Attributes	Parent Element	Description	Element / Attribute Values
<SuspendProgram>			This is the root element for the rule.
<Program>		<SuspendProgram>	Required: This element structure identifies one or more Programs to suspend and optional conditions evaluating to true to execute and complete the rule.
	PROGRAMGUIDARRAY	<Program>	Required: This attribute provides an array of one or more ProgramGUIDs that will be suspended by the Activity.	variable valid value must be an array the array can contain 0 to many ProgramGUIDs that will be suspended all program guids must be associated to the same Policy and the Policy the parent activity is associated
<Tests>		<Program>	Optional: This element provides one or more conditions that, when all evaluate to true, allow processing of the remainder of the parent element's configuration.
<Test>		<Tests>	Required, Repeatable: This element provides a single condition.  It is repeated to provide multiple conditions.	condition Activity fields and variables are available to construct a condition

XML Schema

<SuspendProgram>
    <Program PROGRAMGUIDARRAY="[array]">
        <Tests>
            <Test>[condition]</Test>
            <Test>...</Test>
        </Tests>
    </Program>
</SuspendProgram>

XML Example

<SuspendProgram>
    <Program PROGRAMGUIDARRAY="ProgramGUIDArray"></Program>
</SuspendProgram>
 
OR
 
<SuspendProgram>
    <Program PROGRAMGUIDARRAY="ProgramGUIDArray">
        <Tests>
            <Test>ActiveProgramCountMV > 0</Test>
        </Tests>
    </Program>
</SuspendProgram>