--- sourceDocument: Xanadu API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference Release : - xanadu ft:locale : - ja-JP ft:publication_title : - Xanadu API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # クラウドランナー TestGenerationApi -- スコープ対象、グローバル # クラウドランナー TestGenerationApi -- スコープ対象、グローバル {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：7分 自動テストフレームワーク (ATF) のクラウドランナーで実行するテストジョブの生成を管理します。 この API は、CloudRunnerApi スクリプトインクルードの一部です。 この API は、次のタスクに使用できます。 * テスト生成ジョブを開始します。 * テスト生成ジョブの進行状況を確認します。 * テスト生成ジョブをキャンセルします。 {#cloudrnr-TestGenerationAPI-scoped__cloudrnr-TestGenerationAPI-scoped_ul_vwb_wvn_31c} グローバルスコープでは、この API は sn_atf_tg 名前空間内で実行されます。この API を使用するには、 [ATF Test Generator and Cloud Runner](https://www.servicenow.com/docs/access?context=atf-tg-cr-intro&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) (sn_atf_tg) プラグインを有効にする必要があります。 関連項目： * [クラウドランナー TestRunnerApi -- スコープ対象、グローバル](https://servicenow-prod.fluidtopics.net/GKh0rg8wLZXF6vQ_LjLzSw#cloudrnr-TestRunnerAPI-scoped "自動テストフレームワーク (ATF) のクラウドランナーで実行するテストを管理します。 この API は、CloudRunnerApi スクリプトインクルードの一部です。") * [クラウドランナー TestUserApi -- スコープ指定、グローバル](https://servicenow-prod.fluidtopics.net/OsQ0gpbe3VIO5sbw~IeHfA#cloudrnr-TestUserAPI-scoped "自動テストフレームワーク (ATF) のクラウドランナーで実行されるテストユーザージョブを管理します。 この API は、CloudRunnerApi スクリプトインクルードの一部です。") * [クラウドランナーテスト生成 REST API](https://servicenow-prod.fluidtopics.net/U9y2N9VJ58h67SIF3sVvxA#cloudrunner-testgeneration-api "自動テストフレームワーク (ATF) のクラウドランナーで実行するテストジョブの生成を管理します。") {#cloudrnr-TestGenerationAPI-scoped__ul_gd4_zsn_31c} ## TestGenerationApi -- cancelJob(文字列 snboqId) {#ariaid-title2} テスト生成ジョブとそれに関連する更新セットレコードを完了ステータスに設定します。実行中の生成済みテストのルートトラッカーをキャンセルします。キャンセル時にテストジョブが進行中の場合、このメソッドは生成された進行中のテストレコードをスキップに設定します。 {#cr-TestGen-cancelJob_S__table_epx_lv4_g1c__entry__3}{#cr-TestGen-cancelJob_S__cr-snboqId-ph-desc} | 名前 | タイプ | 説明 | |-|-|-| | snboqId | 文字列 | 必須。ブラウザーオーケストレーションキュー \[sn_atf_tg_sn_boq\] テーブル内の BOQ レコードのsys_id。 | [表 : 1. パラメーター] {#cr-TestGen-cancelJob_S__table_epx_lv4_g1c} {#cr-TestGen-cancelJob_S__table_fpx_lv4_g1c__entry__2} | タイプ | 説明 | |-|-| | null | 成功した場合は Null、それ以外の場合はエラーメッセージ。 | [表 : 2. 返される内容] {#cr-TestGen-cancelJob_S__table_fpx_lv4_g1c} 次の例は、インシデントテーブルのテストの生成を開始し、テストの生成をキャンセルする方法を示しています。グローバルスコープでは、sn_atf_tg 名前空間を使用します。 var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({ tableEncodedQuery: "nameISincident", catalogEncodedQuery: "sysIdISEMPTY", maxTestCount: 10 }); CloudRunnerAPI.TestGenerationAPI.cancelJob({snboqId: insertedSnboqId}); ## TestGenerationApi -- progress(文字列 snboqId) {#ariaid-title3} 提供されたブラウザオーケストレーションキュー (BOQ) レコードに対して生成された各テストのステータスを提供します。 {#cr-TestGen-progress_S__table_epx_lv4_g1c__entry__3}{#cr-TestGen-progress_S__cr-snboqId-ph-desc} | 名前 | タイプ | 説明 | |-|-|-| | snboqId | 文字列 | 必須。ブラウザーオーケストレーションキュー \[sn_atf_tg_sn_boq\] テーブル内の BOQ レコードのsys_id。 | [表 : 3. パラメーター] {#cr-TestGen-progress_S__table_epx_lv4_g1c} {#cr-TestGen-progress_S__table_fpx_lv4_g1c__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | テストジョブに関する情報。高度なテストの詳細は、生成されたテスト \[sn_atf_tg_generated_test\] テーブルで確認できます。 { "testsFailed": Number, "testsInProgress": Number, "testsPending": Number, "testsSkipped": Number, "testsSucceeded": Number } | | テスト失敗 | 生成された失敗したテストの数。失敗の理由は、生成されたテスト \[sn_atf_tg_generated_test\] テーブルに一覧表示されます。 データタイプ：数値 | | testsInProgress | 作成されるユースケースの数。 データタイプ：数値 | | テスト保留中 | 生成する残りのユースケースの数。 データタイプ：数値 | | テストがスキップされました | ジョブのキャンセルによりスキップされたテストの数。 データタイプ：数値 | | テスト成功 | 正常に生成されたテストの数。 データタイプ：数値 | [表 : 4. 返される内容] {#cr-TestGen-progress_S__table_fpx_lv4_g1c} 次の例は、インシデントテーブルのテストの生成を開始し、進捗状況を取得して、テストの生成をキャンセルする方法を示しています。グローバルスコープでは、sn_atf_tg 名前空間を使用します。 var snboqId = CloudRunnerAPI.TestGenerationAPI.startJob({ "tableEncodedQuery": "nameISincident", "catalogEncodedQuery": "sysIdISEMPTY", "maxTestCount": 10 }); gs.info(JSON.stringify(CloudRunnerAPI.TestGenerationAPI.progress({snboqId: snboqId}))); CloudRunnerAPI.TestGenerationAPI.cancelJob({"snboqId": snboqId}); 出力: { "testsSucceeded": 4, "testsFailed": 2, "testsPending": 2, "testsInProgress": 8, "testsSkipped": 0 } ## TestGenerationApi -- startJob(String tableEncodedQuery, String userEncodedQuery, String catalogEncodedQuery, Number maxTestCount, Number maxTestCountPerTable, Number maxTestCountPerItem, String email) {#ariaid-title4} ブラウザーオーケストレーションキュー (BOQ) \[sn_atf_tg_sn_boq\] テーブルにレコードを挿入して、テストジョブを開始します。 {#cr-TestGen-startJob_S_S_S_N_N_N_S__table_epx_lv4_g1c__entry__3}{#cr-TestGen-startJob_S_S_S_N_N_N_S__store-2024-05} | 名前 | タイプ | 説明 | |-|-|-| | カタログエンコードクエリ | 文字列 | オプション。テストを生成するカタログアイテム (CI) を指定するエンコードされたクエリ。 デフォルト:すべての CI (空の文字列) | | メール | 文字列 | オプション。テストの生成が完了したときに通知を送信するメールアドレス。 デフォルト:メールなし (空の文字列) | | maxTestCount | 番号 | オプション。生成するテストの最大数。 可能な値:1 〜 9999 デフォルト:9999 (最大値) | | テーブル当たりの最大テスト数 | 番号 | オプション。テーブルごとに生成するテストの最大数。 可能な値:1 〜 10 デフォルト:10 (最大値) | | アイテム当たりの最大テスト数 | 番号 | オプション。CI ごとに生成するテストの最大数。 可能な値:1 〜 10 デフォルト:10 (最大値) | | separateUpdateSetPerScope | ブーリアン | オプション。生成されたテストをそれぞれのスイート、更新セット、およびスコープに分離するか、テストを 1 つのスイート、更新セット、およびスコープに配置するかを示すフラグ。 有効な値： * true:テストは、各テーブルまたはカタログアイテムのスコープに従って、それぞれのスイートと更新セットに配置されます。 * false:生成されたすべてのテストは、同じスイート、更新セット、およびスコープに配置されます。false の場合、要求に scopeForGeneratingTests が必要です。 {#cr-TestGen-startJob_S_S_S_N_N_N_S__ul_l4b_qfj_y1c} デフォルト：true | | scopeForGeneratingTests | 文字列 | separateUpdateSetPerScope が false に設定されている場合は必須です。生成されたすべてのテストを配置するスコープのSys_id。 デフォルト:sys_idなし (空の文字列) | | tableEncodedQuery | 文字列 | オプション。テストを生成するテーブルを指定するエンコードされたクエリ。「[Encoded query strings](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)」を参照してください。 デフォルト:すべてのテーブル (空の文字列) | | userEncodedQuery | 文字列 | オプション。テストを生成するユーザーを指定するエンコードされたクエリ。 デフォルト:すべてのユーザー (空の文字列) | [表 : 5. パラメーター] {#cr-TestGen-startJob_S_S_S_N_N_N_S__table_epx_lv4_g1c} {#cr-TestGen-startJob_S_S_S_N_N_N_S__table_fpx_lv4_g1c__entry__2} | タイプ | 説明 | |-|-| | 文字列 | ブラウザーオーケストレーションキュー \[sn_atf_tg_sn_boq\] テーブル内の BOQ レコードのsys_id。 | [表 : 6. 返される内容] {#cr-TestGen-startJob_S_S_S_N_N_N_S__table_fpx_lv4_g1c} 次の例は、インシデントテーブルのテストの生成を開始する方法を示しています。グローバルスコープでは、sn_atf_tg 名前空間を使用します。 var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({ tableEncodedQuery: "nameISincident", catalogEncodedQuery: "sysIdISEMPTY", maxTestCount: 10 }); gs.info(insertedSnboqId); 出力: