AlgorithmMacroModuleExample

MacroModule

genre	Examples
author	Christian Kanthak
package	FMEstable/ReleaseMeVis
definition	AlgorithmMacroModuleExample.def
keywords	algorithm, macro, module

Windows

Default Panel

Parameter Fields

Field Index

[]: Trigger	Update: Trigger
Clear: Trigger
Has Valid Output: Bool
Input string value: String
On Input Change Behavior: Enum
Reverted string value: String
Status Code: Enum
Status Message: String

Visible Fields

Update

name: update, type: Trigger

Initiates update of all output field values.

Clear

name: clear, type: Trigger

Clears all output field values to a clean initial state.

On Input Change Behavior

name: onInputChangeBehavior, type: Enum, default: Update, deprecated name: shouldUpdateAutomatically,shouldAutoUpdate

Declares how the module should react if a value of an input field changes.

Values:

Title	Name	Deprecated Name
​Update	​Update	​TRUE
​Clear	​Clear	​FALSE

[]

name: updateDone, type: Trigger, persistent: no

Notifies that an update was performed (Check status interface fields to identify success or failure).

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no

Indicates validity of output field values (success of computation).

Status Code

name: statusCode, type: Enum, persistent: no

Reflects module’s status (successful or failed computations) as one of some predefined enumeration values.

Values:

Title	Name
​Ok	​Ok
​Invalid input object	​Invalid input object
​Invalid input parameter	​Invalid input parameter
​Internal error	​Internal error

Status Message

name: statusMessage, type: String, persistent: no

Gives additional, detailed information about status code as human-readable message.

Input string value

name: inString, type: String

The input string.

Reverted string value

name: outString, type: String, persistent: no

The output string.