Skip to main content Skip to complementary content

Binding

An object that defines how values accesible in the selection app are to be harvested and injected into the data prep phase of the template app at app generation time.

Properties

Name Description Type
templateAppVarName String
selectAppParamType

The different kinds of selection app parameters whose values can be bound to the script of template apps when generating new apps. Note that 'Exclude' is used to specifically prevent fields defined as optional bind parameters in the template app script from being bound (these must either not have the optional quantity constraint specifiers or have a minimum quantity of 0).

One of:
  • Field
  • Variable
  • Property
  • Exclude
String
selectAppParamName

The path (or name) of the selection app field, variable or property to obtain the list of values for this binding.

String
selectionStates

A combination of the letters 'S' and/or 'O' to indicate which values from the selection states 'selected' or 'optional' in the hypercube of the selection app to harvest as bind values to inject into the script of the template app at ODAG request submission time. This is currently only settable in the template app script and not when creating or updating a Link.

String
numericOnly

Set to 'true' to indicate that only numeric values from the select app source parameter should be used. The default value for this property, if left unspecified, is 'false'. This is currently only settable in the template app script and not when creating or updating a Link.

Boolean
range

The lower and upper bound for the permitted number of values that must exist in the selection app's source parameter in order for this binding to be valid (and permit an ODAG Request to be submitted. If this property is not supplied, there is no constraint on either the lower or upper bound. To indicate that an exact number of selections are required, use the same number for both the lower and upper bound.

ValueCountRange
formatting

A property value that describes the formatting of field values in a Binding. This is currently only settable in the template app script and not when creating or updating a Link.

BindFormatting

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!