---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Cloud Runner-TestgenerationApi: Bereichsbezogen, global

# Cloud Runner-TestgenerationApi: Bereichsbezogen, global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 Minuten Lesedauer

Verwaltet die Testauftragsgenerierung, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden soll.
Diese API ist Teil der CloudRunnerApi-Skripteinbindung.  
Sie können diese API für die folgenden Aufgaben verwenden:

* Starten Sie den Testgenerierungsauftrag.
* Überprüfen Sie den Fortschritt des Testgenerierungsauftrags.
* Brechen Sie den Testgenerierungsauftrag ab.
{#cloudrnr-TestGenerationAPI-scoped__cloudrnr-TestGenerationAPI-scoped_ul_vwb_wvn_31c}

Im globalen Bereich wird diese API innerhalb des Namespace „sn_atf_tg" ausgeführt. Sie müssen haben [ATF Test Generator and Cloud Runner](https://www.servicenow.com/docs/access?context=atf-tg-cr-intro&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)(sn_atf_tg) Plugin aktiviert, um diese API zu verwenden.  
Siehe auch:

* [Cloud Runner TestRunnerApi: Bereichsbezogen, global](https://servicenow-prod.fluidtopics.net/nNJhCpN~0DF6sDSBxM_qXg#cloudrnr-TestRunnerAPI-scoped "Verwaltet Tests, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden sollen. Diese API ist Teil der CloudRunnerApi-Skripteinbindung.")
* [Cloud Runner-TestanwenderApi -- Umfang, Global](https://servicenow-prod.fluidtopics.net/B3pJaXlVC2jVCRG6bYdCxg#cloudrnr-TestUserAPI-scoped "Verwaltet Testanwenderaufträge, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden sollen. Diese API ist Teil der CloudRunnerApi-Skripteinbindung.")
* [REST-API für Cloud Runner-Testgenerierung](https://servicenow-prod.fluidtopics.net/f2BtiILLFT4ojMNM6P7QOA#cloudrunner-testgeneration-api "Verwaltet die Testauftragsgenerierung, die in einem Cloud Runner für automatisiertes Test-Framework (ATF) ausgeführt werden soll.")
{#cloudrnr-TestGenerationAPI-scoped__ul_gd4_zsn_31c}

## TestGenerationApi -- cancelJob (Zeichenfolge snboqId) {#ariaid-title2}

Legt den Testgenerierungsauftrag und den zugehörigen Update-Satz-Datensatz auf den Status „Abgeschlossen" fest. Bricht die Stamm-Tracker aller generierten Tests ab, die ausgeführt werden. Wenn beim Abbrechen Testaufträge ausgeführt werden, legt diese Methode einen der generierten in Bearbeitung befindlichen Testdatensätze auf „Übersprungen" fest.
{#cr-TestGen-cancelJob_S__table_epx_lv4_g1c__entry__3}{#cr-TestGen-cancelJob_S__cr-snboqId-ph-desc}

| Name | Typ | Beschreibung |
|-|-|-|
| SnboqId | Zeichenfolge | Erforderlich. Die sys_ID des BOQ-Datensatzes in der Tabelle „Browserorchestration-Warteschlange \[sn_atf_tg_sn_boq\]". |
[Tabelle : 1. Parameter]

{#cr-TestGen-cancelJob_S__table_epx_lv4_g1c} {#cr-TestGen-cancelJob_S__table_fpx_lv4_g1c__entry__2}

| Typ | Beschreibung |
|-|-|
| Null | Null, wenn erfolgreich, andernfalls Fehlermeldung. |
[Tabelle : 2. Rückgaben]

{#cr-TestGen-cancelJob_S__table_fpx_lv4_g1c}  
Das folgende Beispiel zeigt, wie Sie mit der Generierung von Tests für die Incident-Tabelle beginnen und die Testgenerierung abbrechen. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
      tableEncodedQuery: "nameISincident",
      catalogEncodedQuery: "sysIdISEMPTY",
      maxTestCount: 10
    });

    CloudRunnerAPI.TestGenerationAPI.cancelJob({snboqId: insertedSnboqId});

## TestGenerationApi -- Fortschritt (Zeichenfolge snboqId) {#ariaid-title3}

Stellt den Status jedes generierten Tests für einen bereitgestellten BOQ-Datensatz (BrowserOrchestration Queue) bereit.
{#cr-TestGen-progress_S__table_epx_lv4_g1c__entry__3}{#cr-TestGen-progress_S__cr-snboqId-ph-desc}

| Name | Typ | Beschreibung |
|-|-|-|
| SnboqId | Zeichenfolge | Erforderlich. Die sys_ID des BOQ-Datensatzes in der Tabelle „Browserorchestration-Warteschlange \[sn_atf_tg_sn_boq\]". |
[Tabelle : 3. Parameter]

{#cr-TestGen-progress_S__table_epx_lv4_g1c} {#cr-TestGen-progress_S__table_fpx_lv4_g1c__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Informationen zum Testauftrag. Sie finden erweiterte Testdetails in der Tabelle „generierte Tests" \[sn_atf_tg_generated_test\]. { "testsFailed": Number, "testsInProgress": Number, "testsPending": Number, "testsSkipped": Number, "testsSucceeded": Number } |
| TestsFehlgeschlagen | Die Anzahl der generierten fehlgeschlagenen Tests. Die Fehlergründe sind in der Tabelle „generierte Tests" \[sn_atf_tg_generated_test\] aufgeführt. Datentyp: Zahl |
| Testsin Bearbeitung | Die Anzahl der erstellten Anwendungsfälle. Datentyp: Zahl |
| Tests ausstehend | Die Anzahl der noch zu generierenden Anwendungsfälle. Datentyp: Zahl |
| TestsÜbersprungen | Die Anzahl der Tests, die aufgrund des Abbruchs des Auftrags übersprungen wurden. Datentyp: Zahl |
| Tests erfolgreich | Die Anzahl der erfolgreich generierten Tests. Datentyp: Zahl |
[Tabelle : 4. Rückgaben]

{#cr-TestGen-progress_S__table_fpx_lv4_g1c}  
Das folgende Beispiel zeigt, wie Sie mit der Generierung von Tests für die Incident-Tabelle beginnen, den Fortschritt abrufen und die Testgenerierung abbrechen. Verwenden Sie im globalen Bereich den Namespace 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});

Ausgabe:

    {
      "testsSucceeded": 4,
      "testsFailed": 2,
      "testsPending": 2,
      "testsInProgress": 8,
      "testsSkipped": 0
    }

## TestGenerationApi -- startJob(Zeichenfolge tableEncodedQuery, Zeichenfolge userEncodedQuery, Zeichenfolge katalogEncodedQuery, Zahl maxTestCount, Zahl maxTestCountPerTable, Zahl maxTestCountPerItem, Zeichenfolge-E-Mail) {#ariaid-title4}

Fügt einen Datensatz in die Tabelle „Browserorchestration-Warteschlange" (BOQ) \[sn_atf_tg_sn_boq\] ein, um einen Testauftrag zu starten.
{#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}

| Name | Typ | Beschreibung |
|-|-|-|
| CatalogEncodedQuery | Zeichenfolge | Optional. Codierte Abfrage, die die Katalogelemente (CIs) angibt, für die Tests generiert werden sollen. Standard: Alle CIs (leere Zeichenfolge) |
| E-Mail | Zeichenfolge | Optional. E-Mail-Adresse, an die eine Benachrichtigung gesendet werden soll, wenn die Testgenerierung abgeschlossen ist. Standard: Keine E-Mail (leere Zeichenfolge) |
| Max. Testanzahl | Nummer | Optional. Maximale Anzahl von Tests, die generiert werden sollen. Mögliche Werte: 1-9999 Standard: 9999 (Höchstwert) |
| MaxTestCountPerTable | Nummer | Optional. Maximale Anzahl von Tests, die pro Tabelle generiert werden sollen. Mögliche Werte: 1-10 Standard: 10 (Höchstwert) |
| MaxTestCountPerItem | Nummer | Optional. Maximale Anzahl von Tests, die pro CI generiert werden sollen. Mögliche Werte: 1-10 Standard: 10 (Höchstwert) |
| SeparateUpdateSetPerScope | Boolean | Optional. Kennzeichnung, die angibt, ob generierte Tests in die jeweiligen Suites, Update-Sätze und Umfänge getrennt oder Tests in einer Suite, einem Update-Satz und einem Umfang platziert werden sollen. Gültige Werte: * Wahr: Tests werden entsprechend dem Umfang der einzelnen Tabellen oder Katalogelemente in ihrer jeweiligen Suite und in ihrem Update-Satz platziert. * Falsch: Alle generierten Tests werden in derselben Suite, demselben Update-Satz und demselben Umfang platziert. Wenn „falsch", scopeForGeneratingTestsIst in der Anforderung erforderlich. {#cr-TestGen-startJob_S_S_S_N_N_N_S__ul_l4b_qfj_y1c} Standard: Wahr |
| GeltungsbereichForGenerierungTests | Zeichenfolge | Erforderlich, wenn separateUpdateSetPerScopeIst auf „falsch" festgelegt. SYS_ID des Bereichs, in dem alle generierten Tests platziert werden sollen. Standard: Keine sys_ID (leere Zeichenfolge) |
| TableEncodedQuery | Zeichenfolge | Optional. Codierte Abfrage, die die Tabellen angibt, für die Tests generiert werden sollen. Weitere Informationen finden Sie unter [Encoded query strings](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US). Standard: Alle Tabellen (leere Zeichenfolge) |
| UserEncodedQuery | Zeichenfolge | Optional. Codierte Abfrage, die die Anwender angibt, für die Tests generiert werden sollen. Standard: Alle Anwender (leere Zeichenfolge) |
[Tabelle : 5. Parameter]

{#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}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Die sys_ID des BOQ-Datensatzes in der Tabelle „Browserorchestration-Warteschlange \[sn_atf_tg_sn_boq\]". |
[Tabelle : 6. Rückgaben]

{#cr-TestGen-startJob_S_S_S_N_N_N_S__table_fpx_lv4_g1c}  
Das folgende Beispiel zeigt, wie Sie mit der Generierung von Tests für die Incident-Tabelle beginnen. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg.

    var insertedSnboqId = CloudRunnerAPI.TestGenerationAPI.startJob({
      tableEncodedQuery: "nameISincident",
      catalogEncodedQuery: "sysIdISEMPTY",
      maxTestCount: 10
    });

    gs.info(insertedSnboqId);

Ausgabe:

    <sys_id of inserted BOQ record>


