Create an OpenFrame configuration

This configuration specifies the OpenFrame window settings as well as the URL to be launched within OpenFrame.

Before you begin

Role required: admin

About this task

As part of the OpenFrame configuration, users with the admin role can select one or more user groups. Access to the configuration is limited to the users that have the openframe user role and that belong to the selected groups.

Procedure

  1. Navigate to System Properties > OpenFrame to display the OpenFrame Configurations list.
  2. Click New.
  3. Fill in the fields, as appropriate.
    Table 1. OpenFrame Configuration form
    Field Description
    Name The name of the OpenFrame configuration.
    Title The title that appears in the OpenFrame window header.
    Subtitle The subtitle that appears in the OpenFrame window header.
    Order The order number for the configuration.
    If users have multiple OpenFrame configurations, they can only access the configuration with the lowest order number.
    Note: When upgrading, the Order field for the existing default OpenFrame configuration is set to 1.
    User Group The user groups selected for this configuration. Access to this configuration is limited to the users that have the openframe user role and that belong to the selected groups.
    Note: If you do not select any groups, the configuration is available to all users with the openframe user role.
    URL The URL to be launched within OpenFrame. This URL can be an absolute path or a path that is relative to the ServiceNow instance.
    Active Denotes this configuration as active.
    Width The width of the OpenFrame window.
    Height The height of the OpenFrame window, not including the OpenFrame header height.
    Icon Class The class of icons used for the OpenFrame window (retina-icons.css).
    Title Icon The icon displayed on the OpenFrame window header.
    Configuration Can be used to store any JSON encoded string.
    Note:

    Several fields on the OpenFrame Configuration form can also be set by using the OpenFrame API. These fields include: Title, Subtitle, Width, Height, and Title Icon.

  4. Click Submit.