Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Remote Control / Create Session

  • Article
  • 2 minutes to read

Operation Information

Hornbill Integration method for creating a new remote control session in TeamViewer.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type TeamViewer.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose TeamViewer in the Type pick list;
  • Give the TeamViewer KeySafe key a Title (this is the name / identifier for the TeamViewer account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Click the Create Key button to create your new key;
  • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
  • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
  • Accept the review and you will be returned to your KeySafe key.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked TeamViewer account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Description description string TeamViewer session description No None provided
Entity Reference entityId string Hornbill Entity Reference - Request Reference, or Asset ID for example No None provided
Entity Name entityName string Hornbill Entity Name No None provided
Customer ID customerId string Hornbill Customer ID No None provided
Waiting Message waitingMessage string Message displayed to the waiting customer. No None provided
Customer Name. Maximum length is 100 characters endCustomerName string Customer Name. No None provided
Customer Email Address. Maximum length is 254 characters endCustomerEmail string Customer Email. No None provided

Output Parameters

Display Name ID Type Description
Session Code sessionId string Newly created session code
State state string State of the session
Group ID groupid string Group IDwhere this session is stored in.
End Customer Link end_customer_link string End Customer Link
Supporter Link supporter_link string Supporter Link
Created At created_at string Session created at
Valid Until valid_until string Session valid until
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document