Data migration

Enter the tool name followed by /? or -? to display the instructions, for example y-datadump.bat -?. In case of a data import, the target database has to be empty.

You have to redirect the ports in case of a Linux operating system.

Procedure

  1. Open a command prompt (Start > Run > cmd).
  2. Enter y-datadump.bat -s <http://host_url:<port number other than default port 80 or 1080>> -t <tenant name > <command> -u <user name> -p >password> -f <dump file>

In this case, a dump file written containing the database content. The following is output:

[CLI] Setting verbosity level... [VALUE: 0=OFF]

[CLI] Exporting data... [TENANT: 30ff3081-aa9e-33e7-a7d7-5f9d00ae89ee, FILE: C:\out.zip]

[CLI] Data successfully exported. [TENANT: 30ff3081-aa9e-33e7-a7d7-5f9d00ae89ee]

General usage

Options

Description

-?, -h, --help

Show help

-f

File name of the dump file.

-s, --server

URL of the server, URL of the server, for example, http://my_host_url:<port number other than default port 80 or 1080>

-t, --tenant

Tenant name

Default: default

Commands

Description

export

Exports all data of the specified tenant to a data dump file. Currently, a dump contains the following information:

  • tenant
  • users
  • groups
  • user-group assignments
  • profile pictures (optional)
  • permissions, dependent on the privileges of the user who enters the command
  • licenses, dependent on the privileges of the user who enters the command
  • configuration, dependent on the privileges of the user who enters the command

The data is stored in JSON format and packed into an encrypted ZIP file. The ZIP file can be restored using the same command line tool.

import

Imports a data base dump from a file.

Example

In this example, data is exported into a dump file.

y-datadump.bat -s <http://host_url> -t default export -u system -p manager -f "C:\backup\backup.zip"