Trace: » The Dumpentity Plugin

Moved to : https://forge.indepnet.net/wiki/dumpentity/En_manual

The Dumpentity Plugin

This extension works with version 0.70 of GLPI or greater

This extension allows you to export entity data in CSV format.

The data can be retrieved by a user (for use in spreadsheet), or from a remote machine using a script, but it is particularly intended to be used in a federated GLPI system with satellite servers using the loadentity plugin to import entity data from the Dumpentity plugin on a central GLPI server.

Installation

After decompressing the archive into the plugin folder of GLPI GLPI log on as administrator:

Access: Configuration / Plugins / Export Feature / Installation

This will create the tables used by the plugin.

When updating an existing installation to a new version, the “Update” option will be displayed. Selecting this option will update the tables.

Rights Management

Management models

Access: Configuration / Plugins / Export Feature / management models

A pattern is a list of tables to be exported.

The extension comes with 2 models:

  • Export complete all tables can be exported by the plugin
  • Export HelpDesk local minimum for a very small list

Management rights profile

Access: Administration / Profils / onglet Export d'entité

This option allows you to define if selected profiles can use the extension to export the database. It combines a model to a profile. The export will be for the current entity.

Note: Manual exporting is not the best use of this plugin.

Rights Management client computer

Access: Configuration / Plugins / Export Feature / Rights Management client computer

This option defines the IP addresses that can access the CSV download. In this case there will be no further authentication address.

It combines a model and an entity to an address.

Use

Don't forget to activate plugin before using

Access : Configuration / Plugins / Export Feature / Activation

Recovery interactive

Access: Plugins / Export Feature

From this screen, an authorized user can download the CSV of the current entity.

Note: the export is not recursive and only affects parts of the entity, not sub-entities.

Depending extensions, exporting can be done in the following formats:

  • .csv file: a single table
  • .csv.gz a single table
  • .zip: an archive containing all the tables
  • .tar.gz: archive containing all the tables

In the case of recovery in the form of an archive, a file is provided tables.csv containing the list of tables, their description and size of the csv.

Remote Recovery

Access: from a authorized IP address.

  • Retrieve the list of tables:

URL: http://nomduserveur/glpi/plugins/dumpentity/front/plugin_dumpentity.getcsv.php

  • Retrieve the list of a table:

URL: http://nomduserveur/glpi/plugins/dumpentity/front/plugin_dumpentity.getcsv.php?table=nom

  • Retrieve the list of a compressed table:

URL: http://nomduserveur/glpi/plugins/dumpentity/front/plugin_dumpentity.getcsv.php?table=nom&gzip=1

This method does not require recovery of an archive.

This method is used by the extension loadentity

Tips

Avoid multiple users using this plugin, especially during the normal hours as it ca nconsume a lot of resources on the GLPI server.

Have users create a scheduled task to run the plugin (this will indeed be changing the plugin).

Known Issues

  • Complete export format. Zip

This option is available if you have the zip extension to php. This option is included as standard with php 5.2.x or as an extension pecl for previous versions (php-pecl-zip for Fedora / RHEL / CentOS).

Pay attention to use the latest version of the extension, problems were reported with earlier versions. It works correctly with php-zip-5.2.4 or 1.8.8 (xampp 1.6.4 on Windows).

  • Complete export format. Tar.gz

This option is available if you have the Archive_Tar extension for php. This option is included as standard with PEAR (php-pear for Fedora / RHEL / CentOS, xampp 1.6.4 on Windows).