This interface facilitates the transmission of task triggers to external systems. These triggers are initiated during key business processes such as Application processing, Transaction handling, and Suspense management, and are intended to be routed to an external Task Management System.
|
TR ID#
|
Technical Requirements
|
|
TR1
|
The interface will use ACORD Standard Version 2.3 with Transaction Type 1217 (Activity Transmittal) to facilitate communication between ALIP and external systems.
|
|
TR2
|
Generate External Task is triggered by ALIP based on business rules and configurations defined by the client, ensuring alignment with operational requirements.
|
|
TR3
|
ALIP logs the invocation of this API in the Integration History and marks the outcome as Success or Failure based on the result of processing.
|
|
TR4
|
The integration supports both REST/JSON and SOAP/XML message formats. External systems are expected to consume these formats and provide an appropriate acknowledgment response.
|
|
TR5
|
ALIP supports the OAuth 2.0 authentication mechanism for secure REST and SOAP communication with external systems.
|
|
TR6
|
In case of a timeout, the integration will automatically retry up to three times (configurable). If retries are unsuccessful, the transaction will be marked as Failed in Integration History. In the event of OAuth authorization failure, no retries will be attempted, and the transaction will be marked as Failed immediately. Clients are expected to monitor the Integration History to detect and act on any failures.
|
|
BR ID#
|
Business Requirements
|
|
BR1
|
The External Task Generation Interface shall be used to transmit task triggers from ALIP to external systems, enabling appropriate action to be taken based on the task context.
|
|
BR2
|
The API invocation must be driven by business rules configured within ALIP. These rules may include events such as Application Submission, Agent Failure, or other business-defined scenarios.
|
|
BR3
|
The outgoing payload must include the following:
-Comprehensive task details, including Reference Type, Reference Number, Comments, Summary, and Description, along with any additional updates or edits made within ALIP
-All relevant Application and/or Policy information
-All associated requirements and related details
|
-ALIP business rules invoke the External Task Generation Service based on predefined business conditions and processes.
-The ALIP Business Configuration team sends triggers using the GenTaskBox structure under /XML/Trigger, ensuring all required tags are included as needed.
-The input trigger data is then pushed to the ALIP Processing Server (Core API) for further processing.
-The Core API validates the trigger to confirm that all required elements are present and properly formatted.
-Based on the type of trigger, the Core API retrieves the necessary data using ALIP Processor APIs:
1.Application Task Trigger: Returns Application data, Policy Summary (application level), Party, Billing, Investment, Arrangement, and Relation data.
2.Suspense Task Trigger: Returns Policy Summary, Transaction, Suspense, Application Summary, Party, Investment, Arrangement, Billing, and Relation data. If the contract number is missing or invalid, only Suspense data is returned.
3.Transaction Task Trigger: Returns Policy Summary, Transaction, Application Summary, Party, Investment, Arrangement, Billing, and Relation data.
4.Cent Task Trigger: Returns only Party data. The Relation block is not included.
5.Other Trigger Types: Returns only task-level information such as Reference Type, Reference Number, Summary, Comments, and Description.
-All output data elements are detailed in the Response Data Elements section. The retrieved data is then transformed into an ACORD-compliant XML format.
-The generated ACORD XML is sent to the external system. The interface expects an HTTP 200 OK response to consider the integration successful.
-If no response is received, or if the response code is anything other than 200, the integration is marked as failed, and an Integration Failure is recorded in the system
NA
-ALIP will send a single Task trigger within a single message for each use case.
-Premium Banking and Disbursement Banking only for Owner role will be displayed.
-Party blocks for Active roles will be displayed.
N/A
Refer to the ‘Request_Elements’ tab of the Data Mapping sheet attached in Section 3.3.10 for Request Data Elements.
Attached spreadsheet provides details for the response elements in ‘Response_Elements’ tab.
* If you are unable to download the file, right-click the icon and select "Open link in new tab".
|
Success
|
Success Scenario Description
|
Message Code
|
Message Description
|
Message Type
|
Additional Comments
|
|
#1
|
The External task Generation call was successful with External Task generation details being returned in the ACORD Request.
|
1
|
Success
|
Informational
|
Success Message should be logged as an Integration Success with status as ‘The transaction was processed successfully ‘.
|
|
Error
|
Success Scenario Description
|
Message Code
|
Message Description
|
Message Type
|
Additional Comments
|
|
#2
|
The External task Generation call was received but there was a failure to generate the ACORD message due to invalid Task Trigger Data or due to invalid Requirement Type or due to errors while extracting Application/Task Data.
|
Error
|
Fatal
|
Generate External Task errors should be logged as an Integration Failure.
|
|
|
#3
|
The External task Generation call was not successful due to errors while sending the message to External System
|
Error
|
Fatal
|
Any errors while sending the message to External System should be logged as an Integration Failure.
|