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!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
This integration will create a new 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 |
---|---|---|---|---|---|
Site ID | siteId |
number |
The ID of the Site | Yes | None provided |
Building ID | buildingId |
number |
The ID of the Building | No | None provided |
Contact Name | contactName |
string |
The Contacts Name | No | None provided |
Contact Email | contactEmail |
string |
The Contacts Email Address | No | None provided |
Contact Phone | contactPhone |
string |
The Contacts Phone Number | No | None provided |
Contact Organization | contactOrg |
string |
The Contact’s Organization’ | No | None provided |
Description | description |
string |
The Description of the Help Call | Yes | None provided |
Additional Fields | fields |
array |
Any additional fields that you wish to set. | No | None provided |
Output Parameters
Display Name | ID | Type | Description |
---|---|---|---|
ID | id |
string |
The ID of the Help Call |
Code | code |
string |
The Help Call Code |
Status | status |
string |
Status of the operation |
Errors | errors |
string |
Any errors returned by the operation |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document