SSGB5S_2.0.2 - Documentation Index
Table of Contents
Welcome
Release Notes
What's New
Defect fixes
Known issues
System Requirements
Hardware
Operating systems and containers
Host prerequisites
Supported software
Getting Started
Overview of DevOps Loop
User interface
Accessibility features
Administration
Configuration of external databases for the capabilities in DevOps Loop
Configuring an external database for Plan and Control
Configuring an external database for Deploy
Configuring an external database for Build
Configuring an external database for Test
Configuring an external database for Measure and Release
Configuring external access to the Plan PostgreSQL database
Viewing connection details from the DevOps Plan UI
Installation of DevOps Loop
Installing DevOps Loop on IBM Red Hat OpenShift
Installing DevOps Loop on IBM Cloud Kubernetes Service (IKS)
Installing DevOps Loop on Kubernetes Service (K8S)
Installation of DevOps Loop on Google Kubernetes Engine (GKE)
Preparing GCP infrastructure for installing DevOps Loop on GKE
Installing DevOps Loop on Google Kubernetes Engine (GKE)
Installing DevOps Loop on a RHEL system for a demo setup
Setting a public DNS server inside the VM
Installation of DevOps Loop on Amazon Web Services (AWS)
Preparing AWS infrastructure for installing DevOps Loop on AWS
Installing DevOps Loop on AWS
Installation of DevOps Loop in an air-gapped environment
Preparing images and resources for an air-gapped installation
Installing DevOps Loop in an air-gapped environment
Managing DevOps Loop features after installation
Additional Helm parameters
License management and user administration
DevOps Loop licensing information
Configuring floating token licensing
Enabling the social sign-up and social login for DevOps Loop
Revoking a license
User access and administration using Keycloak
About user roles and access permissions
Backup and restoration of DevOps Loop
Backing up DevOps Loop data
Restoring DevOps Loop data
Private CA and self-signed certificate support
Configuring trusted certificates in DevOps Loop
Upgrading DevOps Loop
Integrations in DevOps Loop
AI provider integration for Loop Genie - Tech Preview
Prerequisites for setting up AI providers for Loop Genie
Configuring OpenAI integration
Configuring AZURE OpenAI integration
Configuring Claude integration
Configuring Gemini integration
Configuring IBM watsonx integration
Configuring Ollama integration
Harbor integration overview
Prerequisites for Harbor integration
Installing DevOps Loop with Harbor integration
Accessing Harbor from DevOps Loop
Importing and validating images in Harbor registry
DevOps Loop MCP server
Getting started with the DevOps Loop MCP server
Plan MCP endpoint and tools
Control MCP endpoint and tools
Deploy MCP endpoint and tools
Build MCP endpoint and tools
Test MCP endpoint and tools
Measure MCP endpoint and tools
DevOps Loop MCP server configuration in VS Code
Adding the DevOps Loop MCP server in VS Code by using the command palette
Adding the DevOps Loop MCP server in VS Code by editing the MCP configuration file
Viewing and managing MCP servers in VS Code
Connecting Claude to the DevOps Loop MCP server
Configuring an external MCP server in a teamspace
Teamspace management
Creating a teamspace
Adding or inviting members to a teamspace
Joining a teamspace as an invited member
Removing a member from a teamspace
Uninstalling DevOps Loop
Uninstalling DevOps Loop from IBM Red Hat OpenShift
Uninstalling DevOps Loop from IBM Cloud Kubernetes Service (IKS)
Uninstalling DevOps Loop from Kubernetes Service (K8S)
Working with Loops
Loop management
Creating a loop
Capabilities and resources configured during loop creation
Viewing loop details
Adding members to a loop
Removing a member from a loop
Disabling a loop
Enabling a loop
Loop Segments overview
Adding a loop segment
Learning Loop overview
Creating a Loop with preloaded example data
Dashboards and insights
Viewing dashboards
Editing dashboards
AI-powered search
Capabilities of DevOps Loop
Model
Plan
Code implementation with AI
Code
Code overview
Accessing dev containers
Dev containers
Viewing logs
Working with dev containers
Configuring dev containers
Code IDE user interface
Extensions in dev containers
File management features
Access applications via automatic port forwarding
File system in dev containers
Loading extensions from local .vsix files
Configuring extension registry
Git authentication for dev containers
Authenticating with DevOps Code UI (Recommended)
Authenticating Git with personal access token
Authenticating Git with device code
Code Genie
Non-IDE dev container
Runner Scripts
Creating webhooks
Configuring Coding CLI token
Creating Plan work items from Code
Installing GitHub Copilot in dev containers
Control
AI code reviewing with Code Genie
Trivy scanning with Code Genie
Branching strategy with a protected main branch
Managing Git authentication for developers
Build
Overview of Build
Concepts
Architecture
Service tier
Data tier
CodeStation relocation
Agents
Server-agent communication
Mutual authentication
Tutorials
Create a Maven build project
Introduction
Configure the tutorial system
Lesson 1: Create a Git repository
Lesson 2: Creating a job and adding steps
Lesson 3: Creating a project template
Lesson 4: Creating a source template
Lesson 5: Creating a process template
Lesson 6: Creating a project
Lesson 7: Running the build
Summary
Create a project that integrates with DevOps Deploy
Introduction
Configure the tutorial system
Lesson 1: Creating a Git repository
Lesson 2: Creating a job and adding steps
Lesson 3: Creating a source template
Lesson 4: Creating a process template
Lesson 5: Creating a project template
Lesson 6: Creating a project
Lesson 7: Running the build
Lesson 8: Verifying the build results
Summary
Administering
Feature flags
Running agents
Starting agents on z/OS
Viewing z/OS agent logs
Configuring an external agent for Build in DevOps Loop
Integrating Build resources with existing loop and teamspaces
Integrations
Integrating with Eclipse
Installing the Eclipse plug-in
Configuring the Eclipse plug-in
Configuring CodeStation preferences
Integrating with DevOps Deploy
Integrating with Maven
Managing scripts
Creating job-precondition scripts
Creating post-processing scripts
Creating step-precondition scripts
Creating working directory scripts
User notifications
Configuring mail servers
Configuring instant messaging
Creating notification schemes
Creating notification templates
Creating recipient generators
Configuring event selectors
Security
Guidelines for setting up security
Security types
Creating security types
Roles and permissions
Creating roles
Security teams
Creating teams
Assigning users to teams
Mapping teams to resources
Viewing resources that are assigned to teams
Viewing teams that are assigned to resources
Auditing team activity
Users and groups
Manually creating groups
Creating users manually
Deleting users manually
User profiles
Updating your user profile
Managing user profiles
Creating tokens
Auditing user activity
Project support
Creating artifact sets
Managing cleanups
Adding and editing cleanup policy settings
Managing Labels
Creating lockable resources
Repositories
Creating file system repositories
Creating Maven repositories
Creating schedules
Creating statuses
Server management
Creating announcements
Creating system properties
Creating proxy servers
Server settings
Configuring network settings
Setting system-level security
Configuring miscellaneous system settings
Placing an administrative lock on the server
Viewing the server log
Viewing the server error log
Displaying graphs on the dashboard
Running system diagnostics
Adding a cold standby server
Agents
Configuring agents
Modifying agent settings
Creating agent pools
Modifying agent pools
Modifying agent settings
Restarting agent brokers
Managing untrusted agent certificates
Viewing agent workspace data
Creating scripts to automate administrative tasks
Accessing development tools
Installing plug-ins
Creating and Managing Projects
Creating projects
Configuring projects
Managing build processes
Defining source configurations
Defining build configurations
Defining build properties
Moving build processes
Defining project dependencies
Configuring build artifacts
Defining build triggers
Monitoring build processes
Managing build lives
View build context
Searching for build lives
Managing notification subscriptions
Managing secondary processes
Monitoring projects
Creating and Managing Projects
Running projects
Running preflight builds
CodeStation projects
Creating CodeStation projects
Creating CodeStation project artifact set versions
Build pipelines
Creating Jobs and Processes
Creating jobs
Configuring properties common to all steps
Adding, copying, and arranging steps to a job
Creating Job templates using the Job as Code plugin
Creating Job templates using the Job as Code plugin
Layout of Job as Code configuration file
Disabling and deleting job steps
Managing Project Templates
Creating project templates
Configuring project template build pre-processing properties
Creating project template properties
Creating source templates
Creating build process templates
Creating process definitions
Creating secondary process templates
Monitoring and Reporting
Monitoring current activity
Information Radiator dashboard
Monitoring builds with the Information Radiator dashboard
Reporting
Extending Product Functions
Plug-ins
Installing plug-ins
Plug-ins at run time
Creating plug-ins
The plugin.xml file for automation plug-ins
The header element
Creating source plug-ins
Plug-in steps: The step-type element
Step properties: The properties element
The command element
The post-processing element
Upgrading plug-ins
The info.xml file
Example plug-in
Step properties
Step commands
create_file.groovy
Build Scripting
Properties in Build
Cascading property values
REST API reference
Running REST commands
Authenticating for REST commands
REST API conventions
REST commands for Build
agentPools resource
Get information about all agent pools
agents resource
Create a environment in agent environments
Configure all unconfigured agents
Create a property in agent propertes
Delete a specified name environment in agent environments
Delete a specified name property in agent propertes
Delete an agent
Get agent properties on an agent
Get all properties on an agent
Get environments on an agent
Get information about all agents
Get information about an agent
Get locked properties on an agent
Get system properties on an agent
Update an agent
Update environment in agent environments
Update property in agent propertes
artifactsets resource
Create an artifact set
Delete the artifact set
Get information about all artifact sets
Get information about the artifact set
Update the artifact set
authenticationRealm resource
authenticationRealm GET
authenticationRealm POST
authenticationRealm/{realm} GET
authenticationRealm/{realm} PUT
authenticationRealm/{realm} DELETE
authenticationRealm/{realm}/users GET
authenticationRealm/{realm}/moveUp PUT
authenticationRealm/{realm}/moveDown PUT
authenticationRealm/{realm}/updateUsers PUT
authenticationRealm/{realm}/importUsers/{name} PUT
authorizationRealm resource
authorizationRealm GET
authorizationRealm POST
authorizationRealm/{realm} GET
authorizationRealm/{realm} PUT
authorizationRealm/{realm} DELETE
authtoken resource
authtoken GET
authtoken PUT
authtokentable GET
authtoken{token} GET
authtoken{token} DELETE
authtoken/getOrCreateToken PUT
authtokens resource
Create an authtoken
Delete an authtoken
Get information about queried tokens
Get information about the authtoken
build-lives resource
/build-lives/ GET
/build-lives//latest GET
/build-lives//latest/dependencies GET
/build-lives//latest/dependencies POST
/build-lives//latest/artifact-configs GET
/build-lives//latest/dependencies-xml GET
/build-lives//latest/artifactSets GET
/build-lives//latest/artifactSets/{set} GET
/build-lives//latest/artifactSets/{set}/artifacts GET
/build-lives//latest/artifactSets/{set}/artifacts/{path} GET
/build-lives//latest/artifactRepositories GET
/build-lives//latest/artifactRepositories/{id} GET
/build-lives//latest/artifactRepositories/{id}/artifacts GET
/build-lives//latest/artifactRepositories/{id}/artifacts/{path} GET
/build-lives//{id} GET
/build-lives//{id}/dependencies GET
/build-lives//{id}/dependencies POST
/build-lives//{id}/artifact-configs GET
/build-lives//{id}/dependencies-xml GET
/build-lives//{id}/artifactSets GET
/build-lives//{id}/artifactSets/{set} GET
/build-lives//{id}/artifactSets/{set}/artifacts GET
/build-lives//{id}/artifactSets/{set}/artifacts/{path} GET
/build-lives//{id}/artifactRepositories GET
/build-lives//{id}/artifactRepositories/{id} GET
/build-lives//{id}/artifactRepositories/{id}/artifacts GET
/build-lives//{id}/artifactRepositories/{id}/artifacts/{path} GET
Create a label.
Create a label.
Create a status.
Create a status.
Get a summary of all the findings in the source analytic report
Get a summary of all the findings in the source analytic report
Get all the source analytic reports
Get all the source analytic reports
Get all the source analytic summary reports
Get all the source analytic summary reports
Get build lives for a project
Get information about all code coverage reports
Get information about all code coverage reports
Get information about all issues.
Get information about all issues.
Get information about all labels
Get information about all labels
Get information about all of the findings in the source analytic report
Get information about all of the findings in the source analytic report
Get information about all source change sets
Get information about all source change sets
Get information about all statuses
Get information about all statuses
Get information about all test reports
Get information about all test reports
Get information about the source analytic report
Get information about the source analytic report
Get information about the source analytic summary report
Get information about the source analytic summary report
buildProcessTemplates resource
/buildProcessTemplates/{id}/workflow GET
/buildProcessTemplates/{id}/workflow/graph GET
/buildProcessTemplates/{id}/workflow/graph POST
/buildProcessTemplates/{id}/workflow/graph PUT
/buildProcessTemplates/{id}/workflow/graph/insert POST
/buildProcessTemplates/{id}/workflow/graph/{id} POST
/buildProcessTemplates/{id}/workflow/graph/{id}/iterate DELETE
/buildProcessTemplates/{id}/workflow/graph/{id}/iterate POST
/buildProcessTemplates/{id}/workflow/graph/{id}/iterate/property POST
/buildProcessTemplates/{id}/workflow/graph/{id}/iterate/property GET
/buildProcessTemplates/{id}/workflow/graph/{id}/iterate/property/{propertyName} DELETE
Create a new property by copy on a process template
Create a process template
Delete a job in the process definition.
Delete a process template
Delete a specified name property on a process template
Delete the artifact on a process template
Delete the resource on a process template
Get a list of processes that use the specified process template
Get all artifacts on a process template
Get all properties on a process template
Get all resources on a process template
Get avaiable resources on a process template
Get information about a process template
Get information about all build process templates
Update a process template
Update artifacts on a process template
Update properties on a process template
Update resources on a process template
codestation-build-lives resource
/codestation-build-lives//latest GET
/codestation-build-lives//{id} GET
Create a property in codestation buildLife
Create a property in codestation buildLife
Delete the Version of CodeStation project
Delete the Version of CodeStation project
Get Versions of a CodeStation project
Get the dependencies of a CodeStation Project Version.
Get the dependencies of a CodeStation Project Version.
Get the properties of a Version of a CodeStation Project.
Get the properties of a Version of a CodeStation Project.
Get the statuses of a CodeStation Project Version.
Get the statuses of a CodeStation Project Version.
Update property in codestation buildLife
Update property in codestation buildLife
codestation-projects resource
/codestation-projects/{id} GET
/codestation-projects/{id}/build-lives/latest GET
/codestation-projects/{id}/build-lives/{id} GET
Create a codestation project
Create a property in codestation buildLife
Create a property in codestation buildLife
Create a property in codestation project
Delete the CodeStation project
Delete the Version of CodeStation project
Delete the Version of CodeStation project
Get CodeStation projects
Get Versions for a new CodeStation project
Get Versions of a CodeStation project
Get all properties on a CodeStation Project
Get the dependencies of a CodeStation Project Version.
Get the dependencies of a CodeStation Project Version.
Get the properties of a Version of a CodeStation Project.
Get the properties of a Version of a CodeStation Project.
Get the statuses of a CodeStation Project Version.
Get the statuses of a CodeStation Project Version.
Update a codestation project
Update property in codestation buildLife
Update property in codestation buildLife
Update property in codestation project
conf/locale resource
/conf/locale/{language}.json GET
currentActivity resource
/currentActivity/agentDirLocks GET
/currentActivity/schedules GET
/currentActivity/lockableResources GET
dashboard resource
/dashboard/activity GET
/dashboard/activity/{id} GET
/dashboard/projects GET
/dashboard/tags GET
dependencyConfig resource
Retrieve information about addable dependencies
dynamicAgentPools resource
Create a group rule
Get information about all dynamic agent pools
Get information about rule conditions
Get information about rule types
Get information about the dynamic agent pool
file resource
/file/{hash} GET
files resource
/files POST
fixedAgentPools resource
Create a fixed agent pool
Delete the fixed agent pool.
Get information about all fixed agent pool
Get information about the fixed agent pool
Update the fixed agent pool
group resource
group GET
group POST
group/{group} GET
group/{group} PUT
group/{group} DELETE
group/{group}/members GET
group/{group}/members/{user} PUT
group/{group}/members/{user} DELETE
import resource
/import PUT
jobPreConditions resource
Get information about all job preConditions
jobPreConditionScripts resource
/jobPreConditionScripts GET
/jobPreConditionScripts POST
/jobPreConditionScripts/{id} GET
/jobPreConditionScripts/{id} PUT
/jobPreConditionScripts/{id} DELETE
jobs resource
/jobs/{id}/steps GET
/jobs/{id}/steps POST
/jobs/{id}/steps/{id} GET
/jobs/{id}/steps/{id} PUT
/jobs/{id}/steps/{id} DELETE
Create a job
Delete the job
Get a JSON representation of process templates that use the specified job
Get information about all jobs
Get information about the job
Update the job
label resource
Add a label to buildlives.
Delete the label of buildlives.
Get all labels.
Get all labels.
Replace the label of buildlives.
logs resource
/logsjob/{jobTraceId}/step/{stepSeq}/{fileName} POST
myactivity resource
/myactivity GET
/myactivity/project/{id} GET
/myactivity/workflow/{id} GET
notificationSubscriptions resource
notificationSubscriptions GET
notificationSubscriptions POST
notificationSubscriptions/{id} GET
notificationSubscriptions/{id} PUT
notificationSubscriptions/{id} DELETE
notificationSubscriptions/{id}/children GET
plugins resource
Create an integration
Delete the integration
Delete the plugin
Get information about all integrations of the specified plugin
Get information about all plugins
Get information about the integration
Get information about the plugin
Update the integration
Upload a plugin
Upload a plugin and allow downgrading if necessary
preferences resource
preferencesavailableLocales GET
preflight resource
/preflight/lookupArtifactSets POST
/preflight/request POST
/preflight/request/{requestId} GET
/preflight/build/{buildLifeId} GET
processRequests resource
/processRequests POST
/processRequests{id} GET
processTemplates resource
/processTemplates/{id}/workflow GET
/processTemplates/{id}/workflow/graph GET
/processTemplates/{id}/workflow/graph POST
/processTemplates/{id}/workflow/graph PUT
/processTemplates/{id}/workflow/graph/insert POST
/processTemplates/{id}/workflow/graph/{id} POST
/processTemplates/{id}/workflow/graph/{id}/iterate DELETE
/processTemplates/{id}/workflow/graph/{id}/iterate POST
/processTemplates/{id}/workflow/graph/{id}/iterate/property POST
/processTemplates/{id}/workflow/graph/{id}/iterate/property GET
/processTemplates/{id}/workflow/graph/{id}/iterate/property/{propertyName} DELETE
Create a new property by copy on a process template
Create a process template
Delete a job in the process definition.
Delete a process template
Delete a specified name property on a process template
Delete the artifact on a process template
Delete the resource on a process template
Get a list of processes that use the specified process template
Get all artifacts on a process template
Get all properties on a process template
Get all resources on a process template
Get avaiable resources on a process template
Get information about a process template
Get information about all process templates
Update a process template
Update artifacts on a process template
Update properties on a process template
Update resources on a process template
projects resource
Get project details
/projects/{id}/buildProcesses/{id}/buildLives GET
/projects/{id}/buildProcesses/{id}/buildLives/latest GET
/projects/{id}/buildProcesses/{id}/buildLives/latest/dependencies GET
/projects/{id}/buildProcesses/{id}/buildLives/latest/dependencies POST
/projects/{id}/buildProcesses/{id}/buildLives/latest/artifact-configs GET
/projects/{id}/buildProcesses/{id}/buildLives/latest/dependencies-xml GET
/projects/{id}/buildProcesses/{id}/buildLives/latest/artifactSets GET
/projects/{id}/buildProcesses/{id}/buildLives/latest/artifactSets/{set} GET
/projects/{id}/buildProcesses/{id}/buildLives/latest/artifactSets/{set}/artifacts GET
/projects/{id}/buildProcesses/{id}/buildLives/latest/artifactSets/{set}/artifacts/{path} GET
/projects/{id}/buildProcesses/{id}/buildLives/latest/artifactRepositories GET
/projects/{id}/buildProcesses/{id}/buildLives/latest/artifactRepositories/{id} GET
/projects/{id}/buildProcesses/{id}/buildLives/latest/artifactRepositories/{id}/artifacts GET
/projects/{id}/buildProcesses/{id}/buildLives/latest/artifactRepositories/{id}/artifacts/{path} GET
/projects/{id}/buildProcesses/{id}/buildLives/{id} GET
/projects/{id}/buildProcesses/{id}/buildLives/{id}/dependencies GET
/projects/{id}/buildProcesses/{id}/buildLives/{id}/dependencies POST
/projects/{id}/buildProcesses/{id}/buildLives/{id}/artifact-configs GET
/projects/{id}/buildProcesses/{id}/buildLives/{id}/dependencies-xml GET
/projects/{id}/buildProcesses/{id}/buildLives/{id}/artifactSets GET
/projects/{id}/buildProcesses/{id}/buildLives/{id}/artifactSets/{set} GET
/projects/{id}/buildProcesses/{id}/buildLives/{id}/artifactSets/{set}/artifacts GET
/projects/{id}/buildProcesses/{id}/buildLives/{id}/artifactSets/{set}/artifacts/{path} GET
/projects/{id}/buildProcesses/{id}/buildLives/{id}/artifactRepositories GET
/projects/{id}/buildProcesses/{id}/buildLives/{id}/artifactRepositories/{id} GET
/projects/{id}/buildProcesses/{id}/buildLives/{id}/artifactRepositories/{id}/artifacts GET
/projects/{id}/buildProcesses/{id}/buildLives/{id}/artifactRepositories/{id}/artifacts/{path} GET
/projects/{id}/buildProcesses/{id}/dependencies GET
/projects/{id}/buildProcesses/{id}/dependencies PUT
/projects/{id}/buildProcesses/{id}/dependencies POST
/projects/{id}/buildProcesses/{id}/dependencies/complex GET
/projects/{id}/buildProcesses/{id}/dependencies/{id} GET
/projects/{id}/buildProcesses/{id}/dependencies/{id} PUT
/projects/{id}/buildProcesses/{id}/dependencies/{id} DELETE
/projects/{id}/buildProcesses/{id}/triggers GET
/projects/{id}/buildProcesses/{id}/triggers POST
/projects/{id}/buildProcesses/{id}/triggers/{id} GET
/projects/{id}/buildProcesses/{id}/triggers/{id} PUT
/projects/{id}/buildProcesses/{id}/triggers/{id} DELETE
/projects/{id}/buildProcesses/{id}/successRateReport GET
/projects/{id}/buildProcesses/{id}/successRateReport PUT
/projects/{id}/secondaryProcesses/{id}/dashboardActivity GET
/projects/{id}/secondaryProcesses/{id}/triggers GET
/projects/{id}/secondaryProcesses/{id}/triggers POST
/projects/{id}/secondaryProcesses/{id}/triggers/{id} GET
/projects/{id}/secondaryProcesses/{id}/triggers/{id} PUT
/projects/{id}/secondaryProcesses/{id}/triggers/{id} DELETE
/projects/{id}/notificationSubscriptions GET
/projects/{id}/recentProcessActivity GET
/projects/{id}/latestStatus GET
/projects/{id}/latestBuilds GET
/projects/{id}/sourceChanges GET
/projects/{id}/sourceChangesByUser GET
Create a build process
Create a label.
Create a label.
Create a project
Create a secondary process
Create a source config
Create a status.
Create a status.
Delete a specified name property in process propertes
Delete a specified name property in process propertes
Delete a specified name property in process propertes
Delete the build process
Delete the project
Delete the secondary process
Delete the source config
Get a summary of all the findings in the source analytic report
Get a summary of all the findings in the source analytic report
Get activities shown on the process dashboard
Get all the source analytic reports
Get all the source analytic reports
Get all the source analytic summary reports
Get all the source analytic summary reports
Get dependencies of the build process
Get dependency summaries of the build process
Get general dependency configuration of the build process
Get information about all code coverage reports
Get information about all code coverage reports
Get information about all issues.
Get information about all issues.
Get information about all labels
Get information about all labels
Get information about all of the findings in the source analytic report
Get information about all of the findings in the source analytic report
Get information about all source change sets
Get information about all source change sets
Get information about all source configs
Get information about all statuses
Get information about all statuses
Get information about all test reports
Get information about all test reports
Get information about build activity for a specific build life
Get information about changeset for a specific userName
Get information about changeset for a specific userName
Get information about queried build processes
Get information about queried processes
Get information about queried projects
Get information about queried secondary processes
Get information about the build process
Get information about the project
Get information about the secondary process
Get information about the source analytic report
Get information about the source analytic report
Get information about the source analytic summary report
Get information about the source analytic summary report
Get information about the source config
Get paginated build activity information
Get paginated build activity information
Get properties of the build process
Get properties on a process
Get properties on a process
Get properties on a process
Get status summaries of the build process
Update general dependency configuration of the build process
Update or create property on a process
Update or create property on a process
Update or create property on a process
Update the build process
Update the project
Update the secondary process
Update the source config
radiator resource
/radiator GET
/radiator/{id} POST
/radiator/{id} DELETE
repo resource
/repo POST
/repo/{id} GET
/repo/{id}/{hash} GET
/repo/{id}/byLabel/{label} GET
/repo/{id}/{hash}/label/{label} POST
/repo/{id}/{hash}/copyToServer POST
/repo/{id}/{hash}/copyToUrbanCodeDeploy POST
reporting resource
/reporting/tables GET
/reporting/tables POST
/reporting/tables/{name} GET
/reporting/tables/{name} PUT
/reporting/tables/{name}/expanded GET
/reporting/tables/{name}/related GET
/reporting/dimensions GET
/reporting/dimensions POST
/reporting/dimensions/{name} GET
/reporting/dimensions/{name}/expanded GET
/reporting/tablesAndDimensions GET
/reporting/query POST
/reporting/query/download GET
/reporting/reports GET
/reporting/reports POST
/reporting/reports/{name} PUT
/reporting/reports/{name} DELETE
/reporting/reports/{name} GET
/reporting/reports/{name}/output POST
reports resource
/reports/tests/projects GET
/reports/tests/projects/{id} GET
/reports/tests/projects/{id}/build-processes/{id} GET
/reports/builds/projects GET
/reports/builds/projects/{id} GET
/reports/builds/projects/{id}/build-processes/{id} GET
/reports/commits/projects GET
/reports/commits/projects/{id} GET
/reports/commits/projects/{id}/build-processes/{id} GET
/reports/issues/projects/{id} GET
/reports/issues/projects/{id}/build-processes/{id} GET
/reports/coverage/projects/{id} GET
/reports/coverage/projects/{id}/build-processes/{id} GET
/reports/analytics/projects/{id} GET
/reports/analytics/projects/{id}/build-processes/{id} GET
repositories resource
/repositories GET
/repositories POST
/repositories/{id} GET
/repositories/{id} PUT
/repositories/{id} DELETE
/repositories/{id}/trigger GET
/repositories/{id}/trigger POST
/repositories/{id}/trigger DELETE
requestStatuses resource
/requestStatuses GET
resource resource
resource/{resource}/teamMappings GET
resourceRole resource
resourceRole GET
resourceRole POST
resourceRole/{resourceRole} GET
resourceRole/{resourceRole} DELETE
resourceRole/{resourceRole} PUT
resourceType resource
resourceType GET
resourceType/{resourceType} GET
resourceType/{resourceType}/actions GET
resourceType/{resourceType}/resourceRoles GET
role resource
role GET
role POST
role/{role} GET
role/{role} DELETE
role/{role} PUT
role/{role}/actionMappings GET
role/{role}/actionMappings POST
role/{role}/actionMappings DELETE
search resource
/search/requests GET
/search/statuses GET
/search/workflows GET
/search/workflows/{id} GET
/search/projects GET
Abort buildRequest
Deactivate a build life
Delete a build life
Delete buildLives
Delete buildRequests
Get builds by label.
Get the build by searching.
secondaryProcessTemplates resource
/secondaryProcessTemplates/{id}/workflow GET
/secondaryProcessTemplates/{id}/workflow/graph GET
/secondaryProcessTemplates/{id}/workflow/graph POST
/secondaryProcessTemplates/{id}/workflow/graph PUT
/secondaryProcessTemplates/{id}/workflow/graph/insert POST
/secondaryProcessTemplates/{id}/workflow/graph/{id} POST
/secondaryProcessTemplates/{id}/workflow/graph/{id}/iterate DELETE
/secondaryProcessTemplates/{id}/workflow/graph/{id}/iterate POST
/secondaryProcessTemplates/{id}/workflow/graph/{id}/iterate/property POST
/secondaryProcessTemplates/{id}/workflow/graph/{id}/iterate/property GET
/secondaryProcessTemplates/{id}/workflow/graph/{id}/iterate/property/{propertyName} DELETE
Create a new property by copy on a process template
Create a process template
Delete a job in the process definition.
Delete a process template
Delete a specified name property on a process template
Delete the artifact on a process template
Delete the resource on a process template
Get a list of processes that use the specified process template
Get all artifacts on a process template
Get all properties on a process template
Get all resources on a process template
Get avaiable resources on a process template
Get information about a process template
Get information about all secondary process templates
Update a process template
Update artifacts on a process template
Update properties on a process template
Update resources on a process template
security resource
/security/user GET
sourceTemplates resource
Create a new property by copy on a source config template
Create a source config template
Delete a source config template
Delete a specified name property on a source config template
Get a list of source configs that use the specified source config template
Get information about a source config template
Get information about all source config templates
Get properties on a source template
Update a source config template
Update properties on a source config template
stage resource
/stage POST
/stage/{id} GET
/stage/{id} DELETE
/stage/{id} PUT
/stage/{id}/{path:.+} PUT
/stage/{id}/{path:.+} GET
statuses resource
/statuses GET
/statuses POST
/statuses/{id} GET
/statuses/{id} PUT
/statuses/{id} DELETE
Get the statuses which are not archived.
stepPreConditionScripts resource
/stepPreConditionScripts GET
/stepPreConditionScripts POST
/stepPreConditionScripts/{id} GET
/stepPreConditionScripts/{id} PUT
/stepPreConditionScripts/{id} DELETE
steps resource
/steps GET
/steps/{id} GET
system resource
/system/properties GET
Create a property in system propertes
Delete a specified name property in system propertes
Update properties in system propertes
team resource
team GET
team POST
team/{team} GET
team/{team} DELETE
team/{team} PUT
team/{team}/roleMappings GET
team/{team}/roleMappings POST
team/{team}/roleMappings DELETE
team/{team}/roleMappings/{role}/validMembers GET
team/{team}/resourceMappings GET
team/{team}/resourceMappings POST
team/{team}/resourceMappings DELETE
team/{team}/resourceMappings/{type} GET
team/{team}/batchResourceMappings PUT
team/{team}/batchResourceMappings DELETE
team/{team}/unmappedResources/{type} GET
team/{team}/unmappedResources/{type}/{role} GET
templates resource
Create a new property by copy on a project template
Create a project template
Delete a project template
Delete a specified name property on a project template
Get a list of projects that use the specified project template
Get information about a project template
Get information about all project templates
Get properties on a project template
Update a project template
Update properties on a project template
trends resource
/trends/tests/{name}/{curr}/since/{since} GET
/trends/coverages/{name}/{curr} GET
/trends/coverages/{name}/{curr}/since/{since} GET
/trends/analytics/{name}/{curr}/{limit} GET
/trends/analytics/{name}/{curr}/since/counts/{since} GET
/trends/analytics/{name}/{curr}/since/severities/{since} GET
user resource
user GET
user POST
user/{user} GET
user/{user} DELETE
user/{user} PUT
user/{user}/setPassword PUT
user/{user}/unlock PUT
users resource
users GET
users/{id} DELETE
users/{id}activate PUT
users/{id}inactivate PUT
Create a user
Get information about a user
Update a user
workDirScripts resource
/workDirScripts GET
/workDirScripts POST
/workDirScripts/{type} GET
/workDirScripts/{id} GET
/workDirScripts/{id} PUT
/workDirScripts/{id} DELETE
workflow/{workflowId/dependencies resource
/workflow/{workflowId}/dependencies/ PUT
workflow/massdependencytree resource
/workflow/massdependencytreenodes GET
/workflow/massdependencytreenodes/{nodeId} GET
/workflow/massdependencytreemoveDependencyAjax POST
/workflow/massdependencytreecopyDependencyAjax POST
/workflow/massdependencytreecreateWorkflowDependencyAjax POST
/workflow/massdependencytreecreateCodestationDependencyAjax POST
/workflow/massdependencytreedeleteDependencyAjax POST
workflowStatuses resource
/workflowStatuses GET
Test
Introduction to DevOps Test
Capabilities
User tasks
Member access and permissions
Compatibility and supported assets
Supported versions of assets and resources
Supported suites and tests
Supported virtual services
Accessibility features
Tutorials
Creation and management of your first Web UI test
Prerequisites
Create a new user account
Create a project
Lesson 1: Create an application
Lesson 2: Create a Web UI test by recording user actions
Lesson 3: Create and add variables to a Web UI test
Lesson 4: Modify test steps
Lesson 5: Manage test steps
Lesson 6: Add steps from the Catalog to a Web UI test
Lesson 7: Add verification points to test steps by using Smartshots
Lesson 8: Run the Web UI test
Lesson 9: View and analyze test results
Administrator Guide
Configuration of DevOps Test
Management of third-party licenses
Accepting third-party licenses
Removing acceptance of third-party licenses
Certificate authority: Importing and extending lists
Saving the certificate authority
Importing the certificate authority into the Google Chrome browser
Importing the certificate authority into the Microsoft Edge browser
Importing the certificate authority into the Mozilla Firefox browser
Extending the trusted certificate authority list on Linux
Extending the trusted certificate authority list on Windows
Copying third-party application Jars to Kubernetes
Server extensions
Disabling server extensions
Enabling server extensions
Team space administration
Team space overview
Creating a team space
Tasks in a team space
Tasks in projects in a team space
Management of resources
Managing retention rules
Viewing resource usage statistics
Configuration of an MCP server endpoint
Configuring an MCP server endpoint in VS Code
Integration of Test with Measure
Configuring a webhook for Measure
Adding additional parameters for test runs
Test Author Guide
Edit branch overview
Test Editor overview
Test navigator panel
Test Editor page
Suite Editor page
Application management
Creating an application
Modifying application components
Web UI test management
Web UI test creation
Recording a Web UI test
Creating a Web UI test by using the empty test option
Test creation with Test Genie
Creating a Web UI test with Test Genie
Modifying a Web UI test created by using Test Genie
Running a Web UI test
Accessing the console output
Viewing step-level results and updating tests
Stopping a test run
Modification of Web UI tests
Editing a Web UI test
Adding user actions in a test from smartshots
New test steps from the General catalog
Adding an Assign step
Adding a Log step
Adding a Wait step
Adding a Verify step
New steps for UI-related actions and user actions in a test from the UI catalog
Adding a With step
Adding an Open step
Adding a Click step
Adding a Select step
Adding a Type step
Adding a Press step
Adding conditional logic and redefining the flow in tests from the Flow catalog
Adding a Run step
Adding a Fail step
Adding an If step
Adding a While step
Adding a Do-While step
Adding a drag-and-drop action in a test from a smartshot
Disabling test steps
Configuring timeouts for tests and test steps
Copying test steps from one test to another
Renaming a test asset
Deleting a test asset
Creating a test module from an existing set of steps
Viewing test assets exported from DevOps Test UI
Test suite management
Creating a suite
Modifying a suite
Running a suite sequentially
Running a suite concurrently
Running multiple suites or tests by using the wildcard pattern
Running suites on multiple browsers and devices
Accessing the console output
Stopping test runs within a suite
Rerunning failed tests in a suite
Deleting a suite
Test variables
Creating and assigning test variables
Assigning an object property to a test variable
Adding an Assign step
Assigning test variable values from a dataset by using the Run step
Configuring test variables in the Run step of a test or suite
Creating a dataset by using test variables
Editing a dataset in Test Editor
Multiple datasets in tests and test suites
Assigning test variable values from multiple datasets by using the Assign step
Assigning test variable values from multiple datasets by using the Run step
Test environments
Creating an environment
Modifying an environment
Catalog management
Basic generators
Parameters of the Address generator
Parameters of the Boolean generator
Parameters of the Dataset generator
Parameters of the DateTime generator
Parameters of the Enumerator generator
Parameters of the Function generator
Parameters of the Name generator
Parameters of the Number generator
Parameters of the Phone generator
Parameters of the Regex generator
Parameters of the String generator
Parameters of the Text generator
Parameters of the UUID generator
Management of custom generators
Creating a custom generator
Creating custom generators and categories from Data definitions
Modifying custom generators
Deleting custom generators
Management of custom categories
Creating a new custom category
Deleting custom categories
Data management
Data navigator panel
Prerequisites for working with datasets and data definitions
Management of classifications
Creating a classification
Editing a classification
Deleting a classification
Granting access to classification
Management of database connections
Adding a database connection
Adding a database connection to a classification
Removing a database connection from a classification
Editing a database connection
Duplicating a database connection
Deleting a database connection
Management of database query
Creating a database query
Editing a database query
Duplicating a database query
Deleting a database query
Management of datasets
Creating a dataset
Creating a dataset by using a CSV file
Creating a dataset by using a Data definition
Creating a dataset by using a database query
Editing a dataset
Dataset encryption
Encrypting a dataset column
Decrypting a dataset column
Viewing a dataset
Deleting a dataset
Viewing an encrypted dataset
Changing classification for an encrypted dataset
Managing an encrypted dataset
Adding an encrypted dataset to a classification
Moving an encrypted dataset to another classification
Removing a dataset from the classification
Management of data definition
Creating an empty data definition
Creating a data definition by importing fields from a CSV file
Creating a data definition by importing fields from a dataset
Creating a data definition by importing fields from a database query
Saving a data definition by adding basic generators with their default settings
Saving a data definition by adding basic generators with their modified settings
Modifying a data definition
Viewing a data definition and its details
Deleting a data definition
Management of schemas
Creating an empty schema
Adding a database connection to the schema
Creating a schema by using a database connection
Managing data definitions in a schema
Auto-assigning generators and AI-provided data configurations to data definitions in the Schema View
Deleting a schema
Publishing changes in data definitions, datasets, or schemas
Generating fabricated test data
Generating standard test data by using data definitions and exporting it to a .zip file
Generating negative test data for a data definition
Generating test data by using data definition history
Generating and exporting schema-based test data to a .zip file
Generating test data by using data definitions or schema and exporting it to a database
Publishing all changes in an Edit branch
Test Execution Specialist Guide
System modeling
Task flows for working with a system model
Adding a repository to a team space
Creating a system model
Creating components
Creating child components
Creating linkages between components
Deleting linkages between components
Modifying components
Deleting components
Publishing changes to the system model
Associating resources with components
Viewing resources that are associated with components
Removing resources that are associated with components
Publishing changes of associating or dissociating resources with components
Viewing the system model
Deleting a system model
Deleting a repository from a team space
Prerequisites to running tests
Test run considerations for AFT Suites or Functional tests
Test run considerations for API Suites or API tests
Test run considerations for browser-based Web UI tests
Test run considerations for JMeter tests
Test run considerations for JUnit tests
Test run considerations for using Machine learning capabilities
Test run considerations for Postman tests
Test run considerations for schedules
Test run considerations for Selenium tests
Test run considerations for using mobile device clouds
Management of agents
Management of performance agents
Connecting a Docker performance agent to Test
Test run considerations for running tests on remote performance agents
Viewing performance agents that are registered with DevOps Test
Adding a performance agent to a project
Working with the capabilities of a performance agent
Management of API agents
Considerations for running virtual services on remote API agents
Viewing API agents that are registered with DevOps Test
Adding an API agent to a project
Removing an API agent from a project
Unregistering a remote API agent from DevOps Test
Management of DevOps Test Runtime agents
Installing and registering DevOps Test Runtime agents
Viewing agents that are registered with DevOps Test
Adding an agent to a project
Removing an agent from a project
Unregistering a remote agent from DevOps Test
Management of the personal agent
Installing and starting the personal agent
Stopping or unregistering the personal agent
Management of remote Kubernetes clusters
Considerations for using a remote Kubernetes cluster
Registering a remote Kubernetes cluster
Viewing remote Kubernetes clusters
Adding a remote Kubernetes cluster to a project
Editing configurations of a remote Kubernetes cluster
Removing a remote Kubernetes cluster from a project
Unregistering a remote Kubernetes cluster from a team space
Management of cloud credentials
Adding cloud credentials of mobile device clouds
Adding cloud credentials of AI providers
Adding authorized users to a cloud credential
Viewing details of cloud credentials
Editing details of cloud credentials
Removing authorized users from a cloud credential
Deleting an existing cloud credential
Test run configurations
Configuring a Suite or test for a quick run
Configuring an AFT Suite run
Configuring an AFT Suite to run on a mobile device by using variables
Configuring an AFT Suite to run on a mobile device by using a cloud credential
Configuring an API Suite or an API test run
Configuring a run of a Compound Test that contains HTML tests
Configuring a run of a Compound Test that contains mobile tests to run by using variables
Configuring a run of a Compound Test that contains mobile tests to run by using a cloud credential
Configuring a run of a Compound Test that contains Web UI tests
Configuring a run of a Compound Test that contains Web UI tests to run by using variables
Configuring a run of a Compound Test that contains Web UI tests to run by using a cloud credential
Configuring a run of a Compound Test that contains performance tests
Configuring a run of a mobile test to run by using variables
Configuring a run of a mobile test to run on a mobile device by using a cloud credential
Configuring a run of a Performance test
Configuring a run of a Web UI test
Running server test assets
Running server test assets on an agent
Running server test assets by using a cloud credential
Running server suite assets
Running server suite assets by using a cloud credential
Configuring a run of an SAP GUI test
Configuring a run of a Web UI test to run by using variables
Configuring a run of a Web UI test to run by using a cloud credential
Configuring a run of a Windows test
Configuring a run of a JMeter test
Configuring a run of a JUnit test
Configuring a run of a Postman test
Configuring a run of a Rate Schedule or VU Schedule
Configuring a run of a Selenium test
Configuration of test runs in a GitHub Actions Workflow
Prerequisites to run tests in a GitHub Actions Workflow
Configuring a test run in a GitHub Actions Workflow
Configuration of a scan of an application code
Considerations to scan an application code
Configuring a run to scan the application code
Management of running tests
Viewing the state of test assets
Viewing the progress of running test assets
Checking logs
Resetting the configuration settings for a test run
Stopping test runs
Canceling scheduled test runs
Management of virtualized services
Prerequisites for running HTTP virtual services
Prerequisites for running HTTP virtual services in a Kubernetes cluster
Setting up intercepts
Viewing intercepts that are registered with a team space on DevOps Test
Viewing virtual service resources
Configuring a run of a virtual service
Additional configuration parameters for virtual services
Running HTTP virtual services in Kubernetes cluster without using proxies
Viewing running instances of virtual services
Viewing configurations of running instances of virtual services
Modifying configurations of running instances of virtual services
Viewing routing rules of the virtual services
Viewing usage statistics of virtual services
Stopping virtual services
Test results
Test results and reports
Creating search queries to filter test results
Comparing test reports
Viewing trending reports
Viewing a Functional Report
Navigating to a test, suite, or step from the functional report
Re-executing tests from results
Test results data in Grafana
Installing and configuring the DevOps Test Hub Results Data plugin
Viewing test results data in Grafana
Viewing Surefire format reports
Test logs
Viewing test logs after you start a test run
Viewing test logs after the test run is completed
Test log details
Test log queries
Configuring and running log queries
Adding additional properties in test results
Machine learning capabilities in DevOps Test
Viewing Machine learning insights
Interpretation of insights
Viewing Machine learning analyzers
Interpretation of parameter analysis
Viewing reactions marked by members to Machine learning insights
Modifying Machine learning analyzer settings
Deleting Machine learning insights
Rerunning Machine learning (ML) analysis
Resource monitoring
Resource monitoring capabilities
Monitoring an NGINX server
Monitoring an Apache httpd server
Monitoring metrics collected by a Prometheus server
Monitoring metrics exposed by an OpenMetrics exporter
Monitoring a Java Virtual Machine
Monitoring a Windows Performance host
Monitoring a Linux Performance host
Resource monitoring agents
Installing and running a Docker agent on a remote host
Installing and running a Java agent on a remote host
Starting a resource monitoring Java agent as a service on Windows
Starting a resource monitoring Java agent as a service on Linux
Starting a Java Virtual Machine
Managing sources
Creating labels
Controlling resource monitoring sources in a schedule
Collecting and viewing resource monitoring usage data
Configuring a test
Viewing resource monitoring usage data
Viewing resource monitoring usage data on Grafana
Creating queries for resource monitoring usage data
Configuration of a change management
Configuration of Atlassian Jira as a change management
Configuring Jira as a change management
Creating Jira issues for the test results
Viewing details of the Jira issues
Managing the Jira configuration
Configuration of Azure DevOps as a change management
Configuring Azure DevOps as a change management
Creating Azure DevOps work items
Viewing details of the Azure DevOps work items
Managing the Azure DevOps configuration
Configuration of DevOps Plan as a change management
Configuring DevOps Plan as a change management
Creating work items
Viewing details of the work items
Managing the DevOps Plan configuration
Integrations with other applications
Integration plugin compatibility matrix
Integration with Azure DevOps
Task flow for integrating DevOps Test with Azure DevOps
Installing the IBM DevOps Test Hub extension
Running DevOps Test tests in an Azure DevOps Pipeline
Integration with IBM DevOps Deploy
Installing the DevOps Test Hub Deploy plugin
Using a custom trust store for IBM DevOps Deploy
Creating a component in IBM DevOps Deploy
Creating a process in IBM DevOps Deploy
Configuring the process in IBM DevOps Deploy
Creating a resource in IBM DevOps Deploy
Configuring the resource in IBM DevOps Deploy
Creating an application in IBM DevOps Deploy
Configuring the application in IBM DevOps Deploy
Running tests from IBM DevOps Deploy
Integration with IBM Engineering Test Management
Task flow for integration of IBM Engineering Test Management
Adding the adapter files to IBM Engineering Test Management
Configuring IBM Engineering Test Management on DevOps Test
Preparing test cases in IBM Engineering Test Management
Running tests from IBM Engineering Test Management
Deleting an IBM Engineering Test Management adapter
Integration with Jenkins
Task flows for running test assets from Jenkins
Installing the Test Jenkins plugin
Using a custom trust store
Configuring the Freestyle project
Creating a pipeline script from Jenkins
Configuring the Pipeline project by using the sample script
Configuring the Pipeline project by using the script from SCM
Running tests from Jenkins
Integration with Xray test management for Jira
Generating API keys for the Xray app in Jira
Configuring the Xray integration
Selecting a Jira Xray issue to export test results
Managing the Xray configuration
Access management for DevOps Test
Creating an offline user token in DevOps Test
Deleting an offline user token in DevOps Test
Working with DevOps Test REST services
Running APIs in command line
Test Manager Guide
Managing team spaces
Viewing team spaces
Adding members to a team space
Modifying the configuration of a team space
Viewing the configuration of a team space
Becoming a team space member
Managing members and their roles in a team space
Deleting a team space
Managing DevOps Test projects
Working with projects in a team space
Repository considerations for a server project
Creating a project
Adding repositories to a server project
Secrets configuration
Adding users to a project
Viewing active projects
Changing the visibility configuration of a project
Becoming a project member
Managing access to the server projects
Archiving or unarchiving server projects
Deleting server projects
Project overview
Managing repositories
Adding repositories to a server project
Updating the authentication credentials of the repository
Deleting a repository
Refreshing repositories manually
Selecting the global branch in a project
Creating webhooks
Protecting API test assets by using secrets
Creating a secret in a classification
Granting access to members or member roles
Managing secrets
Notification Management
Managing in-app notifications
Viewing in-app notifications
Managing email notifications
Configuring an SMTP server to manage email notifications
Configuration of a webhook
Webhooks overview
Configuring a webhook template
Configuring a server webhook
Configuring a team space webhook
Configuring a project webhook
Managing the webhook template configuration
Managing the webhook configuration
Enabling a webhook
Management of events
Troubleshooting
Troubleshooting issues
Failed to install DevOps Test Runtime on Windows 11 25H2
Failed to load the extension in Google Chrome while recording
Release
Introduction to releases and pipelines
Home page
Tutorials
Create a value stream
Introduction to value streams
Configure the tutorial system
Lesson 1 Create a value stream
Lesson 2 Customizing value streams
Lesson 3 Providing data to value streams
Lesson 4 Controlling data
Lesson 5 Displaying data
Summary
Linking value stream tools
Introduction
Configure the tutorial system
Lesson 1 Create a value stream
Lesson 2 Integrating Jira projects
Lesson 3 Integrating GitHub
Lesson 4 Controlling data
Summary
Implementing custom metrics
Introduction
Configure the tutorial system
Lesson 1 Defining a custom metric
Lesson 2 Uploading the metric definition
Lesson 3 Creating a metric record
Lesson 4 Adding charts to dashboards
Summary
Integrating Jira, GitHub, and Jenkins in Measure
Lesson 1: Integrating with Jira
Lesson 2: Integrating with GitHub
Lesson 3: Integrating with Jenkins
Lesson 4: Creating the value stream
Lesson 5: Configuring the value stream
Lesson 6: Setting up the build and deployment jobs in Jenkins
Lesson 7: Adding a Jenkins application in the pipeline
Lesson 8: Visualizing the movement of dots in the value stream
Integrating Jira, GitHub, Jenkins, and DevOps Deploy in Measure
Lesson 1: Integrating with Jira
Lesson 2: Integrating with GitHub
Lesson 3: Integrating with Jenkins
Lesson 4: Integrating with DevOps Deploy
Lesson 5: Creating the value stream
Lesson 6: Configuring the value stream
Lesson 7: Setting up the build jobs in Jenkins
Lesson 8: Adding a Jenkins application in the pipeline
Lesson 9: Adding DevOps Deploy environments to the pipeline
Lesson 10: Visualizing the movement of dots in the value stream
Administering
Configuring Measure
Configuring an email server
Configuring calendar settings
Configuring security settings
Roles and permissions
Managing users and authentications
Managing users
Authenticating users with LDAP
Copying DevOps Deploy LDAP
Authenticating users with OIDC
Creating a header-based SSO authentication integration
Managing user groups
Managing teams
Managing passwords
Changing the Administrator password
Retrieving the RabbitMQ password in Kubernetes
Retrieving the RabbitMQ password in OpenShift
Managing user access keys
Configuring log level settings
Configuration of data retention policy
Adding data retention policy
Managing data retention policy
Viewing the execution history of the data retention policy
Measure MCP Server - Tech Preview
Prerequisites to connect with the MCP server in Measure
Connecting to the DevOps Velocity MCP server in Claude Desktop
Connecting to the Measure MCP server by using GitHub Copilot in Visual Studio Code
Releasing Software
Managing a release
Managing releases
Creating releases
Archiving releases
Events and tags
Restoring archived releases, plans, and templates
Deployment plans
Managing deployment plans
Creating deployment plans
Importing tasks into deployment plans
Copying deployment plans
Managing deployment plan templates
Archiving deployment plans
Running deployments
Starting deployments manually
Resolving tasks
Importing tasks into deployment plans
Running scheduled deployments
Tasks
Managing tasks
Creating tasks
Managing task dependencies
Creating task groups
Managing task groups
Managing task tags
Creating run another plan tasks
Creating run another plan tasks: Example
Creating delay tasks
Creating email tasks
Creating header/note tasks
Creating Jenkins (Legacy) tasks
Creating manual tasks
Creating run shell script tasks
Creating ServiceNow tasks
Creating ServiceNow task using Service Now plug-in
Creating DevOps Deploy tasks
Creating Ansible tasks
Creating wait for approval tasks
Properties
Creating properties
Using properties
Extending Product Functions
Introducing plugins
Preventing plugins installs in unsupported server versions
Creating integrations
Plugins integration example
Managing integrations
Defining an initial sync date for plugins
Archiving integrations
Upgrading and downgrading integrations
Creating plugins
Managing native integrations
Managing DevOps Deploy integrations
Managing Jenkins integrations
Integrating with ServiceNow
Migrating integrations
Migrating integration of Jenkins (Legacy) to Jenkins
Migrating integration of UrbanCode Deploy (Legacy) to DevOps Deploy
Uploading a build to a pipeline
Uploading deployment status
Getting started with GraphQL in Measure
How to
Creating reports
Sharing reports
Glossary
Deploy
Getting Started
Overview of DevOps Deploy
Systems and topology overview
Elements overview
Learning
Tutorials
Beginner tutorials
Create a simple helloWorld deployment
Introduction
Configure the helloWorld tutorial system
Lesson 1 Create the helloWorld component
Lesson 2 Create a component process
Lesson 3 Create an application
Lesson 4 Configure an application environment
Lesson 5 Create an application process
Lesson 6 Deploy the component
Summary
Intermediate tutorials
Deploying a simple web application
Introduction
Configuring the agent and target system
Lesson 1: Adding components
Lesson 2: Creating component processes
Lesson 3: Creating an application and an environment
Lesson 4: Creating an application process
Lesson 5: Deploying the application components
Lesson 6: Updating the application
Summary
Creating and deploying snapshots
Introduction
Configuring the server and target system
Lesson 1: Adding snapshots
Lesson 2: Creating an environment
Lesson 3: Deploying the snapshots
Summary
Advanced tutorials
Blue-green deployments
Introduction
Configuring the tutorial system
Lesson 1 Define resources
Lesson 2: Preparing the application
Lesson 3: Create the application process
Lesson 4: Deploying the application
Summary
How-tos
How-to: Deploy applications by using REST commands
How-to: Export and import elements with YAML configuration
How-to: Integrate MS Teams
Teams message card templates
How-to: Integrate Slack
Slack message layout templates
Video and learning resources
Installing an external agent for Deploy in DevOps Loop
Integrating
Connecting to clouds through DevOps Deploy
Configuring virtual system pattern-based clouds
Integrating with IBM Rational Asset Manager
Enabling the DevOps library
Integrating with DevOps Test Workbench
Administering
Backup and recover
Backing up the server
Restoring a backup
High availability and failover
High availability overview
High-availability server processes
High-availability agent communication
Setting up high-availability clusters
Setting up clusters of servers
Adding servers to clusters
Converting a stand-alone server to high availability
Adding cold standby servers
Server settings and configuration
Increasing the amount of memory that is available to the server
Modifying the context root of the server
Management of maintenance blackouts
Creating recurrence maintenance blackouts
Updating maintenance blackouts
Enabling maintenance mode
Canceling maintenance blackouts
Changing the database password
Changing passwords for the server KeyStore
Changing passwords for the encryption KeyStore
Changing passwords for the Tomcat keystore
Changing or updating the JRE of servers
Working with Notifications
Creating Notifications in a Notification Scheme
Managing locks
System settings
Setting your profile
Managing the teams and users for your account
Setting the user preferences
Agents and agent relay configuration
Agent security and communication
Web agent configuration
Web agent communication
Web agent relay configuration
Managing agents remotely
Managing Java packages on an agent
Managing Java packages on agents in bulk
Updating the JRE location for agents
Creating and managing agent pools
Migrating agents to Web
Removing and reinstalling agents as Windows services
Setting agent properties
Updating the JRE location for agent relays
Changing passwords for the agent relay keystores
Managing agent relays remotely
Migrating agents relays to Web
Licensing
License scenarios
Mixed mode licensing
Applying licenses to servers and agents
Tracking agent usage
Configuring the AI settings
Setting up the wizard for new users
Customizing the table views
Managing data
Migrating Codestation from filesystem repositories to S3 repositories
Archiving version artifacts to Amazon S3
Relocating CodeStation
Caching artifacts on agent relays
Releasing VC LOB space
Releasing LOB space in Oracle databases
Releasing LOB space in MySQL or Maria databases
Releasing LOB space in Microsoft SQL Server databases
Releasing LOB space in DB2 databases
Scanning and removing orphaned Codestation blob files
Cleaning up targets
Creating a rotating audit log file
Cleaning up deployment history files
Cleaning up component versions
Cleaning up snapshots
Cleaning up generic process history files
Cleaning up process step log files
Configuring bulk cleanup settings
Managing Security
Guidelines for setting up server security
SSL configuration
Enabling server identity verification
Supported TLS and SSL protocols and ciphers
Enforcing the use of a security protocol or set of ciphers
Configuring SSL on Apache Tomcat and LDAP servers
Implementing custom trust stores
Upgrading encryption key strength
Keystores configuration
Certificate Expiration Enforcement and Auto-Rotation
Automatic rotation of agents certificate
Enforcing certificate expiration and setting certificate validity
Encryption key tools
Creating an encryption key
Rotating an encryption key
Deleting an encryption key
Authorization realms
Creating an internal storage authorization realm
Creating an LDAP authorization realm
Creating an SSO authorization realm
Creating an OpenID Connect authorization realm
Creating a security group
Adding users to groups manually
Authentication realms
Creating authentication realms
Creating users manually
Importing LDAP users
Updating LDAP users and groups
Editing user information manually
Locking and deleting user accounts automatically
Enforcing a maximum login duration
Roles and permissions
Creating roles and assigning permissions
Setting server configuration security
Permission reference
Permissions reference for using application templates
Secret stores
Adding Vault AppRoles to the Deploy secret store
Adding Vault LDAP users to the Deploy secret store
Adding Vault certificate to the Deploy secret store
Vault integration test
Testing Vault AppRole integration
Testing Vault LDAP integration
Testing Vault certificate integration
Secret store property usage
Security teams
Creating a team
Assigning users to teams
Mapping teams to objects
Assigning teams to objects
Security types
Creating security types
Tokens
Restricting authentication tokens
Token expiration settings
Updating the agent relay authentication token password
FIPS mode enablement
Enabling FIPS mode on server
Enabling FIPS mode on compact agents
Enabling FIPS mode on non-compact agents
Enabling FIPS mode on agent relays
Modeling Software Deployment
Dashboard
Components
Creating components
Getting started with creating components
Creating components from the file system
Creating components from a nonversioned file system
Creating components from a versioned file system
Creating components from source-code management systems
Creating components from Git
Creating components from Subversion
Creating components from ClearCase
Creating components from Microsoft Team Foundation Server SCM
Creating components from build integration tools
Creating components from DevOps Build
Creating components from Apache Maven
Creating components from Microsoft Team Foundation Server
Creating component versions with the command-line client
Creating z/OS component versions
Creating z/OS component versions from JCL
Creating z/OS component versions from z/OS UNIX System Services
Creating z/OS component version using the v2 package format
Linked versions in z/OS components
Creating z/OS component linked versions
Merging z/OS component versions
Importing components
Exporting components
Component processes
Importing specific component processes
Exporting specific component processes
Component versions
Tracking environment inventory for components
Importing versions manually
Deleting versions
Downloading component version artifacts
Adding links to component version
Component properties
Creating component manual tasks
Component templates
Creating component templates
Importing component templates
Exporting component templates
Component template properties
Using component templates
Component change logs
Deleting components
Resources
Getting started with creating resources
Modifying the resource tree
Creating groups
Creating agent-type and agent pool-type resources
Creating component-type resources
Adding agents to resource groups
Moving and copying resources
Deleting resources
Deleting resources from the Recycle Bin
Restoring the resources from the Recycle Bin
Comparing and synchronizing resources
Synchronizing resources from a template
Adding resources from a template
Importing resources from WebSphere Application Server
Importing resources from WebSphere Portal
Defining default user impersonation credentials
Resource templates
Creating resource templates
Defining a new template from the resource tree
Agents
Compact agents
Compact agent changes: Summary
Agent executable command-line commands
Agent metadata
Agent relays
Applications
Getting started with creating applications
Creating applications
Importing applications
Sharing secured properties among servers
Exporting applications
Rational Team Concert Build
Build System Toolkit
Application environments
Creating environments
Creating environments from WebSphere Application Server cells
Deployment triggers
Creating deployment triggers
Environment gates
Creating environment gates
Mapping resources and components to environments
Comparing environments
Application templates
Creating application templates
Creating applications from application templates
Creating environment templates
Exporting application templates
Importing application templates
Application processes
Importing specific application processes
Exporting specific application processes
Application blueprints
Creating application blueprints
Application pipelines
Managing pipelines
Executing pipelines
Snapshots
Creating snapshots
Deploying snapshots
Comparing snapshots
Previewing snapshots
Importing and exporting snapshots
Viewing snapshot history
Manual application tasks
Approval process
Creating an approval process
Managing an external approval process
Responding to approval requests
Inventories
Environment inventory and compliance
Managing environment inventory and compliance
Viewing resource configuration inventories
Processes
Process step types and logic
Conditional processes
Switch steps
Pausing a process
Branching and joining steps
Process step properties
Process step preconditions
Adding deployment warnings
Post-processing scripts
Storing reusable post-processing scripts
Examples of post-processing scripts
Component processes
Component process types
Creating component processes
Running component processes
Creating configuration files in component processes
Application processes
Creating application processes
Deploying components in an application process
Running application processes
Running the same process again
Uninstalling components with an application process
Rolling back to a snapshot
Rolling back components that fail to deploy
Modeling blue-green, rolling, and canary deployments
Generic processes
Importing and exporting generic processes
Editing processes
Working on processes in safe edit mode
Running processes
Adding process properties
Copying process steps
Manage process step authentication
User impersonation for process steps
Impersonation on Linux and UNIX systems
Impersonation on Windows systems
Impersonation on z/OS systems
Process steps: Reference
Acquire Lock
Add Inventory Status
Apply Configuration
Apply to Live Configuration
Compare with Live Configuration
Finish
For Each Agent
For Each Tag
Install Component
Install Multiple Components
Inventory Update
Join
Lock Snapshot
Manual Application Task (Utility)
Note
Operational component processes
Release Lock
Remove Inventory Status
Rollback Component
Rollback Multiple Components
Run Component Process
Run Generic Process
Run Generic Process for Each Affected Resource
Run Operational Process for Multiple Components
Run Process for Each Version
Set Status
Switch
Uninstall Component
Uninstall Multiple Components
Update from Live Configuration
Statuses
Creating statuses
Adding version statuses
Adding snapshot statuses
Properties
Creating, setting, and editing properties
Property contexts
Referring to properties
Default properties
Output properties
System properties
Property availability
Tags
Creating tags
Adding tags to objects
Grouping servers by using tags
Component tags
Webhooks
Managing webhook template
Adding webhooks to process
Deploying
Getting started with running deployments
Deploying applications
Deploying components to the z/OS platform
Ship list files
Deploying by using the Job Monitor
Job Monitor customization
Searching the z/OS environment inventory
Scheduling deployments
Canceling stalled deployments
Reporting
Deployment reports
Security reports
Setting up recurring reports
Saving and printing reports
Saving report filters
Monitor operating details
Extending Product Function
Plug-ins
Installing plug-ins
Installing plug-ins from the plug-in site
Installing plug-ins from the Web UI
Creating plug-ins
The plugin.xml file for automation plug-ins
The header element
The plugin-javaopts.conf file
Creating source plug-ins
Plug-in steps: The step-type element
Step properties: the properties element
Plug-in step icons
The command element
The post-processing element
Upgrading plug-ins
The info.xml file
Automatically importing objects from plug-ins
Example plug-in
Step properties
Step commands
create_file.groovy
Creating notification templates
Parameters for notification templates
Command-line client (CLI) reference
Installing the command-line client
Command format
CLI Commands
addAgentPoolToTeam
addAgentServerPin
addAgentToPool
addAgentToTeam
addApplicationToTeam
addComponentResourcePropDef
addComponentTemplateToTeam
addComponentToApplication
addComponentToTeam
addEnvironmentBaseResource
addEnvironmentProperty
addEnvironmentToTeam
addGroupToTeam
addJavaPackage
addPostProcessingScriptToTeam
addProcessToTeam
addResourceToTeam
addStatusToSnapshot
addTagToAgent
addTagToApplication
addTagToComponent
addTagToResource
addUserToGroup
addUserToTeam
addVersionFiles
addVersionLink
addVersionLinkWithName
addVersionStatus
addVersionToSnapshot
addWebhookToApplication
addWebhookToApplicationWithCredentials
addWebhookToProcess
addWebhookToProcessWithCredentials
addZInventoryEntries
archiveVersion
autoDiscoverResource
bulkAddAgentServerPin
bulkGetAgentJavaHomes
bulkGetPreferredJavaPackageForAgent
bulkInstallAgentJava
bulkRemoveAgentServerPin
bulkSetAgentJavaHome
bulkSetAgentKeypairPolicy
bulkUninstallAgentJava
cancelApplicationPipelineExecution
cancelApplicationProcessRequest
cancelComponentProcessRequest
cancelMaintenanceBlackoutSeries
cancelMaintenanceBlackoutSeriesEvent
cancelProcessRequest
cancelScheduledDeploymentSeries
cancelScheduledDeploymentSeriesEvent
cancelServerKeystoreImportTask
cancelWorkflow
closeTask
completeServerKeystoreImportTask
copyResource
copyVersion
createAgentPool
createApplication
createApplicationFromTemplate
createApplicationPipeline
createApplicationProcess
createApplicationTemplate
createAuthToken
createAuthenticationRealm
createAuthorizationRealm
createBlueprintDesignerIntegration
createComponent
createComponentProcess
createComponentTemplate
createDeploymentTrigger
createEnvironment
createEnvironmentFromTemplate
createEnvironmentTemplate
createGenericProcess
createGroup
createMaintenanceBlackout
createManyVersions
createPostProcessingScript
createResource
createResourceTemplate
createResourceTemplateWithAgentPrototypes
createSnapshot
createSnapshotOfEnvironment
createStatus
createTeam
createUser
createVaultAppRole
createVaultCertificate
createVaultLdapUser
createVaultSecretStore
createVersion
createWebhookTemplate
deleteAgent
deleteAgentPool
deleteAgentProperty
deleteAllDesiredInventoryVersions
deleteApplication
deleteApplicationPipeline
deleteApplicationProcess
deleteApplicationTemplate
deleteAuthenticationRealm
deleteAuthorizationRealm
deleteBlueprintDesignerIntegration
deleteComponent
deleteComponentVersionPropDef
deleteDeploymentTrigger
deleteEnvironment
deleteEnvironmentGate
deleteEnvironmentTemplate
deleteEnvironmentTemplateGate
deleteFrontendServer
deleteGroup
deleteJavaPackage
deleteMaintenanceBlackout
deletePostProcessingScript
deleteRedundantDesiredInventoryVersions
deleteResource
deleteResourceProperty
deleteResourceRoleProperty
deleteSecretStore
deleteServerKeystoreEntry
deleteSnapshot
deleteStatus
deleteTeam
deleteUser
deleteVaultAppRole
deleteVaultCertificate
deleteVaultLdapUser
deleteVersion
deleteWebhookTemplate
downloadJavaPackage
downloadVersionArtifacts
executeApplicationPipeline
exportApplication
exportApplicationProcess
exportComponent
exportComponentProcess
exportComponentTemplate
exportComponentTemplateProcess
exportDetailedGroup
exportGenericProcess
exportGroup
exportSnapshot
finishedImporting
forceCancelWorkflow
forceRenameAgent
forgetAgentCert
getAgent
getAgentJavaHomes
getAgentMaintenanceTask
getAgentMaintenanceTasks
getAgentPool
getAgentPools
getAgentProperty
getAgentPrototypes
getAgentStatuses
getAgents
getAllApplicationProcessesForApplication
getAllComponentProcessRequestCount
getAllComponentsForTemplate
getAllLatestDesiredInventory
getAllProcesses
getAllTeams
getAllUsersInRoleForTeam
getAllUsersWithEmail
getApplication
getApplicationPipeline
getApplicationPipelineExecution
getApplicationPipelineExecutions
getApplicationPipelines
getApplicationProcess
getApplicationProcessExecution
getApplicationProcessRequest
getApplicationProcessRequestProperties
getApplicationProcessRequestStatus
getApplicationProcessRequestVersions
getApplicationProcessUnfilledProperties
getApplicationProperties
getApplicationProperty
getApplicationTemplate
getApplicationTemplatePropDefs
getApplicationTemplates
getApplications
getApplicationsProcessRequests
getApplicationsProcessRequestsCount
getApprovalTasks
getAuthToken
getAuthTokens
getAuthTokensForUser
getAuthenticationRealm
getAuthenticationRealms
getAuthorizationRealm
getAuthorizationRealms
getAvailablePlugins
getBlueprintNodePropertiesTemplate
getBlueprintsInApplication
getComponent
getComponentEnvironmentProperties
getComponentProcess
getComponentProcessRequest
getComponentProcessRequestCount
getComponentProcessRequests
getComponentProperties
getComponentProperty
getComponentTemplatePropDefs
getComponentTemplates
getComponentVersionPropDefs
getComponentVersions
getComponents
getComponentsInApplication
getConfigurableAgentLicenseTypes
getCurrentActivityList
getDatabaseLatency
getDeploymentTrigger
getDeploymentTriggers
getEnvironment
getEnvironmentBaseResources
getEnvironmentCompliancy
getEnvironmentGate
getEnvironmentProperties
getEnvironmentProperty
getEnvironmentResourceTree
getEnvironmentTemplate
getEnvironmentTemplateGate
getEnvironmentTemplatePropDefs
getEnvironmentsInApplication
getExternalApprovalProcess
getExternalApprovalProcesses
getFirstUserWithEmail
getFrontendServers
getHighWatermarks
getInstalledPlugins
getInventoryChangesForSnapshot
getJavaPackage
getJavaPackages
getJavaPackagesForAgent
getLLMVendorModels
getLLMVendors
getLatestDesiredInventory
getLatestSnapshotForEnvironment
getLoggingConfig
getMaintenanceBlackouts
getOpenIDConnectRealms
getOverlappingArtifacts
getPostProcessingScript
getPostProcessingScripts
getPreferredJavaPackageForAgent
getProcessRequest
getProcessRequests
getRelayStatuses
getRelays
getResource
getResourceInventoryEntriesForComponent
getResourceProperties
getResourceProperty
getResourceRoleProperties
getResourceRoleProperty
getResourceTemplate
getResourceTemplateChildren
getResources
getResourcesInRecycleBin
getResourcesWithComponentVersion
getSecretStore
getSecretStores
getServerKeystoreImportTask
getServerKeystoreInfo
getSnapshot
getSnapshotConfiguration
getSnapshotVersions
getSnapshotsInApplication
getStatus
getStatusList
getStatuses
getSystemConfiguration
getSystemProperties
getSystemProperty
getTagsForType
getTagsOnAgent
getTagsOnApplication
getTagsOnComponent
getTagsOnResource
getTasksForUser
getTeam
getUser
getUserByEmail
getUsersThatCanRunDeploymentTriggers
getVaultAppRole
getVaultAppRoles
getVaultCertificate
getVaultCertificates
getVaultLdapUser
getVaultLdapUsers
getVersionId
getVersionLink
getVersionLinks
getVersionProperties
getWebhookTemplate
getWebhookTemplates
getWorkflowTraceLogs
getZOSVersionCumulativeManifest
getZOSVersionDeployManifest
getZOSVersionsWithCommitId
importApplication
importApplicationProcess
importComponent
importComponentProcess
importComponentTemplate
importComponentTemplateProcess
importGenericProcess
importGroup
importLdapUser
importSnapshot
importVersions
installAgent
installAgentJava
installLocalPlugin
installPlugin
listArtifacts
loadEnvironmentCompliancy
lockSnapshotConfiguration
lockSnapshotVersions
lockUser
login
logout
moveResource
pauseWorkflow
prepareServerKeystoreImportTask
previewUserLockEvent
provisionEnvironment
removeAgentFromPool
removeAgentFromTeam
removeAgentPoolFromTeam
removeAgentServerPin
removeApplicationFromTeam
removeComponentFromApplication
removeComponentFromTeam
removeComponentResourcePropDef
removeComponentTemplateFromTeam
removeEnvironmentBaseResource
removeEnvironmentFromTeam
removeEnvironmentProperty
removeGroupFromRoleOnTeam
removeInventoryForUnmappedComponents
removeProcessFromTeam
removeResourceFromTeam
removeTagFromAgent
removeTagFromApplication
removeTagFromComponent
removeTagFromResource
removeUserFromGroup
removeUserFromRoleOnTeam
removeVersionFromSnapshot
removeVersionLink
removeVersionLinkByName
removeVersionStatus
removeWebhookFromApplication
removeWebhookFromProcess
repeatApplicationProcessRequest
requestApplicationProcess
requestProcess
restartAgent
restoreArtifacts
restoreFromRecycleBin
resumeWorkflow
revokeAuthToken
rollbackZInventoryEntries
saveEnvironmentGate
saveEnvironmentTemplateGate
savePostProcessingScript
searchZInventoryEntries
setAgentJavaHome
setAgentKeypairPolicy
setAgentLicenseType
setAgentProperty
setAgentUnavailable
setApplicationProperty
setComponentEnvironmentProperty
setComponentProperty
setComponentVersionPropDef
setEnvironmentProperty
setLoggingConfig
setPreferredJavaPackage
setResourceProperty
setResourceRoleProperty
setSystemConfiguration
setSystemProperty
setVersionProperty
shutdownAgent
testAgent
testVaultAppRole
testVaultCertificate
testVaultLdapUser
uninstallAgentJava
unlockUser
unsetPreferredJavaPackage
updateAgent
updateApplicationPipeline
updateApplicationTemplate
updateApplicationTemplatePropDefs
updateAuthenticationRealm
updateAuthorizationRealm
updateComponent
updateComponentResourcePropDef
updateComponentTemplatePropDefs
updateEnvironment
updateEnvironmentProperty
updateEnvironmentTemplate
updateEnvironmentTemplatePropDefs
updateExternalApprovalProcess
updateMaintenanceBlackout
updateResource
updateResourceTemplate
updateRoleActions
updateTeam
updateUser
updateUsersInAuthRealm
updateVaultAppRole
updateVaultCertificate
updateVaultLdapUser
updateVaultSecretStore
updateWebhookForApplication
updateWebhookForApplicationWithCredentials
updateWebhookForProcess
updateWebhookForProcessWithCredentials
updateWebhookTemplate
upgradeAgent
Process-as-code feature
Using the PAC commands
Understanding the PAC file format
Application process steps
application-run-component-process
apply-configuration
for-each-agent
for-each-resource-tag
install-component
install-multiple-components
join
release-lock
rollback-component
rollback-multiple-components
run-operational-process-for-multiple-components
uninstall-component
uninstall-multiple-components
Core component process steps
add-inventory-status
component-manual-task
component-run-component-process
remove-inventory-status
Generic process steps
add-process-warning
acquire-lock
generic-manual-task
plugin
run-generic-process
run-generic-process-for-each-affected-resource
set-final-process-status
shell
start
switch
DevOps Deploy MCP server
Connecting an MCP client to DevOps Deploy MCP server
Using the DevOps Deploy MCP tools
Deploying a snapshot to an environment with the Deploy MCP server
Troubleshooting and Support
General product troubleshooting
Troubleshooting process overview
General information to collect
Searching online knowledge bases
Contacting IBM Software support
Logging
Viewing logs
Managing loggers
Configuring log rotation settings
Managing the logs
Determining the Java heap memory size
Troubleshooting the DevOps Deploy server and agents
Troubleshooting security and permissions
Troubleshooting agent connections
Troubleshooting agent upgrade from the Web UI
Troubleshooting processes
Troubleshooting plug-ins
Troubleshooting DevOps Deploy when running as a container
Troubleshooting problems on z/OS
Performing AI analysis on failed deployments
Measure
Introduction to releases and pipelines
Home page
Tutorials
Create a value stream
Introduction to value streams
Configure the tutorial system
Lesson 1 Create a value stream
Lesson 2 Customizing value streams
Lesson 3 Providing data to value streams
Lesson 4 Controlling data
Lesson 5 Displaying data
Summary
Linking value stream tools
Introduction
Configure the tutorial system
Lesson 1 Create a value stream
Lesson 2 Integrating Jira projects
Lesson 3 Integrating GitHub
Lesson 4 Controlling data
Summary
Implementing custom metrics
Introduction
Configure the tutorial system
Lesson 1 Defining a custom metric
Lesson 2 Uploading the metric definition
Lesson 3 Creating a metric record
Lesson 4 Adding charts to dashboards
Summary
Integrating Jira, GitHub, and Jenkins in Measure
Lesson 1: Integrating with Jira
Lesson 2: Integrating with GitHub
Lesson 3: Integrating with Jenkins
Lesson 4: Creating the value stream
Lesson 5: Configuring the value stream
Lesson 6: Setting up the build and deployment jobs in Jenkins
Lesson 7: Adding a Jenkins application in the pipeline
Lesson 8: Visualizing the movement of dots in the value stream
Integrating Jira, GitHub, Jenkins, and DevOps Deploy in Measure
Lesson 1: Integrating with Jira
Lesson 2: Integrating with GitHub
Lesson 3: Integrating with Jenkins
Lesson 4: Integrating with DevOps Deploy
Lesson 5: Creating the value stream
Lesson 6: Configuring the value stream
Lesson 7: Setting up the build jobs in Jenkins
Lesson 8: Adding a Jenkins application in the pipeline
Lesson 9: Adding DevOps Deploy environments to the pipeline
Lesson 10: Visualizing the movement of dots in the value stream
Administering
Configuring Measure
Configuring an email server
Configuring calendar settings
Configuring security settings
Roles and permissions
Managing users and authentications
Managing users
Authenticating users with LDAP
Copying DevOps Deploy LDAP
Authenticating users with OIDC
Creating a header-based SSO authentication integration
Managing user groups
Managing teams
Managing passwords
Changing the Administrator password
Retrieving the RabbitMQ password in Kubernetes
Retrieving the RabbitMQ password in OpenShift
Managing user access keys
Configuring log level settings
Configuration of data retention policy
Adding data retention policy
Managing data retention policy
Viewing the execution history of the data retention policy
Measure MCP Server - Tech Preview
Prerequisites to connect with the MCP server in Measure
Connecting to the DevOps Velocity MCP server in Claude Desktop
Connecting to the Measure MCP server by using GitHub Copilot in Visual Studio Code
Managing Value Streams
Creating value streams
Setting up a stage
Customizing value streams
VSM JSON code editor
VSM JSON tree editor
Integrating tools
About value stream integrations
Linking rules
Viewing value streams
Value stream metrics
Displaying the metrics
Customizing metric definitions for Lead Time, Cycle Time, and Dev Cycle Time
Implementing custom metrics
DORA metrics
Milestone-risk estimation
Bottleneck detection
Metrics FAQs
Navigating value streams
Managing swim lanes
DevOps query language
External YAML configuration
Creating YAML configuration file in GitHub repository
Importing YAML configuration file to Measure
Importing YAML configuration file using GitHub plug-in integration
Importing YAML configuration file using user interface
Applying the YAML configuration file to Measure
Pipelines
Managing pipelines
Managing hybrid Continuous Integration (CI) and Continuous Deployment (CD) pipeline
Managing API-driven pipelines
Managing pipeline gates
Running pipeline applications
Running open pipeline deployment
Solution versions
Enabling the solution version feature on Measure
Adding an application to the pipeline
Creating the solution version
Editing the draft solution version
Publishing the draft solution version
Deploying the solution version
Unlinking the solution version
Deleting the solution version
Developing Data Insights
Managing Insights dashboards
Managing dashboards
Creating dashboards and favorites
Analyzing data
Metric chart reference
Lead time, cycle time and dev-cycle time table metrics
Agile Churn metric
Change Failure Rate metric
Flow Efficiency metric
GenAI metrics - Tech Preview
Insights reports
Running insights reports
AppScan Enterprise scan report
Release readiness report
Security report
State of the sprint report
Deployment audit report
Pipeline snapshot report
Releasing Software
Managing a release
Managing releases
Creating releases
Archiving releases
Events and tags
Restoring archived releases, plans, and templates
Deployment plans
Managing deployment plans
Creating deployment plans
Importing tasks into deployment plans
Copying deployment plans
Managing deployment plan templates
Archiving deployment plans
Running deployments
Starting deployments manually
Resolving tasks
Importing tasks into deployment plans
Running scheduled deployments
Tasks
Managing tasks
Creating tasks
Managing task dependencies
Creating task groups
Managing task groups
Managing task tags
Creating run another plan tasks
Creating run another plan tasks: Example
Creating delay tasks
Creating email tasks
Creating header/note tasks
Creating Jenkins (Legacy) tasks
Creating manual tasks
Creating run shell script tasks
Creating ServiceNow tasks
Creating ServiceNow task using Service Now plug-in
Creating DevOps Deploy tasks
Creating Ansible tasks
Creating wait for approval tasks
Properties
Creating properties
Using properties
Extending Product Functions
Introducing plugins
Preventing plugins installs in unsupported server versions
Creating integrations
Plugins integration example
Managing integrations
Defining an initial sync date for plugins
Archiving integrations
Upgrading and downgrading integrations
Creating plugins
Managing native integrations
Managing DevOps Deploy integrations
Managing Jenkins integrations
Integrating with ServiceNow
Migrating integrations
Migrating integration of Jenkins (Legacy) to Jenkins
Migrating integration of UrbanCode Deploy (Legacy) to DevOps Deploy
Uploading a build to a pipeline
Uploading deployment status
Getting started with GraphQL in Measure
How to
Creating reports
Sharing reports
Glossary
Loop Genie overview - Tech Preview
Loop Genie workspace
Interacting with Loop Genie
Loop Genie tasks
Running a predefined task in Loop Genie
Creating or modifying a task in Loop Genie
Prompt references for Loop Genie
Troubleshooting
Troubleshooting DevOps Loop installation and upgrade
Troubleshooting Harbor integration
DevOps Loop pod references to check logs for troubleshooting
Offline Documentation (PDF)
Security Considerations
Notices