--- sourceDocument: Australia IT Service Management sourceDocumentLink: https://www.servicenow.com/docs/r/australia/it-service-management Release : - australia ft:locale : - en-US ft:publication_title : - Australia IT Service Management ft:clusterId : - itsm bundleId : - itsm workflow : - Technology --- # Onboard a tool using DevOps generic playbook # Onboard a tool using DevOps generic playbook {#ariaid-title1} Release version: Australia Updated March 12, 2026 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete. ## Summary of Onboard a tool using DevOps generic playbook The DevOps Change application offers a pre-built generic playbook designed to help users onboard and configure new tools efficiently within the DevOps Change Workspace. This guided, visual, and task-oriented playbook ensures a consistent onboarding experience by breaking down the process into clear stages and activities tailored to each tool's capabilities. Show full answer Show less ## Key Features * **Identification of Tool Capabilities:** Tools may have capabilities such as code, plan, and orchestration. The generic playbook organizes onboarding into stages for each capability, including connecting to the tool, specifying access, configuring the tool, importing data, associating pipeline steps (for orchestration), and providing a summary. * **Activity Definitions:** Each step in the playbook corresponds to an activity definition (e.g., Create Tool, Configure \& Test, Import Data). These definitions are maintained in the `sndevopscapabilityactivitymapping` table, which dynamically drives the playbook stages and activities based on the tool's characteristics. * **Customizable Activity Conditions:** You can enable or disable specific activities per tool by adjusting conditions in the mapping table. For instance, tools like GitLab and JFrog do not support data import, so the Import Data activity can be disabled for these tools. * **Activity UI Configuration:** Playbook activity user interfaces (UIs) define how users interact with each activity. Multiple UI templates can be configured for a single activity definition and dynamically selected based on conditions, allowing tailored user experiences per tool. ## Practical Outcomes for ServiceNow Customers * Customers can onboard custom DevOps tools quickly and consistently using the generic playbook framework. * The playbook adapts dynamically to the specific capabilities and requirements of each tool, providing flexibility and scalability. * By configuring activity definitions and UI templates, customers can customize the onboarding process to align with their tool integration needs. * Eliminates manual onboarding errors and streamlines the process, improving operational efficiency in managing DevOps toolchains. 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 {#onboard-new-tool-generic-playbook__section_sgb_5wf_rwb} 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 {#onboard-new-tool-generic-playbook__ol_zsc_kqg_rwb} 2. CapabilityCapability 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) {#onboard-new-tool-generic-playbook__ol_kjl_mqg_rwb} 3. Summary {#onboard-new-tool-generic-playbook__ol_cgr_3qg_rwb} This is how a playbook with multiple capabilities looks like: ## 2. Configure Activity Definitions {#onboard-new-tool-generic-playbook__section_q2z_psg_rwb} 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 {#onboard-new-tool-generic-playbook__ul_xt2_5sg_rwb}For more information, see [Exploring Playbook](https://www.servicenow.com/docs/access?context=process-automation-designer&version=australia&pubname=australia-build-workflows&ft:locale=en-US) 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. 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: ## 3. Configure Activity UI for the Activity Definition {#onboard-new-tool-generic-playbook__section_y3n_1xg_rwb} 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. 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. Result After completing these steps, your tool can be onboarded using the DevOps generic playbook. **Related concepts** * [Integrating DevOps Change Velocity with third party tools](https://www.servicenow.com/docs/pViQYW50q3XmI0CgMeO7rA "Integrate your orchestration, planning, coding, artifact, software quality, and security tools with DevOps Change Velocity for end to end change traceability and automation.")