---
title: "Detrack - System Administration & Setup"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28388444/Detrack%20-%20System%20Administration%20%26%20Setup"
format: markdown
---
# Overview
Before Detrack can be used, the following system administration activities must be completed.
> ⚠️ Detrack Install quick Checklist can be found here: [Detrack checklist.xlsx](https://sterlandsupport.atlassian.net/wiki/download/attachments/28388444/Detrack%20checklist.xlsx?version=1&modificationDate=1733717125076&cacheVersion=1&api=v2)
# Prerequisites
The Frameworks **Activity Task Scheduler Control** and **Notification Event Queue Processor Control** must both be configured and running:
# System Configuration Tasks
The following system configuration tasks must be set up & completed:
## 1. Obtain a Detrack API Code
> ⚠️ Customers using DeTrack need to register with the Detrack application in order to obtain an API code/value that can be added to the FWDTAPI flag below.
To obtain a Detrack API key, perform the following:
1. Log in to the Detrack application.
2. Navigate to the settings drop-down, then select * API Key*:
3. If there is no key, you can generate one using the '*Generate*' button or '*Regenerate*' button if required.
# Setup the System Settings/Flags
Refer to the following processes to setup the system correctly:
## 1. Add the Detrack API code to the FWDTAPI system flag
To add the Detrack API code to the FWDTAPI system flag, perform the following:
1. Run *InstallerFW5992* via the Miscellaneous Table Installer in Frameworks. This will add a new tailoring code, FWDTAPI under *System Settings - General*
2. Enter the API key obtained above into the tailoring code FWDTAPI.
3. Under *System Settings - Flags*, set the enable Order Confirmation flag **FWConfirm **to ticked.
| **Flag** | **Description** | **Setting** |
| --- | --- | --- |
| **FWConfirm** | Enable to enable Order/Quote Confirmations | System Settings - Flags |
| **FWDTAPI ** | Setting for the Detrack API value | System Settings - General |
| **FeatureDNA** | Allow DeTrack Notification Actions | System Settings - General |
| **FWCountry** | By default this is loaded with value = "Australia". For non-Australia sites you will need to set this flag in order to send the right country details to detrack eg New Zealand. | |
## 2. Setup the Branch Flag
To setup the branch flag, perform the following:
1. Under Frameworks Menu '*Branch Maintenance*', set branch flag '*Default Order Complete*' to unticked > Macro (inline-media-image)
for each Branch using the Detrack Application.
## 3. Ensure that the run sheet vehicles are setup via Vehicle Codes Maintenance
> ℹ️ This is only required if using Detrack with Pick and Despatch Application. Vehicle Maintenance currently only exists in ProStix. For further information on how to configure Vehicles, refer to [Delivery Data](https://sterlandsupport.atlassian.net/wiki/spaces/prostix/pages/31102017)
To set up the run sheet vehicles, perform the following:
1. Ensure that the runsheet vehicles are correctly captured via System Administration - Configuration - Miscellaneous Tables, Delivery Data, select option 'Vehicles'.
2. Ensure the runsheet vehicles also have a runsheet driver/s via System Administration - Configuration - Miscellaneous Tables, Delivery Data, select option 'Drivers'.
3. Configure runsheet defaults as required via System Administration - Configuration - Miscellaneous Tables, Delivery Data, select option 'Runsheet Defaults'
4. Ensure the scheduled task **Runsheet-Load** is also configured and set to current (this can be loaded via A-5-6 sysjrunshtld.p). This will create the runsheets based on the vehicles, drivers, and runsheet defaults configured above.
# Notification Configuration tasks
Refer to the following processes to configure the notifications correctly:
## 1. Subscribe the Sales Order Confirmations to DeTrack
To subscribe the Sales Order Confirmations to DeTrack, perform the following:.
Subscribe the below events to Notification Events via the Event Definition Maintenance menu within Frameworks.
| Event | Description |
| --- | --- |
| **OrderConfirmation** | Sales order "Confirmed" in Frameworks. |
| **DespatchConfirmation** | Confirmation order is ready to be despatched. The trigger for this event is linked to the "Despatch Confirmation" scheduled task. |
| **DispatchNotice** | Notice for orders being despatched. The trigger for this event is the printing of the run sheet. |
| **SaleOrderReqDelivery** | Orders where Delivery Data has passed |
| **OrderBackOrdered** | Back Order notification |
| **OrderModified** | Notification when order is modified |
| **SalesOrderInvoice** | Confirmation of Sales order being Invoiced |
| **OrderReleased** | Notification when sales order is picked and released. Used for customers with Interim Invoice instead of the 'SalesOrderInvoice' notification task. |
> ✅ Refer to [Creating Events & Subscribing Users, Internal Staff or Third Parties](https://kb.myframeworks.com.au/space/FRAM/596049922/Setup+&+Administration) for further information.
> ℹ️ After adding or updating any notification tasks, stop and start the Notification event queue processor.
## 2. Excluding Pickup Despatch Types from being sent to Detrack
When the notifications for Detrack are subscribed (enabled), the notification events will always be created and processed by the notification queue.
The notifications may contain multiple actions, one of which will be Detrack. As a result, it is not feasible to prevent the creation of the notification, so another method is used to further refine the notification and determine whether or not an action will be applied or just ignored.
Since Detrack should not handle any orders that are for customer pickup, you will need to modify each event notification task:
- Add ***order:despatchMethod ne 'PU'*** as shown below as a condition for each of the Detrack actions and all of the active Event Notifications that use the Detrack action
In this example, 'PU' is the code for the despatch method that is marked as a pickup under 'Miscellanous Table Maintenance' - 'Delivery - Despatch Types:
> ⚠️ Do not add Depatch type exclusions to the Despatch Notice event notification
To add more than one delivery type, enter as per the below example:
To prevent POS Cash Sales from being processed via Detrack add an additional validation rule to each event notification task:
*and*
*order:despatchMethod ne ''*
You will then need to trim the agents as per [How do I trim the agents in Frameworks?](https://sterkb.atlassian.net/wiki/pages/createpage.action?spaceKey=DRAFTAQS&title=How%20do%20I%20trim%20the%20agents%20in%20Frameworks%3F)
## 3. Create a DETrack Report on all orders for a day
To create a DETrack Report (on all orders for a day) Notification Task and schedule it, perform the following:
1. Click the Frameworks Menu then type **DETrack Report on all orders for a day** or select (**DETrack Report on all orders for a day **from the **System Administration - Event Notifications - Notification Tasks **Frameworks navigation tree).
2. Click the* ***Report Criteria*** *tab to set the report parameters:
| **Parameter** | **Description** |
| --- | --- |
| **From Date, To Date** | Report on all orders submitted or modified for a date/date range |
| **Retrieve and Store POD's** | Enable to allow Frameworks to retrieve POD's from DETrack and save against the Invoice. Refer to [Detrack - Picking and Releasing the Order](https://kb.myframeworks.com.au/space/FRAM/610600027).
> ℹ️ If POD is not being downloaded, user will need to access Detrack dashboard and in the delivery, settings ensure that the tracking status field is enabled for export. |
| **Update Frameworks Orders** | Enable to allow DeTrack to update Frameworks Order with Delivery Status. This will update according to when the scheduled task is set to run as per Step 3 below. |
3. Click the **Schedule** tab to schedule when the DeTrack Report scheduled task should run.
> ✅ Refer to [Scheduled Task - Scheduling and Output](https://kb.myframeworks.com.au/space/FRAM/543523338/Scheduled+Task+-+Scheduling+and+Output) to update this information.
4. Click **Submit** to submit the task.
5. If run now, the **Output** tab displays the results of the completed task. If you ran the task immediately, you can click on the reports generated. If run later, the [Task Scheduler Queue](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405088/Scheduler+Administration#%5BinlineExtension%5DTask-Scheduler-Queue) contains the output.
## 4. Setup email/sms notifications to customers in order to track their Detrack Orders
> ✅ Refer to [Setup & Administration](https://kb.myframeworks.com.au/space/FRAM/596049922/Setup+&+Administration) for information on how to setup email/sms notifications to customers in order to track their Detrack Orders.