---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Registering custom UI macros against the UI extension points

# Registering custom UI macros against the UI extension points {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read

Register custom UI macros against a selected UI extension point in the application code.

By registering custom UI macros, you create an extension instance record that links the UI
extension point definition to its implementation in the custom UI macro.

## Register a custom UI macro {#ariaid-title2}

Create a custom UI macro and code when you register it against a selected UI extension point.

### Before you begin

Role required: application-specific developer, application-specific admin, or admin  
Note:  
To learn about application-specific administrator roles and delegated development, see [Access control rules in
application administration apps](https://www.servicenow.com/docs/access?context=ACL-access-checks&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US) and [Delegated development and
deployment](https://www.servicenow.com/docs/access?context=c_DelegatedDevelopment&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US).

### Procedure

1. Navigate to AllSystem Extension PointsUI Extension Points.
2. In the UI Extension Point \[sys_ui_extension-point\] table, select the extension point that you want to register a custom UI macro against.  
   Note:  
   This listing includes UI extension points that you created and any pre-defined UI extension points that are embedded in ServiceNow AI Platform functions (for example, Customer Service Management and Field Service Management).

   To learn more about functions that contain pre-defined extension points, see the Related Topics links in [Using extension points to extend application functionality](https://servicenow-prod.fluidtopics.net/agUCalbZ4ypHMncaJXRaoQ "Use extension points to extend the functionality of an application without altering the original application code. You can use pre-existing extension points available in selected ServiceNow AI Platform applications, or you can add extension points when you develop custom applications in your own instance.").
3. In the UI Extension Point record, click the Create Implementation related link to create a new custom UI macro and register it against the selected UI extension point.
4. In the UI Macro form, create the custom code.  
   To learn more about creating UI macros, see [UI macros](https://servicenow-prod.fluidtopics.net/~qIUyqeIRdrSnlC1RcqGNQ#c_UIMacros "UI macros are discrete scripted components administrators can add to the user interface.").
5. Click Update.
{#register-custom-ui-macros-ui-ext-pt__steps_tkt_jtq_qfb}

### Result

The custom UI macro is created and registered against the UI extension point.

## Review UI extension instances {#ariaid-title3}

Review the listing of custom UI macros that are registered against a UI extension
point. Extension instances indicate the application scope in which registered custom UI
macros are used and provides a link to each. You can also activate or inactive an extension
instance.

### Before you begin

Role required: admin or the specific role for the developer or administrator of the application  
Note:  
To learn about application-specific administrator roles and delegated development, see [Access control rules in
application administration apps](https://www.servicenow.com/docs/access?context=ACL-access-checks&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US) and [Delegated development and
deployment](https://www.servicenow.com/docs/access?context=c_DelegatedDevelopment&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US).

### Procedure

1. Navigate to AllSystem Extension PointsUI Extension Points.
2. In the UI Extension Point \[sys_ui_extension_point\] table, select the UI extension point that you want to view extensive instances for.
3. In the Implementations related list of the UI Extension Point record, select a UI extension instance.  
   The system displays the UI Extension Instance record.{#review-ui-extension-instances__table_r32_ytq_qfb__entry__2}

   | Field | Description |
   |-|-|
   | Point | Unique name for the UI extension point. The name can have up to 100 alphanumeric characters, including special characters. |
   | Class | UI macro in the application code in which the UI extension point is implemented. |
   | Application | Application scope against which the extension point is assigned. This is system-assigned and cannot be changed. For more information about the protections that are offered by the use of scoping, see [Application scope](https://www.servicenow.com/docs/access?context=c_ApplicationScope&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US). |
   | Active | Active extension point in the current instance. To inactivate an extension point, clear the check box. |
   [Table 1. UI Extension Instance record]

   {#review-ui-extension-instances__table_r32_ytq_qfb}
4. Click Submit.
{#review-ui-extension-instances__steps_q32_ytq_qfb}
**Related concepts**   

* [UI macros](https://servicenow-prod.fluidtopics.net/~qIUyqeIRdrSnlC1RcqGNQ#c_UIMacros "UI macros are discrete scripted components administrators can add to the user interface.")
* [Using extension points to extend application functionality](https://servicenow-prod.fluidtopics.net/agUCalbZ4ypHMncaJXRaoQ "Use extension points to extend the functionality of an application without altering the original application code. You can use pre-existing extension points available in selected ServiceNow AI Platform applications, or you can add extension points when you develop custom applications in your own instance.")

*[\>]: and then