Configure the CA Service Desk Plugin for Integration with BeyondTrust Remote Support
You must purchase this integration separately from both your Remote Support software and your CA Service Desk solution. For more information, contact BeyondTrust sales.
Now that you have configured CA Service Desk and the Secure Remote Access Appliance, deploy and configure the CA Service Desk plugin.
For more information on installing and working with the BeyondTrust Middleware Engine, please see the
BeyondTrust Remote Support Middleware Engine Installation and Configuration document
- Copy the provided plugin zip file to the server hosting the BeyondTrust Middleware Engine.
- Extract the plugin zip file to the Plugins folder in the directory where the BeyondTrust Middleware Engine is installed.
- Restart the BeyondTrust Middleware Engine Windows service.
- From the server, launch the middleware administration tool. The default URL is http://127.0.0.1:53231.
- The CA Service Desk Plugin shows in the list of plugins. Click the clipboard icon to add a new configuration.
Secure Remote Access Appliance
The first portion of the plugin configuration provides the necessary settings for communication between the plugin and the Secure Remote Access Appliance. The configuration sections include:
- 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.
- 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 Secure Remote Access Appliance. If outbound events are not being used, this value is still required, but any value may be used.
- Secure Remote Access Appliance Host Name: The hostname of the Secure Remote Access Appliance. Do not include
https://or other URL elements.
- BeyondTrust Integration API OAuth Client ID: When using API accounts in BeyondTrust Remote Support 16.2.1 or newer, this field should contain the Client ID of the OAuth account.
- BeyondTrust Integration API OAuth Client Secret: When using API Accounts available in BeyondTrust Remote Support 16.2.1 or newer, this field should contain the client Secret of the OAuth account.
- BeyondTrust Integration API User Name: If using a BeyondTrust Remote Support version prior 16.2.1, this field should contain the username of the API service account created on the Secure Remote Access Appliance.
- BeyondTrust Integration API Password: If using a BeyondTrust Remote Support version prior 16.2.1, this field should contain the password of the above user.
- Locale Used for BeyondTrust API Calls: This value directs the Secure Remote Access Appliance to return session data in the specified language.
- Disabled: Enable or disable this plugin configuration.
- 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.
- Use Non-TLS Connections: Leave unchecked unless it is the specific goal to use non-secure connections to the Secure Remote Access Appliance. If checked, TLS communication is disabled altogether. If non-TLS connections are allowed, HTTP access must be enabled on the BeyondTrust /login > Management > API Configuration page. Using non-secure connections is discouraged.
When using OAuth authentication, TLS cannot be disabled.
- 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 BeyondTrust. The middleware engine receives any events configured to be sent in BeyondTrust but passes them off to the plugin only if the corresponding event type is selected in this section.
- Support Session End
- Customer Exit Survey is Completed
- Representative Survey is Completed
- Polling Event Types: If network constraints limit connectivity between the Secure Remote Access Appliance and the middleware engine such that outbound events cannot be used, an alternative is to use polling. The middleware engine regularly polls the Secure Remote Access 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.
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.
- Polling Interval: Enter only if polling is used. This determines how often the middleware engine polls the Secure Remote Access Appliance for sessions that have ended.
- Retry Attempt Limit: Enter the number of retries that can be attempted if the plugin fails to process an event.
- Retry Outbound Event Types: Specify which outbound events the plugin retries if it fails to process the event.
- Retry Polling Event Types: Specify which polling events the plugin retries if it fails to process the event.
CA Service Desk Instance
The remainder of the plugin configuration provides the necessary settings for communication between the plugin and the CA Service Desk instance. The configuration settings include:
- CA Service Desk Services URL: The services URL for the CA Service Desk instance (e.g.,
- CA Service Desk Username: The username of the API account.
- CA Service Desk Password: The password of the above user.
- Enable Automatic Incident Creation on Session Start (Rep joins session): If checked, the plugin processes support_conference_member_added events and the external key to determine whether to create a ticket within CA Service Desk or not. The plugin attempts to create the ticket only if this setting enabled, if the conference member joining the conference is a representative, and if the external key is either a JSON string or the literal value CHAT.
- Enable Automatic Incident Creation on Session End: If checked, the plugin processes support_conference_end events as usual but also examines the external key to determine whether to create a ticket within CA Service Desk or not. The plugin attempts to create the ticket only if this setting is enabled and if the external key is empty, is a JSON string, or is the literal value CHAT. If the external key is any other value, it is assumed to be a valid ticket ID, and the session is processed as usual (i.e., no ticket is created).
- Ticket Default Data: A JSON string containing values that can be used to prepopulate certain fields on the newly created ticket.
After saving the configuration, click the test icon next to the new plugin configuration. No restart is needed.
On the BeyondTrust 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 BeyondTrust session ends or each time a survey is submitted. The templates can be edited if desired.
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 more information on Handlebars templates, please see handlebarsjs.com.