Sharing connection information with other users in an IBM App Connect Dashboard

Sharing connection information with other users in an IBM® App Connect Dashboard by exporting and importing configuration files.

About this task

You can export connection information from your IBM App Connect Dashboard by downloading it in the form of a yaml file. If you want to encrypt any credentials in the exported connections, you must specify a password. If you need to restore this set of connections, you can import the yaml file in the same dashboard, or in a different dashboard. Other users can also import the yaml file on the same dashboard, or on a different dashboard. If a password was set when the connections were exported, you must use the password to import the connections, unless the exported yaml file does not contain any encrypted credentials.

Procedure

  1. Export connection information. You can export connection information by completing the following steps:
    1. In the Deployment locations view, click Export. The "Export Connections" dialog box opens.
    2. In the "Export Connections" dialog box, type a password in the Password (optional) field.

      If you provide a password, it is used to encrypt any credentials in your exported connections. It is possible to view the file, but not the credentials. You need the password to import a connections file that contains encrypted credentials. You do not need a password to import a connections file that does not contain encrypted credentials, even if a password was provided when the file was exported.

    3. If you want to cancel the export action, click Cancel.
    4. Click Export to export the connections.

      Your connections are downloaded as a YAML file into the Downloads folder in your local file system.

    For example, C:\Users\<your user id>\Downloads.
    If you need to restore this set of connections, you can import the file. Another user on the same dashboard can also import this file.
  2. Import connection information.
    You can import connection information that you or another user export from the same dashboard, or from a different dashboard. If a password was set when the connections were exported, and the yaml file contains encrypted credentials, you must use the password to import the connections. You can import connection information by completing the following steps:
    1. In the Deployment locations view, click Import. The Import Connections dialog box opens.
    2. In the Import Connections dialog box, click Click to select a yaml file. A File Explorer window opens.
    3. In the File Explorer window, go the location where the yaml file that you want to import is located.
    4. In the File Explorer window, select the yaml file and click Open. The File imported field in the Import Connections dialog box is populated with the name of the yaml file that you selected.
    5. If the yaml file that you import contains encrypted credentials, you must enter the password that was used when the yaml file was exported in the Password field.
    6. If you want to cancel the import of the file, click Cancel,
    7. Click Import. The yaml file is imported into the Downloads folder in your local file system.
    For example, C:\Users\<your user id>\Downloads.