Versions Compared

Old Version 1

changes.mady.by.user Michelle Cabaya

Saved on

compared with

New Version 2

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.

...

Field NameDescription
ConfigTypeType of X Stream Export being configured. This value must be unique.
ConfigDescriptionDescription of the stored procedure, export or plugin.
ExportTypeType of export. Available based on pre-configured X Stream Exports.
UpdatedWhenDate the last time the definition was loaded or modified.
UpdatedByUsername of who loaded definition or made a modification.
NotesFrom Notes field in the definition.
PluginExportTypeSpecific to plugins and integrations and if ExportType specified "Plugin".
ActiveSchedules


Info

Requires X Dispatch 19.2 or newer.

The number of schedules that are active in the X Stream definition.

NumSchedules


Info

Requires X Dispatch 19.2 or newer.

The Number of schedules created for the X Stream definition.


Info

In X Dispatch 18.0 and newer, 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

...

  1. Definition type information 

    Div

    See above for more information.


  2. Key / Value pairs information

    Div

    Where specific values for X Stream Export are configured. They vary depending on integration, stored procedure, and export type. 

    Note

    It is recommended that only CXT Software technical staff configure this section.



  3. Run schedule 

    Div

    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

...

  1. Go to X Stream > Definitions.

  2. Click the New button in the toolbar. 

    Div


  3. Fill out the Definition Form. See X Stream Definition Form above for more information. 

    Tip
    titleQuick Tip

    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

...

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.


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.

  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. 

    Div



...