Destinations

A Destination describes a system with which the Oracle Insurance Gateway interacts; to collect data, invoke a process or to deliver data.

Oracle Insurance Gateway supports the following destination types:

REST: This destination type facilitates Oracle Insurance Gateway to communicate with REST endpoints. For example, to communicate with the generic api in OHI Claims, a destination of type REST must be set up.
SFTP: This destination type facilitates Oracle Insurance Gateway to communicate with SFTP endpoints.
FILEUPLOAD: This destination type enables Oracle Insurance Gateway to upload data files in OHI applications using Data File Set Integration Point.
DOCUMAKER: This destination type is used by Oracle Insurance Gateway to communicate with Documaker application endpoints.
FUSIONLOAD: This destination type facilitates Oracle Insurance Gateway to upload a zip file to Fusion Universal Content Management (UCM), load data from the file in the open interface tables and finally importing that data into Fusion.
FUSIONSUBM: This destination type enables Oracle Insurance Gateway to submit a Fusion ESS Job Request and to monitor the job in a polling manner until an end state is reached.
FUSIONREPT: This destination type is used by Oracle Insurance Gateway to submit a request to run a report in Fusion. The report output is made available as a data file in a data file set.
AGENT: This destination type facilitates the Oracle Insurance Gateway to communicate with the OHI Agent. The Message that is constructed by the gateway is sent across a Web Socket channel to the Agent using this destination type.

Except for the AGENT destination type, the destination types have the following common settings:

Field Description

Field	Description
code	The unique name of the destination. Example: "Documaker"
credentialKey	The credential key to be used to invoke the destination. It is essentially the authentication/authorization information needed by the target application to authenticate/authorize Oracle Insurance Gateway. Credentials can be set by configuring username and password using the credential integration point. For details refer to the section credential in the guide.
addressKey	The Universal Resource Locator (URL) of the destination.This is typically a system property key, for which a value is derived at runtime from the environment specific properties. This field should always start with prefix 'address.key.' Example: When an address key is set up as 'address.key.claims.service.uri', Oracle Insurance Gateway expects a system property 'address.key.claims.service.uri". This property must then have a valid URL as a value. Oracle Insurance Gateway uses this URL as the endpoint or constructs appropriate endpoint. Please note, when Oracle Insurance Gateway’s built in framework is used to invoke query api, extract or activity endpoints in an another OHI application, the address key URL value should be till the context root of the application. e.g `http://<hostname>:<port>/<context-root>`
destinationType	REST SFTP FILEUPLOAD DOCUMAKER FUSIONLOAD FUSIONSUBM FUSIONREPT AGENT
typeConfig	A list of key/value pairs that represent additional attributes for the destination types. Please see following table to see the relevant key/value pairs for each type.

code

The unique name of the destination. Example: "Documaker"

credentialKey

The credential key to be used to invoke the destination. It is essentially the authentication/authorization information needed by the target application to authenticate/authorize Oracle Insurance Gateway.

Credentials can be set by configuring username and password using the credential integration point. For details refer to the section credential in the guide.

addressKey

The Universal Resource Locator (URL) of the destination.This is typically a system property key, for which a value is derived at runtime from the environment specific properties.

This field should always start with prefix 'address.key.'

Example: When an address key is set up as 'address.key.claims.service.uri', Oracle Insurance Gateway expects a system property 'address.key.claims.service.uri". This property must then have a valid URL as a value. Oracle Insurance Gateway uses this URL as the endpoint or constructs appropriate endpoint.

Please note, when Oracle Insurance Gateway’s built in framework is used to invoke query api, extract or activity endpoints in an another OHI application, the address key URL value should be till the context root of the application. e.g

http://<hostname>:<port>/<context-root>

destinationType

REST
SFTP
FILEUPLOAD
DOCUMAKER
FUSIONLOAD
FUSIONSUBM
FUSIONREPT
AGENT

typeConfig

A list of key/value pairs that represent additional attributes for the destination types. Please see following table to see the relevant key/value pairs for each type.

REST

The following Type Config fields can be used:

Field	Description
path	The path of the REST api to call, this is relative to the base url defined in the address key of the destination.
httpMethod	The HTTP method to be invoked. Possible values: PUT; POST; PATCH; DELETE; GET. Default is: POST. Optional

Field

Description

path

The path of the REST api to call, this is relative to the base url defined in the address key of the destination.

httpMethod

The HTTP method to be invoked. Possible values: PUT; POST; PATCH; DELETE; GET. Default is: POST. Optional

SFTP

The following Type Config fields can be used:

Field	Description
directoryName	The directory path must exist.
hostname	The hostname of the SFTP server.
port	The port of the SFTP server. Optional (default value is 22).
knownHostsFile	The known_hosts file used by the client to verify that the key provided by the server is really the one of the host. Optional.
strictHostKeyChecking	Use strict host key checking in combination with a known hosts file? Possible values are: false (default) and true. Optional.
connectTimeout	The connect timeout (in milliseconds) for waiting for a connection to be established. Default: 10000 milliseconds. Optional.
maxBufferSize	The size (in bytes) of the buffer that SFTP uses when transferring files. Default: 32768 bytes. Optional.
serverAliveInterval	Heartbeat interval (in milliseconds) for keeping the SFTP session alive. Default: 0 (no heartbeat). Optional.
chmod	The file permissions on the stored file. Default: 664. Optional.
separator	The path separator to be used. Use '/' for Unix and '\\' for Windows. Default: '/'. Optional.

Field

Description

directoryName

The directory path must exist.

hostname

The hostname of the SFTP server.

port

The port of the SFTP server. Optional (default value is 22).

knownHostsFile

The known_hosts file used by the client to verify that the key provided by the server is really the one of the host. Optional.

strictHostKeyChecking

Use strict host key checking in combination with a known hosts file? Possible values are: false (default) and true. Optional.

connectTimeout

The connect timeout (in milliseconds) for waiting for a connection to be established. Default: 10000 milliseconds. Optional.

maxBufferSize

The size (in bytes) of the buffer that SFTP uses when transferring files. Default: 32768 bytes. Optional.

serverAliveInterval

Heartbeat interval (in milliseconds) for keeping the SFTP session alive. Default: 0 (no heartbeat). Optional.

chmod

The file permissions on the stored file. Default: 664. Optional.

separator

The path separator to be used. Use '/' for Unix and '\\' for Windows. Default: '/'. Optional.

The Oracle Insurance Gateway acts as a SFTP client only. The SFTP server it is configured to connect to must support SSH FTP v3.

FILEUPLOAD

This type requires no Type Config to be setup.

DOCUMAKER

The following Type Config fields can be used:

Field	Description
timeOutValue	The timeout to wait for response from documaker if not fire and forget. Defined in seconds. Default: 30. Optional.
fireAndForget	Specifies if the call to documaker is fire and forget. Default is: true, Optional
async	Specifies that document production in Documaker should happen asynchronously. Default is false, Optional

Field

Description

timeOutValue

The timeout to wait for response from documaker if not fire and forget. Defined in seconds. Default: 30. Optional.

fireAndForget

Specifies if the call to documaker is fire and forget. Default is: true, Optional

async

Specifies that document production in Documaker should happen asynchronously. Default is false, Optional

Fusion Load and Import Data (FUSIONLOAD)

The following Type Config fields can be used:

Field	Description
documentTitlePrefix	Used as part of the UploadToUCM request. The document title needs to be unique in order to be accepted by UCM. The document title is constructed from concatenating the documentTitlePrefix with the unique ID of the Exchange that was used to upload the document.
documentAuthor	Used as part of the UploadToUCM request. Must match the document author that is configured in Fusion. Optional
documentSecurityGroup	Used as part of the UploadToUCM request. Must match the document security group that is configured in Fusion.
documentAccount	Used as part of the UploadToUCM request. Must match the document account that is configured in Fusion.
loadJobPackageName	Used as part of the request that submits a job to load data from the zip file into Fusion’s open interface tables. Must match the load job package name that is configured in Fusion.
loadJobDefinitionName	Used as part of the request that submits a job to load data from the zip file into Fusion’s open interface tables. Must match the load job definition name that is configured in Fusion.
loadJobParameters	Used as part of the request that submits a job to load data from the zip file into Fusion’s open interface tables. Lists identifiers to the job parameters that must be passed to Fusion for the load job. The identifiers should be the names of Exchange properties. At the time the job parameters are collected to be communicated to Fusion, these Exchange properties must have a value. Note that the order in which these are specified determines the order in which the (values for these) job parameters are passed to Fusion. Optional.
loadJobTimeOutValue	In combination with the loadJobTimeOutUnit, determines how long the Oracle Insurance Gateway keeps polling for the load job to reach an end state from the moment that the job was submitted to Fusion. If the timeout period is reached before the status of the job reaches an end state, the Oracle Insurance Gateway marks the Exchange as Failed. Defined in seconds. Default: 300. Optional.
loadJobStatusCheckInterval	Defines the interval used by the Oracle Insurance Gateway to check the status of the load job. Defined in seconds. Default: 60. Optional.
importJobPackageName	Used as part of the request that submits a job to import data from the open interface tables into Fusion. Must match the import job package name that is configured in Fusion.
importJobDefinitionName	Used as part of the request that submits a job to import data from the open interface tables into Fusion. Must match the import job definition name that is configured in Fusion.
importJobParameters	Used as part of the request that submits a job to import data from the open interface tables into Fusion. Lists identifiers to the job parameters that must be passed to Fusion for the import job. The identifiers should be the names of Exchange properties. At the time the job parameters are collected to be communicated to Fusion, these Exchange properties must have a value. Note that the order in which these are specified determines the order in which the (values for these) job parameters are passed to Fusion. Optional.
importJobTimeOutValue	In combination with the importJobTimeOutUnit, determines how long the Oracle Insurance Gateway keeps polling for the import job to reach an end state from the moment that the job was submitted to Fusion. If the timeout period is reached before the status of the job reaches an end state, the Oracle Insurance Gateway marks the Exchange as Failed. Defined in seconds. Default: 1200. Optional.
importJobStatusCheckInterval	Defines the interval used by the Oracle Insurance Gateway to check the status of the import job. Defined in seconds. Default: 60. Optional.

Field

Description

documentTitlePrefix

Used as part of the UploadToUCM request. The document title needs to be unique in order to be accepted by UCM. The document title is constructed from concatenating the documentTitlePrefix with the unique ID of the Exchange that was used to upload the document.

documentAuthor

Used as part of the UploadToUCM request. Must match the document author that is configured in Fusion. Optional

documentSecurityGroup

Used as part of the UploadToUCM request. Must match the document security group that is configured in Fusion.

documentAccount

Used as part of the UploadToUCM request. Must match the document account that is configured in Fusion.

loadJobPackageName

Used as part of the request that submits a job to load data from the zip file into Fusion’s open interface tables. Must match the load job package name that is configured in Fusion.

loadJobDefinitionName

Used as part of the request that submits a job to load data from the zip file into Fusion’s open interface tables. Must match the load job definition name that is configured in Fusion.

loadJobParameters

Used as part of the request that submits a job to load data from the zip file into Fusion’s open interface tables. Lists identifiers to the job parameters that must be passed to Fusion for the load job. The identifiers should be the names of Exchange properties. At the time the job parameters are collected to be communicated to Fusion, these Exchange properties must have a value. Note that the order in which these are specified determines the order in which the (values for these) job parameters are passed to Fusion. Optional.

loadJobTimeOutValue

In combination with the loadJobTimeOutUnit, determines how long the Oracle Insurance Gateway keeps polling for the load job to reach an end state from the moment that the job was submitted to Fusion. If the timeout period is reached before the status of the job reaches an end state, the Oracle Insurance Gateway marks the Exchange as Failed. Defined in seconds. Default: 300. Optional.

loadJobStatusCheckInterval

Defines the interval used by the Oracle Insurance Gateway to check the status of the load job. Defined in seconds. Default: 60. Optional.

importJobPackageName

Used as part of the request that submits a job to import data from the open interface tables into Fusion. Must match the import job package name that is configured in Fusion.

importJobDefinitionName

Used as part of the request that submits a job to import data from the open interface tables into Fusion. Must match the import job definition name that is configured in Fusion.

importJobParameters

Used as part of the request that submits a job to import data from the open interface tables into Fusion. Lists identifiers to the job parameters that must be passed to Fusion for the import job. The identifiers should be the names of Exchange properties. At the time the job parameters are collected to be communicated to Fusion, these Exchange properties must have a value. Note that the order in which these are specified determines the order in which the (values for these) job parameters are passed to Fusion. Optional.

importJobTimeOutValue

In combination with the importJobTimeOutUnit, determines how long the Oracle Insurance Gateway keeps polling for the import job to reach an end state from the moment that the job was submitted to Fusion. If the timeout period is reached before the status of the job reaches an end state, the Oracle Insurance Gateway marks the Exchange as Failed. Defined in seconds. Default: 1200. Optional.

importJobStatusCheckInterval

Defines the interval used by the Oracle Insurance Gateway to check the status of the import job. Defined in seconds. Default: 60. Optional.

Fusion Submit Job (FUSIONSUBM)

The following Type Config fields can be used:

Field	Description
jobPackageName	Must match the job package name that is configured in Fusion.
jobDefinitionName	Must match the job definition name that is configured in Fusion.
jobParameters	Lists identifiers to the job parameters that must be passed to Fusion for the job. The identifiers should be the names of Exchange properties. At the time the job parameters are collected to be communicated to Fusion, these Exchange properties must have a value. Note that the order in which these are specified determines the order in which the (values for these) job parameters are passed to Fusion. Optional.
jobTimeOutValue	In combination with the jobTimeOutUnit, determines how long the Oracle Insurance Gateway keeps polling for the job to reach an end state from the moment that the job was submitted to Fusion. If the timeout period is reached before the status of the job reaches an end state, the Oracle Insurance Gateway marks the Exchange as Failed. Defined in seconds. Default: 300. Optional.
jobStatusCheckInterval	Defines the interval used by the Oracle Insurance Gateway to check the status of the job. Defined in seconds. Default: 60. Optional.

Field

Description

jobPackageName

Must match the job package name that is configured in Fusion.

jobDefinitionName

Must match the job definition name that is configured in Fusion.

jobParameters

Lists identifiers to the job parameters that must be passed to Fusion for the job. The identifiers should be the names of Exchange properties. At the time the job parameters are collected to be communicated to Fusion, these Exchange properties must have a value. Note that the order in which these are specified determines the order in which the (values for these) job parameters are passed to Fusion. Optional.

jobTimeOutValue

In combination with the jobTimeOutUnit, determines how long the Oracle Insurance Gateway keeps polling for the job to reach an end state from the moment that the job was submitted to Fusion. If the timeout period is reached before the status of the job reaches an end state, the Oracle Insurance Gateway marks the Exchange as Failed. Defined in seconds. Default: 300. Optional.

jobStatusCheckInterval

Defines the interval used by the Oracle Insurance Gateway to check the status of the job. Defined in seconds. Default: 60. Optional.

Fusion Run Report (FUSIONREPT)

The report output is made available as data file in a data file set. The following Type Config fields can be used:

Field	Description
format	The output format of the requested report. Valid values are dictated by Fusion, for example: csv, xml.
locale	The locale selection for the report. Example: en-AU.
template	The template to apply to the report. Must match the Fusion configuration.
absolutePath	The absolute path to the report in the BI Publisher repository. Must match the Fusion report configuration.
parameters	List of name-value Properties. The property values should refer to names of Exchange properties. At the time the parameters are collected to be communicated to Fusion, these Exchange properties must have a value. Optional

Field

Description

format

The output format of the requested report. Valid values are dictated by Fusion, for example: csv, xml.

locale

The locale selection for the report. Example: en-AU.

template

The template to apply to the report. Must match the Fusion configuration.

absolutePath

The absolute path to the report in the BI Publisher repository. Must match the Fusion report configuration.

parameters

List of name-value Properties. The property values should refer to names of Exchange properties. At the time the parameters are collected to be communicated to Fusion, these Exchange properties must have a value. Optional

AGENT

This type requires no Type Config to be setup.