This interface provides the ability to create task items for a given input request. As part of the Create Task process, ALIP will receive a request in ACORD (tc=’1217’) format from an external system. ALIP will process the request and return a response in ACORD XML format back to the calling external systems.
If the request is processed successfully, ALIP will return the new task ID generated in success response.
If the request fails, ALIP will return appropriate error/failure message in the response.
This Interface is independent of product type in ALIP.
|
TR ID#
|
Technical Requirements
|
|
TR1
|
ACORDv2.36 shall be used to communicate with the external system.
|
|
TR2
|
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
|
After successful processing of the request, ALIP should return a Success Response with the generated Task ID to the caller.
|
|
TR4
|
This interface will associate any new task with the ‘Interface User’ to indicate that the task was created/modified via the interface.
|
|
TR5
|
Any failure or error that occurs during the process will be saved as Integration Failure inside ALIP. As applicable a failure response will be sent back to the calling system.
|
|
TR6
|
Interface should be able to generate a ImageURL based on the URLParameters supplied in the Payload. The formation of URL should be configurable and client teams should have complete ownership of this URL generation logic.
|
|
TR7
|
Interface will also support BASE64 encoded URLParams.i.e. The URL Details passed in input Request under “URLParams” can also be BASE 64 encoded and this will be driven by property setting.
|
|
BR ID#
|
Business Requirements
|
|
BR1
|
This interface would create task and attach external image URL parameter to the image associated to the task.
|
|
BR2
|
If ‘ReferenceType’ and ‘Recipient’ values are sent in the request input, same will be used for processing. Otherwise, they will be derived from a business look up table based on the ‘Category’ value provided in the input.
|
|
BR3
|
If there is no match found for the ‘ReferenceType’ in the look up table for any given Category, the integration request will fail with an error message ‘Unable to determine task reference type’
If there is no match found for the ‘Recipient’ in the look up table for any given Category, the integration request will fail with an error message ‘Unable to determine task group’
|
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.
All Image parameters along with the URL (if applicable) will have the information to launch an image within ALIP. ALIP will not perform any validation on the received parameters (along with the URL). If the URL (or parameter combination) were to be wrong, it may result in user seeing an error in the image window.
Changes to ALIP create task box page to add/update image URL for a given task is not in the scope of this interface.
Query parameters of the URL in with the Task Creation Request must be BASE64 encoded.
There will no defaulting of values on any radio button based on the application information received in the create task input request.
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>
|