X Stream Definitions
This is an advanced feature and should be modified with caution.
X Stream Definitions is where details on various processes are stored. It contains details on file movers needed for an integration, stored procedure automation details, file exports, and any custom or integration plugins CXT Software has created for your company. Most definitions are created by CXT Software when building an integration or performing custom work.
To view the X Stream Definitions go to X Stream > Definitions.
Field Name | Description |
|---|---|
ConfigType | Type of X Stream Export being configured. This value must be unique. |
ConfigDescription | Description of the stored procedure, export or plugin. |
ExportType | Type of export. Available based on pre-configured X Stream Exports. |
UpdatedWhen | Date the last time the definition was loaded or modified. |
UpdatedBy | Username of who loaded definition or made a modification. |
Notes | From Notes field in the definition. |
PluginExportType | Specific to plugins and integrations and if ExportType specified "Plugin". |
ActiveSchedules | The number of schedules that are active in the X Stream definition. |
NumSchedules | The Number of schedules created for the X Stream definition. |
The X Stream Definitions grid will update whenever the user presses the "Apply" button or deletes a definition.
X Stream Definition Form
Double-clicking on a definition will open the X Stream Definition form. It can be broken into 3 sections:
Quick Tip: You can right-click and select Open to open the X Stream Definition form.
Definition type information
See above for more information.
Key / Value pairs information
Where specific values for X Stream Export are configured. They vary depending on integration, stored procedure, and export type.
It is recommended that only CXT Software technical staff configure this section.
Run schedule
The run schedule determines the next day/time that the processes run.
Click "Add Schedule" to create a new entry or double-click an existing entry open/edit the current run schedule.
Click "Run Definition" to execute the definition now instead of the specified schedule(s) to run as configured.
Click "Refresh Schedule" to manually refresh the schedule and show updated results without having to close and reopen the form.
See Recurrent Tasks for more information.
Recurrence Task Schedules
The Recurrent Tasks form is where you can set up the time for the processes to run, when it ran last, and any errors.
Field Name | Description |
|---|---|
Recurrence Pattern | Schedule that X Stream Export uses. This can be set to:
|
Depending on the "Recurrence Pattern:"
| The frequency of the "Recurrence Pattern". Example For Daily:
|
Occur at | Time of day on which X Stream Export runs. |
Select "Active" or "Inactive" |
|
Run Times | |
Last ran at | Date and time on which X Stream Export last ran. |
Next run time | The next date and time on which X Stream Export will run. |
Error message | Error message from the last time X Stream Export ran. Quick Tip: This area will not contain the error message box if no errors were reported during the last execution. |