Show TOC

Function documentationSwitch Locate this document in the navigation structure

 

This action is used to perform a particular task, which depends on the provided input. An unlimited number of inputs, each with their own output paths, can be configured. Only the matched output path is executed. You can define a default path to execute if no match is found.

Features

The properties for this action are listed in the following table:

Property

Data Type

Access

Use

MatchValue 1 to MatchValue N

String

In and out

Stores values that are matched to the InputValue property. The number of MatchValuelinks depends on the number of inputs specified on the configuration screen. For example, if the Switch action is configured with three inputs, there are three MatchValue inputs, MatchValue1 through MatchValue3. Each MatchValue statement must be configured using the Link Editorscreen.

InputValue

Integer

In and out

Determines which MatchValue path is taken. Set this property through the Link Editorscreen. The path of the MatchValue property with the same value as the InputValue property is followed. If the Input Valuedoes not match any of the MatchValues, the Default path is taken. The Else path is taken after the Switchaction has completed, regardless of the output.

MatchCount

Integer

In and out

The number of MatchValue links specified for the Switch action.

SelectedMatchIndex

Integer

Out

Returns the index of the MatchValue property. For example, if the InputValue matches MatchValue1, 1is returned. If the InputValue matches MatchValue2, 2 is returned, and so on. If no match is found, the index of the Default path which is equal to the number of inputs plus one is returned.

Success

Boolean

In and out

Indicates whether the action succeeded or failed. If it failed, errors are displayed in the server trace log.