Guidelines for home page extensibility
Guidelines to customize the application home page.
Background
Currently, the home page serves as the landing page and also the access point for all the features through portlets. The home page has three HTMLs, namely, Header, Content, and Footer. Header displays the menu bar, Content displays the portlets, and Footer consists of the site map and switch icon to switch between personas.
If the home page is overridden, any of the new features exposed by adding a new portlet will not
be visible or accessible even after the required backend configurations for resource permissions are
completed. It requires a manual merge to show the new portlet that serves as an entry point for the
new feature to be visible. Therefore, to avoid the manual process, the customization of the home
page portlets and accessing new features is simplified.
Note: Changing the layout of home page (For
example, moving away from portlet layout) still requires override approach and is not within the
scope of this activity.
- Use override extensibility to customize header HTML and JS files, which may necessitate manual reconcile effort in case these files are modified in future releases.
- Overriding the HTML and JS files for main content and footer is not recommended.
- The Sterling Business Center should be used to register new personas.
- The
registerCustomPortlet()
method must be used to register new custom portlets or override allowed properties of default portlets. - It is recommended to switch to the new portlet specifications as soon as possible.