Configure a Run Book

At Run Books, you can configure and schedule Run Books. Run Books are containers for Jobs. Run Books can contain Modules and Projects plus (optionally) the Agents on which they should be executed. To execute the Tasks in the containers in the Run Book, the Run Book is scheduled as Job for a specific time. By combining Modules and Projects and their Agents in a Run Book, a sequence of actions can be scheduled consecutively on different sets of Agents.


To configure a new Run Book without any prefilled properties:

  1. Select New from Run Books.

When viewing, changing or duplicating the configuration details of an existing Run Book, the same configuration page opens. See also Duplicate a Run Book or Run Book Job.


Properties tab

  • Use the Properties tab to view the name and GUID (globally unique identifier) of the Run Book.
  • The Run Book Name is the name that is displayed in the Run Books overview. When creating a Run Book, it is therefore wise to choose a name that reflects its contents.
  • The Run Book Description is only shown in the list view. In the Description field, you can create hyperlinks (http:// https:// file://) when in edit mode (click edit_mode). The users can directly browse to these hyperlinks from the Management Portal when in read only mode (click read_mode).
  • In the Folder field you can optionally specify in which folder (and subfolder) the Run Book is grouped.

Jobs tab

  • Use the Jobs tab to have an overview of the Jobs in the Run Book. From here, you can add, duplicate, edit and delete one or more Jobs. See also Add a new Run Book Job.
    • To change the order of execution of Jobs in the Run Book, select a Job and use the Arrow buttons. Likewise, use the Arrow buttons to move any separators up or down the list of Jobs.
    • To create sets of Jobs, add a separator to have a visual aid to enhance readability; they do not affect the execution order of Jobs.
  • Conditional: whether (true) or not (false) conditions are applied to this Run Book. Conditions determine whether a Job should be executed, skipped or failed.
  • To view or set conditions on a Job:
    • Click the icon (condition_yes or condition_no) in the Conditional column or select Condition from the puntjes for the relevant Job. See also Conditions.

Parameters tab

  • Use the Parameters tab to have an overview of the Job parameters in the Run Book.
  • Parameters: a Run Book parameter is an umbrella parameter for a set of Module parameters and/or Project parameters that occur in one Run Book. In Run Books, Module parameters and Project parameters are known as Job parameters. From here, you can add, delete, rearrange, autocreate and cleanup your Run Book parameters. See also Parameters.
  • Links: when linking a Run Book parameter to a Job parameter, you can specify which action should be performed at the input moment to determine the value of a parameter.

Job History tab

  • Use the Job History tab to view details of Jobs in which the Run Book was used.
  • Use the Filter to limit the results on status, date (range) and Job invoker.

Versioning tab

  • Use the Versioning tab to view a list of changes made to the Run Book, including all known versions of the Run Book. See Version Control.
  • Click the expand (collapse_arrow_right) button to view the details of the change grouped by date.
  • Click the browse (browse) button from the Current Version field to change the version number manually.

Permissions tab

  • Use the Permissions tab to view the level of access that Console users have to the Run Book.
  • Use the option Do not allow this Project to be scheduled programmatically to allow the Run Book from being invoked via the Console only. When selected, it will no longer be possible to invoke the Run Book:
    • During unattended installations of an Agent (by applying properties to its MSI).
    • Via Ivanti Workspace.