Extends

• ArchBaseActionWithOutputsFoundNotFoundFailure

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionDataTableLookup'.

readonly dataTableOutputsFailure :ArchNamedValueList

The contents of this named value list come from the selected data table's reported failure outputs schema.

readonly dataTableOutputsFound :ArchNamedValueList

The contents of this named value list come from the selected data table's reported success output schema. The name value pair items in this list will let you assign variables that will be populated with output values from the data table if execution is successful. Note that this named value list may be undefined even if a valid data table is specified on the action. If no data table is specified on this action, this will return undefined.

readonly isArchActionDataTableLookup :boolean

Returns true indicating that this is an ArchActionDataTableLookup instance.

readonly lookupValue :ArchValueString

This is the value you wish to look up at runtime and will be the key field of the data table inputs schema. Please note that this value cannot be assigned a value until the data table is configured on this action using the ArchActionDataTableLookup#setDataTableByIdAsync method. As such, you will typically assign the value to look up in the callback function passed in to the ArchActionDataTableLookup#setDataTableByIdAsync method.

readonly outputFound :ArchActionOutput

The found output for this action

Inherited From:

• ArchBaseActionWithOutputsFoundNotFoundFailure#outputFound

readonly outputNotFound :ArchActionOutput

The not found output for this action

Inherited From:

• ArchBaseActionWithOutputsFoundNotFoundFailure#outputNotFound

Methods

setDataTableByIdAsync(datatableId, callbackFunctionopt) → {Promise.<ArchActionDataTableLookup>}

This sets the data table that will be used for the lookup by the data table identifier.

Parameters:

Name	Type	Attributes	Description
datatableId	string		the identifier of the Data Table.
callbackFunction	callbackArchActionDataTableLookup	<optional>	a callback function to call if the data table is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect data table lookup action instance.

Returns:

Promise.<ArchActionDataTableLookup>

setDataTableByNameAsync(dataTableName, callbackFunctionopt) → {Promise.<ArchActionDataTableLookup>}

This sets the data table that will be used for the lookup by the data table name.

Parameters:

Name	Type	Attributes	Description
dataTableName	string		the name of the Data Table to set.
callbackFunction	function	<optional>	a callback function to call if the Data Table is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect data table lookup action instance.

Returns:

Promise.<ArchActionDataTableLookup>