1. BitTitan Help Center
  2. Getting Started with BitTitan
  3. Products & Tools
  4. MSPComplete
  5. Runbooks

Edit a Runbook or Service

Administrators and managers can edit Runbooks in the Runbook Page. Agents with any role can edit Services in the Delivery Center. Details such as the name, start date, due dates, assignees, cost estimates, and individual Tasks can be modified.

For more information: Read the Runbooks, Services, and Tasks Overview article.

 

Sections in this article:

 

Draft Runbooks versus Published Runbooks

When you edit a Runbook, a draft version is created separately from the original published version. You can publish the draft version of the Runbook and overwrite the original, you can export the draft version, or discard the draft version and retain the original. Other agents on the Workgroup cannot see the edits applied to the draft Runbook until it is published.

editarunbook1.png

 

Access the Runbook or Service Customization Page

Follow these steps to access the Customization Page for a Runbook or Service:

  1. Select the workgroup on the top of the left navigation pane.
  2. Complete one of these steps if you are editing a Runbook or a Service:
    1. To edit a Runbook, click Runbooks on the left navigation pane. In the Runbooks Page, click the ellipsis for a Runbook, and then select Edit Runbook.
    2. To edit a Service, click Delivery Center on the left navigation pane, and then click a Service. In the Service Page, click the ellipsis on the top right section of the page, and then select Edit Service Details.
  3. The Runbook/Service Customization Page is divided into three areas:

    editarunbook2.png

    #

    Details

    Description

    1

    Runbook/Service details

    The Runbook/Service details area contains this information for the Runbook or Service:

    • Runbook/Service name
    • Runbook/Service start and due date
    • Runbook/Service assignee
    • Runbook/Service time estimate
    • Runbook/Service cost estimate
    • Runbook/Service cost of materials

    The Edit Details for a Runbook or Service section below provides additional information about editing details for a Runbook or Service. 

    2

    Tasks list

    The Task list area contains a list of all Tasks for the selected Service, including this information for each Task:

    • Task name
    • Task due date
    • Task assignee

    The Edit Instructional Tasks, Input Collection Tasks, and PowerShell Automation Tasks section below provides additional information about editing Tasks for a Runbook or Service.

    3

    Task details and guidance

    The Task details and guidance area contains this information for the Task selected in the Task list area:

    • Task name
    • Task start and due date
    • Task assignee
    • Task time estimate
    • Task cost estimate
    • Task instructions, input collection, or PowerShell automation

    The Edit Task Details section below provides additional information about editing Tasks for a Runbook or Service.

 

Edit Details for a Runbook or Service

In the Runbook/Service details area, located on the top of the Runbook/Service Customization Page, you can modify the information listed below.

Note: If you define any information on a Runbook, then every Service launched from that Runbook will have that information set as the default. For example, if you set a Runbook start date to be January 1, 2018, then every Service launched from that Runbook will have a start date of January 1, 2018.

editarunbook3.png

#

Details

Description

1

Name

Enter a name for the Runbook or Service.

Tip: Enter a name that best describes what the Service is intended to accomplish. The Runbook or Service name is referenced in various areas of MSPComplete where Services are tracked, such as the Delivery Center, the Dashboard, and email notifications sent to assignees. 

2

Start date

Define a start date for the Runbook or Service.

3

Due date

Define a due date for the Runbook or Service.

Tip: Enter a due date that provides enough time for the Service to be completed. An overdue Service will trigger notifications to the assignee. You can refer to the Runbook/Service time estimate when defining a due date.

4

Assignee

Select an assignee for the Runbook or Service.

Note: All Tasks are automatically assigned to the assignee for the Runbook or Service. However, Tasks can be individually assigned to different agents later.

5

Runbook/Service time estimate

The estimated amount of time (HH:MM) to complete the Runbook or Service.

Note: The time estimate in the Runbook or Service details area is a read-only value that is automatically calculated from the time estimates of all Tasks in the Runbook or Service. To modify the time estimate for the Runbook or Service, you must modify the individual time estimates for each Task.

6

Runbook/Service cost estimate

The total cost estimate to complete all Tasks for the Runbook or Service.

Note: The total cost estimate is a read-only value that is automatically calculated from the cost per hour for assignees across all Tasks in the Runbook or Service.

7

Cost of materials

The cost of materials required to complete all Tasks for the Runbook or Service. For example, enter the cost of items that you need to purchase to complete the Runbook or Service, such as hardware or software licensing costs.

Tip: When customizing a Runbook, we suggest leaving the start date, due date, and assignee details blank, because every Service launched from that Runbook may require different information. Instead, define the start date, due date, and assignee only when you launch a Service from the Runbook.

Click Publish on the top-right of the page when you are done editing the Runbook or Service details, or continue to the next section below to edit Tasks for the Runbook or Service.

 

Add, Delete, and Change the Order of Tasks

In the Task list area, located on the lower left navigation pane of the Runbook or Service, agents can edit, add, or delete Tasks, as well as change the order of Tasks. Click Publish on the top-right of the Runbook or Service Customization Page to save your edits when you are done editing.

editarunbook4.png

Note: These task editing options appear only when a Runbook or Service is being edited.

#

Details

Description

1

Add Task

You can add one of these Task types to a Runbook or Service:

  • Instructional Task: Tasks that contain prescriptive guidance that an agent can follow to manually complete the Task.
  • Input Collection Task: Tasks that require the agent to provide an input or make a selection before the Task can run or the Service can continue.
  • PowerShell Automation Task: Tasks that run programmatically by executing PowerShell scripts.

2

Task Name

Enter a name for the Task.

Tip: Enter a name that best describes what the Task is intended to accomplish. The Task name is referenced in various areas of MSPComplete where Tasks are tracked, such as the My Tasks Page, the Dashboard, and email notifications sent to assignees.

3

Task order in the Runbook or Service

Click and drag a Task up or down to change the order of the Task within the Runbook or Service.

4

Delete a Task

Click the delete icon to remove a Task from a Runbook or Service.

Important: Deleted Tasks cannot be recovered.

5

Create a New Task

Click Create a New Task to quick-add a new Instructional Task to the Runbook or Service.

 

Edit Instructional Tasks, Input Collection Tasks, and PowerShell Automation Tasks

In the Task details area, located in the lower right pane of the Runbook or Service, you can edit Task details, instructions, input collections, and PowerShell automation.

 

Edit Task Details

in the Task details area, located at the top of the selected Task, agents can edit the details listed below.

editarunbook5.png

#

Details

Description

1

Task name

Enter a name for the Task.

Tip: Enter a name that best describes what the Task is intended to accomplish. The Task name is referenced in various areas of MSPComplete where Tasks are tracked, such as the My Tasks Page, the Dashboard, and email notifications sent to assignees.

2

Task start date

Define a start date for the Task.

3

Task due date

Define a due date for the Task.

Tip: Enter a due date that provides enough time for the Task to be completed. An overdue Task will trigger notifications to the assignee. You can refer to the Task time estimate when defining a due date.

4

Task assignee

Select an assignee for the Task.

Note: All Tasks are automatically assigned to the assignee for the Runbook or Service. However, Tasks can be individually assigned to different agents later.

5

Task time estimate

Enter the estimated amount of time (HH:MM) to complete the Task.

Note: The time estimate in the Runbook or Service details area is a read-only value that is automatically calculated from the time estimates of all Tasks in the Runbook or Service. To modify the time estimate for the Runbook or Service, you must modify the individual time estimates for each Task.

6

Task cost estimate

The cost estimate to complete the Tasks.

Note: The Task cost estimate is a read-only value that is automatically calculated from the cost per hour for the Task assignee and the Task time estimate.

7

Task instructions, input collection, or PowerShell automation

Depending on the type of Task selected, you can modify the instructions, input collection parameters, or PowerShell automation script. Refer to one of the sections listed below for more information.

Click Publish on the top-right of the Runbook or Service Customization Page when you are done editing the Runbook or Service.

 

Edit Instructional Tasks

Instructional Tasks contain prescriptive guidance that agents can follow to manually complete the Task. The instructions for a Task are displayed in the lower area of the selected Task. You can edit the prescriptive guidance for an Instructional Task as outlined below.

editarunbook6.png

#

Details

Description

1

 Formatting toolbar

The toolbar contains these formatting options:

editarunbook7.png

2

 Prescriptive guidance

Type the instructions for the Task directly into the instructions area.

Insert images into the instructions

Follow these steps to insert images into Task instructions:

  1. Put the cursor where the image should be inserted.
  2. Click the image icon in the formatting toolbar.
  3. Click the Upload tab in the Image Properties dialog box.
  4. Click Choose file.
  5. Select the image file on the local drive, and click Open.
  6. Modify the width and height to the appropriate dimensions.
  7. Click OK to insert the image.

 

Edit images in Task instructions

Follow these steps to edit images in Task instructions:

  1. Right-click the image in the Task instructions, and then select Image properties.
  2. You can modify these properties for the image in the image properties dialog box:
    • Width and height
    • Alternate text
    • Border
    • Horizontal and vertical space
    • Alignment
  3. Click OK to save the edits.

Click Publish on the top-right of the Runbook or Service Customization Page when you are done editing the Runbook or Service.

 

Edit Input Collection Tasks

Input Collection Tasks require agents to provide an input or make a selection before the Task can run or the Service can continue. Input Collection Tasks can be edited as outlined below. Read the Automation Building Blocks article to learn more about variables, Input Collection Tasks, and how they are used with PowerShell Automation Tasks.

editarunbook8.png

#

Details

Description

1

 Select Input for the Widget

Enter instructions or a description for the Input Collection Task.

2

 Input Collection Type

Select the input type:

  • Short Text: The agent performing the Task will have to enter a text string.
  • Dropdown: The agent performing the Task will have to select from a list of options you specify.
  • Computers: The agent performing the Task must select one or more customer Computers.
  • Endpoints: The agent performing the Task will have to select a Customer Endpoint. You can optionally specify the types of Endpoints that should be displayed.
  • Users: The agent performing the Task will have to select one or more Customer Users.
  • VMs: The agent performing the Task will have to select one or more Customer Virtual Machines. You can optionally specify the types of VMs that should be displayed.

3

 Input Label

Enter a label for the input collection field.

4

 Variable Name

Enter a variable name for the data collected through the input collection field.

Click Publish on the top-right of the Runbook or Service Customization Page when you are done editing the Runbook or Service.

 

Edit PowerShell Automation Tasks

PowerShell Automation Tasks are scripted processes for which agents can click Run Automation to execute the script and initiate the Task. PowerShell Automation Tasks can be edited as outlined below. Read the Automation Building Blocks article to learn more about variables, Input Collection Tasks, and how they are used with PowerShell Automation Tasks.

Important: PowerShell Automation Tasks are only available to subscribers of the Get Automated plan.


editarunbook9.png

#

Details

Description

1

Details

Click the Details tab to enter instructions or a description for the PowerShell Automation Task.

2

PowerShell

Click the PowerShell tab to view the PowerShell script text box.

3

Save script

Click Save script to save the PowerShell script.

4

PowerShell script text box

Enter the PowerShell script that agents will execute when they click Run Automation for the Task.

Click Publish on the top-right of the Runbook or Service Customization Page when you are done editing the Runbook or Service.

 

 

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more