This interface provides the ability for ALIP to invoke an external Producer Details Service that returns the details of an Agent that can be used by ALIP business configuration to render the display of the Producer or as needed for any other business processes.
The Producer Details interface can be invoked as a SOAP/REST call to the external Producer Details web service using an ACORD message with transaction type 22809.
This integration has currently been configured in ALIP for the following trigger points:
Trigger1: Upon clicking “View Detail” for an Agent on an inforce Contract.
Trigger2: Upon selecting one of the Agent Records from the displayed Agent Search Results on the Contract Role Change for Agent.
Trigger3: Upon selecting one of the Agent Records from the displayed Agent Search Results on the Post Submit “View/Update” edit.
Trigger4: Upon selecting an Agent Record from the displayed Agent Search Results in the Application Submission process.
This configuration can be extended by client teams, to any ALIP UI screen that needs to fetch Producer details from an external system.
The invocation of this interface via ALIP UI on Role History can be controlled by a flag – Bypass Agent Details. If a client needs to switch off this external agent details, then it can be done by switching the flag value via business configuration lookup tables.
| No. | Trigger Point | Agent Validation Rule group Call |
| 1 | “View Detail” in ALIP Contract Role History Page | INT - Agent View Details Main Post Issue |
| 2 | Contract Role change for Agent in Contract Role History page | INT - Additional Info Page Start |
| 3 | Post Submit “View/Update” edit. | Page Start Rule - Post Submit Agent Information Details |
| 4 | Selecting an Agent Record from the displayed Agent Search Results in the Application Submission process. | App - Application Defining Set Tags and Validations |
The following products are in scope:
. Deferred Annuity
. Immediate Annuity
. Term Life Insurance
. Universal Life
. Whole Life Insurance
The integration is applicable for all Application and Contract statuses
| TR ID# | Technical Requirements |
| TR1 | ALIP interface will convert the XML request to ACORD format |
| TR2 | Integration failure occurs when any mandatory tags are not received in the ACORD response. The details of the mandatory fields are defined in the data mapping sheet in section 3.8.10 |
| TR5 | The request and response transformation will be as per data mapping sheet defined in section 3.8.10. |
| TR6 | ALIP can connect to external service using REST or SOAP. For REST, support is provided for OAuth2 authentication. For SOAP support is provided for Basic authentication. |
| BR ID# | Business Requirements |
| BR1 | The Producer Details are retrieved from the external system based on the Producer Code. The producer details include demographic details of the Agent like Addres, Email Address, Phone Number etc. |
| BR2 | Business configuration rules will invoke the Agent Details Integration point with one to many Producer Codes in the request to the ALIP interface |
| BR3 | The validations performed on the input fields are limited to input parameter length and Non empty Producer Code. A maximum of 10 producer codes are supported to be sent in the request to the external system. |
| BR4 | In order to keep the ACORD request structure generic and cater to multiple external systems, validation of the required fields and any other business validations will be enabled via Business rules, that can be changed per the client requirements. |
| BR5 | ALIP will concatenate the CarrierCode to the Agent Code and save it as the Writing Code in ALIP. Writing code = CarrierCode+AgentCode on the basis of CombineCarrierCodeToAgentCode property Value. If It is yes then The UI will display the Agent Code as the composite value. |
| BR6 | Two new data elements will be added in the response to capture/display the Agent Special Instructions and Agency Special Instructions. These 2 data items will not be persisted in ALIP database. |
) ALIP Business rules will trigger the Agent details interface and push a message to the ALIP request queue.
) If “AdditionalProcessingIndicator” tag is set to ‘Y’ in the trigger input, integration will call the rulegroup “INT-Agent Pre Validation Rule” to check if the mandatory custom fields are available.
) If “AdditionalProcessingIndicator” tag is set to ‘N”, integration will not invoke the rule group and the request is sent to external system without performing on additional validations on the data being sent.
) The request is routed to the ALIP interface where the message is translated to ACORD 22809 format and message is posted to the external system to fetch the agent details.
) The response message returned by the external service, is translated to ALIP format and sent back to the invoking trigger point.
) Business configuration will parse this response and display to the user on the based on the trigger point.
N/A
. The Agent data must be of the type individual/company
. This interface is tested on below combinations only:
• SOAP with namespace, without authentication
• REST without namespace with Oauth and POST.
This can be further enhanced to work with other combinations, based on client’s requirement
) Connectivity details to the external systems are highlighted below.
• The connection type for REST/SOAP is configurable for Accenture Dev team, and will be a one time setting. Allowed values are REST and SOAP. Connection Type is set as below:
AGENT_DETAILS.ExternalServiceType=REST
OR
AGENT_DETAILS.ExternalServiceType=SOAP
• In order to support SOAP connection SOAP Action and URL of external system is required. It is set as below in property file. IntegrationPoint.SOAP.{RequiredDetails}.
AGENT_DETAILS.SOAP.Auth=None
AGENT_DETAILS.SOAP.Url= http://vm-int1.navisys.com:8006/mockAgentDetailsServiceBinding
AGENT_DETAILS.SOAP.Action= http://www.client.com/ann/FinancialProfessionalManagement/FinancialProfessionalManagement_V1.0.wsdl/AgentDetailsRequest
• In order to support SOAP connection SOAP Action and URL of external system is required. It is set as below in property file. IntegrationPoint.SOAP.{RequiredDetails}.
AGENT_DETAILS.SOAP.Auth=Basic
AGENT_DETAILS.SOAP.Url= http://vm-int3.navisys.com:8006/mockAgentDetailsServiceBinding
AGENT_DETAILS.SOAP.Action= http://www.client.com/ann/FinancialProfessionalManagement/FinancialProfessionalManagement_V1.0.wsdl/AgentDetailsRequest
• REST connection supports OAauth2 authentication as well, if it is not required it can be turned off. If required token generation details will be required as below.
Oauth2Token.AuthParams=dfsfdhhkkj:gygyuujjlkkj (ClientSecretID:Pwd)
Oauth2Token.Url=http://vm-int1.navisys.com:8084/token(Sample URL, needs to be replaced with client token generation url)
Token Generation Currently supports only application/json format
• The generated token can be cached for certain duration as per client’s requirement. Default Property setting for it will be 0 ms. This can be changed to for example 7200ms
tokenTimeToLive=0
• REST connection supports both XML and JSON content type with POST request. REST connection details are required as below. IntegrationPoint.REST.{RequiredDetails}.
AGENT_DETAILS.REST.AuthReqd=Yes
AGENT_DETAILS.REST.AuthType=OAuth
AGENT_DETAILS.REST.ContentType=XML or JSON
AGENT_DETAILS.REST.Url=http://localhost:8089/annuity/v1/advisors/lookup
AGENT_DETAILS.REST.RequestType=POST or GET
• In case connection to the external REST and SOAP service fails API will retry to connect to service. This setting is also configurable as below. Default setting will be 3 retries.
SOAPConfigurableRetryCount=3
SOAPConfigurableBackOffPeriod=0
RESTConfigurableRetryCount=3
RESTConfigurableBackOffPeriod=0
• ALIP will concatenate the CarrierCode to the Agent Code and save it as the Writing Code in ALIP. Writing code = CarrierCode+AgentCode on the basis of CombineCarrierCodeToAgentCode property Value. If It is yes then The UI will display the Agent Code as the composite value.
IX.AgentInterface.CombineCarrierCodeToAgentCode=No
• API provides the abitity to connect to extetrnal system using namespace. If namespace is required to connect to external system below setting is required. If this setting is provided API will apply it to the external service request and remove the same once the external service response is received before passing it for further processing.
AGENT_DETAILS.Namespace= http://www.client.com/ann/AgentDetaillsRequest_V1.0.xsd
Please refer to spreadsheet below for the request Mapping
Included in the list above.
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | The interface call was successful with details being returned in the output. It can have multiple Producer Codes. | 1 | Success | Informational | TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1 |
| #2 | Unexpected error/exception in the processing. Due to which no data is displayed in the output | NA | System ErrorNote : Any issue with the ALIP systemFrom development perspective it can happen when there is a code failure | fatal | AGENT_CALL_FAILED |
| #3 | XSD Validation Error when we do not have the mandatory tag being generated in the ACORD response e.g. TransRefGUID | NA | XSD validation Error where a mandatory tag in the ACORD response is not returned | fatal | |
| #4 | Timeout Error | NA | Timeout error where it takes longer than expected to receive the reponse from the external system | fatal | |
| #5 | No results returned | 1 | No Search results returned for the producer code sent through the request | Informational | NO_SEARCH_RESULT |
| #6 | More than 10 producer code | 1 | No Search results returned as more than 10 producer code passed in the request | fatal | |
| #7 | Producer Code length cannot be greater than 15 | 1 | Request Validation Error | fatal | |
| #8 | Producer Code is mandatory | 1 | Request Validation Error | fatal | |
| #9 | Token Generation Failure for REST OAuth2 services due to below reasonsToken Generation Url is not validClient Credentials are not validRequest body (if mandatory) is not provided. | NA | Internal Error | NA | < Error> |