This project has moved. For the latest updates, please go here.

Defining flow rules

Introduction

Once your transforms have been created in the editor you can start using them in your advanced flow rules. UMARE supports transforms on join, import, and export flows, wherever the sync engine allows this. Note you cannot use UMARE on the FIM MA, as FIM does not allow you to specify a rules extension.

While the transforms themselves are defined in the UMARE editor, the name of the advanced flow rule specified in the sync engine is where we specify how the transform should be used. This allows a transform to be defined once and used multiple times across import, export, and join flows.

Basic Attribute Flows

Import Attribute Flows

Import attribute flows are defined using the operator >>. The flow rule name must be in the following format
CSAttribute>>TransformID>>MVAttribute

Where CSAttribute is the source connector space attribute, TransformID is the ID of the transform given in the editor, and MVAttribute is the target metaverse attribute.
import-flow-rule.png

Export Attribute Flows

Export attribute flows are defined using the operator <<. The flow rule name must be in the format
CSAttribute<<TransformID<<MVAttribute

Where MVAttribute is the source metaverse attribute, TransformID is the ID of the transform given in the editor, and CSAttribute is the target connector space attribute.
export-flow-rule.png

Join Flows

Join flows allow you to transform a connector space attribute for use in a join comparison. Join flow use the import operator >>, but do not specify a target attribute. The flow rule name must be in the format
CSAttribute>>TransformID

Where CSAttribute is the source connector space attribute, and TransformID is the ID of the transform given in the editor. There is no target attribute for a join flow.

Advanced Attribute Flows

UMARE supports some advanced operations to allow more complex flow rules.

Transform Chaining

Multiple transforms can be used in a flow rule. They are chained together, passing the output of one transform to the input of another.
chained-flow-rule.png

Import flows

CSAttribute>>Transform1>>Transform2>>Transform3>>MVAttribute

The CSAttribute value is passed through Transform1, then Transform2, and finally through Transform3 before being stored in the MVAttribute.

Export flows

Export attribute flows use the export flow operator as shown below
CSAttribute<<Transform3<<Transform2<<Transform1<<MVAttribute

The MVAttribute value is passed through Transform1, then Transform2, and finally through Transform3 before being stored in the CSAttribute.

Combining Multiple Attributes

UMARE allows multiple source attributes to be used as an import to either the import or export flow rules. Note that the sync engine does not allow multiple target values to be specified in an advanced flow rule, only multiple source attributes.

Import flow

CSAttribute1+CSAttribute2>>TransformID>>MVAttribute

The values of CSAttribute1 and CSAttribute2 and combined and passed together to the transform specified by the TransformID, and the resulting value is stored in the MVAttribute

Export flow

CSAttribute<<TransformID<<MVAttribute1+MVAttribute2

The values of MVAttribute1 and MVAttribute2 are combined and passed together to the transform specified by TransformID, and the resulting value is stored in the CSAttribute
composite-flow-rule.png

Last edited Nov 24, 2015 at 9:21 AM by ryannewington, version 4