Flow Data Service (ODS and Variables) (Magic xpi 3.x)
The Flow Data service is used to control the flow of data between, and within, Magic xpi project flows. You can use this service to work with ODS data, flow variables, environment variables, and user parameter data. For example, you can update the value of a flow variable automatically in a flow by using the Flow Data service. To do this, you use the Update action and choose Flow Variable as the Type. Then select the Update Expression to indicate the data's origination. If you want to update the text associated with a flow variable you should enter the following in the table in the Flow Data Service Configuration dialog box.
The following table describes the type of actions and data that you can control with the Flow Data service.
|
|
|
|
|
Update
|
Update replaces data or adds data to a variable. For example, you can add the contents of a file to a User BLOB or User String. You can also change the value of a flow variable.
|
Note:
|
If you update an ODS in a step and that ODS does not exist, Magic xpi will create an ODS.
|
|
|
Flow Variable
Context Variable
Global Variable
BP Variable
ODS Global
ODS Local
Environment Variable
|
|
Clear
|
Clear deletes data in a variable. For example, you can clear all the contents of a User BLOB or User String or clear the current value of a flow variable.
|
Flow Variable
Context Variable
Global Variable
BP Variable
ODS Global
ODS Local
Environment Variable
|
|
Reset
|
Reset changes the value of a flow variable to the original default value entered when creating the value. This option is used only if you entered a default value when creating the flow variable.
|
Flow Variable
Context Variable
Global Variable
BP Variable
|
|
Delete
|
Delete erases an ODS entry. This erases the data at the User Key level, and that User Key no longer exists.
When you select Clear (see above) the information contained in the ODS entry is erased, however the User Key remains and you can add or change the data at any time.
|
ODS Global
ODS Local
|
|
Insert
|
Insert adds data to an ODS Key Index. An Index is part of an ODS Array, which allows you to enter more multiple data in a single ODS key. The individual data entries for the array are contained in an index.
|
ODS Global
ODS Local
|
|
Note:
|
-
You can use the Flow Data Service to update environment variables. The value is only changed for the duration of the current execution, and is not saved when the Server stops. The value is recognized by all the steps in the same thread that uses the environment variable.
-
Usage of the UDSSet function in the Flow Data service should be updated in a Numeric flow variable (return value of the function) and the Source and Destination variable names should be surrounded with single quotes ( '), for example:
UDSSet( 'F.MyDestinationUDS','F.MySourceUDS','TRUE'LOG,'MyUDSModule1')
|
|
Flow Data Service – Configuration
Flow Data Service – Error Handling
Updating a Date Type Variable
