Configure connection and credential aliases to authenticate an integration between your ServiceNow instance and Google Drive.

Before you begin

Role required: admin

About this task

The connection and credential aliases record is used to manage the secure connection of your ServiceNow instance with Google Sheets. A connection alias tells the system how to connect to Google Sheets. It defines the endpoint URL of the Google Drive API and tells the system who is connecting. For example, it stores the authentication details, such as the OAuth token and API keys.

Procedure

  1. Navigate to All > Connections & Credentials > Connection & Credential Aliases.
    1. Select New.
    2. On the form, fill in the fields.
      Table 1. Connection & Credential Aliases form
      Field Description
      Name Name of the alias. An alias can only contain alphanumeric characters and underscores. For example, Sheets_Alias.

      During an upgrade, the tag in the credential record migrates to a Connection & Credential alias. If the credential tag contains special characters other than alphanumeric characters and underscores, it preserves the tag name after the upgrade. You can still use this migrated alias, but you can't update the alias until you change the name to meet the naming restrictions.
      ID Unique identifier for the Connections & Credentials alias, based on the format scope_name.alias_name.
      • If the scope is Global, the ID is the alias name. For example, if you create a Sheets alias in the global scope, it sets the ID to sheets.
      • If you create a workday alias in the HR app scope, it sets the ID to x_hr_app.sheets.
      Parent Alias Connection and credential alias record of the Google Drive.
      Type Type that is either Credential or Connection and Credential. The default is Connection and Credential.
      Connection type Name of the connection type, either Basic, HTTP, JDBC, JMS, or Kafka. The default is HTTP.
      Support Multiple Active Connections Option that indicates whether the alias supports multiple active connections. You can add connections by using the Connections [sys_connection] table. You can associate the connections to the alias by using the Connections related list.
      Default Retry Policy Retry policy for the alias. For more information, see Retry policy.
      Configuration Template Configuration template to use to create a connection and credential record.
    3. Select Submit.
    A connection and credential alias record is created.
  2. Create an OAuth 2.0 credential to use in the connection and credential alias record.
    1. Navigate to All > Connections & Credentials > Credentials.
    2. Select New.
    3. From the list of credential types, select OAuth 2.0 Credentials.
    4. On the form, fill in the fields.
      Table 2. OAuth 2.0 Credentials form
      Field Description
      Name Unique name of the credential to differentiate it from the default credentials that are provided by the application. For example, Sheet credentials.
      Active Option to activate the credential.
      OAuth Entity Profile Default OAuth entity profile that was generated when you performed the application registry in Create an application registry for Google Sheets on a ServiceNow instance.
      Applies to Option to specify if the credential record is applicable for all MID Servers, or a specific MID Server. If specific, add the MID Servers as necessary.
      Order Order (sequence) in which Discovery tries this credential as it attempts to log on to devices. The smaller the number means that the higher in the list this credential appears.
    5. Select Submit.
      The OAuth 2.0 credential record is created.
    6. Open the OAuth 2.0 credential record from the Credentials list.
    7. From the Integration Type list, select Personal.
  3. Create a connection record for your alias.
    1. Navigate to All > Connections & Credentials > Connections.
    2. Select New.
    3. From the list of connection types, select HTTP(s) Connection.
    4. On the form, fill in the fields.
      Table 3. HTTP(s) Connection form
      Field Description
      Name Name of the connection. This field must be unique on the table.

      For example, Sheets credentials.
      Credential Credential to use with this connection.

      For example, select the OAuth 2.0 credential record created in step 2.
      Connection alias Connection alias that resolves your connection and credentials at run time. Only one connection is active per connection alias at any one time.
      Active Option to make this connection active.
      Domain Domain that the action or activity runs in.
      URL builder Option to use the system to build a URL that is based on the inputs, such as host, port, and base path.
      Connection URL URL that the MID Server uses to connect to the specified weblink.

      If URL builder is not selected, enter the connection URL in this field. For example, https://www.googleapis.com/upload/drive/v3/files?uploadType=multipart&fields=id.
      Mutual authentication Option to enable authentication by using a protocol profile.
      Note: If the mutual authentication is selected, a connection URL is built: Protocol + :// + host:port +URL. If a mutual authentication isn’t selected, a connection URL is built: Protocol profile + :// + host:port +URL.

      This field appears only when URL builder is selected.
      Use MID server Option to define the fields in the Advanced MID Server Configuration section.
      If a successful connection doesn’t occur during this time, the connection request times out. Leave this field empty to use the system default connection timeout value.
      Note: Avoid setting the Connection Timeout value to zero, because doing so may cause a stale connection.
      Connection timeout Number of seconds that the system waits for a successful host connection.
    5. Select Submit.
    The connection record is created.
  4. Copy the sys_id of the alias record.
    Note: This sys_id is required when setting up the export to sheets alias system property.
    1. Navigate to All > Connections & Credentials > Connection & Credential Aliases.
    2. From the Connection and Credentials Aliases list, select and open the alias that you created in step 1.
    3. Right-click the header of the alias page and select Copy sys_id.
  5. Configure the export to sheets alias system property.
    1. In the navigation filter, enter sys_properties.list
      The entire list of properties in the System Properties [sys_properties] table appears.
    2. Select New.
    3. On the form, fill in the fields.
      Table 4. System Property form
      Field Description
      Name Name of the property that you’re creating. In this case, glide.oauth.export.to.sheets.alias.
      Description Brief, descriptive phrase that describes the function of the property.
      Type Data type. In this case, string.
      Value Value for the property. In this case, paste the sys_id that you copied from the alias record in step 4.
    4. Select Submit.
      Note: If the Ignore cache check box is selected, the system flushes the server cache when the parameter is changed.

Result

The connection and credential alias record is configured to connect your ServiceNow instance with Google Sheets.