Some of the content described in this article is available in meshIQ Manage versions 12.1 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

Beginning with version 12.1, the term viewlet has been changed to widget. Any references to viewlet in older versions of the documentation refer to widget in version 12.1 and later..

To add new information to a dashboard, you can create widgets.

To add a widget to your dashboard:

1. Click the Add Widget button at the top-right of the perspective. The Create Widget dialog opens. 
   
2. Choose the type of widget you want to create.

See sample widgets: IBM MQ | ActiveMQ | Kafka | ACE | IIB | Solace | RabbitMQ

Create a Object Search or Temporary Widget

1. Click the Add Widget button at the top-right of the perspective. The Create Widget dialog opens. 

2. Select Create Using Object Search or Create Temporary Using Search. The Create New Widget dialog opens. 
   Temporary widgets are available only during the current session. For these widgets, the Temporary Widget slider is selected.
   

3. From the Technology list, select the technology for which you want to create a widget.

The available widget options depend on the selected technology. Remote queue managers are not technology-specific, so they appear in Node widgets for every technology.

4. From the left side of the dialog, select the required object type (for example, Node, Manager, Queue, or Channel).
5. Complete the required fields such as Widget Name, Workgroup Server, and Object selection fields. Other selections also depend on the selected product. For example, the Node list only includes nodes for the product you select.
6. From the Widget Type list, select the widget type you want to create. The available fields change based on the selected widget type:
   • Table: Displays object data in a table format.
   • Pie Chart: Displays aggregated object data as a pie chart. Select Function, Group By, and Value to define the aggregation. For details, see Creating a Pie Chart Widget.
   • Bar Chart: Displays aggregated object data as a bar chart. Select Function, Group By, and Value to define the aggregation. For details, see Creating a Bar Chart Widget.
   • Number Block: Displays a single aggregated value for the selected object. Select Function and Value to define the aggregation. For details, see Creating a Number Block Widget.
   • Metric Trends: Displays metric trend data over time for the selected object. Select the metric to track. Creating this widget initiates data collection. Data may take a few minutes to appear. For details, see Creating a Metric Trends Widget.

7. Configure additional fields as needed, such as Custom Widget Color, Project, Result Limit.

8. (Optional) Use Attribute Filter to narrow the results. For Queue widgets, you can also use Find Message options to search for specific message cases.

9. Click Create. The widget appears at the bottom of the current dashboard.

Create a New Widget Consisting of Favorite Objects

The Create Favorite Widget dialog appears when Create For Favorite Objects is selected from the Create Widget dialog. See What are favorite objects widgets and Create a Favorite Objects Widget for more information.

Create a New Widget from External Resource

You can create a widget using an external resource, such as a knowledge base or intranet, if it supports embedding and can be viewed directly in meshIQ Manage. If you use XRay/Track, this feature enables integration and allows you to view XRay/Track widgets directly within meshIQ Manage.

To create a widget using an external resource, select Create from External Resource from the Create Widget dialog. The Create New External Resource Widget dialog opens.

Enter a name for the widget and the URL of the external source. Select the workgroup server in the last field and click Save. You can check the 'Multi-Selection' checkbox to select multiple workgroup servers. You can also select 'regex' to choose all grouped connections.

If you are adding an XRay/Track widget, refer to Can I publish a widget on a web page? For information on how to share the widget and retrieve its URL.

The widget will now appear on your dashboard. Below is an example.

Open Existing Widget

To open an existing widget, select Open Existing Widget from the Create Widget dialog. The Add Existing Widget dialog opens. This dialog displays all existing widgets available on the workgroup server, including widgets from all active connections. Select the required widget, and then click Add from the Selected menu to open it. To find a widget in the list, use the Search (Filter by) field.

Create a New Widget from an Import File

You can create a new widget by importing a file that contains exported widget properties. The import feature supports JSON and CSV files. For more information about generating these files, see Exporting Widgets to a JSON File and Exporting Widget Data to a CSV File.

1. Select the Import Widget File option from the Create Widget dialog.
   

2. In the Import Widget dialog, drag and drop the file into the upload area, or click Browse a file to locate and select the widget file. Then click Open. The widget name is automatically populated based on the file contents.
   

3. By default, imported widgets are mapped to the first Workgroup Server (WGS) connection that is in use. If only one connection is active and you do not have permission to create connections during import, you will not be able to map to other connections.

   However, if multiple connections are in use or you have permission to create connections during import—and you want to import the widget into a connection other than the default—the User Connection list will display all currently active connections. Select the connection you want to use.

   If you have the Allowed Create Connection On Import permission, you can allow new connections to be added automatically during the import process if needed. To do this, select the Add if not found in DB option from the User Connection list. The system will search for existing connections that match the same port and connection list as the importing connections, even if the names are different. If no matching connection is found, a new one will be created.

4. Use the Map Group Connections section to include grouped connections during the import process.

5. Click Import to add the widget to the dashboard.

________________________________________________________________________________________________________________

Version 11.3 and Earlier

To add new information to a dashboard, you can create viewlets.

To add a viewlet to your dashboard:

1. Click the Viewlet button from the top right of the screen. The Create Viewlet dialog box opens. 
2. Choose the type of viewlet you want to create.

See sample viewlets: IBM MQ | Kafka | ACE | IIB | Solace | RabbitMQ

Create a Temporary or Object Search Viewlet

To add a viewlet to your dashboard:

1. Click the Viewlet button from the top right of the screen. The Create Viewlet dialog box opens. 
2. When you create a viewlet from the WorkSpace dashboard, only the Create Temporary Using Search option is available.
   

3. The Create new viewlet window is displayed when Create Using Object Search or Create Temporary Using Search is selected. Temporary viewlets are only available during the current session. For these viewlets, the Temporary checkbox is selected.
   
4. Select the Product for which you want to create a viewlet. 

For each viewlet, available options are based on the product that is selected from the Product list. Remote queue managers, however, are not product specific. Therefore they are included in Node viewlets for every product, regardless of the product selection.

5. Select the object type on the left side of the window.
6. Complete the fields as required. Other selections also depend on the selected product.  For example, the Node list only includes nodes for the product you select.
7. Use Attribute filter and, for queue viewlets, Find messages to search for specific cases.
8. Click Save Changes. The viewlet is displayed at the bottom of the current dashboard. 

Create a New Viewlet Consisting of Favorite Objects

The Add favorite viewlet dialog box is displayed when Create For Favorite Objects is selected from the Create Viewlet dialog box. See What are favorite objects viewlets and Create a Favorite Objects Viewlet for more information.

Create a New Viewlet from a File

If you or another user has exported viewlet properties to a file (see Exporting viewlet parameters to a file), you can import that file to create a new viewlet. 

1. Select the Import Viewlet File option from the Create Viewlet dialog box.
   
2. After you choose a file, the Viewlet Name is filled in, based on the file contents. 
   
3. Click Import to add the viewlet to the dashboard.

Create a New Viewlet from External Resource

You can create a viewlet using an external resource, like a knowledge base or intranet, if it supports embedding making it viewable directly in meshIQ Manage. If you use XRay/Track, this feature enables integration, allowing you to view XRay/Track viewlets directly within meshIQ Manage.

To create a viewlet using an external resource, select Create From External Resource viewlet from the Create Viewlet window. The Create New External Resource Viewlet dialog opens. 

Enter a name for the viewlet and the URL of the external source. Select the workgroup server in the last field and click Ok. You can check the 'Multi-Selection' checkbox to select multiple workgroup servers. You can also select 'regex' to choose all grouped connections.

If you are adding an XRay/Track viewlet, refer to Can I publish a viewlet on a web page? For information on how to share the viewlet and retrieve its URL.

The viewlet will now appear on your dashboard. Below is an example.

Open Existing Viewlet

To open an existing viewlet, select Open Existing Viewlet from the Create Viewlet window . The Add Existing Viewlet window opens. This window displays all the existing viewlets available within the workgroup server, including those from all active connections. Select the desired viewlet and click to open existing viewlet. To find a viewlet in the list, use the Filter by field.