Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Data collector Base ======
---- dataentry summary ----
name                : Data collector Base
description_wiki    : Inventory Data Collector toolkit for creating your own data collectors
index_hidden        : yes
level_hidden        : 1
collector_hidden    : yes
version             : 1.3.0
release_dt          : 2023-03-15
TeemIp              : 2.7.x - 3.x
code                : itop-data-collector-base
state               : stable
product_hidden      : Not Included
module-lists_hidden : itop-data-collector-base/1.3.0
provider            : Combodo
standalone          : yes
keyword_tags        : Framework, ETL
dependencies_s      : 
download_wiki       : [[https://store.itophub.io/en_US/products/itop-data-collector-base|Data collector base API]]
php-max             : 8.1
----

This module provides the base for creating an industrial data collection and synchronization application for iTop. Developers can rely on this module to perform all the heavy lifting related to the iTop data import and synchronization process in order to focus on the data collection.

<note>
This extension is actually provided through [[https://www.itophub.io/|iTop Hub]], the platform that centralizes all the required resources to optimize your iTop. 
</note>


===== Features =====

  *  Simple API to make the creation of a new collector fast and easy.
  *  Automatic creation and update of Synchronization Data Sources in iTop, based on JSON definitions.
  *  Support small variations to the target Data Model via explicitely “Optional” attributes
  *  Basic validation of the CSV format compared to the expected fields in the synchro data source.
  *  Data upload and synchronization by chunks of max_chunk_size (configurable).
  *  Extensible mechanism for handling configuration parameters.
  *  Extensible list of placeholders in the JSON definition.
  *  Automatic management (via placeholders) of the contact to notify and the user to use for running the synchro.
  *  Validation of the minimum version of PHP and the needed extensions (as specified by the collector).
  *  Command line tool to produce the JSON definition from an existing Synchro Data Source in iTop.
  *  Capability to run independently: the configuration of the data sources, the data collection and the data synchronization.
  *  Configurable log level (for console output or syslog logging)
  *  Simple framework for quickly creating SQL based collectors

===== Limitations =====

  *  Data upload to iTop is done only via the syncho_import web service (could use the command line version or direct SQLcommands. TBD later, maybe)
  *  Prior to the revision 3805 of iTop from SVN (from 2015-10-12!) the collector will NOT work properly if the account used to connect to iTop is not configured to use English as the language !!
  *  Collector can only use the login_mode = “form”, it is not possible to use SSO authentication
  *  Collectors are using [[https://www.itophub.io/wiki/page?id=latest:advancedtopics:synchro_import|synchro_import]], but does not propagate yet date_format

===== Full documentation =====

Comprehensive documentation on that extension is available [[https://www.itophub.io/wiki/page?id=extensions:itop-data-collector-base|here]], on iTop Hub.
Documentation

User Tools

Site Tools

Page Tools
