User Guide: Add-In - HomePage Widgets

Add-Ins Overview

The Cireson Service Manager Portal Add-In feature is a location for pre-packaged solutions. Simply toggle a solution on, and it is active. Toggle any solution off if you no longer wish to use it. This approach allows for a streamlined, no-code approach to extensibility in the Cireson Service Manager Portal.

Note: For information about the Service Manager Portal Add-In feature and installation process, view the overview article here.

HomePage Widgets Download Link

The latest version 1.0.0.0 of this Add-In can be downloaded here.

Note: This version of the Add-In is built and tested against version 11.2.0 of the Cireson Portal. It is recommended you are using that version or higher with this Add-In

HomePage Widgets Summary

The HomePage Widgets Add-In adds a set of widgets for use with the dashboard pages in the Cireson Portal for Service Manager. Once activated the homepage widgets are added the same way as the traditional dashboard widgets via the new Content menu on dashboard pages. The widgets are designed to provide a flexible way for admins to define a home page experience for portal users using the existing dashboard pages. The Widgets that come with this Add-In are

Welcome Message Widget

The welcome message is a widget to give the home page a welcoming experience by greeting the user by name with the correct time of day and a configurable custom message. The welcome message can be dismissed by clicking the X.

Work Item Card Widget

The Work Item Card widget is for displaying work items in a compact vertical "card" format as opposed to the traditional grid format.

The Work Item Card Widget can be configured to display "My Requests", "My Work", or the results of a saved search.

Service Catalog Search Widget

The Service Catalog search widget allows for searching of Request Offerings, Knowledge Articles, or both.

Catalog Browser Widget

The Catalog Browser widget allows for browsing the service catalog by category then by service offering.

Top or Favorite Requests Widget

The Top or Favorite Requests widget allows for displaying the top Request Offerings as determined by the admin (more about that here) or the logged in user's favorite Offerings as determined by them favoriting the Offering from the out of box home pages.

The Top or Favorite Requests widget can be configured to be Horizontal or Vertical.

Top or Featured Articles Widget

The Top or Featured Articles widget allows for displaying the Featured Articles as determined by the admin (more about that here) or the top articles as determined by number of article views.

Each setting for the Add-In is as follows:

Key Description Default Value GoodMorningTextUsed with the Welcome Message widget. This text will be prepended to the logged in user's first name before 12pm local time.Good morningGoodAfternoonTextUsed with the Welcome Message widget. This text will be prepended to the logged in user's first name between 12pm and 6pm local time.Good afternoonGoodEveningTextUsed with the Welcome Message widget. This text will be prepended to the logged in user's first name between 6pm and 11:59pm local time.Good eveningWiCardWidgetPageSizeUsed with the Work Item Card Widget. Determines the count of work items per page in the Work Item Card Widget.5HomeCatPageSizeUsed with the Catalog Browser Widget. Determines the count of request offerings per page in the Catalog Browser Widget.5MyWorkStatusFilterUsed with the Work Item Card Widget. Allows for filtering of statuses when using the Work Item Card Widget for displaying "My Work". The comma separated values in this list are the statuses that WILL BE shown.Active,In Progress,SubmittedMyRequestsStatusFilterUsed with the Work Item Card Widget. Allows for filtering of statuses when using the Work Item Card Widget for displaying "My Requests". The comma separated values in this list are the statuses that WILL BE shown.Active,In Progress,FailedSavedSearchStatusFilterUsed with the Work Item Card Widget. Allows for filtering of statuses when using the Work Item Card Widget for displaying any Saved Search. The comma separated values in this list are the statuses that WILL BE shown.Active,In Progress,SubmittedMyWorkPropertiesUsed with the Work Item Card Widget. Determines the properties to show on the card when using the Work Item Card Widget for displaying "My Work". The comma separated values in this list are the properties that WILL BE shown.Status,AffectedUserMyRequestsPropertiesUsed with the Work Item Card Widget. Determines the properties to show on the card when using the Work Item Card Widget for displaying "My Requests". The comma separated values in this list are the properties that WILL BE shown.StatusSavedSearchPropertiesUsed with the Work Item Card Widget. Determines the properties to show on the card when using the Work Item Card Widget for displaying any Saved Search. The comma separated values in this list are the properties that WILL BE shown.Status,AffectedUserMyRequestsDatePropUsed with the Work Item Card Widget. Determines the date property to show on the card when using the Work Item Card Widget for displaying "My Requests". Options are Created or LastModified.CreatedMyWorkDatePropUsed with the Work Item Card Widget. Determines the date property to show on the card when using the Work Item Card Widget for displaying "My Work". Options are Created or LastModified.LastModifiedSavedSearchDatePropUsed with the Work Item Card Widget. Determines the date property to show on the card when using the Work Item Card Widget for displaying any Saved Search. Options are Created or LastModified.CreatedApplyThemeToPagesPermits the extra dashboard widget CSS to run on the specified pages. Supply the guid(s) from the URL(s) of specific dashboard pages to have the CSS apply to those pages.Paste comma separated list of guids herePagerEmptyTextUsed with the Work Item Card Widget. The text to be displayed in the Word Item Card Widget when no records are returned.No Records

Testing and Validation

If experiencing issues, refer to KB Article 2568 here for overall Add-Ins troubleshooting steps
Run through the Add-In’s functionality with default settings.
1. Verify the following:
  1. In the developer console (open up a browser > dev tools > console), you see that the HomePage Widgets Add-In is loaded
As you change settings, go through the above again with browser console open
1. Verify no error messages
2. Verify your changed settings behave as expected

Examples

Adding a widget

To add a widget, click the +Content button on a dashboard page and select one of the home page widgets from the list:

Versions

This is the first release of the Add-In. Older versions will appear here as they become available.