CreateSegments
This business rule creates one or more new segments on a policy when attached to a transaction. If <Test> configuration is present, the segment creation will be conditional; specifically, when test conditions are satisfied. This rule must be listed in TransactionBusinessRulePacket.
Element/Tag | Attributes | Definition | Element/Attribute Value and Description |
---|---|---|---|
<CreateSegments> |
The opening and closing tag of the CreateSegments business rule. |
||
<Tests> |
Optional This element denotes a section containing one or more conditional expressions that when all are true will allow the rest of the rule to execute. |
|
|
<Test> |
Required, Repeatable Element This element allows the expression of a test condition. |
A string representing an expression that can evaluate to true or false. MathVariables and activity fields may be used within the condition. |
|
<CreateSegment> |
Required, Repeatable: This element identifies a segment and the fields that are created and populated. |
||
SEGMENTNAME |
Required: A literal value that matches the name of the segment exactly. This attribute identifies the segment to create using the segment’s segment name. |
||
STATUSCODE |
Optional: This element provides a value for the status code column on the new segment. |
A literal code value. “24”, the default value, means the default segment and allows the segment to be visible in |
|
PLANSEGMENTNAMEGUID | Optional: Indicates if PLANSEGMENTNAMEGUID needs to be populated for the new segment. By default, it would not be populated. | A MathVariable, Activity field . | |
<Tests> |
Optional: This element denotes a section containing one or more conditional expressions that when all are true will allow the segment to be created. |
||
<Test> |
Required, Repeatable: This element allows the expression of a test condition. |
A string representing an expression that can evaluate to true or false. MathVariables and activity fields may be used within the condition. |
|
<Fields> |
Required, Repeatable: Opening and closing elements to associate segment fields and their values. These values will apply to the specific segment being created. |
||
<Field> |
Required, Repeatable: The opening and closing elements for a segment field definition block. |
|
|
<Name> |
Required: Indicates the segment field that will be created with a value from the <Value> element. |
||
<Value> |
Required: Defines a source for the value being applied to the field indicated by <Name>. |
A MathVariable or activity field from the transaction the rule is attached to. |
|
<MultiFields> | Optional, repeatable element: Defines the multifields to be updated/inserted. | ||
Note: The system will validate named "To" fields against the field name in the MultiField rule for the SEGMENTNAME (AsSegmentName) specified. |
|||
NAME | Required: Specifies the named section of the related entity's Multifield rule. | Literal name | |
END | Required: Specifies the total number of instances of multifields for the named section of the related entity's Multifield rule. If NAME is omitted or does not exist in the MultiField rule, all the fields in the MultiField rule will be repeated for "END" number of times. | Literal Integer or Integer Math Variable | |
<Field> | Optional, repeatable element: Contains the instructions for the specified "To" field. This element (and sub elements) may be omitted if the default field values are desired. | ||
<FromIndexCollection> | Required: A collection of index/value pairs for the target fields. Indices must be unique integers | Math variable collection of index/values. | |
<To> | Required: The target named field in the entity multifield rule | Literal field name | |
<Roles> |
Optional Element |
||
<Role>
|
Required, Repeatable |
||
ROLECODE | Required Attribute |
MathVariable to populate role code; a singular role code. |
|
CLIENTGUID | Required Attribute
MathVariable to populate ClientGUID. |
A singular ClientGUID. |
|
CLIENTGUIDCOLLECTION | The CLIENTGUIDCOLLECTION can be used if multiple Clients are required to be added to the same role. | For CLIENTGUIDCOLLECTION the key is CLIENTGUID and value is PERCENT. | |
<Fields> |
Required: Opening and closing elements to associate role fields and their values. These values will apply to the specific segment role being created. |
||
<Field> |
Repeatable The opening and closing elements for a Role field definition block. |
||
<From> |
Required: Configuration within tags identifies the MathVariable or Field where a value is being obtained. |
||
<To> |
Required: Configuration within tags identifies the Field that is updated. |
||
<BenefitSplits> |
Optional Element |
|
|
<BenefitSplit> |
Creates a new BenefitSplit record for the segment. |
||
BENEFITSPLITCOLLECTION |
Adds the Benefit Funds and Amounts to the Segment. |
Benefit Split Fund Collection |
|
TYPECODE |
The target Benefit Type Code. |
Benefit Type Code |
XML Example
<CreateSegments>
<Tests>
<Test>AddBaseCoverageSegment = 1</Test>
</Tests>
<CreateSegment SEGMENTNAME="Base Coverage" STATUSCODE="24">
<Tests>
<Test>AddBaseCoverageSegment = 1</Test>
</Tests>
<Fields>
<Field>
<Name>SegmentAmount</Name>
<Value>SegmentAmountMV</Value>
<Currency>USD</Currency>
</Field>
</Fields>
<Roles>
<Role ROLECODE="InsuredRoleCode" CLIENTGUID="Activity:InsuredClient">
<Fields>
<Field>
<From>Activity:InsuredIntegerData</From>
<To>CommonRoleField</To>
</Field>
<Field>
<From>Activity:InsuredDateData</From>
<To>RoleTestDate</To>
</Field>
<Field>
<From>Activity:InsuredCheckBoxData</From>
<To>UniqueInsuredField</To>
</Field>
</Fields>
</Role>
<Role ROLECODE="OwnerRoleCode" CLIENTGUID="Activity:OwnerClient">
<Fields>
<Field>
<From>Activity:OwnerIntegerData</From>
<To>CommonRoleField</To>
</Field>
<Field>
<From>Activity:OwnerDateData</From>
<To>RoleTestDate</To>
</Field>
</Fields>
</Role>
</Roles>
<BenefitSplits>
<BenefitSplit BENEFITSPLITCOLLECTION="MathCollection05" TYPECODE="05"/>
<BenefitSplit BENEFITSPLITCOLLECTION="MathCollection51" TYPECODE="51"/>
</BenefitSplits >
</CreateSegment>
</CreateSegments>
XML Schema
<CreateSegments>
<Tests>
<Test>[conditional expression]</Test>
. . .
</Tests>
<CreateSegment SEGMENTNAME="[literal segment name]" STATUSCODE="[code value]" PLANSEGMENTNAMEGUID="[Activity Field Name/Math Variable Name]">
<Tests>
<Test>[conditional expression]</Test>
. . .
</Tests>
<Fields>
<Field>
<Name>[segment field name]</Name>
<Value>[math variable|activity field]</Value>
</Field>
<Field>
. . .
</Field>
. . .
</Fields>
<BenefitSplits>
<BenefitSplit BENEFITSPLITCOLLECTION="[benefit split fund collection name]"
TYPECODE="[benefit type code]"/>
</BenefitSplits >
<Roles>
<Role ROLECODE="[singular role code]" CLIENTGIUD="[singular ClientGUID]" | CLIENTGUIDCOLLECTION="[Collection ClientGUID, [Percent]]">
<Fields>
<Field>
<From></From>
<To></To>
</Field>
</Fields>
</Role>
</Roles>
</CreateSegment>
<CreateSegment>
. . .
<Multifields>
<Field>
<From></From>
<To></To>
</Field>
</MultiFields>
</CreateSegment>
. . .
</CreateSegments>