Altova FlowForce Server 2023 

Input Parameters

Home Prev Top Next

In FlowForce Server, input parameters are similar to function arguments in a programming language. Input parameters can be of various types (for example, file or directory references, text, numbers, Boolean values, and others).

 

Note:FlowForce Server automatically adds an input parameter called triggerfile to jobs that use file system or HTTP triggers (see Triggers). The triggerfile parameter contains the name of the file that activated the trigger and must not be deleted.

 

Under certain conditions, previously set values of function parameters are copied over into parameters of a new function. The parameter value is copied over if the parameter has the same internal name and the same data type in both step functions. Besides this condition, one or more of the following conditions must also be true:

 

The parameter is an expression.

The parameter has logging enabled.

The parameter is an inline credential with a user name and password.

 

The parameter value is not copied over if:

 

the parameter is locked (mapping with more than one parameter with the same name);

the parameter value starts with altova://packagedfile/ (it will not work with any other function except the one it was deployed with).

 

To revert to the default value of an optional parameter, use the Set to button and choose <Default value>. For mandatory parameters, the value has to be removed manually.

 

As soon as a function is selected and its parameters are retrieved, they are cached for this job configuration page. Every time this function is selected again (for any new step, existing step, or the same step), its parameters are no more retrieved; instead, the cached parameters are used.

 

Fields of a parameter

The fields of a parameter are described in the table below.

 

Name

Mandatory field. Specifies the name of an input parameter. You may need to refer to this parameter later from any of the job's execution steps. Therefore, it is recommended to use a descriptive name.

 

The input parameter name must start with a letter and may contain only the following characters: a-z, A-Z, 0-9, and '_'.

Type

Mandatory field. Specifies the data type of the input parameter, which can be one of the following:

 

string

string as file

string as directory

string as file or directory

stream

number

boolean

credential

certificate

result

AS2 partner (Advanced Edition)

AS2 MDN (Advanced Edition)

SFTP connection (Advanced Edition)

Default

Optional field. Specifies the default value of the parameter. This value will be used if no value is specified by the job caller at runtime.

Description

Optional field. Describes the purpose of the parameter. This description becomes available as a tooltip next to the parameter name when you use the current job as an execution step of another job.

 

Buttons

Use the following buttons to manage parameters.

 

add

Add a parameter.

delete

Delete a parameter

icon_duplicate

Duplicate a parameter.

up_arrowdown_arrow

Move a parameter up or down.

icon_undo

Undo the previous delete action.

 

© 2016-2022 Altova GmbH