Membership Element
The <membership> configuration is used in transactions to evaluate membership in a class. The <Membership>
element indicates that class membership needs to be evaluated for a client or policy level transaction.
- Transactions at the employee/sponsor Client level will determine Class Membership for the Client for whom the activity is being processed, using the rules for the inherent/supplied Group Customer.
- Transactions at the policy level will determine Class Membership only for the client assigned to the Primary Member role on the policy.
Membership Evaluation
The <Membership> configuration allows a specific Group Customer ClientGUID to be passed or identify that the evaluation should be performed against all the Group Customers a client is linked to. The membership evaluation will then,
- Create the resulting entries in the AsClassMembership table.
- If no Group Customer ClientGUID is passed, the code will run evaluation against all the related Group Customers.
- The membership tab in the Activity Details will be updated to include the Group Customer Name.
| Element/Tag | Definition | Attributes | Element/Attribute Value and Description |
|---|---|---|---|
|
<Membership> |
|
Optional. |
|
|
<ClassGroup>
|
|
Required, repeatable element: The parent element that defines the details of the Class Membership calculation. |
|
| TYPE |
Required attribute: Specifies the Class Group type for the Membership calculation. |
String: A code value from AsCode. |
|
|
DISPLAYMEMBERSHIPCLASS |
Optional attribute: Specifies the Class Membership types to display. |
String: All | LowestOnly All - Displays all available Membership Classes. LowestOnly - Displays only the leaf nodes or lowest level Membership Classes. |
|
|
<WriteMembership> |
|
Optional element: Determines whether Membership records should be written to the database. |
String: Yes | No | Name of an activity field or math variable with a value of Yes or No. Yes - Membership records should be committed to the database. No - Membership records should not be committed to the database. |
| <ClientGUID> | Optional element: Determines the clientGUID of the Group Customer whether the evaluation should be run against. | String:Name of an activity field or math variable. | |
|
<EffectiveFromDate> |
|
Optional element: Defines the effective starting date of the Membership calculation. |
String:SystemDate | Activity:EffectiveDate | Name of an activity date field or math variable. The default value is the activity effective date. |
|
<EffectiveToDate> |
|
Optional element: Defines the effective ending date of the Membership calculation. |
String:SystemDate | Activity:EffectiveDate | Name of an activity date field or math variable. The default value is 12/31/9999. The EffectiveToDate must be on or after the EffectiveFromDate. Note: This will accept null a value and set it to the default value in case the user do not provide a value. |
XML Schema
<Membership>
<ClassGroup TYPE="[code]" DisplayMembershipClass="All|LowestOnly">
<ClientGUID="[mathvariable]">
<WriteMembership>
Yes|No|[text field]|[mathvariable]
</WriteMembership >
<EffectiveFromDate>
SystemDate|Activity:EffectiveDate|[date field|date mathvariable]
</EffectiveFromDate>
<EffectiveToDate>
SystemDate|Activity:EffectiveDate|[date field|date mathvariable]
</EffectiveToDate>
</ClassGroup>
</Membership>
Example
Perform membership evaluation against all the Group Customers
<Membership>
<ClassGroup TYPE="02" DISPLAYMEMBERSHIPCLASS="All">
<WriteMembership>Yes</WriteMembership>
<EffectiveFromDate>Activity:EffectiveDate</EffectiveFromDate>
<EffectiveToDate>EffectiveUntilDateMV</EffectiveToDate>
</ClassGroup>
</Membership>
Supplying a GUID for a specific Group Customer
<Membership>
<ClassGroup TYPE="02" DISPLAYMEMBERSHIPCLASS="All">
<WriteMembership>Yes</WriteMembership>
<EffectiveFromDate>Activity:EffectiveDate</EffectiveFromDate>
<EffectiveToDate>EffectiveUntilDateMV</EffectiveToDate>
<ClientGUID>GroupCustomerGUIDMV </ClientGUID>
</ClassGroup>
</Membership>