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

Exporting Viewlets (Widgets) to a JSON File

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

You can export the parameters of a widget to a local file. For example, for a queues widget, the following parameters are included in the file:

  • Widget name
  • WGS
  • Node
  • Manager
  • Object Name
  • EMS checkbox
  • Find messages (message criteria), if any
  • Attribute filters, if any

To export a widget's properties to a JSON file, select Export Widget to file from the widget's menu.

A JSON file will automatically be saved to your Downloads folder. This file can then be used to create a new widget. See Creating Widgets in the Dashboard. 

When you export a widget (such as Bar Chart, Pie Chart, Number, Metric Trends, or Table), the system preserves the widget type in the JSON file. When you use this file to create a new widget, it creates the same widget type.

Sample File Contents

{
  "version": "12.1.0-SNAPSHOT_434",
  "wgsConnections": [
    {
      "connectionId": 2,
      "connectionName": "REMOTE WGS",
      "serversList": "129.80.141.85",
      "port": 4010
    }
  ],
  "wgsConnectionGroups": [],
  "schemas": [
    {
      "id": 60,
      "name": "Default Managers Dir",
      "objectType": 204,
      "defaultSortColumn": "Manager Name",
      "defaultSortDirection": 1,
      "secondarySortColumn": "null",
      "secondarySortDirection": -1,
      "schemaType": 0,
      "sharedGroups": [],
      "attributes": [
        {
          "schemaId": 60,
          "attributeParameter": 2015,
          "sortOrder": 1
        },
        {
          "schemaId": 60,
          "attributeParameter": 20007,
          "sortOrder": 2
        },
        {
          "schemaId": 60,
          "attributeParameter": 20812,
          "sortOrder": 3
        },
        {
          "schemaId": 60,
          "attributeParameter": 20813,
          "sortOrder": 4
        },
        {
          "schemaId": 60,
          "attributeParameter": 31,
          "sortOrder": 5
        },
        {
          "schemaId": 60,
          "attributeParameter": 32,
          "sortOrder": 6
        },
        {
          "schemaId": 60,
          "attributeParameter": 20325,
          "sortOrder": 7
        },
        {
          "schemaId": 60,
          "attributeParameter": 20109,
          "sortOrder": 8
        }
      ],
      "customAttributes": []
    }
  ],
  "attributeFilters": [],
  "messageCriteria": [],
  "externalViewlets": [],
  "searchViewlets": [
    {
      "id": 109,
      "widgetType": 0,
      "aggregationFunction": 0,
      "groupByAttr": 2125,
      "valueAttr": 31,
      "name": "Queue Managers",
      "connectionIds": [
        2
      ],
      "connectionInformation": {
        "connectionRegexes": [],
        "selectedConnectionIds": [
          2
        ],
        "selectedConnectionGroupIds": []
      },
      "searchData": {
        "nodeName": "*",
        "qmgrName": "*",
        "objType": 1,
        "objSubType": null,
        "dataLimitOffset": 100,
        "extraName": null,
        "projectIdsInfo": [],
        "productType": 0,
        "showEmptyQueues": true,
        "showSystemObjects": true,
        "activeAttrFiltering": false,
        "viewletColor": null,
        "showInactiveCh": true,
        "flatColor": false,
        "activeFindMsgs": false,
        "attributeFilterId": null,
        "filterType": 0,
        "filteredColumns": [],
        "manageFilterColumns": false,
        "frozenColumns": [],
        "isMultiConnection": false
      },
      "searchObjNames": [
        "*"
      ],
      "schemaId": 60
    }
  ],
  "favoriteViewlets": [],
  "searchDashViewletData": [
    {
      "viewletId": 109,
      "width": 6,
      "viewletType": 702,
      "visible": true,
      "expanded": true,
      "height": 8,
      "xPos": 0,
      "yPos": 6,
      "advancedFilterVisible": false
    }
  ],
  "favoriteDashViewletData": [],
  "externalDashViewletData": []
}

________________________________________________________________________________________________________________

Version 11.3 and Earlier

You can export the parameters of a viewlet to a local file. For example, for a queues viewlet, the following parameters are included in the file:

  • Viewlet name
  • WGS
  • Node
  • Manager
  • Object Name
  • EMS checkbox
  • Find messages (message criteria), if any
  • Attribute filters, if any

To export a viewlet's properties to a JSON file, select Export viewlet to file from the viewlet's menu.

ViewletExprtFile.png

A JSON file will automatically be saved to your Downloads folder.  This file can then be used to create a new viewlet. See Adding a viewlet to your dashboard.

ViewletFile.png

Sample File Contents

{
"version": "v11.1.1.11",
"wgsConnections": [
{
"connectionId": 1,
"connectionName": "Primary Connection",
"serversList": "10.0.0.91",
"port": 4010
}
],
"wgsConnectionGroups": [],
"schemas": [
{
"id": 22,
"name": "Default Local Queues Dir",
"objectType": 21,
"defaultSortColumn": "Queue Name",
"defaultSortDirection": 1,
"secondarySortColumn": "null",
"secondarySortDirection": -1,
"schemaType": 0,
"sharedGroups": [],
"attributes": [
{
"schemaId": 22,
"attributeParameter": 3011,
"sortOrder": 1
},
{
"schemaId": 22,
"attributeParameter": 3,
"sortOrder": 2
},
{
"schemaId": 22,
"attributeParameter": 15,
"sortOrder": 3
},
{
"schemaId": 22,
"attributeParameter": 9,
"sortOrder": 4
},
{
"schemaId": 22,
"attributeParameter": 10,
"sortOrder": 5
},
{
"schemaId": 22,
"attributeParameter": 17,
"sortOrder": 6
},
{
"schemaId": 22,
"attributeParameter": 18,
"sortOrder": 7
},
{
"schemaId": 22,
"attributeParameter": 20109,
"sortOrder": 8
}
],
"customAttributes": []
}
],
"attributeFilters": [],
"messageCriteria": [],
"externalViewlets": [],
"searchViewlets": [
{
"id": 1118,
"name": "Local Queues",
"connectionIds": [
1
],
"connectionInformation": {
"connectionRegexes": [],
"selectedConnectionIds": [
1
],
"selectedConnectionGroupIds": []
},
"searchData": {
"nodeName": "*",
"qmgrName": "*",
"objType": 11,
"objSubType": 1,
"dataLimitOffset": 100,
"extraName": null,
"projectIdsInfo": [],
"productType": 0,
"showEmptyQueues": true,
"showSystemObjects": true,
"activeAttrFiltering": true,
"viewletColor": null,
"showInactiveCh": true,
"flatColor": false,
"activeFindMsgs": true,
"attributeFilterId": null,
"filterType": 0,
"filteredColumns": [],
"manageFilterColumns": false,
"frozenColumns": [],
"isMultiConnection": false
},
"searchObjNames": [
"*"
],
"schemaId": 22
}
],
"favoriteViewlets": [],
"searchDashViewletData": [
{
"viewletId": 1118,
"viewletType": 714,
"pos": 1,
"visible": true,
"expanded": true,
"height": 290
}
],
"favoriteDashViewletData": [],
"externalDashViewletData": []
}