Usage Manual

This page describes how the connector can be used and configured.

Prerequisites

The machine that runs CMDBuild must be able to reach the MySQL server that hosts the OCS Inventory database (by default on port 3306).

The connector authenticates to the database with a username and a password. The database user must be allowed to read the following tables of the OCS database:

accountinfo
bios
drives
hardware
inputs
local_groups
local_users
monitors
networks
ports
printers
sim
software
software_name
software_publisher
software_version
sounds
storages
videos
virtualmachines

The connector only performs SELECT queries and never writes on the OCS database.

Connector dependencies

The connector requires the installation of the Connector utils plugin version 2.0.0 or higher and CMDBuild version 4.2.0 or higher.

Configuration

Plugin configuration

The standard connector plugin configuration can be found here.

This connector has no additional plugin configurations.

Instance configuration

Each instance of the connector reads the database of a single OCS Inventory server.

Config	Default	Description	Notes
Key*		Name that identifies the OCS server instance	Must uniquely identify a single instance
Active		Determines if this instance is processed during batch execution
URL*		Address of the OCS database	Accepted formats: jdbc:mysql://host:port/dbname, host:port/dbname, host/dbname, host:port, host. Missing parts are filled with the default values: port 3306 and database ocs. If the value does not match any of these formats the instance read fails
Username*		Username used to connect to the database
Password*		Password used to connect to the database

Entities preview

100%

Hardware is related to all the other records: its arrow points to the dashed container, which groups those records.

The diagram provides a high-level overview of the entities extracted by the connector and the relationships between them.

The diagram uses the following conventions:

• Orange containers represent CMDBuild superclasses. The entities contained within them belong to the corresponding superclass.

• Dashed orange containers group all the entities that are related to an entity outside the container. An arrow pointing to the container represents a relationship with each of the entities inside it.

• Blue boxes represent record types extracted by the connector. Each box is labeled using the format {Source Object Name} ({_type}), combining the object name used by the source service with the internal record type produced by the connector.

• Arrows represent relationships between entities managed by the connector. The arrow points to the "many" side of the relationship, as indicated by its label (1 : N).

Below is a list of all the entities retrieved by the connector.

• hardware (hardware)
• networks (net_interface)
• software (software)
• drives (disk)
• storages (storage)
• ports (port)
• sim (sim)
• videos (video_card)
• sounds (sound_card)
• virtualmachines (virtual_machine)
• inputs (input_device)
• printers (printer)
• monitors (monitor)
• local_groups (local_group)
• local_users (local_user)

Additional Information

Synchronization to Application Classes

The standard connector imports and maintains data within the CMDBuild standard classes and relationships, providing a consistent representation of the data.

As a separate and optional customization activity, organizations may define additional synchronization processes to populate application-specific classes from the imported infrastructure data. Through custom mappings and enrichment rules, connector resources can be associated with organization-specific business objects, services, assets, or other application entities.

This approach supports customer-specific business models, enrichment processes, and classification rules while preserving the standard infrastructure representation provided by the connector.

Known Limitations

• The connector operates in read-only mode.
• Large environments may require increased execution time.
• No real-time synchronization: data is updated only during scheduled runs.
• The plugin is distributed under a Subscription license model. Its usage is tied to an active support and maintenance agreement, which is subject to expiration and must be renewed to remain valid.

Deployment Guidelines

Deployment of the connector includes the creation of standard CMDBuild classes and relationships corresponding to supported connector resource types. These structures provide the foundation for storing and organizing synchronized infrastructure information. The deployment process also includes configuration elements required for data visualization and the establishment of scheduled synchronization activities.

Following deployment, it is recommended to validate the configuration by executing an initial synchronization and reviewing the imported data.

Scheduling frequency should be selected according to the scale of the environment, expected rate of infrastructure change, and operational reporting requirements.