Project parameters
When you combine multiple Modules into a Project, you can link any Module parameters in these Modules to corresponding Project parameters. With a linked Project parameter, input is requested only once.
When linking a Project parameter to a Module parameter, you can specify which action should be performed at the input moment. This action determines which value should be used by the parameters. You can choose between the following actions:
Link action |
Functionality |
None |
The Project parameter is not linked to any underlying Module parameters. As a result, each Module parameter keeps its own value. |
Set initial value
|
Use this action to set the value of the Project parameter as initial value for the Module parameter that is linked to it. This is the default action when auto-linking parameters. For example, this is useful if multiple Module parameters from different Modules in the Project share the same value (e.g. a specific user name or password). By specifying this value in the Project parameter, the linked Module parameters will all get the same value at the input moment. |
Get final value
|
Use this action to get the value of the Project parameter from the Module parameter that is linked to it after its Module has been executed. This is useful if you want to use this value in the Module parameter of the next Module in the Project before it is executed (through a Set initial value link-action). |
Both
|
Use this action to set the value of the Project parameter as initial value for the Module parameter that is linked to it. After execution of its Module, the Project parameter will then get its value again from the Module parameter that is linked to it. You can then use this parameter value in the next Module of the Project. |
Example
Suppose you have a Run Book (or Project) with multiple Modules for the creation of an Active Directory User, including a Home Folder and a Mailbox.
- The Run Book uses Username as a Run Book parameter. For example, John Smith > smithj.
- The first Module contains some error handling in case jsmith already exits and changes the value of the parameter Username. For example, smithj02.
- The final value needs to be sent back to the Run Book (get final value) and overwrites the Run Book parameter.
- This new initial value (set initial value) will be used in the other Modules.
Configuration
- On the tab Project Parameters > Parameters, you can:
- Create a new Project parameter manually: Click Add. This opens the Add Project Parameter window, which allows you to configure the settings of the Project parameter. See Parameters.
- Create Project parameters automatically: Click AutoCreate. You will also be asked if you also want to link the Project parameters to matching Module parameters automatically.
- View an overview of all Project parameters and edit them: Select a Project parameter and click Edit.
- Change the order in which Project parameters are presented at input moment: Select a Project parameter and use the arrow buttons.
- Delete Project parameters: Select a Project parameter and click Delete.
- Delete Project parameters that are not linked to any Module parameter in the Project: Click Cleanup.
- On the tab Project Parameters > Links, you can:
- Link a Project parameter to one or more Module parameters manually: Select a Module parameter and drag it to a Project parameter. After this, click Action to specify which action should apply to the link.
- Alternatively, you can specify which action should apply to the link by editing the properties of the Project parameter (on the Links tab of the Add Project Parameter window).
- Link all unlinked Module parameters to matching Project parameters automatically: Click AutoLink. This automatically links existing Project parameters to matching Module parameters of the same name and type. If no matching Project parameters exist yet, you will be asked if you also want to create these automatically. AutoLinked Project parameters use the default link action Set initial value.
- View a list of all linked parameters. Linked Module parameters are shown below the Project parameter to which they are linked; unlinked Module parameters are listed separately.
- Create a new Project parameter: Click Add. This opens the Add Project Parameter window, which allows you to configure the settings of the Project parameter.
- Edit existing Project parameters: Select a Project parameter and click Edit.
- Unlink a linked Module parameter: Right-click the linked Module parameter and click Delete. This will only delete the link; not the Module parameter itself. Alternatively, you can delete links by dragging it to Not Linked at the top of the list.
- Link a Project parameter to one or more Module parameters manually: Select a Module parameter and drag it to a Project parameter. After this, click Action to specify which action should apply to the link.
Project and Run Book parameter links: linking parameters of the type List or Multi-select list containing credential parameters is not supported.