Export to a File with Properties¶

To export the metadata of one Server to import it on other Servers that run in different environments, we recommend using the option “export with properties”. This option generates two files:

1. A file that contains the VQL statements of all the elements of the database. The values of the parameters that depend on the environment are variables instead of the actual values. For example, in the CREATE DATASOURCE JDBC statement the value of the parameter DATABASEURI is ${databases.admin.datasources.jdbc.internet_ds.DATABASEURI} instead of the URI of the database.

2. And, a file that contains the values of the variables. The name of this file is the same as the first file but with the extension .properties. For example,

   databases.admin.datasources.jdbc.internet_ds.DATABASEURI= jdbc:mysql://acme:3306/incidents_center
   

To export to a file with properties you can use:

1. The Administration Tool: in the “Export” (or “Export database”) dialog, select the Include properties file check box.

2. The export script: pass the parameter -P includeProperties=yes.

Then, you have to edit the values of the properties file to match the configuration of the target environment: change URLs of the JDBC data sources, user names and passwords, etc.

In this properties file, the passwords are encrypted. So, when you change the value of a property that is a password, you need to enter its encrypted value. Use the command ENCRYPT_PASSWORD to obtain the password encrypted.

For example, execute this from the VQL Shell:

ENCRYPT_PASSWORD 'my_password' FOR_PROPERTIES_FILE

With the FOR_PROPERTIES_FILE option, this command generates the password with certain characters escaped, as needed in these properties files. If you are going to use the result of this command on a dialog of the administration tool, do not add this option.

Regarding this process, you only have to change the properties file. Do not modify the file that contains the VQL statements. Afterward, import these files into the target Server.

To import the VQL file with properties, you can use:

1. The Administration Tool: in the “Import” dialog select the Use properties check box and enter the path to the properties file in the Properties file box.

2. The import script: pass the parameter --properties-file <path to the properties file>.

The following table lists the parameters whose value is replaced with a variable, when exporting them to a file with properties.