--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/api-reference Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-API-Referenz ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Cloud Runner TestUserApi -- Bereichsbezogen, Global # Cloud Runner TestUserApi -- Bereichsbezogen, Global {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 Minuten Lesedauer Verwaltet Testanwenderaufträge, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen. Diese API ist Teil der CloudRunnerApi-Skripteinbindung. Sie können diese API für die folgenden Aufgaben verwenden: * Starten Sie den Anwendertestauftrag. * Legen Sie den Cloud-Anwender fest. * Überprüfen Sie, ob der angegebene Anwender gültig ist. * Überprüft den Fortschritt des Anwendertestauftrags. * Brechen Sie den Testauftrag ab. {#cloudrnr-TestUserAPI-scoped__cloudrnr-TestUserAPI-scoped_ul_vwb_wvn_31c} Im globalen Bereich wird diese API innerhalb des Namespace sn_atf_tg ausgeführt. Sie müssen das Plugin [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) aktivieren, um diese API verwenden zu können. Siehe auch: * [Cloud Runner TestGenerationApi -- Bereichsbezogen, Global](https://servicenow-prod.fluidtopics.net/SO3H_yflqAlcG2QIMoqY0w#cloudrnr-TestGenerationAPI-scoped "Verwaltet die Testauftragsgenerierung, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden soll. Diese API ist Teil der CloudRunnerApi-Skripteinbindung.") * [Cloud Runner TestRunnerApi -- Bereichsbezogen, Global](https://servicenow-prod.fluidtopics.net/1NP46AtE~kQ9Cyr3dKTIPQ#cloudrnr-TestRunnerAPI-scoped "Verwaltet Tests, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen. Diese API ist Teil der CloudRunnerApi-Skripteinbindung.") * [Cloud Runner Test Runner REST API](https://servicenow-prod.fluidtopics.net/uN~3Ra5trrz8am56gF57nw#cloudrunner-testrunner-api "Verwaltet Tests, die in einem Cloud Runner für Automated Test Framework (ATF) ausgeführt werden sollen.") {#cloudrnr-TestUserAPI-scoped__ul_gd4_zsn_31c} ## TestUserApi -- cancelJob(String snboqId) {#ariaid-title2} Legt den Status des Testanwenderauftrags in der Tabelle der Browser-Orchestrationswarteschlange \[sn_atf_tg_sn_boq\] auf „Abgeschlossen" fest. {#cr-TestUserAPI-cancelJob_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-cancelJob_S__cr-snboqId-ph-desc} | Name | Typ | Beschreibung | |-|-|-| | snboqId | Zeichenfolge | Erforderlich. Die sys_id des BOQ-Datensatzes in der Tabelle „Browser-Orchestrationswarteschlange" \[sn_atf_tg_sn_boq\]. | [Tabelle : 1. Parameter] {#cr-TestUserAPI-cancelJob_S__table_epx_lv4_g1c} {#cr-TestUserAPI-cancelJob_S__table_fpx_lv4_g1c__entry__2} | Typ | Beschreibung | |-|-| | Null | NULL bei Erfolg, andernfalls Fehlermeldung. | | Fehler | Falls nicht erfolgreich, mögliche Fehlermeldungen: * Keine BOQ-ID übergeben -- Das angegebene JSON-Objekt hat keinen BOQ-ID-Eintrag. Vergewissern Sie sich, dass das JSON-Objekt wie folgt strukturiert ist: `{snboqId: "`\ "} . * Ungültige BOQ-sys_id übergeben: Die angegebene ID muss für einen BOQ-Datensatz in der Tabelle „Browser-Orchestrationswarteschlange" \[sn_atf_tg_sn_boq\] gelten. {#cr-TestUserAPI-cancelJob_S__ul_wqr_slb_j1c} | [Tabelle : 2. Ausgabe] {#cr-TestUserAPI-cancelJob_S__table_fpx_lv4_g1c} Das folgende Beispiel zeigt, wie Sie einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der gesperrte Benutzer als gültiger Cloud-Benutzer bestätigt wurde, legt der Code den Cloud-Benutzer als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg. var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"}); gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId}))); CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId}); gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: })); CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"}); Ausgabe: {progress: 64, state: running} User is missing the following criteria: User is locked out False ## TestUserApi -- isValidCloudUser(String username) {#ariaid-title3} Überprüft, ob ein angegebener Anwender ein gültiger Cloud-Anwender ist. {#cr-TestUserAPI-isValidCloudUser_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-isValidCloudUser_S__cr-userNm-ph-desc} | Name | Typ | Beschreibung | |-|-|-| | username | Objekt | Erforderlich. Anwender-ID eines gültigen Anwenders, der in der Tabelle „Anwender" \[sys_user\] aufgeführt ist. Dieser Wert wird als Zeichenfolge in einem JSON-Objekt bereitgestellt. Beispiel: `{username: "abel.tuter"}`. | [Tabelle : 3. Parameter] {#cr-TestUserAPI-isValidCloudUser_S__table_epx_lv4_g1c} {#cr-TestUserAPI-isValidCloudUser_S__table_fpx_lv4_g1c__entry__2} | Typ | Beschreibung | |-|-| | Boolean | Kennzeichnung, die angibt, ob der angegebene Anwender ein gültiger Cloud-Anwender ist. Gültige Werte: * „wahr": Der angegebene Anwender ist ein gültiger Cloud-Anwender. * „falsch": Der angegebene Anwender ist aus einem oder mehreren der folgenden Gründe ungültig: * Der Anwender wurde nicht gefunden. * Der Anwender ist inaktiv. * Der Anwender ist ausgesperrt. * Der Anwender benötigt eine Passwortzurücksetzung. * Der Anwender hat keine Administratorrolle. * Der Benutzer hat schreibgeschützten Zugriff. * Der Benutzer hat nur Zugriff auf Webservices. {#cr-TestUserAPI-isValidCloudUser_S__ul_gzz_dcg_m1c} {#cr-TestUserAPI-isValidCloudUser_S__ul_ofc_wzf_m1c} | [Tabelle : 4. Ausgabe] {#cr-TestUserAPI-isValidCloudUser_S__table_fpx_lv4_g1c} Das folgende Beispiel zeigt, wie Sie einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der gesperrte Benutzer als gültiger Cloud-Benutzer bestätigt wurde, legt der Code den Cloud-Benutzer als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg. var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"}); gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId}))); CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId}); gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: })); CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"}); Ausgabe: {progress: 64, state: running} User is missing the following criteria: User is locked out False ## TestUserApi -- Progress(String snboqId) {#ariaid-title4} Stellt den Status jedes Anwendertests für einen angegebenen BOQ-Datensatz (Browser Orchestration Queue) bereit. {#cr-TestUserAPI-progress_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-progress_S__cr-snboqId-ph-desc} | Name | Typ | Beschreibung | |-|-|-| | snboqId | Zeichenfolge | Erforderlich. Die sys_id des BOQ-Datensatzes in der Tabelle „Browser-Orchestrationswarteschlange" \[sn_atf_tg_sn_boq\]. | [Tabelle : 5. Parameter] {#cr-TestUserAPI-progress_S__table_epx_lv4_g1c} {#cr-TestUserAPI-progress_S__table_fpx_lv4_g1c__entry__2}{#cr-TestUserAPI-progress_S__cr-prog-state-ph-desc} | Typ | Beschreibung | |-|-| | Objekt | JSON-Objekt, das den Testfortschritt angibt. { "progress": Number, "state": "String" } | | Object.progress | Gibt den abgeschlossenen Prozentsatz des Testfortschritts an. Typ: Nummer | | Objekt.status | Status des BOQ-Datensatzes. Mögliche Werte: * Ausstehend: Die angeforderte Testaktivität wurde erstellt und wartet auf die Ausführung.{#cr-TestUserAPI-progress_S__cr-prog-state-li-pending} {#cr-TestUserAPI-progress_S__cr-prog-state-li-pending} * Wird verarbeitet -- Die Instanz scannt Datensätze, um sicherzustellen, dass die Ausführungstracker für Cloud Runner markiert sind, bevor die Anforderung an die Cloud-Infrastruktur gesendet wird. * Browser angefordert: An die Cloud-Infrastruktur wurde eine Anforderung zum Starten von Browsern für die Testgenerierung oder den Testlauf gesendet.{#cr-TestUserAPI-progress_S__cr-prog-state-li-brsreq} {#cr-TestUserAPI-progress_S__cr-prog-state-li-brsreq} * Wird ausgeführt -- Cloud-Infrastrukturbrowser suchen ausstehende Tests und führen sie aus. * Abgeschlossen: Die Testaufgabe ist abgeschlossen.{#cr-TestUserAPI-progress_S__cr-prog-state-li-complete} {#cr-TestUserAPI-progress_S__cr-prog-state-li-complete} * Status „Fehlgeschlagen" -- Die Testaufgabe ist fehlgeschlagen.{#cr-TestUserAPI-progress_S__cr-prog-state-li-failed} {#cr-TestUserAPI-progress_S__cr-prog-state-li-failed} {#cr-TestUserAPI-progress_S__ul_rvl_vsg_l1c} Typ: Zeichenfolge | | Fehler | Falls nicht erfolgreich, mögliche Fehlermeldungen: * Keine BOQ-ID übergeben -- Das angegebene JSON-Objekt hat keinen BOQ-ID-Eintrag. Vergewissern Sie sich, dass das JSON-Objekt wie folgt strukturiert ist: `{snboqId: "`\ "} . * Ungültige BOQ-sys_id übergeben: Die angegebene ID muss für einen BOQ-Datensatz in der Tabelle „Browser-Orchestrationswarteschlange" \[sn_atf_tg_sn_boq\] gelten. {#cr-TestUserAPI-progress_S__ul_wqr_slb_j1c} | [Tabelle : 6. Ausgabe] {#cr-TestUserAPI-progress_S__table_fpx_lv4_g1c} Das folgende Beispiel zeigt, wie Sie einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der gesperrte Benutzer als gültiger Cloud-Benutzer bestätigt wurde, legt der Code den Cloud-Benutzer als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg. var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"}); gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId}))); CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId}); gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: })); CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"}); Ausgabe: {progress: 64, state: running} User is missing the following criteria: User is locked out False ## TestUserApi -- auswählenCloudUser(String username) {#ariaid-title5} Startet einen End-to-End-Testanwenderauftrag in Cloud Runner. Wenn sich der Benutzer mit der Administratorrolle ordnungsgemäß anmelden kann, wird die Cloud-Benutzereigenschaft für zukünftige Testläufe und Testgenerierungen in der Cloud Runner-Infrastruktur auf diesen Benutzer festgelegt. {#cr-TestUserAPI-selectCloudUser_S__table_epx_lv4_g1c__entry__3}{#cr-TestUserAPI-selectCloudUser_S__cr-userNm-ph-desc} | Name | Typ | Beschreibung | |-|-|-| | username | Objekt | Erforderlich. Anwender-ID eines gültigen Anwenders, der in der Tabelle „Anwender" \[sys_user\] aufgeführt ist. Dieser Wert wird als Zeichenfolge in einem JSON-Objekt bereitgestellt. Beispiel: `{username: "abel.tuter"}`. | [Tabelle : 7. Parameter] {#cr-TestUserAPI-selectCloudUser_S__table_epx_lv4_g1c} {#cr-TestUserAPI-selectCloudUser_S__table_fpx_lv4_g1c__entry__2} | Typ | Beschreibung | |-|-| | NULL | NULL, wenn erfolgreich. Andernfalls Fehlermeldung. Cloud-Anwender kann nicht als ungültiger Cloud-Anwender festgelegt werden -- Dieser Fehler gibt an, dass der angegebene Anwender aus einem oder mehreren der folgenden Gründe ungültig ist: * Der Anwender wurde nicht gefunden. * Der Anwender ist inaktiv. * Der Anwender ist ausgesperrt. * Der Anwender benötigt eine Passwortzurücksetzung. * Der Anwender hat keine Administratorrolle. * Der Benutzer hat schreibgeschützten Zugriff. * Der Benutzer hat nur Zugriff auf Webservices. {#cr-TestUserAPI-selectCloudUser_S__ul_gzz_dcg_m1c} | [Tabelle : 8. Ausgabe] {#cr-TestUserAPI-selectCloudUser_S__table_fpx_lv4_g1c} Das folgende Beispiel zeigt, wie Sie einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der gesperrte Benutzer als gültiger Cloud-Benutzer bestätigt wurde, legt der Code den Cloud-Benutzer als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg. var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"}); gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId}))); CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId}); gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: })); CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"}); Ausgabe: {progress: 64, state: running} User is missing the following criteria: User is locked out False ## TestUserApi -- startJob (Zeichenfolge username) {#ariaid-title6} Startet einen End-to-End-Testanwenderauftrag in Cloud Runner. {#cr-TestUserAPI-startJob_S__table_epx_lv4_g1c__entry__3} | Name | Typ | Beschreibung | |-|-|-| | username | Zeichenfolge | Erforderlich. Anwendername von sys_user zum Testen der End-to-End-Infrastruktur von Cloud Runner. | [Tabelle : 9. Parameter] {#cr-TestUserAPI-startJob_S__table_epx_lv4_g1c} {#cr-TestUserAPI-startJob_S__table_fpx_lv4_g1c__entry__2} | Typ | Beschreibung | |-|-| | Zeichenfolge | Die sys_id des BOQ-Datensatzes in der Tabelle „Browser-Orchestrationswarteschlange" \[sn_atf_tg_sn_boq\]. | [Tabelle : 10. Ergebnisse] {#cr-TestUserAPI-startJob_S__table_fpx_lv4_g1c} Das folgende Beispiel zeigt, wie Sie einen Testbenutzer für den Administratorbenutzer starten, den Fortschritt abrufen und den Testbenutzer abbrechen. Nachdem der gesperrte Benutzer als gültiger Cloud-Benutzer bestätigt wurde, legt der Code den Cloud-Benutzer als ITIL-Administrator fest. Verwenden Sie im globalen Bereich den Namespace sn_atf_tg. var snboqId = CloudRunnerAPI.TestUserAPI.startJob({username: "abel.tuter"}); gs.info(JSON.stringify(CloudRunnerAPI.TestUserAPI.progress({snboqId: snboqId}))); CloudRunnerAPI.TestUserAPI.cancelJob({snboqId: snboqId}); gs.info(CloudRunnerAPI.TestUserAPI.isValidCloudUser({username: })); CloudRunnerAPI.TestUserAPI.selectCloudUser({username: "itil_admin"}); Ausgabe: {progress: 64, state: running} User is missing the following criteria: User is locked out False