---
title: "Cooks Connect Interface"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28409644/Cooks%20Connect%20Interface"
format: markdown
---
# Overview
The **Cooks Connect Interface** allows you to create a nightly extract of Customer, Products and Customer Product price Data. These output files (csv) are sent via sftp to a nominated folder, where they will be picked up by Cooks Connect and uploaded to the Cooks Connect Customer Portal.
# How to define the Customers and Products to be Exported.
To setup the Customers and Products to be exported, complete the following:
*Click on a heading below for more information:*
## 1. Customers
Only customers that have been flagged as **Web Enabled **will be exported. To do this, perform the following:
1. Click the **Frameworks Menu **and navigate to **Receivables > Maintenance > Customer Maintenance **from the navigation tree.
2. Click **Find** to view a list of all your customers or refine your search criteria by customers number or name.
3. Click the **Trade Portal** tab.
4. Enable the **Web Enabled** checkbox.
5. Click **Save **to commit the changes.
> ✅ Refer to [Customer Export/Import](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28403436) for how to update these fields in mass.
## 2. Products
Only products that have been flagged as **Web Enabled** and/or **App Enabled **will be exported. To do this, perform the following:
1. Click the **Frameworks Menu **and navigate to **Inventory > Maintenance > Product Maintenance **from the navigation tree.
2. Click **Find** to view a list of all your products or refine your search criteria by product number or name.
3. Select the **General Information **option.
4. Click **Edit,** to make changes.
5. Enable the **Web Enabled** and/or **App Enabled **checkboxes
6. Click **Save **to commit the changes
> ✅ Refer to [Product Import](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28409372) for how to update these fields in mass.
---
# How to Process Customer and Product details from Frameworks
To setup the exchange of data, complete the following:
*Click on a heading below for more information:*
## 1. Defining the Cooks Connects System Tables
To maintain the relevant system settings, complete the following:
1. Click the **Frameworks Menu** and navigate to **System Administration** > **System Tables** > **Miscellaneous Table Maintenance** from the navigation tree.
2. In the search field, enter **CooksConnect **and click **Find **to view and maintain the following tables:
- **CooksConnect Directories**
- **CooksConnect SFTP Login settings**
- **CooksConnect SFTP Scripts**
3. Click the **CooksConnect Directories **hyperlink to view and maintain the trade online directory settings. Click **Save **to finalise any changes.
| **Field** | **Description** |
| --- | --- |
| **Code** | Check **Directories **is entered as the **Code**. |
| **Description** | Check **CooksConnect Directories **is entered as the **Description**. |
| **Export Directory** | The **Export Directory **is where the Product, Customer and Customer Pricing reports are stored before being exported to cooks connect customer portal, and will be typically defined as **/prostix/{environment}/cooksconnect/ **or **/frameworks/{environment}/cooksconnect/**
> ℹ️ This path may differ slightly depending on your frameworks environment. For example, {environment} may be /live/ or /demo/. |
| **Host Directory** | The **Host Directory **is where the Product, Customer and Customer Pricing reports are stored once they have been exported to cooks connect customer portal ready to be imported into the database. |
> ⚠️ The directories must be created on your Frameworks server during the setup.
4. Click the **CooksConnect 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 **CooksConnect 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** | Check the correct SFTP port is entered. Typically port **22** is used for SFTP. |
| **Host** | Check the correct SFTP server hostname is entered. For example sftp.yourdomainname.com or sftp.cookscustomerportal.com |
| **User** | Check the correct SFTP username, for the Host, has been entered. |
| **Password** | Check the correct SFTP password, for the Host, has been entered. |
5. Click the **CooksConnect 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 **or **/frameworks/{environment}/deploy/scripts/fw_sftp_upload.sh**
> ℹ️ This path may differ slightly depending on your frameworks environment. For example, {environment} maybe /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 **or **/frameworks/{environment}/deploy/scripts/fw_sftp_poll.sh**
> ℹ️ This path may differ slightly depending on your frameworks environment. For example, {environment} maybe /live/ or /demo/ |
> ⚠️ The directories and script files will be created on your Frameworks server as a part of deployment.
---
## 2. Setting Up the CooksConnect Send Scheduled Task
To setup the schedulable task **Cook Connect Interface Scheduler**, complete the following:
### 1. Accessing the Cook Connect Interface Scheduler
On the [About the Frameworks Home Dashboard](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28379174), under **My Shortcuts,** perform the following to access the **Cook Connect Interface Scheduler.**
1. Click **Add**.
2. Close the **Select an activity to add to your shortcuts **window.
3. In the search field, enter the activity ID **CooksConnectSched**.
4. Click **Finish**.
5. Click the **Cook Connect Interface Scheduler **hyperlink to open the scheduler.
### 2. Confirming the Scheduled FTP Settings
On the **Scheduled FTP Settings **tab, enable the exports required to be scheduled. You can choose to:
- **Export Product: **This will export all product that have been flagged as Web and/or App Enabled in [Product Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378114) under General Information.
- **Export Customer: **This will export all the customers that have been flagged as Web Enabled in [Customer Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28389894) under the Trade Portal tab.
- **Export Customer Price: **This will export the calculated Customer Product Price for only Customers and Products flagged as web enabled.
> ℹ️ All checkboxes will be enabled by default.
For additional information about the cooksproductddmmyyhhmm.csv file, click here
| **Column** | **Name** | **Frameworks Field** |
| --- | --- | --- |
| A | Product Code | Prod.idprod |
| B | Description | Prod.desc_prod1, prod_desc2, prod_desc3, prod_desc_4 concatenated in to a single column. |
| C | Unit | StockingUOM |
| D | GST | Id_gst % (output the actual GST % e.g., 10) |
| E | Category | Desc_grp_prod (Top Level Prod Group) |
| F | Brand | Name_prod_brand |
| G | Alternative Labels | Output blank |
| H | RRP | Unit Sell GST Inc |
| I | State | Output blank |
| J | TP | Unit Sell GST Inc |
| K | Rank | Output blank |
**Product Export **field example:
**Additional Information:**
- The Product output is sorted alphanumerically by Product ID.
For additional information about the cooksCustomersddmmyyhhmm.csv file, click here.
**Customer Export **field example:
| | | |
| --- | --- | --- |
| **Column** | **Name** | **Frameworks Field** |
| A | Account Code | idCust |
| B | Account Name | customerName |
| C | Store | Customers Home Branch |
| D | Credit Limit | creditLimit |
| E | Overdue | OverDueBalance |
| F | Due At EOM | DueBalance |
| G | Current Month | 30DayBalance |
| H | Last Payment Date | Where “Transaction Type” = Payment “Date” |
| I | Last payment Amount | transactionAmount |
| J | Information As At | Current system date (date of extract) |
| K | State | address_cust_3 |
**Additional Information:**
- The Overdue Balance is the balance which is overdue based on the customer Payment Terms. For example, if a customer has a balance in 60 days but is based on 30 days terms, then the balance in 60 days or older is Overdue Balance to output.
For additional information about the CooksCustProdPricesddmmyyhhmm.csv file, click here
**Customer Price **field example:
| | | |
| --- | --- | --- |
| **Column** | **Name** | **Frameworks Table** |
| A | PriceCheckID | Not applicable – always send blank |
| B | AccountCode | idCust |
| C | ProductCode | idProd |
| D | PriceList | Not applicable – always send blank |
| E | Price | SellPriceUnit (Inc GST) |
**Additional Information:**
- The Customer Price output sort sequence is by Customer, then all products (as set as web enabled) and the customers lowest available unit price (as calculated by your [Pricing Hierarchy](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28377236)). Then the next customer and repeat output of products.
- PriceCheckID and Pricelist columns will output as blank as there are no values stored for these in Frameworks.
### 3. Scheduling Nightly Updates
> ⚠️ This task will take several hours to complete the flat file each night. It is strongly recommended to schedule this task AFTER the nightly DB shutdown to avoid interruption.
Navigate to the **Schedule** tab to schedule the task. 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.
> ℹ️ Once files are generated and successfully sent, they will be archived to be purged as required.
# Additional Information
> ✅ Refer to the [Customer Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28389894) and [Product Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378114) User Manual for more information.
> ✅
> ✅ Refer to [Customer Export/Import](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28403436) and [Product Import](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28409372) for how to update these fields in mass.