Skip to content

Commit 8fd01a2

Browse files
authored
Update the schedules section (#443)
1 parent 75fb4c6 commit 8fd01a2

File tree

10 files changed

+20
-10
lines changed

10 files changed

+20
-10
lines changed
54.8 KB
Binary file not shown.
10.9 KB
Loading
12.9 KB
Binary file not shown.
2.48 KB
Loading
3.96 KB
Binary file not shown.
10.5 KB
Loading
11.1 KB
Binary file not shown.
35.3 KB
Loading
34 KB
Binary file not shown.

content/docs/schedules.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,29 +40,31 @@ If you are planning to schedule an actor run, you need to use the actor before y
4040

4141
In [Apify Console](https://console.apify.com/schedules), click on the **Schedules** button in the left-side menu, then click the **Create new** button.
4242

43-
In the **Settings** tab, give your schedule a memorable name, add a description, and choose how often you would like your actor or task to run using the **Cron expression** field.
43+
In the **Settings** tab, give your schedule a memorable name, add a description, and choose how often you would like your actor or task to run using the [schedule setup tool](#schedule-setup).
4444

4545
![New schedule]({{@asset images/schedule-settings.webp}})
4646

47-
Next, you'll need to give the schedule something to run. This is where the actor or task you prepared earlier comes in. Switch to the **Actors** or **Tasks** tab, as appropriate, and click the **Add actor/task button**.
47+
Next, you'll need to give the schedule something to run. This is where the actor or task you prepared earlier comes in. Switch to the **Actors and Tasks** tab, and click the **Add [new]** button.
4848

4949
If you're scheduling an actor run, you'll be able to specify the actor's [input]({{@link actors/running/input.md}}) and running options like
50-
[**build**]({{@link actors/development/builds.md}}),
51-
**timeout**,
52-
[**memory**]({{@link actors/running/memory_and_cpu.md}}).
50+
[build]({{@link actors/development/builds.md}}),
51+
timeout,
52+
[memory]({{@link actors/running/memory_and_cpu.md}}).
5353
The **timeout** value is specified in seconds; a value of **0** means there is no timeout and the actor runs until it finishes.
5454

55+
If you don't provide an input, then the actor's default input is used. If you provide an input with some fields missing, the missing fields are filled in with values from the default input. If input options are not provided, the default options values are used.
56+
5557
![Add actor to schedule]({{@asset images/schedule-actor-run.webp}})
5658

57-
If you're scheduling a task, just select the task you prepared earlier from the **Task** dropdown. If you need to override the task's input, you can pass it as a JSON object in the **Input JSON overrides** field.
59+
If you're scheduling a task, just select the task you prepared earlier using the drop-down. If you need to override the task's input, you can pass it as a JSON object in the **Input JSON overrides** field.
5860

5961
![Add task to schedule]({{@asset images/schedule-add-tasks.webp}})
6062

6163
To add more actors or tasks, just repeat the process.
6264

6365
> You can add a maximum of 10 actors and 10 tasks to each schedule.
6466
65-
Now, all you need to do is click **Save** and wait for your scheduled actors/tasks to run and return your data.
67+
Now, all you need to do is click **Save & activate** and let the scheduler take care of running your jobs on time.
6668

6769
For integrations, you can also add a [webhook](https://docs.apify.com/webhooks) to your tasks, which will notify you (or perform an action of your choice) every time the task runs.
6870

@@ -103,9 +105,19 @@ You can add multiple actor and task runs to a schedule with a single POST reques
103105

104106
For more information, see the [schedules section](https://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule) in the API documentation.
105107

108+
## Schedule setup
109+
110+
The schedule setup tool uses [cron expressions](https://en.wikipedia.org/wiki/Cron#CRON_expression) to specify run times. If you're familiar with how to use them and need a specific run schedule, you can dive right in. If not, don't worry - the setup tool has a visual custom schedule builder that provides a similar level of control as cron expressions, though it's not quite as powerful.
111+
112+
![Schedule setup tool]({{@asset images/schedule-setup.webp}})
113+
114+
The **Next runs** section at the bottom shows when the next five runs will be. You can use this live feedback to experiment until you find the correct configuration.
115+
116+
You can find more information and examples of cron expressions on [crontab.guru](http://crontab.guru/). For additional and non-standard characters, see [this](https://en.wikipedia.org/wiki/Cron#CRON_expression) Wikipedia article.
117+
106118
## Cron expressions
107119

108-
Schedules use [cron expressions](https://en.wikipedia.org/wiki/Cron#CRON_expression) to specify run times. A cron expression has the following structure:
120+
A cron expression has the following structure:
109121

110122
| Position | Field | Values | Wildcards | Optional |
111123
|----------|--------------|--------------------------------|-----------|----------|
@@ -135,8 +147,6 @@ Additionally, you can use the following shortcut expressions:
135147
- `@daily` = `0 0 * * *` - run once a day, at midnight.
136148
- `@hourly` = `0 * * * *` - on the hour, every hour.
137149

138-
You can find more information and examples of cron expressions on [crontab.guru](http://crontab.guru/). For additional and non-standard characters, see [this](https://en.wikipedia.org/wiki/Cron#CRON_expression) Wikipedia article.
139-
140150
## Sharing
141151

142152
You can invite other Apify users to view or modify your schedules using the [access rights]({{@link access_rights.md}}) system. See the [full list of permissions]({{@link access_rights/list_of_permissions.md#schedules}}).

0 commit comments

Comments
 (0)