ClientRelationshipScreen

Element

Attributes

Parent Attribute

Description

<ClientRelationshipScreen>

Required:

This is the opening element that matches the name of the business rule.

<Filter>

<ClientRelationshipScreen>

Optional:

The filter structure expresses conditions upon which the entity's data will not be displayed to a user. The restrictions are based on the user's SecurityGroup membership, the Group Customer's data values and its related data values.

<Conditions>

<Filter>

Required, Repeatable:

This structure defines one or more conditions by SecurityGroup.

SECURITYGROUP

<Conditions>

Required:

The attribute provides a comma-delimited list of Security Group names to associate with the conditional statements contained within this structure. When the user is a member of one of these Security Groups, the conditions are applied to the screen's record data to determine their removal from the screen's presentation.

TYPE

<Conditions>

Required:

This attribute indicates when the conditions express an exclusion or inclusion of data to the presentation. The system currently supports exclusion only.

OPERATOR

<Conditions>

Optional:

The <Conditions> element may contain multiple <Condition> elements. This attribute indicates the relationship between the multiple <Condition> elements. All <Condition> elements apply the same OPERATOR attribute value.

<Condition>

<Conditions>

Required, Repeatable:

The element provides a single condition.

ENTITY

<Condition>

Required:

The attribute provides a table name related to Client Relationships that contain values that should impact the data's presentation on this screen

RELATIONSHIPKEY

<Condition>

Optional:

The attribute provides a further definition for the type of Client Relationship being filtered. This attribute is required when ENTITY attribute is ASCLIENTRELATIONSHIP or ASCLIENTRELATIONSHIPFIELD. These tables store ClientGUIDs in PrimaryClientGUID and SecondaryClientGUID columns and this attribute indicates which column this filter is based upon.

This attribute is ignored when the ENTITY attribute is not ASCLIENTRELATIONSHIP and ASCLIENTRELATIONSHIPFIELD.

<UseBusinessStatus>

<ClientRelationshipScreen>

Optional:

Indicates when a business status is tracked for a Client Relationship as well as the record state.

<ClientTypeIdentifiers>

<ClientRelationshipScreen>

Required:

This element's structure contains multiple groupings of client types that various relationships can reference by the ID.

<ClientTypeIdentifier>

<ClientTypeIdentifiers>

Required, Repeatable:

This element groups multiple client types and assigns the group to an ID that is referenced in the Primary and Secondary relationship configuration. The element is repeated to give definition to the multiple grouping references in the remainder of this rule.

ID

<ClientTypeIdentifier>

Required:

This attribute provides the ID value for the group. It is referenced in the relationships throughout this rule.

<ClientType>

<ClientTypeIdentifier>

Required, Repeatable:

This element provides a single client type code value from AsCodeClientType. One or more client types can make up a group.

<PrimaryRelationships>

Required:

This element is a structure that defines all primary relationships and the secondary relationships associated with each.

<PrimaryRelationship>

<PrimaryRelationships>

Required, Repeatable:

This element defines a single primary relationship. The element is repeated to define multiple primary relationships.

TYPECODE

<PrimaryRelationship>

Required:

This attribute identifies a specific primary relationship type. A primary relationship cannot be defined more than once in this rule.

<AvailableToClientTypes>

<PrimaryRelationship>

Optional:

The structure of this element identifies the client types that can be associated with this primary relationship. If this element is not configured, all client types except ClientType='99' are available.

<ClientTypeIdentifier>

<AvailableToClientTypes>

Required, Repeatable:

This element makes one or more client type codes available to this primary relationship through a client type identifier grouping id defined earlier in the rule. Repeating the element provides multiple client type identifier grouping ids.

<SecondaryRelationships>

<PrimaryRelationship>

Required:

This element's structure defines the characteristics of one or more secondary relationships associated with a primary relationship.

<SecondaryRelationship>

<SecondaryRelationships>

Required, Repeatable:

This element's structure defines a single secondary relationship. Repeating the element defines multiple secondary relationships.

ALLOWGROUPCUSTOMER

<SecondaryRelationship>

Optional:

This attribute allows the secondary relationship to be associated with a GroupCustomer client type creating a hierarchy among the GroupCustomers.

<TypeCodes>

<SecondaryRelationship>

Required:

This element's structure provides one or more secondary relationship types for the primary relationship.

<TypeCode>

<TypeCodes>

Required:

This element identifies a specific secondary relationship type. The screen rule cannot configure the same secondary relationship type more than once within a containing primary relationship.

VALUE

<TypeCode>

Required:

The attribute's value is a secondary relationship type code.

<AvailableToClientTypes>

<TypeCode>

Optional:

The structure of this element identifies each of the primary relationship's client types that can be associated with this secondary relationship. If this element is not configured, all of the primary relationship's client types are available for association with this secondary relationship.

<ClientTypeIdentifier>

<AvailableToClientTypes>

Required, Repeatable:

Each repetition of this element associates a single primary relationship's client type identifier grouping id with this secondary relationship.

<ClientTypeIdentifiers>

<TypeCode>

Optional:

The structure of this element identifies the client types that can be associated with the secondary relationship. If this element is not configured, all client types except ClientType='99' are available.

<ClientTypeIdentifier>

<ClientTypeIdentifiers>

Required, Repeatable:

This element makes one or more client type codes available to this secondary relationship through a client type identifier grouping id defined earlier in the rule. Repeating the element provides multiple client type identifier grouping id.

<Maximum>

<TypeCode>

Optional:

This element provides the maximum number of instances of this secondary relationship contained by the primary relationship. When the maximum is not configured there is no limit.

<Fields>

<SecondaryRelationship>

Optional:

This element defines the dynamic fields for the relationship. 

See Fields Elements.

<Subsections>

<SecondaryRelationship>

Optional:

This element defines one or more collapsible sections of dynamic fields. It provides visual organization of the dynamic fields into one or more sub-sections.

SECTIONNODES

<Subsections>

Optional:

Sections of fields can initially display collapsed or expanded.

<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.

<Fields>

<Subsection>

Required:

See Fields Elements.

This structure provides dynamic fields for the secondary relationship.

<Events>

<SecondaryRelationship>

Optional:

See Action/Events element.

Events defined in this secondary relationship are only applicable to Actions and ScreenMath within the secondary relationship and can only reference fields of the secondary relationship.

<ScreenMath>

<SecondaryRelationship>

Optional:

See ScreenMath Element.

ScreenMath defined in the secondary relationship are only applicable to Events and Actions within the same secondary relationship and can only reference fields of the secondary relationship.

<Actions>

<SecondaryRelationship>

Optional:

See Action/Events element.

Actions defined in the secondary relationship are only applicable to Events and ScreenMath within the same secondary relationship and can only reference fields of the secondary relationship.

<Spawns>

<ClientRelationshipScreen>

Optional:

The persistence of the screen's data can spawn a single Client level activity that completes the time slice process.

<Spawn>

<Spawns>

Required:

Opening element containing a transaction to spawn.

<Transaction>

<Spawn>

Required:

Identifies a transaction to spawn that will complete the creation or modification of a Client Relationship. The transaction must be available from the entity’s context.

SPAWNCODE

Required:

The element identifies how to date the activating activity that is generated from modifying Client Relationships. This code is provided by AsCodeSpawnCode.

FIELD

Required:

The element provides the field that holds a date value that becomes the effective date of the screen's definition time slice. The source data comes from the Plan's time slice that is being modified.

EXECUTIONDATE

<Transaction>

Optional:

The date on which the activity would execute to make the relationship active. For example, a change to the relationship effective in the future may be executed on the present date so the changes become active before they are effective. A date value is required if the activity is not processed immediately.