Skip Navigation
Expand
Using a custom splash page for site maintenance and updates
Answer ID 1306   |   Last Review Date 07/30/2019

Can I have a custom splash page displayed for site maintenance and updates?

Environment:

Customer Portal pages (CP), All versions

Resolution:

You do have an option to upload a custom splash page.  

The general splash page provided by Oracle is used automatically, and displays a message stating, "This site is undergoing maintenance.

Default Splash page message: This site is undergoing maintenance.

This general splash page provided by Oracle is in English - even if your interface has a non-English language pack applied. If you want the text to be in a language other than English (e.g., French or German), you must upload a custom splash page for that interface.

If you have multiple interfaces and wish to have a custom splash page for each interface, you will need to upload a separate custom splash.html file for each interface separately.

During an update, the updated splash page needs to be uploaded to both the production site and the upgrade site prior to the cutover to show the page for the entire duration of cutover down time. The reason being that at the beginning of cutover, the copy on the production site is displayed. During the cutover the version on the upgrade site is copied to the production site and displayed.

Customer Portal Required Changes:

Modify the HTML code for the splash.html file and upload it to your Customer Portal site. 

Customer Portal framework 3.x.x: cp/customer/error/splash.html
Customer Portal framework 2: euf/config/splash.html

The URL for the splash.html page is below.

http://<interfacename>.custhelp.com/cgi-bin/<interfacename>.cfg/php/euf/config/splash.html

If you have uploaded a custom splash.html file, this URL will display the page as it will appear to your end-users when your site is in maintenance mode.  Otherwise, the default splash.html page is used.

If an upgrade site exists, the URL for the splash.html page is:

http://<interfacename>--upgrade.custhelp.com/cgi-bin/<interfacename>.cfg/php/euf/config/splash.html


Notes:

When promoting changes to your production site, you can manually turn the splash page on and off to reserve time for any post-promotion tasks. A configuration setting called "CP_MAINTENANCE_MODE_ENABLED" can be utilized so that all page requests within Production mode in Customer Portal will return the content of the splash.html page and all syndicated widgets will stop displaying data. This will not affect WebDAV, the CP admin area, custom controller endpoints, or requests within development or staging mode. Consequently, administrators can test or change Customer Portal before allowing it to be viewed by the end-users.

To manually turn on the splash page:

1.  Login to the Oracle Service Cloud console.

2.  Click the Configuration button on the navigation pane.

3.  Double-click Configuration Settings under Site Configuration.

4.  Search by Key > CP_MAINTENANCE_MODE_ENABLED.

5.  Select the Yes radio button and click Save.

6.  Visitors to your production site will continue to see the splash page until you reset CP_MAINTENANCE_MODE_ENABLED to No.


For additional information, refer to the 'Turn On the Splash Page' section in online documentation for the version your site is currently running.  To access Oracle Service Cloud manuals and documentation online, refer to the Documentation for Oracle Service Cloud Products.

Available Languages for this Answer:

Notify Me
The page will refresh upon submission. Any pending input will be lost.