Using the Data Flow Management Java API

This section explains how third-party or custom tools can use the Micro Focus Data Flow Management Java API to manage Data Flow.The API provides methods to:

• Manage credentials. View, add, update, and remove.

• Manage jobs. View status, activate, and deactivate.

• Manage probe ranges. View, add, and update.

• Manage triggers. Add or remove a trigger CI, and add, remove, or disable a trigger TQL.

• View general data. Data on domains and probes.

The following services are available in the Discovery Services package:

• DDMConfigurationService. Services to configure the Data Flow Probes, clusters, IP Ranges, and Credentials.The Universal Discovery server can be configured with an XML file or via the Data Flow Probe.

• DDMManagementService. Services to analyze and view the progress, results, and errors of the Universal Discovery run.

• DDMSoftwareSignatureService. Services to define software items to be discovered by the Data Flow Probe components. The definitions are system-wide. If more than one Data Flow probe component is defined, the definitions apply to all of them.

• DDMZoneService. Services to manage zone-based discovery.

In addition to these services, there are Data Flow Management client APIs, which are used in creating Jython adapters. For details, see Developing Jython Adapters.

Permissions

The administrator provides login credentials for connecting with the API. The API client needs the user name and password of an integration user defined in the CMDB. These users do not represent human users of the CMDB, but rather applications that connect to the CMDB.

In addition, the user must have the Access to SDK general action permission in order to log in.

Caution The API client can also work with regular users as long as they have API authentication permission. However, this option is not recommended.

For details, see Create an Integration User.