---
title: "Schedulable Tasks"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28401742/Schedulable%20Tasks"
format: markdown
---
# Overview

<span style="color: #003366"> </span><span style="color: #333333">The </span>**<span style="color: #333333">Schedulable Tasks </span>**<span style="color: #333333">are a list of task, which are run in the background, to help you collect information to be displayed within Frameworks. Scheduled tasks can be</span><span style="color: #003366"> </span><span style="color: #333333">run as a once off, at a specific time or as a recurring schedule (Daily, Weekly, Fortnightly or Monthly).</span><span style="color: #003366"> </span>

# Accessing the Schedulable Tasks

To access one of the scheduler tasks below, perform the following:

1. Click the **Frameworks Menu** and navigate to **System Administration > Task Scheduler > Schedulable Task > **select the required task.

# Schedulable Tasks in Frameworks

Click on one of the heading below to find our more about the scheduler task.

> ✅ ***Tip****: Press Ctrl + f to use your browser's search function to find the system setting you are looking for.*

> ✅ Refer to [Scheduled Task - Scheduling and Output ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402256) for more information on how to schedule any of the below tasks.

<details>
<summary>For scheduling considerations, click here. </summary>

When setting up any schedulable task, it's important to consider the order and execution in relation to other scheduled events, especially for interconnected items. To ensure a smooth process, take the following factors into account:

- **Defining Export Task Timing: **Determine when the export task should be scheduled. Choose a time that aligns with your business operations and when the system is least likely to experience heavy usage.
- **Export Task Duration:** Estimate how long the export task will take to complete. This will help you allocate an appropriate time window for the process.
- **Variability in Export Duration:** Consider whether the time taken for the export task can vary. Factors like data volume and system load can impact the duration. Allow for a potential range of completion times.
- **Initiating Subsequent Tasks:** This should follow the completion of the previous task to ensure any relying data is current.
- **Subsequent Task Duration:** Estimate the time required for any follow-up task to finish. This will help you plan the following steps accurately and ensure efficiency.
- **Allowing Margin:** Factor in enough time for the considerations mentioned above. Give some margin to account for unexpected delays or variations in task durations.
- **Cycle Start Time:** Based on the previous considerations, determine when the entire cycle of export, import, and any other related tasks should begin again. This will help maintain a consistent and well-coordinated data update process.
</details>

## Build Sales Calendar

This scheduled task updates the Sales Details in the [Management Dashboard ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28398108)screen. It builds the Sales Calendar for either today, a calendar month, or an advised date range depending on your selection.

> ℹ️ This scheduled task needs to be set up and run for both the **Today** and **Calendar Month.**

1. On the **Criteria **tab, from the **Select **drop-down menu to chose on of the following:
  - **Today**: Collects the data for today. *Recommended to be scheduled on a daily basis*.
  - **Calendar** **Month**: Collects the data for the Calendar month. *Recommended to be scheduled every night.*
  - **Advised** **Date** **Range**: This option allows you to chose a specific date range to collect the data for the Sales Calendar in the Management Dashboard. *This is used when a rebuild of information is required.*
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## Build Sales Calendar - Quotes

*Recommended to be scheduled every night.*

This scheduled task updates the Quote Details in the [Management Dashboard](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28398108) screen. 

1. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ℹ️ This scheduled tasks doesn't have any user defined parameters on the criteria tab.

## Build Sales Calendar - Future/Past Orders

*Recommended to be scheduled every night.*

<span style="color: #172b4d">This scheduled task updates the Future Order and Past Order Details in the </span><span style="color: #172b4d">[Management Dashboard ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28398108)</span><span style="color: #172b4d"> screen. It b</span>uild the Sales Calendar from future and past dated orders. *Recommended to be scheduled every night.*

1. Go to the **Schedule** tab to schedule thetask as required and then click **Submit **to run the task.

> ℹ️ This scheduled tasks doesn't have any user defined parameters on the criteria tab.

## Build Default Runsheet Headers

*Recommended to be scheduled every night.*

This scheduled tasks creates the Runsheet Headers for the next 7 days. Existing Headers are NOT overwritten. 

1. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ℹ️ This scheduled tasks doesn't have any user defined parameters on the criteria tab.

## Calculate Product 'On Order' Quantities

*Recommended to be scheduled every night.*

This scheduled task calculates the **On P/O** and **On C/O** quantities for the **Product Finder**. *Recommended to be scheduled every night.*

> ⚠️ **Important**: Sales orders on **Order Hold **are NOT included in **On C/O** calculation.

1. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ℹ️ This scheduled tasks doesn't have any user defined parameters on the criteria tab.

## Build KPI Data (Stock, Sales, Debtor and Creditor)

*Recommended to run outside of business hours as this could involve some overhead and time in processing the results.*

This scheduled task creates or updates the KPI Data table for Sales, Debtor and Creditor.

1. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ℹ️ This scheduled tasks doesn't have any user defined parameters on the criteria tab.

## Build KPI Inventory Data

*Recommended to run outside of business hours as this could involve some overhead and time in processing the results.*

This scheduled task creates or updates the KPI Inventory data table. This data is then available for KPI reports (Stock Valuation From KPI Data and Purchase Analysis By Product Group - KPI) in the [Reporting Dashboard ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28380010). 

1. On the **Criteria **tab, define the following:
  - In the **Branch ID **field enter the branch Id you want to run the task for. This defaults to **0 **which will select all branches.
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## Build KPI Product Data

*Recommended to run outside of business hours as this could involve some overhead and time in processing the results. To be scheduled every night.*

This scheduled task creates or updates the KPI Data table for Product Stock. This task will output the qty on hand for each product into a data table to allow for reports to be written to that require a calculation of average inventory value.

1. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ℹ️ This scheduled tasks doesn't have any user defined parameters on the criteria tab.

## Customer Payments Auto Allocations

*Recommended to be scheduled as frequent as your business requires *

This scheduled task automatically allocates customer payments against outstanding Transactions, for example, if you take a payment for $100 the auto allocation matches the amount to the oldest invoice until it is all used or if there are no balance owing or the customer is in in credit leaves the amount as allocated or any additional amounts it then creates a transaction until an invoice/order is available where you then perform a [How do I move the balance from one Customer transaction to another?](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/191889412)to move the left over value on the invoice/order  in the future.

1. On the **Criteria **tab, define the following:
  - In the **Company **field enter the Company Id you want to run the task for.
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## Swap Preferred Supplier

*Recommended to be scheduled outside of business hours.*

This scheduled task switches the preferred supplier based on lowest price. It updates

- Product standard cost
- Product landed cost
- Product preferred supplier

1. The **Report Only **checkbox will be enabled by default. This option allows you to create a report of what the changes will occur when the scheduled task is run. A downloadable file on the **Output tab.**
2. Disable the **Report Only **checkbox to run the task.
3. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task

## Scheduled Farmlands File Extract

> ⚠️ **Important**: The default recipient email address where the <span style="color: #333333">Farmlands invoice EDI file is sent to is defined via the </span>**<span style="color: #333333">FlandEmail </span>**<span style="color: #333333">setting under </span>**<span style="color: #333333">System Administration > System Tables > Miscellaneous Table Maintenance > System Settings - General</span>**<span style="color: #333333"> </span>

This scheduled task allows you to export an email all of the Farmland Card point of sale transactions.

1. On the **Criteria **tab, define the following:

- **Send Daily?**: Enabled this checkbox if you are scheduling to run this task daily. Today's date will then be displayed in the **Period From** and **To** fields.
- **Period From **and **To**: If you are not scheduling this task to run daily then enter the date range you want to run the extract for.

> Macro (include)

- **Email Address Recipient***: Enter the email address you want to send the extracted file to.
- **Extracted To**: This is the server path the extracted file is saved to.

2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> Macro (include)

## Scheduled Invoice Print for Rural Cards

This scheduled task generates a PDF invoice file for **RuralCo Cards**. Member numbers will be include on the invoices. 

> ⚠️ **Important**: The default recipient email address where the <span style="color: #333333">RuralCo PDF is sent to is defined via the </span>**<span style="color: #333333">RuralEmail </span>**<span style="color: #333333">setting under </span>**<span style="color: #333333">System Administration > System Tables > Miscellaneous Table Maintenance > System Settings - General</span>**<span style="color: #333333"> </span>

1. On the **Criteria **tab, define the following:

- **Send Daily?**: Enabled this checkbox if you are scheduling to run this task daily. Today's date will then be displayed in the **Period From** and **To** fields.
- **Period From **and **To**: If you are not scheduling this task to run daily then enter the date range you want to run the extract for.

> Macro (include)

- **Email Address Recipient***: Enter the email address you want to send the extracted file to.
- **Email Subject: **This displays the subject of the email that will be sent " *RuralCo Card Invoices: Period*"
- **Output Dir**: This is the server path the extracted file is saved to.
- **Archive**: This is the server path the archived files are saved to.

2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> Macro (include)

## Bank Till Sessions

This scheduled task will Bank Till Sessions with no expected amount against the Till. Only Till Sessions that are two days older and below will be Banked.

1. The **Report Only **checkbox will be enabled by default. This option allows you to create a report of what the changes will occur when the scheduled task is run. A downloadable file on the **Output tab.**
2. Disable the **Report Only **checkbox to run the task.
3. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## KPI GL Extract

*Recommended to be scheduled outside of business hours as this could involve some overhead and time in processing the results.*

This scheduled task adds or creates Ledger KPI records for all companies with an unclosed financial year.

1. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ℹ️ This scheduled tasks doesn't have any user defined parameters on the criteria tab.

## Debtors Control Audit

This scheduled task will total up the debtors sub-ledger for a company and compare it to the GL balance for Trade Debtors.

1. On the **Criteria **tab, define the following:
  - **From Company** and **To Company**: From the drop-down menus select the company range you want to run the audit for.
  - **Email Address to Notify**: Enter the email address to want to send a notification to at the end of the task. Leave blank to just display the reports on the **Output **tab.
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## Creditor Control Audit

This scheduled task will total up the debtors sub-ledger for a company and compare it to the GL balance for Trade Creditors.

1. On the **Criteria **tab, define the following:

- **From Company** and **To Company**: From the drop-down menus select the company range you want to run the audit for.
- **Email Address to Notify**: Enter the email address to want to send a notification to at the end of the task. Leave blank to just display the reports on the **Output **tab.

2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## Accounts Payable Payment Audit

This scheduled task checks that all cheques in the accounts payable module balances with the account payable payment records linked to them. If any cheques are not balanced a list (.csv) will be created and email the list (if requested).

1. On the **Criteria **tab, define the following:
  - **From Company** and **To Company**: From the drop-down menus select the company range you want to run the audit for.
  - **Email Address to Notify**: Enter the email address to want to send a notification to at the end of the task. Leave blank to just display the reports on the **Output **tab.
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## Inventory GL to Subledger Audit

This scheduled task checks the **Inventory GL** against the **Subledger Audit** to check if it's in balance. The General Ledger accounts included will be determined by the account type being defined as a **stock** account in the chart of accounts.

1. On the **Criteria **tab, define the following:

- **From Company** and **To Company**: From the drop-down menus select the company range you want to run the audit for.
- **Email Address to Notify**: Enter the email address to want to send a notification to at the end of the task. Leave blank to just display the reports on the **Output **tab.

2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## Scan project attachments directory

*Recommended to be scheduled every night.*

This scheduled task will scan the local machines project directory, for example, * /usr/share/tomcat6/webapps/custom/attachments/new/project/xxx* and finds any media files that have been imported but does not yet have media file links and creates them. This means the media file link will now be visible in the chosen project under attachments within Frameworks.

1. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ℹ️ This scheduled tasks doesn't have any user defined parameters on the criteria tab.

## Capture Product Out of Stock Data

*Recommended to be scheduled every night.*

This scheduled task captures product out of stock information and adds it to a table which can then be analysed as required. Product out of stock information is only captured for **branch products** with a **minimum stock level** which is greater than zero and if the **Stock on Hand** (SOH) is less than or equal to zero.

1. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ℹ️ This scheduled tasks doesn't have any user defined parameters on the criteria tab.

## <span style="color: #172b4d">Calculate Reward Points Earned</span>

*Recommended to be scheduled every night.*

This scheduled task<span style="color: #333333"> will </span>**update** <span style="color: #333333">the customer’s </span>**points balance** <span style="color: #333333">and do the relevant</span> **GL postings**<span style="color: #333333">.</span> 

1. On the **Criteria **tab, define the following:
  - **Reward**: Click the **Search **icon to open the **Generic Reward Finder** to search for a reward program to be calculated.

> ℹ️ Leave blank to calculate the point balance for all reward programs.

2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ℹ️ This scheduled tasks doesn't have any user defined parameters on the criteria tab.

## GP Contract Cost Check

*Recommended to be scheduled every night.*

This scheduled task will adjust Contract Line GP% to retain profits when the Product Cost decreases.

> ℹ️ Only Contracts with Hold Sell and Contract Lines with the Pricing Rule (Gross Profit) will be included in the adjustment. See [Contracts Maintenance ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28391896) for more information.

> ⚠️ How the System Settings - Flag **ContCstChkInc (Allow Cost Increases on GP Contract Cost Check task) **affects the Products Sell Price
> ⚠️ 
> ⚠️ - When enabled: If the GP% is positive or negative the contract lines will hold the sell price.
> ⚠️ - When unenabled: If the GP% is positive the contract lines will hold the sell price. If the GP% is negative the contract lines sell price will be updated.

1. On the **Report Criteria **page:
  - Enabled **Report Only **to run just a report of what changes will occur.
  - Disabled **Report Only** to run the task.
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## <span style="color: #172b4d">Scheduled Reprice of Kit Products</span>

*Recommended to be scheduled every night.*

This scheduled task will update the **cost/sell price** of a kit for kits where the cost/sell is calculated by adding the cost of each component in the kit, perform the following: 

> ⚠️ **Important: **This scheduled task is for kits which have been defined in [Kit Maintenance ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28409556) as:
> ⚠️ 
> ⚠️ - Re-price all Kits from the Component Sell prices if Sum Sell has been enabled.
> ⚠️ - Kit Cost will be recalculated by summing the Component Costs if Sum Cost has been enabled.

1. On the **Report ** **Criteria **tab, define the following:

- The **Company** will default to users logged in company.
- Enabled **Include Branch Pricing: **If Branch pricing is included

> ℹ️ The cost/sell for all branches within the specified range for each re-priced kit is updated based on the branches' labour and overhead rates specified in the kit's product group. In addition, kits are re-priced even if sum cost is not enabled; the labour and overhead rates are applied to the existing branch cost.

- Use the **From **branch and **To **branch fields to select the branches you want to include branch pricing for.

2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## Scheduled Load of Longitude and Latitude

This scheduled task <span style="color: #172b4d">will update the longitude and latitude for customer orders (delivery), purchase orders (delivery), customer addresses, branch addresses and central orders (delivery).</span> 

1. On the **Report Criteria** tab, define the following:
  - Enable which options you want to assign latitude and longitude on sales delivery, customer address, central orders and branches.

> ⚠️ All the options will be enabled by default.

2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## Contract Margin Management 

*Recommended to be scheduled every night.*

This scheduled task will apply the contract margin management percentage (**Price Margin %**) defined on a contract to increase the sell prices on the contract lines in the next review period. When applied the product or product group line, within the contract maintenance screen, will have the **Has Future** checkbox enabled.

> ℹ️ **Note: **The future pricing record on the contracted product or product group will be assigned **System **as the user.

> ✅ Refer to the [Contract Future Price Review ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405466) user manual for more information.

> ℹ️ This Scheduled task is ONLY for:
> ℹ️ 
> ℹ️ - Current effective contracts and NOT a tier pricing contract.
> ℹ️ - Non-product group contract lines.
> ℹ️ - Contract lines that will have a cost change between today and next open review date.
> ℹ️ - If the flag **InvContDec** is disabled (Ignore Contract Future Review Prices On Decrease) and the future cost is a decrease in cost, then the future pricing will be reviewed. If the **InvContDec **flag is enabled, then a decrease in future cost will be excluded from the review.

1. On the **Report Criteria** tab, define the following:
  - In the **Company **field enter the company number want to updated. Click the **Search **icon to open the **Company Finder** window.
  - From the **Pricing Rule **drop-down menu select the pricing rule you want to apply the scheduled task to.
  - Enabled **Report Only** to view a .html report of which contacts and products will be updated. Disabled
    to commit the update.
  - Enabled **Report excluded contract lines **to report on any contract lines with have been excluded from being updated.
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ✅ Refer to [Apply Product Future Pricing ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402874) for more information on applying future pricing.

## Contract Future Price Updates

This scheduled task will update contract future prices next review date for products with the current standard future cost and date effective defined. Only for product that have a current standard date effective greater than today. 

> ⚠️ Applies to pre-existing contract future prices, applied by the above **contract margin management **task AND where the **User** field is still **system **(hasn't been modified).
> ⚠️ 
> ⚠️ - If the flag **InvContDec** is disabled (Ignore Contract Future Review Prices On Decrease) and the future cost is a decrease in cost, then the future pricing will be reviewed. If the **InvContDec **flag is enabled, then a decrease in future cost will be excluded from the review.

1. On the **Report Criteria** tab, define which of your companies do you want to run the update for.
  - If you have multiple companies, in the **Company **field enter the company number want to updated. Click the **search** icon to open the **Company Finder** window.
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ✅ Refer to [Apply Product Future Pricing ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402874) for more information on applying future pricing.

## Stock Receipt Price Changes

*Recommended to be scheduled every night.*

This scheduled tasks updates the Supplier Cost based on the last Receipted Cost. If the Supplier Cost is updated, the Standard Cost, Standard Sell, Branch Cost and Branch Sell will be updated accordingly.

> ℹ️ If the standard or branch sell price of the product is updated, the product will be added to an existing label batch for the branch or a new label batch will be created for the branch with the description: "Daily Price Changes for Stock Received - BRN X” to print new shelf labels.

<details>
<summary>Click here for additional information</summary>

**Supplier Costs**

- If the System Setting - Flag **InvReset** is enabled, then any cost changes for the preferred supplier will also update the standard cost.
- If the System Setting - Flag **InvResetB** is checked, then any cost changes for the branch preferred supplier will also update the branch cost.

**Standard/Branch Cost**

- If the standard cost of the product has changes because of the scheduled task, the Unit Sell will updated based on the products Retain GP (Up) and Retail GP (Down) settings.
- If the branch cost of the product has changes because of the scheduled task, the Branch Unit Sell updated based on the products Retain GP (Up) and Retail GP (Down) settings.
</details>

1. On the **Import Criteria** tab, define the following:
  - In the **Branch **field enter the branch id you want the changes to be applied to. Click the **search **icon to open the **Branch Finder** window. (This field is mandatory)
  - In the **User Id **field enter the user id of the user who will receive a notification if a label batch for the branch has had any additions, once the task is completed.
  - The **Date Last Run **information displays the date that the task was last run. This is to make sure you don't miss days, if the task fails to run. It also gives you the option on the first run to update the costs for receipts processed in, for example, the last week. On fist run it will default to yesterdays date. (This field is mandatory)
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## Prostix/Frameworks Pack Transfers Update

*Recommended to be scheduled every night.*

This scheduled task updates the details from a Frameworks sales order back to the ProStix created branch transfer purchase orders so that it can be receipted in ProStix. (Typically only used for sites in transition).

> ⚠️ The following System Settings - Flags are required to be enabled for this function.
> ⚠️ 
> ⚠️ - **FWPKENT: **Enab
> ⚠️ - les Frameworks Enterprise Picking
> ⚠️ - **FWPack: **Allows for packs to be used with Frameworks Picking.

1. On the **Import Criteria** tab, define the following:
  - From the **Branch From **drop-down menu select the requires sending branch.
  - In the **Branch To List** enter the branch id for receiving branch/es
  - Enabled **Report Only** to view a .html report of which contacts and products will be updated. Disabled to commit the update.
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

## Kepler Sales Export Scheduler

This scheduled task gathers the current, or selected previous, day's sales data and sends it to the defined SFTP server.

> ⚠️ The following miscellaneous tables must first be validated:
> ⚠️ 
> ⚠️ - **KeplerSales Directories**
> ⚠️ - **KeplerSales SFTP Login Settings**
> ⚠️ - **KeplerSales SFTP Scripts**

1. On the **Scheduled FTP Settings** tab, complete one of the following:
  - Enable **Historical Sales** and enter a date using the **calendar** icon to export the sales data of a day in the past.
  - Leave the **Historical Sales** checkbox disabled to export the sales data of the current day.
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run

> ✅ Refer to [Kepler Analytics - Setup and Configuration](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28409016) for more information.

## Scan Data Extract Scheduler

This scheduled task utilises the scan data and allows you to extract the historical transactions from Frameworks into the IHG Reporting Systems.

1. On the **Report Criteria** tab, define the following:
  - Select the relevant **Branch** from the dropdown menu.
  - Enable **Send Full** to send a full file or leaved unchecked to send an incremental file.
  - Enable **Skip 6pm Check** to bypass the requirement that this task is run after 6pm.
2. Go to the **Schedule** tab to schedule the the task as required and then click **Submit **to run the task.

## Scan Data Finance GL Extract Scheduler

This scheduled task utilises the scan data and allows you to extract the historical finance records (General Ledger) from Frameworks into the IHG Reporting Systems.

1. On the **Report Criteria** tab, define the following:
  - Select the relevant **Branch** from the dropdown menu.
2. Go to the **Schedule** tab to schedule the the task as required and then click **Submit **to run the task.

## FTP Scheduler

This scheduled task will <span style="color: #172b4d">schedule the running of an ftp script with input parameters.</span> 

> ℹ️ <span style="color: #172b4d">The default script uses secure file transfer protocol (SFTP).</span>

1. On the **Scheduled FTP Settings** tab, define the following:
  - **User Name**: Enter the user name for the FTP server
  - **Password**: Enter the password for the FTP server
  - **Host Order Directory**: Enter the directory path on the remote site.
  - **FTP Site**: Enter the server address for the FTP server
  - **FTP Port**: Enter the port number for the FTP server
  - **Script Path**: Enter the script file path of the Frameworks server. The script path MUST end in either  **fw_ sftp_poll.sh** or **fw_ sftp_upload.sh**
  - **File Path**: Enter the file path of the Frameworks server
  - **Sent File Archive**: Enter the file path where sent files will be archived to once uploaded. This field will only be visible if the **Script Path **is **fw_ sftp_upload.sh**

> ⚠️ **Important:** The **Script, File** and** Archive Paths** MUST already exist on the Frameworks server prior to scheduling this task.

2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ✅ Refer to [https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/218857486](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/218857486) for more detailed information

## Bounced Email Extract

*Recommended to be scheduled every day as a minimum.*

This scheduled task Extract Bounced Emails from the AWS Server. The [https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/40599698](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/40599698) requires this to run for results to be displayed.

1. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

> ℹ️ This scheduled tasks doesn't have any user defined parameters on the criteria tab.

## Re-Index Addresses in Customer Transactions

This will re-index the addresses in all customer transactions within the specified date range for use in **Customer Transaction Enquiry**.

1. On the **Report Criteria** tab, define the following:
  - Enter a branch range using the **Branch From** and **To** fields to apply the re-index to or click the search icon to open the **Branch Finder**.
  - Enter a date range into the **Date From** and **To** fields for the historical data to re-index. This defaults to two years prior to the current date.
2. Go to the **Schedule** tab to schedule the task as required and then click **Submit **to run the task.

# More Schedulable Tasks

> Macro (rw-ui-children)

# Additional Information

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