Skip to main content
Top
Review meshIQ Products (G2.com)

Schemas in Manage

Some of the content described in this article is available in meshIQ Manage versions 12 and later.
For a quick overview of what's new or changed, visit the meshIQ Highlights page for a version-by-version breakdown.  

Jump to Section:
Version 12.x and Later
Version 11.3 and Earlier

Version 12.x and Later

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

Jump ahead

Add a New Schema

  1. Click the Manage Widget Schemas button to open the Manage Schemas dialog. 
    If you do not see the Manage Widget Schemas button, click the Show Filters button at the top right of the widget.

  2. Click Create a new Schema Add buttin.png button to add a new schema. The Add/Edit Schemas dialog opens. This is where you will specify the attributes you want displayed and their order.
  3. At the top of the dialog, in the Enter Schema Name field, enter a name for the new schema.
  4. On the left side of the dialog, the Available Attributes section displays all attributes available for the selected widget type.
  5. Select the attributes you want displayed by clicking the checkbox (you can select more than one) and clicking the right arrow button.
    Alternatively, you can hold the drag icon to manually drag and drop attributes into the schema.

To quickly locate attributes, use the Enter Filter Value field above the Available Attributes list.

  1. The selected attributes appear in the Displayed Attributes section on the right side of the dialog.
    In the example shown above, the selected attributes are Node Name, Manager Name, Queue Name, Put Messages, and Current Depth.

You can also create custom attributes. For more information, see Setting up Custom Attributes.

  1. To display all attributes, click the double right arrow button. 
    To remove attributes from the Displayed Attributes section, use the left arrow or double left arrow buttons.

  2. By default, the order in which the attributes appear in the Displayed Attributes section is the order in which they will appear in the widget.
    To change the order, hold the drag icon next to an attribute, then drag and drop it into the desired position. 

  3. To define how widget data is sorted, use the Default Sort section at the bottom right of the dialog.

    Enable the Col #1 checkbox, select the attribute to sort by, and choose Ascending or Descending from the Direction drop-down list.

    To sort by a secondary column, repeat these steps for the Col #2 checkbox.

  4. Click Save when finished. The new schema is added and can be applied to your widget.
    For information about applying the schema, see Change a widget’s schema.

Share a Schema

To share a schema:

  1. Turn on the Shared Display Schema slider. Its color changes to green.  
  2. Click the vertical ellipse icon that is now displayed next to the Shared Display Schema label.
  3. Click the eye icon mceclip0.png 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 dialog, look for the following icons:

Indicates a schema that has been shared with your group.
Shared up arrow.png 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 dialog, select the schema you want to copy. 
    To view schemas that have been shared with your group, turn on the Shared Display Schemas slider. When enabled, the slider color changes to green: . 
    Schemas that others have shared with you display a downward-pointing arrow shared icon .
    Schemas that you have shared display an upward-pointing arrow shared icon Shared up arrow.png.
  2. Click Create a copy of the selected schema Copy button.png button.
  3. The Add/Edit Schemas dialog 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 Widget’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 dialog. 

  2. To view schemas that have been shared with your group, turn on the Shared Display Schemas slider. When enabled, the slider color changes to green: . 

    Schemas that others have shared with you display a downward-pointing arrow shared  icon .
    Schemas that you have shared display an upward-pointing arrow shared icon Shared up arrow.png.

  3. Click the Edit EDit button.png 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.

  1. The Add/Edit Schemas dialog opens.
  2. Follow the instructions in the Add a New Schema section above for information on how to edit the new schema.
  3. See the section below, Change a Widget’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 dialog and click Delete.

A prompt will appear confirming the delete action. Click Yes to delete, or No to cancel.

Change a Widget's Schema

To change a widget’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.

_________________________________________________________________________________________________________________

Version 11.3 and Earlier

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. 

Jump ahead

Add a new schema

  1. Click the Manage Viewlet Schemas button to open the Manage Schemas window. 
    Versions 11.1 and earlier
    EditSchemaBtBox.png
    Version 11.2
    If you do not see the Manage Viewlet Schemas button, click the Show Filters button at the top right of the viewlet.
    EditSchemaBtBox.png
    MngSchemasDlg.png
  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.
    EditSchemaNums.png
  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.

  1. 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). 

You can also create custom attributes. For more information, see Setting up Custom Attributes.

  1. 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).
  2. 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.
  3. 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) SchemaNotShrd.png. Its color changes to orange.  
  2. Click the vertical ellipse icon that is now displayed next to the Shared Display Schema label EditSchemaShareBt.png.
  3. Click the eye icon mceclip0.png next to each group you want to share the dashboard with. The eye icon changes to green for selected groups.
    EditSchemaShare.png
    Hover your mouse over the vertical ellipse icon to view a list of the groups with which a schema is shared.
    EditSchemaShareTip.png

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

ShrdFltrIconRed.png Indicates a schema that has been shared with your group.
ShrdFltrIcon.png 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: SchemaHideShared.png. Its color changes to orange:SchemaShowShared.png. Schemas that have been shared with your group are marked with a red Shared Display Schema icon:ShrdFltrIconRed.png. Schemas that you have shared are marked with a green Shared Display Schema icon:ShrdFltrIcon.png.
  2. Click Copy As....
    MngSchemasCopyBt.png
  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: SchemaHideShared.png. Its color changes to orange:SchemaShowShared.png. Schemas that have been shared with your group are marked with a red Shared Display Schema icon:ShrdFltrIconRed.png. Schemas that you have shared are marked with a green Shared Display Schema icon:ShrdFltrIcon.png.
  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.

MngSchemasEditBt.png

  1. 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.

MngSchemasDltBt.png

A prompt will appear confirming the delete action.

mceclip6.png

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.

Versions 11.1 and earlier

SchemaSlct.png

Version 11.2

SchemaSlct.png