PlanSegmentNameClassScreen
The PlanSegmentNameClassScreen business rule controls the configuration of the Class Sub-Plans screen, which displays the Class Sub-Plan associations for a selected class. The Class Sub-Plans screen is a tab of the Class screen, which is configured with the ClassScreen business rule.
Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
---|---|---|---|
<PlanSegmentNameClassScreen> |
|
The opening and closing tag for the PlanSegmentNameClassScreen rule. |
|
<Table> |
|
Controls formatting of the Class Plan display. See the Table Element page for more information. The supported values for the <Group> element in column configuration are:
|
|
<PlanSegmentNameClass> |
|
Repeatable element: |
|
TYPECODE |
Required attribute |
||
<Subsections> |
Optional element: The fields configured inside subsections will be grouped together and the display can be collapsed or expanded. |
||
SECTIONNODES |
Optional attribute:
Specifies whether the subsection nodes should be expanded or collapsed. |
Expanded Collapsed Collapsed is the default value. |
|
<Subsection> | Required, Repeatable element: Defines an individual subsection. This element is required if the <Subsections> element is configured. |
||
TITLE | Optional attribute: Defines the title to be displayed on the subsection header. |
String: The title to be displayed on the subsection header. | |
SECTIONNODES | Optional attribute:
Specifies whether the subsection nodes should be expanded or collapsed. |
Expanded: The nodes will be expanded. Collapsed The nodes will be collapsed. This is the default value. |
|
<Fields> |
|
See Fields Elements. |
Fields can be used either within subsections or without any subsection tags under the PlanSegmentNameClass tag. |
<Events> |
Repeatable: The opening and closing tag for Events section. See ActionEvents. Note: Events for fixed fields only support ClassGroupGUID |
Required: Fields are executed only when the screen is accessed through an activity. |
|
<ScreenMath> |
Repeatable:The opening and closing tag for ScreenMath section. See Screen Math. |
||
<Actions> |
Repeatable:The opening and closing tag for Actions section. See ActionEvents. |
||
<DisplayTabs>
|
Contains attributes that control the display of various tabs on the screen. | ||
CLASSSEGMENTNAMEDETAILS |
Determines whether to display the details of the Class Plan. |
Yes/No Yes is the default value. |
|
SEGMENTNAMEDETAILS |
Determines whether to display the details of the plan. |
Yes/No Yes is the default value. |
|
CLASSSEGMENTNAMEPARTICIPANTS |
Determines whether to display the list of plan participants. |
Yes/No Yes is the default value. |
XML Schema
<PlanSegmentNameClassScreen>
<Table>
<Column ALIGN="[LEFT|RIGHT|CENTER]">
<Name></Name>
<Display></Display>
<DataType></DataType>
<Group></Group>
</Column>
</Table>
<PlanSegmentNameClass TYPECODE="">
<Fields>
<Field>
<Name></Name>
<Display></Display>
<DataType></DataType>
</Field>
</Fields>
<Events>
...
<Events>
<ScreenMath>
...
</ScreenMath>
<Actions>
...
</Actions>
</PlanSegmentNameClass>
<DisplayTabs CLASSSEGMENTNAMEDETAILS="" SEGMENTNAMEDETAILS="" CLASSSEGMENTNAMEPARTICIPANTS=""></DisplayTabs>
</PlanSegmentNameClassScreen>
XML Example
<PlanSegmentNameClassScreen>
<Table>
<Column ALIGN="LEFT">
<Name>SegmentName</Name>
<Display>Segment Name</Display>
<DataType>Text</DataType>
<Group>PlanSegmentName</Group>
</Column>
<Column ALIGN="LEFT">
<Name>TypeCode</Name>
<Display>Class Plan Type</Display>
<DataType>Text</DataType>
<Group>PlanSegmentNameClass</Group>
</Column>
<Column ALIGN="LEFT">
<Name>StatusCode</Name>
<Display>Status</Display>
<DataType>Text</DataType>
<Group>PlanSegmentNameClass</Group>
</Column>
<Column ALIGN="LEFT">
<Name>ActiveFrom</Name>
<Display>Active From</Display>
<DataType>Text</DataType>
<Group>PlanSegmentNameClass</Group>
</Column>
<Column ALIGN="LEFT">
<Name>ActiveTo</Name>
<Display>Active To</Display>
<DataType>Text</DataType>
<Group>PlanSegmentNameClass</Group>
</Column>
<Column ALIGN="LEFT">
<Name>PlanName</Name>
<Display>Plan Name</Display>
<DataType>Text</DataType>
<Group>Plan</Group>
</Column>
</Table>
<PlanSegmentNameClass TYPECODE="01">
<Fields>
<Field>
<Name>ClassPlanDynamicField1</Name>
<Display>Class Plan Dynamic Field 1</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>ClassPlanDynamicField2</Name>
<Display>Class Plan Dynamic Field 2</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>DateTest</Name>
<Display>Date Test</Display>
<DataType>Date</DataType>
</Field>
</Fields>
</PlanSegmentNameClass>
<PlanSegmentNameClass TYPECODE="02">
<Fields>
<Field>
<Name>ClassPlanDynamicField3</Name>
<Display>Class Plan Dynamic Field 3</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>ClassPlanDynamicField4</Name>
<Display>Class Plan Dynamic Field 4</Display>
<DataType>Text</DataType>
</Field>
</Fields>
</PlanSegmentNameClass>
<DisplayTabs CLASSSEGMENTNAMEDETAILS="Yes" SEGMENTNAMEDETAILS="Yes"
CLASSSEGMENTNAMEPARTICIPANTS="Yes"></DisplayTabs>
</PlanSegmentNameClassScreen>