Activity Address Add and Update Prototype
OIPA provides the ability to configure a transaction that can add or update address information and then attach it to a client or array of client records.
There are a two business rules that can be attached to the transaction to support this functionality.
- CreateClientAddress: attached to a transaction to identify the ClientGUIDor ClientGUIDArray that the address should be added to when the activity successfully processes.
- CopyToAddressFields: attached to a transaction to copy information from Activity fields to Address fields.
In addition, there are two additional business rules that support this functionality.
- AddressScreen: address types and associated fields are defined in this rule. This should not be attached to the transaction.
- MultiFields: this rule can be used to allow users to select a number from a configured drop down box on the screen, which determines the number of subsequent fields that should be displayed.
Refer to the XMLConfiguration Guide for a complete explanation of the elements and attributes supported in each rule.
Configuration Required for Adding or Updating Address Information Using an Activity
There are several steps involved in configuring a transaction that will add or update address information.
- A transaction must be created to capture the address information.
- The CreateClientAddress rule must be attached to identify the client/clients that receive the new address information.
- The AddressScreen business rule must be configured. The transaction will access the rule to pull the address fields in for the user to enter the new address through the use of the <Address> element configured within the transaction configuration.
Prototype Explanation
A prototype was configured to demonstrate all aspects of the activity address functionality. There are six transactions and four business rules that were configured to demonstrate the functionality. An explanation of each piece of configuration is provided below.
Business Rules
-
MultiField-Phones business rule was created. This is a simple two field rule that allows the user to add up to three different types of phones to the Address screen (Home, Work, Cell).
-
AddressScreen business rule was updated to include the newly created MultiField-Phones rule in its Address Type 03, 04, and 05 sections.
-
CreateClientAddress has four versions that were created and attached to AddFamilyAddress, ClientAddressClearOnRecycle, ClientExpireAddDefaultAddress, and ClientExpireAndAddAddress transactions. The configuration demonstrates the <ClientGUID> element (filled using activity Field and also MathVariable), and <ClientGUIDArray> (MathVariable).
-
CopyToAddressFIelds business rule was attached to ClientExpireAddDefaultAddress ClientExpireAndAddAddress transactions, and are used to expire selected addresses.
Transactions
- AddFamilyAddress: this is a policy-level financial non-reversible, non-reversing transaction that contains an <Address> element that uses the DEFAULTADDRESSTYPE attribute. The <AddressTypes> sub-elements limit the number of available address roles. CreateClientAddress is attached to this transaction. The purpose of the transaction is as follows:
- allow the user to select a Client-Role combination on a policy in the Activity Details screen.
- complete a new address for the selected address role country on the activity Address tab.
- generate an array of clientGUIDs (in a math variable) of all clients with the same last name as the Client-Role selected on the Activity Detail screen.
- add the newly created address to each client identified in the ClientGUIDArray. This is governed by the CreateClientAddress rule attached to the transaction. This transaction also makes use of new syntax that allows transaction math to access activity AddressGUID (Activity:Address:AddressGUID) and then use it to access specific Address Field (CountryCode).
- ClientExpireAddDefaultAddress: this is a client-level financial non-reversible/non-reversing transaction that contains an <Address> element that uses the COPYSOURCEADDRESSGUID attribute set equal to Address Field, configured through the use of the <Calculated> element with a METHOD=”FORCE” attribute that identifies the Default Address. This transaction allows a user to accomplish the following tasks:
- expire the default address(through the use of CopyToAddressFields rule)
- add a new address of the same address role (through the use of CreateClientAddress rule and Client GUID math variable). In order to designate this new address as the default address, the user will have to actually go to the Address screen and click on the default radio button.
- ClientExpireAndAddAddress: this is a client-level financial non-reversible, non-reversing transaction that contains an <Address> element that uses <AddressTypes> sub-elements to limit the number of available address roles. This transaction allows a user to accomplish the following tasks:
- select an address to expire
- expire the address (through the use of CopyToAddressFields rule)
- add a new address from the list of address roles designated in <AddressTypes> sub-element (through the use of CreateClientAddress rule and Client GUID field). The user can designate the new address as Default, by actually going to the Address screen and clicking on the Default radio button.
- ClientSpawnAddress: this is a client-level financial non-reversible, non-reversing transaction that contains an <Address> element that uses the COPYSOURCEADDRESSGUID attribute set equal to Address field. This transaction allows a user to accomplish the following tasks:
- select a client address
- spawn a policy-level PolicyAddressChangeLetter activity through the use of spawn code 09
- pass the address GUID of the selected address to activities
- make sure that the spawned policy-level PolicyAddressChangeLetter activity contains Address tab
- PolicyAddressChangeLetter: this is a policy-level financial transaction that contains an <Address> element that uses the COPYSOURCEADDRESSGUID attribute set equal to Address field (with the value passed from ClientSpawnAddress activity).
- ClientAddressClearOnRecycle: this is a client-level financial transaction that contains an <Address> element that uses the COPYSOURCEADDRESSGUID attribute set equal to Address field. This transaction allows a user to accomplish the following tasks:
- demonstrate the ClearOnRecycle functionality of the Address field. Select the Update Address check box, to fill-in the Address field’s combo-box (empty on load), and then select a COPYSOURCEADDRESSGUID attribute. When the activity is processed and then recycled, even though the Address combo-box becomes empty again for the new pending activity, the Address tab of the activity will still reflect the clone of the address that was there while the activity was active. If the user chooses to change the address on the new pending activity, the Address tab should then change the clone to reflect the newly selected address.
- demonstrate the effect of deleting or recycling an activity when it added an address.