---
title: "Scan Data Extract Scheduler"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28399922/Scan%20Data%20Extract%20Scheduler"
format: markdown
---
# Overview

This scheduled task allows you to extract a wide range of defined data from Frameworks into the IHG Reporting Systems. Full extracts of all defined data are sent once a month, on a nominated day and then daily increments are sent to keep the data regularly updated. All data is sent to the IHG Reporting Systems via secure file transfer protocol (sftp) at the completion of each task.

> ⚠️ **Important: **If you require assistance in configuring **Scan Data**, contact [Support](https://kb.myframeworks.com.au/page/support)

# Accessing the Scan Data Extract Scheduler 

To access the **Scan Data Extract Scheduler** perform the following:

- Click the **Frameworks Menu** and enter **Scan Data Extract Scheduler** into the **Search Box.**  
OR
- Click the **Frameworks Menu** and navigate to **System Administration > Task Scheduler > Schedulable Tasks > Scan Data Extract Scheduler** from the navigation tree.

# Scheduling the Task

## 1. Scheduled FTP Settings Tab

On the **Scheduled FTP Settings **tab, you can define the criteria required for the **Scan Data Extract Scheduler** task

![image-20241018-043713.png](media://cf867311-43ce-4695-8b59-83451efc9203)

- From the **Version **drop-down menu, select the required scan data extract version required to be transferred from Frameworks into the IHG Reporting System.
- From the **Branch **drop-down menu, select the relevant branch the extracted data will be for.
  - The **Store **ID** **for the selected branch is displayed below.
- The **Send Full** checkbox allows you to:
  - **Enable **to send a full file of all the available data
  - Leave **Disabled** to send an incremental (Delta) file. Incremental files only include data modified during the day.
- In the **Day Full **field, enter the day of the month when a **Full File **must be sent to the IHG Reporting System.
- Enable **Skip 6 pm Check** to bypass the requirement that this task is required to run after 6 pm.

> ⚠️ **Important: **When scheduling the **Scan Data Extract** task, the following checkboxes are NOT recommended to be enabled and are typically only required when testing. 
> ⚠️ 
> ⚠️ - **Send Full**
> ⚠️ - **Skip 6pm Check**

## 2. Schedule Tab

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

> ℹ️ The **Scan Data Extract** task is recommended to be scheduled:
> ℹ️ 
> ℹ️ - Using the **Daily **or **Weekly **recurrence options
> ℹ️ - Beginning after 6 pm or after your days' trading.

## 3. Output Tab

The **Output** tab is used to view the results of the completed task (dependent on how it is scheduled).

1. If the task is run immediately, click on the **Generated Reports **hyperlinks
2. If the task has been scheduled to run at a later time or as a part of a recurrence then the [Task Scheduler Queue](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405088/Scheduler+Administration#%5BinlineExtension%5DTask-Scheduler-Queue) will contain the output.


# Additional information

<details>
<summary>System Related Settings</summary>

**System Settings - General**

- **M10ScanData*****[BrnID]*****LRD: **Branch[ID] ScanData Extract Last Run Date on Frameworks.
  - The date when the scheduled task was last completed for the branch (e.g., M10ScanData010LRD for branch 10) is recorded here in the value field. This data is used to determine which day's data needs to be sent the next time the task is run for that branch.
</details>