Versions Compared

Old Version 8

changes.mady.by.user Michelle Cabaya

Saved on

compared with

New Version Current

changes.mady.by.user Michelle Cabaya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

Note

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 Software when building an integration or performing custom work.

To view the X Stream Definitions go to X Stream > Definitions.Image Removed

...

Anchor
DefinitionTypeInfo
DefinitionTypeInfo

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.

Anchor
definitionForm
definitionForm
X Stream Definition Form

Double-clicking on a definition will open the X Stream Definition form. It can be broken into 3 sections:

title
Tip

Quick Tip

: You can right-click and select Open to open the X Stream Definition form.

...

  1. Definition type information 

    See above for more information.

  2. Key / Value pairs information

    Where specific 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.

  3. 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.

Anchor
recurrentTasks
recurrentTasks
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.Image Removed

...

Field Name

Description

Recurrence Pattern

Schedule that X Stream Export uses. This can be set to:

  • Daily

  • Weekly

  • Monthly

  • Minute Interval

  • Second Interval

Depending on the "Recurrence Pattern:"

Daily 

  • Daily        

  • Weekly

  • Monthly

  • Minute Interval

  • Second Interval

The frequency of the "Recurrence Pattern".

Example

For Daily:

  • Every _ Days

  • Every weekday

Occur at

Time of day on which X Stream Export runs. 

Select "Active" or "Inactive"

  • Active: Schedule is active and will run as scheduled.

  • Inactive: The schedule will never run regardless of the "occur at" or "next run time" settings.

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.

Tip

Quick Tip: This area will not contain the error message box if no errors were reported during the last execution.

Copying an X Stream Definition

You can copy a definition to create a new configuration.

  1. Go to X Stream > Definitions.

  2. Right-click on the definition you would like to copy.

  3. Select Copy. 

    Image RemovedImage Added

  4. Enter the new configuration type and description. The Configuration Type must be a unique value.

    Image RemovedImage Added

  5. Optional: Enable Include Recurrence Schedule.

  6. Click OK.

How to Add a New X Stream Definition

  1. Go to X Stream > Definitions.

  2. Click the New button in the toolbar. 

    Image RemovedImage Added

  3. Fill out the Definition Form. See X Stream Definition Form above for more information. You can also import a definition. Go to step 3 in How to Import an X Stream Definition below.

  4. Click OK.

Anchor
import
import
How to Import an X Stream Definition

  1. Go to X Stream > Definitions.

  2. Click the New button in the toolbar.

  3. In the top menu click Edit > Import Definition. 

    Image RemovedImage Added

  4. Select the XML file you would like to import.

  5. Click OK.

How to Export an X Stream Definition

  1. Go to X Stream > Definitions.

  2. Open the definition you would like to export by double-clicking on the definition or right-clicking on the definition and selecting Open.

  3. In the top menu click Edit > Delete Definition and Close. 

    Image RemovedImage Added

  4. Enter the file name you would like to save the XML file as.

  5. Click Save.

How to Delete an X Stream Definition

  1. Go to X Stream > Definitions.

  2. Open the definition you would like to delete by double-clicking on the definition or right-clicking on the definition and selecting Open.

  3. In the top menu click Edit > Delete Definition and Close. 

    Image RemovedImage Added

  4. Enter "DELETE" and click OK.

    Image RemovedImage Added

How to Enable/Disable an X Stream Definition

  1. Go to X Stream > Definitions.

  2. Open the definition you would like to enable or disable by double-clicking on the definition or right-clicking on the definition and selecting Open.

  3. In the top menu click Edit > Enable Definition or Edit > Disable Definition. 

    Image RemovedImage RemovedImage AddedImage Added
Note

Disabling a definition also disables any recurrence schedules configured on the definition.

Page Properties
hiddentrue

How to Test a Plugin

A Plugin Self Test is used to have the plugin run operational tests such as check connections or check key/value pairs. This allows you to test the plugin and find any improper configurations.

...

Image Added
Note

Not all plugins support the Self Test. You will get the following message if the plugin you are trying to test does not have the function built in.

Image Modified

  1. Go to X Stream > Definitions.

  2. Open the definition you would like to test by double-clicking on the definition or right-clicking on the definition and selecting Open.

  3. In the top menu click Edit > Test Plugin. 

...

  1. Image Added