This article applies to customers with a Premium, Corporate, or Tensor subscription plan.

General

The TeamViewer integration for ServiceNow enables remote support for managed devices directly from the ServiceNow dashboard, easily initiating remote sessions. The integration provides ultra-easy collaboration while streamlining work processes as customers join the session by a simple click and you received notification when a customer is online. Pre-built integrations are easy and make your experience seamless.

About ServiceNow

ServiceNow is a company that provides service management software as a service. 

Configuration Instructions

When configuring the TeamViewer application, please take into account the points below:

  • For security reasons do not assign role used by Tokens table ACL to users
  • Connections tables are for future use, do not deleteSet the admin token provided by TeamViewer
  • Set the admin token provided by TeamViewer 

Administration and Configuration

Admin Token

To be able to access the TeamViewer API for certain features like scheduled company-wide connection reports, an admin TeamViewer Script token needs to be configured.

Creating an admin token

NoteIn this description, it is assumed that the administrator has created a Company Profile on their TeamViewer license. For more information on how to setup a Company Profile and add users visit https://community.teamviewer.com/t5/Knowledge-Base/How-to-add-Users-to-a-Company-Profile/ta-p/3573

  • Go to https://login.teamviewer.com
  • Go to ‘Profile’ on top right corner and select Administer <your_company_profile>. Please note that you will need to have a Corporate or higher TeamViewer license to be able to use this functionality.1.png
  • Go to Apps and select Create Script Token2.png
  • Set up permissions as shown below3.png
  • Click Save to generate the Script Token4.png

Setting the admin token

Role required: admin

  1. Connect to ServiceNow with the required user and role(s)
  2. Go to the system properties by typing sys_properties.list in the navigation filter.
  3. Find the property: x_tvgh_teamveiewer.adminToken
  4. Set the value to the admin property provided by TeamViewer

Adding TeamViewer to task extended table

Role required: admin
ServiceNow Store Application: TeamViewer Integration for ServiceNow 2.0 or later must be installed

The Following instructions can only be applied to records on tables that are an extension from the task table. The application comes preconfigured with the TeamViewer Control and TeamViewer Connection History on the Incident form (default view).

Adding the Remote Control section on a form

To add the TeamViewer Control to the form, follow the steps below. General documentation on how to add fields to a form can be found here: https://docs.servicenow.com/bundle/london-platform-administration/page/administer/form-administratio....

  1. Open the form of the Task extended record type (e.g. problem, change request, requested item), where you want to add the TeamViewer Control
  2. On the form right click on the form’s header
  3. From the menu choose Configure -> Form Layout5.png
  4. From the ‘Section’ field, click on ‘New’ and a dialog for entering a name is shown. Enter a name (e.g. TeamViewer Remote Control) and click on OK. Documentation on how to create a form section can be found here: https://docs.servicenow.com/bundle/london-platform-administration/page/administer/form-administratio...6.png
  5. Add the TeamViewer Supporter Control to the newly created form section.7.png
  6. Click on Save to apply the changes to the form.
  7. The TeamViewer Control should now be visible on the form within a form section.8.png

Adding the TeamViewer Connection Report to the form

The next step is to add the TeamViewer Connection Report to the form, this related list shows the connection history for the open task record. More information on adding a related list to a form can be found here: https://docs.servicenow.com/bundle/london-platform-administration/page/administer/form-administratio....

  1. Open the form of the Task extended record type (e.g. problem, change request, requested item), where you want to add the TeamViewer Connection Report
  2. Right click on the form’s header a go to Configure -> Related Lists9.png
  3. From the Available list, select the TeamViewer Connection Report and add it to the Selected list by clicking the Add arrow.10.png
  4. Clicking on Save to apply the changes on the view.
  5. The TeamViewer Connection Report is now be visible under the related lists at the bottom of the form.11.png

Roles

The application permissions model is based on two roles, the standard itil role in ServiceNow and the x_tvgh_teamviewer.session_history_user for the connection history.

Role Permissions
itil Can see the connection history for a task record
x_tvgh_teamviewer.session_history_user Can view the TeamViewer Connection Report for the company wide connection history

 

Connection history and Scheduled job

The TeamViewer integration for ServiceNow application keeps a history of connections created from Sessions via ServiceNow for your account. This is stored in the Connection History table. The information in this table is periodically refreshed and augmented with the relevant information from the session, like the task reference.

Connection history refresh

The connection history is retrieved from TeamViewer via the API on three occasions:

  1. When a session is closed, the connection history for that session I is retrieved
  2. A scheduled job periodically (6 hours by default) retrieves the connection history
  3. A manual refresh of the connection history can be requested by a user with the proper role from the TeamViewer Connection Report.

Setting the scheduled job period

Role Required: Admin

The scheduled job that periodically retrieves the connection history is by default set to run every 6 hours. This interval can be updated by the ServiceNow System administrator by updating the repeat interval on the scheduled job.

  1. Go to the System Definition > Scheduled Jobs
  2. Open the record for the job Retrieve TeamViewer connections
  3. Run the job once, via the Execute Now button, to make sure the latest connection history is retrieved, and no records are missed due to a changed period.
    Both the scheduled job and the refresh action use the time period defined in the scheduled job to determine how far back (in time) connection history must be retrieved. So, if the last job ran 6 hours ago and you update the repeat interval to 3 hours, you miss 3 hours of connection history if you do not run the job once first.12.png
  4. Update the repeat interval
  5. Click on Update

Online Service Cases

Within the TeamViewer Integration for ServiceNow application, a supporter can see all the online service cases from one view, using the Online Service Cases Widget, which can be accessed via TeamViewer Integration > Online Service Cases.13.png

Changing the columns

Role required: admin

The columns shown in the Online Service Cases can be changed by the ServiceNow system administrators and impacts all users of the application. To change the columns, follow these steps to go into the widget instance options:

  1. Change your application ( Settings > Developer > Application) to TeamViewer Integration for ServiceNow 22.png
  2. Go to TeamViewer Integration > Online Service Cases
  3. Press ctrl on your keyboard and right click anywhere on the widget
  4. Click on Instance Options14.png
  5. Add or remove any columns in the Fields list15.png
  6. Click on Save at the bottom of the instance options dialog.

Change the refresh rate

Role Required: admin

The Online Service Cases Widget automatically refreshes the data as long as the page is kept open, by default the data is refreshed every 30s seconds. This can be changed by the ServiceNow system administrator.

  1. Follow steps 1 - 4 from the previous section
  2. Change the refresh interval to your preferred setting, the setting is in seconds16.png
  3. Click on Save

Configuring email templates

The Share Session Code functionality on the TeamViewer Remote Control uses the standard Quick Message functionality from ServiceNow to send the session code per email to the customer. Administrators can define the templates for these quick messages.

Naming Convention

Since we use the standard Quick Message functionality of ServiceNow, the Email window shows all the available Email templates in the ServiceNow instance, including email templates created for other applications. To distinguish the email templates for TeamViewer Integration, it is advised to use a clear naming convention for your Quick Messages, e.g.:

  • TV_ShareSessionSimple
  • TV_ShareSessionAdvance
  • etc.

Creating and editing email templates

ServiceNow system administrators can create new quick message templates and edit existing templates. The email templates for the TeamViewer Integration for ServiceNow application can be accessed via the TeamViewer Integration application.

More information on creating an email template can be found in the ServiceNow documentation: https://docs.servicenow.com/bundle/kingston-servicenow-platform/page/administer/notification/task/t_...

  1. Change your application ( Settings > Developer > Application) to TeamViewer Integration for ServiceNow22.png
  2. Go to TeamViewer Integration > Email templates
  3. Click on an existing Email Template or click on New
  4. Fill in the form, you can use variables substitutions to use fields from the task record, e.g. ${caller_id}23.png
  5. Click on Update (for an existing record) or Submit (for a new record)

Using the integration

Once the TeamViewer integration app has been properly installed and configured, it can be used to create service cases and remotely access and control end users’ devices.

Creating TeamViewer Service Cases

The first time each user attempts to create a service case, they will be prompted to login with their TeamViewer credentials.

17.png18.png

This will only need to happen once per user and his access-token will be stored in the ServiceNow platform until revoked by the user or the administrator from the TeamViewer Management Console.

After the user has logged in successfully, the service case will be created.

19.png

Sharing Service Cases and establishing a connection

Once the service case has been created, the supporter can easily share the session link with the end user by clicking “Share Session code”. That will open the email window where the supporter can select a pre-defined email template.

The end users email address and name as well as the customer link and the subject/body text of the email can be automatically populated through the pre-configured templates.

20.png

The supporter can then select ‘Start Session’ immediately and will wait in a virtual lobby until the  end user clicks the link after which point the remote control session will be established. Otherwise the supporter can wait until the end user selects the link first (in which case he/she will appear as online in the Active sessions screen) and then start the session.

View Connection Reports

In every module (Incident, Problem, Change Request, Control Request) the admin has the ability to add a Related list object with the list of remote control sessions used to solve the specific incident.

The list is refreshed either when a service case is closed or when the ‘Refresh’ button is pressed.21.png

 

 

Version history
Revision #:
3 of 3
Last update:
Friday
Updated by: