ALIP system will be enhanced with an API to provide ability to create tasks via an interface. This interface would create tasks with the related reference type and save all the details of the task.
The response along with success or failure processing indicators will be returned by ALIP to the calling external system. In case of a success response, ALIP will return the response containing the required information i.e. newly generated task ID. Please refer to the Response Data Elements section below for the details.
|
TR ID#
|
Technical Requirements
|
|
TR1
|
This API will allow external client systems to post request to ALIP using Soap based synchronous Webservice call using Basic AUTH security mechanism. Request will contain a user ID and password provided by ALIP.
|
|
TR2
|
Standard ACORDv2.39 format will be used for Request and Response XML.
ACORD Tx 1217 “ Activity transmittal is used to=1217” to create task in ALIP from the external system by employing the following:-
BASIC AUTH
REST application/json
SOAP
|
|
TR3
|
ACORD TX 1217 (System Message Transmittal) will be used for this interface.
|
|
TR4
|
The ACORD request sent will be converted to ALIP canonical format and will be saved as a BLOB in the database which will be tied to the Task ID created by the interface.
|
|
TR5
|
The Task Source will be defaulted to External for tasks created by this Interface.
|
|
TR6
|
Response time of 3 seconds or less is expected for the service calls.
|
|
TR7
|
Interface must always return an error code and description in the event of a processing failure.
The Record will display as Failed in Integration History Page
An integration failure will be recorded in the Integration failure logging table, INTEG.T_INIF_INTEGRATION_FAILURES in the ALIP database.
The task will not be created in the event of failure.
The interface will return an Error Response to the calling system with appropriate Error message.
|
|
TR8
|
Interface should be able to generate a ImageURL based on the ExternalAppID and ExternalImageID supplied in the Payload. The formation of URL should be configurable and client teams should have complete ownership of this URL generation logic.
|
|
BR ID#
|
Business Requirements
|
|
BR1
|
This version will support creation of task same like the previous version. Additionally, this version can accept application data in the input request and attach it to the created task.
|
|
BR2
|
This interface will support receiving parameters as part of Task Create request to create the task.
|
|
BR3
|
If Task Category is ‘Application’ and receives Holding, Party, Relation, FormInstance block in XML in the request, the Reference Application field of the task Summary page will have a link ‘Begin Application’ which will launch a new application workflow with the saved input Application data received with create task request.
|
|
BR4
|
If duplicate TransRefGUID is received in the request the interface will fail to create the task and log an Integration Failure with Duplicate Request.
|
|
BR5
|
If Task Category and Reference Type is other than ‘Application’ and receives Holding, Party, Relation, FormInstance block in XML in the request, then interface will Fail to create the task and log an Integration Failure
|
|
BR6
|
ALIP will perform duplicate check only on the TransRefGUID field. If a task request is sent with the same details as a prior request, but with a new GUID, ALIP will go ahead and create a new task for the request.
|
N/A
This interface is expected to only create a task within ALIP. Any updates for the task will be managed within ALIP.
If the calling external client system happens to process the same message more than once (with a distinct TransRefGUID), ALIP will not do any checks but will create another task in the system.
Client Business process will drive further activities of this task in ALIP which will be covered in Client Business FRD.
The interface will not support Holding/Party/Relation/FormInstance blocks in request with any other Reference type other than “Application”
The interface will not support Holding/Party/Relation/FormInstance blocks in request with any other category type other than “Application”
Interface will perform only XSD validation and duplicate check on the TransRefGUID for the incoming request, no field /data validation is done for the request.
The interface will support Owner, Primary Insured/Primary Annuitant, Agent Roles if present in the request, any other Roles will not be supported. ALIP will not fail xsd validation if the additional Roles are part of request but the information will not be prefilled into the application.
The incoming request will not contain the following:
Scheduled events
Premium information
Coverage amount/ Face Amount
Features
Riders and Benefits
Exchange Replacement
Funds.
XSD validation at ALIP will reject the incoming request if any of the above information are part of the request XML.
The FormInstance data in the inbound 1217 will be mapped to ALIP <Form> object , which will be leveraged by Client Business process as needed.
Task Interface is not responsible for validating, saving or submitting the application. The application must be saved/submitted in ALIP by explicit User actions from ALIP UI.
ALIP User is responsible to provide necessary ALIP Application information required to save/submit application in ALIP database as incoming request will contain partial data.
None
The details of the Request Data elements are provided in the embedded XLS.
* If you are unable to download the file, right-click the icon and select "Open link in new tab".
The details of the Response Data elements are provided in above embedded XLS.
|
Success
|
Success Scenario Description
|
Message Code
|
Message Description
|
Message Type
|
Additional Comments
|
|
#1
|
The Create Task interface executed successfully.
|
1
|
Success
|
Informational
|
Task ID generated will be returned along with the success response
|
|
Error
|
Error Scenario Description
|
Message Code
|
Message Description
|
Message Type
|
Additional Comments
|
|
#1
|
Generic System Failure due to technical errors.
|
100
|
Internal Error
|
Fatal
|
<ResultInfoCode tc="100">
General Error
</ResultInfoCode>
<ResultInfoDesc>
System Error Occurred
</ResultInfoDesc>
|
|
#2
|
System failed while generating creating task.
|
100
|
System Error
|
Fatal
|
<ResultInfoCode tc="100”>
General Error
</ResultInfoCode>
<ResultInfoDesc>
Create Task System Failure Error.
</ResultInfoDesc>
|
|
#3
|
XSD validation failure or field level mandatory failure or allowable value check failure or value is not valid.
|
100
|
XSD Validation Error
|
Failure
|
<ResultInfoCode tc="100">
General Error
</ResultInfoCode>
<ResultInfoDesc>
XSD Validation Error Occurred
</ ResultInfoDesc>
|
|
#4
|
If no ReferenceType is provided in the input request, and an invalid Category value is used to lookup Recipient
|
100
|
Validation Error
|
Failure
|
<ResultInfoCode tc="100">
General Error </ResultInfoCode>
<ResultInfoDesc>
Unable to determine task group.
</ResultInfoDesc>
|
|
#5
|
If no ReferenceType is provided in the input request, and an invalid Category value is used to lookup ReferenceType
|
100
|
Validation Error
|
Failure
|
<ResultInfoCode tc="100">
General Error </ResultInfoCode>
<ResultInfoDesc>
Unable to determine the task reference type.
</ResultInfoDesc>
|
|
#6
|
Incorrect Application number provided as Reference Number in the input XML.
|
100
|
General Error
|
Fatal
|
<ResultInfoCode tc="100">
General Error
</ResultInfoCode>
<ResultInfoDesc>
No Application exist in ALIP for input Reference Number.
</ResultInfoDesc>
|
|
#7
|
Incorrect Contract number provided as Reference Number in the input XML.
|
100
|
General Error
|
Fatal
|
<ResultInfoCode tc="100">
General Error
</ResultInfoCode>
<ResultInfoDesc>
No Contract exist in ALIP for input Reference Number.
</ResultInfoDesc>
|
|
#8
|
Incorrect Requirement ID provided as Reference Number in the input XML. Pass ReferenceType tc code as 5=Requirement
|
100
|
General Error
|
Fatal
|
<ResultInfoCode tc="100">
General Error
</ResultInfoCode>
<ResultInfoDesc>
No Requirement exist in ALIP for input Reference Number.
</ResultInfoDesc>
|
|
#9
|
Incorrect Transaction ID provided as Reference Number in the input XML.
|
100
|
General Error
|
Fatal
|
<ResultInfoCode tc="100">
General Error
</ResultInfoCode>
<ResultInfoDesc>
No Transaction exist in ALIP for input Reference Number.
</ResultInfoDesc>
|
|
#10
|
Incorrect Agent ID provided as Reference Number in the input XML. Pass ReferenceType tc code as 16=Agent.
|
100
|
General Error
|
Fatal
|
<ResultInfoCode tc="100">
General Error
</ResultInfoCode>
<ResultInfoDesc>
No Agent exist in ALIP for input Reference Number.
</ResultInfoDesc>
|