DevOps Change Velocity properties
- UpdatedJan 30, 2025
- 11 minutes to read
- Yokohama
- DevOps
Use these properties to configure settings in the DevOps Change Velocity application.
Role required: sn_devops.admin
You can view the properties from the DevOps Change workspace by navigating to System configuration > Properties.
To view the properties from the Classic UI, navigate to All > DevOps > Administration > Properties.
Property | Description | Default | Name |
---|---|---|---|
Maximum retries for errored inbound events | Maximum number of retries for errored inbound events. | 3 | [sn_devops.max_retry_count_inbound_event] |
Tool capabilities | The tool capabilities supported, entered as comma-separated values. | code,plan,orchestration,artifact,test | [sn_devops.tool_capabilities] |
DevOps change request approval text | The DevOps change request approval text to be used for change management customizations. | Approved | [sn_devops.change_request.approved_approval] |
DevOps change request - Apply attributes on change creation |
If enabled, change attributes are applied when a change is created. If there are any data policies applied on the change attributes, they are enforced when the change is created. If this property is not enabled, change attributes are applied after the change is created, which may cause change creation failure if any data policies are present on the change attributes. |
False (disabled) | [sn_devops.change_request.apply_attributes_on_creation] |
Duration of DevOps system health report (in days) | Defaults to the last 7 days, to show system health metrics like inbound events. | 7 | [sn_devops.health_duration_report] |
Enable automatic association of repos to apps on pipeline execution | If enabled, automatically associates repositories to apps and enables track when a pipeline identifies commits of a repository that is not yet associated. Also associates pipelines that are not yet associated to the corresponding app when the repository is already assigned to the app. | Yes (enabled) | [sn_devops.enable_automatic_associations] |
Maximum number of pages to process at a time for an import request | The maximum number of pages that must be processed at a time for an import request. | 10 | [sn_devops.import.max.pages.processing.per_import] |
DevOps change request reusability decision subflow | The subflow that can be called to check if a previously created change can be reused, instead of creating a new one. | sn_devops.change_request_reusability_subflow | [sn_devops.change_request_reusability_decision] |
GitHub URL | For GitHub, this field is used to get the API URL (for REST calls). | https://github.com | [sn_devops.github.url] |
DevOps change request cancel state | DevOps change request cancel state to be used for change management customizations. |
4 (Canceled) |
[sn_devops.change_request.cancel_state] |
Maximum orchestration tool executions while importing | Maximum orchestration tool executions while importing Jenkins freestyle jobs. | 1000 | [sn_devops.import.orchestration_tool.executions.maximum] |
To save payloads as attachments on the Import Request Page record, set the "Value" field to "true". Anything else is considered as false. | If true, the fetched JSON payload is saved as an attachment in the Import Request page. To save payloads as attachments on the Import Request Page record, set the Value field to true. Anything else is considered false. |
False (disabled) | [sn_devops.import.save.payloads.as.attachments] |
DevOps non-admin software quality summary flag | Enable to view and monitor SonarQube scans configured on your GitHub Actions, Jenkins, or Azure DevOps pipelines as a non-admin SonarQube user. | False (disabled) | [sn_devops.non_admin_software_quality_summary_flag] |
Default test type | Default test type from orchestration pipelines. | JUnit |
[sn_devops.default_test_type] |
Coding tool branches per page | Number of coding tool branches per page. | 19 |
[sn_devops.import.coding_tool.branches.per_page] |
Planning tool issues per page | Number of planning tool issues displayed per page. | 100 | [sn_devops.import.planning_tool.issues.per_page] |
sn_devops role to be automatically added to active DevOps users | The sn_devops role entered in the value field is automatically added to users who are active DevOps users (for example, making a commit). If a role that is not in the sn_devops scope is provided, it is not added. Leave empty if no role should be automatically provided. |
sn_devops.viewer | [sn_devops.discovered.user.auto.assign.role] |
Software quality categories shown by default in the Pipeline UI view | The software quality categories shown by default in the Pipeline UI view, entered as comma-separated values. | coverage,lines_of_code,bugs,code_smells,duplications,vulnerabilities | [sn_devops.sq_ui_category_preferences] |
Errors or exceptions (comma separated) for which errorred inbound events are set to Retry | Errors or exceptions for which the errored inbound events are set to Retry. Entered as comma-separated values. | TimeOutException,FlowObjectAPIException | [sn_devops.inbound_events_retry_error_list] |
DevOps log level | The DevOps log level. Select the appropriate level from the following:
|
Warning | sn_devops.devops_log_level |
Categorize DevOps change requests on DevOps Change field | . Select this option to categorize change requests with category field set to DevOps as a DevOps change. Clear to disable. |
False (disabled) | [sn_devops.custom_change_categorization] |
Orchestration tool executions per page | Number of orchestration tool executions per page. | 50 | [sn_devops.import.orchestration_tool.executions.per_page] |
Enable import polling | Option to enable polling of import requests. Clear to disable polling. | False (disabled) | [sn_devops.enable_import_polling] |
GitHub API version path | The GitHub API version path. | /api/v3 | [sn_devops.github.api_version_path] |
Tool permission check timeout per record (in milliseconds) |
During the tool connection process, the system performs permission validations in the foreground, and restricts the tool connection page. For every permission validation, a REST API call is made to external tools to evaluate the availability of the permission. The REST API response time may vary based on your network settings. To avoid delays, you can specify how long the system should wait to get a response from an external tool before marking the permission as an error through this property. |
10000 | [sn_devops.permission_check_timeout] |
DevOps change request reusability model subflow | The DevOps change request reusability model subflow. | sn_devops.devops_reused_model_change_request | [sn_devops.devops_reused_model_change_request] |
Time elapsed (in minutes) | The time elapsed in minutes. The retry job checks for errored inbound events from the time/value specified. | 1440 (7 days) | [sn_devops.inbound_events_error_retry_mins_ago] |
Cancel the change request when the associated stage in the pipeline fails or is canceled |
When this property is enabled and the orchestration task mapped to a certain step in your DevOps pipeline fails or is canceled, the change request associated with that step is also canceled. A change request can be canceled only if it has not already been rejected or is not in the implement or review state at the time of cancellation. |
False (disabled) | [sn_devops.cancel_change_on_pipeline_cancel] |
Cascade delete threshold (recommended foreground limit 1000) | Cascade delete threshold. | 1000 | [sn_devops.cascade_delete_threshold] |
Maximum retries per page while importing | Maximum retries allowed per page while importing data from tools. | 3 | [sn_devops.import.max.retries.per_page] |
DevOps change request post implement state | DevOps change request post implement state to be used for change management customizations. |
0 (Review) |
[sn_devops.change_request.post_implement_state] |
DevOps change request implement state | DevOps change request implement state to be used for change management customizations. | -1 (Implement) | [sn_devops.change_request.implement_state] |
Default committer score | The default committer score. | 50 | [sn_devops.committer.score.default] |
Enable to track GitLab pull (merge) requests. If not enabled, then pull (merge) requests and related events will be ignored. | When this property is enabled, GitLab pull (merge) requests are tracked in DevOps Change Velocity. If disabled, then all merge request events are ignored. | Yes (enabled) | sn_devops.track.gitlab.pullrequests |
Default throttle reset time in minutes from current time | If a tool doesn't support a throttle reset time, the throttle reset time will be considered as the current time plus the value given for this property. | 15 minutes | [sn_devops.throttle.reset.time.default] |
Multiply factor for committer score | The multiplication factor to be used for committer score. | 1 | [sn_devops.committer.score.multiply.factor] |
Auto archive (in months) | The duration after which the table data is to be auto-archived. | 9 | [sn_devops.table_auto_archive_duration] |
Deprecated - Enable debug flag (Use new property DevOps log level) |
DevOps Debug Logger.
Note: This property is deprecated, use the sn_devops.devops_log_level (DevOps log level) property instead. |
Yes (enabled) | [sn_devops.enable_debug] |
Maximum processing time per page while importing (in seconds) | Maximum processing time in seconds, that should be allowed per page while importing data from tools. | 300 | [sn_devops.import.max.processing.time.seconds.per_page] |
Supported webhook capabilities | Webhook capabilities supported by DevOps Change Velocity. | code,plan,orchestration,artifact, test | [sn_devops.supported_webhook_capabilities] |
DevOps change request closed state | DevOps change request closed state to be used for change management customizations. | 3 | [sn_devops.change_request.closed_state] |
Bulk flow timeout (in milliseconds) | Bulk flow timeout in milliseconds. | 60000 | [sn_devops.bulk_flow_timeout] |
GitHub/Bitbucket coding tool commits per page | Number of coding tool commits per page for GitHub and Bitbucket. | 100 | [sn_devops.import.coding_tool.commits.per_page] |
Folder depth |
Retrieves only those orchestration tasks and pipelines which are in folders whose nesting level is less than or equal to the number specified here. Folder Depth is the level of nesting done on folders in Jenkins, which contains the orchestration task and pipelines that you want to discover. For example, if you want to discover orchestration tasks and pipelines for a folder structure that is nested 2 times in your Jenkins environment, you must enter 2 as the value for this property. |
3 | [sn_devops.discover.jenkins.folder.depth] |
DevOps change request handler subflow | If you are using a custom subflow instead of the Default Change Handler subflow in Flow Designer (which is used to populate the change request fields with default values), then you must update this property value to
the new subflow. You can copy the Default Change Handler subflow in Flow Designer and update it according to your organization's needs. For information on the Default Change Handler subflow, see Customizing DevOps flows. For information on copying a subflow, see Copy a subflow. |
sn_devops.default_change_handler_subflow | [sn_devops.change_request_handler_subflow] |
Coding tool repositories per page |
The number of repositories that must be displayed per page when you import repositories after connecting to a tool. The total number of repositories imported is not dependent on this property, but the number of repositories that must be displayed per page from the total number of repositories imported can be specified using this property. For example, if your tool contains 1000 repositories and you specify 100 as the property value, 1000 repositories will be imported of which 100 will be displayed per page in the Import Requests page. When you discover repositories, the number of repositories that must be retrieved per API call in the backend is also dependent on this property value. For a large number of repositories, set a relatively smaller value in this property so that lesser number of repositories are retrieved per call and the system does not time out. |
100 | [sn_devops.import.coding_tool.repos.per_page] |
GitHub API URL | GitHub API URL. | https://api.github.com | [sn_devops.github.api_url] |
ITBM Agile planning tool issues import max limit | Strategic Portfolio Management (SPM) Agile planning tool issues import max limit. | 1000 | [sn_devops.import.planning_tool.itbm.issues.max.limit] |
Assign a universal task and notify to update tool credentials when expired |
Admins and tool owners will be notified (through universal task, email, banner, and field message) on expiry of tool credentials after the credentials have expired. As an admin or tool owner, you can update your tool credentials and connect the tool to prevent any further loss of data. For information on updating tool credentials, see Update third-party tool credentials in DevOps Change Velocity. |
Yes (enabled) | [sn_devops.credential_expiration.notify_on_expiration] |
Number of days before tool credential expiry to assign a universal task and notify (if applicable) |
Set the number of days before tool credentials expiry to send notifications (through universal task, email, banner, and field message) to admins for GitHub tools created with basic authentication. To stop sending proactive notifications, select 0 as the value for this property. For information on updating tool credentials, see Update third-party tool credentials in DevOps Change Velocity. |
3 | [sn_devops.credential_expiration.notify_before_days] |
Number of days to display warning alerts when events were not being received |
Set the number of days to display warning alerts in the Last event received field in the tool record when events were not being received. This only applies for tools which sends data to ServiceNow. The Last event received field in the tool record header and inside the tool record will be highlighted in yellow for warning alerts when the events were not being received. |
2 | [sn_devops.last_event_received.warning] |
Number of days to display critical alerts when events were not being received |
Set the number of days to display critical alerts in the Last event received field in the tool record when events were not being received. This only applies for tools which sends data to ServiceNow. The Last event received field in the tool record header and inside the tool record will be highlighted in red for critical alerts when the events were not being received. |
7 | [sn_devops.last_event_received.critical] |
Enable whether Azure DevOps Run Commits must be determined from the last successful pipeline build |
If enabled, DevOps Change will pick up the last commits, upto a maximum of 2000, created after the last successful pipeline build from Azure DevOps as part of Run Commits. If disabled, only the last 200 commits will be considered for Run Commits. |
No | [sn_devops.enable_ado_bulk_run_commits] |
Enable whether GitHub Run Commits must be determined from the last successful workflow run |
If enabled, DevOps Change will pick up the first 2000 commits after the last successful workflow run in GitHub as part of Run Commits.
Note: Skipped commits are not considered. If disabled, only the last commit will be picked up for Run Commits. |
No | [sn_devops.enable_github_run_commits] |
This property decides whether to create a Generic Connection on configure operation for Azure DevOps | The step to enter the integration user name and password is required to configure webhooks when this property is enabled. | No | [sn_devops.enable_ado_generic_connection] |
Maximum limit for the number of pipelines that can be discovered for an Azure DevOps project | Set the maximum number of pipelines that can be discovered in an import request for an ADO project. If your project has more than 15000 pipelines, then you can try setting this property value to that number and see if the pipelines get discovered. If not, you can reduce the value to a lower number and try to discover. | 15000 | [sn_devops.discover.max.pipelines.ado] |
Update DevOps Change Request States Automatically when Change Receipt is Enabled | Updates the DevOps change request states automatically when change receipt is enabled. If you want to stop the automatic transition of the change request states even when change receipt is turned on, you must disable this property. | Selected (enabled) | [sn_devops.enable_change_receipt_state_transition] |
Switch to this user after token based authentication is successful | If the devops.system user is not available in your ServiceNow instance, use this property to set any other user that has the sn_devops.integration role, which is needed to complete the token authentication. | devops.system | [sn_devops.token_auth.user] |
Maximum limit for the number of times the discover action that exceeds the rate limit will be retried. | Determines the maximum number of times the discover action will be automatically retried after it reaches the rate limit. For example, if the rate interval in Azure DevOps is 5 mins, and you enter a value of 4 here, then after every 5min, the discover action will be retried for 4 times. | 10 | [sn_devops.max_retry_count_discover] |
Enable change request creation even with errors in DevOps data retrieval |
If enabled, when an error occurs in retrieving DevOps data like work items, commits, test summaries, security summaries, etc, the corresponding change request is still created. The data that can be retrieved will still be associated with the change request. For the data that cannot be retrieved, the reason for the error will be notified to the user in the third-party console, and the same information will also be added in the Change Comments field in the Step Execution record and the change Worknotes. |
No (disabled) | [sn_devops.enable_change_creation_with_partial_data] |
Enable state transition from New to Assess when DevOps Change Request Manual Approval Flow is active | If enabled, updates the change request state from New to Assess directly when the DevOps Change Request Manual Approval Flow is active. If you want to stop the automatic transition of the change request state to Assess when the DevOps Change Request Manual Approval Flow is active, you must disable this property. | Yes (enabled) | [sn_devops.enable_change_request_state_transition] |
Change request callback timeout (in minutes) | Set the timeout value in minutes until which the system will try to process a change when an inbound event goes into the waiting state during a pipeline run. After that the pipeline will be aborted. The reason for the error is displayed in your third-party tool's console logs. When a pipeline is cancelled because of callback timeout, the same information is added in the callback record of the corresponding step execution. | 120 minutes | [sn_devops.change_request_callback_timeout] |
Client ID specifier for GitHub App | If you are connecting to GitHub through a GitHub App using OAuth 2.0, you must enter the Client ID prefix (first 3 or more characters of the ID) of your GitHub App as the value of this property. This is to ensure that the right permission checks are run for the GitHub tool connection. | Iv1,Iv2 | [sn_devops.github_oauth_client_id_specifier] |
Default Bitbucket branch used for import request | Specify the default Bitbucket branch name that must be used to create an import request. | master | [sn_devops.bitbucket_default_branch] |
Close code value for a change request completed successfully when the autoCloseChange parameter is enabled. | Enter the close code value for a change request completed successfully when the autoCloseChange parameter is enabled. | successful | sn_devops.change_request.auto_close_successful_code |
Close code value for a change request completed with issues when the autoCloseChange parameter is enabled. | Enter the close code value for a change request completed with issues when the autoCloseChange parameter is enabled. | successful_issues | sn_devops.change_request.auto_close_partial_successful_code |
Close code value for a change request completed unsuccessfully when the autoCloseChange parameter is enabled. | Enter the close code value for a change request completed unsuccessfully when the autoCloseChange parameter is enabled. | unsuccessful | sn_devops.change_request.auto_close_failure_code |