Enterprise 10 から Enterprise 11 Control Room への API データの移行

表示移行の管理のロール権限を持つ Control Room の管理者は、移行 API を使用して Enterprise 10 から最新の Enterprise 11 の Enterprise Control Room にデータを移行できます。

移行 API では、次の操作を実行できます。

  1. 接続設定を 10.x Control Room データベースに保存/更新します
  2. 利用可能な場合は、接続設定を 2.x Bot Insight データベースに保存/更新します
  3. ロール、ユーザー、Bot に基づきデータを移行するためのオプションを指定します
  4. 移行に指定されたオプション (ロール、ユーザー、Bot) に基づきデータのリストをフェッチします
  5. 移行の進行状況の概要を表示します
  6. 移行に付き成功/失敗したエンティティ数の移行統計を表示します
  7. 移行後に、10.x Control Room から新規および更新された Bot のリストをフェッチします
  8. マイ ドキュメント フォルダーの移行後に、10.x Control Room から一括してファイルを移行します

あるいは、管理 > 移行モジュールの移行ウィザードを使用して、Control Room ユーザー インターフェースからデータを移行します。詳細は「移行の概要」を参照してください。

注: このトピックで示す例は、あくまでも参考用です。

API エンド ポイント

次のエンド ポイントを使用して API にアクセスします。

  1. 移行プロセスには、<Control Room URL>/v2/migration を使用します
  2. 移行プロセスの完了後に、10.x Control Room のソースのマイ ドキュメント フォルダーからファイルを移行する場合は、<Control Room URL>/v1/migration を使用します

例:

https://crdevenv.com:81/v2/migration

移行プロセス API

移行 API は、前述のエンド ポイントを使用して 10.x Control Room データを 11.x Control Room へと移行させます。

移行 API にアクセスする前には認証 API を使用し、特定の移行 API を使用するためにトークンとして渡す必要があります。

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

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

  2. 次のリクエスト ペイロードをヘッダーに指定します。

    "X-Authorization" : "Authorization token"

    "Content-Type" : "application/json"

  3. 次のリクエスト ペイロードを本文に指定します。

    {

    "username": "<Username>",

    "password": "<Password>"

    }

    例:

    {

    "usename": "Ellie.Brown",

    "password": "12345678"

    }

1. ソースの Control Room データベースに接続します

この API は、接続設定をソース 10.x Control Room データベースに保存および更新します。

  1. [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
  2. 本文に認証情報パラメーターを提供します
  3. POST メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/connection で 10.x Control Room データベースに接続します

    例: https://crdevenv.com:81/v2/migration/connection

  4. 本文に次のリクエストペイロードを提供します。

    {

    "host": "string", "port": 0, "databaseName": "string", "username": "string", "password": "string", "integratedSecurity": true, "encrypt": true, "privateKey": "string", "repoPath": "string"

    }

    例:

    {

    "host": "PRODUCTLT",

    "port": 1433,

    "databaseName": "CR104MIG",

    "username": "Ellie.Brown",

    "password": "12345678"

    "integratedSecurity": true,

    "encrypt": true,

    "privateKey": "ABC123",

    "repoPath": "D:\\Data\Automation Anywhere Server Files"

    }

  5. [送信] をクリックします。

パラメーターの説明

パラメーター 説明:
host ソースの Control Room データベースのホスト名です
port ソースの Control Room データベースのポート番号です
databaseName ソースの Control Room データベース名です
username データベースに接続するためのユーザー名です
password データベースに接続するためのパスワードです
integratedSecurity ソースのデータベースへの接続時に Windows 認証を使用するかどうかのインジケーターです。Windows 認証を使用する場合は、これを True に設定します。デフォルト値は False です。
encrypt ソースのデータベースで安全な接続を使用するかどうかのインジケーターです。安全な接続を使用する場合は、これを True に設定します。デフォルト値は false です。
privateKey ソースのデータベースで資格情報値を解読するためのプライベートキーです。これは Control Room の初期のセットアップ時に構成できます。
repoPath Control Room 10.x リポジトリが格納されている、共有されたリポジトリ パスです

2. 保存されている接続詳細を取得する

この API は、データの移行先にできる、ソースの 10.x Control Room データベースで保存されている接続詳細を取得します。

  1. [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
  2. 本文に認証情報パラメーターを提供します
  3. GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/connection で 10.x Control Room データベースの接続詳細をフェッチします

    例: https://crdevenv.com:81/v2/migration/connection

  4. [送信] をクリックします。
  5. 結果は本文データで確認できます。

    {

    "host": "productlt",

    "port": 1433,

    "databaseName": "CR104MIG",

    "username": "",

    "password": "",

    "integratedSecurity": true,

    "encrypt": false,

    "privateKey": "",

    "repoPath": "D:\\DATA\AUTOMATION ANYWHERE SERVER FILES"

    }

パラメーターの説明

パラメーター 説明:
host ソースのデータベース ホストです
port ソースのデータベース ポストです
databaseName ソースのデータベース名です
username ソースのデータベースに接続するためのユーザー名です
password ソースのデータベースに接続するためのパスワードです
integratedSecurity ソースのデータベースへの接続時に Windows 認証を使用するかどうかのインジケーターです (デフォルト値は False)
encrypt ソースのデータベースへの接続時に安全な接続を使用するかどうかのインジケーターです (デフォルト値は False)
privateKey ソースのデータベースで資格情報値を解読するためのプライベート キーです
repoPath Control Room 10.x リポジトリが格納されている、共有されたリポジトリ パスです

3. 2.x Bot Insight データベースに接続します (利用可能な場合)

この API は、利用可能な場合に分析データを移行させるため、ソース 2.x Bot Insight データベースに接続します。

  1. [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
  2. 本文に認証情報パラメーターを提供します
  3. POST メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/connection /botinsight Bot Insight データベースに接続します。

    例: https://crdevenv.com:81/v2/migration/connection/botinsight

  4. 本文に次のリクエスト パラメーターを提供します。

    {

    "host": "string",

    "port": 0,

    "databaseName": "string",

    "username": "string",

    "password": "string",

    "integratedSecurity": true,

    "encrypt": true,

    "serverUrl": "string"

    }

    例:

    {

    "host": "Productlt",

    "port": 8091,

    "databaseName": "BotInsight",

    "username": "Ellie.Brown",

    "password": "12345678"

    "integratedSecurity": true,

    "encrypt": true,

    "serverUrl": "https://productlt.example.com:82/analytics"

    }

  5. [送信] をクリックします。
  6. レスポンスのステータスが「200 Successful operation」であれば、接続パラメーターは正常に保存されています

パラメーターの説明

パラメーター 説明:
host ソースの Bot Insight データベースのホスト名です
port ソースの Bot Insight データベースのポート番号です
databaseName ソースの Bot Insight データベースの名前です
username データベースに接続するためのユーザー名です
password データベースに接続するためのパスワードです
integratedSecurity ソースのデータベースへの接続時に Windows 認証を使用するかどうかのインジケーターです。Windows 認証を使用する場合は、これを True に設定します。デフォルト値は False です。
encrypt ソースのデータベースで安全な接続を使用するかどうかのインジケーターです。安全な接続を使用する場合は、これを True に設定します。デフォルト値は False です。
serverUrl Bot Insight Visualization ServerPort のサーバー URL です

4. 保存されている接続詳細を取得する

この API は、データの移行先にできる、ソースの 2.x Bot Insight‬ データベースで保存されている接続詳細を取得します。

  1. [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
  2. 本文に認証情報パラメーターを提供します
  3. GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/connection/botinsight で 10.x Control Room データベースの接続詳細をフェッチします。

    例: https://crdevenv.com:81/v2/migration/connection/botinsight

  4. [送信] をクリックします。
  5. レスポンスのステータスが「200 Migration config」であれば、接続パラメーターは正常に保存されています。
  6. 結果は本文データで確認できます。

    {

    "host": "Productlt",

    "port": 8091,

    "databaseName": "BotInsight",

    "username": "Ellie.Brown",

    "password": "12345678"

    "integratedSecurity": true,

    "encrypt": true,

    "serverUrl": "https://productlt.example.com:82/analytics"

    }

パラメーターの説明

パラメーター 説明:
host ソースの Bot Insight データベースのホスト名です
port ソースの Bot Insight データベースのポート番号です
databaseName ソースの Bot Insight データベース名です
username データベースに接続するためのユーザー名です
password データベースに接続するためのパスワードです
integratedSecurity ソースのデータベースへの接続時に Windows 認証を使用するかどうかのインジケーターです。Windows 認証を使用する場合は、これを True に設定します。デフォルト値は False です。
encrypt ソースのデータベースで安全な接続を使用するかどうかのインジケーターです。安全な接続を使用する場合は、これを True に設定します。デフォルト値は False です。
serverUrl Bot Insight Visualization ServerPort のサーバー URL です

5. ソース データベースで移行可能な TYPE のエンティティ リスト

この API は、TYPE パラメーターを使用して、移行元データベースで移行可能なエンティティ リストを返します。ロール、ユーザー、Bot、スケジュールのいずれかのオプションを使用して、選択したパラメーターに関連付けられているすべてのデータを移行できます。

  1. [X-Authorization] パラメーターをヘッダーに指定します。
  2. GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/connection /entities で、次にロールユーザーBot またはスケジュールのいずれかのオプションを含む TYPE パラメーターで Control Room データベースに接続します。

    例: https://crdevenv.com:81/v2/migration/connection/entities?Type=ROLE

  3. [送信] をクリックします。
  4. レスポンスのステータスが「200」であれば、データが返されています。
  5. TYPE パラメーターに基づくエンティティ リストが本文に表示されます。

    {

    "entities":

    [

    { "id": "0", "type": "ROLE", "sourceId": "1", "targetId": "0", "name": "Admin", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "2", "targetId": "0", "name": "Basic", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "3", "targetId": "0", "name": "IQBotValidator", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "4", "targetId": "0", "name": "AnalyticsExperts", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "5", "targetId": "0", "name": "AnalyticsConsumers", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "6", "targetId": "0", "name": "BotAgentUser", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "7", "targetId": "0", "name": "BotFarmAdmin", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "8", "targetId": "0", "name": "IQBotServices", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "9", "targetId": "0", "name": "Bot Creator 10x", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "10", "targetId": "0", "name": "Bot Runner 10x", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "11", "targetId": "0", "name": "Bot Scheduler 10x", "status": "SUCCESS", "reason": "" }

    ]

    }

パラメーターの説明

パラメーター 説明:
id 移行 ID
タイプ 移行のために選択されたエンティティ タイプ (ロール、ユーザー、Bot)
sourceId ソース データベース内のエンティティ ID
targetId ターゲット データベース内の移行後のエンティティ ID
名前 ソース データベース内のエンティティ名
ステータス 特定のエンティティの移行ステータス
理由 特定のエンティティの移行失敗の理由

6. ユーザー入力に基づき移行データを準備する

この API は、移行用に指定されたエンティティ タイプのサブセクションに基づき、関連データを持つエンティティを移行します。

  1. [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
  2. POST メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/prepare でデータを移行します。

    例: https://crdevenv.com:81/v2/migration/prepare

  3. 本文に次のリクエスト ペイロードを提供します。

    {

    "selected":

    [

    { "type": "<enitity type>",

    "sourceId": "string" }

    ],

    "excludes": [ "<entity type>"

    ]

    }

    例:

    { "selected": [ { "type": "ROLE", "sourceId": "12" } ], "excludes": [ "BOT" ] }

  4. [送信] をクリックします。
  5. レスポンスのステータスが「200」であれば、データは正常な移行としてリストされています。
  6. 結果は本文に表示されます。

    { "selected":

    [

    { "type": "ROLE", "sourceId": "12" } ],

    "excludes": [ "BOT" ]

    }

パラメーターの説明

パラメーター 説明:
type 移行のために選択されたエンティティタイプ (ロール、ユーザー、Bot) です
sourceId ソース データベース内のエンティティ ID です
excludes

移行から除外されるエンティティ名です。選択したエンティティ タイプに基づくオプションがあります。

[ロール] または [ユーザー] を選択すると、Bot とスケジュールを除外できます。[Bot とスケジュール] を選択すると、MetaBotを除外、または既存の Bot を上書きできます。

7. 移行を開始する

この API は、移行プロセスを開始します。

  1. [X-Authorization] パラメーターをヘッダーに指定します。
  2. POST メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/start/async でデータを移行します。

    例: https://crdevenv.com:81/v2/migration/start/async

  3. [送信] をクリックします。
  4. レスポンスのステータスが「200 Successful operation」であれば、データの移行が正常に開始されています。
  5. 結果は本文に表示されます。

    {

    "id": 1,

    "name": "2018.07.17.16.13.48.ellie.brown",

    "createdBy": 1,

    "migrationType": "ROLE_EXCLUDE_BOT_SCHEDULE"

    }

パラメーターの説明

パラメーター 説明:
id 移行 ID
名前 移行を開始したユーザーの名前です
createdBy 移行を開始したエンティティの ID です。例: Control Room の管理者
migrationType 選択された移行タイプ (ロール、ユーザー、Bot、スケジュール) です。

8. ID 別の移行オブジェクト

この API は、移行開始 API を使用して生成された ID に基づき、移行オブジェクトの詳細をリストします。

  1. [X-Authorization] パラメーターをヘッダーに指定します。
  2. GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/<id> で ID 別にオブジェクトの詳細をフェッチします。

    例: https://crdevenv.com:81/v2/migration/9

  3. [送信] をクリックします。
  4. レスポンスのステータスが「200」であれば、オブジェクトの詳細は正常にリストされています。
  5. 詳細は本文データに表示されます。

    {

    "id": "9",

    "name": "2018.07.17.16.13.48.ellie.brown",

    "startTime": "2018-07-17T10:43:48.127Z",

    "endTime": "2018-07-17T10:43:49.833Z",

    "createdBy": "1",

    "migrationType": "ROLE_EXCLUDE_BOT_SCHEDULE",

    "entities": []

    }

パラメーターの説明

パラメーター 説明:
id 移行 ID
名前 移行を開始したユーザーの名前です
startTime 移行が開始した時間です
endTime 移行が完了した時間です
createdBy 移行を開始したエンティティの ID です。例: Control Room の管理者
entities 移行プロセス中に移行されたエンティティ リストです
migrationType 選択された移行タイプ (ロール、ユーザー、Bot、スケジュール) です。

9. 移行の進捗

この API は、進行中の移行プロセスを表示します。

  1. [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
  2. 本文に認証情報パラメーターを提供します
  3. GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/pogress で ID 別にオブジェクトの詳細をフェッチします。

    例: https://crdevenv.com:81/v2/migration/progress

  4. [送信] をクリックします。
  5. レスポンスのステータスが「200」であれば、オブジェクトの詳細は正常にリストされています。
  6. 詳細は本文データに表示されます。

    {

    "migration":

    { "id": "10", "name": "2018.07.17.16.55.59.ellie.brown", "startTime": "2018-07-17T11:25:59.800Z", "endTime": "2018-07-17T11:26:16.002Z", "createdBy": "1", "migrationType": "BOT_EXCLUDE_MetaBot", "entities": [] },

    "current": "SCHEDULE",

    "progress":

    {

    "BOT": { "total": "10", "successful": "7", "failed": "0", "skipped": "3" },

    "SCHEDULE": { "total": "8", "successful": "8", "failed": "0", "skipped": "0" }

    }

    }

パラメーターの説明

パラメーター 説明:
id 移行 ID です
名前 表示されている移行名です
startTime 移行プロセスが開始したときのタイムスタンプです
endTime 移行プロセスが完了したときのタイムスタンプです。移行が進行中の場合は空になっています
createdBy 移行プロセスを作成または開始したユーザーの ID です
現在 移行されているエンティティ タイプ (ロール、ユーザー、資格情報、Bot、スケジュール) です
進行状況

エンティティのプログレス -

  • 合計 - 移行する特定のエンティティ タイプの合計数です
  • 成功 - 全体のうち正常に移行されたエンティティの数です
  • 失敗 - 全体のうち移行できなかったエンティティの数です
  • スキップ - 全体のうち移行中にスキップされたエンティティの数です

10. 移行統計 - 移行に付き成功/失敗したエンティティ数

この API は、移行に付き成功または失敗したエンティティの数を表示します。

  1. [X-Authorization] パラメーターをヘッダーに指定します。
  2. GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/statistics で ID 別にオブジェクトの詳細をフェッチします。

    例: https://crdevenv.com:81/v2/migration/statistics

  3. [送信] をクリックします。
  4. レスポンスのステータスが「200」であれば、オブジェクトの詳細は正常にリストされています。
  5. 詳細は本文データに表示されます。

    {

    "items": [

    { "id": "1", "name": "2018.07.13.11.14.59.ellie.brown", "startTime": "2018-07-13T05:44:59.787Z", "endTime": "2018-07-13T06:56:25.537Z", "createdBy": "1", "duration": "4285s", "numSuccess": 0, "numFailed": 0, "numSkipped": 0 },

    { "id": "2", "name": "2018.07.13.12.28.08.ellie.brown", "startTime": "2018-07-13T06:58:09.283Z", "endTime": "2018-07-13T06:58:12.910Z", "createdBy": "1", "duration": "3s", "numSuccess": 1, "numFailed": 1, "numSkipped": 0 },

    { "id": "3", "name": "2018.07.13.12.40.34.ellie.brown", "startTime": "2018-07-13T07:10:34.470Z", "endTime": "2018-07-13T07:10:40.060Z", "createdBy": "1", "duration": "5s", "numSuccess": 10, "numFailed": 0, "numSkipped": 0 },

    { "id": "4", "name": "2018.07.13.12.42.19.ellie.brown", "startTime": "2018-07-13T07:12:20.007Z", "endTime": "2018-07-13T07:12:23.107Z", "createdBy": "1", "duration": "3s", "numSuccess": 0, "numFailed": 0, "numSkipped": 6 },

    { "id": "5", "name": "2018.07.13.13.39.53.ellie.brown", "startTime": "2018-07-13T08:09:53.113Z", "endTime": "2018-07-13T08:10:02.673Z", "createdBy": "1", "duration": "9s", "numSuccess": 4, "numFailed": 0, "numSkipped": 0 }

    ]

    }

パラメーターの説明

パラメーター 説明:
id 移行 ID です
名前 表示されている移行名です
startTime 移行プロセスが開始したときのタイムスタンプです
endTime 移行プロセスが完了したときのタイムスタンプです。移行が進行中の場合は空になっています
createdBy オブジェクトを作成したユーザーの ID です
期間 移行に要した期間 (秒またはナノ秒) です
numSuccess 正常に移行されたアイテムの数です
numFailed 移行に失敗したアイテムの数です
numSkipped 移行中にスキップされたアイテムの数です

移行プロセス後の API

プロセスの完了後、次のために移行 API を使用します。

  1. 10.x Control Room のマイ ドキュメント フォルダーからファイルをインポートします
  2. 最後のマイグレーション実行以降に 10.x Control Room から、新規または変更された Bot のリストを取得します
    注: API にアクセスする前には認証 API を使用し、特定の移行 API を使用するためにトークンとして渡す必要があります。
  3. POST メソッドで、エンド ポイント http(s)://<hostname:port>/v1/authentication を使用してトークンを生成します。このために、Control Room インスタンスを、サーバー名/ホスト名/IP およびポート番号として指定します。

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

  4. 次のリクエスト ペイロードをヘッダーに指定します。

    "X-Authorization" : "Authorization token"

    "Content-Type" : "application/json"

  5. 次のリクエスト ペイロードを本文に指定します。

    {

    "username": "<Username>",

    "password": "<Password>"

    }

例:

{

"usename": "Ellie.Brown",

"password": "12345678"

}

重要: 移行後の API の一部または全部を使用しているときにエラーコード 404 が表示された場合は、API を再度使用して 10.x Control Room からルート フォルダーのリストをフェッチします (例: http(s)://<hostname:port>/v1/migration/legacyrepository/rootDirectories)

A. マイ ドキュメント フォルダーからファイルをインポートする

特定の API セットを使用して、10.x Control Room のマイ ドキュメント フォルダーからファイルを移行します。これらの API は、自動化に役立つよう、Bot 内で依存関係またはスタンドアロンとして使用可能な多数のファイルをインポートします。

1. 10.x Control Room からルート フォルダーのリストをフェッチする

この API は、10.x Control Room リポジトリで利用可能なフォルダーのリストをフェッチします。これは、ソース Control Room で利用可能であったフォルダー構造の理解に役立ちます。

  1. [X-Authorization] パラメーターをヘッダーに指定します。
  2. GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v1/migration/legacyrepository/rootDirectories で、次に excludeMetaBot パラメーターで ID 別にオブジェクトの詳細をフェッチします。

    例: https://crdevenv.com:81/v1/migration/legacyrepository/rootDirectories?excludeMetaBot=true

  3. [送信] をクリックします。
  4. レスポンスのステータスが「200」であれば、オブジェクトの詳細は正常にリストされています。
  5. 詳細は本文データに表示されます。

    [

    { "name": "My Docs", "path": "Automation Anywhere\\My Docs" },

    { "name": "My Exes", "path": "Automation Anywhere\\My Exes" },

    { "name": "My Reports", "path": "Automation Anywhere\\My Reports" },

    { "name": "My Scripts", "path": "Automation Anywhere\\My Scripts" },

    { "name": "My Tasks", "path": "Automation Anywhere\\My Tasks" },

    { "name": "My Workflow", "path": "Automation Anywhere\\My Workflow" }

    ]

パラメーターの説明

パラメーター 説明:
名前 ディレクトリ/フォルダーの名前です
path ディレクトリ/フォルダーのパスです

2. 10.x Control Room からルート フォルダーのサブフォルダーのリストをフェッチする

この API は、10.x Control Room リポジトリで使用可能な、特定のルート フォルダーのサブフォルダーのリストをフェッチします。これは、ソースの Control Room のフォルダー構造の理解に役立ちます。

  1. [X-Authorization] パラメーターをヘッダーに指定します。
  2. GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v1/migration/legacyrepository/childDirectories で、次に path パラメーターで ID 別にオブジェクトの詳細をフェッチします。

    例: https://crdevenv.com:81/v1/migration/legacyrepository/childDirectories?path=Automation Anywhere\My Docs

  3. [送信] をクリックします。
  4. レスポンスのステータスが「200」であれば、オブジェクトの詳細は正常にリストされています。
  5. 詳細は本文データに表示されます。

    {

    "folders":

    [

    { "name": "Log-Files", "path": "Automation Anywhere\\My Docs\\Log-Files" }

    ]

    }

パラメーターの説明

パラメーター 説明:
フォルダー サブディレクトリのリストです
名前 ディレクトリ/フォルダーの名前です
path ディレクトリ/フォルダーのパスです

3. 特定のフォルダー内のファイル リストをフェッチする

この API は、ソースの Control Room リポジトリの特定のフォルダーで利用可能なファイル リストをフェッチします。

  1. [X-Authorization] パラメーターをヘッダーに指定します。
  2. GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v1/migration/legacyrepository/childFiles で、次に pathexcludeMetaBot パラメーターで ID 別にオブジェクトの詳細をフェッチします。

    例: https://crdevenv.com:81/v1/migration/legacyrepository/childFiles?path=Automation Anywhere\My Docs\Log-Files&excludeMetaBot=false

  3. [送信] をクリックします。
  4. レスポンスのステータスが「200」であれば、オブジェクトの詳細は正常にリストされています。
  5. 詳細は本文データに表示されます。

    {

    "files":

    [

    { "id": "280", "name": "ActiveMQServer-2018-Jul-17-2.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\ActiveMQServer-2018-Jul-17-2.log.zip" },

    { "id": "281", "name": "IgniteServer-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\IgniteServer-2018-Jul-17-4.log.zip" },

    { "id": "283", "name": "WebCR_Ignite-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Ignite-2018-Jul-17-4.log.zip" },

    { "id": "284", "name": "WebCR_License-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_License-2018-Jul-17-4.log.zip" },

    { "id": "292", "name": "WebCR_Migration-2018-Jul-17-4.log", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.log" },

    { "id": "285", "name": "WebCR_Migration-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.log.zip" },

    { "id": "293", "name": "WebCR_Migration-2018-Jul-17-4.txt", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.txt" }

    ]

    }

パラメーターの説明

パラメーター 説明:
files サブ ファイルのリストです
id Bot のファイル ID です
名前 ディレクトリ/フォルダーの名前です
path ディレクトリ/フォルダーのパスです

4. Control Room 10.x 内でフォルダーを名前別に検索する

この API は、ソースの Control Roomマイ ドキュメント リポジトリから特定の名前のフォルダーを検索します。

  1. [X-Authorization] パラメーターをヘッダーに指定します。
  2. GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v1/migration/legacyrepository/folders で、次に taskName パラメーターで ID 別にオブジェクトの詳細をフェッチします。

    例: https://crdevenv.com:81/v1/migration/legacyrepository/folders?taskName=Import-Table

  3. [送信] をクリックします。
  4. レスポンスのステータスが「200」であれば、オブジェクトの詳細は正常にリストされています。
  5. 詳細は本文データに表示されます。

    {

    "paths":

    [ "Automation Anywhere\\My Docs\\Import-Table" ]

    }

パラメーターの説明

パラメーター 説明:
paths ディレクトリ/フォルダー パスのリストです

5. Control Room 10.x で指定したフォルダーのファイル リストをフェッチする

この API は、ソースの Control Room マイ ドキュメント リポジトリの特定のフォルダーで利用可能なファイル リストをフェッチします。

  1. [X-Authorization] パラメーターをヘッダーに指定します。
  2. POST メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v1/legacyrepository/files で特定のフォルダーのファイル リストをフェッチします。

    例: https://crdevenv.com:81/v1/legacyrepository/files

  3. フォルダー パスのリストをリクエスト ペイロードとして本文に提供します。

    [

    "string"

    ]

    たとえば、次は利用可能なファイルを一覧表示します。

    [

    "Automation Anywhere\\My Docs\\Import-Table"

    ]

  4. [送信] をクリックします。
  5. レスポンスのステータスが「200」であれば、オブジェクトの詳細は正常にリストされています。
  6. レスポンスの詳細は本文データに表示されます。

    {

    "files":

    [

    { "id": 1281, "type": "BOT", "sourceId": "1281", "targetId": 0, "name": "Automation Anywhere\\My Docs\\Import-Table\\Import-Table.txt", "status": "SUCCESS", "reason": "" },

    { "id": 293, "type": "BOT", "sourceId": "293", "targetId": 0, "name": "Automation Anywhere\\My Docs\\Import-Table\\WebCR_Migration-2018-Jul-17-4.txt", "status": "SUCCESS", "reason": "" }

    ]

    }

パラメーターの説明

パラメーター 説明:
files サブ ファイルのリストです
type file type
sourceId ソース データベース内のエンティティ ID
targetId ターゲット データベース内の移行後のエンティティ ID です
名前 ディレクトリ/フォルダーの名前です
ステータス レスポンスのステータス (SUCCESS、SKIPPED、または FAILED) です
理由 ステータスが「失敗」または「スキップ」とされる理由の説明です

B. 11.x の最後の移行後に新規作成または変更された Bot を 10.x から移行する

この API は、データがすでに Control Room バージョン 11.x に移行された後に、ソースの Control Room バージョン 10.x で新規または変更された Bot のリストをフェッチします。基本的にこの API は、11.x 環境の稼働準備が整っていたとしても、10.x 環境を自由に使用し続けることができます。

  1. [X-Authorization] パラメーターをヘッダーに指定します。
  2. POST メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v1/legacyrepository/changedfiles で ID 別にオブジェクトの詳細をフェッチします。

    例: https://crdevenv.com:81/v1/legacyrepository/changedfiles

  3. フォルダー パスのリストをリクエスト ペイロードとして本文に提供します。

    {

    "changeSince": "<last migration date and time>"

    }

    たとえば、次は移行後に更新された Bot 名を一覧表示します。

    {

    "changeSince":"2018-06-25T12:05:00+05:30"

    }

    ヒント: 最後の移行日時のデルタとして、changeSince パラメーターを指定しないでください。
  4. [送信] をクリックします。
  5. レスポンスのステータスが「200」であれば、オブジェクトの詳細は正常にリストされています。
  6. レスポンスの詳細は本文データに表示されます。

    {

    "changedfiles":

    [

    { "type": "BOT", "sourceId": "6", "name": "Automation Anywhere\\My Tasks\\Sample Tasks\\Import-Table.atmx" },

    { "type": "BOT", "sourceId": "7", "name": "Automation Anywhere\\My Tasks\\Sample Tasks\\List-Variable.atmx" }

    ]

    }

パラメーターの説明

パラメーター 説明:
changedFiles 前回の移行後に変更された、または新規のエンティティ リストです
タイプ エンティティ タイプ
sourceId ソース データベース内のエンティティ ID
名前 ディレクトリ/フォルダーの名前です

API レスポンス コード

Http(s) ステータス コード レスポンス - 説明 対処法
200% 成功した操作です NA
400 不正なリクエスト 有効なパラメーターを使用して再試行します
401 認証が必要です 認証パラメーターを提供して再試行します
403 不正なアクセス この操作を実行するための適切な権限があることを確認します
404 見つかりません Control Room で要求されたデータが存在することを確認します
409 競合 指定したパラメーターが正しいことを確認してください
500 内部サーバー エラー サーバーが稼働中であることを確認してください
501 権限エラー 必要な権限があることを確認してください

監査ログ

監査ログは、移行されたエンティティのエントリを個別に表示します。

移行された各エンティティの詳細を示す監査ログ

移行プロセスが開始すると、移行が開始されましたというエントリが監査ログに記録されます。同様に、移行プロセスが完了すると、移行の完了エントリが記録されます。これら 2 つのエントリ間では、移行エントリは、作成更新またはアップロード操作など、移行されたエンティティごと記録されます。

こちらをクリックします 表示アイコン。プロセスの詳細を表示します。