CMS to Service Portal transition
Summarize
Summary of CMS to Service Portal transition
This guide assists ServiceNow customers in transitioning from the Content Management System (CMS) to the Service Portal, focusing on necessary modifications and understanding user impacts during the conversion. It highlights the importance of adapting to a mobile environment and provides essential information on migrating scripts and functionalities.
Show less
Key Features
- Data Lookups: Client-side data lookups are unsupported in Service Portal, but record updates occur as expected when submitted through it.
- Content Blocks and UI Macros: These use Jelly and are replaced by customizable widgets in Service Portal.
- UI Actions: Server-side UI actions are supported, but modifications are required to remove setRedirectURL() operations.
- Catalog Client Scripts: Only mobile and Service Portal UI types are supported; synchronous JavaScript calls must be replaced with asynchronous calls.
- Service Catalog Variables: Supported with exceptions like UI Macros and validation scripts. Help text is always expanded, and complex forms should be simplified.
- Order Guides and Record Producers: Use specific widgets, but large order guides may affect performance, and testing of record producers for expected behavior is crucial.
- Login Scenarios and Redirects: Transition from CMSEntryPage to SPEntryPage script includes for defining login behavior, with no support for redirects.
- Service Catalog Forms: Rendered in a two-column layout, complex forms may require simplification or temporary iframe solutions.
- Shopping Cart: The Service Portal includes a base Shopping Cart widget for managing catalog items.
Key Outcomes
Transitioning to the Service Portal enables a more mobile-friendly user experience while leveraging customizable widgets for better interactivity. Customers need to adapt their existing CMS configurations to comply with Service Portal standards, ensuring smooth functionality and improved user engagement in their Service Catalog offerings. Thorough testing of all elements is essential to maintain usability and performance in the new environment.
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. |