Create an Integration Instance

After setting all the required information (Authentication, API paths and Objects), you can now create an instance to your staging or production deployment of your third party system. You can have your BSS linked with more than deployments of the same third party system.

Creation of a New Instance

An instance of an integration connector can be creating from the Settings action in Enabled Connectors page 

From this action you can create one or more instances by completing the required information. The paradigm below is an instance supports username/password Basic authentication and has already defined the server variables in the transformation.

The information that must be filled in is the following:

  • Basic Information: The name of the instance.
  • Servers: Select which server this instance will use. Drop down menu will present all available values defined in the definition server object.
  • Server Variables: This section will be present only if variable server object is present in the definition. Default value can be overridden by entering the desired value in the textbox.

  • Authentication: According to the type of authentication appropriate fields will be shown. For our example we have used basic authentication with username/password.

  • Synchronization Options: All modules defined in the synchronization object will be present here and user can easily enable/disable the ability of a module by using this table. The available Push and Pull options here are derived from the data transformation schemas you have defined in the JSON document.

Synchronization Lookups

After you successfully create the instance, the lookups interface will become available for mapping fields between the two systems, This table enables the ability to create a mapping between the two systems for non-supported modules. For each supported look up, the Module name, Internal Name , Internal ID and Integration ID will shown.

A look up can be easily setup by entering the internal ID of the external system module inside the textbox. In order to delete a lookup simply remove the value from inside the textbox and the lookup will be removed.

For the above example the transformation for payment type in order to use the look up would be

  • For push:"Payment_Type": "#valueof($.payment.type.integrationId)"
  • For pull:"Type": "#valueof($.Payment_Type.Id)"

Table of Contents