Membership Element

The <Membership> element triggers the evaluation of class memberships for all participants in a Group Customer and related Group Customers or for a Policy's Primary Member client. This is applicable to a Group Customer level activity or Policy level activity. The following describes the general behavior:

  • If configured in a Group Customer level activity and a ClientGUID is provided, membership evaluation is limited to all participants of the Group Customer identified by the <ClientGUID> element.

  • If the <ClientGUID> element is not configured in a Group Customer level activity, membership evaluation is processed for all participants of the activity's Group Customer and all its related Group Customers.

  • If the element is configured in a Policy level activity, membership is evaluated for the Policy's Primary Member role and to all related Group Customers the member is associated with.

  • The results of membership may be persisted in the AsClassMembership table.

  • The results of membership will be displayed in a Membership tab in Activity Details.

MembershipElement: Elements and Attributes

Element

Parent Element

Attribute

Description

<Membership>

<Transaction>

  

Optional:

This element triggers Membership processing for the Activity.

<ClassGroup>

<Membership>

  

Required, Repeatable:

This contains the definition for evaluating membership of a Group Customer or membership of a Primary Member in its Group Customer.  An activity may contain this element multiple times for the multiple memberships various clients may have.
 

<ClassGroup>

TYPE

Required:

This identifies the class group type by its code value.  The definition in the parent element applies to this class group type. 

Values:

  • code value from AsCodeClassGroupType
 

<ClassGroup>

DISPLAYMEMBERSHIPCLASS

Optional:

Indicates which class membership types to display.

Values:

  • All:

    • Displays all available Membership Classes

  • LowestOnly:

    • Displays only the leaf nodes or lowest level Membership Classes

<ClientGUID>

<ClassGroup>

  

Optional:

This element identifies the Group Customer by its ClientGUID for which membership will be evaluated.  If this element is not configured in a Group Customer activity, membership evaluation is processed for all participants of the activity's Group Customer and all its related Group Customers.  If the element is configured in a Policy level activity, membership is evaluated for the policy's Primary Member role and for all related Group Customers the member is associated with.

Values:

  • field

  • variable

<WriteMembership>

<ClassGroup>

  

Optional:

Indicates the persistence of Membership records in the database.

Values:

  • Yes

    • Default

    • Membership records are committed to the database

  • No

    • Membership records are not committed to the database

  • field

  • variable

<EffectiveFromDate>

<ClassGroup>

  

Optional:

Provides the effective starting date of the Membership. The value must be a valid date.

Values:

  • Activity: EffectiveDate

    • default

    • The resulting date is the activity's effective date value.

  • SystemDate

    • The resulting date is the system date value.

  • field

  • variable

<EffectiveToDate>

<ClassGroup>

  

Optional:

Provides the effective end date of the Membership. The value must be a valid date.  

Values:

  • "12/31/9999"

    • default

    • The resulting date is the literal value.

  • SystemDate

    • The resulting date is the system date value.

  • Activity: EffectiveDate

    • The resulting date is the activity's effective date value.

  • field

  • variable

XML Schema

<Transaction>
...
    <Membership>
        <ClassGroup TYPE="[class group type]" DISPLAYMEMBERSHIPCLASS="[class membership type]">
            <ClientGUID>[field | variable]</ClientGUID>
            <WriteMembership>[Yes | No]</WriteMembership>
            <EffectiveFromDate>[system date | date field]</EffectiveFromDate>
            <EffectiveToDate>[system date | date field]</EffectiveToDate>
        </ClassGroup>
        <ClassGroup>...</ClassGroup>
    </Membership>
...
</Transaction>

XML Example 

<Transaction>
...    
    <Membership>
        <ClassGroup TYPE="02" DisplayMembershipClass="All">
            <ClientGUID>GroupCustomerMV</ClientGUID>
            <WriteMembership>No</WriteMembership>
            <EffectiveFromDate>Activity:EffectiveDate</EffectiveFromDate>
            <EffectiveToDate>SystemDate</EffectiveToDate>
        </ClassGroup>
    </Membership>
...
</Transaction>