Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected links that should have been relative instead of absolute.

You can use this function to apply the external map function in the mapping through REST API. Therefore, this feature provides a framework to call the external REST API to apply as map function using Available Function(s) option from the destination elements.

This feature is only visible when:

  • You have selected the Enable External Mapping Function(s) checkbox and REST account from Template/Transaction settings page.
  • You open the mapper from the Define Mapping page of Template/Transaction.

This feature is not supported if you open mapping from Manage Objects page.

Steps to apply Available Functions

  1. Click More  icon of the destination element of the layout and then select Available Function(s) option.



    This will call the API that was defined in the REST account during the Template/Transaction creation.

  2. The Available Functions(s) : NAME screen is displayed.

  3. Select the required function from the list and click Apply.
  4. This will apply the function as a mapping expression.

Request/Response for the External Mapping Function(s)

The External Mapping Functions(s) provides the way to call the external REST API to apply as map function using Available Function(s) option from the destination elements. Following are the Request and Response JSON format for External Mapping Function in Web Mapper.

Request Format for the External Mapping Function

Following example presents the JSON request format send from the Web Mapper when a destination field is selected and user click Available Function(s) option.


 

{
fieldName: "Field1"
fieldPath: "/Root/Record/Field1"
schemaName: "AC_TextSchema_Traget"
}

Request JSON have these three details:

Where,

Field Name: This contains the specific field name of destination element.

Field Path: This contains the path and field name of destination element.

Schema Name: This contains the schema name.

Response Format for the External Mapping Function

These information must available in Response JSON:

[{
"comment": "Place your comment here",
"methodName": "remove",
"parameterTypes": "String,String",
"returnType": "String",
"className": "MapperUtilityClass"
}]

Where,

Comment: Provide the comment for the Response JSON.

Method Name: Mention the Method Name.

Parameter Type: Mention the type of parameters.

Return Type: Mention the return type for the API.

Class Name: Specify the class name of mapping.

Panel
borderStylesolid
titleYou may be interested in...
What is new
Application architecture
Key terms
Install
Usage scenarios