Documentation › Enterprise parameters
Enterprise parameters: values shared by everyone
An enterprise parameter is a value defined once for the whole organization: a VAT rate, the company name, a contact address… Processes and artifacts can take it as a variable.
What they are for
- Each parameter has a name, a type (text, number, email, date, yes / no, single or multiple choice) and a value.
- Everybody can view the Enterprise parameters page: a search by name and filters by type help to find a parameter.
- Only people who have the right can create, edit or delete a parameter.
Create, edit, delete
- Open the Settings menu, then Enterprise parameters.
- Click New parameter, give a name, choose the type and type the value. For a list, add the options and tick the ones chosen By default.
- Use the pencil to edit a parameter and the bin to delete it. A name can only be used once.
Use them
In the start block of a process or an artifact, Variables tab, add a variable and choose the Application scope, then the parameter you want. Its copy keeps the type and the value of the parameter: it cannot be edited by hand. It is then used like the other variables, for example in conditions, API calls or the {{Name}} placeholder of a document template.
A process instance starts with the value its process copied: changing a parameter later does not change the instances already started. These variables appear on the page of the instance, Parameters tab (click Overview).
When a parameter changes
- In the start block, the variable shows a Modified tag with a button to copy the current value. Refresh all refreshes every variable at once.
- A red dot also appears on the start block of the diagram as long as a copy is out of date.
- When you save or publish, ProcNest asks whether to Refresh and continue or Continue without refreshing.
- If the parameter was deleted, the variable shows Removed and keeps its last value.
- In a process instance, the Parameters tab shows the Modified tag too. People who can work on tasks (Edit my tasks) copy the current value with the refresh button. If the type or the options of the parameter changed, it cannot be copied: start a new instance of an updated process.
Who can do what
- View: View enterprise parameters, given to every role by default.
- Create, edit, delete: Create enterprise parameters, Edit enterprise parameters and Delete enterprise parameters, kept for administrators by default. Users and roles explains how to give them.