Business units backup and restoration

Definitions for every type of business unit (tiers, applications, transactions, and reporting groups) can be

  • Imported directly from another Server Monitoring
  • Exported to enable backing up or mirroring configuration The export and import utility can be accessed by users with administrative rights from the Business Units screen.

Export each type of business unit separately or all in a single step.

Exporting the business units enables you to store all of the rules, including reporting hierarchy and tier properties.

Exporting business unit definitions

The Exporting and importing utility for business units enables a report server administrator to back up reporting group, application, transaction, and tier definitions. The export utility is accessed from the Business Units screen and the export output is shown in a web browser.

The exported definitions are in YAML format. This structure is capable of carrying information on tiers, multi-level reporting hierarchy, and user assignments. Do not manually modify the exported structure.

Within the presented structure, the uid parameter is the key to distinguishing between particular definitions. Ensure each exported entity has a unique uid to prevent errors and overwriting during definitions import. Exported uid values must never be changed.

To export definitions of reporting groups, applications, transactions, or tiers:

  1. Log on to the NAM Server as a user with administrative rights.

  2. Go to the Business units screen.

    Access options:

    • From the NAM Server menu, choose Settings ► APM model ► Business units.
    • From the NAM Console top menu, choose Configuration ► Tiers, applications and transactions, and then choose the server for which to access the Business units screen.
  3. Click Export to activate the Exporting and importing utility.

  4. Select the definition types to export.

    You can select more than one type.

  5. Click Export.

    All exported entities and rules are displayed on the screen in the text area. The export is the exact representation of your rules, including names, user assignments, and reporting hierarchy levels.

    The resulting export structure is in YAML format. Do not manually modify. If you intend to copy the definitions directly from the screen, be sure to include all of the screen contents.

    If the exported definition exceeds the limit set for the import, the warning appears. You will need to divide the definition into chunks of about 45 000 lines and perform the import in stages. Divide the definition at the top hierarchy (application) level.

  6. Optional: Save the exported definitions.

    To back up the definitions, select the entire text that appears in the text area above selection options. Paste the definitions in a text file to use it later for restoring during disaster recovery.

    You can also select the content and paste it directly onto another report server using the Exporting and importing utility tool.

Importing business unit definitions

Import the definitions for tiers, applications, transactions, and reporting groups directly from another Server Monitoring or restore the definitions using a previously stored backup file. The server allows two syntax types at import time: simple text file and YAML format. While both types are human readable, the text file does not support the multi-level reporting hierarchy.

Recommended: Import definitions that were generated by the NAM Server that you know have worked previously. Do not import YAML definitions created outside of the report server. Also ensure that each imported entity has a unique uid to prevent import errors or accidental overwriting during the import.

To import definitions of reporting groups, applications, transactions, or tiers:

Log on to the NAM Server as a user with administrative rights.

Go to the Business units screen.

Access options:

  • From the NAM Server menu, choose Settings ► APM model ► Business units.
  • From the NAM Console top menu, choose Configuration ► Tiers, applications and transactions, and then choose the server.

Click Import to activate Exporting and importing utility.

Paste your definitions into the edit box.

The syntax of imported definitions is verified before they are placed in the server configuration. All invalid definitions are rejected.

You can enter definitions in either YAML format or in plain text configuration file format. Note that only YAML is capable of carrying tier or reporting hierarchy information.

  • You can use the values exported through the Control Panel in the NAM Server. Be sure the pasted values are not changed during copying and pasting. Entities with duplicate uid values will be overwritten. For more information, see Exporting business unit definitions above.
  • Business Units Configuration screen is capable of exporting YAML definitions in size of 190 000 lines and more, which is over the limit set for the definitions import. In such case, the Import dialog displays a warning. Divide the exported definition into smaller chunks of about 45 000 lines each and import the definition in stages. Divide the definition at the top hierarchy (application) level.
  • Definitions used in plain text format require the following format:
 Reporting_Group_Name = SoftwareService_Name,Server_IP,URL

Optional: Select to overwrite the existing tier.

When you select Overwrite conflicting tiers, the tiers with identical sequence numbers are overwritten by the imported definitions. A tier sequence number identifies the tier position in the hierarchy of tiers. When you export tiers definitions, the tier position in the sequence is stored. By default, the existing tier order is always preserved, to restore the order from the backup definition the option, Overwrite conflicting tiers must be selected.

Click Import to submit the definitions to the report server.

After your changes are validated, the report server will return the result of the definition validation. The validation summary consists of:

  • The number of defined reporting groups, applications, transactions, and tiers.
  • The number of definitions that conflict with existing definitions because of the application/transaction/reporting group/tier name or uid .
Note

Definitions are added incrementally, which means that imported definitions are added to the existing configuration data without overwriting it. When the definitions conflict, however, the previous configuration will be overwritten, except for the entries defined in an external configuration file.