XINA Struct Report Email
The XINA Struct Report Email command line utility will find daily Export and Trend packages created for the previous day, determine which users are registered to be emailed, and then create an email containing direct links to the Export and Trend packages. Note that this utility creates an email task for each user; the actual emailing will be handled by an AWS Lambda task.
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 emails for e.g. "moma.fm" | |
| hostname | utf8text |
✓ | The hostname that will be used for creating the URLs to the Export and Trend packages in the email contents e.g. "moma.xina.io" |
Example conf:
{
"model": "pace.ops_pace",
"hostname": "https://pace.xina.io"
}
No Comments