Job Input Parameters
In FlowForce Server, job input parameters are similar to function arguments in a programming language. Parameters can be of various types: e.g., file and directory references, text, numbers, Boolean values, and others.
Under certain conditions, job input parameters become automatically available on the configuration page of your job. For example, when you add a file system or HTTP trigger to your job, the triggerfile input parameter is added automatically. You can use the triggerfile in a step function, for example, to upload this file to an FTP server. For an example, see the system/ftp/store function.
Fields of a job input parameter
The fields of a job input 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 job input parameters.
Add a parameter. | |
Delete a parameter | |
Duplicate a parameter. | |
Move a parameter up or down. | |
Undo the previous delete action. |