TeamViewer Embedded Service
  • 08 Jun 2022
  • 5 Minutes to read
  • Dark
    Light
  • PDF

TeamViewer Embedded Service

  • Dark
    Light
  • PDF

The TeamViewer integration allows admins to initiate a TeamViewer remote control session with their end users from anyticket even if they do not have a TeamViewer account.

Requirements

For the integration to work properly, please ensure that the following requirements are in place:

  • Your network must have an internet connection and access to TeamViewer URL
  • Your SysAid URL must also be accessible to outside of your company network
  • You cannot use the server's IP address as the URL
  • You must be running SysAid version 17.2.40 or above
  • Ensure that you can access all TeamViewer servers. The easiest way to do this is to open port 5938 (TCP) for outbound connections to any IP addresses. Alternatively, you can add Teamviewer.com to your whitelist of permitted URLs.
  • For On Premise accounts, ensure that the SysAid server has access to the SysAid Gateway at the following URL: https://gateway.sysaid.com
Note

Only an admin with SysAid Administrator permissions can set up this integration.

To avoid downloading and installing the TeamViewer .exe file every session, we recommend that admins install TeamViewer on your machine just once before using this embedded service. During the installation process it is important to select that you want to use TeamViewer for both commercial and non-commercial use. This allows for TeamViewer to properly work with SysAid's embedded service license.

IntegrationTeamViewerEmbeddedfilesTeamViewerBoth.png

Licensing

SysAid TeamViewer Embedded operates on an annual subscription licensing model. This means that you must have a valid license subscription to retain TeamViewer Embedded capabilities.

Each SysAid TeamViewer Embedded concurrent license allows for access to 150 devices per month (this number covers above average service desk remote control usage per admin based on our aggregated statistics)*.

In a standard service desk attended remote control scenario, there is no need to pre-install the TeamViewer agent on the device you want to access; the SysAid agent launches the remote control session on the spot. You can also enable unattended sessions on a per-need basis without the need to enabe this capability on all devices in your network.

If your organizational needs do require enabling unatteneded capability on all of your devices at all times, you can contact your account manager to discuss the purchase of a specialized license.

Enable the TeamViewer Integration

  1. On the main My Apps page, on the TeamViewer icon, click IntegrationsfilesGreenCog19.jpg.
  2. Click the slider to activate the TeamViewer integration.
  3. Select if you want an activity added to an SR or Asset activity log for each TeamViewer session.
  4. Click Save Changes.
    IntegrationTeamViewerEmbeddedfilesConfiguration.png

Grant TeamViewer Embedded access to an admin or admin group

For an admin to be able to use TeamViewer embedded they need the required permissions. Once the TeamViewer Embedded is enabled on your account, you can allow admins or admin groups to deploy/undeploy TeamViewer embedded on assets and/or to initiate a TeamViewer Embedded remote control session. You can access these permissions in the admin form, the admin list, and the admin group form, respectively.

Launch a TeamViewer session from an SR

Once the integration is configured, you can launch a TeamViewer remote control session from any SR. You can launch an attended session from the user field or an unattended session from the Main Asset field.

Note

You must have at least one available license to launch a TeamViewer session on an asset.

Attended session

Attended sessions are sessions that you launch with the assistance of the users whose machines you are accessing. These users must be logged in during the sessions and they must grant you permission to access their machines. Click here to view a video tutorial for launching an attended session.

To launch an attended session from an SR

  1. Find the user you want to share the session with and click the TeamViewer icon in that user's actions.
    IntegrationTeamViewerEmbeddedfilesStartTeamViewer.png
  2. If this is the first time, you are accessing TeamViewer from SysAid, a prompt appears requesting the necessary permissions. Click Allow.
  3. In the TeamViewer Integration window, click Connect as admin.
    If you have TeamViewer installed on your machine, it opens and launches the session.
  4. If you do not have TeamViewer installed on your machine, an .exe file automatically downloads on your machine. Run the file to launch the session.

Once the session begins, you need to send the admin or end user you are connecting with the necessary information to join the session. To do this, you can either manually send your session partner the session code or you can generate a predefined email notification with a link to the session.

To manually send the session code

  1. When you click the Start TeamViewer link, a TeamViewer window opens on your screen. Copy the session code in the top half of the window.
    IntegrationTeamViewerEmbeddedfilesCode.png
  2. Paste the code into an email or instant message and send it to your session partner.

To generate a predefined email notification with a link to the session

  1. In the TeamViewer Integration window, click Send Message.
    IntegrationTeamViewerEmbeddedfilesTVRC.png
  2. A Send Message window opens with a ready-to-send email that includes a link to the TeamViewer session.
  3. Click Send.
    IntegrationTeamViewerEmbeddedfilesRCEmail.png

Unattended session

Unattended sessions are sessions that you launch without the assistance of the users whose machines you are accessing. These users need not be logged in during the sessions.

Note

You must be running the latest version of the agent to launch an unattended session. To upgrade the agent, navigate to Settings > Network Discovery > Upgrade Agent Version.

Deploy TeamViewer

To initiate an unattended session on an asset you must first deploy the TeamViewer agent on the asset.

To deploy/undeploy a TeamViewer on an asset

  1. In the Asset list, select the assets you want to deploy TeamViewer on.
  2. In the List Actions, select More Actions.
  3. Select TeamViewer Embedded.
  4. Select Enabled or Disabled to deploy or undeploy the TeamViewer agent on the selected assets.
  5. Click Save.

IntegrationTeamViewerEmbeddedfilesDeploy.jpg

Launch a session from an SR

Once TeamViewer is enabled on the asset, you can launch an unattended session from an SR by clicking the TeamViewer icon corresponding to the Main Asset field.

IntegrationTeamViewerEmbeddedfilesMainAssetRC.jpg

If TeamViewer is not installed on your computer, SysAid's TeamViewer dialog offers a link to download TeamViewer to your machine. This will speed up future sessions that your intitiate from your computer.

IntegrationTeamViewerEmbeddedfilesTVEspeedTVEspeed.png

Initiate a TeamViewer Session

Launch a TeamViewer session from an asset

Once the integration is configured, you can launch an unattended TeamViewer remote control session from any asset with the TeamViewer agent deployed on it.

Note

You must have at least one available license to launch a TeamViewer session on an asset.

To launch a TeamViewer session from an asset

  1. From the asset form, open the RC tab.
  2. From the Method drop-down list, select TeamViewer Embedded.
  3. Click Start.
    IntegrationTeamViewerEmbeddedfilesAssetForm.jpg

Notifications

You can edit the email before you send it. You can also edit the default text of the automatically generated notification by locating the TeamViewer notification in Settings > Customize > Notifications.

IntegrationTeamViewerEmbeddedfilesTeamviewerLinkNotificationTeamviewerLinkNotification.png

Activities

Once a TeamViewer session is closed, SysAid automatically generates an activity for the session and adds it to the SR.

IntegrationTeamViewerEmbeddedfilesTVActivity.png

Download session information

You can download monthly .csv reports that detail the usage of TeamViewer Embedded service for the specified monthly period.

To download a TeamViewer Embedded usage report

  1. From the TeamViewer Embedded configuration page, select the monthly period you want to report on.
    IntegrationTeamViewerEmbeddedfilesSessionInformation.png
  2. Click Get Connections.

Was this article helpful?

What's Next