Configure the HP Service Anywhere Plugin for Integration with Bomgar Remote Support

Now that you have configured HP Service Anywhere and the Bomgar Appliance, deploy and configure the HP Service Anywhere plugin. For additional information about working with the Bomgar Middleware Engine, please see the Bomgar Middleware Engine Configuration document.

  1. Copy the provided plugin zip file to the server hosting the Bomgar Middleware Engine.
  2. Unzip the plugin zip file to the Plugins folder in the directory where the Bomgar Middleware Engine is installed.
  3. Restart the Bomgar Middleware Engine Windows service.
  4. From the server, launch the middleware administration tool. The default URL is http://127.0.0.1:53231.
  1. The HP Service Anywhere Plugin shows in the list of plugins. Click the clipboard icon to add a new configuration.

Bomgar Appliance

The first portion of the plugin configuration provides the necessary settings for communication between the plugin and the Bomgar Appliance. The configuration sections include:

Plugin Configuration

  1. Plugin Configuration Name: Any desired value. Because multiple configurations can be created for a single plugin, allowing different environments to be targeted, provide a descriptive name to indicate how this plugin is to be used.
  2. Appliance Id: This can be left as Default or can be given a custom name. This value must match the value configured on the outbound event URL in the Bomgar Appliance. If outbound events are not being used, this value is still required, but any value may be used.
  3. Bomgar Appliance Host Name: The hostname of the Bomgar Appliance. Do not include https:// or other URL elements.
  4. Bomgar Integration API User Name: The username of the API service account created on the Bomgar Appliance.
  5. Bomgar Integration API Password: The password of the above user.
  6. Disabled: Enable or disable this plugin configuration.
  7. Allow Invalid Certificates: Leave unchecked unless there is a specific need to allow. If enabled, invalid SSL certificates are allowed in calls performed by the plugin. This would allow, for example, self-signed certificates. This is not recommended in production environments.
  8. Use Non-TLS Connections: Leave unchecked unless it is the specific goal to use non-secure connections to the Bomgar Appliance. If checked, TLS communication is disabled altogether. If non-TLS connections are allowed, HTTP access must be enabled on the Bomgar /login > Management > API Configuration page. Using non-secure connections is discouraged.
  9. Outbound Events Types: Specify which events the plugin processes when received by the middleware engine. Keep in mind that any event types selected here must also be configured to be sent in Bomgar. The middleware engine receives any events configured to be sent in Bomgar but passes them off to the plugin only if the corresponding event type is selected in this section.
    1. Support Session End
    2. Customer Exit Survey is Completed
    3. Representative Survey is Completed
  10. Polling Event Types: If network constraints limit connectivity between the Bomgar Appliance and the middleware engine such that outbound events cannot be used, an alternative is to use polling. The middleware engine regularly polls the Bomgar Appliance for any sessions that have ended since the last session was processed. At this time, only the Support Session End event type is supported.

    Note: One caveat to polling behavior versus the use of outbound events is that if a session has ended but the customer exit survey has not yet been submitted within the same polling interval, the customer exit survey is not processed. This does not apply to representative surveys since the session is not considered to be complete if a representative survey is still pending.

  11. Polling Interval: Enter only if polling is used. This determines how often the middleware engine polls the Bomgar Appliance for sessions that have ended.

HP Service Anywhere Instance

The remainder of the plugin configuration provides the necessary settings for communication between the plugin and the HP Service Anywhere instance. The configuration settings include:

  1. HP Service Anywhere URL: URL of the Service Anywhere instance.
  2. HP Service Anywhere Username: User created in the HP Service Anywhere Integration.
  3. HP Service Anywhere Password: Password of the above user.
  4. HP Service Anywhere Tenant Id: Tenant ID of the instance.
  5. Update Session Notes: Check this to push the session details into a custom section on the General tab of the service request or incident. You must check either Update Session Notes, Add Comments, or both.
  6. Add Comments: Check this to push the session details into the comments on the Discussions tab. You must check either Update Session Notes, Add Comments, or both.
  7. Rep Lookup Filter: This is used by the integration to associate the Bomgar user with an HP Service Anywhere user for the purposes of auto ticket creation and addition of comments to the Discussions tab. The screen lists some examples and instructions. Modifying this field may require some knowledge of HP Service Anywhere administration.
  8. Customer Lookup Filter: This is used by the integration to associate the end user receiving support with an HP Service Anywhere user for the purposes of auto ticket creation and addition of comments to the Discussions tab. The screen lists some examples and instructions. Modifying this field may require some knowledge of HP Service Anywhere administration.
  9. Default HP Service Anywhere Customer: This is used by the integration in the event that the Customer Lookup Filter cannot find a user. There is no default. Please fill in the numeric ID of a user to set as the default, if desired.

    Note: For the auto ticket creation use case, if a user cannot be found and this field is not configured, then a ticket is not created in HP Service Anywhere. HP Service Anywhere requires a requester when creating a ticket.

  10. HP Service Anywhere Ticket Creation Template: This contains information needed to create a ticket in HP Service Anywhere. There are parts of this template that you must modify following the on-screen instructions. This is also where you can choose to create incidents or service requests.

After saving the configuration, click the test icon next to the new plugin configuration. No restart is needed.

Report Templates

On the Bomgar Middleware Engine server, in the <install dir>\Plugins\<integration>\Templates folder, there are multiple files ending with *.hbs. These files are used by the plugin to format the textual session report and exit surveys that are added to the corresponding ticket each time a Bomgar session ends or each time a survey is submitted. The templates can be edited if desired.

Note: If changes need to be made to a template, it is a good idea to first back up the original in case the changes ever need to be reverted.

For additional information on Handlebars templates, see handlebarsjs.com.