CommentScreen

Description

This business rule controls the appearance and behavior of OIPA's various comment screens.

CommentScreen Element/Attribute Table
Element/Tag	Definition	Element/Attribute Value and Description
<CommentScreen>	Start and end tag of the business rule.
<DefaultComments>	Optional element if all applicable comment types have a unique section configured. DefaultComment section configuration is used if a comment type does not have specific configuration. This streamlines the configuration process if one or more comment types use the same fields, etc. Dynamic field section that will apply to all comment types unless they are specifically configured. Note: Client comments are configured in this section.
<UseTemplates>	Optional element: Indicates if comment templates are used. This element can be repeated in all comment screen sections (e.g. <PolicyComments>, <SegmentComments>, etc.).	Yes:The Comment Template drop-down box will display on the comment screen, and the drop-down list will include all applicable Comment Templates. No: The Comment Template drop-down box will not display on the comment screen. This is the default value.
<FixedFields>	Allows for configuration of "above the line" fields—standard screen field configuration is applicable. See the Fixed Fields page.
<Fields>	Allows for configuration of "below the line" fields—standard screen field configuration is applicable. See the Fields Element page.
<Events>	Allows for configuration of events. Standard screen event configuration is applicable, but events configured here will only apply within the DefaultComments section. See the ActionEvents page.
<ScreenMath>	Allows for configuration of Screen Math—standard Screen Math configuration is applicable. See the ScreenMath Element page.
<Actions>	Allows for configuration of actions—standard screen event configuration is applicable, but actions configured here will only apply within the DefaultComments section. See the ActionEvents page.
<PolicyComments>	Optional element Allows configuration of the dynamic field section that will only display if the Comments Screen is accessed from a policy. If not present comments accessed from Policy will use the DefaultComments configuration.
<SegmentComments>	Optional element Allows configuration of the dynamic field section that will only display if the Comments Screen is accessed from a segment. If not present comments accessed from Policy will use the DefaultComments configuration.
<SuspenseComments>	Optional element Allows configuration of the dynamic field section that will only be visible if the Comments Screen is accessed from the Suspense Screen. If not present comments accessed from Policy will use the DefaultComments configuration.
<ActivityComments>	Optional element Allows configuration of the dynamic field section that will only be visible if the Comments Screen is accessed from an Activity Screen. This configuration controls activity comments accessed via the Policy, Plan or Client Activity screens. If not present comments accessed from Policy will use the DefaultComments configuration.

XML Example

<CommentsScreen>

<DefaultComments>

<UseTemplates>Yes</UseTemplates>

<FixedFields>

<Field>

<Name>Hidden</Name>

<Display>Hidden</Display>

</Field>

</FixedFields>

<Fields>

<Field>

<Name>HiddenCommentReason</Name>

<Display>Hidden Comment Reason</Display>

<DataType>Text</DataType>

<Expanded>Yes</Expanded>

<Hidden>Yes</Hidden>

</Field>

<Field>

<Name>FunctionalDepartment</Name>

<Display>Functional Department</Display>

<DataType>Combo</DataType>

<Query TYPE="SQL">SELECT '', '', 1 FROM DUAL UNION SELECT AsCode.CodeValue, AsCode.LongDescription, 2 FROM AsCode WHERE AsCode.CodeName='AsCodeCommentsFunctionalDepartment' ORDER BY 3, 1</Query>

</Field>

<Field>

<Name>Category</Name>

<Display>Category</Display>

<DataType>Combo</DataType>

<Query TYPE="SQL">SELECT '', '', 1 FROM DUAL UNION SELECT AsCode.CodeValue, AsCode.LongDescription, 2 FROM AsCode WHERE AsCode.CodeName='AsCodeCommentsCategory' ORDER BY 3, 1</Query>

</Field>

<Field>

<Name>ClientCommentField</Name>

<Display>Client Comment Field</Display>

<DataType>Text</DataType>

</Field>

</Fields>

<Events>

<Event TYPE="ONLOAD">

<ActionSet ID="OnLoadTest"></ActionSet>

</Event>

<Event TYPE="ONCHANGE" FIELD="Hidden">

<Math ID="GlobalScreenMath"></Math>

<ActionSet ID="OnChangeActionSet"></ActionSet>

</Event>

<Event TYPE="ONSUBMIT">

<ActionSet ID="FinalValidation"></ActionSet>

</Event>

</Events>

<ScreenMath>

<Math ID="GlobalScreenMath" GLOBAL="Yes">

<MathVariables>

<MathVariable VARIABLENAME="Checked" TYPE="VALUE" DATATYPE="TEXT">CHECKED</MathVariable>

<MathVariable VARIABLENAME="UnChecked" TYPE="VALUE" DATATYPE="TEXT">UNCHECKED</MathVariable>

<MathVariable VARIABLENAME="OnLoadTest" TYPE="VALUE" DATATYPE="TEXT">Client Data</MathVariable>

</MathVariables>

</Math>

</ScreenMath>

<Actions>

<ActionSet ID="OnLoadTest">

<Condition IF="IsEmpty(ClientCommentField)">

<Action ACTIONTYPE="ASSIGN" FIELD="ClientCommentField">GlobalScreenMath:OnLoadTest</Action>

</Condition>

</ActionSet>

<ActionSet ID="FinalValidation">

<Condition IF="IsEmpty(FunctionalDepartment)">

<Action ACTIONTYPE="ERROR">Functional Department must be entered.</Action>

</Condition>

</ActionSet>

<ActionSet ID="OnChangeActionSet">

<Condition IF="Hidden=GlobalScreenMath:UnChecked">

<Action ACTIONTYPE="HIDE" FIELD="HiddenCommentReason"></Action>

<Else>

<Action ACTIONTYPE="SHOW" FIELD="HiddenCommentReason"></Action>

</Else>

</Condition>

</ActionSet>

<ActionSet ID="FinalValidation">

<Condition IF="IsEmpty(FunctionalDepartment)">

<Action ACTIONTYPE="ERROR">Functional Department must be entered.</Action>

</Condition>

</ActionSet>

</Actions>

</DefaultComments>

<SuspenseComments>

<UseTemplates>Yes</UseTemplates>

<FixedFields>

<Field>

<Name>Hidden</Name>

<Display>Hidden</Display>

</Field>

</FixedFields>

<Fields>

<Field>

<Name>HiddenCommentReason</Name>

<Display>Hidden Comment Reason</Display>

<DataType>Text</DataType>

<Expanded>Yes</Expanded>

<Hidden>Yes</Hidden>

</Field>

<Field>

<Name>FunctionalDepartment</Name>

<Display>Functional Department</Display>

<DataType>Combo</DataType>

<Query TYPE="SQL">SELECT '', '', 1 FROM DUAL UNION SELECT AsCode.CodeValue, AsCode.LongDescription, 2 FROM AsCode WHERE AsCode.CodeName='AsCodeCommentsFunctionalDepartment' ORDER BY 3, 1</Query>

</Field>

<Field>

<Name>Category</Name>

<Display>Category</Display>

<DataType>Combo</DataType>

<Query TYPE="SQL">SELECT '', '', 1 FROM DUAL UNION SELECT AsCode.CodeValue, AsCode.LongDescription, 2 FROM AsCode WHERE AsCode.CodeName='AsCodeCommentsCategory' ORDER BY 3, 1</Query>

</Field>

<Field>

<Name>SuspenseCommentField</Name>

<Display>Suspense Comment Field</Display>

<DataType>Text</DataType>

</Field>

</Fields>

<Events>

<Event TYPE="ONLOAD">

<ActionSet ID="OnLoadTest"></ActionSet>

</Event>

<Event TYPE="ONCHANGE" FIELD="Hidden">

<Math ID="GlobalScreenMath"></Math>

<ActionSet ID="OnChangeActionSet"></ActionSet>

</Event>

<Event TYPE="ONSUBMIT">

<ActionSet ID="FinalValidation"></ActionSet>

</Event>

</Events>

<ScreenMath>

<Math ID="GlobalScreenMath" GLOBAL="Yes">

<MathVariables>

<MathVariable VARIABLENAME="Checked" TYPE="VALUE" DATATYPE="TEXT">CHECKED</MathVariable>

<MathVariable VARIABLENAME="UnChecked" TYPE="VALUE" DATATYPE="TEXT">UNCHECKED</MathVariable>

<MathVariable VARIABLENAME="OnLoadTest" TYPE="VALUE" DATATYPE="TEXT">Suspense Data</MathVariable>

</MathVariables>

</Math>

</ScreenMath>

<Actions>

<ActionSet ID="OnLoadTest">

<Condition IF="IsEmpty(SuspenseCommentField)">

<Action ACTIONTYPE="ASSIGN" FIELD="SuspenseCommentField">GlobalScreenMath:OnLoadTest</Action>

</Condition>

</ActionSet>

<ActionSet ID="FinalValidation">

<Condition IF="IsEmpty(FunctionalDepartment)">

<Action ACTIONTYPE="ERROR">Functional Department must be entered.</Action>

</Condition>

</ActionSet>

<ActionSet ID="OnChangeActionSet">

<Condition IF="Hidden=GlobalScreenMath:UnChecked">

<Action ACTIONTYPE="HIDE" FIELD="HiddenCommentReason"></Action>

<Else>

<Action ACTIONTYPE="SHOW" FIELD="HiddenCommentReason"></Action>

</Else>

</Condition>

</ActionSet>

<ActionSet ID="FinalValidation">

<Condition IF="IsEmpty(FunctionalDepartment)">

<Action ACTIONTYPE="ERROR">Functional Department must be entered.</Action>

</Condition>

</ActionSet>

</Actions>

</SuspenseComments>

</CommentsScreen>