A parameter can be used to store a value that differs between deployments but is fixed for all cases of a deployed process.
The value is set when you configure the process. For example, if you have a process for approving expense reports, you could define a parameter for the approver’s email address that is set at deployment.
The value can also be changed after deployment:
- In versions 7.0.x, if you are using the Enterprise or the Performance edition
- In versions 7.1.0 and above, if you are using the Enterprise, Performance or Efficiency edition
You can define a parameter for a pool or for a lane. A parameter can be of type text, Boolean, integer, or double.
To define a parameter:
Open the process diagram and select the pool or lane.
In the Data tab, go to the Parameters pane. A table of the parameters already define is displayed.
Click Add, enter the parameter name, choose the type from the drop-down list, and optionally add a description of the parameter.
To modify a parameter (for example to change its type), click on the existing type on in the table of parameters and choose the new type from the drop-down list.
To remove a parameter, select it in the table of parameters and click Remove.
Parameter values are set in Bonita Studio when the process is configured (see the process configuration overview for other details of how to configure a process).
To set a parameter value:
Open the process diagram in Bonita Studio.
Choose an environment from Configure menu in the cool bar.
Click Parameters in the left-hand menu of the configuration wizard. A table of process parameters and their current values is displayed.
Select the table cell for the parameter value you want to set or modify, and enter the new value.
When all the parameters values have been set, click Finish.
You can export the parameter values to a file by clicking Export parameters as file…. The default file name is process_name_Parameters.properties. You can also set parameter values by importing a parameter.properties file. The values in the file are used to set the values of the corresponding parameters. Note that importing a parameters.properties file does not create parameters in the process, just sets the values of those that exist if they are present in the file.
When you build a process for deployment (see Import and export a process), the .bar archive that is created also contains a parameters.properties file.
You can edit a parameters.properties file to change the value of a parameter before importing it into Bonita Studio or before deploying the .bar. You can also edit the file after process deployment, but this is not recommended if the process is running. If you need to change a parameter value for a process that is in production, update the process configuration in Bonita Portal).
From 7.x, to use parameters in forms, you need to retrieve them using the REST API.