---
title: Onboard a tool using DevOps generic playbook
description: DevOps Change has a pre-build playbook setup for users to configure a new tool. Custom tool integrations can be created using the guided playbook experience in the DevOps Change Workspace.
locale: en-US
canonical_url: https://www.servicenow.com/docs/r/australia/it-service-management/devops-change-velocity/onboard-new-tool-generic-playbook.html
release: australia
product: DevOps Change Velocity
classification: devops-change-velocity
topic_type: reference
last_updated: "2026-03-12"
reading_time_minutes: 2
breadcrumb: [Manage, DevOps Change Velocity, IT Service Management]
---

# Onboard a tool using DevOps generic playbook

DevOps Change has a pre-build playbook setup for users to configure a new tool. Custom tool integrations can be created using the guided playbook experience in the DevOps Change Workspace.

Playbooks provide end users with a visual, task-oriented guide with the steps to complete a process, ensuring a consistent experience for tool onboarding. For detailed information about playbooks, see .

Perform the following steps to onboard your custom tool using the DevOps generic playbook.

## 1. Identify tool capabilities

To configure a tool using the generic playbook, first you must identify the capabilities supported by the tool. A tool can have one or more capabilities like code, plan, and orchestration.

The Generic playbook consists of the following stages and each stage has its related activities:

1.  Connect to a tool
    1.  Connect to a tool
    2.  Specify tool access
    3.  Configure the tool
2.  Capability

    Capability can be of type plan, code, or orchestrate. If the tool has multiple capabilities, multiple stages exist with the capability name.

    1.  Select to track
    2.  Import data
    3.  Associate \(This activity is for the Orchestration tools to associate pipeline steps\)
3.  Summary

This is how a playbook with multiple capabilities looks like:\[Omitted image "generic-pb-onboard1.png"\] Alt text: Playbook with multiple capabilities.

## 2. Configure Activity Definitions

Each Activity in a playbook is associated to an activity definition. DevOps has the following activity definitions:

-   DevOps CreateTool AD
-   DevOps Configure & Test AD
-   DevOps Select Associated Objects AD
-   DevOps Import Data AD
-   DevOps Associate Services AD
-   DevOps Summary AD

For more information, see [Exploring Playbook](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/build-workflows/process-automation-designer.md) and .

The DevOps table **sn\_devops\_capability\_activity\_mapping** has been created to maintain associations between Activity definitions and capabilities. This table configuration is used to dynamically render the stages and activities for a tool. You can update the conditions as needed to either enable or disable a particular activity for a tool.

\[Omitted image "generic-pb-onboard2.png"\] Alt text: The Tool Capability Activity Mappings table.

For example, tools like GitLab and JFrog don’t support data import. So you don't require the Data Import activity for such tools. In that case, you must add the logic in the condition column to return false for these types of tools. See the following image as a reference:\[Omitted image "generic-pb-onboard3.png"\] Alt text: Example where data import logic is false.

## 3. Configure Activity UI for the Activity Definition

Playbook Activity UIs define the experience type and UI template rendered to users while managing Playbooks. You can configure multiple Activity UIs for an Activity Definition and render any one dynamically based on the condition evaluation.

DevOps has the following AUIs for Create Tool activity. Except this, all other activity definitions have only one Activity UI.

\[Omitted image "generic-pb-onboard4.png"\] Alt text: DevOps AUIs.

You can configure any one of the Activity UI based on the requirement.

Identify the required activity UI and add your tool in the condition builder so that the UI gets effected in the playbook for the tool.\[Omitted image "generic-pb-onboard5.png"\] Alt text: Override playbook activity.

**Result**

After completing these steps, your tool can be onboarded using the DevOps generic playbook.

**Parent Topic:**[Managing DevOps Change Velocity](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-service-management/devops-change-velocity/using-devops-change-velocity.md)

**Related topics**  


[Integrating DevOps Change Velocity with third party tools](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-service-management/devops-change-velocity/integrating-devops-change-with-third-party-tools.md)