IncPermanentResponse

Prev Next

Description

Class name: com.ebd.hub.datawizard.util.IncPermanentResponse

Configuration: Done directly with a string in field "Additional parameters".

This class can alter one or several permanent values. It is able to increment permanent values (e.g. interchange numbers) only if a (preceding) Response was successful. By using appropriate dependencies of the Responses, it can be achieved that the class is only executed in the case of successful data transfer.

To do so, the field "Additional parameters" expects a string (e.g. by using a variable) containing a list of commands, separated by a | (pipe). Empty commands will be ignored without producing an error. An error might be produced if the previous value of a permanent value has not been an integer value. If a permanent value has not existed before, it will be created with the value 0 and incremented. If Custom in phase 6 of the logging configuration is on, every altered value of a permanent value will be shown in the message log.

Note: Profiles, that use this class should set checkbox "Profile is a singleton".

Parameters

Each command consists of 1 to 4 tokens, separated by semicolon, with the following syntax:

<permanentName>;<global>;<stepSize>;<ignoreError>

Parameter

Description

permanentName

Name of the permanent value, which should be incremented. Default: default.

global

Allows other profiles to access the permanent value if "true" (so profile-wide or system-wide permanent value). Default: "false".

stepSize

Integer value (positive or negative) to be added. Default: "1".

ignoreError

If the keyword "ignore" is set, an occurring error will be ignored. The error will be written into the message log, but the Response will not terminate with an error. Subsequent commands will be executed. Default: The flag is not set.

Example

DOCNUM and DOCNUM;false;1 are equivalent. Both commands increment the permanent value DOCNUM by 1 (only for this profile).