Frames

A Frame contains Plug-ins, which are software components used to display information. The frame contains the plug-ins and controls how users interact with those plug-ins.

In Lucity Web, frames are generally divided into two columns. However, there are also Span Frames (commonly used with reports) that extend across two columns.

Frame Example

Frame Setup

Frames are created in the Dashboard Tabs window. The Frame window in the Lucity Administration Tool enables users to configure the frame using the following fields, options, and tools:

add_frame

Frame options

Frame Name

Specifies the name that should appear above the Frame when it is displayed on the Dashboard.

Span Frame

Indicates that the Frame should span the entire width of the Dashboard tab. By default, frames are only half as wide as the Dashboard tab, allowing two frames to appear side by side. The Span Frame option is useful in displaying reports.

Show 'Launch in Desktop'

Gives users the option to open the results of the Plug-in Lucity Desktop. Uncheck this box to hide the option.

Show 'Launch in Web'

Gives users the option to open the results of the Plug-in Lucity Web. Uncheck this box to hide the option.

For Web

Indicates that this Frame should appear on the Lucity Web Dashboard. Uncheck this box to hide the frame in Lucity Web.

For Mobile

Indicates that this Frame should appear on the Lucity Mobile Dashboard. Uncheck this box to hide the frame in Lucity Mobile.

Mobile Offline Support

States that the Frame should work in Lucity Mobile's offline mode. This preference forces data in the frame to be cached on the tablet so that users have access to the data when not connected to the network.

Saves all changes made to the Frame and closes the window.

Cancel

Closes the window and cancels any changes made to the Frame.

Plugins

Add

Adds a new Plug-in to the list on the left side of the dialog box.

Edit

Edits the selected Plug-in.

Delete

Deletes the selected Plug-in.

Rename

Enables users to rename the selected Plug-in.

Copy

Makes a duplicate of the selected Plug-in.

Copy Existing

Enables users to save time by copying a Plug-in from another user's Dashboard.

Moves the selected Plug-in record up one space in the grid. The order of the plug-ins in the grid dictates the order they will appear in the frame.

Moves the selected Plug-in record down one space in the grid.

Click the Add button. The Plug-in dialog box appears.
Select a Plugin Type from the first drop-down list. Types include Asset Hierarchy Trees, Crystal Reports, Data Drills, and RSS Feeds.
Enter a Name for the plug-in. This name is for the administrator's benefit and should identify the purpose of the plug-in.
Click OK. The appropriate customization screen appears.

More information about Plug-ins

Select a Plug-in in the grid.
Click the Edit button. The appropriate Plug-in window appears.

More information about Plug-ins

Click the Copy Existing button, located beside the Plug-ins list in the Frame dialog. The following window appears:
Select the Users or Templates radio button at the bottom-left of the screen.
- Select a User or Template name from the list.
- Click the Lookup icon to quickly locate a User Name or Template in the list. More
  - One of the following field sets will appear:
  - Enter a LoginID, First Name, or Last Name, or Template Name
  - As the user types, the list is automatically filtered to match.
  - Remove what was typed to clear the filtering, and click the button again to find the find fields.
Select a previously defined Dashboard tab from the second list.
Select a previously defined Frame from the third list.
Finally, select a previously defined Plug-in from the fourth list.
Click OK. The Plug-in is added to the Frame.