MaintainRelationship
MaintainRelationship is a new attached Business Rule and will be available under the Rules Palette Global Rules Explorer -> Business Rules -> Attached Rules. This Business rule has been added to the TransactionBusinessRulePacket when configured in a transaction.
Element/Tag | Attribute | Definition | Element/Attribute Value and Description |
---|---|---|---|
<MaintainRelationships> |
|
The opening and closing elements of the MaintainRelationships Business Rule. |
|
<Relationships> <Relationship> |
|
Repeatable element: Defines the section holding the Relationship to create on the new client |
. |
Required attribute: |
MathVariable or field containing the PrimaryClientGUID. |
||
PRIMARYGUID |
Repeatable element: Defines the section holding the Relationship to create on the new client |
Identifies the primary client for the relationship time slice. MathVariable or field containing the PrimaryClientGUID |
|
|
SECONDARYGUID |
Optional element: Defines the section holding the tests that will determine if the Client record is to be created. |
Identifies the secondary client for the relationship time slice. MathVariable or field containing the SecondaryClientGUID |
|
Repeatable element: Standard expressions comparing fields or math variables. |
|
|
|
PRIMARYTYPE |
Defines the section holding the Client and Person fields to populate. |
Identifies the Primary client for the relationship time slice. MathVariable or literal code value from AsCode.CodeName: AsCodePrimaryRelationshipType |
|
SECONDARYTYPE |
Required, repeatable element: |
Identifies the secondary client for the relationship time slice. |
|
|
Required element: Defines the source value, field or math variable. |
MathVariable or literal code value from AsCode.CodeName: AsCodeSecondaryRelationshipType |
<To> |
|
Required element: Defines the target field name to which the source value is copied. |
|
<Addresses> |
|
Defines the section holding the Addresses to create for the new client. |
|
<Address> |
|
Repeatable element: Defines the section holding the detail for a specific address. |
|
ROLECODE |
Required attribute: Defines the address role to be created. |
MathVariable or literal code value from AsCode.CodeName: AsCodeAddressRole. |
|
COUNTRYCODE |
Required attribute: Defines the country context for the address role to be created. |
MathVariable or literal code value from AsCountry |
|
<Tests> |
|
Optional element: Defines the section holding the tests to determine if the Address record is to be created. |
|
<Test> |
|
Repeatable element: Standard expression comparing fields or math variables. |
|
<Fields> |
|
Defines the section holding the Address fields to populate. |
|
<Field> |
|
Required, repeatable element: |
|
<From> |
|
Required element: Defines the source value, field or math variable. |
|
<To> |
|
Required element: Defines the target field name to which the source value is copied. |
|
<Relationships> |
|
|
|
<Relationship> |
|
Optional element: Defines the section holding the Relationship to create on the new client. |
|
PRIMARYGUID |
Required attribute: Identifies the Group Customer with whom the relationship is to be created. |
MathVariable or field containing a Group Customer GUID. |
|
PRIMARYTYPE |
Required attribute: Defines the primary relationship type with the Group Customer. |
MathVariable or literal code value from AsCode.CodeName: AsCodePrimaryRelationshipType. |
|
SECONDARYTYPE |
Required attribute: Defines the secondary relationship type with the Group Customer. |
MathVariable or literal code value from AsCode.CodeName: AsCodeSecondaryRelationshipType. |
|
EFFECTIVEFROM |
Required attribute: Defines the start date for the relationship with the Group Customer. |
MathVariable or field containing a date.
|
|
RECORDSTATUSCODE |
Required attribute: Defines the record status code for the relationship time slice |
MathVariable or field containing a status code. Code Name: AsCodeChangeStatus. Allowed Value are DRAFT/ACTIVE Default Value is "ACTIVE" |
|
BUSINESSSTATUSCODE |
Optional attribute: Defines the BUSINESSSTATUSCODE for relationship time slice |
MathVariable or field containing a status code. Code Name: AsCodeClientRelationshipBusinessStatus. |
|
<Tests> |
|
Optional element: Defines the section holding the tests to determine if the Relationship record is to be created. |
|
<Test> |
|
Repeatable element: Standard expression comparing fields or math variables. |
|
<Fields> |
|
Optional element: Defines the section holding the Client Relationship fields to populate. |
|
<Field> |
|
Required, repeatable element: |
|
<From> |
|
Required element: Defines the source value, field or math variable. |
|
<To> |
|
Required element: Defines the target field name to which the source value is copied. |
|
<ClassMemberships> |
|
Optional element: Defines the section holding the class memberships to create on the new client |
|
<ClassMembership> |
|
Optional, repeatable element: Defines the section holding the class membership attributes and tests. |
|
CLASSGUID |
Required attribute: Identifies the ClassGUID for the client. |
MathVariable or field containing a Group Customer GUID |
|
EFFECTIVEFROM |
Required attribute: Defines the start date for the class membership. |
MathVariable or field containing a date. |
|
EFFECTIVETO |
Optional attribute: Defines the end date of the class membership. |
MathVariable or field containing a date. |
|
<Tests> |
|
Optional element: Defines the section holding the tests to determine if the class membership is to be created. |
|
<Test> |
|
Repeatable element: Standard expression comparing fields or math variables. |
|
<Activities> |
|
Optional element: Defines the section holding the Activities to create on the new client. |
|
<Activity> |
|
Repeatable element: Defines the section holding the detail for a specific activity. |
|
TRANSACTIONNAME |
Required attribute: Defines the transaction to be created on the new client. |
MathVariable or literal transaction name from AsTransaction |
|
SEQUENCE |
Required attribute: Defines the sequence array the activity will be inserted into. |
ActivityArray MathVariable. |
|
<Tests> |
|
Optional element: Defines the section holding the tests to determine if the Activity record is to be created. |
|
<Test> |
|
Repeatable element: Standard expression comparing fields or math variables. |
|
<Fields> |
|
Required element: Defines the section holding the Activity fields to populate. |
|
<Field> |
|
Required, repeatable element: |
|
<From> |
|
Required element: Defines the source value, field or math variable. |
|
<To> |
|
Required element: Defines the target field name to which the source value is copied. |
"EffectiveDate" is the minimum required input. |
<Organization> |
|
Required when creating Organization records. Repeatable. |
|
TYPECODE |
Required attribute: Defines the Organization type to be created. |
MathVariable or literal code value from AsCode.CodeName: AsCodeOrganizationType. |
|
INTAKERECORD |
Optional attribute: Defines the record in AsIntakeRecord with which the new client will be associated. Note: Only one client may be associated with an INTAKERECORDGUID. Once created, this association cannot be changed. |
MathVariable, Intake field or activity field containing an INTAKERECORDGUID, or an empty string. | |
<Tests> |
|
Optional element: Defines the section holding the tests to determine if the Client record is to be created. |
|
<Test> |
|
Repeatable element: Standard expression comparing fields or math variables. |
|
<Fields> |
|
Required element: Defines the section holding the Client and Organization fields to populate. |
|
<Field> |
|
Required, repeatable element: |
|
<From> |
|
Required element: Defines the source value, field or math variable. |
|
<To> |
|
Required element: Defines the target field name to which the source value is copied. |
|
<Relationship> |
|
Optional element: Defines the section holding the Relationship to create on the new client. |
|
PRIMARYGUID |
Required attribute: Identifies the Group Customer with whom the relationship is to be created. |
MathVariable or field containing a Group Customer GUID |
|
PRIMARYTYPE |
Required attribute: Defines the primary relationship type with the Group Customer. |
MathVariable or literal code value from AsCode.CodeName: AsCodePrimaryRelationshipType. |
|
SECONDARYTYPE |
Required attribute: Defines the secondary relationship type with the Group Customer. |
MathVariable or literal code value from AsCode.CodeName: AsCodeSecondaryRelationshipType. |
|
EFFECTIVEFROM |
Required attribute: Defines the start date for the relationship with the Group Customer. |
MathVariable or field containing a date. |
|
<Tests> |
|
Optional element: Defines the section holding the tests to determine if the Relationship record is to be created. |
|
<Test> |
|
Repeatable element: Standard expression comparing fields or math variables. |
|
<Fields> |
|
Optional element: Defines the section holding the Client Relationship fields to populate. |
|
<Field> |
|
Required, repeatable element: |
|
<From> |
|
Required element: Defines the source value, field or math variable. |
|
<To> |
|
Required element: Defines the target field name to which the source value is copied. |
|
<Addresses> |
|
Optional element: Defines the section holding the Addresses to create for the new client. |
|
<Address> |
|
Required, repeatable element: Defines the section holding the detail for a specific address. |
|
ROLECODE |
Required attribute: Defines the address role to be created. |
MathVariable or literal code value from AsCode.CodeName: AsCodeAddressRole. |
|
COUNTRYCODE |
Required attribute: Defines the country context for the address role to be created. |
MathVariable or literal code value from AsCountry |
|
<Tests> |
|
Optional element: Defines the section holding the tests to determine if the Address record is to be created. |
|
<Test> |
|
Repeatable element: Standard expression comparing fields or math variables. |
|
<Fields> |
|
Defines the section holding the Address fields to populate. |
|
<Field> |
|
Required, repeatable element: |
|
<From> |
|
Required element: Defines the source value, field or math variable. |
|
<To> |
|
Required element: Defines the target field name to which the source value is copied. |
|
<Activities> |
|
Optional element: Defines the section holding the Activities to create on the new client. |
|
<Activity> |
|
Repeatable element: Defines the section holding the detail for a specific activity. |
|
TRANSACTIONNAME |
Required attribute: Defines the transaction to be created on the new client. |
MathVariable or literal transaction name from AsTransaction |
|
SEQUENCE |
Required attribute: Defines the sequence array the activity will be inserted into. |
ActivityArray MathVariable. |
|
<Tests> |
|
Optional element: Defines the section holding the tests to determine if the Activity record is to be created. |
|
<Test> |
|
Repeatable element: Standard expression comparing fields or math variables. |
|
<Fields> |
|
Defines the section holding the Activity fields to populate. |
|
<Field> |
|
Required, repeatable element: |
|
<From> |
|
Required element: Defines the source value, field or math variable. |
|
<To> |
|
Required element: Defines the target field name to which the source value is copied. |
|
XML Example
<MaintainRelationships>
<Relationships>
<Relationship PRIMARYGUID="PrimaryRelationshipClientGUIDMV" SECONDARYGUID="SecondaryRelationshipClientGUIDMV" PRIMARYTYPE="PrimaryRelationshipTypeMV" SECONDARYTYPE="SecondaryRelationshipTypeMV" EFFECTIVEFROM="EffectiveDateMV" RECORDSTATUSCODE="RecordStatusMV" BUSINESSSTATUSCODE="BusinessStatusMV">
<Fields>
<Field>
<From>EmployeeSalaryMV</From>
<To>EmployeeSalary</To>
</Field>
</Fields>
</Relationship>
<Relationships>
<MaintainRelationships>