Page tree
Skip to end of metadata
Go to start of metadata

Bomgar Remote Support Integration

BomgarTM is a secure remote support application that allows technicians to login to customer devices, such as computers, phones, and tablets, to troubleshoot and manage issues.   Agiloft supports integration with the Remote Jump Client via the Bomgar Web Representative Console cloud browser version and the desktop-based Representative Console

This section describes the initial administrator setup required to use the Bomgar integration. In brief, you will:

  1. Enable Bomgar within Agiloft to add the necessary background table and data structures.
  2. Enter configuration details to enable communication between Agiloft and Bomgar.
  3. Add fields to the process table, typically Support Cases, to capture and hold data from Bomgar, including a custom action button to generate Bomgar Session Keys.


To integrate with Bomgar you will need:

  • A licensed installation of the Bomgar Appliance and Representative Consoles. Each technician or support rep has a separate RC.
  • An administrator-level username and password to connect to the Bomgar Appliance.
  • The FQDN or IP address of your Bomgar Appliance.

Deploy and Configure the Bomgar Extension in  Agiloft

To complete the following steps, log in to your KB as an administrator.

  1. Click the Setup gear in the top-right corner and go to Integration. 
  2. Under Bomgar Extension, click Deploy. It takes a few minutes for the system to add the Bomgar Session Details table.
  3. When deployment is complete, the Deploy button is replaced with Configure Bomgar Extension. 
  4. Click Configure Bomgar Extension and enter the configuration details: 
    • Bomgar Appliance Host Name: Enter the FQDN/IP address, such as
    • API User Name: Enter an admin-level Bomgar username to generate session keys and view reports. 
    • API User Password: Enter the admin user’s password.
    • Confirm API User Password: Enter the password again to confirm.
    • Bomgar Session Details Report Template: A report is generated after each individual support session based on this template. After completing a session, the report is available for download in the Bomgar Session Details table. As the wizard text suggests, there is a default report template that the system uses if this field is left blank, but you can upload a customized report.
  5. Save changes.

Some special URL characters are reserved and can not be used in the password. For more information, see Percent Encoding.

Bomgar Session Details Table

Once you deploy and enable Bomgar in your KB, the system adds a Bomgar Session Details table. After a Bomgar session ends, the session information is sent to this table and the details are stored. If you don't create your own HTML report template, as mentioned above, then the reports are generated in the default report template format. By default, the  Agiloft system does include Bomgar sessions that were not launched from within your KB. 

By default, the Bomgar Session Details table does not include Bomgar sessions that were launched from outside of your KB. To receive and process Bomgar events launched outside of the  Agiloft system, use the Bomgar Host Names or IP Addresses global variable to enter a comma-separated list of authorized host names or IP addresses.

User Setup Requirements

Technicians who will launch support sessions must exist as users in both Bomgar and Agiloft for the system to confirm their identity and assign sessions.

One of the following requirements must be met:

  • The Username in Bomgar matches the Login in Agiloft.
  • The Email Address in Bomgar matches the Email Address in Agiloft.

To confirm user settings, log in to the Bomgar admin portal and create or edit a user on the Users & Security tab. Then confirm it matches the user record in Agiloft:

Server Configuration in Bomgar Console

The Bomgar Admin Console requires the following configuration to enable Agiloft to capture the events:

  1. Login to your Bomgar appliance (example: as an admin user.
  2. From the menu, click Management and then select Outbound Events.
  3. Click Add New HTTP Recipient.
  4. Choose a name and add the  Agiloft Server URL. The new parameter KB should match the name of the  Agiloft KB where the Bomgar Extension is enabled. For example:[KB_NAME]

    The KB parameter is mandatory in order to store details of Bomgar sessions which did not originate in Agiloft. In cases where Bomgar sessions are initiated from Agiloft, the parameter KB is optional and will not be used.
  5. Finish the rest of the form according to your company policy and click Add Recipient.

Modify the Support Table

You will need to create a few fields in whichever table staff will work on tickets and launch Bomgar sessions, most commonly the Support Case or Helpdesk Case table.

The following fields are required:

  • Bomgar Session Key: Create a text or short text field to hold the Bomgar session pin.
  • Session Key Expiration: Create a date/time field to hold the Bomgar pin expiration.
  • Bomgar Session URL: Create a short text field to hold the session URL.
  • Bomgar Support Sessions: Create an embedded search result.
    1. On the General tab, enter a Field Label and name. From the Table drop-down, select Bomgar Session Detail.
      Field General tab
    2. On the Permissions tab, chose the option to use a saved search. We recommend creating a search based on the current customer name, so support technicians can see all of the customer’s support sessions in the embedded table. Alternately, you might want to create a search that shows only support sessions related the current case by filtering on the logical table name and the case ID.

    3. On the Display tab, choose or create a view to use. Include any fields you want to see in the Support Case or Helpdesk Case record.  We recommend including the primary support technician, links to view the session recording and the session chat transcript, the start and end times, and the session status.
  • Generate Bomgar Key: Create an action button to generate the BeyondTrust session key.  This button populates the session key, URL, and expiration, into the fields specified. Configuration of this action button also determines how support sessions are assigned in the Bomgar Appliance.
    1. On the General tab of the field wizard, enter a Field label.
    2. Check Execute Actions, then click Add Action.
    3. In the pop-up window, click Create Bomgar Support Session Key Action.
    4. In the action wizard:
      1. On the General tab, enter an action Name and Description.
      2. On the Session Key Generation tab, choose the three fields from the process table that hold the session key, URL, and session key expiration.

      3. On the Support Session Assignment tab, select the fields holding the customer’s name and email address. Then choose an assignment policy. In most situations, we recommend assigning sessions to the logged in power user. See below for a detailed explanation of assignment options in Assigning Support Sessions.

There is one more recommended field that isn't required:

  • Email Bomgar Session Key: Create an action button to email the session pin to the customer. This field is not required, since there are several ways to configure an email action or to share the URL and session key with a customer. Below is our recommended setup:

    1. On the General tab of the field wizard, enter a Field label for the button.
    2. Check Execute Actions and click Add Action.
    3. In the action wizard, click Create If-Then-Else Action.
      1. On the General tab, give the action a name.
      2. Before creating the email action, we’ll check that the session key is not expired. Click Add If to begin. In the pop-up filter window, click Time. Choose the appropriate options to find session key expiration times greater than one minute old.
        Time filter showing Session Key Expiration is greater than or equal to 1 Minute old
      3. Click Finish to return to the If-then-else wizard.
      4. Click Add Action and create a Validate Action to warn the support technician if the key is expired. Your message will say something like “The session key is expired, please generate a new key.” Click Finish to return to the If-then-else wizard.
      5. Click Add Else, then create an Email Action that sends the PIN and URL to the support customer. You can modify an existing email template or create a new one to use. Be sure to include field variables in the template to display the URL and session key fields. The completed If-then-else action will look similar to:

    4. Finish and save the action and field wizards.
    Instead of using the email key action button, you may share the key and URL by phone, IM, or email.

Assign Support Sessions

The action button setup determines how the session for which the key and URL are generated is assigned. You can assign Bomgar sessions to the:

  1. Logged in power user: The technician who clicks the Generate Bomgar Session Key and URL button.
  2. User identified in the field specified below: Use this option to assign the session to a user field in the record, typically the Assigned Person.
  3. Team identified in the field specified below: Use this option to assign the session to an entire team. Any logged in member of the team will be able to accept the session in the Bomgar console. In this case, you will typically choose the Assigned Team field.
  4. Assign session to the general queue: With this option, any representative logged into Bomgar can accept the session. To use this option, you must log in to the Bomgar Administrative Interface, go to Configuration > Options, and check the box to Enable the General Queue.

  5. Specific team or representative name in the field specified below: This option allows you to assign a support session to a user known only in Bomgar. You will need another field to hold the custom value. The technician enters the value of a known Bomgar representative or team into the field before clicking the Generate Session Key action button.

Layout and Permissions

Once you have finished adding these fields, add them to the layout and set up permissions. You can arrange the layout according to your needs. The following permissions are minimally required for support reps:

  • view access to the Bomgar Session Details table.
  • view own/other permission to fields in the Bomgar Session Details table, i.e., the fields which appear in the embedded search result field.
  • view own/other permission to the relevant Bomgar fields and action buttons in the support table.

You may wish to give additional view permissions to customers, such as the ability to view or download the session’s chat transcripts.

Initiate a Bomgar Remote Support Session

To launch a Bomgar support session from the Agiloft KB, a technician must:

  1. Log into the KB and the Bomgar Representative Console.
  2. Open a support case in Agiloft, often on the phone with a customer.
  3. Click the Generate Bomgar Session Key and URL action button, and confirm the Session Key, Session URL, and other fields have populated correctly.
  4. Send the session key and URL to the customer via action button, phone, chat, IM, or email.
  5. Accept the session in the Bomgar Console after the customer receives the key and begins the session.

Note: Technicians must end the session from the Bomgar Representative Console to send the details back to  Agiloft.

View Session Details

To view the details of a Bomgar session, click on the View Details link from the embedded table in the record. You can also view the details directly from the session record in the Bomgar Session Details table or in the Bomgar interface itself. Chat and session detail records remain on the Bomgar server for 90 days.

Launch Bomgar Session from a Jump Client

By enabling the proper script, it is possible for a support representative to launch a Bomgar session to a Jump Client that has been pinned from within Agiloft. Note that the process will be different depending on whether you are accessing the desktop client, or the desktop or cloud versions of the Bomgar Web Representative Console. Customers can use both the cloud and desktop version of the Representative Console in a KB, by adding actions for the LaunchBomgarJumpClientSession.jar and the LaunchBomgarJumpClientCloudSession.jar.

To set up this functionality within a Bomgar-enabled KB:

  1. Bomgar_jump_client_search_criteria: In either the Support Cases or Helpdesk Cases tables, create a Short Text field named bomgar_jump_client_search_criteria. Add the field to the Layout.
  2. Launch Bomgar Session for Jump Client: Create an action button with a Script Action.
    1. Label your button: Launch Bomgar Session for Jump Client.
    2. In the Before Executing Actions section, select Save Record.
    3. Select Open a URL Provided By and choose Action.
    4. Create a Script Action. If the script is for the Bomgar Desktop Representative Console application to provide remote support via a Bomgar Jump Client session:
      1. Under Action Name write: LaunchBomgarJumpClientSession.jar. Click Finish.

        For this to work, the LaunchBomgarJumpClientSession.jar file must be available under the Scripts directory of the KB. To add the file to the directory, contact customer support and ask the representative to upload file attached below to the correct location. The path will be specified in the corresponding Script Action wizard.
      2. Select your new action and click Finish again.
    5. If the script is for the Bomgar Cloud Representative Console from the web browser to provide remote support via a Bomgar Jump Client session...
      1. Under Action Name write: LaunchBomgarJumpClientCloudSession.jar. Click Finish.

        For this to work, the LaunchBomgarJumpClientCloudSession.jar file must be available under the Scripts directory of the KB. To add the file to the directory, contact customer support and ask the representative to upload file attached below to the correct location. The path will be specified in the corresponding Script Action wizard.
    6. Leave the remaining default properties and save the action button.
    7. Add it to the layout.
    8. Save the layout.

Open a Jump Client in Agiloft as a Bomgar Support Representative:

Within Bomgar, you can pin a Jump Client in the Representative Console. For more information, see here.

  1. Log in to  Agiloft as a Bomgar Representative, and also log into the Bomgar Representative Console.
  2. In the relevant record, enter a search string that matches the Jump Client. This can be a substring of the value in the Name or Comment field in the Bomgar Console.
  3. Clicking the Action Button in the browser will either download a file from the Bomgar server, which you can double-click to launch, or it will download and automatically launch a file from your Bomgar server.
  4. When launched, this file automatically starts a new Bomgar session.