Enterprise 10 から Enterprise 11 Control Room への API データの移行
- 更新日 2020/05/12
Enterprise 10 から Enterprise 11 Control Room への API データの移行
表示と移行の管理のロール権限を持つ Control Room の管理者は、移行 API を使用して Enterprise 10 から最新の Enterprise 11 の Enterprise Control Room にデータを移行できます。
移行 API では、次の操作を実行できます。
- 接続設定を 10.x Control Room データベースに保存/更新します
- 利用可能な場合は、接続設定を 2.x Bot Insight データベースに保存/更新します
- ロール、ユーザー、Bot に基づきデータを移行するためのオプションを指定します
- 移行に指定されたオプション (ロール、ユーザー、Bot) に基づきデータのリストをフェッチします
- 移行の進行状況の概要を表示します
- 移行に付き成功/失敗したエンティティ数の移行統計を表示します
- 移行後に、10.x Control Room から新規および更新された Bot のリストをフェッチします
- マイ ドキュメント フォルダーの移行後に、10.x Control Room から一括してファイルを移行します
あるいは、管理 > 移行モジュールの移行ウィザードを使用して、Control Room ユーザー インターフェースからデータを移行します。詳細は「移行の概要」を参照してください。
API エンド ポイント
次のエンド ポイントを使用して API にアクセスします。
- 移行プロセスには、<Control Room URL>/v2/migration を使用します
- 移行プロセスの完了後に、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 を使用するためにトークンとして渡す必要があります。
- POST メソッドで、エンド ポイント http(s)://<hostname:port>/v1/authentication を使用してトークンを生成します。このために、Control Room インスタンスを、サーバー名/ホスト名/IP およびポート番号として指定します。
例: https://crdevenv.com:81/v1/authentication
- 次のリクエスト ペイロードをヘッダーに指定します。
"X-Authorization" : "Authorization token"
"Content-Type" : "application/json"
- 次のリクエスト ペイロードを本文に指定します。
{
"username": "<Username>",
"password": "<Password>"
}
例:
{
"usename": "Ellie.Brown",
"password": "12345678"
}
1. ソースの Control Room データベースに接続します
この API は、接続設定をソース 10.x Control Room データベースに保存および更新します。
- [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
- 本文に認証情報パラメーターを提供します
- POST メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/connection で 10.x Control Room データベースに接続します
例: https://crdevenv.com:81/v2/migration/connection
- 本文に次のリクエストペイロードを提供します。
{
"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"
}
- [送信] をクリックします。
パラメーターの説明
パラメーター | 説明: |
---|---|
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 データベースで保存されている接続詳細を取得します。
- [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
- 本文に認証情報パラメーターを提供します
- GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/connection で 10.x Control Room データベースの接続詳細をフェッチします
例: https://crdevenv.com:81/v2/migration/connection
- [送信] をクリックします。
- 結果は本文データで確認できます。
{
"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 データベースに接続します。
- [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
- 本文に認証情報パラメーターを提供します
- POST メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/connection /botinsight Bot Insight データベースに接続します。
例: https://crdevenv.com:81/v2/migration/connection/botinsight
- 本文に次のリクエスト パラメーターを提供します。
{
"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"
}
- [送信] をクリックします。
- レスポンスのステータスが「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 データベースで保存されている接続詳細を取得します。
- [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
- 本文に認証情報パラメーターを提供します
- GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/connection/botinsight で 10.x Control Room データベースの接続詳細をフェッチします。
例: https://crdevenv.com:81/v2/migration/connection/botinsight
- [送信] をクリックします。
- レスポンスのステータスが「200 Migration config」であれば、接続パラメーターは正常に保存されています。
- 結果は本文データで確認できます。
{
"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、スケジュールのいずれかのオプションを使用して、選択したパラメーターに関連付けられているすべてのデータを移行できます。
- [X-Authorization] パラメーターをヘッダーに指定します。
- GET メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/connection /entities で、次にロール、ユーザー、Bot またはスケジュールのいずれかのオプションを含む TYPE パラメーターで Control Room データベースに接続します。
例: https://crdevenv.com:81/v2/migration/connection/entities?Type=ROLE
- [送信] をクリックします。
- レスポンスのステータスが「200」であれば、データが返されています。
- 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 は、移行用に指定されたエンティティ タイプのサブセクションに基づき、関連データを持つエンティティを移行します。
- [X-Authorization] パラメーターと [Content Type] パラメーターをヘッダーに指定します。
- POST メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/prepare でデータを移行します。
例: https://crdevenv.com:81/v2/migration/prepare
- 本文に次のリクエスト ペイロードを提供します。
{
"selected":
[
{ "type": "<enitity type>",
"sourceId": "string" }
],
"excludes": [ "<entity type>"
]
}
例:
{ "selected": [ { "type": "ROLE", "sourceId": "12" } ], "excludes": [ "BOT" ] }
- [送信] をクリックします。
- レスポンスのステータスが「200」であれば、データは正常な移行としてリストされています。
- 結果は本文に表示されます。
{ "selected":
[
{ "type": "ROLE", "sourceId": "12" } ],
"excludes": [ "BOT" ]
}
パラメーターの説明
パラメーター | 説明: |
---|---|
type | 移行のために選択されたエンティティタイプ (ロール、ユーザー、Bot) です |
sourceId | ソース データベース内のエンティティ ID です |
excludes |
移行から除外されるエンティティ名です。選択したエンティティ タイプに基づくオプションがあります。 [ロール] または [ユーザー] を選択すると、Bot とスケジュールを除外できます。[Bot とスケジュール] を選択すると、MetaBotを除外、または既存の Bot を上書きできます。 |
7. 移行を開始する
この API は、移行プロセスを開始します。
- [X-Authorization] パラメーターをヘッダーに指定します。
- POST メソッドを使用して、エンド ポイント http(s)://<hostname:port>/v2/migration/start/async でデータを移行します。
例: https://crdevenv.com:81/v2/migration/start/async
- [送信] をクリックします。
- レスポンスのステータスが「200 Successful operation」であれば、データの移行が正常に開始されています。
- 結果は本文に表示されます。
{
"id": 1,
"name": "2018.07.17.16.13.48.ellie.brown",
"createdBy": 1,
"migrationType": "ROLE_EXCLUDE_BOT_SCHEDULE"
}