Transaction Configuration Requirements

Once a transaction has been configured with at least the required elements, there are two business rules that must be attached so that the transaction will process successfully.  These rules are automatically attached to the transaction when it is created in the Rules Palette. Also the transaction must be listed in the EligibleTransactionByPolicyStatus rule and security access must be granted to appropriate security groups or it will not be visible in OIPA. A description of these requirements is listed below.    

Note: Specific values from the database can be retrieved without writing SQL statements, by using the available defined prefixes and fields for configuration. Please see the Available Prefixes and Fields for Configuration for a listing. 

Required Transaction Elements

There are only two elements that must be present in a transaction.  The first is the <Transaction> opening and end tag and the second is <Effective Date>.  All other elements are optional and are only configured if they are required in order for the transaction to process.

Example of Transaction Rule XML

TransactionCosmetics Business Rule

The XML data of a TransactionCosmetics rule controls the icon, button and reverse icon for the transaction.   Also, a value from the transaction’s XML may be displayed on the Activity screen.  A listing of available icons can be found in the TransactionCosmetics section of the configuration guide.

Example of TransactionCosmetics Rule XML

TransactionBusinessRulePacket Business Rule

The TransactionBusinessRulePacket controls the processing order for any of a transaction's attached business rules.  All rules attached to a transaction must be listed in the TransactionBusinessRulePacket business rule in the order that they should process.  Exceptions to this are rules that do not require transaction processing for the rule to be invoked.

Including Rules in TransactionBusinessRulePacket

Include/Exclude	Rule Name
Attached Rules to Include	CopyToClientFields
	CopyToPolicyFields
	CopyToRoleFields
	CopyToSegmentFields
	ReassignAllocations
	RolesExist
	ShadowPendingActivity
	StatusChange
	ValidateExpressions
Attached Rules to Include	ReassignAllocations
	RolesExist
	ShadowPendingActivity
	StatusChange
	ValidateExpressions
Attached Rules to Exclude	ActivitySummary
	ConfirmationScreen
	CopyToScheduledValuationFields
	DisbursementNumber
	FundListForAllocation
	GenerateDocument
	QuoteScreen
	TransactionBusinessRulePacket
	TransactionCosmetics
	VerificationScreen

Rules Palette View of Attached Rules to List and Attached Rules(Non-Packet) Not to List

Example TransactionBusinessRulePacket Business Rule XML

Note:  The Rules Palette automatically updates the TransactionBusinessRulePacket business rule’s XML when you override an attached business rule with the rule's name.  Depending on when you attach various attached business rules to a transaction they might not be listed in the correct processing order in the TransactionBusinessRulePacket business rule.

EligibleTransactionByPolicyStatus

Policy level transactions for a plan must be listed in the EligibleTransactionByPolicyStatus business rule according to policy status.  If you don't have your transaction information added or it is added in the wrong status your transaction will not show in the OIPA Activity drop-down box. Do NOT attach this business rule to your transaction. This is a plan rule override business rule. This configuration needs to run prior to transaction configuration in order for the transaction to be listed in the Activities drop-down box for that plan and the user.  You may list your transaction multiple times in this business rule so it is available in different policy statuses, if applicable. You also use this business rule to configure if the transaction is processed by an end user or automated by the system.

Example EligibleTransactionByPolicyStatus Rule XML

In the Rules Palette, when you initially create a transaction, you will notice in Step 2 of the wizard that it asks what status you would like your transaction to appear in.  Even if you specify this, you must still configure the EligibleTransactionByPolicyStatus business rule.

Security Access

See the Security section of the Rules Palette help system for steps on how to add a transaction to a security group.