Data Sources

Prev Next

Data Sources configuration refers to the process of setting up and administering data sources within a Service Automation environment. This process involves defining the endpoints, protocols, and security measures used to connect and interact with various data sources.

To configure Service Automation in any ITSM tool, data capture from that particular tool becomes a vital activity. Information such as Incident details, Service requests, Custom attributes, customer names, and location names can be configured as Data Source in the Data Source screen.
It displays the total Data Sources along with individual counts for the specific method type.

To view Data Source page, perform the following steps:

  1. Navigate to SA > Integration > Data Sources.
    Data Sources page is displayed.

    Figure: Data Sources

Actions

Following are list of actions in the right action panel of data source configuration page:

Action Name

Description

Filters

Opens filter options to narrow down the data sources shown in the list based on criteria such as method type, content type, or active status.

Configure Columns

Allows users to customize the columns displayed in the data source list by selecting or deselecting available fields.

Add New

Navigates to the New Data Source screen to create a new data source configuration. For more information, refer Configure Data Source.

Export to Excel

Exports the currently displayed data source list to an Excel file using the default export format.

Export All to Excel

Exports all available data sources (not limited to the current page or filters) to an Excel file.

Export to JSON

Exports the currently displayed data source records into a JSON file format.

Export All to JSON

Exports the complete set of data sources into a JSON file, including all records regardless of filters.

Configure Data Source

To configure a new Data Source, perform the following steps:

  1. Click icon from the right action panel  to configure a new Data Source.

  2. Enter all the required details as shown below and click SAVE to save and create a new Data Source configuration.

    Figure: New Data Source page

Field Description

This table contains the list of fields and their descriptions available on the New Data Source page:

Field Name

Description

Data Source Name

Enter unique name to identify the data source within the system.

URL

Enter URL Endpoint of the external API or service. Must be a valid HTTP/HTTPS URL.

Active

Toggle to make the data source available for use. Enables or disables the data source.

Method Settings

Method Type

Select HTTP method used to invoke the API from the below option:

  • GET

  • POST

Content Type

Select Content Type from the dropdown, this specifies the media type of the request body.

Example: application/json.

Headers

Key

Enter Key, this is the name of the HTTP header used in the request

Example: Authorization.

Value

Enter Value, this entered value corresponding to the header key

Example: Bearer token.

Action

Add or remove header rows using the available controls.

Payload

Payload

Request body sent to the API. Typically in JSON format for POST or PUT requests.

Payload information button

Displays the information of Payload variables.

Figure: Payload Variables pop-up

Dynamic Payload Values

Specify required parameter values for valid API responses and successful data mapping in field configurations. Parameters are dynamic and depends on the API Payload. Specify the parameter values to test the API. Few examples of parameters are as follows:

  • Tenant

  • Module Code

  • Source Type

  • Catalog ID

  • Category ID

Parameter

Name of the dynamic parameter used in the payload or request.

Value

Value assigned to the dynamic parameter during execution or validation.

Validate

Executes the API call to verify configuration and response correctness.

Submit

Saves the data source configuration.

Cancel

Discards changes and exits without saving.

Actions

Following are list of actions in the right action panel of new data source configuration page:

Action Name

Description

Show List

Opens the list view displaying all existing data sources configured in the system. Enables quick navigation and selection of other data sources.

Import from Existing

Allows creation of a new data source by copying configuration details from an existing data source. Useful for reuse and faster setup.

Import from JSON

Imports a data source configuration from a JSON file or JSON input. Automatically populates fields such as URL, method settings, headers, and payload.

Export To New

Exports the current data source configuration and creates a new data source using the same details. Helps in duplicating configurations with minimal changes.

Export To JSON

Exports the current data source configuration into a JSON format for backup, sharing, or reuse in another environment.

View Response

Displays the API response returned from the most recent validation or test execution of the data source. Useful for troubleshooting and data mapping verification.