Documentation forDatabase Performance Analyzer

Import and export custom entities

If you have multiple DPA servers, they can share the following custom entities:

  • Custom properties that can be used in alert notification templates
  • Rules that determine which database instances are assigned to alerts
  • Alerts

You can export custom entities from one server and import them to another. In a large deployment, use this capability to implement a common set of alerts, rules, and custom properties on all servers. You can also use it to ensure that a testing or staging environment matches the production environment. In addition, exporting custom entities to a file provides a backup of your custom entities.

Existing entities with the same name

When you import custom entities, DPA creates new entities. Existing entities of the same type and with the same name are not updated during an import. To import an updated version of an existing entity, you must either rename or delete the existing entity on the target server.

Exporting custom entities

The export includes all alert definitions, custom properties, and rules.

  1. Log in to DPA as a user with administrative privileges.

  2. From the DPA menu in the upper-right corner, click Options.

  3. Under Support > Utilities, click Export Custom Entities.

    The Export Custom Entities wizard opens.

  4. Click Next.

    The Summary page lists the custom properties, rules, and alerts that will be exported.

  5. Click Finish & Export.

    The custom entity definitions are saved in a file for each entity type. These files are compressed to a .zip file named CustomEnties_YYYY-MM-DD-timestamp.zip. The .zip file is placed in the default download directory on your client computer.

    Do not edit these files with a text editor. The files cannot be imported if they have been edited.

Import custom entities

DPA imports all entities as long as an existing entity does not have the same name.

  1. Log in as an administrator to the DPA instance where you want to import the custom entities.
  2. From the DPA menu in the upper-right corner, click Options.

  3. Under Support > Utilities, click Import Custom Entities.

    The Import Custom Entities wizard opens.

  4. Drag the exported .zip file and drop it on the wizard, or browse to the file location.

  5. Click Next to import the entities.

    The Summary page shows the result of the import:

    • Names of custom entities that were created are shown in black.
    • Names of custom entities that could not be created (because an entity of that type with the same name already exists) are shown in orange with a message.

  6. Click Done to close the dialog.

No entities are listed during an import

During an import, you select a file that contains exported custom entities and then click Next. However, instead of listing the entities that were and were not imported, the screen is blank except for the headings.

To resolve this issue:

  1. Open the iwc.log file. (See DPA troubleshooting tips for information about accessing log files.)

  2. Search the log for the string CustomEntitiesImportController. Look for an error such as the one below, followed by the path and name of an exported custom entities file:

    CustomEntitiesImportController:195 - java.io.FileNotFoundException

  3. On the DPA server, go to the DPA-install-dir\iwc\tomcat directory and delete the following files:

    • customEntitiesZip
    • customEntitiesZipTemp
  4. Attempt the import again.