Using Built in Integrations

Atfinity allows to send data to and get data from the outside by using its built-in integrations. This is useful if a case needs relevant information from external systems.

Using Atfinity's integrations includes three parts:

1. Define when the integration should be executed in a rule.

2. Defining the information sent to the system in an input assignment.

3. Defining what happens with the received result in an output assignment.

1. Define when the integration should be executed in a rule

Execution of an integration is always triggered by a rule, or rather when the rule's condition evaluates to true. In order to use an integration in Atfinity's one has to create a rule and define its condition.

2. Defining the information sent to the system in an input assignment.

The information to be sent needs to be assigned to pre defined parameters of the integration. This input assignment happens in the rule's action. An input assignment could look like this:

API_REQUEST.name := UPPER(p.full_name)

On the left side of the assignment operator := is a predefined parameters of the respective integration. API_REQUEST is a reserved word in Atfinity indicating an integration input and, in this example, name is a predefined placeholder which this integration can send to the outside system. On the right side of the := operator is the value which name should take. This value is collected during the case in the case manager.

3. Defining what happens with the received result in an output assignment.

Output assignments are similar to input assignments. They are also defined in the rule's action, however, the other way around, since this time values received from the outside system need to be assigned to information in the case manager. So an output assignment would look like this:

p.number_of_hits := API_RESULT.number_of_hits

Here, the instance's information needs to be assigned a value and is therefore on the left side of the := operator, while the returned result is on the right side. The word API_RESULT indicates a returned result and, in this case, number_of_hits is the specific information returned from the system.

Once assigned, the information p.number_of_hits is available in the case manager.

Example: World-Check

Word-Check is a product offered by the company Refinitiv. It's a database of Politically Exposed Persons and heightened risk individuals. In the case that a person needs to be screened, the world-check integration can be used. It sends data about the individual to World-Check which screens for possible hits and returns the result to Atfinity.

A rule for an that would execute the World-Check integration could have a condition like this:

p is Person
p.perform_worldcheck = true

This means that once yes is selected for the information 'perform_worldcheck' the rule's condition evaluates to true and its action (i.e. the integration) will be executed.

The input assignment in the rule's action would be as follows:

API_REQUEST.name := UPPER(p.full_name)
API_REQUEST.gender := UPPER(p.gender)
API_REQUEST.date_of_birth := FORMAT_DATE(p.date_of_birth, "YYYY-MM-DD")
API_REQUEST.country_of_residence := UPPER(p.domicile_country)
API_REQUEST.place_of_birth := UPPER(p.country_of_birth)
API_REQUEST.nationality := UPPER(p.first_nationality)

In this integration run, a person's (referenced as p) name and gender as well as other pieces of information are provided. The receiving system uses this information and screens for whether it contains a person that matches this information. The result of this screen is then sent back to Atfinity and received as follows:

p.worldcheck_has_hits := API_RESULT.has_hits
p.worldcheck_number_of_hits := API_RESULT.number_of_hits
p.worldcheck_check_date := API_RESULT.check_date

Here, the result includes if the screen led to any hits, how many hits there were and the date on which the world check was performed. These three values are assigned to information that the user has defined in Atfinity. These values can then further be used in the case.