General
API Keys
Various Workflow Extensions require API keys to function. The specific documentation of a Workflow Extension will describe the key(s) you or your organization must possess for the Extension to function properly.
API Keys are retrieved from the deployment configuration to make it easy to store them in one place, and also to secure your keys in production.
Keys are stored in the deployments settings.py file.
This is a slightly technical process. Only administrators are permitted to edit this file. Do not edit this file if you are not sure what you are doing or if your organization has already set it up for you. Do not edit any portion of the file other than what is described below or inside a specific Workflow Extension’s documentation. Do not edit the filename.
This file may be edited with any text editor. It contains a simple Python dictionary object named “API_KEYS”. To insert your organization’s key, locate the identifier for the Workflow Extension(s) you are adding a key for. It will be to the left of a colon within all the data inside curly braces ( { } ). If you can’t find the identifier you are looking for, add it to this dictionary according to the Extension’s documentation.
To the right of the colon next to that identifier, there will be double quotes. If they are empty, paste the key in-between the quotes. If there is an existing key, replace the entirety of it, within the quotes, with the new key. Quotes must remain present. Do not delete the comma after the end-quote. See the image below for an example of how one line should look when entering a key. The highlighted text shows where you would place your API key.
Your key dictionary may contain more rows between the curly braces, depending on the Extensions you have configured. Again, each Workflow Extension’s documentation will specify what should be included in this file to achieve functionality.
For added security, it is recommended that you use environment variables to reference your API keys in settings.py. Follow the same process as in section 3. Generate a secret key. for setting and retrieving the keys from an environment variable.
Hover Info
There are various buttons and items within the application environment that do not have labels. They are described within this Guide, but while using the environment, if you question what an item is, hover the cursor over the item for a second. A small box will appear with a label, indicating what the item is.
Keyboard Shortcuts (Keybinds)
To make interaction with the application environment most convenient for the user, various components may be accessed quickly using the keyboard shortcuts provided in the table below.
| Component | Shortcut |
|---|---|
| Settings and Preferences | Ctrl + Alt + S |
| Menu | Ctrl + Alt + C |
| Workflow Drawer | Ctrl + Alt + E |
| Data Manager | Ctrl + Alt + D |
| Reporting Manager | Ctrl + Alt + R |