GroupCustomerScreen
The Group Customer screen allows an OIPA user to add a Group Customer and edit its data. This rule defines the presentation of the fixed and dynamic fields and their data types. The business rule can exist as a Global rule or be overridden at the Primary Company.
| Element/Tag | Attributes | Parent Element | Description | Element/Attribute Value |
|---|---|---|---|---|
|
<GroupCustomerScreen> |
|
Required: This is the opening element that matches the name of the business rule. |
||
| <AutomaticCustomerNumber> | <GroupCustomerScreen> |
Optional: Allows the system to generate a customer number when creating a new group customer. The format is defined in the AutomaticCustomerNumber business rule. |
|
|
| <DisplayPhoneScreen> | <GroupCustomerScreen> |
Optional: Specifies whether the Phone screen is enabled or disabled. |
|
|
| <Client> | <GroupCustomerScreen> |
Required, Repeatable: This structure allows the definition of one or more Group Customer Client Types, their dynamic fields, ActivityPlan, and Relationship Activity Plan. |
||
| TYPECODE | <Client> |
Required: Specifies the client's Type code being defined in the structure. |
|
|
| ACTIVITYPLAN | <Client> |
Required: Specifies the plan that contains the transactions available to clients of the Type provided by the TYPECODE attribute. |
|
|
| RELATIONSHIPACTIVITYPLAN | <Client> |
Required: Specifies the plan that contains group customer relationship transactions available to clients of the Type provided by the TYPECODE attribute. |
|
|
| <FixedFields> | <Client> |
Optional: See Fixed Fields under Common Elements. The field names available to this structure will be presented in the following order on the Group Customer Screen.
|
||
| <Subsections> | <Client> |
Optional: This element defines one or more collapsible sections of dynamic fields. This provides a visual organization of the dynamic fields into one or more sections. |
||
| <Subsection> | <Subsections> |
Required, Repeatable: This element defines a single collapsible section. More than one of these sections may be defined. |
||
| TITLE | <Subsection> |
Optional: This attribute gives the section a title on the subsection's header. |
literal text | |
| SECTIONNODES | <Subsection> |
Optional: A section can initially display collapsed or expanded. |
|
|
| <Fields> | <Subsection> |
Required: See the Fields Elements. |
||
| <Events> | <Client> |
Optional: See Action/Events element. |
||
| <ScreenMath> | <Client> |
Optional: See Action/Events element. |
||
| <Actions> | <Client> |
Optional: See Action/Events element. |
||
| <DisplayFormat> | <Client> |
Required: This element provides definition to construct the name of the group customer that appears on various OIPA screens. The name is constructed from data in the Group Customer and its associated Client records. |
||
| <Part> | <DisplayFormat> |
Required, Repeatable: This element represents one part of the total name. |
|
|
| PRE | <Part> |
Optional: Specifies one or more characters to concatenate to the beginning of the associated <Part> value. |
literal text character | |
| POST | <Part> |
Optional: Specifies one or more characters to concatenate to the end of the associated <Part> value. |
literal text character | |
| <MultiFields> | <Client> |
Optional: This element is used to identify and turn on and off the display of a multifields construct. |
|
|
| RULE | <MultiFields> |
Required: This attribute provides the exact name of the MultiFields business rule. |
literal | |
XML Schema
<GroupCustomerScreen>
<AutomaticCustomerNumber>[No | Yes | Optional]</AutomaticCustomerNumber>
<DisplayPhoneScreen>[No | Yes]</DisplayPhoneScreen>
<Client TYPECODE="[code value]" ACTIVITYPLAN="[plan name]" RELATIONSHIPACTIVITYPLAN="[plan name]">
<FixedFields>
<Field>
<Name>[CompanyName | CustomerNumber | TaxID | AllowedForCopy]</Name>
<Display>[literal]</Display>
<Disabled>[No | Yes]</Disabled>
<Hidden>[No | Yes]</Hidden>
<Required>[No | Yes</Required>
<Expanded>[No | Yes]</Expanded>
</Field>
<Field>
<Name>[LegalResidenceCountryCode | PrimaryEnrollmentRelationship | EnrollmentClassGroup | HierarchyRelationship]</Name>
<Display>[literal]</Display>
<Disabled>[No | Yes]</Disabled>
<Hidden>[No | Yes]</Hidden>
<Required>[No | Yes</Required>
<Expanded>[No | Yes]</Expanded>
<Query TYPE="SQL">[SQL statement]</Query>
</Field>
<Field>
<Name>[LegalResidenceCountryCode | PrimaryEnrollmentRelationship | EnrollmentClassGroup | HierarchyRelationship]</Name>
<Display>[literal]</Display>
<Disabled>[No | Yes]</Disabled>
<Hidden>[No | Yes]</Hidden>
<Required>[No | Yes</Required>
<Expanded>[No | Yes]</Expanded>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>[literal]</OptionValue>
<OptionText>[literal]</OptionText>
</Option>
<Option>...</Option>
</Options>
</Query>
</Field>
<Field>...</Field>
</FixedFields>
<Subsections>
<Subsection TITLE="[literal]" SECTIONNODES="[Collapsed | Expanded]">
<Fields>
<Field>...</Field>
<Field>...</Field>
</Fields>
</Subsection>
<Subsection>...</Subsection>
</Subsections>
<Events>...</Events>
<ScreenMath>...</ScreenMath>
<Actions>...</Actions>
<DisplayFormat>
<Part PRE="[literal]" POST="[literal]">[field name]</Part>
<Part>...</Part>
</DisplayFormat>
<MultiFields RULE="[rule name]">[No | Yes]</MultiFields>
</Client>
<Client>...</Client>
</GroupCustomerScreen>
XML Example
<GroupCustomerScreen>
<DisplayPhoneScreen>Yes</DisplayPhoneScreen>
<Client TYPECODE="20" ACTIVITYPLAN="Customer Plan" RELATIONSHIPACTIVITYPLAN="Relationship Plan">
<FixedFields>
<Field>
<Name>CompanyName</Name>
<Display>Company Name</Display>
</Field>
<Field>
<Name>AllowedForCopy</Name>
<Display>Allow for Copy</Display>
</Field>
</FixedFields>
<Subsections>
<Subsection TITLE="Customer Detail" SECTIONNODES="Expanded">
<Fields>
<Field>
<Name>Corporation</Name>
<Display>Corporation</Display>
<DataType>Radio</DataType>
<DefaultValue>00</DefaultValue>
<Disabled>No</Disabled>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>01</OptionValue>
<OptionText>Yes</OptionText>
</Option>
<Option>
<OptionValue>00</OptionValue>
<OptionText>No</OptionText>
</Option>
</Options>
</Query>
</Field>
<Field>
<Name>TaxIDSource</Name>
<Display>TaxID Source</Display>
<DataType>Combo</DataType>
<DefaultValue>00</DefaultValue>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>00</OptionValue>
<OptionText>Application</OptionText>
</Option>
<Option>
<OptionValue>01</OptionValue>
<OptionText>Form</OptionText>
</Option>
</Options>
</Query>
</Field>
<Field>
<Name>OriginalEffectiveDate</Name>
<Display>Original Effective Date</Display>
<DataType>Date</DataType>
<DefaultValue>SYSTEMDATE</DefaultValue>
</Field>
<Field>
<Name>ChangeEffectiveDate</Name>
<Display>Change Effective Date</Display>
<DataType>Date</DataType>
<DefaultValue>SYSTEMDATE</DefaultValue>
</Field>
<Field>
<Name>CustomerLegalName</Name>
<Display>Customer Legal Name</Display>
<DataType>Text</DataType>
<Required>Yes</Required>
</Field>
<Field>
<Name>AlternateFederalEmployerIDNumber</Name>
<Display>Alternate Federal Employer ID Number</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>CustomerStatus</Name>
<Display>Customer Status</Display>
<DataType>Combo</DataType>
<Query TYPE="SQL">SELECT CodeValue, ShortDescription FROM AsCode WHERE CodeName = 'AsCodeCustomerStatus'</Query>
<Required>Yes</Required>
</Field>
<Field>
<Name>SitusState</Name>
<Display>Situs State</Display>
<DataType>Combo</DataType>
<Query TYPE="SQL">SELECT CodeValue, ShortDescription FROM AsCode WHERE CodeName = 'AsCodeState'</Query>
<Required>Yes</Required>
</Field>
<Field>
<Name>CancellationDate</Name>
<Display>Cancellation Date</Display>
<DataType>Date</DataType>
</Field>
<Field>
<Name>CancellationReason</Name>
<Display>Cancellation Reason</Display>
<DataType>Combo</DataType>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>04</OptionValue>
<OptionText>Reason 1</OptionText>
</Option>
<Option>
<OptionValue>05</OptionValue>
<OptionText>Reason 2</OptionText>
</Option>
<Option>
<OptionValue>06</OptionValue>
<OptionText>Reason 3</OptionText>
</Option>
</Options>
</Query>
<Hidden>Yes</Hidden>
</Field>
<Field>
<Name>CancellationReasonDescription</Name>
<Display>Cancellation Reason Description</Display>
<DataType>Text</DataType>
<Hidden>Yes</Hidden>
</Field>
<Field>
<Name>ReinstatementDate</Name>
<Display>Reinstatement Date</Display>
<DataType>Date</DataType>
<Hidden>Yes</Hidden>
</Field>
<Field>
<Name>IndustryCode</Name>
<Display>Industry Code(SIC Code)</Display>
<DataType>Combo</DataType>
<Query TYPE="SQL">SELECT CodeValue, ShortDescription FROM AsCode WHERE CodeName = 'AsCodeSICCode'</Query>
</Field>
</Fields>
</Subsection>
<Subsection TITLE="Customer Preferences" SECTIONNODES="Expanded">
<Fields>
<Field>
<Name>CorrespondenceName</Name>
<Display>Correspondence Name</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>UniqueIDPreference</Name>
<Display>Unique ID Preference</Display>
<DataType>Combo</DataType>
<DefaultValue>00</DefaultValue>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>00</OptionValue>
<OptionText>Tax ID</OptionText>
</Option>
<Option>
<OptionValue>01</OptionValue>
<OptionText>Employee ID</OptionText>
</Option>
</Options>
</Query>
</Field>
<Field>
<Name>CustomerCommunicationPreference</Name>
<Display>Customer Communication Preference</Display>
<DataType>Combo</DataType>
<DefaultValue>00</DefaultValue>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>00</OptionValue>
<OptionText>Paper</OptionText>
</Option>
<Option>
<OptionValue>01</OptionValue>
<OptionText>Email</OptionText>
</Option>
</Options>
</Query>
</Field>
<Field>
<Name>EmployeeCommunicationPreference</Name>
<Display>Employee Communication Preference</Display>
<DataType>Combo</DataType>
<DefaultValue>00</DefaultValue>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>00</OptionValue>
<OptionText>Paper</OptionText>
</Option>
<Option>
<OptionValue>01</OptionValue>
<OptionText>Email</OptionText>
</Option>
</Options>
</Query>
</Field>
</Fields>
</Subsection>
</Subsections>
<Events>
<Event TYPE="ONCHANGE" FIELD="CancellationDate">
<Math ID="GlobalScreenMath"/>
<ActionSet ID="OnChangeScreenValidation1"/>
<ActionSet ID="OnChangeScreenValidation3"/>
</Event>
<Event TYPE="ONCHANGE" FIELD="CancellationReason">
<Math ID="GlobalScreenMath"/>
<ActionSet ID="OnChangeScreenValidation2"/>
</Event>
<Event TYPE="ONSUBMIT">
<ActionSet ID="OnSubmitScreenValidations"/>
</Event>
</Events>
<ScreenMath>
<Math ID="GlobalScreenMath" GLOBAL="Yes">
<MathVariables>
<MathVariable VARIABLENAME="CancellationReasonSMV" TYPE="VALUE" DATATYPE="Text">06</MathVariable>
<MathVariable VARIABLENAME="ValueSMV" TYPE="VALUE" DATATYPE="Text"/>
</MathVariables>
</Math>
</ScreenMath>
<Actions>
<ActionSet ID="OnChangeScreenValidation1">
<Condition IF=" Not IsEmpty(CancellationDate)">
<Action ACTIONTYPE="SHOW" FIELD="CancellationReason"/>
<Else>
<Action ACTIONTYPE="HIDE" FIELD="CancellationReason"/>
</Else>
</Condition>
</ActionSet>
<ActionSet ID="OnChangeScreenValidation2">
<Condition IF="CancellationReason=GlobalScreenMath:CancellationReasonSMV">
<Action ACTIONTYPE="SHOW" FIELD="CancellationReasonDescription"/>
<Action ACTIONTYPE="ASSIGN" FIELD="CancellationReasonDescription">GlobalScreenMath:ValueSMV</Action>
<Else>
<Action ACTIONTYPE="HIDE" FIELD="CancellationReasonDescription"/>
</Else>
</Condition>
</ActionSet>
<ActionSet ID="OnChangeScreenValidation3">
<Condition IF=" Not IsEmpty(CancellationDate)">
<Action ACTIONTYPE="SHOW" FIELD="ReinstatementDate"/>
<Action ACTIONTYPE="ASSIGN" FIELD="ReinstatementDate">GlobalScreenMath:ValueSMV</Action>
<Else>
<Action ACTIONTYPE="HIDE" FIELD="ReinstatementDate"/>
</Else>
</Condition>
</ActionSet>
<ActionSet ID="OnSubmitScreenValidations">
<Condition IF="IsEmpty(ChangeEffectiveDate)">
<Action ACTIONTYPE="ERROR">Change Effective Date is a required field.</Action>
</Condition>
<Condition IF="Not IsEmpty(CancellationDate) AND CancellationDate < ChangeEffectiveDate">
<Action ACTIONTYPE="ERROR">Cancellation Date should be greater than Change Effective Date.</Action>
</Condition>
<Condition IF="Not IsEmpty(ReinstatementDate) AND ReinstatementDate
<CancellationDate">
<Action ACTIONTYPE="ERROR">Reinstatement Date should be greater than Cancellation Date.</Action>
</Condition>
</ActionSet>
</Actions>
<DisplayFormat>
<Part POST=" ">CompanyName</Part>
</DisplayFormat>
</Client>
<Client TYPECODE="22" ACTIVITYPLAN="Customer Plan" RELATIONSHIPACTIVITYPLAN="Relationship Plan">
<Subsections>
<Subsection TITLE="Customer Detail" SECTIONNODES="Expanded">
<Fields>
<Field>
<Name>Corporation</Name>
<Display>Corporation</Display>
<DataType>Radio</DataType>
<DefaultValue>00</DefaultValue>
<Disabled>No</Disabled>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>01</OptionValue>
<OptionText>Yes</OptionText>
</Option>
<Option>
<OptionValue>00</OptionValue>
<OptionText>No</OptionText>
</Option>
</Options>
</Query>
</Field>
<Field>
<Name>TaxIDSource</Name>
<Display>TaxID Source</Display>
<DataType>Combo</DataType>
<DefaultValue>00</DefaultValue>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>00</OptionValue>
<OptionText>Application</OptionText>
</Option>
<Option>
<OptionValue>01</OptionValue>
<OptionText>Form</OptionText>
</Option>
</Options>
</Query>
</Field>
<Field>
<Name>OriginalEffectiveDate</Name>
<Display>Original Effective Date</Display>
<DataType>Date</DataType>
<DefaultValue>SYSTEMDATE</DefaultValue>
</Field>
<Field>
<Name>ChangeEffectiveDate</Name>
<Display>Change Effective Date</Display>
<DataType>Date</DataType>
<DefaultValue>SYSTEMDATE</DefaultValue>
</Field>
<Field>
<Name>CustomerLegalName</Name>
<Display>Customer Legal Name</Display>
<DataType>Text</DataType>
<Required>Yes</Required>
</Field>
<Field>
<Name>AlternateFederalEmployerIDNumber</Name>
<Display>Alternate Federal Employer ID Number</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>CustomerStatus</Name>
<Display>Customer Status</Display>
<DataType>Combo</DataType>
<Query TYPE="SQL">SELECT CodeValue, ShortDescription FROM AsCode WHERE CodeName = 'AsCodeCustomerStatus'</Query>
<Required>Yes</Required>
</Field>
<Field>
<Name>SitusState</Name>
<Display>Situs State</Display>
<DataType>Combo</DataType>
<Query TYPE="SQL">SELECT CodeValue, ShortDescription FROM AsCode WHERE CodeName = 'AsCodeState'</Query>
<Required>Yes</Required>
</Field>
<Field>
<Name>CancellationDate</Name>
<Display>Cancellation Date</Display>
<DataType>Date</DataType>
</Field>
<Field>
<Name>CancellationReason</Name>
<Display>Cancellation Reason</Display>
<DataType>Combo</DataType>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>04</OptionValue>
<OptionText>Reason 1</OptionText>
</Option>
<Option>
<OptionValue>05</OptionValue>
<OptionText>Reason 2</OptionText>
</Option>
<Option>
<OptionValue>06</OptionValue>
<OptionText>Reason 3</OptionText>
</Option>
</Options>
</Query>
<Hidden>Yes</Hidden>
</Field>
<Field>
<Name>CancellationReasonDescription</Name>
<Display>Cancellation Reason Description</Display>
<DataType>Text</DataType>
<Hidden>Yes</Hidden>
</Field>
<Field>
<Name>ReinstatementDate</Name>
<Display>Reinstatement Date</Display>
<DataType>Date</DataType>
<Hidden>Yes</Hidden>
</Field>
<Field>
<Name>IndustryCode</Name>
<Display>Industry Code(SIC Code)</Display>
<DataType>Combo</DataType>
<Query TYPE="SQL">SELECT CodeValue, ShortDescription FROM AsCode WHERE CodeName = 'AsCodeSICCode'</Query>
</Field>
</Fields>
</Subsection>
<Subsection TITLE="Customer Preferences" SECTIONNODES="Expanded">
<Fields>
<Field>
<Name>CorrespondenceName</Name>
<Display>Correspondence Name</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>UniqueIDPreference</Name>
<Display>Unique ID Preference</Display>
<DataType>Combo</DataType>
<DefaultValue>00</DefaultValue>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>00</OptionValue>
<OptionText>Tax ID</OptionText>
</Option>
<Option>
<OptionValue>01</OptionValue>
<OptionText>Employee ID</OptionText>
</Option>
</Options>
</Query>
</Field>
<Field>
<Name>CustomerCommunicationPreference</Name>
<Display>Customer Communication Preference</Display>
<DataType>Combo</DataType>
<DefaultValue>00</DefaultValue>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>00</OptionValue>
<OptionText>Paper</OptionText>
</Option>
<Option>
<OptionValue>01</OptionValue>
<OptionText>Email</OptionText>
</Option>
</Options>
</Query>
</Field>
<Field>
<Name>EmployeeCommunicationPreference</Name>
<Display>Employee Communication Preference</Display>
<DataType>Combo</DataType>
<DefaultValue>00</DefaultValue>
<Query TYPE="FIXED">
<Options>
<Option>
<OptionValue>00</OptionValue>
<OptionText>Paper</OptionText>
</Option>
<Option>
<OptionValue>01</OptionValue>
<OptionText>Email</OptionText>
</Option>
</Options>
</Query>
</Field>
</Fields>
</Subsection>
</Subsections>
<Events>
<Event TYPE="ONCHANGE" FIELD="CancellationDate">
<Math ID="GlobalScreenMath"/>
<ActionSet ID="OnChangeScreenValidation1"/>
<ActionSet ID="OnChangeScreenValidation3"/>
</Event>
<Event TYPE="ONCHANGE" FIELD="CancellationReason">
<Math ID="GlobalScreenMath"/>
<ActionSet ID="OnChangeScreenValidation2"/>
</Event>
<Event TYPE="ONSUBMIT">
<ActionSet ID="OnSubmitScreenValidations"/>
</Event>
</Events>
<ScreenMath>
<Math ID="GlobalScreenMath" GLOBAL="Yes">
<MathVariables>
<MathVariable VARIABLENAME="CancellationReasonSMV" TYPE="VALUE" DATATYPE="Text">06</MathVariable>
<MathVariable VARIABLENAME="ValueSMV" TYPE="VALUE" DATATYPE="Text"/>
</MathVariables>
</Math>
</ScreenMath>
<Actions>
<ActionSet ID="OnChangeScreenValidation1">
<Condition IF=" Not IsEmpty(CancellationDate)">
<Action ACTIONTYPE="SHOW" FIELD="CancellationReason"/>
<Else>
<Action ACTIONTYPE="HIDE" FIELD="CancellationReason"/>
</Else>
</Condition>
</ActionSet>
<ActionSet ID="OnChangeScreenValidation2">
<Condition IF="CancellationReason=GlobalScreenMath:CancellationReasonSMV">
<Action ACTIONTYPE="SHOW" FIELD="CancellationReasonDescription"/>
<Action ACTIONTYPE="ASSIGN" FIELD="CancellationReasonDescription">GlobalScreenMath:ValueSMV</Action>
<Else>
<Action ACTIONTYPE="HIDE" FIELD="CancellationReasonDescription"/>
</Else>
</Condition>
</ActionSet>
<ActionSet ID="OnChangeScreenValidation3">
<Condition IF=" Not IsEmpty(CancellationDate)">
<Action ACTIONTYPE="SHOW" FIELD="ReinstatementDate"/>
<Action ACTIONTYPE="ASSIGN" FIELD="ReinstatementDate">GlobalScreenMath:ValueSMV</Action>
<Else>
<Action ACTIONTYPE="HIDE" FIELD="ReinstatementDate"/>
</Else>
</Condition>
</ActionSet>
<ActionSet ID="OnSubmitScreenValidations">
<Condition IF="IsEmpty(ChangeEffectiveDate)">
<Action ACTIONTYPE="ERROR">Change Effective Date is a required field.</Action>
</Condition>
<Condition IF="Not IsEmpty(CancellationDate) AND CancellationDate < ChangeEffectiveDate">
<Action ACTIONTYPE="ERROR">Cancellation Date should be greater than Change Effective Date.</Action>
</Condition>
<Condition IF="Not IsEmpty(ReinstatementDate) AND ReinstatementDate
<CancellationDate">
<Action ACTIONTYPE="ERROR">Reinstatement Date should be greater than Cancellation Date.</Action>
</Condition>
</ActionSet>
</Actions>
<DisplayFormat>
<Part POST=" ">CompanyName</Part>
</DisplayFormat>
</Client>
</GroupCustomerScreen>
