Click on Images to Expand Them
For a widget to be visible to the users, it must be included in an Interface. A widget can be one of several things displayed on the screen (e.g. part of a Dashboard that shows a list of Work Items as well as the wizard for creating a new Work Item), or it can be the only thing visible on the screen. In either case, it must be contained in an interface.
Step 1: Accessing the Interfaces Tile
Navigate to Administration menu > Single Pane of Glass tile > Interfaces tile.
Navigation to Interfaces
Step 2: Opening Interface Details
Click the New Interfaces button. This opens a blank Interfaces Details screen.
New Interfaces button
Step 3: Filling Out the Detail Panel
There are three fields in the Details panel.
Interface Details panel
Fill out the fields in the Details panel:
Field | Description |
---|---|
Name | Users will not see this name; it is for internal reference only. Name it in a way that can be recognized by your co-workers for its function. |
Description | A more in-detail description of the interface, used for internal reference. |
Interface Key | Create a short code name for the interface. This key can then be referenced and called by JavaScript code, for example, to open this wizard from another wizard. |
Step 4: Accessing Quick Select and Choosing from the List of Roles
If necessary, add Included or Excluded Pooled Actors (you only need one or the other) in the respective panels. Click Quick Select in the top right corner of the panel and choose from the list of Roles.
Included Pooled Actors are the user roles that can access the interface.
Excluded Pooled Actors are the user roles that cannot access the interface.
If no roles are added to these panels, then all users will be able to see this interface.
Note
Troubleshooting
: If you receive an error “Exception while adding unbound Included (Excluded) Pooled Actors attribute values”, try the following:
Remove the Included or Excluded Pooled Actors.
Save and Close.
Re-open the interface and add the Included/Excluded Pooled Actors again.
Save and Close again. This should allow those users/data roles to be applied after the interface is successfully created. If you continue to receive an error, please contact Engineering for assistance.
Pooled Actors panels
Step 5: Selecting the Interface Layout
In the bottom part of the screen, select the layout of the interface. To display only the wizard, choose Full Screen. Other layout options are listed below.
Note
: Once the interface is created and saved, its layout cannot be changed. If it is necessary to change the layout, then a new interface must be created.
Interface layout options
Layout options include:
Layout option | Description |
---|---|
12/4-4-4 | Full width on the top of the screen. Three equal columns on the bottom of the screen. |
12/6-6 | Full width on the top of the screen. Two equal columns on the bottom of the screen. |
12/6-6/12 | Full width on the top of the screen. Two equal columns in the middle. Full width on the bottom of the screen. |
3-9 (12/6-6) | A narrow left column full length of the screen. A wider right column divided into two rows – full width on the top and two equal columns on the bottom. |
4-8 | Two columns on the screen, with the right column wider than the left one. |
6-6 | Two equal columns on the screen. |
Full Screen | One or several widgets across the full width of the screen. |
Step 6: Selecting Widgets with Your Wizard
Click the plus sign in the upper-right corner of the layout visualization. Then search and select the widget with your wizard.
Adding a widget to the interface layout
Step 7: Changing the Position of Widgets
If the layout contains more than one widget, you may change the position of widgets by dragging them by the Change widget location icon.
Step 8: Saving Your Work
Click Save in the top toolbar of the screen to create your new interface. You can now proceed to adding a menu item that opens this interface.