The e-Statements is a functionality that allows Customers to enable or disable e-statements, meaning email statements for the transaction done at the Contract Level. The existing Correspondence Override setting which generate Confirms will be used to enable of disable e-statements option.
The Customer will be able to view the selections of e-statements on all his contracts in the Summary Information of the customer. Also, each Contract information will include the selection of e-statements option.
When a customer checks/selects(3-Email for Check and 4-Regular Mail for uncheck) the e-Statements option, the backend system searches for all the Active contracts of the customer and updates the Mailing Type of the particular Correspondence Override to Email.
When a customer unchecks the e-Statements option or wants to unsubscribe from the E-Statements, the Mailing type is reverted to the previous setting that was persisted earlier.
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.36 shall be used to communicate. |
| TR2 | ACORD Tx 228 “ e-Statements tc=189/18903” should be used to set the E-Statements Details |
| TR3 | Interface must always return an error code and desc in the event of a processing failure in addition to HTTP response code. |
| TR4 | For a successful request a return code of 200 is returned. |
| BR ID# | Business Requirements | Interface Design Traceability | Test Case Traceability |
| BR1 | E-statements is an ablity to provide information regarding the e-Statements selection for the contracts in the Customer Summary Information | IEX-IDD-INT-20-7.4 | IEX-IDD-INT-20-11.1 |
| BR2 | E-statements is an ablity to provide information regarding the e-Statements selection in the Contract Information | IEX-IDD-INT-20-7.4 | IEX-IDD-INT-20-11.1 |
| BR3 | E-statements is an ablity to set the Correspondence Mailing Type to Email on enable for a Contract on all Transactions on a specified role, if an setting exists. | IEX-IDD-INT-20-7.4 | IEX-IDD-INT-20-11.1 |
| BR3 | A message “You do not have correspondence settings on the Contract Level” | IEX-IDD-INT-20-7.4 | IEX-IDD-INT-20-11.1 |
The external system would fire the REST URL with the JSON message containing input parameters on the request queue.
ALIP webadapters would pick up, process the message, convert it into XML format, and posts it onto the ALIP request queue.
ALIP process server will pick up the message, convert from ACORD to the canonical format, perform the necessary XSD validations, and other basic validations on the completeness of the correspondence information, existence of the CRM id/External agent ID in ALIP.
Post the necessary validations, it would invoke the necessary ALIP APIs/workflows to update or retrieve the necessary correspondence information from the database.
The licensing information in case of a “GET” request, would be generated in XML format, converted to ACORD format, and sent back to the REST layer.
Here, it would be further converted back into the final JSON output format and returned back to the external system.
This interface provides the ability for viewing if the customer has any correspondence settings available for the Conract.
Upon receiving the request,based on the CRMID, ALIP system checks for the list of contracts where correspondence is set to role specified fo the role and provides the Mailing Type for the contract.
If the validations are successful the the request is forwarded to appropriate API/workflow which converts the response to ACCORD and then into the JSON format.
If the validations fail the appropriate error messages will be displayed on ALIP system next to the licensing request. The status of licensing will reflect the same as in “Error”.
This interface provides the ability to set the Mailing Type to Email or any previous setting for a Contract of the customer.
Upon receiving the request,based on the CRMid, ALIP system gets the contracts for a customer. On receiving the list of contracts, the system changes Mailing Type of the existing Correspondences to Email if e-statements is to be enabled or to the previous setting if e-statements is to be disabled.
If the validations are successful the the request is forwarded to appropriate API/workflow which converts the response to ACCORD and then into the JSON format.
If the validations fail the appropriate error messages will be displayed on ALIP system next to the appointments request. The status of licensing will reflect the same as in “Error”.
N/A
N/A
NA
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The e-statments call for the Customer’s Holding was successful with e-statements details being returned in the output | 1 | Success | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1 |
| #2 | The e-staments call for a single Holding was successful with the e-statements details being returned in the output. | 1 | Success | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1 |
| Error | Error Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The e-statements call for Customer’s Holding was NOT successful due to a technical error or customer not found. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |
| #2 | The e-statements call for Holding was NOT successful due to a technical error or contract not found. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |
| #3 | The e-statements call was to perform the e-statements setings on the Customer was successful with success message in the output | 1 | Success | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1 |
| #4 | The e-statements call was to perform the e-statements setings on the Holding was successful with success message in the output | 1 | Success | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1 |
| #5 | The e-statements call for setting E-staements in the Customer’s Holding was NOT successful due to a technical error or customer not found. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |
| #6 | The e-statements call for E-staements in the Holding was NOT successful due to a technical error or contract not found. | 5 | Internal Error | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5 |