Update or create web components
Summarize
Summary of Update or Create Web Components
This feature allows you to update or create web components within your ServiceNow instance, specifically for integration with third-party websites through the Web Embeddables application.
Show less
Key Features
- Embed-Ready Category: The UI Builder toolbox includes an embed-ready category that displays only components verified for use in the Web Embeddables context. Custom components are excluded from this category.
- Automatic Component Creation: When redirected from the Web Embeddables app to UI Builder, a new component is automatically created in the Manage Components section, regardless of any changes made.
- Reduced Feature Set: The Settings tab is unavailable in UI Builder for embeddable components, ensuring consistent management of embeddable details from the Web Embeddables app.
- Component Management: You can manage and include components in your module through the Manage Components section, with the option to quickly locate embeddable components by filtering the category.
Key Outcomes
By using this functionality, you can efficiently create and manage components designed for embedding, ensuring they are compliant and operate smoothly on third-party websites. This streamlines your workflow and enhances the reliability of your web integrations.
Enables you to update or create ServiceNow web components on your instance.
UI Builder toolbox filter
The UI Builder toolbox includes an embed-ready category that displays only components that are available by default and verified to work within the Web Embeddables rendering context. These components are pre-validated to confirm consistent and reliable behavior when embedded on third-party websites. Custom components aren’t displayed in this category.
You can select components outside the embed-ready category, but components from other categories are embed-ready. If you add a component from another category, verify that it meets the criteria for embedding components on third-party websites before adding them to your module.
Navigate back to the Web Embeddables application
When you’re redirected from the Web Embeddables app to UI Builder, the component is automatically created and appears in the Manage Components section on the Web Embeddables home page, regardless of whether you make any changes in UI Builder.
If you configure the component using its properties in UI Builder, save your changes before returning to the Web Embeddables app. If you navigate away without saving, you lose any configuration changes you have made.
To return to the Web Embeddables app, select Configure Embeddables in the UI Builder toolbar. This option is available only for embeddable components. From the Manage Components section, you can manage and include the component in your module.
Reduced feature set in UI Builder
UI Builder offers a reduced feature set when working with embeddable components. The Settings tab isn’t available, as the Web Embeddables app manages embeddable identity and configuration. This confirms that embeddable details remain consistent and are manged from a single location.
In UI Builder, you can edit component properties and preview the embeddable component to verify its appearance and behavior before publishing. To edit embeddable details such as name and description, go to the Web Embeddables app.
Manage embeddable components in UI Builder
To initiate a new embeddable creation workflow, start from the Web Embeddables app. This confirms the component is correctly registered as an embeddable and follows the supported creation workflow.
Embeddable components are visible in the UI Builder component list and are classified as Embeddable under the Associated Type column. To quickly locate all embeddable components, select the Embed-ready as the category in the component list. This displays only components that are verified to work within the Web Embeddables rendering context, making it easier to identify and manage your embeddable components from a single view.