Importing and Exporting Location Definition
This section describes the steps to import and export location definitions.
The location definition includes:
- location properties (including agent connection properties)
- action(s) defined only on the location
Importing Location Definition
You can load locations to a hub by importing the location definition(s) from a JSON file. This can be a JSON file generated using the Export Location Definition option, or it can be manually prepared as long as it conforms to the JSON file format used by Fivetran HVR. You can find the relevant JSON examples in section Locations on the hvrdefinitionimport page.
You can import a location definition from the Locations page: click the More Options icon at the top right and select Import Location Definitions. Then browse for the required file and click Open. The Import Summary dialog shows the details of the import. Click Continue.
When importing a location, there may be a situation when a location with the same name already exists on the hub. Note that two locations with the same names are not allowed. Therefore, when importing such a location, the Import Summary dialog will offer the following options:
Import Under a Different Name - Keep the existing location and add the location being imported with a different name, derived from the original name, with an ascending number appended (starting from 2). For example, when importing location myloc, it will be added to the hub with name myloc2.
Replace - The existing location will be replaced with the imported one.
Importing Location With Encrypted Data
When importing a location containing confidential data encrypted with a transport key (e.g. during the location export with option Encrypt values with single-use transport-key), a warning will be displayed listing the objects that contain encrypted values. To decrypt the data, specify the transport key in the ENTER TRANSPORT KEY field and click Continue.
If you do not have the transport key available, you may click Proceed Without Key, in which case the encrypted data will be imported redacted.
The redacted values of the imported location properties (e.g. Database_Password) need to be updated manually, otherwise, the corresponding location connections will be broken. For example, to update the database password, open the Location Details page, click Edit in the Database Connection pane, and type the valid password in the PASSWORD field.
Importing Location With Redacted Data
When importing a location containing confidential data that is redacted (e.g. during the location export with option Redact values from export file), a warning (e.g. W_JR4300) will be displayed mentioning the object that contains a redacted value. Choose one of the following options and click Continue:
once: once ignore the warning displayed in the dialog. If there is a second redacted value triggering the warning, then the dialog appears again.
for this request: for this import, the warning will be ignored. If you start the import a second time, the warning appears again.
today: the warning will be ignored for today.
forever: the warning will be ignored forever.
The redacted values of the imported location properties (e.g. Database_Password) need to be updated manually, otherwise, the corresponding location connections will be broken. For example, to update the database password, open the Location Details page, click Edit in the Database Connection pane, and type the valid password in the PASSWORD field.
Exporting Location Definition
You can export a location definition from two places:
On the Location Details page, click the More Options icon at the top right and select Export Location Definition.
On the Locations page, you can select multiple locations to export them at once. Then, click the More Options icon at the top right and select Export Location Definitions.
In the Export Location dialog:
choose the scope of data to be exported, i.e. any actions defined for the location.
An action defined on the exported location will only be exported if the action is defined for all channels containing the location. If the action defined on the exported location is defined only in a specific channel or channels containing the location, such action will not be exported.
Choose the way the secret and confidential data related to the location will be exported. For this, select one of the following options in the Classified info field:
Redact values from export file: redacts the data in the created export file.
Encrypt values with single-use transport-key: encrypts the data in the created export file with a transport key.
Export stored (obfuscated) values (displayed when software wallet is disabled): saves the data obfuscated.
Export wallet-encrypted values (displayed when software wallet is enabled): encrypts the data with the encryption wallet.
Objects exported using option Export wallet-encrypted values can only be imported back to the same hub system. When imported to a different hub system, the wallet-encrypted values of the location properties will be imported redacted, in which case you will need to update them manually, otherwise, the corresponding location connections will be broken. For example, to update the database password, open the Location Details page, click Edit in the Database Connection pane, and type the valid password in the PASSWORD field.
The following Classified info options are available only for a user with HubOwner permission:
- Encrypt values with single-use transport-key,
- Export stored (obfuscated) values
- Export wallet-encrypted values