XINA Struct Report

The XINA Struct Report command line utility generates Export and Trend tasks for Profiles and Trend Definitions that are configured to auto generate. It can also optionally generate the XINA Report Email Task. The Export tasks will export the a days worth of data and the Trend tasks will use the time ranges or intervals as configured in the Trend Definition. By default, it will generate reports for the day before the task's creation time. The most common use case is to create the XINA Report Task (xina_struct_report) using XINA's internal cron system once per day.
Arguments

Name
Req
Description
Default

cache

Cache directory path. Used for any persistent caching across tasks for optimization purposes.

conf
✓
File path to the JSON config containing the report parameters.

env
✓
File path to the JSON environment file which defines environment parameters such as project specific paths.

help

Print available options.

host

XINA Tunnel host.
"localhost"

port

XINA Tunnel port.
41746

import
✓
Import directory path. Files that need to be imported will be placed here.

log
✓
File path that log events will be written to.

out
✓
Ouptut directory path. Files placed here will be uploaded and accessible directly from the Task interface (e.g. notifications panel).

post
✓
Post directory path (for post-import outputs) e.g. uploading log files to the Task record.

task
✓
File path to the JSON file containing info about the Task.

temp
✓
Temp directory path for storing temporary files during execution.

conf
The below table describes the available fields in the conf JSON file.

Name
Type
Req
Description
Default

model
utf8text 
✓
Path of model to generate Export and Trend tasks for e.g. "moma.fm"

email
boolean

If true, the report email task will be generated
true

date
utf8text

Generates the report for the given date/day. Supports 2 formats: YYYY-MM-DD (e.g. 2020-10-25) and YYYY-DOY (e.g. 2025-300).
Generates report for the day before the task creation time.

Example conf:
{
 "model": "pace.ops_pace",
 "email": true,
 "date": "2024-01-30"
}