Configure ServiceNow for Integration with BeyondTrust

Unless otherwise noted, all of the steps in this section take place in the ServiceNow interface. Use development or test instances of ServiceNow so that the integration can be thoroughly tested before installation in the production instance.

Install Remote Support Integration via App Store

Retrieve Update Sets

Please see ServiceNow's FAQ regarding app installation via the ServiceNow App Store.



ServiceNow Store

Set Up ServiceNow Integration with Remote Support

B Series Appliance

Follow these steps in ServiceNow to connect ServiceNow to Remote Support.

  1. Browse to BeyondTrust CSM Appliances.
  2. Click New to add a new Remote Support appliance record and enter the following values:
    • Name: Must be Default.
    • Hostname: Host name of the Remote Support deployment.
    • OAuth Client ID: The OAuth client ID that is used to authenticate to the Remote Support deployment. This is obtained in a previous step, Create a ServiceNow OAuth API Account.
    • OAuth Client Secret: The OAuth client secret that is used to authenticate to the Remote Support deployment. This is obtained in a previous step, Create a ServiceNow OAuth API Account.


B Series Appliance

  • Integration Enabled: Check this box to enable the integration.
  • Outbound Event Token: The token that is used as an added security measure to confirm outbound events are coming from the Remote Support deployment that is sending the same token. If left blank, this outbound event token process is ignored. If a value is provided, however, the same value must be sent from all outbound events coming from BeyondTrust as a parameter named outbound_event_token.
  • Accepted IP Addresses: A comma-separated list of IP addresses from which this integration accepts outbound events.

Assign Users Appropriate Roles

Edit User


Give the x_bmgr_crm.agent role to ITIL users who provide technical support using this integration.

You must elevate the admin's role in order to make the following change.

  1. Browse to User Administration > Users.
  2. Select a user.
  3. Click the Roles tab, and then click the Edit button.
  4. Add the x_bmgr_crm.agent role from the Collection list to the Roles list.
  5. Click Save.


Configure Case States

ServiceNow Case States

Case states are used in the Remote Support Integration, (specifically UI Actions like Session Key) to control when the button shows up on case forms.

  1. Browse to Case and click Open to see a list of open cases.
  2. Click Case Number to select a case.
  3. Right-click on the label for the State field or any other field which uses a dropdown or choice list, and click Show Choice List.
  4. Filter the list by Table=sn_customerservice_case and Element=state.
  5. Take note of the different sn_customerservice_case choices, specifically the value of cases with a label of Resolved or Closed, and any custom case states for which the Remote Support Session Key button should not appear.
  6. Go back to the case, right-click on the Session Key button located in the Case title bar, and select Configure > UI Actions.
  7. In the UI Actions list, click Remote Support Session Key, select the Condition field, and ensure current.state is configured to include the IDs of the case states for which the session key button should not appear.

The following code in the UI Action condition field controls which states the Session Key button displays for. By default, the Session Key button displays for cases whose states are set to New, Open, or Awaiting Info, for example, cases with states set to 1, 10, or 18 respectively.

x_bmgr_crm.BomgarUtil.showSessionKeyOnCaseForm('Default', current.getUniqueValue(), [1,10,18])

For example, if you had a custom state of 27, which represented a Pending Case, and you wanted the Session Key button to also display for that state, you would modify the code above to the following:

x_bmgr_crm.BomgarUtil.showSessionKeyOnCaseForm('Default', current.getUniqueValue(), [1,10,18,27])

Configure Chat Now Form in Service Portal

  1. Browse to Service Portal and click Service Portal Configuration to open the configuration landing page.

ServiceNow configuration landing page.

  1. Click Designer to launch the Service Portal Designer.


Service Portal home tile selected on the ServiceNow portal designer page.

  1. Scroll down the list of pages and click the Service Portal index page (or whichever page is marked with the home icon).


ServiceNow Service Portal Designer widgets selection options.

  1. In the Widgets menu on the left, find the Bomgar Chat widget. Drag it onto the page, and place it where you'd like it to display.


ServiceNow MID Server Option

MID Server

It is possible to avoid direct connection between ServiceNow and Remote Support by using an MID server for internal Remote Support deployments.

For more information on MID servers, please see MID Server.