---
title: "Truck Tracker - System Administration & Setup"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28392448/Truck%20Tracker%20-%20System%20Administration%20%26%20Setup"
format: markdown
---
# Overview
Before Truck Tracker can be used, the following system administration activities must be completed.
# Prerequisites
The following pre-requisites are required before continuing with the rest of the configuration:
## Task and Event Queue Controllers
1. Frameworks **Activity Task Scheduler Control** and **Notification Event Queue Processor Control** must both be configured and running:
> ✅ Refer to the [Notifications Event Queue Processor Control](https://kb.myframeworks.com.au/space/FRAM/596148225/Notifications+Event+Queue+Processor+Control) and the **Activity Task Scheduler Control **section in the [Scheduler Administration](https://kb.myframeworks.com.au/space/FRAM/596018697/Scheduler+Administration) User Manuals for more information.
2. The system feature code **GNA** must be enabled to allow the **GetSwift Truck Tracker Action** in a Sales Order Notifications. Please contact [Support ](https://kb.myframeworks.com.au/page/support)for assistance in Activating this feature code.
3. Ensure sftp scripts are in **/prostix/bat**, or copy as follows:
```
cp -vp deploy/scripts/M10DMSIReceive.sh deploy/scripts/M10DMSISend.sh /prostix/bat
```
4. Ensure folders are setup on ProStix server, or create them as follows:
```
mkdir -vp /prostix/live/getswift/send/archive /prostix/live/getswift/receive
```
5. **Under Branch** Maintenance ensure the following:
- The Branch flag **Default Order Complete** should be set to **No**
- The **Store ID** must be defined for Getswift to validate the sending of orders.
> ✅ Refer to the [Branch Maintenance](https://kb.myframeworks.com.au/space/FRAM/542484345/Branch+Maintenance) User Manual for more information.
# System Configuration
1. Ensure the Getswift table installers **installFW5609, FW5609-1** and **FW5609-2** have been run via the Frameworks **Miscellaneous Table Installer**. These should run automatically and create the below Validations which will need to be made active.
## Miscellaneous Table Maintenance
Ensure the below values are configured within Miscellaneous Tables in Frameworks:
1. Misc Table: GetSwift FTP Login settings: FTP settings for the FTP scripts
Hostname = [sftp.mitre10.com.au](http://sftp.mitre10.com.au)
SFTP port = 64873
User = sftp store ID as supplied by IHG
Password = sftp password as supplied by IHG
2. Misc Table: GetSwift Directories: Directories to use to store the export files
3. Misc Table: GetSwift FTP Scripts: Path and script to use to transfer files set as per below:
**Email address for errors**: Email address to use to send error notifications to the users when a notification fails. Leave this field blank to suppress email notifications.
4. Configure Requested Delivery Times
This is part of the sign-up process for Truck Tracker where they define the windows they want.
## Additional Validations Configuration
Within Miscellaneous Table Maintenance, a list containing dynamic validations for Track Trucker can be tailored to ensure Delivery Details when placing orders adhere to strict validation rules.
| **Validation Field** | **Explanation of rules** |
| --- | --- |
| **Code** | This is the unique identifier that consists of two parts separated by a dash '-'. |
| **Description** | This is used as part of the error message if the validation fails. |
| **Active** | If not active, the validation will not be applied to that field |
| **Minimum length** | Counts the number of letters or digits and fails if there are less than the minimum |
| **Maximum length** | Counts the number of letters or digits and fails if there are more than the maximum |
| **Mandatory Length** | Counts the number of letters or digits and fails if there are more or less than the mandatory length |
| **Valid Characters** | Checks to see if the data captured contains only the characters specified. There are three shortcuts that use the tokens: [a-z] = all alpha, [0-9] = all numerics, [space] to indicate spaces are allowed. Any other character should simply be added to the field without any delimiters. For example, if you wanted only alphas and colons then you would use "[a-z];" |
| **Only if Tracking active** | Will ignore the validation if there are no events with actions for Truck Tracker. |
| **Additional Rules** | These are programmed special validations. Currently there are a fixed number of them. They may be combined using a semi-colon ';' |
| **Email Validation=default** | Checks that the email address is valid. Currently there is only one type of validation, but there is provision for any new version |
| **Valid Prefix=x,x,x** | Checks that the prefix is one of the prefixes in the comma-seperated list. The list may contain different lengths for each entry. |
| **Enforce Valid Stat=true** | Checks that the State is in the list of valid states using the (State) misc table list |
| **Allow Past Dates=false** | Prevents dates in the past. Assumes the value is a date or date/time but will not create an error if it is not. |
## System flags/settings
| **Flag** | **Description** | **Default Value** | **Miscellaneous Value** |
| --- | --- | --- | --- |
| **FWGSVer** | FIle Version Number | 1 | Integer |
| **FWCountry** | Country name for GetSwift Exports | Australia | Character |
| **FWGSDir** | Directory that will hold the GetSwift Export data | /prostix/live/getswift | Character |
| **FWConfirm** | Enable Order confirmation flag | set to yes | Flags |
## Notification Events
The following Notification events are triggered by Frameworks and .xml confirmations are sent to Truck Tracker:
| **Event** | **Description** |
| --- | --- |
| **OrderConfirmation** | Sales order confirmation |
| **DespatchConfirmation** | Confirmation order has been despatched |
| **DispatchNotice** | notice for orders being despatched |
| **SaleOrderReqDelivery** | Orders where Delivery Data has passed |
| **OrderBackOrdered** | Back Order notification |
| **OrderModified** | Notification when order is modified |
| **SalesOrderInvoice** | Confirmation order has been invoiced |
Configuring the Notification Event via [Creating Events & Subscribing Users, Internal Staff or Third ](https://kb.myframeworks.com.au/space/FRAM/596049922/Setup+&+Administration#Event-Notifications-consists-of-the-following-options/activities:)Parties using the **Event Definition Maintenance** menu within Frameworks.
### Excluding Pickup Despatch Types from being sent to Truck Tracker
When the notifications for GetSwift 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 GetSwift. 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 GetSwift 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 GetSwift actions and all of the active Event Notifications that use the GetSwfit 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:
To add more than one delivery type, enter as per the below example:
To prevent POS Cash Sales from being processed via Getswift 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=USAFram&title=How%20do%20I%20trim%20the%20agents%20in%20Frameworks%3F)
> ℹ️
> ℹ️ **Note: **Timing agents is not required for OE12 environments.
# Additional Information
> ✅ Refer the [Frameworks Automated Notification System](https://kb.myframeworks.com.au/space/FRAM/542779149/Frameworks+Automated+Notification+System) Administrator Guides for additional information.