---
title: "Kepler Analytics - Setup and Configuration"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28409016/Kepler%20Analytics%20-%20Setup%20and%20Configuration"
format: markdown
---
# How to Configure the Export of Kepler Sales Data
To configure the export of sales data, complete the following:
## 1. Install Kepler Analytics Sales Integration Setup
To ensure the Kepler Sales miscellaneous tables have been installed, complete the following:
1. Click **Frameworks** and navigate to **System Administration** > **System Tables** > **Miscellaneous Table Installer** from the navigation tree.
2. Click **Find **to return a list of installers. Enter **InstallerFW15045** into the **Installer Name** field.
3. If the **Has Been Run?** checkbox is unchecked, select the installer via the checkbox on the far left and click **Install Selected**.
## 2. Complete and Validate Kepler Sales Miscellaneous Tables
To complete and validate relevant system settings, complete the following:
1. Click **Frameworks **and navigate to **System Administration** > **System Tables** > **Miscellaneous Table Maintenance** from the navigation tree.
2. In the **Table** search field, enter **KeplerSales** and click **Find **to view and maintain the following tables:
- **KeplerSales Directories**
- **KeplerSales SFTP Login settings**
- **KeplerSales SFTP Scripts**
3. Click the **KeplerSales Directories **hyperlink and maintain the Kepler Sales directory settings. Click **Save **to finalise any changes.
| **Field** | **Description** |
| --- | --- |
| **Code** | Check **Directories **is entered as the **Code**. |
| **Description** | Check **KeplerSales Directories **is entered as the **Description**. |
| **Local Directory** | The **Upload Directory **will be typically defined as **/prostix/{environment}/keplersales/**
> ℹ️ This path may differ slightly depending on your framework's environment. For example, {environment} may be /live/ or /demo/. |
| **Host Directory** | The **Host Directory** is initially empty and can be defined here. Typically, can be defined as **/upload/keplersales/** |
4. Click the **KeplerSales SFTP Login settings **hyperlink to view and maintain the relevant settings. Click **Save **to finalise any changes.
| **Field** | **Description** |
| --- | --- |
| **Code** | Check **Login **is entered as the **Code**. |
| **Description** | Check **KeplerSales Login Details **is entered as the **Description**. |
| **Use (S)FTP Scripts** | Enable to ensure the secure file transfer protocol (SFTP) scripts are used to securely transfer your data. |
| **(S)FTP Port** | The **(S)FTP Port** is initially empty and can be defined here. Typically port **22** is used for SFTP. |
| **Host** | The SFTP server hostname is initially empty and can be set here. For example, [sftp.yourdomainname.com](http://sftp.yourdomainname.com/). |
| **User** | The username is initially empty and can be set here. |
| **Password** | The password is initially empty and can be set here. |
5. Click the **KeplerSales SFTP Scripts** hyperlink to view and maintain the relevant settings. Click **Save **to finalise any changes.
| **Field** | **Description** |
| --- | --- |
| **Code** | Check **Scripts **is entered as the **Code**. |
| **Description** | Check **Upload and Poll Scripts is** entered as the **Description**. |
| **Upload Script** | The path for the location of the **Upload Script (push** files to a remote SFTP site) will be typically defined as **/prostix/{environment}/deploy/scripts/fw_sftp_upload.sh.**
> ℹ️ This path may differ slightly depending on your framework's environment. For example, {environment} may be /live/ or /demo/. |
| **Poll Script** | The path for the location of the **Poll Script (download** files from a remote SFTP site) will be typically defined as **/prostix/{environment}/deploy/scripts/fw_sftp_poll.sh**.
> ℹ️ This path may differ slightly depending on your framework's environment. For example, {environment} may be /live/ or /demo/. |
> ⚠️ The directories and script files will be created on your Frameworks server as a part of deployment.
## 3. Schedule and Run Kepler Sales Export
To use the **Kepler Sales Export Scheduler**, complete the following:
### 1. Accessing the Kepler Sales Export Scheduler
Click **Frameworks **and navigate to **System Administration** > **Task Scheduler** > **Schedulable Tasks** > **Kepler Sales Export Scheduler** from the navigation tree.
### 2. Customising the Scheduled FTP Settings
On the **Scheduled FTP Settings** tab, complete one of the following:
- Enable the checkbox for **Historical Sales** and enter a date using the **Show Date Chooser** icon to export the sales data of a day in the past.
- Leave the **Historical Sales** checkbox unchecked to export the sales data of the current day.
### 3. Scheduling Hourly Updates
Navigate to the **Schedule** tab to schedule the task. It is strongly recommended to schedule this task to run hourly. To do so, complete the following:
1. Select the **Repeating **option
2. Enter the **start** date and time or use the **Show Date Chooser** icon.
3. Set to **Recur every 60 mins**
4. If required, set a **Between **time range for the hours you want to run the task, for example, 8:30 - 17:30.
5. Enable the checkbox for the days you want the updates to run.
6. Click **Submit** to schedule the task.
Steps for version earlier than 6.1
## Steps for version earlier than 6.1
Navigate to the **Schedule** tab to schedule the task. It is strongly recommended to schedule this task to run hourly. To do so, complete the following:
1. Select the **Daily** option.
2. Enter the start date and time or use the **Show Date Chooser** icon.
3. Set to recur every (1) day.
4. Click **Submit **to schedule the task.
5. Click **New **to start a new submission.
6. Repeat the previous steps but use the same date and add 1 hour to the previous set time (for example, if 16/03/2022 09:00 was used, enter 16/03/2022 10:00)
7. Repeat for every hour of the desired period.
> ℹ️ The **Scheduled FTP Settings** will refresh with every new submission, so be sure to make necessary changes if required.
> ✅ Refer to the [Scheduled Task - Scheduling and Output](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402256) User Manual for more information.
### 4. Interpreting the Output
Once the export is complete, a pipe delimited .csv file is created detailing the sales data. The file is in the form of the following:
*Store ID|Store Name|Transaction Datetime|Transaction ID|Salesperson ID|Salesperson Name|Product ID|Product Name|Product Category|Product Description|SKU ID|SKU Colour|SKU Size|Qty Sold|Unit Price|Sales Total|Currency*
# Additional Information
> ✅ Refer to [Schedulable Tasks](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28401742) for more information.