Chapter 5
5. Settings
Open settings from the Status tab. Select Update Config in the System Status panel. On a new installation, select Configure Settings.
The settings form has three sections. Fields marked with an asterisk (*) are required. Save stays unavailable until each required field has a valid value.
5.1 Xendata Configuration
| Field | Default | What to enter |
|---|---|---|
| Host | localhost |
The XenData server; keep localhost |
| Port | 3466 |
The XenData Workflow API port |
| Callback Host | localhost |
The address that XenData sends progress to; keep localhost |
| TCP Port | 54321 |
The port that receives XenData progress updates |
| File Group | Default |
The XenData file group for Iconik archives |
Callback Host and TCP Port tell XenData where to send progress.
XenData for Iconik runs on the XenData server, so both hosts are localhost.
Change TCP Port only when another program uses 54321.
If XenData cannot reach this address, jobs start but never finish. See Jobs stay at STARTED.
Choose a file group
- Enter Host and Port.
- Under File Group, select Load.
- Choose a file group from the list.
After the first load, the button changes to Refresh. Wait a few seconds between requests. The button stays unavailable for 3 seconds after each request, to protect the XenData service.
If XenData cannot list file groups, a message shows under the field. You can still type the file group name.
Change the file group only with your XenData administrator. New archives go to the new file group. Assets already archived stay in their original file group.
5.2 iconik Configuration
| Field | Default | What to enter |
|---|---|---|
| iconik Storage ID | Blank | The ID of the ISG disk storage that holds original files |
| iconik Archive Storage ID | Blank | The ID of the Iconik storage that represents the XenData archive |
| App ID | Blank | The Iconik application ID |
| App Token | Blank | The Iconik application token |
| iconik Base URL | https://app.iconik.io |
The Iconik address for your organization |
Get these values from your Iconik administrator. The application needs permission to read and update assets, file sets, metadata, and jobs.
If the token expires or is removed, jobs fail. Enter a new App Token and select Save.
5.3 SQS Configuration
| Field | Default | What to enter |
|---|---|---|
| Region | Blank | The AWS region of the queue, such as us-east-1 |
| SQS Queue URL | Blank | The full queue address |
| Access Key ID | Blank | The AWS access key for the queue |
| Secret Access Key | Blank | The AWS secret key for the queue |
North Shore Automation supplies these values. Each site uses its own queue. Do not point two XenData for Iconik installations at the same queue.
5.4 Save, Cancel, and Reset App Config
| Button | Result |
|---|---|
| Save | Saves the settings and reconnects to XenData, Iconik, and SQS |
| Cancel | Closes the form and discards changes |
| Reset App Config | Returns all settings to their defaults at once |
Reset App Config does not ask for confirmation. It removes your Iconik and AWS values. XenData for Iconik stops collecting requests until you enter the settings again. It does not delete job records or change Iconik.
Record your settings in a safe place before you use Reset App Config.
5.5 Where settings are kept
XenData for Iconik saves settings for the Windows user that runs it. Settings stay in place when you uninstall or upgrade. See File locations.
The settings file holds the Iconik token and AWS secret key. Limit access to this Windows account and computer.
Previous: Following jobs in Iconik · Contents · Next: Status, logs, and support