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}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

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

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Help Calls / Get

  • Article
  • 3 minutes to read

Operation Information

This integration will return details of a Help Call.

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 Technology Forge TF Cloud.

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 Technology Forge TF Cloud in the Type pick list;
  • Give the Technology Forge TF Cloud KeySafe key a Title (this is the name / identifier for the Technology Forge TF Cloud account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Domain string Domain for the TF Cloud instance token generation and API Endpoint
Client ID string Application Client ID
Client Secret string Application Client Secret
Site Group string Application Site Group
Username string Username
Password string Password
Token string Access Token

Revoking Access

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

Warning

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

Input Parameters

Display Name ID Type Description Required Supported Values
Code code string The Help Call Code Yes None provided
Return Notes returnNotes boolean Whether helpcall notes should be returned (filling firstNote, lastNote, allNotes and allNotesReverse). If this is not set those fields will remain empty to save network loads. No None provided

Output Parameters

Display Name ID Type Description
ID id string Help Call ID
Site siteDesc string Site Description
Building buildingDesc string Building Description
Help Call Status callStatus string The Status of the Help Call
Help Call Description description string The Help Call Description
Priority priority string Priority Code
Priority Description priorityDesc string Priority Description
Status status string Status of the operation
First Note firstNote string First note
Last Note lastNote string Most recent note
All Notes allNotes string All notes in chronological order
All Notes Reversed allNotesReverse string All notes in reverse chronological order (i.e. most recent note first)
First Private Note firstPrivNote string First private note
Last Private Note lastPrivNote string Most recent private note
All Private Notes allPrivNotes string All private notes in chronological order
All Private Notes Reversed allPrivNotesReverse string All private notes in reverse chronological order (i.e. most recent note first)
First Open Note firstOpenNote string First open note
Last Open Note lastOpenNote string Most recent open note
All Open Notes allOpenNotes string All open notes in chronological order
All Open Notes Reversed allOpenNotesReverse string All open notes in reverse chronological order (i.e. most recent note first)
Errors errors string Any errors returned by the operation
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document