Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


GLOSSARY


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL MANUAL VERSIONS

Ignition 8
Ignition 7.9
Ignition 7.8

Deprecated Pages

Skip to end of metadata
Go to start of metadata

This function is used by Ignition's Expression language.

Description

This function is only available in Transaction Group Expression Items and Expression Tags.

Retrieves data from a global variable DatasetName created using the ExecuteQuery function.

Syntax

getDatasetValueByName(datasetName, row, column, fallback)

  • Parameters

string datasetName - The name of the dataset created using the executeQuery function.

int row - The row index.

string column - The name of the column.

Object fallback - A fallback value if the lookup fails.

  • Results

Object - The value at the given row index and column name. They type returned matches the type of the value selected.

Examples

For example, suppose you had a dataset called 'MyResult' with this information in it:

ProductCodeQuantityWeight
BAN_0023803.243
BAN_0101209.928
APL_0001251.287
FWL_2203227.889
getDatasetValueByName("MyResult", 0, "Quantity", -1)  //would return 380
getDatasetValueByName("MyResult", 1, "Weight", -1)  //would return 9.928
getDatasetValueByName("MyResult", 0, "Color", -1) //would return -1 because there is no Color column and it reverts to the fallback value.