Chapter 9
9. Reference
9.1 Defaults
| Setting | Default |
|---|---|
| Host | localhost |
| Port | 3466 |
| Callback Host | localhost |
| TCP Port | 54321 |
| File Group | Default |
| iconik Base URL | https://app.iconik.io |
| All other Iconik and SQS fields | Blank |
9.2 Timing and limits
| Item | Behavior |
|---|---|
| Queue check | Continuous; a new request is usually collected within a few seconds |
| Requests collected at one time | Up to 10 |
| Requests processed at one time | Up to 5 |
| Collections or saved searches per request | The first one only |
| Wait for XenData to confirm a new job | 5 minutes, then the sub-job fails |
| Request to XenData | Times out after 30 seconds |
| Queue retention | Set for each site; read Message Retention Period on the Status tab |
| Local job history | 7 days; older records are removed at startup |
| Log files | 5 MB each; up to 5 files of each kind |
A request that stays in the queue longer than its retention period is removed by AWS. Run the action again in Iconik if the application was stopped longer than that period.
9.3 File locations
XenData for Iconik keeps its data in the Windows user profile of the person who runs it.
| Item | Location |
|---|---|
| Application | Start > North Shore Automation > NSA ICO-XD Connect |
| Application data | %APPDATA%\NSA ICO-XD Connect\ |
| Settings | config.json in application data |
| Job database | xendata.db in application data |
| Log files | The logs folder in application data |
Uninstall does not remove application data. Do not edit or delete these files while the application runs.
9.4 Iconik requirements
Your Iconik administrator sets up these items once. North Shore Automation supplies the custom action address.
| Item | Requirement |
|---|---|
| Archive custom action | Sends the header action with the value archive |
| Restore custom action | Sends the header action with the value restore |
| Custom action contexts | Assets, a collection, or a saved search |
| Optional archive form | A boolean field named DeleteAfterArchive |
| ISG storage | The disk storage that holds original files |
| Archive storage | An Iconik storage that represents the XenData archive |
| Application token | Can read and update assets, file sets, metadata fields, and jobs |
Use lowercase action values.
Collections and saved searches are expanded only for archive and restore in lowercase.
XenData for Iconik creates the metadata fields XenDataTapeID and XenDataArchiveTemplateVersion when they do not exist.
Add them to an asset metadata view so that users can see them.
9.5 Where to do common tasks
| Task | Location |
|---|---|
| Archive or restore assets | Iconik custom actions |
| Follow job progress | Iconik Jobs |
| Find the tape for an asset | XenData Tape ID field on the asset in Iconik |
| Change XenData, Iconik, or SQS settings | Status > Update Config |
| Check connections | Status tab |
| Read recent activity | Logs tab |
| Quit the application | File > Exit, or Quit on the tray icon |
| Update the application | Uninstall, then run the new .msi. See Updates |
9.6 Glossary
| Term | Meaning |
|---|---|
| Archive storage | The Iconik storage that represents copies on XenData tape |
| Asset | An Iconik record for a media item, with its files and metadata |
| AWS | Amazon Web Services, the cloud service that hosts the request queue |
| Callback | A progress update that XenData sends to XenData for Iconik |
| Custom action | An Iconik menu command that sends a request to an outside system |
| File group | A XenData area on tape with its own rules; archives go into one file group |
| File set | Iconik's record of an asset's files on one storage |
| ISG | Iconik Storage Gateway; the disk storage that Iconik manages on your network |
| Parent job | An Iconik job that groups sub-jobs for one request |
| Queue | The AWS SQS queue that holds requests until XenData for Iconik collects them |
| SQS | Simple Queue Service, the AWS queue service |
| Sub-job | An Iconik job for one asset |
| Template version | The tape path format of an archive: 1 without folders, 2 with folders |