Join the #BuildWithBuildAgent Challenge! Get recognized, earn exclusive swag, and inspire the ServiceNow Community with what you can build using Build Agent.  Join the Challenge.

Anand Biswas
ServiceNow Employee
ServiceNow Employee

Overview

By default, the rm_defect and other custom tables in ServiceNow do not include an External Identifier field required for Azure DevOps (ADO) integration. To enable this, you must manually configure a reference field and extend the existing Populate External Identifier Reference Business Rule.

This article provides the steps to configure the External Identifier reference on a custom table (e.g., rm_defect).


Issue

  • Following the ServiceNow documentation for populating external identifier references on a custom table may not work out of the box.

  • Running gr.isValidField('external_identifier') on the rm_defect table returns false.

  • This is because the External Identifier field is not available by default on the custom table.


Resolution

Step 1: Add External Identifier Column to rm_defect

  1. Navigate to System Definition > Tables.

  2. Open the rm_defect table.

  3. Create a new field with the following properties:

    • Type: Reference

    • Reference Table: sn_int_common_external_identifiers

    • Column Name (example): u_external_identifier

    • Column Label (example): External Identifier

  4. Save the changes.

Screenshot 2025-08-22 at 3.51.15 PM.png


Step 2: Update "Populate External Identifier Reference" Business Rule

  1. Navigate to System Definition > Business Rules.

  2. Open the Business Rule: Populate External Identifier Reference (on sn_int_common_external_identifiers table).

  3. Update the Filter Conditions:

    • Add an OR conditionreference_table = rm_defect. 

Screenshot 2025-08-22 at 3.50.22 PM.png

  1. In the Advanced Script, add logic to handle the rm_defect reference (ensure script correctly maps the new field).

Screenshot 2025-08-22 at 3.49.37 PM.png


Step 3: Validate

  • Navigate to any record in rm_defect.

  • The new External Identifier field should now display references from sn_int_common_external_identifiers.

  • Ensure synchronization between Azure DevOps and ServiceNow reflects in this field.


Additional Notes

  • Apply the same configuration for other custom tables (e.g., rm_scrum_task) if needed.

  • The official ServiceNow documentation for Azure DevOps integration currently does not mention these manual steps. Updates to the docs are planned.

  • For comparison, you can also refer to the Jira integration guide (similar approach):
    Populate external identifier reference fields on a custom table


Related Documentation

Version history
Last update:
‎08-22-2025 03:28 AM
Updated by:
Contributors