List of methods supported in macro

We can execute JavaScript code from within our flow, by using the Macro element.

Here are the list of methods supported by Flow macro.

Naming schemes

When getting or updating a value, the name of the value (optionally including a property name) will be expected in the following formats:

{![My Value]}
{![My Object].[Property Name]}

Getting values

state.getArray(valueName) – Returns a StateObjectData array containing the objectdata for a list value
state.getBooleanValue(valueName) – Returns a JavaScript boolean value
state.getContentValue(valueName) – Returns a JavaScript string value
state.getDateTimeValue(valueName) – Returns a JavaScript Date value
state.getNumberValue(valueName) – Returns a JavaScript number value
state.getObject(valueName) – Returns a StateObjectData object containing the objectdata for an object
state.getPasswordValue(valueName) – Returns a JavaScript string value
state.getStringValue(valueName) – Returns a JavaScript string value
state.getValue(valueName) – Returns a JavaScript string value regardless of ContentType. Only applicable to scalar ContentTypes: string, number, boolean, content, password, datetime

Updating values

state.setBooleanValue(valueName, boolean)
state.setContentValue(valueName, string)
state.setDateTimeValue(valueName, datetime)
state.setNumberValue(valueName, number)
state.setPasswordValue(valueName, string)
state.setStringValue(valueName, string)
state.setValue(valueName, string)

When updating an object or a list (array) value, we will need to pass in StateObjectData. This can be fetched via a state.getArray or state.getObject call.

We can also create new objects, like this:

state.setObject(valueName, StateObjectData) – StateObjectData is a single object either created with state.createObject or fetched from state.getObject
state.setArray(valueName, StateObjectData[]) – StateObjectData[] is an array either created by one more state.createObject objects or fetched from state.getArray
state.createObject(typeElementId) – Returns a newly created StateObjectData object of the type specified via the typeElementId

Getting property values

The StateObjectData objects support the following methods for querying their properties:

getPropertyValue(typePropertyId)
getPropertyStringValue(typePropertyId)
getPropertyContentValue(typePropertyId)
getPropertyPasswordValue(typePropertyId)
getPropertyNumberValue(typePropertyId)
getPropertyDateTimeValue(typePropertyId)
getPropertyBooleanValue(typePropertyId)
getPropertyArray(typePropertyId)
getPropertyObject(typePropertyId)

Setting property values

The StateObjectData objects support the following methods for updating property values:

setPropertyValue(typePropertyId, string)
setPropertyStringValue(typePropertyId, string)
setPropertyContentValue(typePropertyId, string)
setPropertyPasswordValue(typePropertyId, string)
setPropertyNumberValue(typePropertyId, number)
setPropertyDateTimeValue(typePropertyId, Date)
setPropertyBooleanValue(typePropertyId, boolean)
setPropertyArray(typePropertyId, StateObjectData[])
setPropertyObject(typePropertyId, StateObjectData)

Null checking objects and lists

var list = state.getArray('!{[My List Value]}')[0];
if (list !== null && list.length > 0 && list[0] !== null) {
    ...
}

var list = state.getArray('!{[My List Value]}')[0];

if (list !== null && list.length > 0 && list[0] !== null) {

...

}

var item = state.getObject('!{[My Object Value]}');
if (item !== null) {
    ...
}

var item = state.getObject('!{[My Object Value]}');

if (item !== null) {

...

}

You may also want to see:

Check out the glossary for a definition of terms and key concepts that appear in the Boomi Flow website, drawing tool, technical documentation, blogs, and marketing communications.

If you need to take a closer look, click on the images to enlarge them. Have a question? Click the Help button on the bottom right-hand corner of this page to ask.