Prerequisites

In order to have a successful installation of the ZigiWave ZigiOps and connect it with the corresponding third party, the following prerequisites must be met.

Dynatrace SaaS/Managed Requirements

Component

Required

Integration UserSuccessfully generated API Token with enabled "Access problem and event feed, metric, topology and RUM JavaScript tag management" option
Communication
  • Port 80/443 from ZigiWave ZigiOps to Dynatrace
  • Port 9094 (or any custom port) from Dynatrace to ZigiWave ZigiOps (optional)

Operations Bridge Requirements

Component

Required

Version10.x (or newer)
IntegrationSuccessful integration between Operations Bridge / Operations Connector
Communication
  • Port 30005 from ZigiWave ZigiOps to Operations Connector

Preparing Your Environment

The integration is achieved with the use of the ZigiWave ZigiOps platform, which acts as an adapter for mapping the data between the integrated software products. There are couple of points to consider while planning the integration deployment.

Dynatrace Environment

Dynatrace is considered as a source for the out-of-the-box integration. This means that the ZigiOps will collect data from Dynatrace and insert it into the target system, through Micro Focus Operations Connector.

Creating an API Token

You will need to create an API Token (or use an existing one), so the ZigiWave ZigiOps will be able to access your Dynatrace instance.

  1. Access the Dynatrace UI
  2. Go to Settings > Integration > Dynatrace API and click the Generate Token button
  3. Input a name for your token and enable the Access problem and event feed, metrics, and topology option. The other permissions are optional.

     Click here to expand...

Configuring a Problem Notifications (Optional)

By default, the ZigiWave ZigiOps is polling the problems on a scheduled interval. You can configure problem notifications, as an alternate method of getting the problem data. However the method will require the ZigiOps host to be accessible outside your network. The default listener port is 9094 (unless your specify otherwise via the ZigiWave ZigiOps settings).

  1. Access the Dynatrace UI.
  2. Go to Settings > Integration > Problem Notifications > Set Up Notifications and click the Custom Integration button.
  3. Configure the custom integration itself settings:
    • Webhook URL → This is the ZigiWave ZigiOps listener path. By default it is HTTP(S)://ZIGIOPS.EXAMPLE.COM:9094/LISTENER/DYNATRACESAAS/PROBLEM. In case you decide to change the default port/protocol within the ZigiOps settings, remember to reflect the change here, as well.

      Please note that the ZigiOps is shipped with self-signed SSL certificate, so you should enable the Accept any SSL certificate (self-signed or invalid) option.

    • Custom Payload → This is where you can configure the Dynatrace Problems fields that will be sent to the ZigiWave ZigiOps.

      Dynatrace Problem Notification - Custom Payload (JSON)
      {
      	"ProblemTitle": "{ProblemTitle}",
      	"ProblemDetailsText": "{ProblemDetailsText}",
      	"State": "{State}",
      	"Severity": "{ProblemSeverity}",
      	"Impact": "{ProblemImpact}",
      	"ImpactedEntity": "{ImpactedEntity}",
      	"ImpactedEntities": {ImpactedEntities},
      	"Tags": "{Tags}",
      	"ProblemURL": "{ProblemURL}",
      	"ProblemIdentifier": "{PID}"
      }
  4. Click the Send Test Notification button to confirm, if the connection will be successful. Now click the Save button to save the changes.

Operations Bridge Environment

The ZigiOps delivers the collected data to Micro Focus Operations Bridge, through the Micro Focus Operations Connector. The communication between the ZigiOps and the Operations Connector is achieved using REST Web Service Listener policies, so it is not mandatory the Operations Connector to be installed on the same host with ZigiOps. They are pre-configured to deliver topology, events and metrics to Operations Bridge.

Integrating the Operations Connector and Operations Bridge

The integration requires an active and working integration between the Micro Focus Operations Connector and Micro Focus Operations Bridge.

If the integration between the Micro Focus Operations Connector and Micro Focus Operations Bridge is not working properly, the ZigiOps will continue sending data to the Micro Focus Operations Connector, however the data will not be delivered to Micro Focus Operations Bridge.

Deploying the Operations Connector policies

To import and activate the policies:

  1. Access the Micro Focus Operations Connector UI and press the Import button.

  2. Now browse to the policies folder, located at C:\ZIGIWAVE\ZIGIOPS\CONF\RESOURCES\BSMC10-POLICIES and import them.

  3. Once the policies are imported, you have to select and activate them by clicking the Activate button.

Configuring the ZigiOps System Definitions

Adding source/target products connectivity information as a System Definition to the ZigiOps is done from the ZigiOps Web Console.

Dynatrace System Definition

Follow the steps below in order to add the Dynatrace instance as a System Definition to the ZigiOps Web Console.

  1. Navigate to Configurator > System Definitions > New System > Dynatrace and configure the following parameters:
    • Display Name → The Dynatrace display name. We're recommending to use the instance environment id, but it is up to you.
    • Environment ID → The Dynatrace Environment ID. For example if your instance URL is HTTPS://ABC12345.LIVE.DYNATRACE.COM, the id would be ABC12345.
    • API Token → The Dynatrace API Token, that was previously generated. It is used as an authentication method.
    • Environment Type → The Dynatrace instance environment type. It might be either SaaS or Managed.
      • Managed Environment Domain → The Dynatrace Managed Domain. Only needed, if Managed Instance is selected.
    • Proxy Settings → Enables the usage of a proxy server

    • Proxy Authentication → Select your proxy authentication method, if your proxy server requires it

  2. Examine the settings and if they are correct, click the Submit button to save the system.

  3. Click the Test Connection button to confirm, if the connection was successful.

Operations Connector System Definition

Follow the steps below in order to add the Micro Focus Operations Connector instance as a System Definition to the ZigiWave ZigiOps Web Console.

  1. Navigate to Configurator > System Definitions > New System > Operations Connector and configure the following parameters:
    • Operations Connector Server URL → The Micro Focus Operations Connector URL in the following format HTTP(S)://<FQDN>:<PORT>. For example HTTPS://OPSCX.EXAMPLE.COM:30005 

    • Proxy Settings → Proxy Settings - Enables the usage of a proxy server
    • Proxy Authentication → Select your proxy authentication method, if your proxy server requires it

  2. Examine the settings and if they are correct, click the Submit button to save the system.

  3. Click the Test Connection button to confirm, if the connection was successful.

Configuring the ZigiOps Connector Settings

Connector Setup

The Connector Setup is the last point in order to finalize the integration configuration.

Settings

When landing on the Settings page for the first time, you will be guided through several steps in the form of configuration wizard for enabling the integration.

  1. SystemsOn this screen you should choose the source/target products. If you have added only one product per type, they will be automatically populated. If you have more than one product of either type, you will be able to choose which one to use, from the drop-down menus. Press the Next button to continue.

  2. Dynatrace Listener Settings On this screen you can configure the listener port and protocol that the ZigiWave ZigiOps will use to accept the incoming data from Dynatrace's problem notifications. Press the Next button to continue.

  3. SchedulingOn this screen you will see the options to configure the scheduled intervals for collecting data.

  4. Actions - On this screen you might select which of the integration actions to be enabled. If you are not sure what to select here, accept the defaults, which will set all actions as enabled. Press the Next button to continue.

  5. Setup Completion - On the last screen you will see a message stating that the initial setup has been finished, but still need to be submitted. After you submit the settings, you will be returned to the Settings page, where you can modify the settings at any time. Press the Submit button to enable the integration.

Status

The Status Page presents the last run status of each action in the integration. When first landing on that page after enabling the integration, you will see the overall status as Unknow, because no data has passed through it, yet. When data starts flowing through the integration, you will see the corresponding status of each action and the overall status will be an aggregation.

Data

The Data Page presents the last payload received from the source system and the corresponding payload sent to the target system.
There are two drop-down menus which you use to display the needed data:

  • Action - Choose the action for which you want to see the data
  • Data - Choose the exact data for the corresponding action

In this topic