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 |
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
Restart the Veeam ONE Monitoring Service for the change to take effect.
PowerShell Service Restart
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
Restart the Veeam ONE Monitoring Service for the change to take effect.
PowerShell Service Restart
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.