Automation Anywhere ドキュメントを読んで確認する

Automation Anywhere バージョン11.3

コンテンツを閉じる

コンテンツ

コンテンツを開く

Bot ライフサイクル管理 をエクスポートおよびインポートするための API

  • 更新済み: 3/02/2021
    • 11.3.x
    • 管理
    • Enterprise
    • API ドキュメント

Bot ライフサイクル管理 をエクスポートおよびインポートするための API

Bot のエクスポートとインポート API を使用することで、中断のないオートメーション ライフサイクルを実現するための組織の Bot ライフサイクル管理 ソリューションをカスタマイズできます。

通常、Control Room ユーザーは、TaskBot を特定の環境から別の環境にデプロイする際に、Control Room 以外の手段 (E メールなど) に依存する必要があります。エクスポート/インポート API を使用すると、カスタマイズした Bot ライフサイクル管理 (BLM) ソリューションを簡単に導入できるため、オートメーション ライフサイクルの障害となり得るすべての外部要因を排除できます。

[Bot のエクスポート] と [Bot のダウンロード] の権限を持つ Control Room ユーザーは、Bot とその依存関係ファイルをエクスポートできます。同様に、[Bot のインポート] と [Bot のアップロード] の権限を持つユーザーは、Bot とその依存ファイルをインポートできます。

たとえば、実稼動の準備完了として検証済みの Bot は、ステージング環境から実稼動環境に移行できます。

Control Room のエクスポート/インポート REST API を使用すれば、組織の自動化のニーズに基づき、開発環境、テスト環境、受け入れ検査環境、実稼働環境などの異なる環境で、依存関係ファイルを含む TaskBot のオートメーション を管理できます。

Control Room ユーザー インターフェースでこの機能を利用する方法については、「Bot のエクスポート」および「Bot のインポート」の記事をご覧ください。

機能とメリット

  • Bot ライフサイクル管理 でロール ベースのアクセス制御
  • 依存関係 (ファイルと Bot) の自動エクスポート
  • コンプライアンスを目的としたソース環境およびターゲット環境の監査とトレーサビリティ
  • エクスポート/インポートの成否に関する E メール通知

エクスポート

  • Control Room ユーザーが資格情報を使用して認証する場合は、[Bot のエクスポート] 権限を保持している必要があります。
  • Control Room ユーザーが資格情報を使用して認証する場合は、Bot の [ダウンロード] 権限、MetaBot に対する最小限の [実行] 権限、エクスポートする依存関係が必要になります。
  • ソースの Control Room でバージョン管理が有効になっている場合は、エクスポートするすべての Bot と依存関係の実稼働バージョンを設定する必要があります。
  • Control Room のサービスを実行するために使用するユーザー アカウントは、パッケージのエクスポート先であるネットワーク上の場所 (共有ドライブ) や Control Room サーバー マシンなどにアクセスできる必要があります。

インポート

  • Control Room ユーザーが資格情報を使用して認証する場合は、[Bot のインポート] 権限が必要です。
  • Control Room ユーザーが資格情報を使用して認証する場合は、インポートする Bot と依存関係に対する [アップロード] 権限が必要になります。
  • ユーティリティを実行して複数の Bot をインポートする Control Room ユーザーは、Automation Anywhere が提供するエクスポート済みのパッケージ ファイルにアクセスできる必要があります。

API エンド ポイント

  • エクスポート- <your_control_room_url>/v1/blm/export

    例: https://crdevenv.com:81/v1/alm/export

  • インポート- <your_control_room_url>/v1/blm/import

    例: https://crtestenv.com:82/v1/alm/import

上記の BLM エクスポート/インポート API のエンド ポイントを使用すると、1 つの Bot とそのすべての依存関係をエクスポート/インポートできます。

Bot のエクスポート

Automation Anywhere が提供する Export API を使用して 1 つの Bot とその依存関係ファイルをエクスポートするには、次の手順に従います。

  1. POST メソッドで、エンドポイント http(s)://<hostname:port>/v1/authentication を使用してトークンを生成します。このために、Control Room インスタンスを、サーバー名/ホスト名/IP およびポート番号として指定します。

    例: https://crdevenv.com:81/v1/authentication

  2. Post メソッドを使用して、資格情報のパラメーターを本文データに指定します。たとえば、次のように指定します。
    {
    "username":"cradmin",
    "password":"cr@admin"
    }
  3. [実行] をクリックします。
  4. BLM エクスポート API は、認証 API を使用して取得した認証トークンを利用します。この認証トークンをヘッダー入力の 1 つとして、BLM エクスポート API に渡す必要があります。
  5. POST メソッドと次の URL を使用します。<your_control_room_url>/v1/blm/export

    リクエスト ヘッダーに次のパラメーターを指定します。

    • packageName: 作成するパッケージの名前。
    • selectedFileIds: これは数値です。エクスポートする親の Bot の 1 つ以上の ID を入力します。
    • fileIds: これは数値です。エクスポートする依存関係 Bot の 1 つ以上の ID を入力します。
    • excludeMetabots: これは Boolean 値です。true または false のいずれかを入力しますパッケージから依存 MetaBot を除外する場合は、true を入力します。
    • password: これは文字列であり、任意です。エクスポートのパスワードを入力します。
      以下に例を示します。
      {
        "packageName": "doc-test",
        "selectedFileIds": [12
        ],
        "fileIds": [
          12
        ],
        "excludeMetaBots": true,
        "password": ""
      }
  6. [実行] をクリックします。
  7. Swagger で API をテストしている場合は、レスポンス本文は、aapkg 形式でエクスポートされたファイルをダウンロードするためのダウンロード リンクを返します。それ以外の場合は、レスポンス本文をバイナリ ファイルとして aapkg 形式で保存する必要があります。

Bot のインポート

ネットワーク ドライブや Control Room マシンのパスに Bot が正常にエクスポートされると、別の許可されたユーザーがインポート API を使用して、このパッケージを別の Control Room にインポートできます。

  1. Post メソッドで、エンド ポイント http(s)://<hostname:port>/v1/authentication を使用してトークンを生成します。サーバー名/ホスト名/IPポート番号を組み合わせた形式で Control Room インスタンスを指定します。

    例: https://crtestenv.com:82/v1/authentication

  2. Post メソッドを使用して、資格情報のパラメーターを本文データに指定します。

    以下に例を示します。

     { 
    "username":"cradmin2", 
    "password":"cr@admin" 
    }
  3. [実行] をクリックします。
  4. BLM インポート API は、認証 API を使用して取得した認証トークンを利用します。この認証トークンをヘッダー入力の 1 つとして、BLM インポート API に渡す必要があります。
  5. POST メソッドと次の URL を使用します。<your_control_room_url>/v1/blm/import

    リクエスト ヘッダーに次のパラメーターを指定します。

    • file: Control Room にインポートするファイルを選択します。
    • overwriteOption: インポートするファイルがすでに存在する場合は、[スキップ]、[上書き]、または [中止] オプションを選択します。
    • productionversionOption: [現在] または [インポート済み] オプションを選択します。パッケージと共にプロダクト バージョンをインポート済みと設定するか、現在のバージョンをそのまま保持します。
    • Password: 保護されたパッケージをインポートするためのパスワードを入力します。このフィールドを空白のままにしないでください。空白のままにすると、デフォルト値がパスワードとして保持されます。

    以下に例を示します。

    リクエスト本文:
    "file": "doc-test_6488adfd-5989-46d8-a38a-7009876f2612.aapkg"
    "overwriteOption": "skip"
    "productionVersionOption": "current"
    "password": "********"
  6. [実行] をクリックします。
  7. Control Room に Bot がインポートされます。

    以下に例を示します。ファイルはフォルダー内にすでに存在しており、overWrite パラメーター値で skip と定義されているため、ファイルはスキップされます。

    レスポンス本文:

    {
      "alreadyExistFiles": [
        "Automation Anywhere\\My Tasks\\Task_C.atmx"
      ],
      "checkoutFiles": [],
      "filesHasNoPermission": [],
      "addedOrUpdatedFiles": [],
      "overwrittenFiles": [],
      "skippedFiles": [
        "Automation Anywhere\\My Tasks\\Task_C.atmx"
      ]
    }

API レスポンス コード

Http(s) ステータス コード レスポンス - 説明 対処法
200 パッケージは正常に作成されました NA
400 無効なリクエスト パラメーター 有効なパラメーターを使用して再試行します
404 ファイルが見つかりません。 Control Room にファイルや Bot が存在することを確認します
501 権限エラー [Bot のエクスポート/インポート] 権限または [アップロード/ダウンロード] 権限があることを確認します
フィードバックを送る