> For the complete documentation index, see [llms.txt](https://docs.editran.onesait.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.editran.onesait.com/documentacion-editran/connect-3.2-en/migracion/editran-export.md).

# Editran Export

Configuration export tool for Editran Classic and Editran Connect

This command-line utility allows exporting the configurations of the products **Editran Classic** and **Editran Connect**.

The tool can be run on the operating systems **Windows** and **RedHat**, using the corresponding binary in each case.

| Binary name          | Platform / OS |
| -------------------- | ------------- |
| *editran-export.exe* | Windows       |
| *editran-export*     | Linux         |

The binary **editran-export** is self-contained and does not need external dependencies.

It is not necessary for the binary **editran-export** to be in the same folder as the installed product to be exported, but it is recommended to place it in a known location in the file system of the machine where it will be run, and in a directory with read and write permissions for the user who will run it.

The tool must always be run from a terminal with the following requirements, depending on the indicated operating system:

* For Windows, first log in with the corresponding user who administers the product and run the editran-export tool from an **administrator terminal**.
* For RedHat, log in using the user `editran` (or equivalent) who administers the product to be exported before running the tool.

The different versions of the tool for each OS are available on the Editran product download website.

## Supported product versions

The tool is compatible with the following versions of the products mentioned above:

| Product                                 | Version                  |
| --------------------------------------- | ------------------------ |
| Editran Classic                         | 5.0.1 / 5.0.2            |
| 5.1.0                                   |                          |
| 5.2.0                                   |                          |
| 5.2.1.y                                 |                          |
| 5.3.y                                   |                          |
| Editran Connect                         | 1.1.12 / 1.1.16 / 1.1.17 |
| 1.2.20 / 1.2.23                         |                          |
| 2.0.6 / 2.0.7 / 2.0.8                   |                          |
| 2.1.5 / 2.1.7 / 2.1.9 / 2.1.12 / 2.1.13 |                          |
| 3.0.8                                   |                          |
| 3.x.y                                   |                          |

## How to use the tool

Below are all the available parameters for interacting with the configuration export tool.

| Parameter                                            | Description                                                                                                                                                                                                                                                     | Required | Usage example                                                                                |
| ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------- |
| <p><code>-i</code><br><code>--installpath</code></p> | Full path to the installation folder of the product whose configuration we want to export.                                                                                                                                                                      | YES      | <p><code>-i C:\EditranCoreConnect</code><br><code>--installpath C:\EditranConnect</code></p> |
| <p><code>-v</code><br><code>--version</code></p>     | Version and release of the Editran installation from which we want to export the data.                                                                                                                                                                          | YES      | <p><code>-v 5.2.0</code><br><code>--version 2.1.12</code></p>                                |
| <p><code>-p</code><br><code>--product</code></p>     | <p>Type of installed product from which to export the configuration.<br>Accepted values: <strong>Connect</strong> for Editran Connect and <strong>Editran</strong> for Editran Classic.</p>                                                                     | YES      | <p><code>-p Editran</code><br><code>--product Connect</code></p>                             |
| <p><code>-o</code><br><code>--output</code></p>      | <p>Full path to the output directory where the compressed file with the exported configuration will be created.<br>If not specified, the output will be the folder where the exporter is run.</p>                                                               | NO       | <p><code>-o C:\Users\admin\Downloads</code><br><code>--output /opt/migration</code></p>      |
| <p><code>-h</code><br><code>--help</code></p>        | <p>Help and information command for the tool.<br>Shows the accepted arguments, whether they are required or not, and the allowed values.<br>Help will also be shown if no arguments are provided when invoking the command or if any argument is incorrect.</p> | NO       | <p><code>-h</code><br><code>--help</code></p>                                                |
| <p><code>-t</code><br><code>--targz</code></p>       | <p>Packages the output file <code>data-export</code> in format <code>.tar.gz</code>, useful for Linux systems.<br>If this parameter is not specified, the default format will be <code>.zip</code>.</p>                                                         | NO       | `-t`                                                                                         |

NOTE: To specify an installation path `-i` that contains spaces, the full path must be specified in double quotes `""` so that validation is performed correctly. For example: `-i "C:\Editran v5.2.0"`

The tool includes the help command `-h`, `--help` which will show information similar to that collected in the previous parameter table.

As a usage example, the command `editran-export -h` will display the following information:

```shell
***** EDITRAN-EXPORT-TOOL *****
 Version: 1.0.0
 Compiled: 2025-11-27_13:36:17
*******************************
editran-export: Configuration export tool for Editran and Connect products.
Usage: editran-export -p <product-type> -i <installation-path> -v <version> [-o <output-path>] [-t]
     editran-export -h
  -p, --product <product-type>             Type of product from which to export the configuration.
                                           Valid values: editran or connect.
  -i, --installpath <installation-path>    Full path to the root of the product installation directory.
  -v, --version <ver.rel.minor>            Version and release of the installed product. Format X.X.Y
                                           Valid versions for the Editran product: 5.0.1, 5.0.2, 5.1.0, 5.2.0, 5.2.1.y, 5.3.y
                                           Valid versions for the Connect product: 1.1.12, 1.1.16, 1.1.17, 1.2.20, 1.2.23, 2.0.6, 2.0.7, 2.0.8, 2.1.5, 2.1.7, 2.1.9, 2.1.12, 2.1.13, 3.0.8, 3.x.y
  -o, --output <output-path>               Output directory for the export file.
  -t, --targz                              Packaging of the output file in .tar.gz format. The default format is .zip.
  -h, --help                               Shows this help. Default behavior if no flags are provided to the command.

Usage examples:
   editran-export --product Editran --installpath C:\EditranClassic --version 5.2.1
   editran-export -p Connect -i /opt/EditranConnect -v 2.0.8 -o /home/myuser -t
```

## Tool output

As a result of its successful execution, the tool generates a compressed file with the exported configuration data of the indicated product and with extension *.zip* or *.tar.gz* depending on the chosen compression parameter.

The compressed file will be named `data-export_<product>_<timestamp>.<zip/tar.gz>`.

As an example, the structure contained in the output compressed file can be as follows:

| **EDITRAN CLASSIC**                                                                                                                                                                                                                     | **EDITRAN CONNECT**                                                                                                               |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| <p>📁 data-export\_editran<br>├── 📁 .rsa<br>│ └── 📄 claves.rsa<br>├── 📄 ckds.des<br>├── 📄 controlgc.cfg<br>├── 📄 editrangt.cfg<br>├── 📄 ediperfi.txt<br>├── 📄 igaperfi.txt<br>├── 📄 editran-export.log<br>└── 📄 index.json</p> | <p>📁 data-export\_connect<br>├── 📄 ckds.des<br>├── 📄 editrandb\_dump.sql<br>├── 📄 editran-export.log<br>└── 📄 index.json</p> |

NOTE: If the product *Editran* does not have the modules installed *EditranGT* or *EditranGC*, its configuration will not be exported.

NOTE: The final name of the exported files may vary or different files not shown in the previous example may appear. If you have any questions or problems, contact the support team.

The meaning of each exported file is as follows, according to its respective configuration module:

* RSA cryptography:
  * Folder `.rsa`: Folder that will contain all the RSA keys configured in the Editran Classic installation.
  * Files of `claves.rsa`: Individual files with the RSA keys generated locally or exchanged.
  * Configuration file `controlgc.cfg`: Configuration file of the EditranGC tool.
* DES cryptography:
  * File `ckds.des`: File that will contain the DES keys configured in the product.
* Scheduler or Transmission Manager:
  * Configuration file `editrangt.cfg`: Configuration file of the EditranGT tool.
* Editran/P session configuration:
  * Text file `ediperfi.txt`: Text file generated with the command `ediperfi -r -a -n -oediperfi.txt` based on the sessions configured in `editranp.cfg` and `editranp.sdx`.
* Editran/G Presentation configuration:
  * Text file `igaperfi.txt`: Text file generated with the command `igaperfi -r -a -oediperfi.txt` based on the sessions configured in `editrang.cfg`.
* Connect database backup:
  * File `editrandb_dump.sql`: Connect database recovery file. This file was generated with the command *pg\_dump* from PostgreSQL.
* Report of the configuration export tool log:
  * File `editran-export.log`: Detailed log with the tool execution report.
* Index file of the exported files:
  * File `index.json`: Text file in JSON format that contains the details of the export: product, version and export platform, as well as a report of the modules and the names of the exported files for each module. This file will be used by the configuration import tool included in Connect versions 3.2 and later.

## How to export the configuration of an Editran Classic product

### Prerequisites

To extract the configuration of an Editran Classic product using the tool **editran-export**, you first need the executable corresponding to the operating system (Windows or RedHat) where the product to be exported is installed.

The corresponding binary can be downloaded from the Editran product download website.

It is recommended to copy the binary to a known folder, or otherwise, to the root of the installed product that we are going to export (e.g.: C:\Editran or /opt/editran).

To find out the version of the Editran product installed on the machine, you can run the command `ediver` from a terminal, included in the product within the folder `bin` of the installation path, which will show the product version information.

```shell
C:\Editran\bin>ediver.exe
Editran v5.3.1
ProductId: 53 1 Jul  8 2025 22388
```

For the export tool to work correctly, the product license must be running. For versions later than Editran Classic 5.2.0, the license service must be running with a valid license.

### Export on Windows

From an administrator terminal, we run the tool invocation command following the rules defined in the command help.

We specify `editran` as the product type to export with the parameter `-p editran`, we indicate the full installation path in the file system of the machine with `-i <installation-path>` and the version of the product to export with the parameter `-v <version>`. Optionally, an alternative path can be specified where the export compressed file will be generated with the parameter `-o <output-path>`, indicating the full path to the output folder. To use the `tar.gz`compression format, specify the parameter `-t` when running the tool.

As an example, the following command will export the configuration of an Editran Classic product version 5.3.1 on Windows OS, installed in the path `C:\Editran`, using the binary *editran-export.exe*:

`editran-export.exe -p editran -i C:\Editran -v 5.3.1`

```shell
C:\Editran>editran-export.exe -p editran -i C:\Editran -v 5.3.1
***** EDITRAN-EXPORT-TOOL *****
 Version: 1.1.0
 Compiled: 2026-01-12_10:13:16
*******************************
LOGGER Created log file at C:\Editran\data-export_editran_20260114_121136\editran-export.log
Exporting Editran configuration...
Installation path: C:\Editran
Version: 5.3.1
Output directory: C:\Editran\data-export_editran_20260114_121136
Format: zip
[Editran/P] Exported EditranP configuration to C:\Editran\data-export_editran_20260114_121136\ediperfi.txt.
[Editran/G] Exported EditranG configuration to C:\Editran\data-export_editran_20260114_121136\igaperfi.txt.
[Scheduler] Copied file C:\Editran\data-export_editran_20260114_121136\editrangt.cfg
[RSA Keys] Copied file C:\Editran\data-export_editran_20260114_121136\controlGC.cfg
[RSA Keys] Copied directory C:\Editran\data-export_editran_20260114_121136\.rsa
[DES Keys] Copied file C:\Editran\data-export_editran_20260114_121136\ckds.des
ZIP-format compressed file generated successfully: C:\Editran\data-export_editran_20260114_121136.zip
Export completed successfully.
```

The tool log indicates the location of the generated compressed file. In the example:

`ZIP-format compressed file generated successfully: C:\Editran\data-export_editran_20260114_121136.zip`

Inside this file we can find the detailed tool log called `editran-export.log`, which will indicate all the steps and actions taken to export the configuration, as well as any errors that may have occurred.

It is recommended to consult that log to verify that everything finished correctly.

### Export on RedHat Enterprise Linux

From a terminal in RedHat and having logged in with the administrator user of the Editran Classic product installation, we run the tool invocation command following the rules defined in the command help.

We specify `editran` as the product type to export with the parameter `-p editran`, we indicate the full installation path in the file system of the machine with `-i <installation-path>` and the version of the product to export with the parameter `-v <version>`. Optionally, an alternative path can be specified where the export compressed file will be generated with the parameter `-o <output-path>`, indicating the full path to the output folder. To use the `tar.gz`compression format, specify the parameter `-t` when running the tool.

As an example, the following command will export the configuration of an Editran Classic product version 5.2.1.9 on RedHat OS, installed in the path `/opt/classic/editran` compressing the configuration in format `.tar.gz`, and using for that the binary *editran-export*:

```shell
[classic@EDILDA01 editran]$ editran-export -p editran -v 5.2.1.9 -i /home/classic/editran -t
***** EDITRAN-EXPORT-TOOL *****
 Version: 1.1.0
 Compiled: 2026-01-12_10:02:18
*******************************
LOGGER Created log file at /home/classic/editran/data-export_editran_20260114_131303/editran-export.log
Exporting Editran configuration...
Installation path: /home/classic/editran
Version: 5.2.1.9
Output directory: /home/classic/editran/data-export_editran_20260114_131303
Format: tar.gz
[Editran/P] Exported EditranP configuration to /home/classic/editran/data-export_editran_20260114_131303/ediperfi.txt.
[Editran/G] Exported EditranG configuration to /home/classic/editran/data-export_editran_20260114_131303/igaperfi.txt.
[Scheduler] NOTICE: editrangt.cfg is not configured in this installation. Export will continue.
[RSA Keys] Copied file /home/classic/editran/data-export_editran_20260114_131303/controlGC.cfg
[RSA Keys] Copied directory /home/classic/editran/data-export_editran_20260114_131303/.rsa
[DES Keys] Copied file /home/classic/editran/data-export_editran_20260114_131303/ckds.des
TarGz-format compressed file generated successfully: /home/classic/editran/data-export_editran_20260114_131303.tar.gz
Export completed successfully.
```

The tool log indicates the location of the generated compressed file. In the example:

`TarGz-format compressed file generated successfully: /home/classic/editran/data-export_editran_20260114_131303.tar.gz`

Inside this file we can find the detailed tool log called `editran-export.log`, which will indicate all the steps and actions taken to export the configuration, as well as any errors that may have occurred.

It is recommended to consult that log to verify that everything finished correctly.

## How to export the configuration of an Editran Connect product

### Prerequisites

To extract the configuration of an Editran Connect product using the tool **editran-export**, you first need the executable corresponding to the operating system (Windows or RedHat) where the product to be exported is installed.\
The corresponding binary can be downloaded from the Editran product download website.

It is recommended to copy the binary to a known folder, or otherwise, to the root of the installed product that we are going to export (e.g.: C:\EditranConnect or /opt/editranconnect).

You can verify the version of the installed connect product in the `Local Configuration > License > License Data` panel of the Connect application or from its WebView.

![Get Connect product version](https://1386330368-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2jqgE5yyM3S58JKHROiz%2Fuploads%2Fgit-blob-7e2c036af5b6adee76835e09d9d30e40bb3063d3%2Fver_version_connect.png?alt=media)

For the export tool to work correctly, the `license service` and the `data service` of the product must be running.

### Export on Windows

From an administrator terminal, we run the tool invocation command following the rules defined in the command help.<br>

We specify `connect` as the product type to export with the parameter `-p connect`, we indicate the full installation path in the file system of the machine with `-i <installation-path>` and the version of the product to export with the parameter `-v <version>`. Optionally, an alternative path can be specified where the export compressed file will be generated with the parameter `-o <output-path>`, indicating the full path to the output folder. To use the `tar.gz`compression format, specify the parameter `-t` when running the tool.

As an example, the following command will export the configuration of an Editran Connect product version 3.2.0 on Windows OS, installed in the path `C:\EditranConnect`, creating the compressed file with the exported configuration in the user folder located at `C:\Users\admin\Documentos\fichero exportacion` and using the binary *editran-export.exe*:

NOTE: Keep in mind that to enter folder paths that contain spaces, it is necessary to use double quotes `""` so that the tool validates it correctly.

`editran-export.exe -p connect -v 3.2.0 -i C:\EditranConnect -o "C:\Users\admin\Documentos\fichero exportacion"`

```shell
C:\Users\admin\Downloads\editran-tools-win\utils>editran-export.exe -p connect -v 3.2.0 -i C:\EditranConnect -o "C:\Users\admin\Documentos\fichero exportacion"
***** EDITRAN-EXPORT-TOOL *****
 Version: 1.1.0
 Compiled: 2026-01-12_10:13:16
*******************************
LOGGER Created log file at C:\Users\admin\Documentos\fichero exportacion\data-export_connect_20260115_105424\editran-export.log
Exporting Connect configuration...
Installation path: C:\EditranConnect
Version: 3.2.0
Output directory: C:\Users\admin\Documentos\fichero exportacion\data-export_connect_20260115_105424
Format: zip
[DES Keys] Copied file C:\Users\admin\Documentos\fichero exportacion\data-export_connect_20260115_105424\ckds.des
[Database] Performing database export.
[Database] Database export completed successfully.
ZIP-format compressed file generated successfully: C:\Users\admin\Documentos\fichero exportacion\data-export_connect_20260115_105424.zip
Export completed successfully.
```

The tool log indicates the location of the generated compressed file. In the example:

`ZIP-format compressed file generated successfully: C:\Users\admin\Documentos\fichero exportacion\data-export_connect_20260115_105424.zip`

Inside this file we can find the detailed tool log called `editran-export.log`, which will indicate all the steps and actions taken to export the configuration, as well as any errors that may have occurred.

It is recommended to consult that log to verify that everything finished correctly.

### Export on RedHat Enterprise Linux

From a terminal in RedHat and logged in with the administrator user of the Editran Connect product installation, we run the tool invocation command following the rules defined in the command help.

We specify `connect` as the product type to export with the parameter `-p connect`, we indicate the full installation path in the file system of the machine with `-i <installation-path>` and the version of the product to export with the parameter `-v <version>`. Optionally, an alternative path can be specified where the export compressed file will be generated with the parameter `-o <output-path>`, indicating the full path to the output folder. To use the `tar.gz`compression format, specify the parameter `-t` when running the tool.

NOTE: The Connect export process may take several minutes depending on the size of the database. The more data configured in the product, the larger the database will be and it may take longer. Please wait patiently until the message appears `[Database] Database export completed successfully`. If you have any questions or problems regarding this, contact the support team.

As an example, the following command will export the configuration of an Editran Connect product version 2.1.17 on RedHat OS, installed in the path `/opt/EditranConnect` compressing the configuration in format `.tar.gz`, and using for that the binary *editran-export*:

```shell
[editran@EDILDA01 EditranConnect]$ editran-export -p connect -v 2.1.17 -i /opt/EditranConnect -t
***** EDITRAN-EXPORT-TOOL *****
 Version: 1.1.0
 Compiled: 2026-01-12_10:02:18
*******************************
LOGGER Created log file at /opt/EditranConnect/data-export_connect_20260114_170426/editran-export.log
Exporting Connect configuration...
Installation path: /opt/EditranConnect
Version: 2.1.17
Output directory: /opt/EditranConnect/data-export_connect_20260114_170426
Format: tar.gz
[DES Keys] Copied file /opt/EditranConnect/data-export_connect_20260114_170426/ckds.des
[Database] Performing database export.
[Database] Database export completed successfully.
TarGz-format compressed file generated successfully: /opt/EditranConnect/data-export_connect_20260114_170426.tar.gz
Export completed successfully.
```

The tool log indicates the location of the generated compressed file. In the example:

`TarGz-format compressed file generated successfully: /opt/EditranConnect/data-export_connect_20260114_170426.tar.gz`

Inside this file we can find the detailed tool log called `editran-export.log`, which will indicate all the steps and actions taken to export the configuration, as well as any errors that may have occurred.

It is recommended to consult that log to verify that everything finished correctly.

## Execution error summary

### Running editran-export without administrator privileges

This error indicates that **editran-export** it has not been run from an administrator terminal. It is necessary to run it with those privileges to check the status of the required services and ensure the export works correctly.

```shell
Error: EDITRAN_EXPORT:42: WINDOWS_SERVICES:73: error connecting to the SCM. Run the tool with administrator privileges.: Access is denied.
```

### The license service is not running

This error indicates that the license service of the installed product is not running.

```shell
Error: EDITRAN_EXPORT:46: the license service is not running
```

To solve the problem, make sure the license service is running. Also check that the license is valid for the installed version and/or has not expired. The file `licencia.dat` must exist in the folder `<installation_path>\bin\SL\`.

### Incorrect or expired product license

These errors indicate that the product license is not correct. The command log will indicate specifically what the license error is, whether it has expired or whether the license version is not appropriate for the version of the installed software.

```shell
Error: LINUX_EXEC:66: error executing /home/classic/editran/bin/ediperfi -r -a -n -o/home/classic/editran/data-export_editran_20260114_133129/ediperfi.txt:
/home/classic/editran/bin/ediperfi: License:  [LicAPI]-Expired license
: exit status 4
Error: EDITRAN_EXPORT:89: EditranP sessions cannot be dumped
```

```shell
Error: LINUX_EXEC:66: error executing /home/classic/editran/bin/ediperfi -r -a -n -o/home/classic/editran/data-export_editran_20260114_133702/ediperfi.txt:
/home/classic/editran/bin/ediperfi: License:  [LicAPI]-Unlicensed version
: exit status 4
Error: EDITRAN_EXPORT:89: EditranP sessions cannot be dumped
```

To find out the version of the installed product:

* In the Editran Classic product run the command `ediver` included in the folder `<installation-path>\bin` of the product.
* In the Editran Connect product, you can check the installed version in the panel of `Local Configuration > License > License Data` panel of the Connect application or from its WebView.

To obtain a new license for the installed product, contact the support team.

### The Editran Connect Database service is not running

This error indicates that the Editran Connect data service is not running.

```shell
Error: CONNECT_EXPORT:181: CONNECT_EXPORT:120: WINDOWS_SERVICES:107: the EditranDataServer service is not running
```

The data service name may vary between the different versions and/or supported operating systems according to the following table:

| Platform | Version lower than 3.2       | Version 3.2 and later       |
| -------- | ---------------------------- | --------------------------- |
| Windows  | EditranConnectData           | EditranDataServer           |
| Linux    | editran.connect.data.service | editran.data.server.service |

To solve the problem, make sure that the Connect product data service is started and working correctly before running the configuration export tool.

### Incorrect product installation path

This error indicates that the installation path specified in the parameter `-i, --installpath` of the command **editran-export** is not correct and the tool cannot find the installed product.

On RedHat, the displayed error will be as follows:

```shell
Error: EDITRAN_EXPORT:42: LINUX_SERVICES:100: the service status could not be queried: exec: "/home/classic/bin/EDItran": stat /home/classic/bin/EDItran: no such file or directory
Error: EDITRAN_EXPORT:89: EditranP sessions cannot be dumped
```

On Windows, the displayed error will be as follows:

```shell
Error: exec: "C:\EditranClassic\bin\ediperfi.exe": file does not exist
Error: EDITRAN_EXPORT:89: EditranP sessions cannot be dumped
```

To solve it, make sure that the installation path specified in the parameter `-i, --installpath` is correct. If the path contains spaces, the full path must be specified in double quotes `""` so that validation is performed correctly. For example: `-i "C:\Editran v5.2.0"`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.editran.onesait.com/documentacion-editran/connect-3.2-en/migracion/editran-export.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
