How to Customize the Short Description of ServiceNow Incidents Created by Veeam ONE

KB ID: 4974
Product: Veeam ONE | 13.1
Last Modified: 2026-11-18
mailbox
Get weekly article updates
By subscribing, you are agreeing to have your personal information managed in accordance with the terms of Veeam's Privacy Notice.

Cheers for trusting us with the spot in your mailbox!

Now you’re less likely to miss what’s been brewing in our knowledge base with this weekly digest

error icon

Oops! Something went wrong.

Please, try again later.

Purpose

This article documents how to customize the Short Description of incidents that Veeam ONE creates in ServiceNow.

By default, the Short Description contains only the alarm name. A registry value can be configured on the Veeam ONE server so that the Short Description also includes details from the triggered alarm, such as the affected node, the alarm status, or the time the alarm was triggered.

Solution

Limitations and Considerations

  • The settings in this article require Veeam ONE 13.1+.
  • In Veeam ONE versions prior to 13.1, incident creation fails if the Short Description exceeds 100 characters.
  • The registry value customizes only the Short Description. The content of the incident Description field cannot be customized.
  • The template is configured once on the Veeam ONE server and applies to all incidents that Veeam ONE creates in ServiceNow.
  • Veeam ONE limits the Short Description to 160 characters, which matches the default length of the Short Description field in ServiceNow, and truncates longer values. Parameters that can return long values, such as the alarm summary (%3), increase the chance of truncation.

Customizing the Short Description

On the Veeam ONE server, create the following registry value:

Key Location: HKEY_LOCAL_MACHINE\SOFTWARE\Veeam\Veeam ONE Monitor\Service
Value Name: ServiceNowIncidentDisplayNameTemplate
Value Type: String Value (REG_SZ)
Value Data: Short Description template

The template can combine free text with the following parameters, which are the same parameters used by the Run script alarm action:

  • %1: alarm name
  • %2: affected node name
  • %3: alarm summary
  • %4: date and time of alarm trigger
  • %5: alarm status
  • %6: previous alarm status
  • %7: ID assigned to a combination of an affected node and an alarm
  • %8: type of a child alarm object

For example, the Value Data VEEAM: %2 - %1 produces a Short Description similar to the following:

VEEAM: SRV-SQL01 - VM with no Backup

PowerShell Registry Value Creation

New-ItemProperty -Path 'HKLM:\SOFTWARE\Veeam\Veeam ONE Monitor\Service' -Name 'ServiceNowIncidentDisplayNameTemplate' -Value 'VEEAM: %2 - %1' -PropertyType String -Force

Restart the Veeam ONE Monitoring Service for the change to take effect.

PowerShell Service Restart

Restart-Service -DisplayName 'Veeam ONE Monitoring Service'

Changing the Short Description Length Limit

By default, Veeam ONE limits the Short Description to 160 characters. If the Short Description field in ServiceNow has been configured to allow more characters, create the following registry value on the Veeam ONE server to match that length:

Key Location: HKEY_LOCAL_MACHINE\SOFTWARE\Veeam\Veeam ONE Monitor\Service
Value Name: ServiceNowIncidentShortDescriptionMaxLength
Value Type: DWORD (32-Bit) Value
Value Data: maximum Short Description length, in characters (Decimal)
Default: 160

In the following example, replace 255 with the length configured in ServiceNow.

PowerShell Registry Value Creation

New-ItemProperty -Path 'HKLM:\SOFTWARE\Veeam\Veeam ONE Monitor\Service' -Name 'ServiceNowIncidentShortDescriptionMaxLength' -Value 255 -PropertyType DWord -Force

Restart the Veeam ONE Monitoring Service for the change to take effect.

PowerShell Service Restart

Restart-Service -DisplayName 'Veeam ONE Monitoring Service'

If this KB article did not resolve your issue or you need further assistance with Veeam software, please create a Veeam Support Case.

To submit feedback regarding this article, please click this link: Send Article Feedback
To report a typo on this page, highlight the typo with your mouse and press CTRL + Enter.

Spelling error in text

Thank you!

Thank you!

Your feedback has been received and will be reviewed.

Oops! Something went wrong.

Please, try again later.

You have selected too large block!

Please try select less.

KB Feedback/Suggestion

This form is only for KB Feedback/Suggestions, if you need help with the software open a support case

By submitting, you are agreeing to have your personal information managed in accordance with the terms of Veeam's Privacy Notice.
Verify your email to continue your product download
We've sent a verification code to:
  • Incorrect verification code. Please try again.
An email with a verification code was just sent to
Didn't receive the code? Click to resend in sec
Didn't receive the code? Click to resend
Thank you!

Thank you!

Your feedback has been received and will be reviewed.

error icon

Oops! Something went wrong.

Please, try again later.