ReinstateProgram

The ReinstateProgram attached business rule is used to reinstate one or more Policy level or a Segment level programs from a Suspend status. The result of processing this rule updates the identified Programs' statuses to their values prior to suspension. It also spawns the reinstatement activity that is the transaction defined by the Programs' definition rule. This reinstatement activity will re-establish the program schedule considering that the program could have been modified and that these generated activities may need to reflect that. The <Fields> element structure in the ReinstateProgram rule will transfer the parent activity variable data to the spawned reinstatement activity. The generated activity receives the effective date from the activity this rule has been attached, so it should not be configured in the <Field> element. Its generated activity must reconcile whether suspended recurring program activities are skipped upon reinstatement or there is a "catch up" of the suspended recurring program activities. When the ReinstateProgram business rule is reversed or undone, the unsuspended Programs return to a Suspend status and the Programs' activities are shadowed.

The transactions this rule is attached can be program or non-program transactions. Program transactions are the transactions defined to Program Actions in the ProgramDefinition rule. The generated Activity from this rule is an instance of a Program transaction. Activities include an "IsProgram" variable that can be used in the Activity's Math and in this rule's conditions.

ReinstateProgram: Elements and Attributes

Elements	Attributes	Parent Element	Description	Element / Attribute Values
<ReinstateProgram>			This is the root element for the rule.
<Program>		<ReinstateProgram>	Required: This element structure identifies the Program or Programs being reinstated and passes Program data to the generated reinstatement Activity.  The generated activity is defined by the ProgramDefinition rule.
	PROGRAMGUID	<Program>	Optional: This attribute provides a Program's guid that will be reinstated. This attribute is applicable when the <From> element is configured.  This attribute is ignored when the <FromCollection> element is configured in this rule.	variable valid value must be a ProgramGUID field valid value must be a ProgramGUID
<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
<Fields>		<Program>	Optional: This element's structure maps available data to the reinstatement activity that will be generated by this rule.
<Field>		<Fields>	Required, Repeatable: This element's structure maps source data to a single field in the generated Reinstatement activity. Each <Field> structure must be configured with either a <From> element or a <FromCollection> element and should not contain both elements.
<From>		<Field>	Optional: This element identifies the data source that is passed to a generated activity field.  The data source is a math variable or field from the parent activity.   This element is ignored when configured with a <FromCollection> element in the same <Field> element.	variable field
<FromCollection>		<Field>	Optional: This element identifies the data source from a collection math variable in the parent activity. This element should not exist with the <From> element in the same <Field> parent element.  If it is configured with the <From> element, this element takes precedence and the system ignores the <From> element.	collection key = ProgramGUID being reinstated value = field data to pass to the generated activity
<To>		<Field>	Required: This element identifies the field in the generated Reinstatement activity that is created with the the data from the <From> or <FromCollection> element.	field name
<OptionText>		<Field>	Optional: This element identifies the data source that will update the OptionText applicable to a field with the datatype of combo or radio in a single Program activity. This element is applicable when <From> element is configured within the same parent <Field> element.  It is ignored when <FromCollection> element is configured within the same parent <Field> element.	variable
<OptionTextCollection>		<Field>	Optional: This element identifies the collection that will update the OptionText applicable to a field with the datatype of combo or radio for multiple Program activities. This element is applicable when <FromCollection> element is configured within the same parent <Field> element.  It is ignored when <From> element is configured within the same parent <Field> element.	collection

XML Schema

<ReinstateProgram>
    <Program PROGRAMGUID="[variable | field]">
        <Tests>
            <Test>[condition]</Test>
            <Test>...</Test>
        </Tests>
        <Fields>
            <Field>
                <From>[variable | field]</From>
                <To>[field name]</To>
            </Field>
            <Field>
                <From>[variable | field]</From>
                <To>[field name]</To>
                <OptionText>[variable]</OptionText>
            </Field>
            <Field>...</Field>
        </Fields>
    </Program>
</ReinstateProgram>
 
OR
 
<ReinstateProgram>
    <Program>
        <Tests>
            <Test>[condition]</Test>
            <Test>...</Test>
        </Tests>
        <Fields>
            <Field>
                <FromCollection>[collection]</FromCollection>
                <To>[field name]</To>
            </Field>
            <Field>
                <FromCollection>[collection]</FromCollection>
                <To>[field name]</To>
                <OptionTextCollection>[collection]</OptionTextCollection>
            </Field>
            <Field>...</Field>
        </Fields>
    </Program>
</ReinstateProgram>

XML Example

<ReinstateProgram>
    <Program>
        <Fields>
            <Field>
                <FromCollection>NextBusinessDayCollection</FromCollection>
                <To>EffectiveDate</To>
            </Field>
            <Field>
                <FromCollection>ProgramFrequencyCollection</FromCollection>
                <To>ProgramFrequency</To>
                <OptionTextCollection>ProgramFequencyOptionCollection</OptionTextCollection>
            </Field>
            <Field>
                <FromCollection>StartDateCollection</FromCollection>
                <To>StartDate</To>
            </Field>
            <Field>
            <Field>
                <FromCollection>ProgramAmountCollection</FromCollection>
                <To>ProgramAmount</To>
            </Field>
        </Fields>
    </Program>
</ReinstateProgram>
 
OR
 
<ReinstateProgram>
    <Program PROGRAMGUID="ProgramGUIDMV">
        <Fields>
            <Field>
                <From>NextBusinessDayMV</From>
                <To>EffectiveDate</To>
            </Field>
            <Field>
                <From>ProgramFrequencyMV</From>
                <To>ProgramFrequency</To>
                <OptionText>ProgramFequencyOptionMV</OptionText>
            </Field>
            <Field>
                <From>StartDateMV</From>
                <To>StartDate</To>
            </Field>
            <Field>
                <From>ProgramAmountMV</From>
                <To>ProgramAmount</To>
            </Field>
        </Fields>
    </Program>
</ReinstateProgram>