Pipelines

Appearance

Installation ​

Pre-requisites ​

Before using this tool, ensure that you have the following:

  • Node.js (version 20.11.1 or higher)

Installation Steps ​

Follow these steps to install and set up the tool:

  1. Create a Directory:

    bash
    mkdir vcx

  2. Navigate to the Directory:

    bash
    cd vcx

  3. Download the Release:

    bash
    curl https://vtt-cs-delivery-ca-central-1.s3.ca-central-1.amazonaws.com/packages/vcx/latest/release.zip -o release.zip

  4. Extract the Zip File:

    bash
    unzip release.zip && rm release.zip

This will provide you with the vcx executable, which is a single-file bundled version of the tool.

  1. Run the Tool:
    bash
    node vcx.mjs

Environment Configuration ​

Before running the migration tool, you can set up the environment variables in your local .env file or use .env.json. For detailed instructions, please refer to the Environment Configuration Documentation.

Config.json ​

You need to create a config.json file in the root directory of the tool. For more information on how to configure the config.json file, please refer to the Config.json Documentation.

Selective Migration ​

For information on how to configure selective migration, please refer to the Selective Migration Documentation.

Running the Tool ​

Once installed, you can run the tool using the vcx command:

  1. Generate Connect Resources: Generate Connect resources:

    bash
    node vcx.mjs generate --profile VT_DEMO_TO_PROD

    Optional Arguments for Generate:

    • --export-lex-bots <boolean>: Specify whether to export Lex bots. For example, --export-lex-bots true.
    • --export-target-resources <boolean>: Specify whether to export target resources. For example, --export-target-resources true.

  2. Migrate Resources: Create or update resources in the target Connect instance:

    bash
    node vcx.mjs migrate --profile VT_DEMO_TO_PROD

    Optional Arguments for Migrate:

    • --config <string>: Specify the config.json file to use. For example, --config /custom-path/config.json.
    • --excludeDisabledResources <boolean>: Exclude disabled resources from the migration. For example, --excludeDisabledResources true.

For more in-depth information, please refer to the main documentation page for detailed explanations on each command and additional configurations.