Dependencies

In Service Portal, you can link JavaScript and CSS files to widgets. This allows developers to create dependencies between their widgets and third party libraries, external style sheets, and angular modules.

Dependencies are loaded asynchronous from the server at the time that they are needed.

Use the following steps to create a dependency package and associate it with a widget.

Create a dependency package

A dependency package is a collection of Javascript and CSS files that can be then connected to a widget. Locate dependencies either in the table sp_dependency, or by navigating to Service Portal > Dependencies.

In the dependency record, define the following:
Field Description
Name The name of your dependency. (Useful for selecting a dependency from a dropdown list)
Include on page load Select if you want your dependency to be loaded onto the page on initial page load of Service Portal, or leave unchecked to load the dependency only when the linked widget is loaded onto a page.
Angular module name This is an optional field. It is only necessary if the linked JavaScript is an Angular module. Provide the name of the Angular module name that you are loading in, so that it can be injected into the Service Portal Angular application. Leave blank if not applicable.

Add files to the dependency package

After you save the information for your dependency package, you can use related lists section to add JS Include and the CSS Include files. For each related list, include the following information:

Field Description
Display name Name of the include.
Source Depending on whether you add a JS Include or a CSS Include, select one of these options from the list:
  • URL
  • UI script (for a JS Include) or Style Sheet (for a CSS Include)

For a JS Include, use the UI Script field to reference a UI Script found in System UI > UI Scripts.

For the CSS Include, use the Style Sheet field to reference a record in the sp_css table.

Add a Dependency Package to a widget

After you have created a dependency package and added any files, you can create a relationship between the Dependency and a widget.
  1. Navigate to Service Portal > Widgets and find the widget record you want to add the dependency to.
  2. From the Dependencies related list, click Edit.
  3. In the slushbucket, find the Dependency you created and double-click to add it to the selected items column on the right. Save the page to return to the widget record.

Widgets can have as many or as few dependencies as you want. However, the more you add, the more content widgets need to download to render on the page. Keep the dependencies as small as possible for fast load times.