AgreementRoleScreen

The AgreememtRoleScreen gives users the following capabilities:

  • View existing Agreement Roles of a Group Customer.

  • Find and add a new Client of a specific Role type.

  • Edit details of an Agreement Role.

  • Delete an Agreement Role record.

    • The record is not physically deleted from OIPA but is updated with a Deleted status code.

AgreementRoleScreen Elements And Attributes

Elements

Attributes

Parent Element

Description

 Element/Attribute Value

<AgreementRoleScreen>

    

Required:

This is the root element containing the definition for the screen.

  

<AgreementRole>

  

<AgreementRoleScreen>

Required, Repeatable:

This structure defines an Agreement Role type, the associated Clients, and the dynamic fields it will contain.  It is repeated to define multiple Agreement Role types.

  
 

TYPECODE

<AgreementRole>

Required:

This attribute identifies the type of Agreement Role being defined.

Values:

  • literal

    • This must be a CodeValue from AsCodeAgreementRoleType.
 

DISABLEBYAGREEMENTSTATUS

<AgreementRole>

Optional:

This attribute indicates when the fields are disabled based on the Agreement Role's status.

Values:

  • literal

    • This must be a CodeValue from AsCodeAgreementRoleStatus.
 

ALLOWGROUPCUSTOMER

<AgreementRole>

Optional:

This is an indicator that the Agreement Role will be available for selection under the "Find Customer" tab in OIPA.  If there are no Agreement Role types defined by this screen rule, the "Find Customer" tab will not be available on the screen.

Values:

  • No

    • default

    • The Agreement Role type will not be available for selection under the "Find Customer" tab.

  • Yes

    • The Agreement Role type will be available for selection under the "Find Customer" tab.

<ClientTypes>

  

<AgreementRole>

Optional:

This element is a structure to identify all the Client types that can be associated to the Agreement Role's type.

  

<ClientType>

  

<ClientTypes>

Required, Repeatable:

This element provides a single Client Type code value and is repeated to provide multiple Client Type codes.  The purpose of the element is to populate the Client Type options for the "Find Client" and "New Client" screens triggered by users attempting to associate Clients to Agreement Roles.  If no Client Type codes are defined for an Agreement Role type, no "Find Client" or "New Client" screen will be presented to associate a Client to the Agreement Role type.

Values:

  • literal

    • This must be a CodeValue from AsCodeClientType

<Subsections>

  

<AgreementRole>

Optional:

This element defines one or more collapsible sections of dynamic fields.  This allows configuration to define and organize the dynamic field presentation.

  
 

SECTIONNODES

<Subsections>

Optional:

All subsections can initially be displayed as collapsed or expanded.

Values:

  • Collapsed

    • default

    • All sections are initially collapsed.

  • Expanded

    • All sections are initially expanded.

<Subsection>

  

<Subsections>

Required, Repeatable:

This element defines a single collapsible section containing a set of dynamic fields.  More than one of these sections may be defined.

  
 

TITLE

<Subsection>

Optional:

This attribute gives the section a title on the subsection's header.  If the attribute is not provided, the subsection's header is blank.

 Values:

  • literal
 

SECTIONNODES

<Subsection>

Optional:

This defines whether the subsection will initially be collapsed or expanded.  In this position of the rule the element provides individual control over the subsection that may be different than the same attribute on the parent element.

Values:

  • Collapsed

    • default

    • The individual section is initially collapsed.

  • Expanded

    • The individual section is initially expanded.

<Fields>

  

<Subsection>

Required:

See Fields Elements.

  

<ScreenMath>

  

<AgreementRole>

Optional:

See ScreenMath Element.

  

<Events>

  

<AgreementRole>

Optional:

See Action/Events element.

  

<Actions>

  

<AgreementRole>

Optional:

See Action/Events element.

  

XML Schema

<AgreementRoleScreen>
    <AgreementRole TYPECODE="[code]" ALLOWGROUPCUSTOMER="[No | Yes]" DISABLEBYAGREEMENTSTATUS="[code]">
        <ClientTypes>
            <ClientType>[type code]</ClientType>
            <ClientType>...</ClientType>
        </ClientTypes>
        <Subsections SECTIONNODES="[Collapsed | Expanded]">
            <Subsection TITLE="[literal]" SECTIONNODES="[Collapsed | Expanded]">
                <Fields>...</Fields>
            </Subsection>
            <Subsection>...</Subsection>
        </Subsections>
        <Events>...</Events>
        <ScreenMath>...</ScreenMath>
        <Actions>...</Actions>
    </AgreementRole>
    <AgreementRole>...</AgreementRole>
</AgreementRoleScreen>

XML Example

<AgreementRoleScreen>
    <AgreementRole TYPECODE="01" ALLOWGROUPCUSTOMER="No" DISABLEBYAGREEMENTSTATUS="ACTIVE">
        <ClientTypes>
            <ClientType>01</ClientType>
            <ClientType>02</ClientType>
            <ClientType>20</ClientType>
        </ClientTypes>
        <Subsections>
            <Subsection TITLE="Detail Section 1" SECTIONNODES="Expanded">
                <Fields>
                    <Field>
                        <Name>IdentifierNumber</Name>
                        <Display>Identifier Number</Display>
                        <DataType>Identifier</DataType>
                        <Disabled>Yes</Disabled>
                        <Parts>
                            <Part TYPE="VALUE">ARN</Part>
                            <Part TYPE="SEQUENCE" FORMAT="00000000">IdentifierNumber</Part>
                        </Parts>
                    </Field>
                    <Field>
                        <Name>AgreementRoleType</Name>
                        <Display>Agreement Role Type</Display>
                        <DataType>Text</DataType>
                    </Field>
                    <Field>
                        <Name>AgreementRoleStatus</Name>
                        <Display>Agreement Role Status</Display>
                        <DataType>Combo</DataType>
                        <Query TYPE="SQL">SELECT CodeValue, Longdescription From AsCode WHERE CodeName = 'AsCodeAgreementRoleStatus' ORDER BY 2</Query>
                    </Field>
                </Fields>
            </Subsection>
        </Subsections>
    </AgreementRole>
    <AgreementRole TYPECODE="02" ALLOWGROUPCUSTOMER="NO" DISABLEBYAGREEMENTSTATUS="ACTIVE">
        <ClientTypes>
            <ClientType>02</ClientType>
        </ClientTypes>
        <Fields>
            <Field>
                <Name>IdentifierNumber</Name>
                <Display>Identifier Number</Display>
                <DataType>Identifier</DataType>
                <Disabled>Yes</Disabled>
                <Parts>
                    <Part TYPE="VALUE">ARN</Part>
                    <Part TYPE="SEQUENCE" FORMAT="00000000">IdentifierNumber</Part>
                </Parts>
            </Field>
            <Field>
                <Name>AgreementRoleType</Name>
                <Display>Agreement Role Type</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>AgreementRoleDynamicField1</Name>
                <Display>Agreement Role Dynamic Field1</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>AgreementRoleDynamicField2</Name>
                <Display>Agreement Role Dynamic Field2</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>AgreementRoleStatus</Name>
                <Display>Agreement Role Status</Display>
                <DataType>Combo</DataType>
                <Query TYPE="SQL">SELECT CodeValue, Longdescription From AsCode WHERE CodeName = 'AsCodeAgreementRoleStatus' ORDER BY 2</Query>
            </Field>
        </Fields>
    </AgreementRole>
    <AgreementRole TYPECODE="03" ALLOWGROUPCUSTOMER="NO" DISABLEBYAGREEMENTSTATUS="PENDING,ACTIVE">
        <ClientTypes>
            <ClientType>02</ClientType>
        </ClientTypes>
        <Fields>
            <Field>
                <Name>IdentifierNumber</Name>
                <Display>Identifier Number</Display>
                <DataType>Identifier</DataType>
                <Disabled>Yes</Disabled>
                <Parts>
                    <Part TYPE="VALUE">ARN</Part>
                    <Part TYPE="SEQUENCE" FORMAT="00000000">IdentifierNumber</Part>
                </Parts>
            </Field>
            <Field>
                <Name>AgreementRoleDynamicField1</Name>
                <Display>Agreement Role Dynamic Field1</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>AgreementRoleDynamicField2</Name>
                <Display>Agreement Role Dynamic Field2</Display>
                <DataType>Text</DataType>
            </Field>
            <Field>
                <Name>AgreementRoleStatus</Name>
                <Display>Agreement Role Status</Display>
                <DataType>Combo</DataType>
                <Query TYPE="SQL">SELECT CodeValue, Longdescription From AsCode WHERE CodeName = 'AsCodeAgreementRoleStatus' ORDER BY 2</Query>
            </Field>
            <Field>
                <Name>AgreementRoleType</Name>
                <Display>Agreement Role Type</Display>
                <DataType>Text</DataType>
            </Field>
        </Fields>
    </AgreementRole>
</AgreementRoleScreen>