External Web Service Mapping

Select this check box when you want to configure the data flow from Client Web Services to SummitAI.

The Batch Process only applies in the following two scenarios:

• User Master creation from Client Web Service to SummitAI
• User Master update from Client Web Service to SummitAI

Note: When the SummitAI as Source check box is not selected, the Batch Process check box appears below it.

Specify the number of records you want to create or update in a single batch.

Note:

• When the Batch Process check box is selected, a new field, No. of Records (in a Batch) appears below it.
• You can specify a maximum of 100 records in the No. of Records field.

1. No Authentication
   
   
2. API Key - Specify the API key details.
   
   
   Figure: API Key
   
   
3. Bearer Token
   
   
   1. Static Bearer Token
      
      
      Figure: Static
      
      
   2. Dynamic Bearer Token
      
      
      Figure: Dynamic Bearer Token
      
      

4. Basic - Specify the credentials for the authentication.
   
   
   
   

5. OAuth 2.0 - Enter the required auth details.
   
   
   Figure: OAuth 2.0

Click View/Edit Data Mapping button to configure the Column Names and their values to exchange the data between two Web Services. Upon clicking the View/Edit Data Mapping button, the MAP DATA pop-up page is displayed.

Figure: MAPPING FIELDS

The Source Response Field contains an array with three elements: "value1", "value2", and "value3". You can access the values within the array using the appropriate object parameters and values.

The Target Input Field contains an "input" field. When passing this JSON object as the input to the field, make sure to provide the necessary formatting and parsing based on the value name and attribute you are using to Map.

Note: The View/Edit Data Mapping button is displayed while editing only when the Map Data check box is selected.

There is a new column named Collection, where three new options have been introduced namely First, Last and All in the source field.

Figure: Collection Column

Figure: First, Last, All options

First: Choose this option to map only the first attribute of the array mentioned in the Source Field to the Target Field.

For example, if we have the below input in the source field,

Source: Fields.comment.comments.0.body

and we select the First option under collections, then only the First comment in that array will be mapped to the Target Field.

Last: Choose this option to map only the Last attribute of the array mentioned in the Source Field to the Target Field.

For example, if we have the below input in the source field,

Source: Fields.comment.comments.0.body

and we select the Last option under collections, then only the First comment in that array will be mapped to the Target Field.

All: Choose this option to map all the attributes of the array mentioned in the Source Field to the Target Field which will be comma separated.

For example, if we have the below input in the source field,

Source: Fields.comment.comments.0.body

and we select the All option under collections, then all the comments (Comma separated) in that array will be mapped to the Target Field.

Note
In case there is no array matching with the input provided in the Source Field, this option will be greyed out.

While mapping with a third-party application, to gain access we need to enter the credentials such as an API Key which is confidential information. To protect such confidential information, we have implemented Confidential Key Value Protection.

While entering confidential information such as the API Key in the request body, the platform has been updated so that the API key can be mentioned along with $$ as prefix and suffix as shown below:

 “APIKey”: $$APIKEY$$

After entering this in the request body, on clicking SUBMIT, user will be prompted to enter the Actual API Key (which is confidential) under PLACEHOLDER INPUTS as shown below:

Figure: API Key

On clicking the eye Icon next to the field, you can hide the confidential information as shown below:

Figure: Confidential information hidden using Eye Icon

Similarly, while entering any information while configuring an API key, any confidential information can be suffixed and prefixed with $$ as shown below, to protect the confidentiality of the information. The user will be prompted to enter the confidential information separately. The same has been implemented for the following fields:

• Request Body:

In the request body, enter the $$ symbol before and after the API Key to protect the confidential information as shown below:

Figure: Request Body

• Additional Headers

• URL

Figure: $$ before and after the Target URL

You will get a prompt and the Target URL will be hidden as shown below:

Clickadd new field mapping andto remove any existing field mapping.

Clickadd new field mapping andto remove any existing field mapping.

Clickadd new field mapping andto remove any existing field mapping.

Specify a time interval in minutes.

Click View/Edit Data Mapping button to configure the Column Names and their values to exchange the data between two Web Services. Upon clicking the View/Edit Data Mapping button, the MAP DATA pop-up page is displayed.

Clickadd new field mapping andto remove any existing field mapping.

Clickadd new field mapping andto remove any existing field mapping.