Administration Guide

Customizing the SSP homepage layout

Introduced in 2021.1

Updated in 2025

The Self Service Portal (SSP) homepage layout is defined using a JSON-based template that allows full control over the placement, configuration, and appearance of widgets. This template is managed in the Admin Center. Read this page to see how you can customize the homepage's layout.

Accessing and managing the homepage template

To view or modify the homepage template:

  1. Navigate to Admin Center > Apps and Portals > SSP Homepage Template.

  2. Use the built-in JSON editor to customize widget properties, layout, and behavior. For example, you can adjust the itemCount for specific widgets or change the visibility of the search box by setting the visible parameter to true or false.

  3. Save your custom template as a JSON file using the Export option. This allows you to back up your settings or reuse them for other instances.

  4. To apply an existing configuration, use the Import option to upload the JSON file, making it easy to replicate layouts across multiple portals.

You can revert the homepage layout to the default settings at any time by clicking Restore Default. For additional information, see Help: Customizing the homepage template.

Homepage widgets

Widgets are modular components that provide various features on the homepage. You can configure the layout by organizing widgets into columns and setting their properties within the JSON file.

Key widget properties:

  • type: Defines the widget type, such as Search, TicketSubmit, or KBArticles

  • title: Specifies the display title for the widget (references to the localization key in localization files)

  • description: Specifies the display description for the widget (references to the localization key in localization files)

  • itemCount: Controls the number of items displayed in list-based widgets (e.g., Announcements, KBArticles)

  • anonymousAccess: Determines visibility for unauthenticated users (applicable to Announcements and KBArticles)

  • orderBy: Specifies sorting for list-based widgets

These widgets are available:

  • Search: The Find a Solution search box at the top of the page

  • TicketSubmit: The Submit a Ticket button which opens a new ticket form

  • ServiceRequest: The Request a Service button which navigates to the Service Catalog

  • AskQuestion: The Ask a Question button which navigates to the Knowledge Base

  • LatestUpdates: A list of the latest updates from the Tickets, Service Requests, Equipment Requests, and Approvals which are available for the current user.

  • MyTickets: A list of recent tickets from the Tickets, Service Requests, Equipment Requests, and Approvals which was submitted by the current user.

  • MyApproval: A list of approval requests which are available for the current user

  • ServiceCatalog: A list of service request items from the Service Catalog

  • Announcements: A list of Announcements

  • KBArticles: A list of articles from the Knowledge Base.

Embedding custom JavaScript

On-prem only

Custom JavaScript files can be added to the Self Service Portal to enhance functionality. These scripts are stored in the following location:

[PhysicalPathToSSP]\remix\client\

To manage custom scripts:

  1. Place your custom add_[ScriptName].js files in the specified directory [PhysicalPathToSSP]\www\js\custom\.

  2. Test and review scripts to ensure compatibility.

The [PhysicalPathToSSP] is the placeholder for the physical path to the installation folder of your Self Service Portal.

NOTE: For instruction on viewing the physical path of Self Service Portal installation folder, see Physical Path to Self Service Portal Files.