This Interface provides the ability to Re-Index Image metadata received from Client Document Management System to ALIP. The request will contain ALIP Application Number and ALIP Requirement Identifier along with Image metadata to be processed in ALIP system. Re-indexing is categorized into Add and Update operations and the operation to be performed in ALIP will be identified based on Event Type value received in the request.
Add Image – The Interface should Add the Target Image metadata in ALIP for the respective Application Number i.e the Policy Number of Client System, and ALIP Requirement Identifier provided in the request.
Update Image - The Interface should Update Target Image metadata with referenced Application number and Requirement ID with for the given Source Image metadata for the referenced Application Number i.e the Policy Number of Client System, and Requirement Identifier provided in the request.
Delete Image - The Interface should Delete the Source Image metadata in ALIP for the respective Application Number i.e the Policy Number of Client System, and ALIP Requirement Identifier provided in the request.
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.39 shall be used to communicate with the external system. |
| TR2 | This API will allow external client systems to post request to ALIP using RESTful API with Basic AUTH security mechanism. This API will receive ACORD message from external system in JSON format and will respond with ACORD response in JSON format. |
| TR3 | After successful processing of the request, ALIP should return a Success Response. For Add Image operation the generated Image ID will also be sent as part of response to the caller. |
| TR4 | ACORD TX 510 (FormInstance Maintenance) will be used for this interface. |
| TR4 | The requirement identifier can be optional in case DELETE and MOVE operation for the SOURCE FormInstance as mentioned in mapping sheet of section 3.1.8 |
| TR6 | 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 PageAn integration failure will be recorded in the Integration failure logging table, INTEG.T_INIF_INTEGRATION_FAILURES in the ALIP database.The Image operation will not be sucessfull in the event of failure.The interface will return an Error Response to the calling system with appropriate Error message. |
| BR ID# | Business Requirements |
| BR1 | This interface will provide the ability to Add, Update and Delete Image metadata in ALIP for given Requirement of an Application |
| BR2 | The interface will receive the ALIP Application Number (i.e Policy Number of client system) and ALIP Requirement Identifier along with Image Metadata and Image Operation in the request. |
| BR3 | The interface will validate the existence of Application Number and Requirement Identifier with ALIP database. If the validation fails the interface will fail the request and send failure response to caller system |
| BR4 | The interface will receive a single operation as part of request for single Application Number and single Requirement Identifier. |
| BR5 | Once Delete Operation is done successfully the interface will update the Requirement Status comment with a message eg.: ”Document Deleted by ‘%UserID’ on ‘Date & Time’ , Reason: ‘%Reason’” |
| BR6 | Requirement Identifier is optional for DELETE,UPDATE and MOVE Operation for the source block. |
None
The interface will not support multiple operations in request i.e Add ,Update and Delete in single request.
The interface will receive the Application Number which is interpreted as Policy Number for Client System which should be valid Application Number in ALIP. For invalid Application Number the interface will fail the request.
The interface will receive the Requirement Identifier which exists in ALIP . This identifier should also be valid against the Application Number sent in same request. For invalid Requirement Identifier the interface will fail the request.
The interface will not support any modifications on the requirement status.
The interface will support only reindexing of one Image Metadata in single request.
The Image Metadata will be available on Application Summary Page “View Images”.
Currently ALIP UI does not support Image Metadata to be viewed on Requirement Level. The client team will have to enhance to view the image metadata on Requirement Level.
For update operation even if existing image is moved from given Requirement/Application number still the request should populate both Source and Target FormInstance blocks with the same image content. i.e update or move operation will always have Source and Target FormInstance blocks.
None
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The Image Add request received for valid Application Number ,Requirement Identifier and Image Metadata | 1 | Success | Informational | Image ID generated will be returned along with the success response |
| #2 | The Image Update request received for valid Application Number ,Requirement Identifier and Image Metadata | 1 | Success | Informational | Interface will return a success response |
| #3 | The Image Delete request received for valid Application Number ,Requirement Identifier and Image Metadata | 1 | Success | Informational | Interface will return a success response |
| #4 | The Image Delete request received for valid Application Number,Comments,Image Metadata and no Requirement id. | 1 | Success | Informational | Interface will return a success response with the comments in the Requirement ID fetched by interface. |
| #5 | The Image Update request received for valid Source Application Number ,Requirement Identifier to Target Application Number ,Requirement | 1 | Success | Informational | Interface will return a success response |
| #6 | The Image Move request received for valid Source Application Number,Comments and no Requirement Identifier in source to Target Application Number ,Requirement | 1 | Success | Informational | Interface will return a success response with the comments in the source Requirement ID fetched by interface. |
| Error | Error Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | Generic System Failure due to technical errors. | 100 | Internal Error | Fatal | |
| #2 | XSD validation failure or field level mandatory failure or allowable value check failure or value is not valid. | 3 | XSD Validation Error | Failure | |
| #3 | If invalid ALIP Application Number is provided in the input request | 3 | Validation Error | Failure | |
| #4 | If invalid ALIP Requirement Identifier is provided in the input request | 3 | Validation Error | Failure | |
| #5 | Incorrect Requirement Identifier against Application number provided in the input request | 3 | General Error | Fatal | |
| #6 | Invalid Source Image Metadata provided during Image Update request in the input | 100 | General Error | Fatal | |
| #7 | Multiple images found with the source file Name | 100 | General Error | Fatal | |
| #8 | Invalid Source Image Metadata provided during Image Delete request in the input | 100 | General Error | Fatal | |
| #9 | Multiple images found with the source file Name | 100 | General Error | Fatal | |
| #10 | Incorrect Requirement Identifier against Application number provided in the target request block in case of updating from existing requirement ID &App ID (source ) to new application ID and Requirement ID(target). | 3 | General Error | Fatal | |
| #11 | No Requirement ID in target block for Move Operation | 3 | General Error | Fatal |