User Defined Storage (Magic xpi 4.13)
Magic xpi's User Defined Storage (UDS) lets you define multi-dimensional storage tables (arrays). You can use these definitions in your integration flows to store and retrieve multi-instance data types.
UDS data is stored in the memory, and is therefore available to the current running flow only. However, you can receive the UDS data as a BLOB to enable you to use it at a later stage. First you define the UDS models in the UDS Repository. You can then use them in flows by defining flow variables based on the UDS models.
To use the UDS functionality:
-
In the Repositories section of the Solution Explorer, double-click on UDS to open the UDS Repository. Alternatively, you can open the UDS Repository by pressing SHIFT+F10.
-
The UDS Repository is divided into two halves. The left pane contains the following properties:
|
|
|
|
Name
|
The name that you define for a specific UDS model. For example, Customer. The name can contain up to 30 characters. The name cannot not contain any of the following characters: # - & \ / < > { } [ ] ( ) , ; " %, a space or three question marks (???).
|
|
Description
|
A description of the UDS model, as defined by you. You can include information designed to help you identify a particular UDS model, or you can enter a short description of the UDS model's function.
|
-
The right pane is the Fields table. These fields define the arrays belonging to the UDS model that you just added in the left pane. It contains the following properties:
|
|
|
|
Name
|
The name of the property. For example, CustomerName. The name can contain up to 30 characters.
|
|
Type
|
Select one of the following types from the drop-down menu:
-
Alpha
-
BLOB
-
Date
-
Logical
-
Numeric
-
Time
For example, you would select Alpha to correspond with the CustomerName.
|
| You cannot add more than one BLOB field to each UDS entry. |
|
|
Length
|
The maximum length of the field.
|
|
Index
|
This lets you sort the UDS according to a specific field. For example, you can decide to sort the records based on the CustomerName entered in the Name column.
|
|
Default Value
|
Enter a default value here. For example, you could enter a specific customer name or a specific order date.
|
| This field accepts explicit values only. Functions, expressions, variables, and logical names are not allowed. If the entered value is not explicit, the Checker will return an error. |
|
-
Each pane has its own Add and Delete buttons. These are used for adding and deleting UDS models, and their fields, from the UDS Repository.
-
When you have finished entering your required UDS models, click OK to save your entries and to close the UDS Repository. Alternatively, you can click Cancel to exit the UDS Repository without saving any new entries.
|
|
-
Once you define UDS models in the UDS Repository, they will be added to the list of the flow variable types (in the Variable repository's Type column).
-
UDS variables can only be defined as flow variables.
-
You cannot add duplicate names to the UDS Repository, and the name field cannot be left empty.
-
Before deleting an entry, you should make sure that it is not used in other places in your project. You can do this by running the Find Reference utility.
-
UDS variables are automatically given the letter U as a prefix. Since version: 4.5
-
If an invalid entry is used, Magic xpi displays an error icon  . A tooltip describes the error. Since version: 4.5
|
Using the UDS in a Flow
UDS and the Data Mapper
UDS and the Flow Data Utility
UDS Functions
UDS Properties
UDS Table – Debugger
