Chapter 6

6. Status, logs, and support

The XenData for Iconik window has two tabs: Status and Logs.

6.1 System Status

System Status shows the XenData server that XenData for Iconik uses.

Value	Meaning
State	Complete (green): XenData answered. Pending (yellow): XenData is busy. Error (red): XenData reported a problem
Product Name, Product Version	The XenData software on the server
Archive Status	OnLine (green): the archive accepts work. OffLine (red): it does not. Maintenance (yellow): it is in maintenance
Archive Root	The archive location on the XenData server
Server IP, Server Port	The XenData server address
Client IP, Client Port	This computer's connection to XenData
NSA ICO-XD Connect	The installed version of XenData for Iconik

XenData for Iconik reads this panel when the window opens and after you save settings. It does not refresh the panel on its own. To read it again, select Update Config and then Save.

6.2 SQS Queue Status

SQS Queue Status shows the cloud queue that holds Iconik requests.

State	Meaning
Connected	XenData for Iconik can read the queue
Connecting...	XenData for Iconik is checking the queue
Connection Failed	XenData for Iconik cannot read the queue; read the error below the state

The panel also lists queue details from AWS.

Detail	Use
Approximate Number Of Messages	Requests that wait for collection; this is usually `0`
Approximate Number Of Messages Not Visible	Requests that XenData for Iconik is processing now
Message Retention Period	How long, in seconds, the queue keeps a request that is not collected

If Approximate Number Of Messages stays above 0, requests are not being collected. See A job does not appear in Iconik.

6.3 The Logs tab

Logs shows recent activity while the window is open. Each line has a time, a level, and a message.

Level	Meaning
error	A problem that stopped part of the work
warn	A problem that XenData for Iconik worked around
info	Normal activity
success	A step completed

Select Copy Logs to copy the shown lines to the clipboard. Paste them into a support email or text file.

6.4 Log files

XenData for Iconik also writes logs to files.

File	Contains
`xendata-connect.log`	All activity at info level and above
`xendata-connect-error.log`	Errors only

Each file grows to 5 megabytes (MB). XenData for Iconik then starts a new file and keeps up to 5 files of each kind. Older files are removed. See File locations.

You cannot change the log level or location from the window.

6.5 Collect information for support

Note what you did, what you expected, and what happened.
Record the time and time zone of the problem.
Copy the version from the NSA ICO-XD Connect line on the Status tab.
In Iconik, copy the job name, the job status, and the sub-job message.
Copy the log files that cover the time of the problem.
Copy the job database. See Copy the job database.
Email the details, the log files, and the database .zip file to support@northshoreautomation.com.

Review the files before you send them. Logs and the job database can contain asset names, file paths, and storage IDs. Do not send the Iconik token, the AWS secret key, or the settings file.

6.6 Copy the job database

The job database holds the records of recent jobs and sub-jobs. Support uses it to see what happened to each asset.

Open File Explorer.
Type %APPDATA%\NSA ICO-XD Connect in the address bar, then press Enter.
Select xendata.db. If xendata.db-wal and xendata.db-shm are also there, select them too.
Right-click the selected files and select Copy.
Paste the copies into a new folder, for example on the desktop.
Right-click the new folder and select Compress to ZIP file. On Windows 10, select Send to > Compressed (zipped) folder.
Attach the .zip file to your support email.

You do not need to quit the application to copy the database. Do not move, rename, or delete the original files. The database keeps 7 days of job records, so copy it soon after the problem. See Local job history.

Previous: Settings · Contents · Next: Updates