Add widget to SharePoint site

Note

Since version 2.1.1 widget web part is included in the default HelpDesk installation package. It means you don't need to install it separately as in previous versions and it's available right after HelpDesk installation.

Creating widget configuration

Open HelpDesk site and navigate to the Settings tab using the left navbar. Click on the Widgets tab.

Widget Tab

Here you can create a new widget configuration for your page by choosing "New item" and edit any existing configurations by clicking "Edit". Note that editing of widget configuration is employing to every existing widget with this configuration.

Create a new item

Provide a Title for the widget and choose "For SharePoint" as its Type.

SharePoint widget

Check the configuration of the default views. You can set how many Tickets per page the widget will have for a certain view. The Display fields property specifies what information about tickets will be exposed on the widget list. Just start typing the name of a field and pick it up from the dropdown list. Creation of custom views is also available and described in this article.

Edit widget view

Note

Display fields customization is available from version 1.4.7 and custom views—from version 2.1.9.

Note

Display fields are cached for 30 minutes for optimisation purposes. You will need to clear browser cache to apply your changes immediately.

After saving, a configuration ID for SharePoint will be generated—copy it for inserting into the web part on a page.

Generated ID

Enable automatic sign-in for a widget

Open the SharePoint site where you want to place the widget.

Install Plumsail HelpDesk Widget add-in from SharePoint App store. Installing of the add-in is required to enable automatic sign-in under the current SharePoint user in a widget.

Then you need to place widget to a specific SharePoint page. Steps to do that are described below.

Adding widget to modern SharePoint page

Navigate to a page where you'd like to place a widget.

Pick Plumsail HelpDesk Widget WebPart web part from the menu to add it to your page:

Pick the HelpDesk web part

Once you added the web part you need to configure it. Just copy 'Configuration ID for SharePoint' from widget configuration form and paste it to corresponding web part property.

Copy ID to the web part

Publish the page. Your HelpDesk widget is ready to use.

The widget on the page

Known issues

You may encounter the following error trying to add Plumsail HelpDesk Widget to a SharePoint site:

Widget Issue

In this case, click Find out why and Request Approval.

Request Approval

Enter a reason and request approval.

Send Request

Note

You should have global (tenant) admin permissions to perform further actions in App Catalog.

Then, open App Catalog and go to App Requests. Click Plumsail HelpDesk Widget on the requests list.

App Catalog

Check the permissions granting to the app and click Approve.

Approval

Then go back to the site where you want to install the widget add-in and click it again. Confirm that you Trust It.

Widget Installation

When the installation is finished, the widget's icon color will be changed from pale to bright one in Site contents.

Widget's Pale Icon

Widget's Bright Icon