CMS to Service Portal transition
Summarize
Summary of CMS to Service Portal transition
This guide helps ServiceNow customers transition from CMS (Content Management System) to Service Portal, focusing on modifying CMS and Service Catalog implementations for Service Portal adoption. It highlights differences, limitations, and necessary adjustments to ensure a smooth user experience, especially in a mobile environment. Customers should also review mobile client GlideForm scripting and migration considerations.
Show less
Key Transition Considerations and Component Support
- Data Lookups: Client-side data lookups are unsupported in Service Portal, but server-side lookups still apply when records are submitted or updated. This limitation may not impact requester-only CMS implementations.
- Content Blocks and UI Macros: Both use Jelly scripting and aren’t supported in Service Portal. They are replaced by widgets, which are customizable and cover most use cases; custom widgets can be developed using AngularJS.
- UI Actions: Server-side UI actions are supported except for setRedirectURL(), which must be refactored because Service Portal handles redirection differently. Client-side UI actions are ignored.
- Catalog Client Scripts: Only scripts marked for Mobile/Service Portal or All UI types are supported; Desktop-only scripts are not. Synchronous GlideAjax calls (e.g., getXMLWait()) are unsupported and must be replaced with asynchronous methods.
- UI Policies: Scripted UI policies must use APIs supported in Service Portal; unsupported APIs need removal.
- Service Catalog Variables: Supported except for UI Macros and UI Pages variable types, and validation scripts. Help text is always expanded, and List Collector variables appear as choice lists rather than slushbuckets. Testing is recommended to verify display behavior.
- Order Guides: Rendered via the Order Guide widget; large guides may cause performance issues and should be simplified or split. An iFrame rendering workaround is available temporarily.
- Record Producers: Supported with some differences, such as ignoring catalog item sort order and not honoring time zones for date values. Testing in Service Portal is advised.
- Login Scenarios and Redirects: CMS CMSEntryPage scripts are replaced by SPEntryPage script includes and system properties. Redirects are unsupported and login behaviors should be configured accordingly.
- Service Catalog Forms: Rendered within widgets in a two-column layout; complex forms with nested containers or more than two columns will be reorganized into fewer columns. Simplification of complex forms is recommended, with iFrame rendering as a temporary solution.
- Shopping Cart: Service Portal provides a base system Shopping Cart widget for use.
Practical Tips for Customers
- Review and update client scripts and UI policies to ensure compatibility with Service Portal APIs and asynchronous patterns.
- Replace Jelly-based components (Content blocks, UI Macros) with widgets using AngularJS for customization.
- Test all catalog items, record producers, and variable annotations thoroughly in Service Portal to confirm expected behavior and appearance.
- Adjust complex Service Catalog forms to fit within Service Portal’s two-column layout constraints or consider temporary iFrame solutions.
- Modify login scenarios by configuring the SPEntryPage script include and related properties instead of legacy CMS methods.
- Prepare for performance impacts in large order guides and explore splitting or simplifying them.
Your CMS may include complex forms and customizations that do not render as expected in Service Portal. Use this guide to understand how best to modify your CMS and Service Catalog implementation for Service Portal adoption, and to understand how a conversion may affect your users.
If you are considering transitioning from CMS to Service Portal, make sure that you understand the impact of moving to a mobile environment. Review the Mobile client GlideForm (g form) scripting and migration.
Support level and transition actions
| CMS component | Service Portal support |
Possible transition actions |
|---|---|---|
| Data lookups | The client-side component of a data lookup is not supported in Service Portal. However, the data lookup is applied in the platform when a record is submitted or updated in Service Portal. |
While data lookups are not applied in the Service Portal, the record updates as expected in the platform UI when submitted or updated in the Service Portal. If your CMS is used by requesters only, this limitation may not affect your implementation. |
| Content blocks | Because Content blocks use Jelly, they are not supported in Service Portal . |
In the Service Portal, content blocks are replaced by widgets. Widgets are highly customizable components that can query record data, display and update records, and gather user input. Base system widgets generally cover most use cases. Just as you add content blocks to a page in your CMS, you can add widgets to a page using the Service Portal Designer. |
| UI Macros | Because UI Macros use Jelly, they are not supported in Service Portal. |
|
| UI actions | All server-side UI actions are supported in Service Portal, although setRedirectURL() operations are ignored because Service Portal forms handle redirection in a different way than the platform. The form widget ignores all UI actions marked as Client. |
|
| Catalog client scripts |
Only UI Type options Mobile / Service Portal and All are supported. UI type Desktop is not supported in Service Portal. For a list of supported APIs, see Service Portal and client scripts. Note: Synchronous JavaScript calls are not supported in Service Portal and
must be replaced by asynchronous calls. For example, the getXMLWait()
method of the GlideAjax class is not supported in Service Portal. Instead,
use one of the following supported asynchronous methods:
For additional information on GlideAjax, refer to GlideAjax. To understand the impact of updating your CMS to work in a mobile environment, review Mobile client GlideForm (g form) scripting and migration. |
|
| UI policies | Scripted UI policies can only use APIs supported in Service Portal. For a list of supported APIs, see Service Portal and client scripts. |
Update your scripts to remove any unsupported client APIs. |
Service Catalog variables |
Service Catalog variables are supported in Service Portal with the following exceptions:
|
|
| Order guides | Order Guides in Service Portal use the Order Guide widget. |
Large order guides can cause performance issues in the Service Portal. If you have large order guides, you can:
|
| Record producers | Record producers are used in Service Portal with the following differences:
|
Make sure to test all record producers used in Service Portal to make sure that they behave as expected. |
| Login scenarios and redirects | In CMS, you used the CMSEntryPage script include to define login scenarios. Instead, Service Portal uses the SPEntryPage script include and related system properties to define login scenarios. Redirects are not supported in Service Portal. |
In Service Portal, define login behavior by modifying the SPEntryPage script include and setting system properties. For more information, see Single sign-on, logins, and URL redirects. |
Service Catalog forms |
Service Catalog forms such as catalog items and record producers are rendered within widgets in a two-column layout. Complex forms may not display as expected.
|
|
| Shopping cart | The Service Portal includes a base system Shopping Cart widget. |
Use the Shopping Cart widget. |