Field Mapping

Prev Next

Field Mapping Configurations refer to the process of mapping fields between various applications or systems in order to ensure consistency and data accuracy. This configuration ensures accurate data transfer between the systems despite differences in field names, formats, or structures.

Service Automation requires information from  (product) which can be obtained by configuring the API base URL. Then configure the list of APIs that fetch the data required from . Since Service Automation support is available for Incident management, service request and work order modules, we will map the APIs to the corresponding fields. This page is a guide to configure fields of a module to a particular data source and align it to the API.

To configure field mapping, perform the following steps:

  1. Navigate to SA > Integrations > Field Mapping.

  2. Click the desired Module Name hyperlink.

    Figure: Field Mapping

  3. Make changes on the configurations and click Save.

    Figure: Field Mapping configurations page

  4. Select the Module from the drop-down to load module field mapping configurations.

  5. Click Map icon to map the API response to valid text and value using Response Mapping option.

    Figure: Response Mapping

    For more information, refer to field description:

    Field

    Description

    Text

    Used to map a readable or display value from the API response. Typically mapped to a descriptive field (for example, user name).

    Value

    Used to map the actual value or identifier returned by the API response (for example, user ID or reference value).


    Data Source Response Browser, this section displays the structured response schema returned by the configured data source.

    Common nodes include:

    • Errors – API or validation errors

    • Message – Status or informational messages

    • Output – Root response element

    • TokenID / OrgID – Metadata returned by the API

    • OutputObject – Business data returned from the request

    Nodes can be expanded to drill down into nested objects.

    OutputObject
     └── Caller
         ├── Value
         └── Text


    Selecting a node automatically populates the Text or Value field with the corresponding response path, such as:

    • OutputObject.Caller.Text

    • OutputObject.Caller.Value


    Example: When integrating external systems for Change creation or retrieval:

    • The Caller field can be mapped to return both:

      • A readable name (Text)

      • A unique identifier (Value)

    • These mapped values are then used to populate the Change record correctly in Apex.

  6. Specify the required details. Click Save. The data settings for the selected module are saved.

Field Description

This table contains the list of fields and their descriptions available on Field Mapping configuration:

Field

Description

Field Name

Default names are displayed based on the Module selection.

Field Alias

Specify the required name to be displayed.

Control Type

Specify the type of control. Following are the types of controls:

  • Textbox

  • Dropdown

  • Autosearch

  • Treeview

Data Source Name

Select the Data Source name from the drop-down list.

Mapping

Using Response Mapping, map the API response to valid text and value.

Active

Use the toggle switch to toggle configured data settings as active or inactive.

Only active fields are displayed in the Workflow Designer.

Configuration page Actions

Following are list of items on the right action panel in configuration page.

Action Name

Description

Configure Columns

Allows users to customize the columns displayed in the Field Mapping list. Users can show, hide, or reorder columns based on their preference.

Add New

Navigates to the configuration screen to create a new field mapping for a selected module (for example, Change Management, Incident Management, or Service Request).

Export to Excel

Exports the currently displayed field mapping list to an Excel file for reporting, review, or offline analysis.

List page Actions

Following list of actions are performed on the right action panel.

Action Name

Description

Configure Columns

Allows users to customize the columns displayed in the Field Mapping list. Users can show, hide, or reorder columns based on their preference.