このハウツーでは、Botの開発、テスト、パイロット、本番リリースの目的で、最終的にエンドユーザーがBotを利用できるようになるまでに複数の段階を設定しているシナリオについて説明します。

例題

開発者がBotの開発を完了し、QAチームがBotにアクセスしてテストするのに際し、Botをテスト環境に移行させる必要がある場合を考えてみます。Botの定義は、いくつかの環境固有の値を除いて大幅に変更されることはありません。

このドキュメントでは、Botのエクスポートおよびインポート機能を使用して同じことを実現する方法をご紹介します。Botのインポートとエクスポートの詳細については、こちらを参照してください。

Pre-requisites

• Botビルドナレッジ
• 完全に開発され、機能しているBotが必要となります。ここでは、バンキングBotを使用します。

導入

ステップ1-Botのエクスポート

1. 開発環境からテスト環境に移行するBotを開きます。
2. 設定 -> Bot管理からBotのエクスポートオプションを選択します。
3. エクスポートしたいBotコンポーネントを選択します。最初はすべてのコンポーネントをエクスポートしますが、その後は選択したコンポーネントのみをエクスポートするよう選択できます。
4. エクスポートをクリックします。
5. Bot定義はZIPファイルとしてエクスポートされます。
6. このファイルは、Bot定義をコードリポジトリにチェックインしたり、任意のチケットシステムに送ったりするために使用できます。

ステップ2-config.jsonの修正

1. 環境固有の値を必要とするすべての変数は、エクスポートしたファイルに含まれるconfig.jsonファイルで利用できます。
2. これらのグローバル変数を更新します（グローバル変数の詳細については、こちらをご覧くださいまた事例についてはこちらをご覧ください）。
3. これで、インフラストラクチャ/DevOpsチームとファイルを共有して、他の環境でのデプロイを開始できます。
4. 権限がある場合は、以下のステップに従ってBotをターゲット環境にインポートできます。

ステップ3-Botのインポート

1. 前のステップでエクスポートしたzipファイルからファイルを抽出します。
2. テスト環境で、新しいBotを作成します。
3. 設定 -> Bot管理からBotのインポートオプションを選択します。
4. 前のステップから、Bot定義ファイル、Bot設定ファイル、カスタムスクリプトファイル（ある場合）を選択します。
5. フルインポートのインポートオプションを選択します。既存のBotにこのオプションを使用する場合、現在のBot設定は消去され、インポートされたBotに置き換えられることに注意してください。
6. インポートをクリックします。
7. Botがテスト環境に置かれ、QAチームによるテストが可能になります。

ステップ4-Botの更新

Botを変更すると、その変更をテスト環境のBotに適用する必要がある場合があります。

1. 開発環境から、変更されたBotを開きます。
2. 設定 -> Bot管理からBotのエクスポートオプションを選択します。
3. エクスポートしたいBotコンポーネントを選択します。変更したコンポーネントのみをエクスポートするように設定することもできます。
4. エクスポートをクリックします。
5. Bot定義はZIPファイルとしてエクスポートされます。
6. zipファイルからファイルを抽出します。
7. エクスポートしたファイルに存在するconfig.jsonファイルで、環境固有の値を必要とする変数値を変更します。
8. テスト環境で、更新が必要なBotを開きます。
9. 設定 -> Bot管理からBotのインポートオプションを選択します。
10. 前の抽出ステップから、Bot定義ファイル、Bot設定ファイル、カスタムスクリプトファイル（ある場合）を選択します。
11. 増分インポートのインポートオプションを選択します。
12. インポートをクリックします。
13. 更新されたBotがテスト環境に置かれ、QAチームによるテストが可能になります。

In this How-To, we will explore a scenario wherein your organization has set up multiple stages before a bot is finally made available to the end-users for the purpose of bot development, testing, pilot and production release.

Problem Statement

Consider the case wherein the developer has completed the bot development and it needs to be moved to the testing environment for the QA team to access and test the same. The bot definition does not change drastically except for a few environment-specific values.

In this document, we will show how the bot export and import functionality can be used to achieve the same. Refer here for more on Bot Import and Export.

Pre-requisites

• Bot building knowledge
• A fully developed and functional bot. Here we are using the Banking Bot.

Implementation

Step 1 – Export Bot

1. In the development environment, open the bot you want to move to the testing environment.
2. Select the Deploy tab from the top menu
3. From Bot Management, select the Import & Export option.
4. Choose the Export tab
5. Select the bot components you want to export. The first time you will want to export all components, subsequently, you might want to choose to export only selected components.
6. Click Export.
7. The bot definition is exported as a ZIP file.
8. The file may be used to check the bot definition into your code repository or to attach it to any ticketing system.

Step 2 – Modify config.json

1. Any variables that need environment-specific values will be available in the ​config.json​ file present in the exported file.​
2. Update these Global Variables (see here for more on Global Variables and here for an example).
3. Now the file can be shared with the infrastructure / DevOps teams for initiating deployment in other environments.
4. If you have permissions, you can import the bot to the target environment by following the steps given below.

Step 3 – Import Bot

1. Extract the files from the zip file exported in the previous step.
2. In the testing environment, create a new bot.
3. Select the Deploy tab from the top menu
4. From Bot Management, select the Import & Export option.
5. Choose the Import tab
6. Select the Bot Definition File, Bot Config File, and Custom Script File (if any) from the previous step.
7. Select the Full Import Import Option. Note that if you are using this option in an existing bot the current bot configurations will be erased and replaced with the imported bot.
8. Click Import.
9. Your Bot is ready in the testing environment for the QA team to test.

Step 4 – Update Bot

Chances are you need to modify the bot and apply those changes to the bot in the testing environment.

1. From the development environment, open the modified bot.
2. Select the Deploy tab from the top menu
3. From Bot Management, select the Import & Export option.
4. Choose the Export tab
5. Select the bot components you want to export. You might want to choose to export only modified components.
6. Click Export.
7. The bot definition is exported as a ZIP file.
8. Extract the files from the zip file.
9. Change the values for any variables that need environment-specific values in the ​config.json​ file present in the exported file.​
10. In the testing environment, open the bot that needs to be updated.
11. Select the Deploy tab from the top menu
12. From Bot Management, select the Import & Export option.
13. Choose the Import tab
14. Select the Bot Definition File, Bot Config File, and Custom Script File (if any) from the previous extract step.
15. Select the Incremental Import from the Import Option section
16. Click Import.
17. Your Bot is updated and ready in the testing environment for the QA team to test.