# Utilities # XINA Connect XINA Connect is a Java application which combines the features of the XINA Tunnel and XINA Import applicatons with a UI. This application is distributed as a Java jar file and requires Java 17 or greater to run. The recommended OpenJDK build is available [here](https://learn.microsoft.com/en-us/java/openjdk/download). ### Latest Version #### 1.1.0 [Windows Installer](https://smce-xina.s3.amazonaws.com/dist/connect/XINA+Connect+Beta-1.1.0.msi) [Windows Portable](https://smce-xina.s3.amazonaws.com/dist/connect/XINA+Connect+Beta-1.1.0.zip) [MacOS Installer](https://smce-xina.s3.amazonaws.com/dist/connect/XINA+Connect+Beta-1.1.0.dmg) [Jar File](https://smce-xina.s3.amazonaws.com/dist/connect/XINA+Connect+Beta-1.1.0.jar.zip)(requires Java 17+) `java -jar xina_connect.jar` ### Previous Versions #### 1.0.0 [Windows Installer](https://smce-xina.s3.amazonaws.com/dist/connect/XINA+Connect+Beta-1.0.0.msi) [MacOS Installer](https://smce-xina.s3.amazonaws.com/dist/connect/XINA+Connect+Beta-1.0.0.dmg) # XINA Tunnel XINA Tunnel is a command line application required for client applications to communicate with the XINA Server via the [XINA API](/books/api-reference). This application is distributed as a Java jar file and requires Java 21 or greater to run. The recommended OpenJDK build is available [here](https://learn.microsoft.com/en-us/java/openjdk/download). ### Latest Version #### XINA Tunnel 13.1.0 [Download](https://smce-xina.s3.amazonaws.com/dist/13.1.0/xina-tunnel.jar) ### Usage Windows ``` java -jar "path to xina_tunnel.jar" ^ -host "host URL or IP address" ^ -keyfile "path to key.json" ``` MacOS, Linux ``` java -jar "path to xina_tunnel.jar" \ -host "host URL or IP address" \ -keyfile "path to key.json" ``` ### Old Versions #### XINA Tunnel 9.2.0 [Download](https://smce-xina.s3.amazonaws.com/dist/tunnel/xina_tunnel_9.2.0.zip) ### Usage Windows ``` java -jar "path to xina_tunnel.jar" ^ -host "host URL or IP address" ^ -keyfile "path to key.json" ``` MacOS, Linux ``` java -jar "path to xina_tunnel.jar" \ -host "host URL or IP address" \ -keyfile "path to key.json" ``` # XINA Import XINA Import is a utility for importing XINA API actions as JSON files. This application is distributed as a Java jar file and requires Java 21 or greater to run. The recommended OpenJDK build is available [here](https://learn.microsoft.com/en-us/java/openjdk/download). ### Latest Version #### XINA Import 13.1.0 [Download](https://smce-xina.s3.amazonaws.com/dist/13.1.0/xina-import.jar) Windows ``` java -jar "path to xina_import.jar" ^ [additional arguments...] ``` MacOS, Linux ``` java -jar "path to xina_import.jar" \ [additional arguments...] ```
Argument | Info | Default |
---|---|---|
`-host | the XINA Tunnel host | `"localhost"` |
`-post | the XINA Tunnel port | `41746` |
`-okmove | if set, move files to path to after successful import | none (files are not moved) |
`-oktrash` | if set, move files to OS trash after successful import | `false` |
`-okdelete` | if set, permanently delete files after successful import | `false` |
`-ermove | if set, move files to path to after failed import | none (errors stop import) |
`-dir | path to directory containing files to import | |
`-watch | path to directory to watch for files to import | |
`-recursive` | if true in `dir` or `watch` mode, searches directory recursively for JSON files | `false` |
Argument | Info | Default |
---|---|---|
`-host | the XINA Tunnel host | `"localhost"` |
`-post | the XINA Tunnel port | `41746` |
`-okmove | if set, move files to path to after successful import | none (files are not moved) |
`-oktrash` | if set, move files to OS trash after successful import | `false` |
`-okdelete` | if set, permanently delete files after successful import | `false` |
`-ermove` | if set, move files to path to after failed import | none (errors stop import) |
`-dir | path to directory containing files to import | |
`-watch | path to directory to watch for files to import | |
`-recursive` | if true in `dir` or `watch` mode, searches directory recursively for JSON files | `false` |
Argument | Info | Default |
---|---|---|
`-host | the XINA Tunnel host | `"localhost"` |
`-post | the XINA Tunnel port | `41746` |
`-movejson | directory to move JSON files to after import | none (files are not moved) |
`-movefile | directory to move other files to after import | none (files are not moved) |
`-deljson` | if set, permanently delete JSON files after import | `false` |
`-delfile` | if set, permanently delete other files after import | `false` |
`-dir | path to directory containing files to import | |
`-watch | path to directory to watch for files to import | |
`-recursive` | if true in `dir` or `watch` mode, searches directory recursively for JSON files | `false` |
Name | Req | Description | Default |
---|---|---|---|
task | ✓ | task ID | |
conf | ✓ | JSON conf file path | |
temp | ✓ | temp directory path | |
import | ✓ | import directory path (for file outputs) | |
post | ✓ | post directory path (for post-import outputs) | |
host | tunnel host | `"localhost"` | |
port | tunnel port | `41746` |
Name | Req | Description | Default |
---|---|---|---|
origin | ✓ | origin group | |
slice | slice length in minutes | `60` | |
t | slice time barrier (see below) |
Name | Req | Description | Default |
---|---|---|---|
task | ✓ | task ID | |
conf | ✓ | JSON conf file path | |
temp | ✓ | temp directory path | |
import | ✓ | import directory path (for file outputs) | |
post | ✓ | post directory path (for post-import outputs) | |
host | tunnel host | `"localhost"` | |
port | tunnel port | `41746` |
Name | Req | Description | Default |
---|---|---|---|
pipe | ✓ | pipe group path, or model path if no pipe | |
slice | slice length in minutes | `60` | |
t | TBD REMOVE slice time barrier (see below) | ||
TODO: Add re-mine options |
Name | Req | Description | Default |
---|---|---|---|
cache | Cache directory path. Used for any persistent caching across tasks for optimization purposes. | ||
cancellation | Path to the cancellation file for detecting cancel requests. | ||
conf | ✓ | File path to the JSON config containing the export parameters. | |
env | ✓ | File path to the JSON environment file which defines environment parameters such as project specific paths. | |
extract | Overrides the path provided in the environment file to the [struct\_extract](https://wiki.xina.io/books/structured-data-standards/page/struct-extract-interface) app. Only used if the archive format is `xpf`. | ||
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. `struct_export` is responsbile for generating the corresponding import action file but `xina-run` will perform the actual importing. | |
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). | |
pkt\_models | Models to use packet time by default. **\[TBD Remove\]** | ||
plot | ✓ | Overrides the path provided in the environment file to the app that generates plot PDFs. | |
post | ✓ | Post directory path (for post-import outputs) e.g. uploading log files to the Task record. | |
python | ✓ | Overrides the path to the Python executable used by the plot app provided in the environment file. | |
task | ✓ | File path to the JSON file containing info about the Task. | |
temp | ✓ | Temp directory path for storing temporary files during execution. For example, zipped archives are unzipped to this directory for processing. |
Name | Type | Req | Description | Default |
---|---|---|---|---|
model | `utf8text ` | ✓ | Path of model to export data from e.g. `moma.fm` | |
start | `instant(us)` | ✓ | Start time of data to export. May be provided as a Unix timestamp in microseconds (e.g. `1738781947000000`) or an ISO 8601 formatted string (e.g. `2024-06-12T00:00:00Z`). | |
end | `instant(us)` | ✓ | End time of data to export. May be provided as a Unix timestamp in microseconds (e.g. `1738781947000000`) or an ISO 8601 formatted string (e.g. `2024-06-12T00:00:00Z`). | |
ueid | `UUID` | Event UUID of interval if the export was requested for an interval. The event's start and end time will be used instead of `start` and `end`. | ||
disable\_filter | `boolean` | If `true`, does not apply the filters defined in `data_conf`. This is useful if you want to export an existing profile that has filters, but don't want to apply the filters. | false | |
copy | `boolean` | If true, the zip file will be uploaded and available from the Task UI. | false | |
label | `utf8text` | The text that will be used to name the files and final zip file. The format will be like `2024_06_12_00_00_00_2024_06_12_00_20_00_profile_label` | ||
profile | `utf8text ` | The name of the Profile if the export was generated from one. If provided, then the Profile's `plot_conf` and `data_conf` will be used. | ||
auto\_conf | `struct_auto_conf` | The `struct_auto_conf` that triggered the export. Only provided if the export was auto generated. | ||
plot\_conf | `struct_plot_conf` | The plot configuration used to generate the plot PDF. See [plot format](https://wiki.xina.io/books/oci-user-guide/page/export-plot-configuration-json-format). An empty object i.e. `{}` can be provided to generate the default plot configuration. If not provided, then plots will not be generated. | One mnemonic per plot, one plot per page, sorted by `mn_id` in ascending order. | |
data\_conf | `struct_data_conf` | See [struct\_data\_conf](https://wiki.xina.io/link/170#bkmrk-struct_data_conf-jso) | ||
multi | `boolean` | **\[TBD REMOVE - Not currently supported\]** Has extract process all archives at once. This was added for performance reasons since loading the mnem def is slow. |
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 trend 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. `struct_trend` is responsbile for generating the corresponding import action file but `xina-run` will perform the actual importing. | |
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. |
Name | Type | Req | Description | Default |
---|---|---|---|---|
model | `utf8text ` | ✓ | Path of model to trend data from e.g. `moma.fm` | |
copy | `boolean` | If true, the zip file will be uploaded and available from the Task interface. | false | |
trend | `utf8text ` | The name of the [Trend Definition](https://wiki.xina.io/link/170#bkmrk-trend-definitions) to generate the trend for. If provided, then the `profiles`, `trend_conf`, and `plot_conf` will be loaded from it. | ||
label | `utf8text` | The text that will be used to name the files and final zip file. The format will be like `2024_06_12_00_00_00_2024_06_12_00_20_00_profile_label` | ||
profiles | `set(utf8string)` | Name of profile(s) to include in trend | ||
trend\_conf | `struct_trend_conf` | See [struct\_trend\_conf](https://wiki.xina.io/link/170#bkmrk-struct_trend_conf-js) | ||
plot\_conf | `jsonobject` | See [trend plot conf](https://wiki.xina.io/link/170#bkmrk-plot_conf-jsonobject-1) |
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. |
Name | Type | Req | Description | Default |
---|---|---|---|---|
model | `utf8text ` | ✓ | Path of model to generate Export and Trend tasks 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" | |
`boolean` | If true, the report email task will be generated | true |
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. |
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" |