You are here: Business Rules > Attached Rules > CreateSegments

CreateSegments

Description

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.

CreateSegments Element/Attribute Table
Element/Tab	Definition	Attribute	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: A literal code value. “24”, the default value, means the default segment and allows the segment to be visible in OIPA. This element provides a value for the status code column on the new segment.
<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.
<Roles>	Optional element
<Role>	Required and repeatable
		ROLECODE	Required attribute; MathVariable to populate role code; a singular role code.
		CLIENTGUID	Required attribute; MathVariable to populate ClientGUID. A singular ClientGUID.
<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.

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>

</CreateSegment>

</CreateSegments>

Schema Example

<CreateSegments>

<Tests>

<Test>[conditional expression]</Test>

. . .

</Tests>

<CreateSegment SEGMENTNAME="[literal segment name]" STATUSCODE="[code value]">

<Tests>

<Test>[conditional expression]</Test>

. . .

</Tests>

<Fields>

<Field>

<Name>[segment field name]</Name>

<Value>[math variable|activity field]</Value>

</Field>

<Field>

. . .

</Field>

. . .

</Fields>

<Roles>

<Role ROLECODE="[singular role code]" CLIENTGIUD="[singular ClientGUID]"</Role>

<Fields>

<Field>

<From></From>

<To></To>

</Field>

</Fields>

</Role>

</Roles>

</CreateSegment>

<CreateSegment>

. . .

</CreateSegment>

. . .

</CreateSegments>