Skip to main content

system.kanoa.dashboard.importDashboard(exportInfo, userId)

Imports dashboard information along with the widgets that it's constructed with, and creates a new dashboard on the target system

Parameters​

exportInfo Dictionary: Dictionary that contains dashboard info and all associated widget info
userId Integer: Id of user executing the function

Returns​

dashboardId Integer None if dashboard not created
importLogs List of Strings list of information about the import steps

Example​

userId = 5
exportInfo = {
  "data": {
    "folder": [
      {
        "folderDescription": null,
        "roles": null,
        "parentPath": null,
        "icon": null,
        "folderId": 8,
        "parentId": null,
        "folderPath": "System Dashboards",
        "path": "System Dashboards",
        "changedDate": null,
        "createdDate": "2024-07-21 14:49:57.94",
        "createdBy": 5,
        "changedBy": null,
        "sortOrder": null,
        "iconColor": null,
        "folderName": "System Dashboards"
      }
    ],
    "dashboardInfo": {
      "private": false,
      "roles": null,
      "showOnMobile": false,
      "folderId": 8,
      "enabled": true,
      "dashboardName": "Asset Overview",
      "folderPath": "System Dashboards",
      "path": "System Dashboards\\Asset Overview",
      "changedDate": "2024-07-21 14:51:06.243",
      "createdDate": "2024-07-21 14:50:39.27",
      "dashboardId": 4,
      "createdBy": 5,
      "changedBy": 5,
      "sortOrder": null,
      "iconColor": "#00D9D9",
      "dashboardDescription": "Provides an enterprise overview of assets for a user with drill down capability. Primarily used for landing page.",
      "iconPath": "kanoa/enterprise"
    },
    "widgets": [
      {
        "widgetLink": {
          "widgetName": "Assets Overview",
          "widgetId": 38,
          "enabled": true,
          "dashboardName": "Asset Overview",
          "viewPath": "kanoa/mes/asset/overview/mainView",
          "breakpointId": 2,
          "columnEnd": 21,
          "changedDate": null,
          "breakpointName": "Desktop",
          "widgetDescription": "Provides a hierarchical view of all assets providing drill down capability",
          "createdDate": "2024-07-21 14:50:50.01",
          "size": null,
          "dashboardId": 4,
          "createdBy": 5,
          "dashboardWidgetId": 26,
          "changedBy": null,
          "columnStart": 1,
          "rowStart": 1,
          "rowEnd": 21,
          "viewParams": "{\"assetId\": null, \"expand\": true, \"level\": 0}"
        },
        "widgetCategory": {
          "changedDate": null,
          "widgetCategoryDescription": null,
          "widgetCategoryName": "Analytics",
          "createdDate": "2024-07-09 00:00:00.0",
          "createdBy": 5,
          "changedBy": null,
          "widgetCategoryId": 7,
          "enabled": true
        },
        "widgetInfo": {
          "widgetName": "Assets Overview",
          "widgetCategoryName": "Analytics",
          "widgetId": 38,
          "widgetPath": "Analytics\\Assets Overview",
          "widgetCategoryId": 7,
          "enabled": 0,
          "viewPath": "kanoa/mes/asset/overview/mainView",
          "path": "Analytics\\Assets Overview",
          "changedDate": null,
          "widgetDescription": "Provides a hierarchical view of all assets providing drill down capability",
          "createdDate": "2024-07-21 14:22:46.933",
          "createdBy": 5,
          "changedBy": null,
          "sortOrder": null,
          "viewParams": "{}"
        },
        "breakpoint": {
          "rowGap": 5,
          "columnCount": 20,
          "enabled": true,
          "breakpointId": 2,
          "changedDate": null,
          "breakpointName": "Desktop",
          "createdDate": "2024-07-08 18:33:35.377",
          "size": null,
          "columnGap": 5,
          "createdBy": 39,
          "changedBy": null,
          "columnWidth": null,
          "rowCount": 20,
          "breakpointDescription": null,
          "rowHeight": null
        }
      }
    ]
  },
  "exportType": "dashboardInfo"
}
system.kanoa.dashboard.importDashboard(exportInfo, userId)