Schemas

The functionality described in this article is available in Navigator versions 10.5.0.5 and greater. See the Navigator v10.5.0.5 hot fix section of the 10.5 Highlights for an overview of feature changes.

Schemas control how viewlets are displayed; the attribute columns and the order in which they appear are controlled by the schema currently in effect. Each viewlet type has a default schema, but you can create your own custom schema to specify the attributes you want to view and their order. 

Add a new schema

1. Click the Manage Viewlet Schemas button to open the Manage Schemas window. 
   
   
2. Click Add to add a new schema. The Edit Schema window opens. On this window is where you will specify the attributes you want displayed and their order.
   
3. At the top of the screen in the Schema Name field (1), enter a name to represent the new schema. 
4. On the left side of the window in the Available attributes section (4), you will see all of the attributes listed for this viewlet type. Select the attributes you want displayed by clicking on them (you can multi-select by holding the Ctrl key when clicking on each attribute) and clicking the Add button (3).

Easily find attributes in the Available attributes list by using the filter (4) immediately above the table.

5. The selected attributes will move to the Displayed attributes section (5) on the right side of the screen. In the example image above, the attributes selected were Queue Name, Manager Name, Default Bind, Type of Object to Which.., Default Priority, Base Object Name, and Put Messages. If you want all attributes to display, simply click the Add all button (6). To remove attributes from the Displayed attributes, use the Remove and Remove all buttons (7). 

See Setting up custom attributes for information about creating your own custom attributes.

6. By default, the order in which the attributes appear in the Displayed attributes section (5) is the order in which they will appear in the viewlet. To change this order, select an attribute and use the Move to Top, Move Up, Move Down and Move to Bottom buttons (8).
7. Choose the manner in which the viewlet’s data will be sorted by modifying the Default sort section (9) at the bottom right of the window. Enable the Col. #1 checkbox and select the attribute to sort by. Select Ascending or Descending from the Direction drop-down list. To sort by a secondary column, perform the same steps for the Col. #2 checkbox.
8. Click OK when finished. The new schema is now added and can be applied to your viewlet. See the section below, Change a viewlet’s schema, for information on how to apply the new schema.

Share a Schema

To share a schema:

1. Turn on the Shared Display Schema slider (2) . Its color changes to orange.  
2. Click the vertical ellipse icon that is now displayed next to the Shared Display Schema label .
3. Click the eye icon next to each group you want to share the dashboard with. The eye icon changes to green for selected groups.
   
   Hover your mouse over the vertical ellipse icon to view a list of the groups with which a schema is shared.
   

On the Manage Schemas window, look for the following icons:

	Indicates a schema that has been shared with your group.
	Indicates a schema that you have shared.

Copy a schema

You can use an existing schema’s configurations to create a new schema.

1. On the Manage Schemas window, simply select the schema you want to copy. To view schemas that have been shared with your group, turn on the Shared Display Schemas slider: . Its color changes to orange:. Schemas that have been shared with your group are marked with a red Shared Display Schema icon:. Schemas that you have shared are marked with a green Shared Display Schema icon:.
2. Click Copy As....
   
3. The Edit Schemas window opens. Follow the instructions in the Add a new schema section above for information on how to edit the new schema.
4. See the section below, Change a viewlet’s schema, for information on how to apply the updated schema.

Edit a schema

After you edit a schema that you have shared with one or more groups, the users in those groups will have access to the updated version of the schema.

To edit an existing schema's configurations:

1. Select the schema you want to edit on the Manage Schemas window. To view schemas that have been shared with your group, turn on the Shared Display Schemas slider: . Its color changes to orange:. Schemas that have been shared with your group are marked with a red Shared Display Schema icon:. Schemas that you have shared are marked with a green Shared Display Schema icon:.
2. Click the Edit button. Please note that the default schema cannot be edited.

Instead of overwriting an existing schema, it is recommended that you make a copy of an existing schema first and use that as a starting point.

3. The Edit Schemas window opens. Follow the instructions in the Add a new schema section above for information on how to edit the new schema.

See the section below, Change a viewlet’s schema, for information on how to apply the updated schema.

Delete a schema

To permanently remove a schema, select it from the Manage Schemas window and click Delete.

A prompt will appear confirming the delete action.

Change a viewlet's schema

To change a viewlet’s schema, click the Schema drop-down and select the desired schema. This schema will be in effect for this session and all future sessions until it is changed again.