Connector Dialog for ServiceNow

NOTE: This connector requires a Java Virtual Machine (JVM) to work. If it is not available on the connectors list, follow these steps to enable it:

Enter values into the dialog box to connect and fetch data from your ServiceNow data source. Select a specific tab to display specific options.

Connection Tab

Fill out the fields below to initiate a successful connection. Bold fields are required.

Notes

  • Optional Fields. Other fields are optional but you may need to consult your data source administrator for other field values you need to enter to connect. 
  • Connection Strings that Exceed 1020 characters. For Connection Strings that exceed 1020 characters, a File DSN is temporarily created. Refer to this page for details on the implementation.
  • Support for Short Names: Progress short names are supported by this release of Monarch Data Prep Studio, specifically in the Other Connection Options field. Refer to this page for details on the implementation.

Field

Description

Host Name

Enter the host name portion of the HTTP endpoint to which you send requests.

Authentication Method

Determines the authentication method to be used during the course of the session.

Select the method from the drop-down list.

Client ID

Enter the client ID key for your application when authenticating to REST endpoints with OAuth 2.0 enabled (AuthenticationMethod=OAuth2).

Client Secret

Enter the client secret for your application when authenticating to REST endpoints with OAuth 2.0 enabled.

Important: The client secret is a confidential value used to authenticate the application to the service. To prevent unauthorized access, this value must be securely maintained.

Access Token

Enter the access token used to authenticate to REST endpoints with OAuth 2.0 enabled. Typically, this option is configured by the application; however, in some scenarios, you may need to secure a token using external processes. In those instances, you can also use this option to set the access token manually.

Note: You can use the Copy/Paste icon  to easily paste or copy the token value to or from the dialog box.

Refresh Token

Enter the refresh token used to either request a new access token or renew an expired access token for OAuth 2.0 implementations.

Important: The refresh token is a confidential value used to authenticate to the service. To prevent unauthorized access, this value must be securely maintained.

Note: You can use the Copy/Paste icon  to easily paste or copy the token value to or from the dialog box.

Authorization URI

Enter the endpoint for obtaining an authorization code from a third-party authorization service for OAuth 2.0 implementations.

Token URI

Enter the endpoint for retrieving access tokens when OAuth 2.0 authentication is enabled.

Redirect URI

Enter the endpoint to which the client is returned after authenticating with a third-party service when OAuth 2.0 authentication is enabled (AuthenticationMethod=OAuth2).

For some authentication flows, the REST service will redirect you to a third-party service for authentication. Once your credentials have been validated, the third-party service returns the client to an endpoint in the REST service to continue the session. The endpoint used by the third-party service is provided by the client and specified using the Redirect URI option.

Scope

Enter a space-separated list of OAuth scopes that limit the permissions granted by an access token.

Reset Connection

Check this box to reset the OAuath connection and fetch new access tokens.

TEST CONNECTION

Click to initiate a connection and test the values you have entered. If there are errors, messages will be displayed beside this button.

Note: You can right-click on an error message to display a Copy button. Select the button to copy the error message.

Tables and View Tab

Tables and Views

 

Allows you to load, and then select, the tables from your database by manually selecting from a list.

To load tables and views via search and select:

  1. Select the Tables and Views tab.

  2. Click Load Tables to load a list of predefined tables or views. These are displayed on the Tables List (at the left side of the dialog box).

  3. Select a table from the Tables List.

    The columns of the table are displayed in the Columns List (beside the Tables List).

  4. Select the columns to add to your data table by checking the column boxes.

Note: If you wish to add a duplicate column, select this column from the Add a duplicate column drop-down list provided.

 

To select a column:

Check the boxes beside the columns you want to use. If you want to use all columns check the Column box on the header.

 

To aggregate columns:

 

If the data returned are to be aggregated, check the Aggregate box on the header, then select the aggregation method you want to use for each column. The following aggregation methods are possible for each data type:

 

To filter columns:

 

If the data returned are to be filtered, check the Apply Filter on the header. Then, for each column, select a filter method from the filter drop down and then enter the filter value in the Filter Value box.

Note that some data sources require case-sensitive filter values. Refer to this list to check which data sources have case-sensitive filters.

To load tables and views using an SQL Query, select the Query tab

Preview Data

Click to fetch data using the credentials and criteria you have specified. This allows you to confirm your connection, ensure you have connected to the correct table, check your query, and verify the information that will be loaded.

Notes:

  • Only 10 records are displayed to allow you to verify that you are selecting the correct data. This limit prevents system slow down.

  • The button is only enabled if the connection is active and the query is correct. Check your connection or your query if one of the buttons is disabled.

Query Tab

Query

Allows you to load, and then select, the tables from your database by entering a SQL Statement.

If you already selected Tables and Views, this box is updated to show the corresponding  SELECT * FROM TABLE query.

If you want to define the query, enter the SELECT, EXEC, and/or WITH statements to execute.

Notes

  • To minimize security risks and prevent SQL Injection attacks:

  • Only Select, Exec, and/or With statements are allowed.

  • The following are NOT allowed:

    • Comment characters ( -- )

    • Semi-colons ( ; )

  •  In cases where you need to use a series of SQL statements with or without comments, we recommend you use stored procedures to contain these statements. The stored procedure can then be executed from the form.

  • The Preview Data and OK buttons are only enabled if the connection is active and the query is correct. Check your connection or your query if one of the buttons is disabled.

Preview Data

Click to fetch data using the credentials and criteria you have specified. This allows you to confirm your connection, ensure you have connected to the correct table, check your query, and verify the information that will be loaded.

Notes:

  • Only 10 records are displayed to allow you to verify that you are selecting the correct data. This limit prevents system slow down.

  • The button is only enabled if the connection is active and the query is correct. Check your connection or your query if one of the buttons is disabled.

OK/CANCEL

Select OK to establish the connection and fetch data or Cancel to close the dialog. 

The state of the OK and PREVIEW buttons provides a handy status about the state of your connection:

  • The OK and PREVIEW DATA buttons are enabled as soon as the required fields have been entered and verified. This usually means a connection to the data source has been established and a table has been selected.

  • The OK button is disabled when an update is made that can lead to an invalid result (e.g. the User Name or Password is not valid, or the the SQL statement in the Query tab is invalid). In such cases, use  PREVIEW DATA to validate that data can be retrieved. If this fails verify your connection information or query until data can be retrieved.

 

 

 

© 2024 Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support