Output parameters are variables that contain the computed data to be returned by an action, process or process flow element.

How to Add an Output Parameter To an Action, Process, or Process Flow

  1. Right-click on the action (Data layer), process or process activity (Processes layer) in the eSpace tree and select Add Output Parameter;

  2. Define its properties. Learn more about the output parameter properties.

How to Access an Output Parameter

In an Action

In the expressions of the caller flow that invokes the action, you can access the output parameters in one of the following ways:

See how to execute an action in an action flow.

In case the action is a User Function, invoke it, in the expressions, in one of the following ways:

Learn how to Use User Functions.

In a Process

In the expressions of the caller flow that invokes the process, you can access the output parameters in one of the following ways:

See more about execute process tool and output parameters in a process flow.

In the expressions of the process itself, you can access the output parameters values in one of the following ways:

In a Process Flow

In the expressions of the caller flow that invokes the process element, you can access the output parameters in one of the following ways:

See more about process elements and output parameters in a process flow.

In the expressions of the process element itself, you can access the output parameters values in one of the following ways:

How to Delete an Output Parameter

To delete an output parameter, right-click it in the eSpace tree and select the option Delete.

Output Parameter Properties

Property

Description

Optionality

Default value

Obs.

Name

Name of the Parameter.

Mandatory

 

See rules for naming elements.

Description

Free text that describes the action or process parameter. You can edit the text by directly typing it in the property or in the description editor which opens by clicking

Optional

 

Useful for documentation purposes.

The maximum size of this property is 2000 characters.

Data Type

List of all the data types supported by Service Studio. In this list you'll also find the Identifiers of all the entities of the Space.

Mandatory

Text

See list of possible data types.

Is Close Activity Input

When designing a process activity, this property indicates if its output parameter is also used as an input parameter of its Close<Activity> extended action. The options are:

  • 'Yes, Mandatory': The output parameter is a mandatory input parameter of the Close<Activity> extended action;
  • 'Yes, Optional': The output parameter is an optional input parameter of the Close<Activity> extended action;
  • 'No': The output parameter is not an input parameter of the Close<Activity> extended action.

NA

Yes, Mandatory

This property is only available when specifying an output parameter for a Human Activity or a Wait process activities.

 

Learn more About Processes, Process Activities, and Process Activities Extended Actions.

Is Start Activity Input

When designing a process activity, this property indicates if its output parameter is also used as an input parameter of its Start<Activity> extended action. The options are:

  • 'Yes, Mandatory': The output parameter is a mandatory input parameter of the Start<Activity> extended action;
  • 'Yes, Optional': The output parameter is an optional input parameter of the Start<Activity> extended action;
  • 'No': The output parameter is not an input parameter of the Start<Activity> extended action.

NA

Yes, Mandatory

This property is only available when specifying an output parameter for a Conditional Start process activity.

 

Learn more About Processes, Process Activities, and Process Activities Extended Actions.

Record Definition

List of entities and structures created in the eSpace. You can type the name of the entity or structure, use the Record Editor or select one of the entities and structures displayed.

Optional

 

Mandatory only when the property Data Type is a Record or a Record List.

Advanced Properties

The following properties are only visible for consumed REST API and Web Services.

REST API Properties

Properties for an output parameter of consumed REST APIs.

Property

Description

Optionality

Default value

Obs.

Original Name

The name of the output parameter. Set it with the name you expect to receive in the response.

 

 

If not set, the value in the Name property is used.

Receive In

Indicates where the output parameter value is placed in the response:

  • Header: the output parameter and its value are received in the header of the request;
  • Body: the output parameter and its value are received in the body of the request.

Learn more About REST API Method Parameters

Mandatory

 

 

Default Value

Value for the output parameter if it has no value set.

N/A

 

Read-only.

SOAP Properties

Properties for an output parameter of consumed SOAP Web Services.

Property

Description

Optionality

Default value

Obs.

Original Name

The name of the output parameter.

N/A

 

Read-only.

Default Value

Value for the output parameter if it has no value set.

Optional

 

The default value can be a literal or one of the following built-in functions:

NullDate(), NullIdentifier(), NullObject(), NullTextIdentifier(), CurrDate(), CurrTime(), CurrDateTime() or NewLine().

Original Description

The description of the output parameter.

N/A

 

Read-only.

Min. Occurrences

The output parameter is optional if this property has 0 (zero) value.

N/A

 

Read-only.

Max. Occurrences

Indicates the number of values that can be received in the output parameter. When set with unbounded there is no limit.

N/A

 

Read-only.

Nillable

Indicates whether the output parameter allows nil values.

N/A

 

Read-only.

See Also

About Variables | Expose an Action as a User Function | Use User Functions