BeginSub

Description (v2.2.0)

INFO Retrieve named parameters in subcallflow
INFO Named parameters: [namedParameters]
INFO Mandatory parameters: [mandatoryParameters]

Release notes

Show release notes
Version 2.2.0 - Early deployment
  • Bugfix: Compatibility with newer Gosub (M25237)(TS-160)
  • Dependency:
    • Communication Server Module v2.0.0+
    • GoSub Action v2.2.0+

Version 1.0.0 - Early deployment
  • Feature: Process named parameters in subcallflow (M11106)
  • Dependency:
    • Communication Server Module v2.0.0+
    • GoSub Action v2.0.0+

Target Audience

This is a technical action meant to be used only by experimented service creators, not the end customer.

Action parameters

  • Mandatory params: Mandatory parameters needed for the SubCallflow. These variables are available in the SubCallflow with the prefix sub.
  • Local vars: Define the variables used in the SubCallflow These variables will be prefixed with sub.

The BeginSub is the first action of a SubCallflow called by a GoSub action. The mandatory parameters are compared to the input parameters defined in the GoSub action >= 2.0.0. If one mandatory parameter is not found in the input parameters, the subcallflows will fail and the ${missing_parameter} variable is set. This mechanism ensures compatibility between subcallflow and its parent callflow.

All the variables used in a SubCallflow must be declared in the BeginSub action as an input variable or as a local variable.

Example of use

1st case:

  1. Parent callflow: SetVar Action
    • TestVar1=value1,TestVar2=value2,TestVar3=value3,TestVar4=value4
  2. Parent callflow: GoSub Action
    • input parameters=TestVar1&TestVar2&TestVar3&TestVar4
  3. First action in the subcallflow: BeginSub Action
    • mandatory parameters=TestVar1&TestVar3
    • local variables=TestLocalVar1&TestLocalVar2

choice-yes The variables definition is correct and local variables "subTestVar1" and "subTestVar3" are set with values "value1" and "value3" respectively. The variables TestLocalVar1 and TestLocalVar2 can be changed in the SubCallflow without side effect on the other callflow.

2nd case:

  1. Parent callflow: SetVar Action
    • TestVar1=value1,TestVar2=value2,TestVar3=value3,TestVar4=value4
  2. Parent callflow: GoSub Action
    • input parameters=TestVar1&TestVar2&TestVar3&TestVar4
  3. First action in the subcallflow: BeginSub Action
    • mandatory parameters=TestVar1&TestVar5
    • local variables=TestLocalVar1&TestLocalVar2

choice-no The variables definition is not correct and the "missing_parameter" variable is set with the value "TestVar5".

Limitation

warning The BeginSub action must be used in conjuction with the GoSub action >= 2.0.0.

Copyright © Escaux SA