This interface provides the ability to generate the contract number for the given case number and save a skeleton application in ALIP for the same, if requested. As part of the Contract Number Generation process, ALIP will receive a request in ACORD 106 format from an external system. This interface will receive two indicators, one for contract number generation and another for application creation. Based on these indicators, the interface will perform the required action.
ALIP will process the request and return the generated Contract Number as a response in the ACORD XML format to external systems. ALIP will not run any validations as part of this interface request processing. The Success Response will contain the contract number if generated.
This Interface is applicable for all products in ALIP.
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.36 shall be used to communicate with the external system. |
| TR2 | Client’s System will put a Contract Number Generation request message in the ACORD XML format to ALIP Process Server’s Request Queue. (TransType tc=”106” and TransSubType tc=”10600”) |
| TR3 | ALIP Process Server should process the received ACORD message. If “Generate Contract Number” flag is set to “Yes”, a new contract number should be created corresponding to the case number. If “Generate Contract Number” flag is set to “No”, the contract number is expected to be part of the input and should be saved as a part of application save. |
| TR4 | If the Save Skeleton Application Indicator is set to ‘Yes’ in the request, the application should be saved in ALIP. |
| TR5 | After successful processing, the ALIP interface should return a Success Response with the contract number to the caller. |
| TR6 | This interface will associate any activity with the “Interface User” to indicate an “Interface User” has created or updated the application. |
| TR7 | Any failures or errors that occur during the process will be saved as Integration Failures inside ALIP. |
| BR ID# | Business Requirements |
| BR1 | ALIP Contract Number should always be numeric and match the current ALIP functionality. This should be configurable at the client level. |
| BR2 | If Application Control Number is present in the input xml, it will be used to validate if any application corresponding to this value, already exists in ALIP. If it is in existence, the interface will return an error response to the caller. If an existing application is not found, then a new application with this case number will be generated. |
| BR3 | If the “Generate Contract Number” flag is set to “Yes”, the interface will generate the contract number. |
| BR4 | If the “Generate Contract Number” flag is set to “No”, the interface will extract the contract number from the XML. This Contract number will be saved as part of the Skeleton Application if it is not en existing Contract Number in ALIP. |
| BR5 | If the “Save Application Indicator” is set to “Yes”, the interface will save the provided application information from the input XML into ALIP. No validations are required to be run before saving the message in the ALIP system. If any errors are produced by ALIP system while saving the application, they will be sent as is to the ESB/calling system as a response in addition to generating an Integration Failure. |
| BR6 | If the “Save Application Indicator” is set to “No”, the interface will not save the application information in ALIP. |
| BR7 | Both these flags (“Generate Contract Number” and “Application save”) cannot be set to “No” at the same time. Both these flags can be set to “Yes” at the same time. |
N
Y
None
ALIP will not run any IGO validations as part of this interface request processing.
Contract number in the input would be validated only for empty string.
It is assumed that valid Product Type and Plan Name combination is provided in the input xml, there will be no validations for Product Type and Plan Name combination.
If the “Generate Contract Number” indicator is set to “Yes” and a Contract Number is provided in the input, then the Contract Number provided in the input will be ignored and a new Contract Number will be generated.
It is assumed that if " Generate Contract Number” and “Save Application” indicators are not present in the input, then ALIP will default them to “Yes”.So, client should send value to this tag only if they wish to either not save the application or not generate contract number. If they want both, then it is ALIP default behavior and they can pass the values as YES or not pass anything.
None
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The Skeleton Application Creation with Contract Number Generation is successful. | 1 | Success | Informational |
| 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 | System failed while generating contract number. | 100 | System Error | fatal | |
| #4 | System failed because an application already exists with the same App Control number in case this field is available in request. It is true even for existing contract number. | 100 | Validation Error | Fatal | |
| #5 | Invalid TransType code provided in ACORD xml i.e. /XML/TransType. | 100 | Invalid TransType code provided | Fatal | |
| #6 | Validation errors (e.g.Mandatory elements missing or not having allowable values e.g. Product Type). | 100 | General Error | Fatal | |
| #7 | Validation error.System needs at least one of the indicators (Generate Contract Number or Create Skeleton App) to be set to Yes | 100 | General Error | Fatal | |
| #8 | Invalid PlanName provided in the input XML | 100 | General Error | Fatal | |
| #9 | Contract Number is missing when the indicator for Generate Contract Number is “No” and Create Skeleton App is “Yes” | 100 | General Error | Fatal | |
| #10 | No PlanName provided in the input XML |