ProgramScreen

The ProgramScreen rule contains the configuration for Program views that display on the Programs screen. Views are listed in the Views drop-down in the same order as they are specified in this rule's configuration. Programs represent repetitive processing according to a well defined schedules like asset rebalancing, automated investment schedules, cost of living adjustments, systematic payouts/withdrawals, systematic costs, etc.

ProgramScreen: Elements and Attributes

Elements	Attributes	Parent Element	Description	Element / Attribute Values
<ProgramScreen>			This is the root element of the rule.
<ProgramViews>		<ProgramScreen>	Required: This element's structure defines all views to display on the screen.  Multiple views can be defined.
<View>		<ProgramViews>	Required, Repeatable: This element defines a single program view.  This element is repeated for multiple definitions.
	NAME	<View>	Required: This attribute provides a name for the view.  It is listed in the Views drop-down field.  Each name must be unique in this rule.	literal
<ProgramTypes>		<View>	Required: This element's structure defines the program types that will be included in the view.
	ALLTYPES	<ProgramTypes>	Optional: This attribute is a shortcut that indicates all program types will be included in the view.	No default <ProgramType> element or elements provide the program types to display in the view Yes all program types will be displayed in the view
<ProgramType>		<ProgramTypes>	Optional, Repeatable: This element provides the program type to display in the view.  The element is repeated to include multiple program types in the view.  When multiple program types are in the view, ALLTYPES attribute is "Yes" attribute is ignored.  When ALLTYPES attribute is "No" or not configured, this element is required.	code value valid value comes from AsCodeProgramType
<Table>		<View>	Required: See the Table Element article under the Common Elements topic. The groups that can be accessed in the <Table> element are: Segment SegmentField Program ProgramField Policy PolicyField

XML Schema

<ProgramScreen>
    <ProgramViews>
        <View NAME="[name]">
            <ProgramTypes ALLTYPES="Yes"/>
            <Table>
                <Column>...</Column>
                <Column>...</Column>
            </Table>
        </View>
        <View NAME="[name]">
            <ProgramTypes>
                <ProgramType>[code]</ProgramType>
                <ProgramType>...</ProgramType>
            </ProgramTypes>
            <Table>
                <Column>...</Column>
                <Column>...</Column>
            </Table>
        </View>
        <View>...</View>
    </ProgramViews>
</ProgramScreen>

XML Example

<ProgramScreen>
    <ProgramViews>
        <View NAME="All Programs View">
            <ProgramTypes ALLTYPES="Yes"></ProgramTypes>
            <Table>
                <Column>
                    <Display>Client Name</Display>
                    <Name>ClientName</Name>
                    <Group>ProgramField</Group>
                    <DataType>Client</DataType>
                </Column>
                <Column>
                    <Display>Segment Name</Display>
                    <Name>SegmentName</Name>
                    <Group>Segment</Group>
                    <DataType>Text</DataType>
                </Column>
                <Column>
                    <Display>Start Date</Display>
                    <Name>StartDate</Name>
                    <Group>Program</Group>
                    <DataType>Date</DataType>
                </Column>
                <Column>
                    <Display>End Date</Display>
                    <Name>EndDate</Name>
                    <Group>Program</Group>
                    <DataType>Date</DataType>
                </Column>
                <Column>
                    <Display>Program Status</Display>
                    <Name>StatusCode</Name>
                    <Group>Program</Group>
                    <DataType>Text</DataType>
                </Column>
                <Column>
                    <Display>Program Frequency</Display>
                    <Name>ProgramFrequency</Name>
                    <Group>ProgramField</Group>
                    <DataType>Text</DataType>
                </Column>
            </Table>
        </View>
        <View NAME="Program C View">
            <ProgramTypes>
                <ProgramType>03</ProgramType>
            </ProgramTypes>
            <Table>
                <Column>
                    <Display>Segment Name</Display>
                    <Name>SegmentName</Name>
                    <Group>Segment</Group>
                    <DataType>Text</DataType>
                </Column>
                <Column>
                    <Display>Client Name</Display>
                    <Name>ClientName</Name>
                    <Group>ProgramField</Group>
                    <DataType>Client</DataType>
                </Column>
                <Column>
                    <Display>Table Rating</Display>
                    <Name>SegmentTableRating</Name>
                    <Group>SegmentField</Group>
                    <DataType>Text</DataType>
                </Column>
                <Column>
                    <Display>Start Date</Display>
                    <Name>StartDate</Name>
                    <Group>Program</Group>
                    <DataType>Date</DataType>
                </Column>
                <Column>
                    <Display>End Date</Display>
                    <Name>EndDate</Name>
                    <Group>Program</Group>
                    <DataType>Date</DataType>
                </Column>
                <Column>
                    <Display>Program Status</Display>
                    <Name>StatusCode</Name>
                    <Group>Program</Group>
                    <DataType>Text</DataType>
                </Column>
                <Column>
                    <Display>Program Frequency</Display>
                    <Name>ProgramFrequency</Name>
                    <Group>ProgramField</Group>
                    <DataType>Text</DataType>
                </Column>
            </Table>
        </View>
    </ProgramViews>
</ProgramScreen>