Index Import Interface

Request/Response & Json Schema

Overview

This interface provides ALIP the ability to accept and process an Index Investment rates file, that allows for the insert/update of Indices for Index Investment Strategies information in the system

Technical Requirements

TR ID# Technical Requirements Interface Design Traceability Test Case Traceability
TR1 A batch command will be sent to ALIP by the client system, comprising of the name and path of the index values file.    
TR2 ALIP will read the Indices for Index Investment Strategies file, verify that the file format & number of fields match expected data elements, parse the file into multiple records and post each of those records to ALIP queues    
TR3 ALIP will validate each record and then add/update the index values for valid records.
TR4 The status of the index add/update will be returned in the batch response.
TR5 Individual validation failure or failure while updating the rates, would be logged as integration failures, and render the processing as ‘Failed’ that will be returned in the batch response, based on a predefined threshold.
TR6 If the incoming feed file is malformed or unreadable, the error would be logged as integration failures, and the batch status will be FAILED.

Business Requirements

BR ID# Business Requirements Interface Design Traceability Test Case Traceability
BR1 ALIP will load index values for matching index funds that have been previously defined in ALIP Index Funds name table (LIIN)    
BR2 Mandatory fields would be validated for each index, including a check on the presence of the index name in ALIP.
BR3 For valid records, the existing rates information for the specific index and date will be updated with the new rates information and new dates.
BR4 Failed records will be rejected with an integration failure logged for each record.
BR5 Below validations will be performed on incoming feed file:a) Index value should be numeric.b) Index name should exist in ALIP.

Process Flow Diagram

Process Flow Description

The external system will post the comma separated file containing the Indices information and route the rate file to an ALIP internal location.

ALIP would read the Indices information file and save it in the database, after validating that the file is not empty, readable and not malformed. In case of any error, the interface will return an error at this step itself.

ALIP will parse the file into multiple records and send it to the ALIP queues for separate processing, by the ALIP process server.

ALIP will validate that the index name exists in the ALIP Index Names table and mark it failed if not found. For valid index names, it would further process the index value and insert/update accordingly in the ALIP Index Values table.

The status values of each would be aggregated to compute the percentage of records successfully processed. For a predefined percentage threshold, the interface can be set to mark the job as successfully processed as required. E.g. if the threshold is set to 5, the interface would show a successful status if 95%+ records complete successfully.

Final aggregated interface response would be generated based on the above completion status, and sent to the ALIP response queue, where it would be readable by the external systems.

Impact on ALIP system

None

Assumptions

None

Dependencies

N/A

Additional File System Support

Batch job will support default File System. Default File System Can be changed to AWS File System if required using the below document

Request Data Elements

Sample file of Import Index Values

Sample Batch Command Request

Response Data Elements

Sample Batch Command Response

Success/Error Handling

Success Success Scenario Description Message Code Message Description Message Type Additional Comments
#1 The Indices for Index Investment Strategies import execution was successful. 1 Success Informational

Error Error Scenario Description Message Code Message Description Message Type Additional Comments
#1 The Index Values inbound feed interface execution was NOT successful due to technical errors 3 Internal Error fatal Any system error in the individual record processing, will be logged in the integration failures tables.
#2 The Index Values inbound feed interface execution failed due to all rates fields not being present or not valid. 2 No rows found Warning Record specific data error, should be logged in the integration failures tables with appropriate status - ‘FAILED_MANDATORY_OR_VALID_FIELD_VALIDATION’
#3 The Index Values inbound feed interface execution failed as the Index Name does not exist in ALIP 4 Validation failure Warning Record specific data error, should be logged in the integration failures tables with appropriate status - ‘FAILED_INDEX_NAME_VALIDATION’
#4 The Index Values inbound feed interface execution was NOT successful due to the incoming feed file being malformed /unreadable. 5 Batch Failure fatal Error/Exception will be generated, while attempting to parse the file content, which will be logged in the error logs.. The batch job should be marked as FAILED.