Store value as variable

Value resolver – Abstract

Purpose: Assigns the input value of the variable addressed via the Variable Name parameter in the execution context.

Tooltip

• Usage: The input value is assigned to the variable addressed via the Variable Name parameter in the execution context of the value resolver. This is either overwritten or newly created.

• Parameter: The single Variable Name parameter defines the name of the variable for value assignment by static text. It is only formally optional. Without specifications the value resolver is effectively ineffective.

• Note: Assignments to a variable whose name is determined 'dynamically' by the value resolver at runtime are only possible by write access via the Variable value resolver in event actions (e.g. Set value).

The Store value as variable value resolver assigns the input value to the variable addressed via the optional Variable Name parameter in the execution context.

• If the Variable Name parameter does not contain any information, then the input value will not be saved.

• If the addressed variable is already in use in the execution context, it will be overwritten.

• If the addressed variable does not yet exist in the execution context, it is added.

In each case, the input value is returned unchanged.

In the context of a value resolution chain, any intermediate result can be literally stored 'at random' in order to be able to access it in the further course or to examine the value in the context of Tests.

While in Event handling or in a Client Workflow the value of a variable can alternatively be assigned by an event action (e.g. by Set value with a Variable value resolver as target), the Store value as variable value resolver e.g. in Association criteria represents the only possibility to store a value directly in the execution context.

Configuration

►NOTE◄ If the Variable Name is not determined statically in the configuration but rather at runtime, only an assignment via event action (e.g. with the Set value value resolver) can be considered. If the target of the assignment is determined by the Variable value resolver, the name of the variable can be determined via value resolver.

Example

Simple use case: Save intermediate result in a multilevel calculation

Based on numerical values for 'quantity' (quantity), 'unit price' (unitPrice) and an applicable 'tax rate' (taxRate) specified in percent, in addition to the resulting 'grossAmount' (grossAmount), the 'netAmount' (netAmount) should also be calculated as follows:

• netAmount = quantity * unitPrice

• grossAmount = netAmount * (1+taxRate/100)

The following configuration demonstrates how the 'net amount' can be stored as an intermediate result in a value assignment for the 'gross amount' via the Store value as variable value resolver.

The subsequent use of the netAmount and grossAmount variables is not discussed here.

Configuration:

►NOTE◄ The concept demonstrated here can also be applied in a multi-step manner in the same value resolution chain to transfer a series of intermediate results into variables.

More complex use case: 'Validating rule' occupies variables for the 'Actions on passed rule'

In an event handling, the Validating rule determines whether the company to which the logged-in user account (according to User of session) refers as 'owner' (ownerId) owns its company account itself or not.

Actions should only be executed if this is not the case. Among other things, a notification then indicates ownership.

Runtime example:

Configuration:

The Validating rule of an event handler shown above defines an Entity property rule that compares the 'owner' (ownerId) field for the User of session with the same field in the company account referenced there as 'owner':

• On the left side of the comparison, the ID of the company that owns the User of session is determined:

  • The value resolver chain starts with the User of session value resolver, which returns the logged in user account.

  • The concatenated Store value as variable value resolver stores this user account in the me variable.

    ►NOTE◄ The Show alert (Popup) event action in the 'Title' refers to this variable.

  • The concatenated Object property value resolver reads the 'owner' (ownerId) field of the user account that is the User of session.

  • The concatenated Store value as variable value resolver stores the ID of the company account specified as 'owner' in the myOwnerId variable.

    ►NOTE◄ The Variable value resolver at the beginning of the value resolver chain on the right-hand side of the Entity property rule refers to this variable.

• On the right side of the comparison, the ID of the company that owns the company account that owns the User of session is determined.

  • The value resolver chain starts with the myOwnerId variable, where a lookup is performed for the Class 'Company account' (CompanyAccount) (see Variable value resolver).

  • The concatenated Store value as variable value resolver stores the company account looked up via the Variable value resolver in the myOwner variable.

    ►NOTE◄ The Show alert (Popup) event action in the configuration of the 'Message' refers to this variable.

  • The concatenated Object property value resolver reads the 'owner' (ownerId) field of the user account, the company account that owns the User of session.

  • The concatenated Store value as variable value resolver stores the ID of the company account specified as 'owner' in the myOwnersOwnerId variable.

    ►NOTE◄ The Show alert (Popup) event action in the configuration of the 'Message' refers to this variable.

Since the Validating rule is always processed before any Actions on passed rule are executed, in its context the variables addressed via the Store value as variable value resolver are populated as follows: