---
title: "Scheduled Task - Scheduling and Output"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28402256/Scheduled%20Task%20-%20Scheduling%20and%20Output"
format: markdown
---
# Overview

Scheduled Tasks allow users to run a task in the background like purging or archiving data, sending customer invoices, or adding stock to requisitions lists. Scheduled tasks can be run once off, at a specific time or as a recurring schedule (Daily, Weekly, Fortnightly or Monthly).

A **Scheduled Task** window has 3 tabs:

1. The Criteria tab
2. The Schedule tab
3. The Output tab

# 1. Criteria Tab

The** Criteria tab **is used to capture the criteria for the task that needs to be performed. It contains the information needed to run the scheduled task.

The scheduled task's criteria will differ depending on the module the task was run from and if it is an import or report criteria.

> ✅ Refer to the specific processes for how to complete the **Criteria** tab or resolve any errors, for example:
> ✅ 
> ✅ [Ledger Chart Of Accounts Import ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28404036) 
> ✅ 
> ✅ [Scheduler Administration](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405088)
> ✅ 
> ✅ [Central Allocations Scheduled Task](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28383154).

# 2. Schedule Tab

<span style="color: #333333">From the </span>**Schedule**<span style="color: #333333"> tab, a user can:</span>

1. Set a **Task Description.**
2. Set who will be the owner of the task from the **Execution By** drop-down. Available options are:
  - The ID of the currently logged in user.
  - taskSched user

> ✅ Refer to the *Updating a Schedule Task Owner* section from the [Task Scheduler Queue](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28395250) article to know more about the **taskSched** user.

3. Define when to run the task as a one-off or recurrence. By default, a task is set to run immediately.
4. Select your preferred time zone from the **Time Zone** drop-down.

> ℹ️ **Note: **The time zone field defaults to run according to your server’s time zone. Frameworks automatically adjusts for changes such as daylight saving time, based on the time zone setting selected.

> ❌ Scheduling tasks for a past time is not allowed and will result in an error message.

5. **Send a notifications** to the user's Home dashboard or **send an email.**

> ℹ️ You can enter multiple usernames, separated by commas, in the **Notify** field. There are no security restrictions on which users can receive notifications, as long as they are valid and active Frameworks users .

> ✅ Refer to the [Scheduling Tasks](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402256) section for more information.

![image-20250428-024635.png](media://5701ce1a-7c6e-49ce-bee7-a603a53edf51)

## More information on Send Email

If **Send Email **is selected, additional email settings will be available to be updated. The **To** email address will default to the current user's email address.

![image](media://18b631da-fd57-4bc6-8c69-38f840136104)

> ⚠️ If a scheduled task fails, the user who ran the task will receive a notification.

# 3. Output Tab

<span style="color: #333333">The </span>**Output**<span style="color: #333333"> tab is used to view the results of the completed task (dependent on how is is scheduled).</span>

1. If the task immediately, Click on the **Generated Reports **hyperlinks
2. If the task has been scheduled run at a later time or as a part of a recurrence then the [Scheduler Administration](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405088) will contain the output.

![image](media://aad3acd5-dad4-415d-9eaa-cf7c913c26db)

 

> Macro (anchor)



---

# Scheduling tasks

The below information will explain the different schedule types.

> ℹ️ The scheduled task is defaulted to run *One Time* and is set to run at the *current system date and time*.

## Scheduling Once Only Tasks

To schedule once only tasks, perform the following:

1. From the **Frameworks menu**, access the relevant task.
2. From the **Criteria** tab (Import or Report) set the required criteria for the scheduled task.
3. Click the **Schedule** tab. The scheduled task is defaulted to run **One Time** and is set to run at the *current system date and time*.
  1. If required, update the **Start date** and **time** or use the **calendar** icon to search for an appropriate date and time to run the task.
4. Click on the **Submit** button to submit the task to the scheduler. A message is displayed depending on when the user runs the report. Refer to the message for further information.

> ℹ️ Set the start time to run in the future (minutes, hours, days, months etc). If the start date or time is backdated, the task will run immediately, therefore, if the **schedule** tab has been open for a while and the current date and time have changed, clicking the **submit **button will still run the task immediately.

## Scheduling Daily Tasks

To schedule daily tasks, perform the following:

1. From the **Frameworks menu**, access the relevant task.
2. From the **Criteria** tab (Import or Report) set the required criteria for the scheduled task.
3. Click the **Schedule** tab, then select **Daily**.
4. Update the **Start** **date** and **time** or use the **calendar** icon to search for an appropriate date and time to run the task.
  1. If required, update the **Recur Every** field from the default of daily (1 day) to how often the task should occur, if not daily. The task will be executed at the same time set in the start date above each day.
5. Click on the **Submit** button to submit the task to the scheduler. A message is displayed depending on when the user runs the report. Refer to the message for further information.
6. The **Output** tab will display the results of the completed task.

> **For example:** To run the task every second day, in the **Recur Every** field, enter **2**. To run the task every every 4th day, in the **Recur Every** field, enter **4**.

## Scheduling Weekly or Fortnightly Tasks

To schedule weekly or fortnightly tasks, perform the following:

1. From the **Frameworks menu**, access the relevant task.
2. From the **Criteria** tab (Import or Report) set the required criteria for the scheduled task.
3. Click the **Schedule** tab, then select **Weekly**.
4. Update the **Start** **date** and **time** or use the **calendar** icon to search for an appropriate date and time to run the task.
5. Enable the relevant **day of the week** required for the task to run. Multiple days can be selected.
6. If required, update the **Recur Every** field to indicate how often the task should run.
7. Click on the **Submit** button to submit the task to the scheduler. A message is displayed depending on when the user runs the report. Refer to the message for further information.
8. The **Output** tab will display the results of the completed task. ** **

> **For example**: To run the task every fortnightly, in the **Recur Every** field, enter **2**. To run the task every every 3rd week, in the **Recur Every** field, enter **3**.

## Scheduling Monthly Tasks

To schedule monthly tasks, perform the following:

1. From the **Frameworks menu**, access the relevant task.
2. From the **Criteria** tab (Import or Report) set the required criteria for the scheduled task.
3. Click the **Schedule** tab, then select **Monthly**.
4. Update the **Start** **date** and **time** or use the **calendar **icon to search for an appropriate date and time to run the task.
5. In the **Months** field type the months the scheduled task is required to run. For Example, enter **January,April,July,October **to run the task on these specific months. (Use a comma between each month, with no spaces).
  1. Or select the **Months** via the **search** icon. In the pop-up box enable the months, or select all, then click **Use.**
  2. If required, select either the **Days** of the month the task will run (For example: day 1, day 5, day 15 in the **Days** field.) or **On **the days of the week per week to run the monthly task (For example, the *First* week of the month on a *Sunday* in the **On** field.).
    1. For **Days**:
      1. Click **Days** then via the search > Macro (inline-media-image)

 icon select which days in the month the task will run.
    2. For **On**:
      1. Click **On, **then via the search > Macro (inline-media-image)

 icon select which week and day in the month the task will run.
6. Click on the **Submit** button to submit the task to the scheduler. A message is displayed depending on when the user runs the report. Refer to the message for further information.
7. The **Output** tab will display the results of the completed task. ** **

## Scheduling Repeating Tasks

To schedule once only tasks, perform the following:

1. From the **Frameworks menu**, access the relevant task.
2. From the **Criteria** tab (Import or Report) set the required criteria for the scheduled task.
3. Click the **Schedule** tab, then select **Repeating**.
4. Update the **Start** **date** and **time** or use the **calendar** icon to search for an appropriate date and time to run the task.
5. Updated the **Recur every minutes **field with how often you required the scheduled task to run after the defined start time.
  - This defaults to every **60 minutes** and can be set no shorter than every **15 minutes.**
6. The **Between **fields allow you to set a time range for the scheduled task run during the selected days of the week.
  - Times must be entered in 24-hour time, for example, 9:00 - 17:00.
  - If the task is set to run between, for example, 9:00 - 17:00 every 60 min then the first task will run at 9:00 am and the last task will run at 16:00 and NOT 17:00. If you need it to run at 17:00 make the end time 17:05.
7. Enable the relevant **day of the week** required the task to run. Multiple days can be selected.
8. Click on the **Submit** button to submit the task to the scheduler. A message is displayed depending on when the user runs the report. Refer to the message for further information.
9. The **Output** tab will display the results of the completed task.

> ⚠️ Once the task has completed then the next task is scheduled to run. If the current task has not yet been completed then the next task will wait until the current task has been completed and start at the following interval.
> ⚠️ 
> ⚠️ **For Example**, A task is scheduled to run every 15 min starting at 9:00 am and it takes 20 mins to run then the 9:15 am schedule will be skipped and the next task will run at the next 15 min interval which is 9:30 am.

---

# Additional Information

> ✅ Refer to [Scheduler Administration ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405088) for more information on scheduled tasks