> For the complete documentation index, see [llms.txt](https://docs.meta-inf.hu/pipeline-forms/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.meta-inf.hu/pipeline-forms/user-guides/user-guide/run-pipelines/schedule-a-form.md).

# Schedule a Form

## Schedule a Form

To Schedule a form, follow the steps described described here:

{% content-ref url="/pages/ytmg6K0gCHQ8vDF1ONW3" %}
[Manual execution](/pipeline-forms/user-guides/user-guide/run-pipelines/manual-execution.md)
{% endcontent-ref %}

When Form input fields are filled, **Schedule** is the second option besides **Run Pipeline.**

<figure><img src="https://2614715257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR41wZlyQDaFKYgHnadh%2Fuploads%2FBkkc6xKUSkT9GGoIvLZ8%2Fimage.png?alt=media&amp;token=92cd5ade-bc9c-4ece-8719-0b80b47d1171" alt=""><figcaption><p>Scheduling a form</p></figcaption></figure>

A **New schedule** popup will prompt for the following details:

* **Name** - give a name that describes the behaviour. This will be used in the schedule list
* **Use latest commit on branch** - as you selected a specific commit it is important&#x20;
* that you decide whether the scheduler should use it or use the latest commit on the branch instead
* **Occurrence** - you can set up the regularity of the schedule: Hourly, Daily, Weekly

<figure><img src="https://2614715257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR41wZlyQDaFKYgHnadh%2Fuploads%2FAy1vr95ZWpfF4ioIPHMR%2Fimage.png?alt=media&amp;token=98b6202f-93ef-488e-9369-57aa4dba16c9" alt=""><figcaption><p>New schedule dialog</p></figcaption></figure>

### Occurrence

#### **Hourly**

Hourly Occurrence will run every hour, 24 times a day.

#### Daily

When Daily Occurrence **is** selected, you can select a

* &#x20;one-hour interval, when the schedule will be executed every day of the week

<figure><img src="https://2614715257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR41wZlyQDaFKYgHnadh%2Fuploads%2FAZJIw5RFTxKRgIXMbzyQ%2Fimage.png?alt=media&amp;token=29089386-cc23-4a71-b8aa-cec837390998" alt=""><figcaption><p>Daily occurrence</p></figcaption></figure>

#### Weekly

When Weekly Occurrence is selected, you can select a

* one hour interval
* Days of the week, when the execution will be executed every week

<figure><img src="https://2614715257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR41wZlyQDaFKYgHnadh%2Fuploads%2FGLNcopwHu574onc68jyi%2Fimage.png?alt=media&amp;token=af45d9fb-b297-4485-aadd-ef2b805701b3" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Note that the selected hour range is in your time zone, while the execution is calculated in UTC.
{% endhint %}

When a schedule is set, it will be automatically added to the schedule list and will be enabled (Active) by default.

<figure><img src="https://2614715257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR41wZlyQDaFKYgHnadh%2Fuploads%2FSJSF0II2jcyLDdLKbEFG%2Fimage.png?alt=media&amp;token=d1512fe3-8f8e-4107-b96a-408b848ae7d1" alt=""><figcaption><p>Schedule List</p></figcaption></figure>

When occurrence hits next time, your pipeline will be automatically executed, with your form data! :tada:

Scheduling a form will add a new entry in the Audit logs with the name: **Create schedule**.

{% hint style="success" %}
Every scheduled execution with Forms will add a record to the Execution logs.
{% endhint %}

## Manage Scheduled Forms

When a pipeline execution is scheduled, various actions can be performed on it.

{% hint style="success" %}
Every operation related to managing a Scheduled Form is visible in the Audit logs.
{% endhint %}

### Preview schedule

Clicking on the entry in the Schedule List results in a popup with the details of the schedule. This is useful when you want to check the scheduled pipeline details.&#x20;

<figure><img src="https://2614715257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR41wZlyQDaFKYgHnadh%2Fuploads%2FIcmr30aZc7LhG5GvvexS%2Fimage.png?alt=media&amp;token=7087faee-e8a4-4008-ac6e-921ae8c83c0d" alt=""><figcaption><p>Preview of a scheduled pipeline</p></figcaption></figure>

The following details are displayed:

* **Name** - the name of the schedule
* **Occurrence** - occurrence type with specific details and hour range
* Selected **Branch**, **Pipeline**, **Form** (which might be deleted since, because it is version controlled)
* Selected **commit** - combined if always the latest is selected
* **Variables** entered - key-value pairs, where the key is the actual key from the Form
* **Created** and **Edited dates**&#x20;

{% hint style="success" %}
This view respects hidden fields, so passwords won't be visible here.
{% endhint %}

### Deactivate schedule

By turning the **Active** toggle off, the schedule will be deactivated.

<figure><img src="https://2614715257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR41wZlyQDaFKYgHnadh%2Fuploads%2Fp6jBgY7WY0VqGhoTAk5r%2Fimage.png?alt=media&amp;token=57325cdd-bfc3-4aa0-ac69-6cb3e11b1389" alt=""><figcaption><p>Turn a schedule on and off </p></figcaption></figure>

By pressing the toggle again, the schedule will be activated again :relaxed:

### Edit schedule

Before getting started with editing, it is important to understand the intention of the Edit feature, and the general behaviour of version control. When you schedule a form, it will be created as a standalone schedule with some extra variables and a set occurrence. The form itself might be deleted or drastically changed right after. So the edit feature won't include the form itself, only raw data which is stored after using a Form.

Due to this, we recommend that you consider editing a schedule for minor changes only, such as changes in variables or the schedule to avoid duplicate scheduling. For major changes, it might be a good idea to start over with scheduling a Form.

{% hint style="danger" %}
As every user can edit a schedule, this operation requires careful consideration in terms of bypassing Form constraints like a regular expression, the select fields's preset values or field types. Each stored variable can be edited separately.&#x20;

Feel free to share your feedback about this feature by contacting us through our support channels.
{% endhint %}

To edit a schedule, press the pencil in the Actions menu:

<figure><img src="https://2614715257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR41wZlyQDaFKYgHnadh%2Fuploads%2FAK84ClaVxB8eiThIvXHz%2Fimage.png?alt=media&amp;token=8df25d94-78cb-4093-a52e-13643527e8a8" alt=""><figcaption><p>Editing a scheduled pipeline</p></figcaption></figure>

{% hint style="success" %}
This view respects hidden fields as well, so passwords are not visible, but editable here.
{% endhint %}

### Delete schedule

Deletion should be the last operation you want to use. It is suggested to deactivate a schedule first, since it is reversible, while deletion is not.

To delete a schedule, press the trash icon in the Action menu:

<figure><img src="https://2614715257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR41wZlyQDaFKYgHnadh%2Fuploads%2FqqqslNMlIDSiJWetMzv2%2Fimage.png?alt=media&amp;token=12edb192-1eba-42bf-b636-1b459fce8f22" alt=""><figcaption><p>Delete a scheduled pipeline</p></figcaption></figure>

Confirm deletion, and the scheduled pipeline will be gone forever :wave:.
