3.2.4 Dashboard Import / Export Function and Expanded Delete Function

(a) Overview

The following REST APIs are provided for importing and exporting dashboard definitions: You can use these REST APIs to migrate, back up, and recover dashboard definitions. You can also divert and duplicate the acquired dashboard definition.

• Get Dashboard Definitions API (Export Dashboard Definitions feature)

  You can export only the dashboard definitions that are visible to JP1 users running REST API.

  For details about the Get Dashboard Definition API, see 5.20.1 Get Dashboard Definition in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

• Add Dashboard Definition API (Import Dashboard Definition Feature)

  For details about the Add Dashboard Definition API, see 5.20.3 Add Dashboard Definition in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

It also provides the following REST API for retrieving and deleting a list of currently defined dashboard definitions:

• Get Dashboard Definitions List API

  For details about the Get Dashboard Definition List API, see 5.20.2 Get Dashboard Definitions list in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

• Delete Dashboard Definitions API

  For details about the Delete Dashboard Definition API, see 5.20.4 Delete Dashboard Definition in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

(b) Use case

- Migrate Dashboard Definitions During Setup

• Migrate without editing SID because the configuration (including the hostname) is the same in the development environment and the production environment.

  If your system is one of the following categories, migrate to the production environment without editing the dashboard definition in your development environment:

  • The configuration (including the hostname) and tree SID are the same in the development environment and the production environment.

  • The tree SID is not set in the dashboard definition to be migrated.

  You can migrate dashboard definitions as follows:

  1. Run the Get Dashboard Definitions API to get the dashboard definitions for your development environment-data in JSON format.

  2. Specify the dashboard definition to your production environment with the Add Dashboard Definition API by specifying the captured dashboard definition in the parameter.

• Because the hostname of the system differs between the development environment and the production environment, SID must be edited and migrated.

  If the dashboard definition to be migrated has a tree SID and SID are different in the pre-and post-migration environments, move to the production environment after editing the tree SID of the dashboard definition in the development environment.

  You can migrate dashboard definitions as follows:

  1. Get dashboard definition (JSON format data) of the development environment with the Get Dashboard Definition API.

  2. Edit the obtained dashboard definition tree SID in a text editor, for example, to suit your production environment.

  3. Specify the dashboard definition to your production environment with the Add Dashboard Definition API by specifying the edited dashboard definition in the parameter.

- Updating Dashboard Definitions During JP1/IM Operation

When adding or editing dashboard definitions while JP1/IM is in operation, if you are testing in a development environment to ensure that there are no problems and then migrating to a production environment in order not to corrupt the production environment, update the dashboard definitions with only API Get, Add, or Remove Dashboard Definitions. This assumes that you have already defined a dashboard with the same settings in your development and production environments.

You can update the dashboard definition as follows:

1. Edit the dashboard definition in your development environment and get it as an updated dashboard definition in the Get Dashboard Definitions API.

2. Specify the dashboard definition to your production environment with the Add Dashboard Definition API by specifying the captured dashboard definition in the parameter.

3. In the Get List of integrated operation viewer (GUI) or Dashboard Definitions API, verify that you successfully added the updated dashboard definition to your production environment.

4. You can update a dashboard definition by specifying and deleting ID of pre-update dashboard definitions that remain in production in integrated operation viewer (GUI) or the Delete Dashboard Definitions API.

   If the dashboard is tied to a tree SID in IM management node, deleting the old dashboard definition causes the new dashboard definition to appear in the Dashboard tab.

   Note that you cannot directly overwrite an existing dashboard definition.

(a) Overview

When the dashboard get/list collection/deletion function for administrators^# is enabled, if JP1 resource group is "*" and you are logged in as a JP1 user with JP1_Console_Admin privileges, you can retrieve, list (list retrieve), and remove dashboard definitions for all JP1 users from integrated operation viewer or REST API. Note that you cannot edit dashboard definitions or change the publishing scope owned by other JP1 users other than the logged-in JP1 user.

#

If you are upgrading JP1/IM - Manager from a version earlier than 13-11 to version 13-11 or later and you want to use the dashboard get/list collection/deletion function for administrators, you must configure the settings to use the dashboard get/list collection/deletion function for administrators.

For details, see 2.4.1(1)(b) Dashboard List dialog box in the JP1/Integrated Management 3 - Manager GUI Reference, 5.24.2 Get Dashboard Definitions list and 5.20.4 Delete Dashboard Definition in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

In addition, enable/disable of the dashboard get/list collection/deletion function for administrators is set in jp1.imdd.http.adminAllowUserDashboard property^# of Intelligent Integrated Management Base definition file (imdd.properties).

#

When upgrading JP1/IM - Manager from a version earlier than 13-11 to a version later than 13-11, jp1.imdd.http.adminAllowUserDashboard property will not be added to Intelligent Integrated Management Base definition file (imdd.properties file). In this case, manually copy jp1.imdd.http.adminAllowUserDashboard property from the model file of the Intelligent Integrated Management Base definition file.

For details about Intelligent Integrated Management Base definition file, see Intelligent Integrated Management Base definition file (imdd.properties) in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

(b) Use Case

- Dashboard Definition Single Backup and Recovery

If you need to recover a dashboard definition, for example, because you accidentally deleted it when editing a dashboard, you can back up and recover only the dashboard definition using the get API and add API of Dashboard Definition without stopping operation.

For this process, it is assumed that the IM management node configuration remains the same during both backup and recovery.

Follow these steps to back up and recover dashboard definitions:

1. Back up the dashboard definitions (data in JSON format) using the Get Dashboard Definitions API.

2. Add and recover the backup dashboard definition in the Add Dashboard Definition API.

To back up and recover multiple dashboard definitions, create and run batch processes that use the Get and Add APIs on the dashboard IDs retrieved from the Get Dashboard Definition List API.

- Deleting Dashboards for deleted JP1 users

Enable the dashboard get/list collection/deletion function for administrators to remove the dashboard definitions owned by JP1 user whose JP1 resource group is "*" and who has JP1_Console_Admin privileges.

You can delete a deleted dashboard as follows:

1. Log in to the Integrated Operation Viewer (GUI) as a JP1 user with a resource group of '*' and JP1_Console_Admin permissions.

2. In the Dashboard list (which includes dashboards from all JP1 users, including deleted ones), select the dashboard owned by the deleted JP1 user, and then click [Delete] to delete it.

You can also remove dashboard definitions owned by other JP1 users. If you are logged in as a JP1 user with other permissions, or if the dashboard get/list collection/deletion function for administrators is disabled, you can only remove dashboard definitions owned by the logged in JP1 user.