본 방법에서는 최종 사용자에게 봇 개발, 테스트, 파일럿 및 프로덕션 릴리스를 위해 봇이 제공되기 전에 여러 단계를 설정한 시나리오를 살펴봅니다.
문제 설명
개발자가 봇 개발을 완료한 후 QA 팀이 봇 개발에 액세스하여 테스트를 수행할 수 있도록 이를 테스트 환경으로 이동해야 하는 사례를 생각해 보세요. 봇 정의는 몇 가지 환경별 값을 제외하고는 크게 변하는 것이 없습니다.
본 문서에서는 봇 내보내기 및 가져오기 기능을 사용하여 이와 같은 결과를 얻는 방법을 설명합니다. 봇 가져오기 및 내보내기에 대한 자세한 내용은 여기를 참조하세요.
전제 조건
- 봇 구축 지식
- 완전히 개발되고 기능적인 봇. 여기에서는 뱅킹 봇을 사용합니다.
구현
1단계 – 봇 내보내기
- 개발 환경에서 테스트 환경으로 옮기고자 하는 봇을 엽니다.
- 상단 메뉴에서 배포 탭 선택
- 봇 관리에서 가져오기 및 내보내기 옵션을 선택합니다.
- 내보내기 탭 선택
- 내보내고자 하는 봇 구성 요소를 선택합니다. 처음에는 모든 구성 요소를 내보내고자 할 것이고 다음에는 선택한 구성 요소만 내보내길 원할 수 있습니다.
- 내보내기를 클릭합니다.
- 봇 정의가 ZIP 파일로 내보내집니다.
- 이 파일은 코드 저장소에 봇 정의를 확인하거나 티켓 시스템에 첨부하기 위해 사용될 수 있습니다.
2단계 – config.json 수정
- 환경별 값이 필요한 변수는 내보낸 파일에 있는 config.json 파일에서 사용할 수 있습니다.
- 이 전역 변수를 업데이트합니다(전역 변수에 대한 자세한 내용은 여기를 참조하고 예제는 여기를 참조하세요).
- 이제 다른 환경에서 배포를 시작하기 위해 인프라/DevOps 팀과 파일을 공유할 수 있습니다.
- 사용 권한이 있다면 아래 단계에 따라 봇을 대상 환경으로 가져올 수 있습니다.
3단계 – 봇 가져오기
- 이전 단계에서 내보낸 zip 파일에서 파일의 압축을 풉니다.
- 테스트 환경에서 새 봇을 생성합니다.
- 상단 메뉴에서 배포 탭 선택
- 봇 관리에서 가져오기 및 내보내기 옵션을 선택합니다.
- 가져오기 탭 선택
- 이전 단계에서 봇 정의 파일, 봇 설정 파일 및 사용자 정의 스크립트 파일(있는 경우)을 선택합니다.
- 전체 가져오기 옵션을 선택합니다. 기존 봇에서 이 옵션을 사용하는 경우 현재 봇 설정이 지워지고 가져온 봇으로 대체된다는 점을 주의하세요.
- 가져오기를 클릭합니다.
- QA 팀이 봇을 테스트하도록 테스트 환경에서 준비되었습니다.
4단계 – 봇 업데이트
테스트 환경에서 봇을 수정하고 이러한 변경 사항을 봇에 적용해야 할 수 있습니다.
- 개발 환경에서 수정된 봇을 엽니다.
- 상단 메뉴에서 배포 탭 선택
- 봇 관리에서 가져오기 및 내보내기 옵션을 선택합니다.
- 내보내기 탭 선택
- 내보내고자 하는 봇 구성 요소를 선택합니다. 수정된 구성 요소만 내보내도록 선택할 수 있습니다.
- 내보내기를 클릭합니다.
- 봇 정의가 ZIP 파일로 내보내집니다.
- zip 파일에서 파일의 압축을 풉니다.
- 압축이 풀린 파일에 있는 config.json 파일에서 환경별 값이 필요한 변수의 값을 변경합니다.
- 테스트 환경에서 업데이트가 필요한 봇을 엽니다.
- 상단 메뉴에서 배포 탭 선택
- 봇 관리에서 가져오기 및 내보내기 옵션을 선택합니다.
- 가져오기 탭 선택
- 이전 추출 단계에서 봇 정의 파일, 봇 설정 파일 및 사용자 정의 스크립트 파일(있는 경우)을 선택합니다.
- 가져오기 옵션 섹션에서 증분 가져오기 선택
- 가져오기를 클릭합니다.
- 봇이 업데이트되었고 QA 팀이 봇을 테스트하도록 테스트 환경에서 준비되었습니다.
このハウツーでは、組織が、ボットの開発、テスト、パイロット、プロダクションリリースなど、最終的にエンドユーザーがボットを利用できるようになるまでの複数の段階をセットアップしている場合のシナリオを探究しましょう。
問題提起
開発者がボットの開発を完了し、QAチームがアクセスしてテストできるテスト環境に移動させる必要があるケースを考えてみましょう。ボットの定義は、環境固有の少数の値を除いて、大きくは変わりません。
この文書では、ボットのエクスポートとインポート機能を使用して、同じことを実現する方法を紹介します。ボットのインポート・エクスポートの詳細についてはこちらをご参照ください。
必要条件
- ボット構築のナレッジ
- 完全に開発され、機能しているボットです。ここでは、バンキングボットを使用しています。
導入
ステップ1 – ボットをエクスポート
- 開発環境では、テスト環境に移行したいボットを開きます。
- トップメニューから デプロイタブを選択します
- ボット管理からインポートとエクスポートを選択します。
- エクスポートタブを選択
- エクスポートしたいボットコンポーネントを選択します。最初はすべてのコンポーネントをエクスポートしますが、その後は選択済みコンポーネントのみをエクスポートするように選択できます。
- エクスポートをクリック。
- ボットの定義は、ZIPファイルとしてエクスポートされます。
- このファイルは、ボットの定義をコードリポジトリに登録するか、またはチケットシステムに添付するために使用されます。
ステップ2 – config.jsonを修正
- 環境固有の値を必要とする変数は、エクスポートされたファイルに含まれる config.jsonファイルにおいて利用できます。
- これらのグローバル変数を更新します(グローバル変数の詳細はこちらをご覧くださいまた例はこちら)。
- このファイルをインフラストラクチャ/DevOpsチームと共有し、他の環境でのデプロイを開始することができます。
- 権限がある場合は、以下の手順でボットを対象環境にインポートすることができます。
ステップ3 – ボットをインポート
- 前のステップでエクスポートしたZIPファイルから、ファイルを抽出します。
- テスト環境では、新しいボットを作成します。
- トップメニューから デプロイタブを選択します
- ボット管理からインポートとエクスポートを選択します。
- インポートタブを選択
- 前のステップから(もしあれば)、ボット定義ファイル、 ボット設定ファイル、 カスタムスクリプトファイルを選択します。
- 全体インポートインポートオプションを選択します。既存のボットでこのオプションを使用している場合、現在のボット設定は消去されて、インポート済みのボットに置換されますのでご注意ください。
- インポートをクリックします。
- Myボットは、QAチームがテストするためのテスト環境に準備されています。
ステップ4:ボットを更新
ボットを変更し、その変更をテスト環境のボットに適用しなければならない場合もあるでしょう。
- 開発環境から、変更したボットを開きます。
- トップメニューから デプロイタブを選択します
- ボット管理からインポートとエクスポートを選択します。
- エクスポートタブを選択
- エクスポートしたいボットコンポーネントを選択します。変更されたコンポーネントのみをエクスポートするように選択することもできます。
- エクスポートをクリック。
- ボットの定義は、ZIPファイルとしてエクスポートされます。
- ZIPファイルからファイルを取り出します。
- エクスポートされたファイルに含まれる config.jsonファイルで、環境固有の値を必要とする変数の値を変更します。
- テスト環境では、更新が必要なボットを開きます。
- トップメニューから デプロイタブを選択します
- ボット管理からインポートとエクスポートを選択します。
- インポートタブを選択
- 前の抽出ステップから(もしあれば)、ボット定義ファイル、 ボット設定ファイル、 カスタムスクリプトファイルを選択します。
- 「インポートオプション」セクションから増分インポートを選択します。
- インポートをクリックします。
- Myボットは、QAチームがテストするためのテスト環境に準備されています。
Leave a Reply
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
- In the development environment, open the bot you want to move to the testing environment.
- Select the Deploy tab from the top menu
- From Bot Management, select the Import & Export option.
- Choose the Export tab
- 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.
- Click Export.
- The bot definition is exported as a ZIP file.
- 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
- Any variables that need environment-specific values will be available in the config.json file present in the exported file.
- Update these Global Variables (see here for more on Global Variables and here for an example).
- Now the file can be shared with the infrastructure / DevOps teams for initiating deployment in other environments.
- If you have permissions, you can import the bot to the target environment by following the steps given below.
Step 3 – Import Bot
- Extract the files from the zip file exported in the previous step.
- In the testing environment, create a new bot.
- Select the Deploy tab from the top menu
- From Bot Management, select the Import & Export option.
- Choose the Import tab
- Select the Bot Definition File, Bot Config File, and Custom Script File (if any) from the previous step.
- 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.
- Click Import.
- 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.
- From the development environment, open the modified bot.
- Select the Deploy tab from the top menu
- From Bot Management, select the Import & Export option.
- Choose the Export tab
- Select the bot components you want to export. You might want to choose to export only modified components.
- Click Export.
- The bot definition is exported as a ZIP file.
- Extract the files from the zip file.
- Change the values for any variables that need environment-specific values in the config.json file present in the exported file.
- In the testing environment, open the bot that needs to be updated.
- Select the Deploy tab from the top menu
- From Bot Management, select the Import & Export option.
- Choose the Import tab
- Select the Bot Definition File, Bot Config File, and Custom Script File (if any) from the previous extract step.
- Select the Incremental Import from the Import Option section
- Click Import.
- Your Bot is updated and ready in the testing environment for the QA team to test.