Skip to content

Commit

Permalink
Merge branch 'Jerome-main-patch-39107' into 'main'
Browse files Browse the repository at this point in the history
Upload screenshots to be used in docs

See merge request documentation/uilicious-docs-v3!37
  • Loading branch information
Tai Shi Ling committed Feb 20, 2024
2 parents de69fe0 + f3c01a5 commit df83390
Show file tree
Hide file tree
Showing 31 changed files with 53 additions and 86 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 8 additions & 8 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@
* [Schedule a test using Jobs](how-to-guides/run-test/schedule-a-job.md)
* [Run a test using the CLI](how-to-guides/run-test/run-test-using-cli.md)
* [Connect to Webdriver Grid](how-to-guides/run-test/connect-to-webdriver-grid.md)
* Setting up jobs
* [Schedule a Job](how-to-guides/Setting-up-jobs/schedule-a-job.md)
* [Setup Notifications](how-to-guides/Setting-up-jobs/set-up-notifications.md)
* [Set up Email Notifications](how-to-guides/Setting-up-jobs/set-up-email-notifications.md)
* [Set up Discord Notifications](how-to-guides/Setting-up-jobs/set-up-discord-notifications.md)
* [Set up Telegram Notifications](how-to-guides/Setting-up-jobs/set-up-telegram-notifications.md)
* [Set up Slack Notifications](how-to-guides/Setting-up-jobs/set-up-slack-notifications.md)
* [Set up Microsoft Teams Notifications](how-to-guides/Setting-up-jobs/set-up-microsoft-teams-notifications.md)
* Scheduling tests using Jobs
* [Setting up a job](how-to-guides/Setting-up-jobs/schedule-a-job.md)
* Notifications
* [Email](how-to-guides/Setting-up-jobs/set-up-email-notifications.md)
* [Discord](how-to-guides/Setting-up-jobs/set-up-discord-notifications.md)x
* [Telegram](how-to-guides/Setting-up-jobs/set-up-telegram-notifications.md)
* [Slack](how-to-guides/Setting-up-jobs/set-up-slack-notifications.md)
* [Microsoft Teams](how-to-guides/Setting-up-jobs/set-up-microsoft-teams-notifications.md)
* Integrations
* Github
* [Saving project to Github](how-to-guides/github/saving-projects-to-github.md)
Expand Down
123 changes: 45 additions & 78 deletions how-to-guides/Setting-up-jobs/schedule-a-job.md
Original file line number Diff line number Diff line change
@@ -1,125 +1,92 @@
---
description: This section shows you how to schedule a job, delete a job, or disable a job.
description: This guide shows you how to schedule tests and setup error notifications using Jobs.
---

# Schedule a Job
# Schedule tests using jobs

## Introduction
In this article, we'll cover how to create jobs to schedule test runs and setup notifications.

Monitoring is creating a job to automatically run tests on a scheduled basis. You can schedule your tests to run at set intervals or at specific times.
[[toc]]

There are two main ways to schedule automated test jobs in UIlicious: the UIlicious editor or the monitoring panel of the UIlicious editor. The Monitoring panel displays all scheduled jobs in one place.
## What is a Job?

You can select a single test or run tests in bulk in either approach.
A job is a task that executes tests on a scheduled basis. Jobs will trigger automatically at the scheduled time, and run tests in the background, utilising the available test runners in your workspace. You can create a job that runs any number of tests. You can setup notifications when tests fail or when they complete.

There are also several options to configure in testing:
## Setting up a Job

* Dataset
* Browser Type
* Resolution
* User Agent
To start, first, select the "**Monitoring**" Tab and click "**Schedule a job**" button.

Once you have created and scheduled a job, you can configure them to send instant notifications when automated tests fail or produce an error.
![Click the "Schedule a job" button](/static/img/job-notifications/Schedule_Button_At_Monitoring.png)

In this section, we will learn how to:
Then, **enter a name** for the job.

* [Create a scheduled job ](./schedule-a-job.html#schedule-a-job)
* [Delete a job](./schedule-a-job.html#how-to-delete-a-job)
* [Disable a job](./schedule-a-job.html#how-to-disable-a-job)
* [Check Job Status](./schedule-a-job.html#view-status-of-a-job)
![Enter a name for the job](/static/img/job-notifications/jobs-enter-name.png)

If you are interested in setting up notifications to receive status updates about your scheduled job, check out our [How to Set Up Notifications](./set-up-notifications.html) section.
Now, **select the tests** that you want to run as part of this job.

### Using the Editor
![Select tests to run](/static/img/job-notifications/jobs-select-test.png)

In the editor, click the **Schedule** button.
Then, **choose the browsers, resolution, dataset, region, and user agent** for running the tests. You may select more than one browser, and the job will run each test with each selected browser.

![The blue Schedule button in the editor allows you to schedule a job for your current test script.](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649282897/UI-licious:%20Monitoring/scheduleaJob-1\_vcknh8.png)
![Configure test run settings](/static/img/job-notifications/Job_Configuration.png)

### Using the Monitoring Panel
Finally, **configure the schedule** for running the job.

In the **Editor** panel, select the **Monitoring** pane at the top. 
![Select the days you want to run the job](/static/img/job-notifications/Job_Schedule.png)

In **Monitoring**, you can view your complete list of jobs.
![Select the times you want to run the job](/static/img/job-notifications/jobs-schedule-time.png)

![The blue Schedule a New Job button allows you to schedule a new job for your test scripts](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649282897/UI-licious:%20Monitoring/scheduleaJob-2\_klnawl.png)
Optionally, you can **setup notifications** on the test outcomes. You can select whether you want notifications for all test outcomes `When: "Always"` or only when tests fails `When: "Error"`. You can setup **email notifications** and **notifications for chat applications** such as [Slack](./set-up-slack-notifications.md), [Teams](./set-up-microsoft-teams-notifications.md), [Telegram](./set-up-telegram-notifications.md), [Discord](./set-up-discord-notifications.md) using **webhooks**.

### Schedule a Job <a href="#schedule-a-job" id="schedule-a-job"></a>
![](/static/img/job-notifications/Job_Email_Notification.png)

Under **General**, name your scheduled job.
Once you save the job, you can view its status from the **Monitoring** View, and click on the name of the job to view its past runs and manage the job.

![Enter your Job Name in the input box.](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649285376/UI-licious:%20Monitoring/scheduleaJob-3\_cgrw23.gif)
![](/static/img/job-notifications/jobs-monitoring-page-highlight-job.png)

Select either a single test or multiple tests.
## The Monitoring View

![Select a single test or choose multiple tests for your scheduled job](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649285820/UI-licious:%20Monitoring/scheduleaJob-4\_loimqh.gif)
The Monitoring View shows you a summary of all jobs and their most recent status.

Region and User-Agent only work in Chrome and Firefox browsers.
![](/static/img/job-notifications/jobs-monitoring-page-overview.png)

Select the desired Dataset, Browser, Resolution, Region, and User-Agent for your scheduled job.
You can also select multiple jobs to bulk edit their run settings, schedule, and notifications.

![UI-licious allows you to add in datasets and select which browsers and resolution sizes to test in. Choose the region you would also like to test in.](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649286615/UI-licious:%20Monitoring/scheduleaJob-5\_gvvzuu.gif)
![](/static/img/job-notifications/jobs-bulk-edit.png)

Under **Schedule**, select when and how often you want the job to repeat.
## Viewing Past Runs

You can make your jobs run daily or weekly.
You may view past runs for a job by **clicking on the name of the job** from the Monitoring View.

You can also choose to schedule your job to run once a day or at regular intervals (ex. every six hours).
![Click on the name of the job to view its past runs and manage the job](/static/img/job-notifications/jobs-click-job-name.png)

![UI-licious allows you to schedule your jobs daily or weekly.](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649286864/UI-licious:%20Monitoring/ScheduleaJob-6\_df88hs.gif)
The past runs page will show a summary of past test runs, indicating number of passing and failing tests by the browsers.

### How to Delete a Job <a href="#how-to-delete-a-job" id="how-to-delete-a-job"></a>
![](/static/img/job-notifications/jobs-past-runs-page-for-suite-of-tests.png)

**WARNING**:\
\
You will no longer be able to see historical reports if you delete a job.&#x20;
Click on "**View Report**" to view the full report of a run, which will show the result of each individual test.

Deleted jobs and reports cannot be recovered.
![](/static/img/job-notifications/jobs-run-report-for-suite-of-test.png)

To view all scheduled jobs, go to the **Monitoring** pane.
You can view the Test Run Report for an single test run by clicking on its status.

Scroll down to the scheduled job you would like to delete.
![Click on the status of a test run to view its report](/static/img/job-notifications/jobs__test-suite-run-report__click-to-view-report.png)

Click the **three dots (...)** next to the blue **Run** button, and select **Delete**.
![Full step-by-step report of a test run, with screenshots](/static/img/job-notifications/jobs__single-test-run-report.png)

![Click the Delete button next to a scheduled job to delete the job.](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649287592/UI-licious:%20Monitoring/ScheduleaJob-7\_cvelit.png)

Then, click the red **Delete** button.
## Disable / Enable a job

![alt\_text](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649288445/UI-licious:%20Monitoring/scheduleaJob-8\_ti25kf.gif)
You may disable a job to stop it from running at schedule times temporarily. This may be useful when you expect test failures due to changes in the application and want to pause the job while the test script is being updated. To disable a job, click the "..." button to show more actions and click "Disable" to disable the job.

Confirm you have deleted the selected job.
![Pause a job by disabling it](/static/img/job-notifications/Job_Disable_Button.png)

### How to Disable a Job <a href="#how-to-disable-a-job" id="how-to-disable-a-job"></a>
## Delete a job

**Good to know:**\
\
Once a job is disabled, the user can still access reports.
To delete a job, click the "..." button to show more actions, and click "**Delete**".

To view all scheduled jobs, go to the **Monitoring** pane.
![Delete a job](/static/img/job-notifications/Job_Delete_Button.png)

Scheduled jobs are enabled by default.
Once the job is deleted, you will no longer be able to access the past runs page for this job and view the aggregated run reports. To view past runs for this job, you will need to go to the "Runs" view and search for the individual test run reports.

Scroll down to the scheduled job you would like to disable.

Click on the **three dots (...)** next to the blue **Run** button, and select **Disable**.

Then, click the red **Disable** button.

![Click the red Disable button to disable a scheduled job.](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649288526/UI-licious:%20Monitoring/scheduleaJob-9a\_hdmsji.gif)

Confirm there is a **Scheduled test run is a disabled** label.

![A black Scheduled test run is disabled label should appear after disabling a job.](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649288248/UI-licious:%20Monitoring/ScheduleaJob-10\_sxejyh.png)

### View Status of a Job <a href="#view-status-of-a-job" id="view-status-of-a-job"></a>

A **status** tells the current state of your scheduled job in UIlicious.

Under **Status**, click the dropdown menu to reveal more options.

![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649781432/UI-licious:%20Monitoring/ScheduleaJob11.png)

### Set Up Notifications

If you are interested in learning more about setting up your notifications (whether it be email or an application of your choice), view our [How to Set Up Notifications](./set-up-notifications.html) section.
Note that this is a permanent and irreversible action. If you wish to pause a job instead, we suggest disabling the job instead.

0 comments on commit df83390

Please sign in to comment.