Audience
This guide is for HighQ administrators who want to configure BRYTER integration with HighQ.
Before you start
Before adding a HighQ integration in BRYTER, a HighQ system admin must first Register a new API Application in Collaborate. This will typically be a customer, not a BRYTER admin.
NOTE: When adding the Application in Collaborate, the System Admin will need to set the refresh token expiry to a period > 48 hours. The BRYTER Integrations OAuth flow requires this in order to allow for a daily refresh of tokens.
After adding an API application to HighQ, the system admin can share the client_id and client_secret parameters from HighQ’s System Admin / API application registration page.
Redirect URI – The customer's System Admin will need to configure the redirect_uri as follows: https://{tenant_name}.bryter.io/admin/integrations/configuration/create/redirect-handler
The Admin Console
This image illustrates the Admin Console’s Integrations page, where you can configure integrations installed in the Catalog.
Important: you cannot be logged in to HighQ at the same time, so you have to do the config in an incognito browser. If the users are logged into HighQ at the same time in order to get the various creds from the iSheet, etc the setup with the authentication will not work. In that case an error saying “Unable to get token” will be displayed.
Character limit on HighQ Single line text columns
Single line text columns in HighQ have a character limit that defaults to 255. You can adjust this limit to any value between 1 and 255 in HighQ.
For use cases requiring longer input, you can either create Multiple line text columns or convert existing Single line text columns to Multiple line text columns, which have no character limit.
Authorization
This integration uses the OAuth protocol, which requires the following parameters:
Name |
Description |
Example value |
auth_url | Authentication parameter, in the form {base_url}/{tenant_name}/authorize.action | https://acme.highq.com/acme/authorize.action |
token_url | Authentication parameter, in the form {base_url}/api/oauth2/token | https://acme.highq.com/acme/api/oauth2/token |
client_id | Authentication parameter from HighQ / System admin / API application registration | 123 |
client_secret | Authentication parameter from HighQ / System admin / API application registration / Secret key | tW2mLslZ2kKczlpmEl3mHDnm |
Parameters
Name |
Description |
Example value |
highq-instance | Server URL (base_url), in the form https://{tenant-name}.highq.com/{tenant-name}/ | https://acme.highq.com/acme/ |
isheet-id | (iSheet integrations only) Identifies the iSheet to use, from the iSheet URL’s metaData.sheetId query string parameter | 61 |
isheet-row-key-column-ids | (iSheet integrations only) comma-separated column numeric IDs. To get the value from HighQ in the browser, sort by the desired column and get the sortColumnID query string parameter value. This works when an iSheet has at least 2 rows. | 111,222,333 |
choice-separator | (iSheet integrations only) The separator used to delimit values for multiple-choice columns. Defaults to , if not specified. | ;; |
site-name | name of the HighQ site that should be accessed (for testing use "BRYTER Site") | BRYTER Site |
search-limit | A number up to 100. As we use HighQ's fuzzy search in the iSheet Get Row action, usually more than one search results are returned by the HighQ service and the integration further filters the results and keeps only the single correct result. A good starting point to set the value might be 100. If the search doesn't return an existing entry you can try to increase that value - decreasing it could speed up the integration. | 100 |