KeystoneIntranet - User contributions [en]

Keystone Cloud Tunnel (Cloudflare)

2026-08-13T13:12:34Z

Hhildreth: /* Website Setup */

==Introduction==

The Keystone Cloud Tunnel (Cloudflare) is a reverse-proxy that allows Keystone Online and third parties to securely access the resources provided by KServer without requiring one or more ports to be opened through the customer's firewall. It is a direct replacement for the previous Keystone Relay which has been deprecated and will eventually be phased out entirely.

Because Keystone Cloud Tunnel is based on Cloudflare Tunnels, some preparation steps must be done when setting up Keystone Cloud Tunnel on a customer system for the first time.

==Preparation==

===Creating a New Tunnel===

Creating a new tunnel requires several steps. These steps have been consolidated into a single Windows Command Batch file. Currently, this resides on the Keystone Internal Build Testing server (192.168.2.232)

# Connect to the internal build testing server (you can TeamViewer or RDP.)
# Open a Windows Command prompt.
# Type: CD \CCGH\CFTUNNEL
# Type: MAKECT ##### (where ##### is the Keystone serial number for the customer.)
# When complete, you will see something similar to this:
#:[[Image:makect.jpg]]
#* The "Tunnel Name" is the name assigned to the tunnel.
#* The "Tunnel ID" is a unique identifier for the tunnel assigned by Cloudflare.
#* The "Output Dir" is the folder created by the batch file that holds the two configuration files (config.yml and KSTunnel.json.)
#* The "DNS Name" is the URL (will be prefixed with "https://") that will be used by external clients to make KServer requests for this customer.

===Recording the Tunnel Configuration===

It is extremely important to record in Keeper the information created by the previous step.

# Download the two configuration files from the "Output Dir" created in the previous step.
# Open a browser and login to Keeper.
# Locate the customer you are working on.
# Click on the "API Credentials" folder (create a new folder if this doesn't already exist.)
#:[[File:Keeper_cloudflare_1.jpg|border]]
# Click the 3 dots to the right of "API Credentials", select "New Record", select "Cloudflare Tunnel" as the record type and enter "Cloudflare Tunnel" as the name:
#:[[Image:Keeper_cloudflare_2.jpg|border]]
# On the record screen, enter the "Tunnel Name" and "Tunnel ID" from the previous step (cut & paste from your command prompt window.) For the KSTunnel.json box, you need to open the KSTunnel.json file that you downloaded and cut & paste the contents of this file into the box:
#:[[Image:Keeper_cloudflare_3.jpg|border]]

==Installation & Configuration of Customer Server==

===New Customer Setup===
Perform the standard Keystone installation process. When the screen appears where you select which services to install, be sure that Keystone Cloud Tunnel is checked. When you click Next, you will see the following prompt:
:::image goes here
At this point, upload the two files downloaded after the tunnel was created into the C:\ProgramData\GivenHansco\Keystone\Settings folder (this folder should already have been created by the setup program). Once the files are uploaded, click Next and proceed normally.

===Existing Customer Setup===
# Download the web update on the server and release it so workstations will update. Once released '''do not''' Restart Keystone.
# Install the update on the server using the EXE. This will show the services screen during the update where Keystone Cloud Tunnel can be selected.
# Make sure the files are in the settings folder before you install the service.
# C:\ProgramData\GivenHansco\Keystone\Settings folder

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloudflare Setup (https://ksXXXXXX.ghapi.net -- see example below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool) (If existing API key is present you can leave alone)
# Remove Keystone Relay Connection field
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

==Last Steps==
# Make sure Paul is aware of the customers that are moved from Keystone Relay
# '''(If a customer has a third party interface do not remove the relay at this time -- 8.6.26)''' Make sure the relay is disabled or uninstalled Command prompt - (sc delete ksrelay_service)

Keystone Cloud Tunnel (Cloudflare)

2026-08-13T13:11:26Z

Hhildreth: /* New Customer Setup */

==Introduction==

The Keystone Cloud Tunnel (Cloudflare) is a reverse-proxy that allows Keystone Online and third parties to securely access the resources provided by KServer without requiring one or more ports to be opened through the customer's firewall. It is a direct replacement for the previous Keystone Relay which has been deprecated and will eventually be phased out entirely.

Because Keystone Cloud Tunnel is based on Cloudflare Tunnels, some preparation steps must be done when setting up Keystone Cloud Tunnel on a customer system for the first time.

==Preparation==

===Creating a New Tunnel===

Creating a new tunnel requires several steps. These steps have been consolidated into a single Windows Command Batch file. Currently, this resides on the Keystone Internal Build Testing server (192.168.2.232)

# Connect to the internal build testing server (you can TeamViewer or RDP.)
# Open a Windows Command prompt.
# Type: CD \CCGH\CFTUNNEL
# Type: MAKECT ##### (where ##### is the Keystone serial number for the customer.)
# When complete, you will see something similar to this:
#:[[Image:makect.jpg]]
#* The "Tunnel Name" is the name assigned to the tunnel.
#* The "Tunnel ID" is a unique identifier for the tunnel assigned by Cloudflare.
#* The "Output Dir" is the folder created by the batch file that holds the two configuration files (config.yml and KSTunnel.json.)
#* The "DNS Name" is the URL (will be prefixed with "https://") that will be used by external clients to make KServer requests for this customer.

===Recording the Tunnel Configuration===

It is extremely important to record in Keeper the information created by the previous step.

# Download the two configuration files from the "Output Dir" created in the previous step.
# Open a browser and login to Keeper.
# Locate the customer you are working on.
# Click on the "API Credentials" folder (create a new folder if this doesn't already exist.)
#:[[File:Keeper_cloudflare_1.jpg|border]]
# Click the 3 dots to the right of "API Credentials", select "New Record", select "Cloudflare Tunnel" as the record type and enter "Cloudflare Tunnel" as the name:
#:[[Image:Keeper_cloudflare_2.jpg|border]]
# On the record screen, enter the "Tunnel Name" and "Tunnel ID" from the previous step (cut & paste from your command prompt window.) For the KSTunnel.json box, you need to open the KSTunnel.json file that you downloaded and cut & paste the contents of this file into the box:
#:[[Image:Keeper_cloudflare_3.jpg|border]]

==Installation & Configuration of Customer Server==

===New Customer Setup===
Perform the standard Keystone installation process. When the screen appears where you select which services to install, be sure that Keystone Cloud Tunnel is checked. When you click Next, you will see the following prompt:
:::image goes here
At this point, upload the two files downloaded after the tunnel was created into the C:\ProgramData\GivenHansco\Keystone\Settings folder (this folder should already have been created by the setup program). Once the files are uploaded, click Next and proceed normally.

===Existing Customer Setup===
# Download the web update on the server and release it so workstations will update. Once released '''do not''' Restart Keystone.
# Install the update on the server using the EXE. This will show the services screen during the update where Keystone Cloud Tunnel can be selected.
# Make sure the files are in the settings folder before you install the service.
# C:\ProgramData\GivenHansco\Keystone\Settings folder

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (https://ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool) (If existing API key exists you can leave alone)
# Remove Keystone relay Connection field
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

==Last Steps==
# Make sure Paul is aware of the customers that are moved from Keystone Relay
# '''(If a customer has a third party interface do not remove the relay at this time -- 8.6.26)''' Make sure the relay is disabled or uninstalled Command prompt - (sc delete ksrelay_service)

Keystone Cloud Tunnel (Cloudflare)

2026-08-13T13:10:42Z

Hhildreth: /* Recording the Tunnel Configuration */

==Introduction==

The Keystone Cloud Tunnel (Cloudflare) is a reverse-proxy that allows Keystone Online and third parties to securely access the resources provided by KServer without requiring one or more ports to be opened through the customer's firewall. It is a direct replacement for the previous Keystone Relay which has been deprecated and will eventually be phased out entirely.

Because Keystone Cloud Tunnel is based on Cloudflare Tunnels, some preparation steps must be done when setting up Keystone Cloud Tunnel on a customer system for the first time.

==Preparation==

===Creating a New Tunnel===

Creating a new tunnel requires several steps. These steps have been consolidated into a single Windows Command Batch file. Currently, this resides on the Keystone Internal Build Testing server (192.168.2.232)

# Connect to the internal build testing server (you can TeamViewer or RDP.)
# Open a Windows Command prompt.
# Type: CD \CCGH\CFTUNNEL
# Type: MAKECT ##### (where ##### is the Keystone serial number for the customer.)
# When complete, you will see something similar to this:
#:[[Image:makect.jpg]]
#* The "Tunnel Name" is the name assigned to the tunnel.
#* The "Tunnel ID" is a unique identifier for the tunnel assigned by Cloudflare.
#* The "Output Dir" is the folder created by the batch file that holds the two configuration files (config.yml and KSTunnel.json.)
#* The "DNS Name" is the URL (will be prefixed with "https://") that will be used by external clients to make KServer requests for this customer.

===Recording the Tunnel Configuration===

It is extremely important to record in Keeper the information created by the previous step.

# Download the two configuration files from the "Output Dir" created in the previous step.
# Open a browser and login to Keeper.
# Locate the customer you are working on.
# Click on the "API Credentials" folder (create a new folder if this doesn't already exist.)
#:[[File:Keeper_cloudflare_1.jpg|border]]
# Click the 3 dots to the right of "API Credentials", select "New Record", select "Cloudflare Tunnel" as the record type and enter "Cloudflare Tunnel" as the name:
#:[[Image:Keeper_cloudflare_2.jpg|border]]
# On the record screen, enter the "Tunnel Name" and "Tunnel ID" from the previous step (cut & paste from your command prompt window.) For the KSTunnel.json box, you need to open the KSTunnel.json file that you downloaded and cut & paste the contents of this file into the box:
#:[[Image:Keeper_cloudflare_3.jpg|border]]

==Installation & Configuration of Customer Server==

===New Customer Setup===
Perform the standard Keystone installation process. When the screen appears where you select which services to install, be sure that Keystone Cloud Tunnel is checked. When you click Next, you will see the following prompt:
:::image goes here
At this point, upload the two files downloaded after the tunnel was created into the C:\ProgramData\GivenHansco\Keystone\Settings folder (this folder should already have been created by the setup program.) Once the files are uploaded, click Next and proceed normally.

===Existing Customer Setup===
# Download the web update on the server and release it so workstations will update. Once released '''do not''' Restart Keystone.
# Install the update on the server using the EXE. This will show the services screen during the update where Keystone Cloud Tunnel can be selected.
# Make sure the files are in the settings folder before you install the service.
# C:\ProgramData\GivenHansco\Keystone\Settings folder

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (https://ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool) (If existing API key exists you can leave alone)
# Remove Keystone relay Connection field
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

==Last Steps==
# Make sure Paul is aware of the customers that are moved from Keystone Relay
# '''(If a customer has a third party interface do not remove the relay at this time -- 8.6.26)''' Make sure the relay is disabled or uninstalled Command prompt - (sc delete ksrelay_service)

Keystone Cloud Tunnel (Cloudflare)

2026-08-13T13:09:08Z

Hhildreth: /* Creating a New Tunnel */

==Introduction==

The Keystone Cloud Tunnel (Cloudflare) is a reverse-proxy that allows Keystone Online and third parties to securely access the resources provided by KServer without requiring one or more ports to be opened through the customer's firewall. It is a direct replacement for the previous Keystone Relay which has been deprecated and will eventually be phased out entirely.

Because Keystone Cloud Tunnel is based on Cloudflare Tunnels, some preparation steps must be done when setting up Keystone Cloud Tunnel on a customer system for the first time.

==Preparation==

===Creating a New Tunnel===

Creating a new tunnel requires several steps. These steps have been consolidated into a single Windows Command Batch file. Currently, this resides on the Keystone Internal Build Testing server (192.168.2.232)

# Connect to the internal build testing server (you can TeamViewer or RDP.)
# Open a Windows Command prompt.
# Type: CD \CCGH\CFTUNNEL
# Type: MAKECT ##### (where ##### is the Keystone serial number for the customer.)
# When complete, you will see something similar to this:
#:[[Image:makect.jpg]]
#* The "Tunnel Name" is the name assigned to the tunnel.
#* The "Tunnel ID" is a unique identifier for the tunnel assigned by Cloudflare.
#* The "Output Dir" is the folder created by the batch file that holds the two configuration files (config.yml and KSTunnel.json.)
#* The "DNS Name" is the URL (will be prefixed with "https://") that will be used by external clients to make KServer requests for this customer.

===Recording the Tunnel Configuration===

It is extremely important to record in Keeper the information created by the previous step.

# Download the two configuration files from the "Output Dir" created in the previous step.
# Open a browser and login to Keeper.
# Locate the customer you are working on.
# Click on the "API Credentials" folder (create a new folder if this doesn't already exist.)
#:[[File:Keeper_cloudflare_1.jpg|border]]
# Click the 3 dots to the right of "API Credentials", select "New Record", select "Cloudflare Tunnel" as the record type and enter "Cloudflare Tunnel" as the name:
#:[[Image:Keeper_cloudflare_2.jpg|border]]
# On the record screen, enter the "Tunnel Name" and "Tunnel ID" from the previous step (cut & paste from your command prompt window.) For the KSTunnel.JSON box, you need to open the KSTunnel.json file that you downloaded and cut & paste the contents of this file into the box:
#:[[Image:Keeper_cloudflare_3.jpg|border]]

==Installation & Configuration of Customer Server==

===New Customer Setup===
Perform the standard Keystone installation process. When the screen appears where you select which services to install, be sure that Keystone Cloud Tunnel is checked. When you click Next, you will see the following prompt:
:::image goes here
At this point, upload the two files downloaded after the tunnel was created into the C:\ProgramData\GivenHansco\Keystone\Settings folder (this folder should already have been created by the setup program.) Once the files are uploaded, click Next and proceed normally.

===Existing Customer Setup===
# Download the web update on the server and release it so workstations will update. Once released '''do not''' Restart Keystone.
# Install the update on the server using the EXE. This will show the services screen during the update where Keystone Cloud Tunnel can be selected.
# Make sure the files are in the settings folder before you install the service.
# C:\ProgramData\GivenHansco\Keystone\Settings folder

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (https://ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool) (If existing API key exists you can leave alone)
# Remove Keystone relay Connection field
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

==Last Steps==
# Make sure Paul is aware of the customers that are moved from Keystone Relay
# '''(If a customer has a third party interface do not remove the relay at this time -- 8.6.26)''' Make sure the relay is disabled or uninstalled Command prompt - (sc delete ksrelay_service)

GPS/Status Devices

2026-04-10T14:50:14Z

Hhildreth: /* Integra XML Configuration (TrakIt) */

==Device Aggregator and Server Installation==
*Start command prompt as administartor
*From command prompt run the following commands:
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\ccdeviceserver.exe" -install</PRE>
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\CCDeviceAggregator.exe" -install</PRE>

*Start Services
*Verify that both Keystone Device Server and Keystone Device Aggregator are set to start automatically and are running.

==Device Server Properties==
Right Click Tray Icon 
Device Server ID: DS1

==Device Maintenance Setup==

Description: GPS 
Type: GPS/Status 
Dev Server ID: DS1 (default name)

<PRE>PROTOCOL=GHGPS
IPPORT=52241
KEEPALIVE=N
EOLHEX=04
USESERVERTIME=Y</PRE>

==Custom Truck Modes==

Introduced in Keystone 2.7.19, custom truck modes allow miscellaneous truck status information to be gathered from the GPS system and presented on the Dispatch Schedule screen. These modes must be defined in the GPS setup for the GPS device as well as in the Keystone DITCUSTSTAT table. To specify a custom truck mode use the following syntax in Device Maintenance for the GPS device:

<PRE>
CUSTOM_EVENT_<n>=<xxx>
</PRE>

where <n> represents the custom truck mode (integer) and <xxx> represents the custom truck mode value from the GPS device (string.)

The DITCUSTSTAT table maps the integer custom truck mode value to a short alphanumeric code and a longer description as follows:

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Field Name
! Field Type
! Description
|-
| CUSTOM_STATUS
| Integer
| Custom Truck Mode Identifier
|-
| STATUS_CODE
| String(6)
| Short code which appears on Dispatch Schedule truck grid
|-
| DESCRIPTION
| String(35)
| Description which appears on Dispatch Schedule status pop-up
|-
| STATUS_COLOR
| Integer (color)
| Color used to display STATUS_CODE and DESCRIPTION on Dispatch Schedule
|-
| SCHEDULE_SEQ
| Integer
| Determines sequence of custom truck modes on schedule screen negative # = highest priority 0 = no mode positive # = lowest priority
|-
| CLEAR_STATUS_COL
| String(100)
| Specifies statuses that will clear this custom truck mode NULL = never clear * = clear on all statuses except 13 (travel) *1*2*3 = clear on status 1, 2 or 3
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Protocol Choices ==

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Protocol
! Device
! Documentation
! Comm Link Type
! Keystone Version
|-
| GHNEXTEL2
| Keystone GPS/(Keystone Nextel Phone)
|
| UDP Server
|
|-
| KEYSTONEGPS
| Keystone GPS (identical to GHNEXTEL2)
|
| UDP Server
|
|-
| TRIMBLEXML
| Trimble (XML)
| [[Media:Trimble_XML_Integration_Interface_2_15_draft.pdf|Trimble XML Integration Interface]]
| MSMQ Server
|
|-
| INTEGRAXML
| TrakIt (Integra XML)
| [[Media:Integra_XML_V2.5.pdf|Integra XML Technical Specification]]
| MSMQ Server
|
|-
| DIGITALFLEETXML
| Digital Fleet (CALIFORNIA/PREVAILING WAGE ONLY -- ONLY USE THIS FOR FROM_DISPATCH DEVICE)
|
| MSMQ Server
|
|-
| TRAKITLEGACY
| TrakIt (Legacy Output)
|
| UDP Server
|
|-
| TRIMBLELEGACY
| Trimble (Legacy Output)
|
| Serial Server
|
|-
| GHGPS
| FileMaker GPS
|
| TCP Server
|
|-
| GHNEXTEL
| Nextel Phone
|
| UDP Server
|
|-
| DINET
| Dinet Status Box
|
| Serial Server
|
|-
| GHARGO
| KEYSTONE GPS w/Argo Modem
|
| TCP Server
|
|-
| GHBLUETREE
| KEYSTONE GPS w/BlueTree Modem
|
| UDP Server
|
|-
| GHDATAREMOTE
| KEYSTONE GPS w/DataRemote Modem
|
| UDP Server
|
|-
| VERIFI
| Verifi Truck Status (XML)
| [[Media:Subscription_API_for_signalling.pdf|Verifi Truck Status XML Interface]] [[Media:Signalling_Response.pdf|Verifi Truck Status XML Response]]
| Polled REST Server
| 3.4.5.6
|-
| ROADKING
| RoadKing GPS (JSON)
|
| HTTP Server
| 3.6.15.5
|-
| OSHKOSH
| Oshkosh Begin/End Pour and Post Pour Wash (JSON)
| [http://lhptwebapi-t.cloudapp.net/Help/Api/GET-v2-AssetReportEvents Oshkosh AssetReportEvents API]
| Polled REST Server
| 4.1.2.2
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

==Protocol Notes==
===Integra XML Configuration (TrakIt)===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is CHECKED):
*fromdispatch
*todispatch

The PC running TrakitWare must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrakitWare.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

* If customer uses DigitalFleet for Prevailing Wage (Like some California customers, i.e. Folsom Ready Mix, and P&L Concrete) then the setup is different

If the customer does Prevailing Wage and needs that information sent to DigitalFleet then in the from_dispatch device we need to set the protocol as DIGITALFLEETXML. This allows the Job Identifier, etc. to be sent to DigitalFleet. However, in the to_dispatch device we need to keep the protocol configured as INTEGRAXML. If it is not, then messages get stuck in the Messaging Queue and are not sent to Keystone. So trucks will not status from statuses/changes coming from DigitalFleet.

If customer uses DigitalFleet and needs batch begin and end times, our Keystone Batch can accomodate this but it has to be setup. DigitalFleet needs to provide a VSC Code, Port Number, and an IP Address. Then Batch configures this in the config file, and sends the begin load and end load times to DigitalFleet.

===Trimble XML Configuration===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is UNCHECKED):
*from_dispatch
*to_dispatch

The PC running TrimExchange must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrimExchange.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Filemaker GPS Startup===
Double Click the GPS Shortcut 
LOGIN: GPS 
Click: Connect 
Minimize 

===Bluetree GPS Modem===

Diagnostics:
<PRE>TELNET <modem_ip> 6070</PRE>
Command to see IP address that modem is connecting to:
<PRE>AT+BRPRDS?</PRE>

===RoadKing GPS Sample JSON Content===
<PRE>
{
"TruckEvent": {
"OrderNumber": "117393",
"TruckNumber": "108",
"Date": "2020/07/30",
"Time": "15:50:34",
"EventCode": "9"
}
}
</PRE>

===Oshkosh Begin/End Pour Sample JSON Content===
<PRE>
[
{
"AssetId": 42490,
"ReportEventTypeId": 7,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T01:16:22",
"Latitude": 43.981525,
"Longitude": -88.545744
},
{
"AssetId": 42490,
"ReportEventTypeId": 8,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T02:15:20",
"Latitude": 43.98158,
"Longitude": -88.545723
}
]
</PRE>

==Sample Configurations==
===Common Device Parameters===
<PRE>
USESERVERTIME=0 ;0=Use time from status message, 1=Substitute current clock time in status message
USEGEOFENCING=0 ;0=Disable geofencing, 1=Use geofencing to determine on job/at plant status
USEODOMETER=1 ;0=Estimate odometer using distance formula, 1=Use odometer field from status message
USEPLANTNO=0 ;0=Ignore plant number from status message, 1=Use plant number from Arrive Plant/In Service status message
ONJOBSTOPTIME=6 ;0=Disable on job stop time, 1=Move to on job status if truck stopped more than x minutes
GPSCOMPANIES=<CoId>[,<CoId>]* ;if truck is not found in current company, check each of the listed companies
; To stop bad signals from showing up on the map, add the following lines. The Lat and Long are for the plant
; and the Radius is in miles. If more than on plant, set the Lat and Long in the center of all the plants.
VALIDLAT=41.98765
VALIDLONG=-78.97650
VALIDRADIUS=150
SETORDERLOCFROMGPS=0 ;0=Ignore GPS coordinates from status message, 1=Set Order GPS coordinates from On Job, Begin Pour, End Pour status messages
ALLOWRETCONC=1 (3.4+) ;0=Ignore returned concrete from status message, 1=Process returned concrete from status message
TRUCKFILTER=<TruckId> (3.5+) ;only statuses for the specified Truck Id will be processed, all other trucks will be ignored (diagnostics)
; Events that can be configured are as follows
EVENT_BEGINLOAD=
EVENT_ENDLOAD=
EVENT_TOJOB=
EVENT_ONJOB=
EVENT_BEGINPOUR=
EVENT_ENDPOUR=
EVENT_RETURNING=
EVENT_ARRIVEPLANT=
EVENT_INSERVICE=
EVENT_OUTOFSERVICE=
EVENT_CLOCKIN=
EVENT_CLOCKOUT=
EVENT_GPS=
EVENT_PRETICKET=
EVENT_DRIVER_CLOCKIN= (2.7+)
EVENT_DRIVER_CLOCKOUT= (2.7+)
EVENT_RETCONC= (3.4+)
EVENT_ADDWATER= (3.4+)
; Custom Truck Modes
; where n = custom truck mode (integer) - defined in DITCUSTSTAT table
; xxx = custom truck mode value from GPS (string)
CUSTOM_EVENT_n=xxx
</PRE>

===Keystone GPS===
This is the modern Windows / Web Version of Keystone GPS used since 2008. Based on the Keystone Nextel system of early 2000s.
<PRE>
PROTOCOL=KEYSTONEGPS
; The following parameters default to the values shown
IPPORT=7002
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===TrakIt (Integra XML)===
<PRE>
PROTOCOL=INTEGRAXML
MSMQFORMATNAME=DIRECT=OS:.\private$\todispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=1
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=9
EVENT_OUTOFSERVICE=10
</PRE>

===Trimble (XML)===
<PRE>
PROTOCOL=TRIMBLEXML
MSMQFORMATNAME=DIRECT=OS:.\private$\to_dispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=LDS
EVENT_ENDLOAD=LDC
EVENT_TOJOB=TJB
EVENT_ONJOB=AJB
EVENT_BEGINPOUR=POU
EVENT_ENDPOUR=EPR
EVENT_RETURNING=TPL
EVENT_ARRIVEPLANT=IYD
EVENT_INSERVICE=ISV
EVENT_OUTOFSERVICE=OSV
</PRE>

When setting up Trimble (XML), you need to also do the following in Windows:

*Ensure that the Windows Message Queuing Server is installed.
[[File:Windows Message Queuing Feature.PNG|600px]]


*Create the necessary message queues to interface with Trimble.
[[File:Message Queues.PNG|600px]]


*Set the properties for the Trimble message queues.
[[File:Queue Properties.PNG|400px]]


===TrakIt (Legacy Output)===
<PRE>
PROTOCOL=TRAKITLEGACY
IPPORT=???
; Event Defaults are shown below
EVENT_ENDLOAD=4
EVENT_TOJOB=5
EVENT_ONJOB=6
EVENT_BEGINPOUR=7
EVENT_ENDPOUR=8
EVENT_RETURNING=9
EVENT_ARRIVEPLANT=3
EVENT_CLOCKIN=1
EVENT_CLOCKOUT=11
</PRE>

===Nextel Phone===
<PRE>
PROTOCOL=GHNEXTEL
IPPORT=52242
; Event Defaults are shown below
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=1
EVENT_GPS=0
</PRE>
===Trimble (Legacy Output)===
<PRE>
PROTOCOL=TRIMBLELEGACY
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0A
TIMEOUT=500
; Event Defaults are shown below
EVENT_ENDLOAD=1
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=0
</PRE>
===Dinet Status Box===
<PRE>
PROTOCOL=DINET
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0D
TIMEOUT=500
; Event Defaults are shown below
EVENT_BEGINLOAD=0
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=1
EVENT_OUTOFSERVICE=9
</PRE>
===KEYSTONE GPS w/Argo Modem===
<PRE>
PROTOCOL=GHARGO
IPPORT=52243
EOLHEX=23
; Event Defaults are shown below
EVENT_INSERVICE=511
EVENT_BEGINPOUR=521
EVENT_ENDPOUR=531
EVENT_GPS=602
</PRE>

===KEYSTONE GPS w/BlueTree Modem===
<PRE>
PROTOCOL=GHBLUETREE
IPPORT=52242
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=1
</PRE>
===KEYSTONE GPS w/DataRemote Modem===
<PRE>
PROTOCOL=GHDATAREMOTE
IPPORT=52243
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=0
</PRE>
===FileMaker GPS===
<PRE>
PROTOCOL=GHGPS
IPPORT=52241
EOLHEX=0D0A
KEEPALIVE=Y
; Event Defaults are shown below
EVENT_TOJOB=4
EVENT_ONJOB=5
EVENT_BEGINPOUR=1
EVENT_ENDPOUR=2
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=7
EVENT_INSERVICE=3
EVENT_OUTOFSERVICE=8
EVENT_GPS=0
</PRE>

===Verifi Truck Status===
<PRE>
PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.0/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=********************
</PRE>

===RoadKing GPS Status===
<PRE>
PROTOCOL=ROADKING
; The following parameters default to the values shown
URL=/roadking/gps
IPPORT=7003
KEEPALIVE=1
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===Oshkosh Begin/End Pour and Post Pour Wash===
<PRE>
PROTOCOL=OSHKOSH
TIMEOUT=60000
; The following parameters default to the values shown
ROOTURL=https://api.lhptelematics.com/v2/
AUTHUSERNAME=********************
AUTHPASSWORD=********************
MAXPOURMINS=120
; Event Defaults are shown below
EVENT_BEGINPOUR=8
EVENT_ENDPOUR=9
EVENT_BEGINPOSTPOURWASH=10
EVENT_ENDPOSTPOURWASH=11
</PRE>

==Keystone ODBC Configuration (for Keystone GPS support)==

'''NOTE'''
ODBC is no longer used by Keystone GPS. Keystone GPS now uses a REST call. Remove Old ODBC connections where possible.

Install the InterBase ODBC Driver.

Use the 32-bit version of the Windows ODBC Administrator. (On 64-bit Windows you must run the ODBCAD32.EXE located in C:\Windows\SysWOW64.)

Create a new System DSN by clicking the "Add" button.

Enter the appropriate configuration information. Be sure to check the "read" box in the Transaction Options group.

Click the "Test connection" button before saving to verify that the database connection is valid.

Quote Form Fields

2026-04-03T18:09:00Z

Hhildreth: /* Selected Fields */

Quote form Fields
(Oct. 10, 2019 ver. 3.6)

Part of [[Keystone Forms]]

===Selected Fields===

<PRE>
CAST(' + IntToStr(i) + ' AS INTEGER) LOCPRODCLASS,
QH.PROSPECT_NO, QH.JOB_PO_LOC, QH.SALESPERSON, QC.D_AND_B_RATING,
QH.FOLLOW_UP_DATE, QH.WON_LOST_FLAG, QH.REASON_CODE,
QH.QUOTE_DATE, QH.LAST_REVISED_DATE,
QH.EXPIRATION_DATE, QH.SESSION_NO, QH.TRANS_NO, QD.LINE_NO, QD.UNIT_OF_MEASURE,
QH.*, QD.*,
QC.NAME,
QC.ADDRESS_1,
QC.ADDRESS_2,
QC.CITY,
QC.STATE,
QC.ZIP,
QC.CLASS,
QC.D_AND_B_RATING,
QC.PHONE_NO CUST_PHONE_NO,
QC.FAX_NO CUST_FAX_NO,
(0) TAX_RATE,
SL.DESCRIPTION SLSPN_NAME,
SL.JOB_TITLE SLSPN_JOB_TITLE,
SL.PHONE_NO SLSPN_PHONE_NO,
SL.CELL_NO SLSPN_CELL_NO,
SL.FAX_NO SLSPN_FAX_NO,
SL.EMAIL SLSPN_EMAIL,
SL.USER_1 SLSPN_USER_1,
SL.USER_2 SLSPN_USER_2,
SL.SIGNATURE_IMAGE SL_SIGNATURE_IMAGE,
SL.SIGNATURE_IMAGE_EXT SL_SIGNATURE_IMAGE_EXT,
CT.DESCRIPTION TERMS_DESC,
PL.PLANT_NAME, PL.PLANT_SCREEN_ID,
PL.ADDRESS_1 PLANT_ADDRESS_1, PL.ADDRESS_2 PLANT_ADDRESS_2,
PL.PHONE_NO PLANT_PHONE_NO,
PR.PRODUCT_TYPE, PR.PLANT_NO PROD_PLANT_NO,
PL2.PLANT_NAME PROD_PLANT_NAME, PL2.PLANT_SCREEN_ID PROD_PLANT_SCREEN_ID,
UC.DESCRIPTION USAGE_DESC
FROM ' + VIEW_QTPROSP_CUST_LIST + ' QC
INNER JOIN ' + TBL_QTJOBHD + ' QH ON (QH.PROSPECT_NO = QC.PROSPECT_NO)
INNER JOIN ' + TBL_QTJOBDT + ' QD ON (QH.SESSION_NO = QD.SESSION_NO) AND (QH.TRANS_NO = QD.TRANS_NO)
LEFT OUTER JOIN ' + TBL_ARSLSPER + ' SL ON (QH.SALESPERSON = SL.CLASS_NO)
LEFT OUTER JOIN ' + TBL_ARCTMCLS + ' CT ON (QH.TERMS_CLASS = CT.CLASS_NO)
LEFT OUTER JOIN ' + TBL_ARPROD + ' PR ON (PR.PRODUCT_CODE = QD.PRODUCT_CODE)
LEFT OUTER JOIN ' + TBL_ARPLANT + ' PL ON (PL.PLANT_NO = QH.PLANT_NO)
LEFT OUTER JOIN ' + TBL_ARPLANT + ' PL2 ON (PL2.PLANT_NO = PR.PLANT_NO)
LEFT OUTER JOIN ' + TBL_DIUSECLS + ' UC ON (UC.CLASS_NO = QH.USAGE_TYPE)
PROD_DESCRIPTION_1 (4.7.4)
PROD_DESCRIPTION_2 (4.7.4)

*To Remove Price or QTY - Example Below*
IFNOT COND_COMMENT
COLUMN 52 FORMAT #####.00 FIELD QTY_ORDERED
COLUMN 61 FORMAT ####.000 FIELD UNIT_PRICE
</PRE>

===Calculated Fields===
<PRE>
CALC_CUSTADDR1
CALC_CUSTADDR2
CALC_CUSTADDR3
CALC_CUSTADDR4
CALC_RETADDR1
CALC_RETADDR2
CALC_RETADDR3
CALC_RETADDR4
CALC_SYSDATE
CALC_ORDTAXABLE
CALC_ORDNONTAX
CALC_ORDSUBTOTAL
CALC_ORDTAXTOTAL
CALC_ORDTOTAL
CALC_LISTSUBTOTAL
CALC_LISTTAXTOTAL
CALC_LISTTOTAL
CALC_SAVINGS
CALC_DISCOUNT
CALC_COSTTOTAL
CALC_PROFIT
COND_PRTRETADDR
COND_INTERNAL
COND_PRTLISTS
CALC_USERID
CALC_EXTPRICE
CALC_DISC_UNITPRICE
CALC_DISC_EXTPRICE
COND_COMMENT
CALC_DISCTOTAL
CALC_DISC_ORDSUBTOTAL
CALC_DISC_ORDTOTAL
CALC_UNIT_DISC
CALC_UNIT_TAX
CALC_UNIT_NET
CONDITION_1
CONDITION_2
CONDITION_3
CONDITION_4
CONDITION_5
CONDITION_6
CONDITION_7
CONDITION_8
CONDITIONS (LEFT 80 - FORMAT MEMO)
CALC_DISCTAXTOTAL
CALC_DISCTAX_ORDTOTAL
CALC_DISCSAVINGS
COND_PRODTYPE_MIX
COND_PRODTYPE_ING
COND_PRODTYPE_AGG
COND_PRODTYPE_DEL
CALC_UMS
CALC_UMSTOTAL
COND_PRODUCTTOTALS
CALC_UMSTOTALLINE (AFTER DETAIL)
CONTACT_EMAIL
</PRE>

===Salesperson Signature Image===

To print the salesperson's signature image on the quote form, use this line in the form file:

<pre>
COLUMN 1 LEFT 20 IMAGEFIELD SL_SIGNATURE SALESPERSON
^^^^^^^^^^^ -- the field in the quote table representing the Salesperson Id
^^^^^^^^^^^^ -- this specifies the salesperson signature image
^^ -- controls the horizontal width of the signature image
</pre>

Quote Form Fields

2025-04-02T17:40:15Z

Hhildreth: /* Selected Fields */

Quote form Fields
(Oct. 10, 2019 ver. 3.6)

===Selected Fields===

<PRE>
CAST(' + IntToStr(i) + ' AS INTEGER) LOCPRODCLASS,
QH.PROSPECT_NO, QH.JOB_PO_LOC, QH.SALESPERSON, QC.D_AND_B_RATING,
QH.FOLLOW_UP_DATE, QH.WON_LOST_FLAG, QH.REASON_CODE,
QH.QUOTE_DATE, QH.LAST_REVISED_DATE,
QH.EXPIRATION_DATE, QH.SESSION_NO, QH.TRANS_NO, QD.LINE_NO,
QH.*, QD.*,
QC.NAME,
QC.ADDRESS_1,
QC.ADDRESS_2,
QC.CITY,
QC.STATE,
QC.ZIP,
QC.CLASS,
QC.D_AND_B_RATING,
QC.PHONE_NO CUST_PHONE_NO,
QC.FAX_NO CUST_FAX_NO,
(0) TAX_RATE,
SL.DESCRIPTION SLSPN_NAME,
SL.JOB_TITLE SLSPN_JOB_TITLE,
SL.PHONE_NO SLSPN_PHONE_NO,
SL.CELL_NO SLSPN_CELL_NO,
SL.FAX_NO SLSPN_FAX_NO,
SL.EMAIL SLSPN_EMAIL,
SL.USER_1 SLSPN_USER_1,
SL.USER_2 SLSPN_USER_2,
SL.SIGNATURE_IMAGE SL_SIGNATURE_IMAGE,
SL.SIGNATURE_IMAGE_EXT SL_SIGNATURE_IMAGE_EXT,
CT.DESCRIPTION TERMS_DESC,
PL.PLANT_NAME, PL.PLANT_SCREEN_ID,
PL.ADDRESS_1 PLANT_ADDRESS_1, PL.ADDRESS_2 PLANT_ADDRESS_2,
PL.PHONE_NO PLANT_PHONE_NO,
PR.PRODUCT_TYPE, PR.PLANT_NO PROD_PLANT_NO,
PL2.PLANT_NAME PROD_PLANT_NAME, PL2.PLANT_SCREEN_ID PROD_PLANT_SCREEN_ID,
UC.DESCRIPTION USAGE_DESC
FROM ' + VIEW_QTPROSP_CUST_LIST + ' QC
INNER JOIN ' + TBL_QTJOBHD + ' QH ON (QH.PROSPECT_NO = QC.PROSPECT_NO)
INNER JOIN ' + TBL_QTJOBDT + ' QD ON (QH.SESSION_NO = QD.SESSION_NO) AND (QH.TRANS_NO = QD.TRANS_NO)
LEFT OUTER JOIN ' + TBL_ARSLSPER + ' SL ON (QH.SALESPERSON = SL.CLASS_NO)
LEFT OUTER JOIN ' + TBL_ARCTMCLS + ' CT ON (QH.TERMS_CLASS = CT.CLASS_NO)
LEFT OUTER JOIN ' + TBL_ARPROD + ' PR ON (PR.PRODUCT_CODE = QD.PRODUCT_CODE)
LEFT OUTER JOIN ' + TBL_ARPLANT + ' PL ON (PL.PLANT_NO = QH.PLANT_NO)
LEFT OUTER JOIN ' + TBL_ARPLANT + ' PL2 ON (PL2.PLANT_NO = PR.PLANT_NO)
LEFT OUTER JOIN ' + TBL_DIUSECLS + ' UC ON (UC.CLASS_NO = QH.USAGE_TYPE)
PROD_DESCRIPTION_1 (4.7.4)
PROD_DESCRIPTION_2 (4.7.4)
</PRE>

===Calculated Fields===
<PRE>
CALC_CUSTADDR1
CALC_CUSTADDR2
CALC_CUSTADDR3
CALC_CUSTADDR4
CALC_RETADDR1
CALC_RETADDR2
CALC_RETADDR3
CALC_RETADDR4
CALC_SYSDATE
CALC_ORDTAXABLE
CALC_ORDNONTAX
CALC_ORDSUBTOTAL
CALC_ORDTAXTOTAL
CALC_ORDTOTAL
CALC_LISTSUBTOTAL
CALC_LISTTAXTOTAL
CALC_LISTTOTAL
CALC_SAVINGS
CALC_DISCOUNT
CALC_COSTTOTAL
CALC_PROFIT
COND_PRTRETADDR
COND_INTERNAL
COND_PRTLISTS
CALC_USERID
CALC_EXTPRICE
CALC_DISC_UNITPRICE
CALC_DISC_EXTPRICE
COND_COMMENT
CALC_DISCTOTAL
CALC_DISC_ORDSUBTOTAL
CALC_DISC_ORDTOTAL
CALC_UNIT_DISC
CALC_UNIT_TAX
CALC_UNIT_NET
CONDITION_1
CONDITION_2
CONDITION_3
CONDITION_4
CONDITION_5
CONDITION_6
CONDITION_7
CONDITION_8
CONDITIONS (LEFT 80 - FORMAT MEMO)
CALC_DISCTAXTOTAL
CALC_DISCTAX_ORDTOTAL
CALC_DISCSAVINGS
COND_PRODTYPE_MIX
COND_PRODTYPE_ING
COND_PRODTYPE_AGG
COND_PRODTYPE_DEL
CALC_UMS
CALC_UMSTOTAL
COND_PRODUCTTOTALS
CALC_UMSTOTALLINE (AFTER DETAIL)
CONTACT_EMAIL
</PRE>

===Salesperson Signature Image===

To print the salesperson's signature image on the quote form, use this line in the form file:

<pre>
COLUMN 1 LEFT 20 IMAGEFIELD SL_SIGNATURE SALESPERSON
^^^^^^^^^^^ -- the field in the quote table representing the Salesperson Id
^^^^^^^^^^^^ -- this specifies the salesperson signature image
^^ -- controls the horizontal width of the signature image
</pre>

GPS/Status Devices

2024-12-06T20:13:50Z

Hhildreth: /* Protocol Notes */

==Device Aggregator and Server Installation==
*Start command prompt as administartor
*From command prompt run the following commands:
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\ccdeviceserver.exe" -install</PRE>
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\CCDeviceAggregator.exe" -install</PRE>

*Start Services
*Verify that both Keystone Device Server and Keystone Device Aggregator are set to start automatically and are running.

==Device Server Properties==
Right Click Tray Icon 
Device Server ID: DS1

==Device Maintenance Setup==

Description: GPS 
Type: GPS/Status 
Dev Server ID: DS1 (default name)

<PRE>PROTOCOL=GHGPS
IPPORT=52241
KEEPALIVE=N
EOLHEX=04
USESERVERTIME=Y</PRE>

==Custom Truck Modes==

Introduced in Keystone 2.7.19, custom truck modes allow miscellaneous truck status information to be gathered from the GPS system and presented on the Dispatch Schedule screen. These modes must be defined in the GPS setup for the GPS device as well as in the Keystone DITCUSTSTAT table. To specify a custom truck mode use the following syntax in Device Maintenance for the GPS device:

<PRE>
CUSTOM_EVENT_<n>=<xxx>
</PRE>

where <n> represents the custom truck mode (integer) and <xxx> represents the custom truck mode value from the GPS device (string.)

The DITCUSTSTAT table maps the integer custom truck mode value to a short alphanumeric code and a longer description as follows:

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Field Name
! Field Type
! Description
|-
| CUSTOM_STATUS
| Integer
| Custom Truck Mode Identifier
|-
| STATUS_CODE
| String(6)
| Short code which appears on Dispatch Schedule truck grid
|-
| DESCRIPTION
| String(35)
| Description which appears on Dispatch Schedule status pop-up
|-
| STATUS_COLOR
| Integer (color)
| Color used to display STATUS_CODE and DESCRIPTION on Dispatch Schedule
|-
| SCHEDULE_SEQ
| Integer
| Determines sequence of custom truck modes on schedule screen negative # = highest priority 0 = no mode positive # = lowest priority
|-
| CLEAR_STATUS_COL
| String(100)
| Specifies statuses that will clear this custom truck mode NULL = never clear * = clear on all statuses except 13 (travel) *1*2*3 = clear on status 1, 2 or 3
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Protocol Choices ==

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Protocol
! Device
! Documentation
! Comm Link Type
! Keystone Version
|-
| GHNEXTEL2
| Keystone GPS/(Keystone Nextel Phone)
|
| UDP Server
|
|-
| KEYSTONEGPS
| Keystone GPS (identical to GHNEXTEL2)
|
| UDP Server
|
|-
| TRIMBLEXML
| Trimble (XML)
| [[Media:Trimble_XML_Integration_Interface_2_15_draft.pdf|Trimble XML Integration Interface]]
| MSMQ Server
|
|-
| INTEGRAXML
| TrakIt (Integra XML)
| [[Media:Integra_XML_V2.5.pdf|Integra XML Technical Specification]]
| MSMQ Server
|
|-
| DIGITALFLEETXML
| Digital Fleet (CALIFORNIA/PREVAILING WAGE ONLY -- ONLY USE THIS FOR FROM_DISPATCH DEVICE)
|
| MSMQ Server
|
|-
| TRAKITLEGACY
| TrakIt (Legacy Output)
|
| UDP Server
|
|-
| TRIMBLELEGACY
| Trimble (Legacy Output)
|
| Serial Server
|
|-
| GHGPS
| FileMaker GPS
|
| TCP Server
|
|-
| GHNEXTEL
| Nextel Phone
|
| UDP Server
|
|-
| DINET
| Dinet Status Box
|
| Serial Server
|
|-
| GHARGO
| KEYSTONE GPS w/Argo Modem
|
| TCP Server
|
|-
| GHBLUETREE
| KEYSTONE GPS w/BlueTree Modem
|
| UDP Server
|
|-
| GHDATAREMOTE
| KEYSTONE GPS w/DataRemote Modem
|
| UDP Server
|
|-
| VERIFI
| Verifi Truck Status (XML)
| [[Media:Subscription_API_for_signalling.pdf|Verifi Truck Status XML Interface]] [[Media:Signalling_Response.pdf|Verifi Truck Status XML Response]]
| Polled REST Server
| 3.4.5.6
|-
| ROADKING
| RoadKing GPS (JSON)
|
| HTTP Server
| 3.6.15.5
|-
| OSHKOSH
| Oshkosh Begin/End Pour and Post Pour Wash (JSON)
| [http://lhptwebapi-t.cloudapp.net/Help/Api/GET-v2-AssetReportEvents Oshkosh AssetReportEvents API]
| Polled REST Server
| 4.1.2.2
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

==Protocol Notes==
===Integra XML Configuration (TrakIt)===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is CHECKED):
*fromdispatch
*todispatch

The PC running TrakitWare must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrakitWare.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

* If customer uses DigitalFleet for Prevailing Wage (Like some California customers, i.e. Folsom Ready Mix, and P&L Concrete) then the setup is different

If the customer does Prevailing Wage and needs that information sent to DigitalFleet then in the from_dispatch device we need to set the protocol as DIGITALFLEETXML. This allows the Job Identifier, etc. to be sent to DigitalFleet. However, in the to_dispatch device we need to keep the protocol configured as INTEGRAXML. If it is not, then messages get stuck in the Messaging Queue and are not sent to Keystone. So trucks will not status from statuses/changes coming from DigitalFleet.

===Trimble XML Configuration===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is UNCHECKED):
*from_dispatch
*to_dispatch

The PC running TrimExchange must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrimExchange.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Filemaker GPS Startup===
Double Click the GPS Shortcut 
LOGIN: GPS 
Click: Connect 
Minimize 

===Bluetree GPS Modem===

Diagnostics:
<PRE>TELNET <modem_ip> 6070</PRE>
Command to see IP address that modem is connecting to:
<PRE>AT+BRPRDS?</PRE>

===RoadKing GPS Sample JSON Content===
<PRE>
{
"TruckEvent": {
"OrderNumber": "117393",
"TruckNumber": "108",
"Date": "2020/07/30",
"Time": "15:50:34",
"EventCode": "9"
}
}
</PRE>

===Oshkosh Begin/End Pour Sample JSON Content===
<PRE>
[
{
"AssetId": 42490,
"ReportEventTypeId": 7,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T01:16:22",
"Latitude": 43.981525,
"Longitude": -88.545744
},
{
"AssetId": 42490,
"ReportEventTypeId": 8,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T02:15:20",
"Latitude": 43.98158,
"Longitude": -88.545723
}
]
</PRE>

==Sample Configurations==
===Common Device Parameters===
<PRE>
USESERVERTIME=0 ;0=Use time from status message, 1=Substitute current clock time in status message
USEGEOFENCING=0 ;0=Disable geofencing, 1=Use geofencing to determine on job/at plant status
USEODOMETER=1 ;0=Estimate odometer using distance formula, 1=Use odometer field from status message
USEPLANTNO=0 ;0=Ignore plant number from status message, 1=Use plant number from Arrive Plant/In Service status message
ONJOBSTOPTIME=6 ;0=Disable on job stop time, 1=Move to on job status if truck stopped more than x minutes
GPSCOMPANIES=<CoId>[,<CoId>]* ;if truck is not found in current company, check each of the listed companies
; To stop bad signals from showing up on the map, add the following lines. The Lat and Long are for the plant
; and the Radius is in miles. If more than on plant, set the Lat and Long in the center of all the plants.
VALIDLAT=41.98765
VALIDLONG=-78.97650
VALIDRADIUS=150
SETORDERLOCFROMGPS=0 ;0=Ignore GPS coordinates from status message, 1=Set Order GPS coordinates from On Job, Begin Pour, End Pour status messages
ALLOWRETCONC=1 (3.4+) ;0=Ignore returned concrete from status message, 1=Process returned concrete from status message
TRUCKFILTER=<TruckId> (3.5+) ;only statuses for the specified Truck Id will be processed, all other trucks will be ignored (diagnostics)
; Events that can be configured are as follows
EVENT_BEGINLOAD=
EVENT_ENDLOAD=
EVENT_TOJOB=
EVENT_ONJOB=
EVENT_BEGINPOUR=
EVENT_ENDPOUR=
EVENT_RETURNING=
EVENT_ARRIVEPLANT=
EVENT_INSERVICE=
EVENT_OUTOFSERVICE=
EVENT_CLOCKIN=
EVENT_CLOCKOUT=
EVENT_GPS=
EVENT_PRETICKET=
EVENT_DRIVER_CLOCKIN= (2.7+)
EVENT_DRIVER_CLOCKOUT= (2.7+)
EVENT_RETCONC= (3.4+)
EVENT_ADDWATER= (3.4+)
; Custom Truck Modes
; where n = custom truck mode (integer) - defined in DITCUSTSTAT table
; xxx = custom truck mode value from GPS (string)
CUSTOM_EVENT_n=xxx
</PRE>

===Keystone GPS===
This is the modern Windows / Web Version of Keystone GPS used since 2008. Based on the Keystone Nextel system of early 2000s.
<PRE>
PROTOCOL=KEYSTONEGPS
; The following parameters default to the values shown
IPPORT=7002
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===TrakIt (Integra XML)===
<PRE>
PROTOCOL=INTEGRAXML
MSMQFORMATNAME=DIRECT=OS:.\private$\todispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=1
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=9
EVENT_OUTOFSERVICE=10
</PRE>

===Trimble (XML)===
<PRE>
PROTOCOL=TRIMBLEXML
MSMQFORMATNAME=DIRECT=OS:.\private$\to_dispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=LDS
EVENT_ENDLOAD=LDC
EVENT_TOJOB=TJB
EVENT_ONJOB=AJB
EVENT_BEGINPOUR=POU
EVENT_ENDPOUR=EPR
EVENT_RETURNING=TPL
EVENT_ARRIVEPLANT=IYD
EVENT_INSERVICE=ISV
EVENT_OUTOFSERVICE=OSV
</PRE>

When setting up Trimble (XML), you need to also do the following in Windows:

*Ensure that the Windows Message Queuing Server is installed.
[[File:Windows Message Queuing Feature.PNG|600px]]


*Create the necessary message queues to interface with Trimble.
[[File:Message Queues.PNG|600px]]


*Set the properties for the Trimble message queues.
[[File:Queue Properties.PNG|400px]]


===TrakIt (Legacy Output)===
<PRE>
PROTOCOL=TRAKITLEGACY
IPPORT=???
; Event Defaults are shown below
EVENT_ENDLOAD=4
EVENT_TOJOB=5
EVENT_ONJOB=6
EVENT_BEGINPOUR=7
EVENT_ENDPOUR=8
EVENT_RETURNING=9
EVENT_ARRIVEPLANT=3
EVENT_CLOCKIN=1
EVENT_CLOCKOUT=11
</PRE>

===Nextel Phone===
<PRE>
PROTOCOL=GHNEXTEL
IPPORT=52242
; Event Defaults are shown below
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=1
EVENT_GPS=0
</PRE>
===Trimble (Legacy Output)===
<PRE>
PROTOCOL=TRIMBLELEGACY
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0A
TIMEOUT=500
; Event Defaults are shown below
EVENT_ENDLOAD=1
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=0
</PRE>
===Dinet Status Box===
<PRE>
PROTOCOL=DINET
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0D
TIMEOUT=500
; Event Defaults are shown below
EVENT_BEGINLOAD=0
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=1
EVENT_OUTOFSERVICE=9
</PRE>
===KEYSTONE GPS w/Argo Modem===
<PRE>
PROTOCOL=GHARGO
IPPORT=52243
EOLHEX=23
; Event Defaults are shown below
EVENT_INSERVICE=511
EVENT_BEGINPOUR=521
EVENT_ENDPOUR=531
EVENT_GPS=602
</PRE>

===KEYSTONE GPS w/BlueTree Modem===
<PRE>
PROTOCOL=GHBLUETREE
IPPORT=52242
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=1
</PRE>
===KEYSTONE GPS w/DataRemote Modem===
<PRE>
PROTOCOL=GHDATAREMOTE
IPPORT=52243
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=0
</PRE>
===FileMaker GPS===
<PRE>
PROTOCOL=GHGPS
IPPORT=52241
EOLHEX=0D0A
KEEPALIVE=Y
; Event Defaults are shown below
EVENT_TOJOB=4
EVENT_ONJOB=5
EVENT_BEGINPOUR=1
EVENT_ENDPOUR=2
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=7
EVENT_INSERVICE=3
EVENT_OUTOFSERVICE=8
EVENT_GPS=0
</PRE>

===Verifi Truck Status===
<PRE>
PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.0/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=********************
</PRE>

===RoadKing GPS Status===
<PRE>
PROTOCOL=ROADKING
; The following parameters default to the values shown
URL=/roadking/gps
IPPORT=7003
KEEPALIVE=1
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===Oshkosh Begin/End Pour and Post Pour Wash===
<PRE>
PROTOCOL=OSHKOSH
TIMEOUT=60000
; The following parameters default to the values shown
ROOTURL=https://api.lhptelematics.com/v2/
AUTHUSERNAME=********************
AUTHPASSWORD=********************
MAXPOURMINS=120
; Event Defaults are shown below
EVENT_BEGINPOUR=8
EVENT_ENDPOUR=9
EVENT_BEGINPOSTPOURWASH=10
EVENT_ENDPOSTPOURWASH=11
</PRE>

==Keystone ODBC Configuration (for Keystone GPS support)==

'''NOTE'''
ODBC is no longer used by Keystone GPS. Keystone GPS now uses a REST call. Remove Old ODBC connections where possible.

Install the InterBase ODBC Driver.

Use the 32-bit version of the Windows ODBC Administrator. (On 64-bit Windows you must run the ODBCAD32.EXE located in C:\Windows\SysWOW64.)

Create a new System DSN by clicking the "Add" button.

Enter the appropriate configuration information. Be sure to check the "read" box in the Transaction Options group.

Click the "Test connection" button before saving to verify that the database connection is valid.

GPS/Status Devices

2024-12-06T20:05:23Z

Hhildreth: /* Protocol Choices */

==Device Aggregator and Server Installation==
*Start command prompt as administartor
*From command prompt run the following commands:
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\ccdeviceserver.exe" -install</PRE>
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\CCDeviceAggregator.exe" -install</PRE>

*Start Services
*Verify that both Keystone Device Server and Keystone Device Aggregator are set to start automatically and are running.

==Device Server Properties==
Right Click Tray Icon 
Device Server ID: DS1

==Device Maintenance Setup==

Description: GPS 
Type: GPS/Status 
Dev Server ID: DS1 (default name)

<PRE>PROTOCOL=GHGPS
IPPORT=52241
KEEPALIVE=N
EOLHEX=04
USESERVERTIME=Y</PRE>

==Custom Truck Modes==

Introduced in Keystone 2.7.19, custom truck modes allow miscellaneous truck status information to be gathered from the GPS system and presented on the Dispatch Schedule screen. These modes must be defined in the GPS setup for the GPS device as well as in the Keystone DITCUSTSTAT table. To specify a custom truck mode use the following syntax in Device Maintenance for the GPS device:

<PRE>
CUSTOM_EVENT_<n>=<xxx>
</PRE>

where <n> represents the custom truck mode (integer) and <xxx> represents the custom truck mode value from the GPS device (string.)

The DITCUSTSTAT table maps the integer custom truck mode value to a short alphanumeric code and a longer description as follows:

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Field Name
! Field Type
! Description
|-
| CUSTOM_STATUS
| Integer
| Custom Truck Mode Identifier
|-
| STATUS_CODE
| String(6)
| Short code which appears on Dispatch Schedule truck grid
|-
| DESCRIPTION
| String(35)
| Description which appears on Dispatch Schedule status pop-up
|-
| STATUS_COLOR
| Integer (color)
| Color used to display STATUS_CODE and DESCRIPTION on Dispatch Schedule
|-
| SCHEDULE_SEQ
| Integer
| Determines sequence of custom truck modes on schedule screen negative # = highest priority 0 = no mode positive # = lowest priority
|-
| CLEAR_STATUS_COL
| String(100)
| Specifies statuses that will clear this custom truck mode NULL = never clear * = clear on all statuses except 13 (travel) *1*2*3 = clear on status 1, 2 or 3
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Protocol Choices ==

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Protocol
! Device
! Documentation
! Comm Link Type
! Keystone Version
|-
| GHNEXTEL2
| Keystone GPS/(Keystone Nextel Phone)
|
| UDP Server
|
|-
| KEYSTONEGPS
| Keystone GPS (identical to GHNEXTEL2)
|
| UDP Server
|
|-
| TRIMBLEXML
| Trimble (XML)
| [[Media:Trimble_XML_Integration_Interface_2_15_draft.pdf|Trimble XML Integration Interface]]
| MSMQ Server
|
|-
| INTEGRAXML
| TrakIt (Integra XML)
| [[Media:Integra_XML_V2.5.pdf|Integra XML Technical Specification]]
| MSMQ Server
|
|-
| DIGITALFLEETXML
| Digital Fleet (CALIFORNIA/PREVAILING WAGE ONLY -- ONLY USE THIS FOR FROM_DISPATCH DEVICE)
|
| MSMQ Server
|
|-
| TRAKITLEGACY
| TrakIt (Legacy Output)
|
| UDP Server
|
|-
| TRIMBLELEGACY
| Trimble (Legacy Output)
|
| Serial Server
|
|-
| GHGPS
| FileMaker GPS
|
| TCP Server
|
|-
| GHNEXTEL
| Nextel Phone
|
| UDP Server
|
|-
| DINET
| Dinet Status Box
|
| Serial Server
|
|-
| GHARGO
| KEYSTONE GPS w/Argo Modem
|
| TCP Server
|
|-
| GHBLUETREE
| KEYSTONE GPS w/BlueTree Modem
|
| UDP Server
|
|-
| GHDATAREMOTE
| KEYSTONE GPS w/DataRemote Modem
|
| UDP Server
|
|-
| VERIFI
| Verifi Truck Status (XML)
| [[Media:Subscription_API_for_signalling.pdf|Verifi Truck Status XML Interface]] [[Media:Signalling_Response.pdf|Verifi Truck Status XML Response]]
| Polled REST Server
| 3.4.5.6
|-
| ROADKING
| RoadKing GPS (JSON)
|
| HTTP Server
| 3.6.15.5
|-
| OSHKOSH
| Oshkosh Begin/End Pour and Post Pour Wash (JSON)
| [http://lhptwebapi-t.cloudapp.net/Help/Api/GET-v2-AssetReportEvents Oshkosh AssetReportEvents API]
| Polled REST Server
| 4.1.2.2
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

==Protocol Notes==
===Integra XML Configuration (TrakIt)===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is CHECKED):
*fromdispatch
*todispatch

The PC running TrakitWare must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrakitWare.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Trimble XML Configuration===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is UNCHECKED):
*from_dispatch
*to_dispatch

The PC running TrimExchange must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrimExchange.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Filemaker GPS Startup===
Double Click the GPS Shortcut 
LOGIN: GPS 
Click: Connect 
Minimize 

===Bluetree GPS Modem===

Diagnostics:
<PRE>TELNET <modem_ip> 6070</PRE>
Command to see IP address that modem is connecting to:
<PRE>AT+BRPRDS?</PRE>

===RoadKing GPS Sample JSON Content===
<PRE>
{
"TruckEvent": {
"OrderNumber": "117393",
"TruckNumber": "108",
"Date": "2020/07/30",
"Time": "15:50:34",
"EventCode": "9"
}
}
</PRE>

===Oshkosh Begin/End Pour Sample JSON Content===
<PRE>
[
{
"AssetId": 42490,
"ReportEventTypeId": 7,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T01:16:22",
"Latitude": 43.981525,
"Longitude": -88.545744
},
{
"AssetId": 42490,
"ReportEventTypeId": 8,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T02:15:20",
"Latitude": 43.98158,
"Longitude": -88.545723
}
]
</PRE>

==Sample Configurations==
===Common Device Parameters===
<PRE>
USESERVERTIME=0 ;0=Use time from status message, 1=Substitute current clock time in status message
USEGEOFENCING=0 ;0=Disable geofencing, 1=Use geofencing to determine on job/at plant status
USEODOMETER=1 ;0=Estimate odometer using distance formula, 1=Use odometer field from status message
USEPLANTNO=0 ;0=Ignore plant number from status message, 1=Use plant number from Arrive Plant/In Service status message
ONJOBSTOPTIME=6 ;0=Disable on job stop time, 1=Move to on job status if truck stopped more than x minutes
GPSCOMPANIES=<CoId>[,<CoId>]* ;if truck is not found in current company, check each of the listed companies
; To stop bad signals from showing up on the map, add the following lines. The Lat and Long are for the plant
; and the Radius is in miles. If more than on plant, set the Lat and Long in the center of all the plants.
VALIDLAT=41.98765
VALIDLONG=-78.97650
VALIDRADIUS=150
SETORDERLOCFROMGPS=0 ;0=Ignore GPS coordinates from status message, 1=Set Order GPS coordinates from On Job, Begin Pour, End Pour status messages
ALLOWRETCONC=1 (3.4+) ;0=Ignore returned concrete from status message, 1=Process returned concrete from status message
TRUCKFILTER=<TruckId> (3.5+) ;only statuses for the specified Truck Id will be processed, all other trucks will be ignored (diagnostics)
; Events that can be configured are as follows
EVENT_BEGINLOAD=
EVENT_ENDLOAD=
EVENT_TOJOB=
EVENT_ONJOB=
EVENT_BEGINPOUR=
EVENT_ENDPOUR=
EVENT_RETURNING=
EVENT_ARRIVEPLANT=
EVENT_INSERVICE=
EVENT_OUTOFSERVICE=
EVENT_CLOCKIN=
EVENT_CLOCKOUT=
EVENT_GPS=
EVENT_PRETICKET=
EVENT_DRIVER_CLOCKIN= (2.7+)
EVENT_DRIVER_CLOCKOUT= (2.7+)
EVENT_RETCONC= (3.4+)
EVENT_ADDWATER= (3.4+)
; Custom Truck Modes
; where n = custom truck mode (integer) - defined in DITCUSTSTAT table
; xxx = custom truck mode value from GPS (string)
CUSTOM_EVENT_n=xxx
</PRE>

===Keystone GPS===
This is the modern Windows / Web Version of Keystone GPS used since 2008. Based on the Keystone Nextel system of early 2000s.
<PRE>
PROTOCOL=KEYSTONEGPS
; The following parameters default to the values shown
IPPORT=7002
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===TrakIt (Integra XML)===
<PRE>
PROTOCOL=INTEGRAXML
MSMQFORMATNAME=DIRECT=OS:.\private$\todispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=1
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=9
EVENT_OUTOFSERVICE=10
</PRE>

===Trimble (XML)===
<PRE>
PROTOCOL=TRIMBLEXML
MSMQFORMATNAME=DIRECT=OS:.\private$\to_dispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=LDS
EVENT_ENDLOAD=LDC
EVENT_TOJOB=TJB
EVENT_ONJOB=AJB
EVENT_BEGINPOUR=POU
EVENT_ENDPOUR=EPR
EVENT_RETURNING=TPL
EVENT_ARRIVEPLANT=IYD
EVENT_INSERVICE=ISV
EVENT_OUTOFSERVICE=OSV
</PRE>

When setting up Trimble (XML), you need to also do the following in Windows:

*Ensure that the Windows Message Queuing Server is installed.
[[File:Windows Message Queuing Feature.PNG|600px]]


*Create the necessary message queues to interface with Trimble.
[[File:Message Queues.PNG|600px]]


*Set the properties for the Trimble message queues.
[[File:Queue Properties.PNG|400px]]


===TrakIt (Legacy Output)===
<PRE>
PROTOCOL=TRAKITLEGACY
IPPORT=???
; Event Defaults are shown below
EVENT_ENDLOAD=4
EVENT_TOJOB=5
EVENT_ONJOB=6
EVENT_BEGINPOUR=7
EVENT_ENDPOUR=8
EVENT_RETURNING=9
EVENT_ARRIVEPLANT=3
EVENT_CLOCKIN=1
EVENT_CLOCKOUT=11
</PRE>

===Nextel Phone===
<PRE>
PROTOCOL=GHNEXTEL
IPPORT=52242
; Event Defaults are shown below
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=1
EVENT_GPS=0
</PRE>
===Trimble (Legacy Output)===
<PRE>
PROTOCOL=TRIMBLELEGACY
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0A
TIMEOUT=500
; Event Defaults are shown below
EVENT_ENDLOAD=1
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=0
</PRE>
===Dinet Status Box===
<PRE>
PROTOCOL=DINET
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0D
TIMEOUT=500
; Event Defaults are shown below
EVENT_BEGINLOAD=0
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=1
EVENT_OUTOFSERVICE=9
</PRE>
===KEYSTONE GPS w/Argo Modem===
<PRE>
PROTOCOL=GHARGO
IPPORT=52243
EOLHEX=23
; Event Defaults are shown below
EVENT_INSERVICE=511
EVENT_BEGINPOUR=521
EVENT_ENDPOUR=531
EVENT_GPS=602
</PRE>

===KEYSTONE GPS w/BlueTree Modem===
<PRE>
PROTOCOL=GHBLUETREE
IPPORT=52242
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=1
</PRE>
===KEYSTONE GPS w/DataRemote Modem===
<PRE>
PROTOCOL=GHDATAREMOTE
IPPORT=52243
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=0
</PRE>
===FileMaker GPS===
<PRE>
PROTOCOL=GHGPS
IPPORT=52241
EOLHEX=0D0A
KEEPALIVE=Y
; Event Defaults are shown below
EVENT_TOJOB=4
EVENT_ONJOB=5
EVENT_BEGINPOUR=1
EVENT_ENDPOUR=2
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=7
EVENT_INSERVICE=3
EVENT_OUTOFSERVICE=8
EVENT_GPS=0
</PRE>

===Verifi Truck Status===
<PRE>
PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.0/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=********************
</PRE>

===RoadKing GPS Status===
<PRE>
PROTOCOL=ROADKING
; The following parameters default to the values shown
URL=/roadking/gps
IPPORT=7003
KEEPALIVE=1
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===Oshkosh Begin/End Pour and Post Pour Wash===
<PRE>
PROTOCOL=OSHKOSH
TIMEOUT=60000
; The following parameters default to the values shown
ROOTURL=https://api.lhptelematics.com/v2/
AUTHUSERNAME=********************
AUTHPASSWORD=********************
MAXPOURMINS=120
; Event Defaults are shown below
EVENT_BEGINPOUR=8
EVENT_ENDPOUR=9
EVENT_BEGINPOSTPOURWASH=10
EVENT_ENDPOSTPOURWASH=11
</PRE>

==Keystone ODBC Configuration (for Keystone GPS support)==

'''NOTE'''
ODBC is no longer used by Keystone GPS. Keystone GPS now uses a REST call. Remove Old ODBC connections where possible.

Install the InterBase ODBC Driver.

Use the 32-bit version of the Windows ODBC Administrator. (On 64-bit Windows you must run the ODBCAD32.EXE located in C:\Windows\SysWOW64.)

Create a new System DSN by clicking the "Add" button.

Enter the appropriate configuration information. Be sure to check the "read" box in the Transaction Options group.

Click the "Test connection" button before saving to verify that the database connection is valid.

GPS/Status Devices

2024-12-06T20:04:53Z

Hhildreth: /* Protocol Choices */

==Device Aggregator and Server Installation==
*Start command prompt as administartor
*From command prompt run the following commands:
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\ccdeviceserver.exe" -install</PRE>
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\CCDeviceAggregator.exe" -install</PRE>

*Start Services
*Verify that both Keystone Device Server and Keystone Device Aggregator are set to start automatically and are running.

==Device Server Properties==
Right Click Tray Icon 
Device Server ID: DS1

==Device Maintenance Setup==

Description: GPS 
Type: GPS/Status 
Dev Server ID: DS1 (default name)

<PRE>PROTOCOL=GHGPS
IPPORT=52241
KEEPALIVE=N
EOLHEX=04
USESERVERTIME=Y</PRE>

==Custom Truck Modes==

Introduced in Keystone 2.7.19, custom truck modes allow miscellaneous truck status information to be gathered from the GPS system and presented on the Dispatch Schedule screen. These modes must be defined in the GPS setup for the GPS device as well as in the Keystone DITCUSTSTAT table. To specify a custom truck mode use the following syntax in Device Maintenance for the GPS device:

<PRE>
CUSTOM_EVENT_<n>=<xxx>
</PRE>

where <n> represents the custom truck mode (integer) and <xxx> represents the custom truck mode value from the GPS device (string.)

The DITCUSTSTAT table maps the integer custom truck mode value to a short alphanumeric code and a longer description as follows:

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Field Name
! Field Type
! Description
|-
| CUSTOM_STATUS
| Integer
| Custom Truck Mode Identifier
|-
| STATUS_CODE
| String(6)
| Short code which appears on Dispatch Schedule truck grid
|-
| DESCRIPTION
| String(35)
| Description which appears on Dispatch Schedule status pop-up
|-
| STATUS_COLOR
| Integer (color)
| Color used to display STATUS_CODE and DESCRIPTION on Dispatch Schedule
|-
| SCHEDULE_SEQ
| Integer
| Determines sequence of custom truck modes on schedule screen negative # = highest priority 0 = no mode positive # = lowest priority
|-
| CLEAR_STATUS_COL
| String(100)
| Specifies statuses that will clear this custom truck mode NULL = never clear * = clear on all statuses except 13 (travel) *1*2*3 = clear on status 1, 2 or 3
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Protocol Choices ==

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Protocol
! Device
! Documentation
! Comm Link Type
! Keystone Version
|-
| GHNEXTEL2
| Keystone GPS/(Keystone Nextel Phone)
|
| UDP Server
|
|-
| KEYSTONEGPS
| Keystone GPS (identical to GHNEXTEL2)
|
| UDP Server
|
|-
| TRIMBLEXML
| Trimble (XML)
| [[Media:Trimble_XML_Integration_Interface_2_15_draft.pdf|Trimble XML Integration Interface]]
| MSMQ Server
|
|-
| INTEGRAXML
| TrakIt (Integra XML)
| [[Media:Integra_XML_V2.5.pdf|Integra XML Technical Specification]]
| MSMQ Server

|-
| DIGITALFLEETXML
| Digital Fleet (CALIFORNIA/PREVAILING WAGE ONLY -- ONLY USE THIS FOR FROM_DISPATCH DEVICE)
|
| MSMQ Server
|
|-
| TRAKITLEGACY
| TrakIt (Legacy Output)
|
| UDP Server
|
|-
| TRIMBLELEGACY
| Trimble (Legacy Output)
|
| Serial Server
|
|-
| GHGPS
| FileMaker GPS
|
| TCP Server
|
|-
| GHNEXTEL
| Nextel Phone
|
| UDP Server
|
|-
| DINET
| Dinet Status Box
|
| Serial Server
|
|-
| GHARGO
| KEYSTONE GPS w/Argo Modem
|
| TCP Server
|
|-
| GHBLUETREE
| KEYSTONE GPS w/BlueTree Modem
|
| UDP Server
|
|-
| GHDATAREMOTE
| KEYSTONE GPS w/DataRemote Modem
|
| UDP Server
|
|-
| VERIFI
| Verifi Truck Status (XML)
| [[Media:Subscription_API_for_signalling.pdf|Verifi Truck Status XML Interface]] [[Media:Signalling_Response.pdf|Verifi Truck Status XML Response]]
| Polled REST Server
| 3.4.5.6
|-
| ROADKING
| RoadKing GPS (JSON)
|
| HTTP Server
| 3.6.15.5
|-
| OSHKOSH
| Oshkosh Begin/End Pour and Post Pour Wash (JSON)
| [http://lhptwebapi-t.cloudapp.net/Help/Api/GET-v2-AssetReportEvents Oshkosh AssetReportEvents API]
| Polled REST Server
| 4.1.2.2
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

==Protocol Notes==
===Integra XML Configuration (TrakIt)===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is CHECKED):
*fromdispatch
*todispatch

The PC running TrakitWare must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrakitWare.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Trimble XML Configuration===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is UNCHECKED):
*from_dispatch
*to_dispatch

The PC running TrimExchange must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrimExchange.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Filemaker GPS Startup===
Double Click the GPS Shortcut 
LOGIN: GPS 
Click: Connect 
Minimize 

===Bluetree GPS Modem===

Diagnostics:
<PRE>TELNET <modem_ip> 6070</PRE>
Command to see IP address that modem is connecting to:
<PRE>AT+BRPRDS?</PRE>

===RoadKing GPS Sample JSON Content===
<PRE>
{
"TruckEvent": {
"OrderNumber": "117393",
"TruckNumber": "108",
"Date": "2020/07/30",
"Time": "15:50:34",
"EventCode": "9"
}
}
</PRE>

===Oshkosh Begin/End Pour Sample JSON Content===
<PRE>
[
{
"AssetId": 42490,
"ReportEventTypeId": 7,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T01:16:22",
"Latitude": 43.981525,
"Longitude": -88.545744
},
{
"AssetId": 42490,
"ReportEventTypeId": 8,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T02:15:20",
"Latitude": 43.98158,
"Longitude": -88.545723
}
]
</PRE>

==Sample Configurations==
===Common Device Parameters===
<PRE>
USESERVERTIME=0 ;0=Use time from status message, 1=Substitute current clock time in status message
USEGEOFENCING=0 ;0=Disable geofencing, 1=Use geofencing to determine on job/at plant status
USEODOMETER=1 ;0=Estimate odometer using distance formula, 1=Use odometer field from status message
USEPLANTNO=0 ;0=Ignore plant number from status message, 1=Use plant number from Arrive Plant/In Service status message
ONJOBSTOPTIME=6 ;0=Disable on job stop time, 1=Move to on job status if truck stopped more than x minutes
GPSCOMPANIES=<CoId>[,<CoId>]* ;if truck is not found in current company, check each of the listed companies
; To stop bad signals from showing up on the map, add the following lines. The Lat and Long are for the plant
; and the Radius is in miles. If more than on plant, set the Lat and Long in the center of all the plants.
VALIDLAT=41.98765
VALIDLONG=-78.97650
VALIDRADIUS=150
SETORDERLOCFROMGPS=0 ;0=Ignore GPS coordinates from status message, 1=Set Order GPS coordinates from On Job, Begin Pour, End Pour status messages
ALLOWRETCONC=1 (3.4+) ;0=Ignore returned concrete from status message, 1=Process returned concrete from status message
TRUCKFILTER=<TruckId> (3.5+) ;only statuses for the specified Truck Id will be processed, all other trucks will be ignored (diagnostics)
; Events that can be configured are as follows
EVENT_BEGINLOAD=
EVENT_ENDLOAD=
EVENT_TOJOB=
EVENT_ONJOB=
EVENT_BEGINPOUR=
EVENT_ENDPOUR=
EVENT_RETURNING=
EVENT_ARRIVEPLANT=
EVENT_INSERVICE=
EVENT_OUTOFSERVICE=
EVENT_CLOCKIN=
EVENT_CLOCKOUT=
EVENT_GPS=
EVENT_PRETICKET=
EVENT_DRIVER_CLOCKIN= (2.7+)
EVENT_DRIVER_CLOCKOUT= (2.7+)
EVENT_RETCONC= (3.4+)
EVENT_ADDWATER= (3.4+)
; Custom Truck Modes
; where n = custom truck mode (integer) - defined in DITCUSTSTAT table
; xxx = custom truck mode value from GPS (string)
CUSTOM_EVENT_n=xxx
</PRE>

===Keystone GPS===
This is the modern Windows / Web Version of Keystone GPS used since 2008. Based on the Keystone Nextel system of early 2000s.
<PRE>
PROTOCOL=KEYSTONEGPS
; The following parameters default to the values shown
IPPORT=7002
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===TrakIt (Integra XML)===
<PRE>
PROTOCOL=INTEGRAXML
MSMQFORMATNAME=DIRECT=OS:.\private$\todispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=1
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=9
EVENT_OUTOFSERVICE=10
</PRE>

===Trimble (XML)===
<PRE>
PROTOCOL=TRIMBLEXML
MSMQFORMATNAME=DIRECT=OS:.\private$\to_dispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=LDS
EVENT_ENDLOAD=LDC
EVENT_TOJOB=TJB
EVENT_ONJOB=AJB
EVENT_BEGINPOUR=POU
EVENT_ENDPOUR=EPR
EVENT_RETURNING=TPL
EVENT_ARRIVEPLANT=IYD
EVENT_INSERVICE=ISV
EVENT_OUTOFSERVICE=OSV
</PRE>

When setting up Trimble (XML), you need to also do the following in Windows:

*Ensure that the Windows Message Queuing Server is installed.
[[File:Windows Message Queuing Feature.PNG|600px]]


*Create the necessary message queues to interface with Trimble.
[[File:Message Queues.PNG|600px]]


*Set the properties for the Trimble message queues.
[[File:Queue Properties.PNG|400px]]


===TrakIt (Legacy Output)===
<PRE>
PROTOCOL=TRAKITLEGACY
IPPORT=???
; Event Defaults are shown below
EVENT_ENDLOAD=4
EVENT_TOJOB=5
EVENT_ONJOB=6
EVENT_BEGINPOUR=7
EVENT_ENDPOUR=8
EVENT_RETURNING=9
EVENT_ARRIVEPLANT=3
EVENT_CLOCKIN=1
EVENT_CLOCKOUT=11
</PRE>

===Nextel Phone===
<PRE>
PROTOCOL=GHNEXTEL
IPPORT=52242
; Event Defaults are shown below
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=1
EVENT_GPS=0
</PRE>
===Trimble (Legacy Output)===
<PRE>
PROTOCOL=TRIMBLELEGACY
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0A
TIMEOUT=500
; Event Defaults are shown below
EVENT_ENDLOAD=1
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=0
</PRE>
===Dinet Status Box===
<PRE>
PROTOCOL=DINET
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0D
TIMEOUT=500
; Event Defaults are shown below
EVENT_BEGINLOAD=0
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=1
EVENT_OUTOFSERVICE=9
</PRE>
===KEYSTONE GPS w/Argo Modem===
<PRE>
PROTOCOL=GHARGO
IPPORT=52243
EOLHEX=23
; Event Defaults are shown below
EVENT_INSERVICE=511
EVENT_BEGINPOUR=521
EVENT_ENDPOUR=531
EVENT_GPS=602
</PRE>

===KEYSTONE GPS w/BlueTree Modem===
<PRE>
PROTOCOL=GHBLUETREE
IPPORT=52242
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=1
</PRE>
===KEYSTONE GPS w/DataRemote Modem===
<PRE>
PROTOCOL=GHDATAREMOTE
IPPORT=52243
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=0
</PRE>
===FileMaker GPS===
<PRE>
PROTOCOL=GHGPS
IPPORT=52241
EOLHEX=0D0A
KEEPALIVE=Y
; Event Defaults are shown below
EVENT_TOJOB=4
EVENT_ONJOB=5
EVENT_BEGINPOUR=1
EVENT_ENDPOUR=2
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=7
EVENT_INSERVICE=3
EVENT_OUTOFSERVICE=8
EVENT_GPS=0
</PRE>

===Verifi Truck Status===
<PRE>
PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.0/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=********************
</PRE>

===RoadKing GPS Status===
<PRE>
PROTOCOL=ROADKING
; The following parameters default to the values shown
URL=/roadking/gps
IPPORT=7003
KEEPALIVE=1
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===Oshkosh Begin/End Pour and Post Pour Wash===
<PRE>
PROTOCOL=OSHKOSH
TIMEOUT=60000
; The following parameters default to the values shown
ROOTURL=https://api.lhptelematics.com/v2/
AUTHUSERNAME=********************
AUTHPASSWORD=********************
MAXPOURMINS=120
; Event Defaults are shown below
EVENT_BEGINPOUR=8
EVENT_ENDPOUR=9
EVENT_BEGINPOSTPOURWASH=10
EVENT_ENDPOSTPOURWASH=11
</PRE>

==Keystone ODBC Configuration (for Keystone GPS support)==

'''NOTE'''
ODBC is no longer used by Keystone GPS. Keystone GPS now uses a REST call. Remove Old ODBC connections where possible.

Install the InterBase ODBC Driver.

Use the 32-bit version of the Windows ODBC Administrator. (On 64-bit Windows you must run the ODBCAD32.EXE located in C:\Windows\SysWOW64.)

Create a new System DSN by clicking the "Add" button.

Enter the appropriate configuration information. Be sure to check the "read" box in the Transaction Options group.

Click the "Test connection" button before saving to verify that the database connection is valid.

GPS/Status Devices

2024-12-06T20:04:42Z

Hhildreth: /* Protocol Choices */

==Device Aggregator and Server Installation==
*Start command prompt as administartor
*From command prompt run the following commands:
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\ccdeviceserver.exe" -install</PRE>
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\CCDeviceAggregator.exe" -install</PRE>

*Start Services
*Verify that both Keystone Device Server and Keystone Device Aggregator are set to start automatically and are running.

==Device Server Properties==
Right Click Tray Icon 
Device Server ID: DS1

==Device Maintenance Setup==

Description: GPS 
Type: GPS/Status 
Dev Server ID: DS1 (default name)

<PRE>PROTOCOL=GHGPS
IPPORT=52241
KEEPALIVE=N
EOLHEX=04
USESERVERTIME=Y</PRE>

==Custom Truck Modes==

Introduced in Keystone 2.7.19, custom truck modes allow miscellaneous truck status information to be gathered from the GPS system and presented on the Dispatch Schedule screen. These modes must be defined in the GPS setup for the GPS device as well as in the Keystone DITCUSTSTAT table. To specify a custom truck mode use the following syntax in Device Maintenance for the GPS device:

<PRE>
CUSTOM_EVENT_<n>=<xxx>
</PRE>

where <n> represents the custom truck mode (integer) and <xxx> represents the custom truck mode value from the GPS device (string.)

The DITCUSTSTAT table maps the integer custom truck mode value to a short alphanumeric code and a longer description as follows:

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Field Name
! Field Type
! Description
|-
| CUSTOM_STATUS
| Integer
| Custom Truck Mode Identifier
|-
| STATUS_CODE
| String(6)
| Short code which appears on Dispatch Schedule truck grid
|-
| DESCRIPTION
| String(35)
| Description which appears on Dispatch Schedule status pop-up
|-
| STATUS_COLOR
| Integer (color)
| Color used to display STATUS_CODE and DESCRIPTION on Dispatch Schedule
|-
| SCHEDULE_SEQ
| Integer
| Determines sequence of custom truck modes on schedule screen negative # = highest priority 0 = no mode positive # = lowest priority
|-
| CLEAR_STATUS_COL
| String(100)
| Specifies statuses that will clear this custom truck mode NULL = never clear * = clear on all statuses except 13 (travel) *1*2*3 = clear on status 1, 2 or 3
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Protocol Choices ==

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Protocol
! Device
! Documentation
! Comm Link Type
! Keystone Version
|-
| GHNEXTEL2
| Keystone GPS/(Keystone Nextel Phone)
|
| UDP Server
|
|-
| KEYSTONEGPS
| Keystone GPS (identical to GHNEXTEL2)
|
| UDP Server
|
|-
| TRIMBLEXML
| Trimble (XML)
| [[Media:Trimble_XML_Integration_Interface_2_15_draft.pdf|Trimble XML Integration Interface]]
| MSMQ Server
|
|-
| INTEGRAXML
| TrakIt (Integra XML)
| [[Media:Integra_XML_V2.5.pdf|Integra XML Technical Specification]]
| MSMQ Server

|-
| DIGITALFLEETXML
| Digital Fleet (CALIFORNIA/PREVAILING WAGE ONLY -- ONLY USE THIS FOR FROM_DISPATCH DEVICE)
|
| MSMQ Server
|
|-
| TRAKITLEGACY
| TrakIt (Legacy Output)
|
| UDP Server
|
|-
| TRIMBLELEGACY
| Trimble (Legacy Output)
|
| Serial Server
|
|-
| GHGPS
| FileMaker GPS
|
| TCP Server
|
|-
| GHNEXTEL
| Nextel Phone
|
| UDP Server
|
|-
| DINET
| Dinet Status Box
|
| Serial Server
|
|-
| GHARGO
| KEYSTONE GPS w/Argo Modem
|
| TCP Server
|
|-
| GHBLUETREE
| KEYSTONE GPS w/BlueTree Modem
|
| UDP Server
|
|-
| GHDATAREMOTE
| KEYSTONE GPS w/DataRemote Modem
|
| UDP Server
|
|-
| VERIFI
| Verifi Truck Status (XML)
| [[Media:Subscription_API_for_signalling.pdf|Verifi Truck Status XML Interface]] [[Media:Signalling_Response.pdf|Verifi Truck Status XML Response]]
| Polled REST Server
| 3.4.5.6
|-
| ROADKING
| RoadKing GPS (JSON)
|
| HTTP Server
| 3.6.15.5
|-
| OSHKOSH
| Oshkosh Begin/End Pour and Post Pour Wash (JSON)
| [http://lhptwebapi-t.cloudapp.net/Help/Api/GET-v2-AssetReportEvents Oshkosh AssetReportEvents API]
| Polled REST Server
| 4.1.2.2
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

==Protocol Notes==
===Integra XML Configuration (TrakIt)===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is CHECKED):
*fromdispatch
*todispatch

The PC running TrakitWare must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrakitWare.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Trimble XML Configuration===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is UNCHECKED):
*from_dispatch
*to_dispatch

The PC running TrimExchange must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrimExchange.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Filemaker GPS Startup===
Double Click the GPS Shortcut 
LOGIN: GPS 
Click: Connect 
Minimize 

===Bluetree GPS Modem===

Diagnostics:
<PRE>TELNET <modem_ip> 6070</PRE>
Command to see IP address that modem is connecting to:
<PRE>AT+BRPRDS?</PRE>

===RoadKing GPS Sample JSON Content===
<PRE>
{
"TruckEvent": {
"OrderNumber": "117393",
"TruckNumber": "108",
"Date": "2020/07/30",
"Time": "15:50:34",
"EventCode": "9"
}
}
</PRE>

===Oshkosh Begin/End Pour Sample JSON Content===
<PRE>
[
{
"AssetId": 42490,
"ReportEventTypeId": 7,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T01:16:22",
"Latitude": 43.981525,
"Longitude": -88.545744
},
{
"AssetId": 42490,
"ReportEventTypeId": 8,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T02:15:20",
"Latitude": 43.98158,
"Longitude": -88.545723
}
]
</PRE>

==Sample Configurations==
===Common Device Parameters===
<PRE>
USESERVERTIME=0 ;0=Use time from status message, 1=Substitute current clock time in status message
USEGEOFENCING=0 ;0=Disable geofencing, 1=Use geofencing to determine on job/at plant status
USEODOMETER=1 ;0=Estimate odometer using distance formula, 1=Use odometer field from status message
USEPLANTNO=0 ;0=Ignore plant number from status message, 1=Use plant number from Arrive Plant/In Service status message
ONJOBSTOPTIME=6 ;0=Disable on job stop time, 1=Move to on job status if truck stopped more than x minutes
GPSCOMPANIES=<CoId>[,<CoId>]* ;if truck is not found in current company, check each of the listed companies
; To stop bad signals from showing up on the map, add the following lines. The Lat and Long are for the plant
; and the Radius is in miles. If more than on plant, set the Lat and Long in the center of all the plants.
VALIDLAT=41.98765
VALIDLONG=-78.97650
VALIDRADIUS=150
SETORDERLOCFROMGPS=0 ;0=Ignore GPS coordinates from status message, 1=Set Order GPS coordinates from On Job, Begin Pour, End Pour status messages
ALLOWRETCONC=1 (3.4+) ;0=Ignore returned concrete from status message, 1=Process returned concrete from status message
TRUCKFILTER=<TruckId> (3.5+) ;only statuses for the specified Truck Id will be processed, all other trucks will be ignored (diagnostics)
; Events that can be configured are as follows
EVENT_BEGINLOAD=
EVENT_ENDLOAD=
EVENT_TOJOB=
EVENT_ONJOB=
EVENT_BEGINPOUR=
EVENT_ENDPOUR=
EVENT_RETURNING=
EVENT_ARRIVEPLANT=
EVENT_INSERVICE=
EVENT_OUTOFSERVICE=
EVENT_CLOCKIN=
EVENT_CLOCKOUT=
EVENT_GPS=
EVENT_PRETICKET=
EVENT_DRIVER_CLOCKIN= (2.7+)
EVENT_DRIVER_CLOCKOUT= (2.7+)
EVENT_RETCONC= (3.4+)
EVENT_ADDWATER= (3.4+)
; Custom Truck Modes
; where n = custom truck mode (integer) - defined in DITCUSTSTAT table
; xxx = custom truck mode value from GPS (string)
CUSTOM_EVENT_n=xxx
</PRE>

===Keystone GPS===
This is the modern Windows / Web Version of Keystone GPS used since 2008. Based on the Keystone Nextel system of early 2000s.
<PRE>
PROTOCOL=KEYSTONEGPS
; The following parameters default to the values shown
IPPORT=7002
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===TrakIt (Integra XML)===
<PRE>
PROTOCOL=INTEGRAXML
MSMQFORMATNAME=DIRECT=OS:.\private$\todispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=1
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=9
EVENT_OUTOFSERVICE=10
</PRE>

===Trimble (XML)===
<PRE>
PROTOCOL=TRIMBLEXML
MSMQFORMATNAME=DIRECT=OS:.\private$\to_dispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=LDS
EVENT_ENDLOAD=LDC
EVENT_TOJOB=TJB
EVENT_ONJOB=AJB
EVENT_BEGINPOUR=POU
EVENT_ENDPOUR=EPR
EVENT_RETURNING=TPL
EVENT_ARRIVEPLANT=IYD
EVENT_INSERVICE=ISV
EVENT_OUTOFSERVICE=OSV
</PRE>

When setting up Trimble (XML), you need to also do the following in Windows:

*Ensure that the Windows Message Queuing Server is installed.
[[File:Windows Message Queuing Feature.PNG|600px]]


*Create the necessary message queues to interface with Trimble.
[[File:Message Queues.PNG|600px]]


*Set the properties for the Trimble message queues.
[[File:Queue Properties.PNG|400px]]


===TrakIt (Legacy Output)===
<PRE>
PROTOCOL=TRAKITLEGACY
IPPORT=???
; Event Defaults are shown below
EVENT_ENDLOAD=4
EVENT_TOJOB=5
EVENT_ONJOB=6
EVENT_BEGINPOUR=7
EVENT_ENDPOUR=8
EVENT_RETURNING=9
EVENT_ARRIVEPLANT=3
EVENT_CLOCKIN=1
EVENT_CLOCKOUT=11
</PRE>

===Nextel Phone===
<PRE>
PROTOCOL=GHNEXTEL
IPPORT=52242
; Event Defaults are shown below
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=1
EVENT_GPS=0
</PRE>
===Trimble (Legacy Output)===
<PRE>
PROTOCOL=TRIMBLELEGACY
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0A
TIMEOUT=500
; Event Defaults are shown below
EVENT_ENDLOAD=1
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=0
</PRE>
===Dinet Status Box===
<PRE>
PROTOCOL=DINET
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0D
TIMEOUT=500
; Event Defaults are shown below
EVENT_BEGINLOAD=0
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=1
EVENT_OUTOFSERVICE=9
</PRE>
===KEYSTONE GPS w/Argo Modem===
<PRE>
PROTOCOL=GHARGO
IPPORT=52243
EOLHEX=23
; Event Defaults are shown below
EVENT_INSERVICE=511
EVENT_BEGINPOUR=521
EVENT_ENDPOUR=531
EVENT_GPS=602
</PRE>

===KEYSTONE GPS w/BlueTree Modem===
<PRE>
PROTOCOL=GHBLUETREE
IPPORT=52242
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=1
</PRE>
===KEYSTONE GPS w/DataRemote Modem===
<PRE>
PROTOCOL=GHDATAREMOTE
IPPORT=52243
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=0
</PRE>
===FileMaker GPS===
<PRE>
PROTOCOL=GHGPS
IPPORT=52241
EOLHEX=0D0A
KEEPALIVE=Y
; Event Defaults are shown below
EVENT_TOJOB=4
EVENT_ONJOB=5
EVENT_BEGINPOUR=1
EVENT_ENDPOUR=2
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=7
EVENT_INSERVICE=3
EVENT_OUTOFSERVICE=8
EVENT_GPS=0
</PRE>

===Verifi Truck Status===
<PRE>
PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.0/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=********************
</PRE>

===RoadKing GPS Status===
<PRE>
PROTOCOL=ROADKING
; The following parameters default to the values shown
URL=/roadking/gps
IPPORT=7003
KEEPALIVE=1
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===Oshkosh Begin/End Pour and Post Pour Wash===
<PRE>
PROTOCOL=OSHKOSH
TIMEOUT=60000
; The following parameters default to the values shown
ROOTURL=https://api.lhptelematics.com/v2/
AUTHUSERNAME=********************
AUTHPASSWORD=********************
MAXPOURMINS=120
; Event Defaults are shown below
EVENT_BEGINPOUR=8
EVENT_ENDPOUR=9
EVENT_BEGINPOSTPOURWASH=10
EVENT_ENDPOSTPOURWASH=11
</PRE>

==Keystone ODBC Configuration (for Keystone GPS support)==

'''NOTE'''
ODBC is no longer used by Keystone GPS. Keystone GPS now uses a REST call. Remove Old ODBC connections where possible.

Install the InterBase ODBC Driver.

Use the 32-bit version of the Windows ODBC Administrator. (On 64-bit Windows you must run the ODBCAD32.EXE located in C:\Windows\SysWOW64.)

Create a new System DSN by clicking the "Add" button.

Enter the appropriate configuration information. Be sure to check the "read" box in the Transaction Options group.

Click the "Test connection" button before saving to verify that the database connection is valid.

GPS/Status Devices

2024-12-06T20:04:24Z

Hhildreth: /* Protocol Choices */

==Device Aggregator and Server Installation==
*Start command prompt as administartor
*From command prompt run the following commands:
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\ccdeviceserver.exe" -install</PRE>
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\CCDeviceAggregator.exe" -install</PRE>

*Start Services
*Verify that both Keystone Device Server and Keystone Device Aggregator are set to start automatically and are running.

==Device Server Properties==
Right Click Tray Icon 
Device Server ID: DS1

==Device Maintenance Setup==

Description: GPS 
Type: GPS/Status 
Dev Server ID: DS1 (default name)

<PRE>PROTOCOL=GHGPS
IPPORT=52241
KEEPALIVE=N
EOLHEX=04
USESERVERTIME=Y</PRE>

==Custom Truck Modes==

Introduced in Keystone 2.7.19, custom truck modes allow miscellaneous truck status information to be gathered from the GPS system and presented on the Dispatch Schedule screen. These modes must be defined in the GPS setup for the GPS device as well as in the Keystone DITCUSTSTAT table. To specify a custom truck mode use the following syntax in Device Maintenance for the GPS device:

<PRE>
CUSTOM_EVENT_<n>=<xxx>
</PRE>

where <n> represents the custom truck mode (integer) and <xxx> represents the custom truck mode value from the GPS device (string.)

The DITCUSTSTAT table maps the integer custom truck mode value to a short alphanumeric code and a longer description as follows:

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Field Name
! Field Type
! Description
|-
| CUSTOM_STATUS
| Integer
| Custom Truck Mode Identifier
|-
| STATUS_CODE
| String(6)
| Short code which appears on Dispatch Schedule truck grid
|-
| DESCRIPTION
| String(35)
| Description which appears on Dispatch Schedule status pop-up
|-
| STATUS_COLOR
| Integer (color)
| Color used to display STATUS_CODE and DESCRIPTION on Dispatch Schedule
|-
| SCHEDULE_SEQ
| Integer
| Determines sequence of custom truck modes on schedule screen negative # = highest priority 0 = no mode positive # = lowest priority
|-
| CLEAR_STATUS_COL
| String(100)
| Specifies statuses that will clear this custom truck mode NULL = never clear * = clear on all statuses except 13 (travel) *1*2*3 = clear on status 1, 2 or 3
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Protocol Choices ==

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Protocol
! Device
! Documentation
! Comm Link Type
! Keystone Version
|-
| GHNEXTEL2
| Keystone GPS/(Keystone Nextel Phone)
|
| UDP Server
|
|-
| KEYSTONEGPS
| Keystone GPS (identical to GHNEXTEL2)
|
| UDP Server
|
|-
| TRIMBLEXML
| Trimble (XML)
| [[Media:Trimble_XML_Integration_Interface_2_15_draft.pdf|Trimble XML Integration Interface]]
| MSMQ Server
|
|-
| INTEGRAXML
| TrakIt (Integra XML)
| [[Media:Integra_XML_V2.5.pdf|Integra XML Technical Specification]]
| MSMQ Server

|-
| DIGITALFLEETXML
| Digital Fleet (CALIFORNIA/PREVAILING WAGE ONLY -- ONLY USE THIS FOR FROM_DISPATCH DEVICE)
|
| MSMQ Server
|
|-
| TRAKITLEGACY
| TrakIt (Legacy Output)
|
| UDP Server
|
|-
| TRIMBLELEGACY
| Trimble (Legacy Output)
|
| Serial Server
|
|-
| GHGPS
| FileMaker GPS
|
| TCP Server
|
|-
| GHNEXTEL
| Nextel Phone
|
| UDP Server
|
|-
| DINET
| Dinet Status Box
|
| Serial Server
|
|-
| GHARGO
| KEYSTONE GPS w/Argo Modem
|
| TCP Server
|
|-
| GHBLUETREE
| KEYSTONE GPS w/BlueTree Modem
|
| UDP Server
|
|-
| GHDATAREMOTE
| KEYSTONE GPS w/DataRemote Modem
|
| UDP Server
|
|-
| VERIFI
| Verifi Truck Status (XML)
| [[Media:Subscription_API_for_signalling.pdf|Verifi Truck Status XML Interface]] [[Media:Signalling_Response.pdf|Verifi Truck Status XML Response]]
| Polled REST Server
| 3.4.5.6
|-
| ROADKING
| RoadKing GPS (JSON)
|
| HTTP Server
| 3.6.15.5
|-
| OSHKOSH
| Oshkosh Begin/End Pour and Post Pour Wash (JSON)
| [http://lhptwebapi-t.cloudapp.net/Help/Api/GET-v2-AssetReportEvents Oshkosh AssetReportEvents API]
| Polled REST Server
| 4.1.2.2
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

==Protocol Notes==
===Integra XML Configuration (TrakIt)===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is CHECKED):
*fromdispatch
*todispatch

The PC running TrakitWare must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrakitWare.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Trimble XML Configuration===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is UNCHECKED):
*from_dispatch
*to_dispatch

The PC running TrimExchange must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrimExchange.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Filemaker GPS Startup===
Double Click the GPS Shortcut 
LOGIN: GPS 
Click: Connect 
Minimize 

===Bluetree GPS Modem===

Diagnostics:
<PRE>TELNET <modem_ip> 6070</PRE>
Command to see IP address that modem is connecting to:
<PRE>AT+BRPRDS?</PRE>

===RoadKing GPS Sample JSON Content===
<PRE>
{
"TruckEvent": {
"OrderNumber": "117393",
"TruckNumber": "108",
"Date": "2020/07/30",
"Time": "15:50:34",
"EventCode": "9"
}
}
</PRE>

===Oshkosh Begin/End Pour Sample JSON Content===
<PRE>
[
{
"AssetId": 42490,
"ReportEventTypeId": 7,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T01:16:22",
"Latitude": 43.981525,
"Longitude": -88.545744
},
{
"AssetId": 42490,
"ReportEventTypeId": 8,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T02:15:20",
"Latitude": 43.98158,
"Longitude": -88.545723
}
]
</PRE>

==Sample Configurations==
===Common Device Parameters===
<PRE>
USESERVERTIME=0 ;0=Use time from status message, 1=Substitute current clock time in status message
USEGEOFENCING=0 ;0=Disable geofencing, 1=Use geofencing to determine on job/at plant status
USEODOMETER=1 ;0=Estimate odometer using distance formula, 1=Use odometer field from status message
USEPLANTNO=0 ;0=Ignore plant number from status message, 1=Use plant number from Arrive Plant/In Service status message
ONJOBSTOPTIME=6 ;0=Disable on job stop time, 1=Move to on job status if truck stopped more than x minutes
GPSCOMPANIES=<CoId>[,<CoId>]* ;if truck is not found in current company, check each of the listed companies
; To stop bad signals from showing up on the map, add the following lines. The Lat and Long are for the plant
; and the Radius is in miles. If more than on plant, set the Lat and Long in the center of all the plants.
VALIDLAT=41.98765
VALIDLONG=-78.97650
VALIDRADIUS=150
SETORDERLOCFROMGPS=0 ;0=Ignore GPS coordinates from status message, 1=Set Order GPS coordinates from On Job, Begin Pour, End Pour status messages
ALLOWRETCONC=1 (3.4+) ;0=Ignore returned concrete from status message, 1=Process returned concrete from status message
TRUCKFILTER=<TruckId> (3.5+) ;only statuses for the specified Truck Id will be processed, all other trucks will be ignored (diagnostics)
; Events that can be configured are as follows
EVENT_BEGINLOAD=
EVENT_ENDLOAD=
EVENT_TOJOB=
EVENT_ONJOB=
EVENT_BEGINPOUR=
EVENT_ENDPOUR=
EVENT_RETURNING=
EVENT_ARRIVEPLANT=
EVENT_INSERVICE=
EVENT_OUTOFSERVICE=
EVENT_CLOCKIN=
EVENT_CLOCKOUT=
EVENT_GPS=
EVENT_PRETICKET=
EVENT_DRIVER_CLOCKIN= (2.7+)
EVENT_DRIVER_CLOCKOUT= (2.7+)
EVENT_RETCONC= (3.4+)
EVENT_ADDWATER= (3.4+)
; Custom Truck Modes
; where n = custom truck mode (integer) - defined in DITCUSTSTAT table
; xxx = custom truck mode value from GPS (string)
CUSTOM_EVENT_n=xxx
</PRE>

===Keystone GPS===
This is the modern Windows / Web Version of Keystone GPS used since 2008. Based on the Keystone Nextel system of early 2000s.
<PRE>
PROTOCOL=KEYSTONEGPS
; The following parameters default to the values shown
IPPORT=7002
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===TrakIt (Integra XML)===
<PRE>
PROTOCOL=INTEGRAXML
MSMQFORMATNAME=DIRECT=OS:.\private$\todispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=1
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=9
EVENT_OUTOFSERVICE=10
</PRE>

===Trimble (XML)===
<PRE>
PROTOCOL=TRIMBLEXML
MSMQFORMATNAME=DIRECT=OS:.\private$\to_dispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=LDS
EVENT_ENDLOAD=LDC
EVENT_TOJOB=TJB
EVENT_ONJOB=AJB
EVENT_BEGINPOUR=POU
EVENT_ENDPOUR=EPR
EVENT_RETURNING=TPL
EVENT_ARRIVEPLANT=IYD
EVENT_INSERVICE=ISV
EVENT_OUTOFSERVICE=OSV
</PRE>

When setting up Trimble (XML), you need to also do the following in Windows:

*Ensure that the Windows Message Queuing Server is installed.
[[File:Windows Message Queuing Feature.PNG|600px]]


*Create the necessary message queues to interface with Trimble.
[[File:Message Queues.PNG|600px]]


*Set the properties for the Trimble message queues.
[[File:Queue Properties.PNG|400px]]


===TrakIt (Legacy Output)===
<PRE>
PROTOCOL=TRAKITLEGACY
IPPORT=???
; Event Defaults are shown below
EVENT_ENDLOAD=4
EVENT_TOJOB=5
EVENT_ONJOB=6
EVENT_BEGINPOUR=7
EVENT_ENDPOUR=8
EVENT_RETURNING=9
EVENT_ARRIVEPLANT=3
EVENT_CLOCKIN=1
EVENT_CLOCKOUT=11
</PRE>

===Nextel Phone===
<PRE>
PROTOCOL=GHNEXTEL
IPPORT=52242
; Event Defaults are shown below
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=1
EVENT_GPS=0
</PRE>
===Trimble (Legacy Output)===
<PRE>
PROTOCOL=TRIMBLELEGACY
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0A
TIMEOUT=500
; Event Defaults are shown below
EVENT_ENDLOAD=1
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=0
</PRE>
===Dinet Status Box===
<PRE>
PROTOCOL=DINET
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0D
TIMEOUT=500
; Event Defaults are shown below
EVENT_BEGINLOAD=0
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=1
EVENT_OUTOFSERVICE=9
</PRE>
===KEYSTONE GPS w/Argo Modem===
<PRE>
PROTOCOL=GHARGO
IPPORT=52243
EOLHEX=23
; Event Defaults are shown below
EVENT_INSERVICE=511
EVENT_BEGINPOUR=521
EVENT_ENDPOUR=531
EVENT_GPS=602
</PRE>

===KEYSTONE GPS w/BlueTree Modem===
<PRE>
PROTOCOL=GHBLUETREE
IPPORT=52242
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=1
</PRE>
===KEYSTONE GPS w/DataRemote Modem===
<PRE>
PROTOCOL=GHDATAREMOTE
IPPORT=52243
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=0
</PRE>
===FileMaker GPS===
<PRE>
PROTOCOL=GHGPS
IPPORT=52241
EOLHEX=0D0A
KEEPALIVE=Y
; Event Defaults are shown below
EVENT_TOJOB=4
EVENT_ONJOB=5
EVENT_BEGINPOUR=1
EVENT_ENDPOUR=2
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=7
EVENT_INSERVICE=3
EVENT_OUTOFSERVICE=8
EVENT_GPS=0
</PRE>

===Verifi Truck Status===
<PRE>
PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.0/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=********************
</PRE>

===RoadKing GPS Status===
<PRE>
PROTOCOL=ROADKING
; The following parameters default to the values shown
URL=/roadking/gps
IPPORT=7003
KEEPALIVE=1
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===Oshkosh Begin/End Pour and Post Pour Wash===
<PRE>
PROTOCOL=OSHKOSH
TIMEOUT=60000
; The following parameters default to the values shown
ROOTURL=https://api.lhptelematics.com/v2/
AUTHUSERNAME=********************
AUTHPASSWORD=********************
MAXPOURMINS=120
; Event Defaults are shown below
EVENT_BEGINPOUR=8
EVENT_ENDPOUR=9
EVENT_BEGINPOSTPOURWASH=10
EVENT_ENDPOSTPOURWASH=11
</PRE>

==Keystone ODBC Configuration (for Keystone GPS support)==

'''NOTE'''
ODBC is no longer used by Keystone GPS. Keystone GPS now uses a REST call. Remove Old ODBC connections where possible.

Install the InterBase ODBC Driver.

Use the 32-bit version of the Windows ODBC Administrator. (On 64-bit Windows you must run the ODBCAD32.EXE located in C:\Windows\SysWOW64.)

Create a new System DSN by clicking the "Add" button.

Enter the appropriate configuration information. Be sure to check the "read" box in the Transaction Options group.

Click the "Test connection" button before saving to verify that the database connection is valid.

GPS/Status Devices

2024-12-06T20:01:47Z

Hhildreth: /* Protocol Choices */

==Device Aggregator and Server Installation==
*Start command prompt as administartor
*From command prompt run the following commands:
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\ccdeviceserver.exe" -install</PRE>
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\CCDeviceAggregator.exe" -install</PRE>

*Start Services
*Verify that both Keystone Device Server and Keystone Device Aggregator are set to start automatically and are running.

==Device Server Properties==
Right Click Tray Icon 
Device Server ID: DS1

==Device Maintenance Setup==

Description: GPS 
Type: GPS/Status 
Dev Server ID: DS1 (default name)

<PRE>PROTOCOL=GHGPS
IPPORT=52241
KEEPALIVE=N
EOLHEX=04
USESERVERTIME=Y</PRE>

==Custom Truck Modes==

Introduced in Keystone 2.7.19, custom truck modes allow miscellaneous truck status information to be gathered from the GPS system and presented on the Dispatch Schedule screen. These modes must be defined in the GPS setup for the GPS device as well as in the Keystone DITCUSTSTAT table. To specify a custom truck mode use the following syntax in Device Maintenance for the GPS device:

<PRE>
CUSTOM_EVENT_<n>=<xxx>
</PRE>

where <n> represents the custom truck mode (integer) and <xxx> represents the custom truck mode value from the GPS device (string.)

The DITCUSTSTAT table maps the integer custom truck mode value to a short alphanumeric code and a longer description as follows:

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Field Name
! Field Type
! Description
|-
| CUSTOM_STATUS
| Integer
| Custom Truck Mode Identifier
|-
| STATUS_CODE
| String(6)
| Short code which appears on Dispatch Schedule truck grid
|-
| DESCRIPTION
| String(35)
| Description which appears on Dispatch Schedule status pop-up
|-
| STATUS_COLOR
| Integer (color)
| Color used to display STATUS_CODE and DESCRIPTION on Dispatch Schedule
|-
| SCHEDULE_SEQ
| Integer
| Determines sequence of custom truck modes on schedule screen negative # = highest priority 0 = no mode positive # = lowest priority
|-
| CLEAR_STATUS_COL
| String(100)
| Specifies statuses that will clear this custom truck mode NULL = never clear * = clear on all statuses except 13 (travel) *1*2*3 = clear on status 1, 2 or 3
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Protocol Choices ==

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Protocol
! Device
! Documentation
! Comm Link Type
! Keystone Version
|-
| GHNEXTEL2
| Keystone GPS/(Keystone Nextel Phone)
|
| UDP Server
|
|-
| KEYSTONEGPS
| Keystone GPS (identical to GHNEXTEL2)
|
| UDP Server
|
|-
| TRIMBLEXML
| Trimble (XML)
| [[Media:Trimble_XML_Integration_Interface_2_15_draft.pdf|Trimble XML Integration Interface]]
| MSMQ Server
|
|-
| INTEGRAXML
| TrakIt (Integra XML)
| [[Media:Integra_XML_V2.5.pdf|Integra XML Technical Specification]]
| MSMQ Server

|-
| DIGITALFLEETXML
| Digital Fleet (CALIFORNIA PREVAILING WAGE ONLY -- ONLY USE THIS FOR FROM_DISPATCH DEVICE)
|
| MSMQ Server
|
|-
| TRAKITLEGACY
| TrakIt (Legacy Output)
|
| UDP Server
|
|-
| TRIMBLELEGACY
| Trimble (Legacy Output)
|
| Serial Server
|
|-
| GHGPS
| FileMaker GPS
|
| TCP Server
|
|-
| GHNEXTEL
| Nextel Phone
|
| UDP Server
|
|-
| DINET
| Dinet Status Box
|
| Serial Server
|
|-
| GHARGO
| KEYSTONE GPS w/Argo Modem
|
| TCP Server
|
|-
| GHBLUETREE
| KEYSTONE GPS w/BlueTree Modem
|
| UDP Server
|
|-
| GHDATAREMOTE
| KEYSTONE GPS w/DataRemote Modem
|
| UDP Server
|
|-
| VERIFI
| Verifi Truck Status (XML)
| [[Media:Subscription_API_for_signalling.pdf|Verifi Truck Status XML Interface]] [[Media:Signalling_Response.pdf|Verifi Truck Status XML Response]]
| Polled REST Server
| 3.4.5.6
|-
| ROADKING
| RoadKing GPS (JSON)
|
| HTTP Server
| 3.6.15.5
|-
| OSHKOSH
| Oshkosh Begin/End Pour and Post Pour Wash (JSON)
| [http://lhptwebapi-t.cloudapp.net/Help/Api/GET-v2-AssetReportEvents Oshkosh AssetReportEvents API]
| Polled REST Server
| 4.1.2.2
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

==Protocol Notes==
===Integra XML Configuration (TrakIt)===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is CHECKED):
*fromdispatch
*todispatch

The PC running TrakitWare must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrakitWare.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Trimble XML Configuration===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is UNCHECKED):
*from_dispatch
*to_dispatch

The PC running TrimExchange must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrimExchange.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Filemaker GPS Startup===
Double Click the GPS Shortcut 
LOGIN: GPS 
Click: Connect 
Minimize 

===Bluetree GPS Modem===

Diagnostics:
<PRE>TELNET <modem_ip> 6070</PRE>
Command to see IP address that modem is connecting to:
<PRE>AT+BRPRDS?</PRE>

===RoadKing GPS Sample JSON Content===
<PRE>
{
"TruckEvent": {
"OrderNumber": "117393",
"TruckNumber": "108",
"Date": "2020/07/30",
"Time": "15:50:34",
"EventCode": "9"
}
}
</PRE>

===Oshkosh Begin/End Pour Sample JSON Content===
<PRE>
[
{
"AssetId": 42490,
"ReportEventTypeId": 7,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T01:16:22",
"Latitude": 43.981525,
"Longitude": -88.545744
},
{
"AssetId": 42490,
"ReportEventTypeId": 8,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T02:15:20",
"Latitude": 43.98158,
"Longitude": -88.545723
}
]
</PRE>

==Sample Configurations==
===Common Device Parameters===
<PRE>
USESERVERTIME=0 ;0=Use time from status message, 1=Substitute current clock time in status message
USEGEOFENCING=0 ;0=Disable geofencing, 1=Use geofencing to determine on job/at plant status
USEODOMETER=1 ;0=Estimate odometer using distance formula, 1=Use odometer field from status message
USEPLANTNO=0 ;0=Ignore plant number from status message, 1=Use plant number from Arrive Plant/In Service status message
ONJOBSTOPTIME=6 ;0=Disable on job stop time, 1=Move to on job status if truck stopped more than x minutes
GPSCOMPANIES=<CoId>[,<CoId>]* ;if truck is not found in current company, check each of the listed companies
; To stop bad signals from showing up on the map, add the following lines. The Lat and Long are for the plant
; and the Radius is in miles. If more than on plant, set the Lat and Long in the center of all the plants.
VALIDLAT=41.98765
VALIDLONG=-78.97650
VALIDRADIUS=150
SETORDERLOCFROMGPS=0 ;0=Ignore GPS coordinates from status message, 1=Set Order GPS coordinates from On Job, Begin Pour, End Pour status messages
ALLOWRETCONC=1 (3.4+) ;0=Ignore returned concrete from status message, 1=Process returned concrete from status message
TRUCKFILTER=<TruckId> (3.5+) ;only statuses for the specified Truck Id will be processed, all other trucks will be ignored (diagnostics)
; Events that can be configured are as follows
EVENT_BEGINLOAD=
EVENT_ENDLOAD=
EVENT_TOJOB=
EVENT_ONJOB=
EVENT_BEGINPOUR=
EVENT_ENDPOUR=
EVENT_RETURNING=
EVENT_ARRIVEPLANT=
EVENT_INSERVICE=
EVENT_OUTOFSERVICE=
EVENT_CLOCKIN=
EVENT_CLOCKOUT=
EVENT_GPS=
EVENT_PRETICKET=
EVENT_DRIVER_CLOCKIN= (2.7+)
EVENT_DRIVER_CLOCKOUT= (2.7+)
EVENT_RETCONC= (3.4+)
EVENT_ADDWATER= (3.4+)
; Custom Truck Modes
; where n = custom truck mode (integer) - defined in DITCUSTSTAT table
; xxx = custom truck mode value from GPS (string)
CUSTOM_EVENT_n=xxx
</PRE>

===Keystone GPS===
This is the modern Windows / Web Version of Keystone GPS used since 2008. Based on the Keystone Nextel system of early 2000s.
<PRE>
PROTOCOL=KEYSTONEGPS
; The following parameters default to the values shown
IPPORT=7002
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===TrakIt (Integra XML)===
<PRE>
PROTOCOL=INTEGRAXML
MSMQFORMATNAME=DIRECT=OS:.\private$\todispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=1
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=9
EVENT_OUTOFSERVICE=10
</PRE>

===Trimble (XML)===
<PRE>
PROTOCOL=TRIMBLEXML
MSMQFORMATNAME=DIRECT=OS:.\private$\to_dispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=LDS
EVENT_ENDLOAD=LDC
EVENT_TOJOB=TJB
EVENT_ONJOB=AJB
EVENT_BEGINPOUR=POU
EVENT_ENDPOUR=EPR
EVENT_RETURNING=TPL
EVENT_ARRIVEPLANT=IYD
EVENT_INSERVICE=ISV
EVENT_OUTOFSERVICE=OSV
</PRE>

When setting up Trimble (XML), you need to also do the following in Windows:

*Ensure that the Windows Message Queuing Server is installed.
[[File:Windows Message Queuing Feature.PNG|600px]]


*Create the necessary message queues to interface with Trimble.
[[File:Message Queues.PNG|600px]]


*Set the properties for the Trimble message queues.
[[File:Queue Properties.PNG|400px]]


===TrakIt (Legacy Output)===
<PRE>
PROTOCOL=TRAKITLEGACY
IPPORT=???
; Event Defaults are shown below
EVENT_ENDLOAD=4
EVENT_TOJOB=5
EVENT_ONJOB=6
EVENT_BEGINPOUR=7
EVENT_ENDPOUR=8
EVENT_RETURNING=9
EVENT_ARRIVEPLANT=3
EVENT_CLOCKIN=1
EVENT_CLOCKOUT=11
</PRE>

===Nextel Phone===
<PRE>
PROTOCOL=GHNEXTEL
IPPORT=52242
; Event Defaults are shown below
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=1
EVENT_GPS=0
</PRE>
===Trimble (Legacy Output)===
<PRE>
PROTOCOL=TRIMBLELEGACY
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0A
TIMEOUT=500
; Event Defaults are shown below
EVENT_ENDLOAD=1
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=0
</PRE>
===Dinet Status Box===
<PRE>
PROTOCOL=DINET
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0D
TIMEOUT=500
; Event Defaults are shown below
EVENT_BEGINLOAD=0
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=1
EVENT_OUTOFSERVICE=9
</PRE>
===KEYSTONE GPS w/Argo Modem===
<PRE>
PROTOCOL=GHARGO
IPPORT=52243
EOLHEX=23
; Event Defaults are shown below
EVENT_INSERVICE=511
EVENT_BEGINPOUR=521
EVENT_ENDPOUR=531
EVENT_GPS=602
</PRE>

===KEYSTONE GPS w/BlueTree Modem===
<PRE>
PROTOCOL=GHBLUETREE
IPPORT=52242
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=1
</PRE>
===KEYSTONE GPS w/DataRemote Modem===
<PRE>
PROTOCOL=GHDATAREMOTE
IPPORT=52243
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=0
</PRE>
===FileMaker GPS===
<PRE>
PROTOCOL=GHGPS
IPPORT=52241
EOLHEX=0D0A
KEEPALIVE=Y
; Event Defaults are shown below
EVENT_TOJOB=4
EVENT_ONJOB=5
EVENT_BEGINPOUR=1
EVENT_ENDPOUR=2
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=7
EVENT_INSERVICE=3
EVENT_OUTOFSERVICE=8
EVENT_GPS=0
</PRE>

===Verifi Truck Status===
<PRE>
PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.0/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=********************
</PRE>

===RoadKing GPS Status===
<PRE>
PROTOCOL=ROADKING
; The following parameters default to the values shown
URL=/roadking/gps
IPPORT=7003
KEEPALIVE=1
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===Oshkosh Begin/End Pour and Post Pour Wash===
<PRE>
PROTOCOL=OSHKOSH
TIMEOUT=60000
; The following parameters default to the values shown
ROOTURL=https://api.lhptelematics.com/v2/
AUTHUSERNAME=********************
AUTHPASSWORD=********************
MAXPOURMINS=120
; Event Defaults are shown below
EVENT_BEGINPOUR=8
EVENT_ENDPOUR=9
EVENT_BEGINPOSTPOURWASH=10
EVENT_ENDPOSTPOURWASH=11
</PRE>

==Keystone ODBC Configuration (for Keystone GPS support)==

'''NOTE'''
ODBC is no longer used by Keystone GPS. Keystone GPS now uses a REST call. Remove Old ODBC connections where possible.

Install the InterBase ODBC Driver.

Use the 32-bit version of the Windows ODBC Administrator. (On 64-bit Windows you must run the ODBCAD32.EXE located in C:\Windows\SysWOW64.)

Create a new System DSN by clicking the "Add" button.

Enter the appropriate configuration information. Be sure to check the "read" box in the Transaction Options group.

Click the "Test connection" button before saving to verify that the database connection is valid.

GPS/Status Devices

2024-12-06T20:00:12Z

Hhildreth: /* Protocol Choices */

==Device Aggregator and Server Installation==
*Start command prompt as administartor
*From command prompt run the following commands:
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\ccdeviceserver.exe" -install</PRE>
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\CCDeviceAggregator.exe" -install</PRE>

*Start Services
*Verify that both Keystone Device Server and Keystone Device Aggregator are set to start automatically and are running.

==Device Server Properties==
Right Click Tray Icon 
Device Server ID: DS1

==Device Maintenance Setup==

Description: GPS 
Type: GPS/Status 
Dev Server ID: DS1 (default name)

<PRE>PROTOCOL=GHGPS
IPPORT=52241
KEEPALIVE=N
EOLHEX=04
USESERVERTIME=Y</PRE>

==Custom Truck Modes==

Introduced in Keystone 2.7.19, custom truck modes allow miscellaneous truck status information to be gathered from the GPS system and presented on the Dispatch Schedule screen. These modes must be defined in the GPS setup for the GPS device as well as in the Keystone DITCUSTSTAT table. To specify a custom truck mode use the following syntax in Device Maintenance for the GPS device:

<PRE>
CUSTOM_EVENT_<n>=<xxx>
</PRE>

where <n> represents the custom truck mode (integer) and <xxx> represents the custom truck mode value from the GPS device (string.)

The DITCUSTSTAT table maps the integer custom truck mode value to a short alphanumeric code and a longer description as follows:

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Field Name
! Field Type
! Description
|-
| CUSTOM_STATUS
| Integer
| Custom Truck Mode Identifier
|-
| STATUS_CODE
| String(6)
| Short code which appears on Dispatch Schedule truck grid
|-
| DESCRIPTION
| String(35)
| Description which appears on Dispatch Schedule status pop-up
|-
| STATUS_COLOR
| Integer (color)
| Color used to display STATUS_CODE and DESCRIPTION on Dispatch Schedule
|-
| SCHEDULE_SEQ
| Integer
| Determines sequence of custom truck modes on schedule screen negative # = highest priority 0 = no mode positive # = lowest priority
|-
| CLEAR_STATUS_COL
| String(100)
| Specifies statuses that will clear this custom truck mode NULL = never clear * = clear on all statuses except 13 (travel) *1*2*3 = clear on status 1, 2 or 3
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Protocol Choices ==

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Protocol
! Device
! Documentation
! Comm Link Type
! Keystone Version
|-
| GHNEXTEL2
| Keystone GPS/(Keystone Nextel Phone)
|
| UDP Server
|
|-
| KEYSTONEGPS
| Keystone GPS (identical to GHNEXTEL2)
|
| UDP Server
|
|-
| TRIMBLEXML
| Trimble (XML)
| [[Media:Trimble_XML_Integration_Interface_2_15_draft.pdf|Trimble XML Integration Interface]]
| MSMQ Server
|
|-
| INTEGRAXML
| TrakIt (Integra XML)
| [[Media:Integra_XML_V2.5.pdf|Integra XML Technical Specification]]
| MSMQ Server

|-
| DIGITALFLEETXML
| Digital Fleet (CALIFORNIA PREVAILING WAGE ONLY -- ONLY USE THIS FOR FROM_DISPATCH DEVICE)
|
| MSMQ Server
|
|-
| TRAKITLEGACY
| TrakIt (Legacy Output)
|
| UDP Server
|
|-
| TRIMBLELEGACY
| Trimble (Legacy Output)
|
| Serial Server
|
|-
| GHGPS
| FileMaker GPS
|
| TCP Server
|
|-
| GHNEXTEL
| Nextel Phone
|
| UDP Server
|
|-
| DINET
| Dinet Status Box
|
| Serial Server
|
|-
| GHARGO
| KEYSTONE GPS w/Argo Modem
|
| TCP Server
|
|-
| GHBLUETREE
| KEYSTONE GPS w/BlueTree Modem
|
| UDP Server
|
|-
| GHDATAREMOTE
| KEYSTONE GPS w/DataRemote Modem
|
| UDP Server
|
|-
| VERIFI
| Verifi Truck Status (XML)
| [[Media:Subscription_API_for_signalling.pdf|Verifi Truck Status XML Interface]] [[Media:Signalling_Response.pdf|Verifi Truck Status XML Response]]
| Polled REST Server
| 3.4.5.6
|-
| ROADKING
| RoadKing GPS (JSON)
|
| HTTP Server
| 3.6.15.5
|-
| OSHKOSH
| Oshkosh Begin/End Pour and Post Pour Wash (JSON)
| [http://lhptwebapi-t.cloudapp.net/Help/Api/GET-v2-AssetReportEvents Oshkosh AssetReportEvents API]
| Polled REST Server
| 4.1.2.2
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

==Protocol Notes==
===Integra XML Configuration (TrakIt)===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is CHECKED):
*fromdispatch
*todispatch

The PC running TrakitWare must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrakitWare.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Trimble XML Configuration===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is UNCHECKED):
*from_dispatch
*to_dispatch

The PC running TrimExchange must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrimExchange.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Filemaker GPS Startup===
Double Click the GPS Shortcut 
LOGIN: GPS 
Click: Connect 
Minimize 

===Bluetree GPS Modem===

Diagnostics:
<PRE>TELNET <modem_ip> 6070</PRE>
Command to see IP address that modem is connecting to:
<PRE>AT+BRPRDS?</PRE>

===RoadKing GPS Sample JSON Content===
<PRE>
{
"TruckEvent": {
"OrderNumber": "117393",
"TruckNumber": "108",
"Date": "2020/07/30",
"Time": "15:50:34",
"EventCode": "9"
}
}
</PRE>

===Oshkosh Begin/End Pour Sample JSON Content===
<PRE>
[
{
"AssetId": 42490,
"ReportEventTypeId": 7,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T01:16:22",
"Latitude": 43.981525,
"Longitude": -88.545744
},
{
"AssetId": 42490,
"ReportEventTypeId": 8,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T02:15:20",
"Latitude": 43.98158,
"Longitude": -88.545723
}
]
</PRE>

==Sample Configurations==
===Common Device Parameters===
<PRE>
USESERVERTIME=0 ;0=Use time from status message, 1=Substitute current clock time in status message
USEGEOFENCING=0 ;0=Disable geofencing, 1=Use geofencing to determine on job/at plant status
USEODOMETER=1 ;0=Estimate odometer using distance formula, 1=Use odometer field from status message
USEPLANTNO=0 ;0=Ignore plant number from status message, 1=Use plant number from Arrive Plant/In Service status message
ONJOBSTOPTIME=6 ;0=Disable on job stop time, 1=Move to on job status if truck stopped more than x minutes
GPSCOMPANIES=<CoId>[,<CoId>]* ;if truck is not found in current company, check each of the listed companies
; To stop bad signals from showing up on the map, add the following lines. The Lat and Long are for the plant
; and the Radius is in miles. If more than on plant, set the Lat and Long in the center of all the plants.
VALIDLAT=41.98765
VALIDLONG=-78.97650
VALIDRADIUS=150
SETORDERLOCFROMGPS=0 ;0=Ignore GPS coordinates from status message, 1=Set Order GPS coordinates from On Job, Begin Pour, End Pour status messages
ALLOWRETCONC=1 (3.4+) ;0=Ignore returned concrete from status message, 1=Process returned concrete from status message
TRUCKFILTER=<TruckId> (3.5+) ;only statuses for the specified Truck Id will be processed, all other trucks will be ignored (diagnostics)
; Events that can be configured are as follows
EVENT_BEGINLOAD=
EVENT_ENDLOAD=
EVENT_TOJOB=
EVENT_ONJOB=
EVENT_BEGINPOUR=
EVENT_ENDPOUR=
EVENT_RETURNING=
EVENT_ARRIVEPLANT=
EVENT_INSERVICE=
EVENT_OUTOFSERVICE=
EVENT_CLOCKIN=
EVENT_CLOCKOUT=
EVENT_GPS=
EVENT_PRETICKET=
EVENT_DRIVER_CLOCKIN= (2.7+)
EVENT_DRIVER_CLOCKOUT= (2.7+)
EVENT_RETCONC= (3.4+)
EVENT_ADDWATER= (3.4+)
; Custom Truck Modes
; where n = custom truck mode (integer) - defined in DITCUSTSTAT table
; xxx = custom truck mode value from GPS (string)
CUSTOM_EVENT_n=xxx
</PRE>

===Keystone GPS===
This is the modern Windows / Web Version of Keystone GPS used since 2008. Based on the Keystone Nextel system of early 2000s.
<PRE>
PROTOCOL=KEYSTONEGPS
; The following parameters default to the values shown
IPPORT=7002
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===TrakIt (Integra XML)===
<PRE>
PROTOCOL=INTEGRAXML
MSMQFORMATNAME=DIRECT=OS:.\private$\todispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=1
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=9
EVENT_OUTOFSERVICE=10
</PRE>

===Trimble (XML)===
<PRE>
PROTOCOL=TRIMBLEXML
MSMQFORMATNAME=DIRECT=OS:.\private$\to_dispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=LDS
EVENT_ENDLOAD=LDC
EVENT_TOJOB=TJB
EVENT_ONJOB=AJB
EVENT_BEGINPOUR=POU
EVENT_ENDPOUR=EPR
EVENT_RETURNING=TPL
EVENT_ARRIVEPLANT=IYD
EVENT_INSERVICE=ISV
EVENT_OUTOFSERVICE=OSV
</PRE>

When setting up Trimble (XML), you need to also do the following in Windows:

*Ensure that the Windows Message Queuing Server is installed.
[[File:Windows Message Queuing Feature.PNG|600px]]


*Create the necessary message queues to interface with Trimble.
[[File:Message Queues.PNG|600px]]


*Set the properties for the Trimble message queues.
[[File:Queue Properties.PNG|400px]]


===TrakIt (Legacy Output)===
<PRE>
PROTOCOL=TRAKITLEGACY
IPPORT=???
; Event Defaults are shown below
EVENT_ENDLOAD=4
EVENT_TOJOB=5
EVENT_ONJOB=6
EVENT_BEGINPOUR=7
EVENT_ENDPOUR=8
EVENT_RETURNING=9
EVENT_ARRIVEPLANT=3
EVENT_CLOCKIN=1
EVENT_CLOCKOUT=11
</PRE>

===Nextel Phone===
<PRE>
PROTOCOL=GHNEXTEL
IPPORT=52242
; Event Defaults are shown below
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=1
EVENT_GPS=0
</PRE>
===Trimble (Legacy Output)===
<PRE>
PROTOCOL=TRIMBLELEGACY
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0A
TIMEOUT=500
; Event Defaults are shown below
EVENT_ENDLOAD=1
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=0
</PRE>
===Dinet Status Box===
<PRE>
PROTOCOL=DINET
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0D
TIMEOUT=500
; Event Defaults are shown below
EVENT_BEGINLOAD=0
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=1
EVENT_OUTOFSERVICE=9
</PRE>
===KEYSTONE GPS w/Argo Modem===
<PRE>
PROTOCOL=GHARGO
IPPORT=52243
EOLHEX=23
; Event Defaults are shown below
EVENT_INSERVICE=511
EVENT_BEGINPOUR=521
EVENT_ENDPOUR=531
EVENT_GPS=602
</PRE>

===KEYSTONE GPS w/BlueTree Modem===
<PRE>
PROTOCOL=GHBLUETREE
IPPORT=52242
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=1
</PRE>
===KEYSTONE GPS w/DataRemote Modem===
<PRE>
PROTOCOL=GHDATAREMOTE
IPPORT=52243
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=0
</PRE>
===FileMaker GPS===
<PRE>
PROTOCOL=GHGPS
IPPORT=52241
EOLHEX=0D0A
KEEPALIVE=Y
; Event Defaults are shown below
EVENT_TOJOB=4
EVENT_ONJOB=5
EVENT_BEGINPOUR=1
EVENT_ENDPOUR=2
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=7
EVENT_INSERVICE=3
EVENT_OUTOFSERVICE=8
EVENT_GPS=0
</PRE>

===Verifi Truck Status===
<PRE>
PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.0/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=********************
</PRE>

===RoadKing GPS Status===
<PRE>
PROTOCOL=ROADKING
; The following parameters default to the values shown
URL=/roadking/gps
IPPORT=7003
KEEPALIVE=1
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===Oshkosh Begin/End Pour and Post Pour Wash===
<PRE>
PROTOCOL=OSHKOSH
TIMEOUT=60000
; The following parameters default to the values shown
ROOTURL=https://api.lhptelematics.com/v2/
AUTHUSERNAME=********************
AUTHPASSWORD=********************
MAXPOURMINS=120
; Event Defaults are shown below
EVENT_BEGINPOUR=8
EVENT_ENDPOUR=9
EVENT_BEGINPOSTPOURWASH=10
EVENT_ENDPOSTPOURWASH=11
</PRE>

==Keystone ODBC Configuration (for Keystone GPS support)==

'''NOTE'''
ODBC is no longer used by Keystone GPS. Keystone GPS now uses a REST call. Remove Old ODBC connections where possible.

Install the InterBase ODBC Driver.

Use the 32-bit version of the Windows ODBC Administrator. (On 64-bit Windows you must run the ODBCAD32.EXE located in C:\Windows\SysWOW64.)

Create a new System DSN by clicking the "Add" button.

Enter the appropriate configuration information. Be sure to check the "read" box in the Transaction Options group.

Click the "Test connection" button before saving to verify that the database connection is valid.

GPS/Status Devices

2024-12-06T19:59:53Z

Hhildreth: /* Protocol Choices */

==Device Aggregator and Server Installation==
*Start command prompt as administartor
*From command prompt run the following commands:
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\ccdeviceserver.exe" -install</PRE>
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\CCDeviceAggregator.exe" -install</PRE>

*Start Services
*Verify that both Keystone Device Server and Keystone Device Aggregator are set to start automatically and are running.

==Device Server Properties==
Right Click Tray Icon 
Device Server ID: DS1

==Device Maintenance Setup==

Description: GPS 
Type: GPS/Status 
Dev Server ID: DS1 (default name)

<PRE>PROTOCOL=GHGPS
IPPORT=52241
KEEPALIVE=N
EOLHEX=04
USESERVERTIME=Y</PRE>

==Custom Truck Modes==

Introduced in Keystone 2.7.19, custom truck modes allow miscellaneous truck status information to be gathered from the GPS system and presented on the Dispatch Schedule screen. These modes must be defined in the GPS setup for the GPS device as well as in the Keystone DITCUSTSTAT table. To specify a custom truck mode use the following syntax in Device Maintenance for the GPS device:

<PRE>
CUSTOM_EVENT_<n>=<xxx>
</PRE>

where <n> represents the custom truck mode (integer) and <xxx> represents the custom truck mode value from the GPS device (string.)

The DITCUSTSTAT table maps the integer custom truck mode value to a short alphanumeric code and a longer description as follows:

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Field Name
! Field Type
! Description
|-
| CUSTOM_STATUS
| Integer
| Custom Truck Mode Identifier
|-
| STATUS_CODE
| String(6)
| Short code which appears on Dispatch Schedule truck grid
|-
| DESCRIPTION
| String(35)
| Description which appears on Dispatch Schedule status pop-up
|-
| STATUS_COLOR
| Integer (color)
| Color used to display STATUS_CODE and DESCRIPTION on Dispatch Schedule
|-
| SCHEDULE_SEQ
| Integer
| Determines sequence of custom truck modes on schedule screen negative # = highest priority 0 = no mode positive # = lowest priority
|-
| CLEAR_STATUS_COL
| String(100)
| Specifies statuses that will clear this custom truck mode NULL = never clear * = clear on all statuses except 13 (travel) *1*2*3 = clear on status 1, 2 or 3
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Protocol Choices ==

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Protocol
! Device
! Documentation
! Comm Link Type
! Keystone Version
|-
| GHNEXTEL2
| Keystone GPS/(Keystone Nextel Phone)
|
| UDP Server
|
|-
| KEYSTONEGPS
| Keystone GPS (identical to GHNEXTEL2)
|
| UDP Server
|
|-
| TRIMBLEXML
| Trimble (XML)
| [[Media:Trimble_XML_Integration_Interface_2_15_draft.pdf|Trimble XML Integration Interface]]
| MSMQ Server
|
|-
| INTEGRAXML
| TrakIt (Integra XML)
| [[Media:Integra_XML_V2.5.pdf|Integra XML Technical Specification]]
| MSMQ Server
|-
| DIGITALFLEETXML
| Digital Fleet (CALIFORNIA PREVAILING WAGE ONLY -- ONLY USE THIS FOR FROM_DISPATCH DEVICE)
|
| MSMQ Server
|
|-
| TRAKITLEGACY
| TrakIt (Legacy Output)
|
| UDP Server
|
|-
| TRIMBLELEGACY
| Trimble (Legacy Output)
|
| Serial Server
|
|-
| GHGPS
| FileMaker GPS
|
| TCP Server
|
|-
| GHNEXTEL
| Nextel Phone
|
| UDP Server
|
|-
| DINET
| Dinet Status Box
|
| Serial Server
|
|-
| GHARGO
| KEYSTONE GPS w/Argo Modem
|
| TCP Server
|
|-
| GHBLUETREE
| KEYSTONE GPS w/BlueTree Modem
|
| UDP Server
|
|-
| GHDATAREMOTE
| KEYSTONE GPS w/DataRemote Modem
|
| UDP Server
|
|-
| VERIFI
| Verifi Truck Status (XML)
| [[Media:Subscription_API_for_signalling.pdf|Verifi Truck Status XML Interface]] [[Media:Signalling_Response.pdf|Verifi Truck Status XML Response]]
| Polled REST Server
| 3.4.5.6
|-
| ROADKING
| RoadKing GPS (JSON)
|
| HTTP Server
| 3.6.15.5
|-
| OSHKOSH
| Oshkosh Begin/End Pour and Post Pour Wash (JSON)
| [http://lhptwebapi-t.cloudapp.net/Help/Api/GET-v2-AssetReportEvents Oshkosh AssetReportEvents API]
| Polled REST Server
| 4.1.2.2
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

==Protocol Notes==
===Integra XML Configuration (TrakIt)===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is CHECKED):
*fromdispatch
*todispatch

The PC running TrakitWare must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrakitWare.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Trimble XML Configuration===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is UNCHECKED):
*from_dispatch
*to_dispatch

The PC running TrimExchange must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrimExchange.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Filemaker GPS Startup===
Double Click the GPS Shortcut 
LOGIN: GPS 
Click: Connect 
Minimize 

===Bluetree GPS Modem===

Diagnostics:
<PRE>TELNET <modem_ip> 6070</PRE>
Command to see IP address that modem is connecting to:
<PRE>AT+BRPRDS?</PRE>

===RoadKing GPS Sample JSON Content===
<PRE>
{
"TruckEvent": {
"OrderNumber": "117393",
"TruckNumber": "108",
"Date": "2020/07/30",
"Time": "15:50:34",
"EventCode": "9"
}
}
</PRE>

===Oshkosh Begin/End Pour Sample JSON Content===
<PRE>
[
{
"AssetId": 42490,
"ReportEventTypeId": 7,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T01:16:22",
"Latitude": 43.981525,
"Longitude": -88.545744
},
{
"AssetId": 42490,
"ReportEventTypeId": 8,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T02:15:20",
"Latitude": 43.98158,
"Longitude": -88.545723
}
]
</PRE>

==Sample Configurations==
===Common Device Parameters===
<PRE>
USESERVERTIME=0 ;0=Use time from status message, 1=Substitute current clock time in status message
USEGEOFENCING=0 ;0=Disable geofencing, 1=Use geofencing to determine on job/at plant status
USEODOMETER=1 ;0=Estimate odometer using distance formula, 1=Use odometer field from status message
USEPLANTNO=0 ;0=Ignore plant number from status message, 1=Use plant number from Arrive Plant/In Service status message
ONJOBSTOPTIME=6 ;0=Disable on job stop time, 1=Move to on job status if truck stopped more than x minutes
GPSCOMPANIES=<CoId>[,<CoId>]* ;if truck is not found in current company, check each of the listed companies
; To stop bad signals from showing up on the map, add the following lines. The Lat and Long are for the plant
; and the Radius is in miles. If more than on plant, set the Lat and Long in the center of all the plants.
VALIDLAT=41.98765
VALIDLONG=-78.97650
VALIDRADIUS=150
SETORDERLOCFROMGPS=0 ;0=Ignore GPS coordinates from status message, 1=Set Order GPS coordinates from On Job, Begin Pour, End Pour status messages
ALLOWRETCONC=1 (3.4+) ;0=Ignore returned concrete from status message, 1=Process returned concrete from status message
TRUCKFILTER=<TruckId> (3.5+) ;only statuses for the specified Truck Id will be processed, all other trucks will be ignored (diagnostics)
; Events that can be configured are as follows
EVENT_BEGINLOAD=
EVENT_ENDLOAD=
EVENT_TOJOB=
EVENT_ONJOB=
EVENT_BEGINPOUR=
EVENT_ENDPOUR=
EVENT_RETURNING=
EVENT_ARRIVEPLANT=
EVENT_INSERVICE=
EVENT_OUTOFSERVICE=
EVENT_CLOCKIN=
EVENT_CLOCKOUT=
EVENT_GPS=
EVENT_PRETICKET=
EVENT_DRIVER_CLOCKIN= (2.7+)
EVENT_DRIVER_CLOCKOUT= (2.7+)
EVENT_RETCONC= (3.4+)
EVENT_ADDWATER= (3.4+)
; Custom Truck Modes
; where n = custom truck mode (integer) - defined in DITCUSTSTAT table
; xxx = custom truck mode value from GPS (string)
CUSTOM_EVENT_n=xxx
</PRE>

===Keystone GPS===
This is the modern Windows / Web Version of Keystone GPS used since 2008. Based on the Keystone Nextel system of early 2000s.
<PRE>
PROTOCOL=KEYSTONEGPS
; The following parameters default to the values shown
IPPORT=7002
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===TrakIt (Integra XML)===
<PRE>
PROTOCOL=INTEGRAXML
MSMQFORMATNAME=DIRECT=OS:.\private$\todispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=1
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=9
EVENT_OUTOFSERVICE=10
</PRE>

===Trimble (XML)===
<PRE>
PROTOCOL=TRIMBLEXML
MSMQFORMATNAME=DIRECT=OS:.\private$\to_dispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=LDS
EVENT_ENDLOAD=LDC
EVENT_TOJOB=TJB
EVENT_ONJOB=AJB
EVENT_BEGINPOUR=POU
EVENT_ENDPOUR=EPR
EVENT_RETURNING=TPL
EVENT_ARRIVEPLANT=IYD
EVENT_INSERVICE=ISV
EVENT_OUTOFSERVICE=OSV
</PRE>

When setting up Trimble (XML), you need to also do the following in Windows:

*Ensure that the Windows Message Queuing Server is installed.
[[File:Windows Message Queuing Feature.PNG|600px]]


*Create the necessary message queues to interface with Trimble.
[[File:Message Queues.PNG|600px]]


*Set the properties for the Trimble message queues.
[[File:Queue Properties.PNG|400px]]


===TrakIt (Legacy Output)===
<PRE>
PROTOCOL=TRAKITLEGACY
IPPORT=???
; Event Defaults are shown below
EVENT_ENDLOAD=4
EVENT_TOJOB=5
EVENT_ONJOB=6
EVENT_BEGINPOUR=7
EVENT_ENDPOUR=8
EVENT_RETURNING=9
EVENT_ARRIVEPLANT=3
EVENT_CLOCKIN=1
EVENT_CLOCKOUT=11
</PRE>

===Nextel Phone===
<PRE>
PROTOCOL=GHNEXTEL
IPPORT=52242
; Event Defaults are shown below
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=1
EVENT_GPS=0
</PRE>
===Trimble (Legacy Output)===
<PRE>
PROTOCOL=TRIMBLELEGACY
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0A
TIMEOUT=500
; Event Defaults are shown below
EVENT_ENDLOAD=1
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=0
</PRE>
===Dinet Status Box===
<PRE>
PROTOCOL=DINET
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0D
TIMEOUT=500
; Event Defaults are shown below
EVENT_BEGINLOAD=0
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=1
EVENT_OUTOFSERVICE=9
</PRE>
===KEYSTONE GPS w/Argo Modem===
<PRE>
PROTOCOL=GHARGO
IPPORT=52243
EOLHEX=23
; Event Defaults are shown below
EVENT_INSERVICE=511
EVENT_BEGINPOUR=521
EVENT_ENDPOUR=531
EVENT_GPS=602
</PRE>

===KEYSTONE GPS w/BlueTree Modem===
<PRE>
PROTOCOL=GHBLUETREE
IPPORT=52242
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=1
</PRE>
===KEYSTONE GPS w/DataRemote Modem===
<PRE>
PROTOCOL=GHDATAREMOTE
IPPORT=52243
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=0
</PRE>
===FileMaker GPS===
<PRE>
PROTOCOL=GHGPS
IPPORT=52241
EOLHEX=0D0A
KEEPALIVE=Y
; Event Defaults are shown below
EVENT_TOJOB=4
EVENT_ONJOB=5
EVENT_BEGINPOUR=1
EVENT_ENDPOUR=2
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=7
EVENT_INSERVICE=3
EVENT_OUTOFSERVICE=8
EVENT_GPS=0
</PRE>

===Verifi Truck Status===
<PRE>
PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.0/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=********************
</PRE>

===RoadKing GPS Status===
<PRE>
PROTOCOL=ROADKING
; The following parameters default to the values shown
URL=/roadking/gps
IPPORT=7003
KEEPALIVE=1
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===Oshkosh Begin/End Pour and Post Pour Wash===
<PRE>
PROTOCOL=OSHKOSH
TIMEOUT=60000
; The following parameters default to the values shown
ROOTURL=https://api.lhptelematics.com/v2/
AUTHUSERNAME=********************
AUTHPASSWORD=********************
MAXPOURMINS=120
; Event Defaults are shown below
EVENT_BEGINPOUR=8
EVENT_ENDPOUR=9
EVENT_BEGINPOSTPOURWASH=10
EVENT_ENDPOSTPOURWASH=11
</PRE>

==Keystone ODBC Configuration (for Keystone GPS support)==

'''NOTE'''
ODBC is no longer used by Keystone GPS. Keystone GPS now uses a REST call. Remove Old ODBC connections where possible.

Install the InterBase ODBC Driver.

Use the 32-bit version of the Windows ODBC Administrator. (On 64-bit Windows you must run the ODBCAD32.EXE located in C:\Windows\SysWOW64.)

Create a new System DSN by clicking the "Add" button.

Enter the appropriate configuration information. Be sure to check the "read" box in the Transaction Options group.

Click the "Test connection" button before saving to verify that the database connection is valid.

GPS/Status Devices

2024-12-06T19:58:47Z

Hhildreth: /* Protocol Choices */

==Device Aggregator and Server Installation==
*Start command prompt as administartor
*From command prompt run the following commands:
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\ccdeviceserver.exe" -install</PRE>
<PRE>"c:\Program Files (x86)\GivenHansco\keystone\bin\CCDeviceAggregator.exe" -install</PRE>

*Start Services
*Verify that both Keystone Device Server and Keystone Device Aggregator are set to start automatically and are running.

==Device Server Properties==
Right Click Tray Icon 
Device Server ID: DS1

==Device Maintenance Setup==

Description: GPS 
Type: GPS/Status 
Dev Server ID: DS1 (default name)

<PRE>PROTOCOL=GHGPS
IPPORT=52241
KEEPALIVE=N
EOLHEX=04
USESERVERTIME=Y</PRE>

==Custom Truck Modes==

Introduced in Keystone 2.7.19, custom truck modes allow miscellaneous truck status information to be gathered from the GPS system and presented on the Dispatch Schedule screen. These modes must be defined in the GPS setup for the GPS device as well as in the Keystone DITCUSTSTAT table. To specify a custom truck mode use the following syntax in Device Maintenance for the GPS device:

<PRE>
CUSTOM_EVENT_<n>=<xxx>
</PRE>

where <n> represents the custom truck mode (integer) and <xxx> represents the custom truck mode value from the GPS device (string.)

The DITCUSTSTAT table maps the integer custom truck mode value to a short alphanumeric code and a longer description as follows:

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Field Name
! Field Type
! Description
|-
| CUSTOM_STATUS
| Integer
| Custom Truck Mode Identifier
|-
| STATUS_CODE
| String(6)
| Short code which appears on Dispatch Schedule truck grid
|-
| DESCRIPTION
| String(35)
| Description which appears on Dispatch Schedule status pop-up
|-
| STATUS_COLOR
| Integer (color)
| Color used to display STATUS_CODE and DESCRIPTION on Dispatch Schedule
|-
| SCHEDULE_SEQ
| Integer
| Determines sequence of custom truck modes on schedule screen negative # = highest priority 0 = no mode positive # = lowest priority
|-
| CLEAR_STATUS_COL
| String(100)
| Specifies statuses that will clear this custom truck mode NULL = never clear * = clear on all statuses except 13 (travel) *1*2*3 = clear on status 1, 2 or 3
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

== Protocol Choices ==

{| border="3" cellspacing="0" cellpadding="3" align="left"
! Protocol
! Device
! Documentation
! Comm Link Type
! Keystone Version
|-
| GHNEXTEL2
| Keystone GPS/(Keystone Nextel Phone)
|
| UDP Server
|
|-
| KEYSTONEGPS
| Keystone GPS (identical to GHNEXTEL2)
|
| UDP Server
|
|-
| TRIMBLEXML
| Trimble (XML)
| [[Media:Trimble_XML_Integration_Interface_2_15_draft.pdf|Trimble XML Integration Interface]]
| MSMQ Server
|
|-
| INTEGRAXML
| TrakIt (Integra XML)
| [[Media:Integra_XML_V2.5.pdf|Integra XML Technical Specification]]
| MSMQ Server
|-
| DIGITALFLEETXML
| Digital Fleet (CALIFORNIA PREVAILING WAGE ONLY -- ONLY USE THIS FOR FROM_DISPATCH DEVICE)
|
| MSMQ Server
|-
| TRAKITLEGACY
| TrakIt (Legacy Output)
|
| UDP Server
|
|-
| TRIMBLELEGACY
| Trimble (Legacy Output)
|
| Serial Server
|
|-
| GHGPS
| FileMaker GPS
|
| TCP Server
|
|-
| GHNEXTEL
| Nextel Phone
|
| UDP Server
|
|-
| DINET
| Dinet Status Box
|
| Serial Server
|
|-
| GHARGO
| KEYSTONE GPS w/Argo Modem
|
| TCP Server
|
|-
| GHBLUETREE
| KEYSTONE GPS w/BlueTree Modem
|
| UDP Server
|
|-
| GHDATAREMOTE
| KEYSTONE GPS w/DataRemote Modem
|
| UDP Server
|
|-
| VERIFI
| Verifi Truck Status (XML)
| [[Media:Subscription_API_for_signalling.pdf|Verifi Truck Status XML Interface]] [[Media:Signalling_Response.pdf|Verifi Truck Status XML Response]]
| Polled REST Server
| 3.4.5.6
|-
| ROADKING
| RoadKing GPS (JSON)
|
| HTTP Server
| 3.6.15.5
|-
| OSHKOSH
| Oshkosh Begin/End Pour and Post Pour Wash (JSON)
| [http://lhptwebapi-t.cloudapp.net/Help/Api/GET-v2-AssetReportEvents Oshkosh AssetReportEvents API]
| Polled REST Server
| 4.1.2.2
|}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

==Protocol Notes==
===Integra XML Configuration (TrakIt)===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is CHECKED):
*fromdispatch
*todispatch

The PC running TrakitWare must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrakitWare.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Trimble XML Configuration===

Windows Message Queuing Services must be installed on the PC running Keystone Device Server.
In addition, the following private message queues must be created on the PC (make sure the "Transactional" checkbox is UNCHECKED):
*from_dispatch
*to_dispatch

The PC running TrimExchange must be configured to read/write from/to the PC containing these message queues. (The simplest configuration occurs when Keystone Device Server is installed on the same PC as TrimExchange.)
If the PC running Keystone Device Server contains a firewall it must be configured according to these instructions:
http://support.microsoft.com/kb/183293

===Filemaker GPS Startup===
Double Click the GPS Shortcut 
LOGIN: GPS 
Click: Connect 
Minimize 

===Bluetree GPS Modem===

Diagnostics:
<PRE>TELNET <modem_ip> 6070</PRE>
Command to see IP address that modem is connecting to:
<PRE>AT+BRPRDS?</PRE>

===RoadKing GPS Sample JSON Content===
<PRE>
{
"TruckEvent": {
"OrderNumber": "117393",
"TruckNumber": "108",
"Date": "2020/07/30",
"Time": "15:50:34",
"EventCode": "9"
}
}
</PRE>

===Oshkosh Begin/End Pour Sample JSON Content===
<PRE>
[
{
"AssetId": 42490,
"ReportEventTypeId": 7,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T01:16:22",
"Latitude": 43.981525,
"Longitude": -88.545744
},
{
"AssetId": 42490,
"ReportEventTypeId": 8,
"AssetName": "TEST001",
"Vin": "99999BEN1HTEST001",
"Timestamp": "2020-10-22T02:15:20",
"Latitude": 43.98158,
"Longitude": -88.545723
}
]
</PRE>

==Sample Configurations==
===Common Device Parameters===
<PRE>
USESERVERTIME=0 ;0=Use time from status message, 1=Substitute current clock time in status message
USEGEOFENCING=0 ;0=Disable geofencing, 1=Use geofencing to determine on job/at plant status
USEODOMETER=1 ;0=Estimate odometer using distance formula, 1=Use odometer field from status message
USEPLANTNO=0 ;0=Ignore plant number from status message, 1=Use plant number from Arrive Plant/In Service status message
ONJOBSTOPTIME=6 ;0=Disable on job stop time, 1=Move to on job status if truck stopped more than x minutes
GPSCOMPANIES=<CoId>[,<CoId>]* ;if truck is not found in current company, check each of the listed companies
; To stop bad signals from showing up on the map, add the following lines. The Lat and Long are for the plant
; and the Radius is in miles. If more than on plant, set the Lat and Long in the center of all the plants.
VALIDLAT=41.98765
VALIDLONG=-78.97650
VALIDRADIUS=150
SETORDERLOCFROMGPS=0 ;0=Ignore GPS coordinates from status message, 1=Set Order GPS coordinates from On Job, Begin Pour, End Pour status messages
ALLOWRETCONC=1 (3.4+) ;0=Ignore returned concrete from status message, 1=Process returned concrete from status message
TRUCKFILTER=<TruckId> (3.5+) ;only statuses for the specified Truck Id will be processed, all other trucks will be ignored (diagnostics)
; Events that can be configured are as follows
EVENT_BEGINLOAD=
EVENT_ENDLOAD=
EVENT_TOJOB=
EVENT_ONJOB=
EVENT_BEGINPOUR=
EVENT_ENDPOUR=
EVENT_RETURNING=
EVENT_ARRIVEPLANT=
EVENT_INSERVICE=
EVENT_OUTOFSERVICE=
EVENT_CLOCKIN=
EVENT_CLOCKOUT=
EVENT_GPS=
EVENT_PRETICKET=
EVENT_DRIVER_CLOCKIN= (2.7+)
EVENT_DRIVER_CLOCKOUT= (2.7+)
EVENT_RETCONC= (3.4+)
EVENT_ADDWATER= (3.4+)
; Custom Truck Modes
; where n = custom truck mode (integer) - defined in DITCUSTSTAT table
; xxx = custom truck mode value from GPS (string)
CUSTOM_EVENT_n=xxx
</PRE>

===Keystone GPS===
This is the modern Windows / Web Version of Keystone GPS used since 2008. Based on the Keystone Nextel system of early 2000s.
<PRE>
PROTOCOL=KEYSTONEGPS
; The following parameters default to the values shown
IPPORT=7002
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===TrakIt (Integra XML)===
<PRE>
PROTOCOL=INTEGRAXML
MSMQFORMATNAME=DIRECT=OS:.\private$\todispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=1
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=9
EVENT_OUTOFSERVICE=10
</PRE>

===Trimble (XML)===
<PRE>
PROTOCOL=TRIMBLEXML
MSMQFORMATNAME=DIRECT=OS:.\private$\to_dispatch
; Event Defaults are shown below
EVENT_BEGINLOAD=LDS
EVENT_ENDLOAD=LDC
EVENT_TOJOB=TJB
EVENT_ONJOB=AJB
EVENT_BEGINPOUR=POU
EVENT_ENDPOUR=EPR
EVENT_RETURNING=TPL
EVENT_ARRIVEPLANT=IYD
EVENT_INSERVICE=ISV
EVENT_OUTOFSERVICE=OSV
</PRE>

When setting up Trimble (XML), you need to also do the following in Windows:

*Ensure that the Windows Message Queuing Server is installed.
[[File:Windows Message Queuing Feature.PNG|600px]]


*Create the necessary message queues to interface with Trimble.
[[File:Message Queues.PNG|600px]]


*Set the properties for the Trimble message queues.
[[File:Queue Properties.PNG|400px]]


===TrakIt (Legacy Output)===
<PRE>
PROTOCOL=TRAKITLEGACY
IPPORT=???
; Event Defaults are shown below
EVENT_ENDLOAD=4
EVENT_TOJOB=5
EVENT_ONJOB=6
EVENT_BEGINPOUR=7
EVENT_ENDPOUR=8
EVENT_RETURNING=9
EVENT_ARRIVEPLANT=3
EVENT_CLOCKIN=1
EVENT_CLOCKOUT=11
</PRE>

===Nextel Phone===
<PRE>
PROTOCOL=GHNEXTEL
IPPORT=52242
; Event Defaults are shown below
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=1
EVENT_GPS=0
</PRE>
===Trimble (Legacy Output)===
<PRE>
PROTOCOL=TRIMBLELEGACY
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0A
TIMEOUT=500
; Event Defaults are shown below
EVENT_ENDLOAD=1
EVENT_TOJOB=2
EVENT_ONJOB=3
EVENT_BEGINPOUR=4
EVENT_ENDPOUR=5
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=0
</PRE>
===Dinet Status Box===
<PRE>
PROTOCOL=DINET
COMPORT=1
BAUDRATE=9600
DATABITS=8
STOPBITS=1
PARITY=N
EOLHEX=0D
TIMEOUT=500
; Event Defaults are shown below
EVENT_BEGINLOAD=0
EVENT_ENDLOAD=2
EVENT_TOJOB=3
EVENT_ONJOB=4
EVENT_BEGINPOUR=5
EVENT_ENDPOUR=6
EVENT_RETURNING=7
EVENT_ARRIVEPLANT=8
EVENT_INSERVICE=1
EVENT_OUTOFSERVICE=9
</PRE>
===KEYSTONE GPS w/Argo Modem===
<PRE>
PROTOCOL=GHARGO
IPPORT=52243
EOLHEX=23
; Event Defaults are shown below
EVENT_INSERVICE=511
EVENT_BEGINPOUR=521
EVENT_ENDPOUR=531
EVENT_GPS=602
</PRE>

===KEYSTONE GPS w/BlueTree Modem===
<PRE>
PROTOCOL=GHBLUETREE
IPPORT=52242
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=1
</PRE>
===KEYSTONE GPS w/DataRemote Modem===
<PRE>
PROTOCOL=GHDATAREMOTE
IPPORT=52243
; Event Defaults are shown below
EVENT_BEGINPOUR=2
EVENT_ENDPOUR=3
EVENT_GPS=0
</PRE>
===FileMaker GPS===
<PRE>
PROTOCOL=GHGPS
IPPORT=52241
EOLHEX=0D0A
KEEPALIVE=Y
; Event Defaults are shown below
EVENT_TOJOB=4
EVENT_ONJOB=5
EVENT_BEGINPOUR=1
EVENT_ENDPOUR=2
EVENT_RETURNING=6
EVENT_ARRIVEPLANT=7
EVENT_INSERVICE=3
EVENT_OUTOFSERVICE=8
EVENT_GPS=0
</PRE>

===Verifi Truck Status===
<PRE>
PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.0/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=********************
</PRE>

===RoadKing GPS Status===
<PRE>
PROTOCOL=ROADKING
; The following parameters default to the values shown
URL=/roadking/gps
IPPORT=7003
KEEPALIVE=1
; Event Defaults are shown below
EVENT_ENDLOAD=5
EVENT_TOJOB=8
EVENT_ONJOB=9
EVENT_BEGINPOUR=10
EVENT_ENDPOUR=11
EVENT_RETURNING=12
EVENT_ARRIVEPLANT=4
EVENT_INSERVICE=2
EVENT_OUTOFSERVICE=14
EVENT_DRIVER_CLOCKIN=1
EVENT_DRIVER_CLOCKOUT=15
EVENT_RETCONC=17
EVENT_ADDWATER=18
EVENT_GPS=20
</PRE>

===Oshkosh Begin/End Pour and Post Pour Wash===
<PRE>
PROTOCOL=OSHKOSH
TIMEOUT=60000
; The following parameters default to the values shown
ROOTURL=https://api.lhptelematics.com/v2/
AUTHUSERNAME=********************
AUTHPASSWORD=********************
MAXPOURMINS=120
; Event Defaults are shown below
EVENT_BEGINPOUR=8
EVENT_ENDPOUR=9
EVENT_BEGINPOSTPOURWASH=10
EVENT_ENDPOSTPOURWASH=11
</PRE>

==Keystone ODBC Configuration (for Keystone GPS support)==

'''NOTE'''
ODBC is no longer used by Keystone GPS. Keystone GPS now uses a REST call. Remove Old ODBC connections where possible.

Install the InterBase ODBC Driver.

Use the 32-bit version of the Windows ODBC Administrator. (On 64-bit Windows you must run the ODBCAD32.EXE located in C:\Windows\SysWOW64.)

Create a new System DSN by clicking the "Add" button.

Enter the appropriate configuration information. Be sure to check the "read" box in the Transaction Options group.

Click the "Test connection" button before saving to verify that the database connection is valid.

Ticket Form Fields

2024-09-05T17:59:36Z

Hhildreth: /* Calculated Fields */

==Ticket Fields==

'''Note:''' These is the list of fields direct from the select query. Aliases such as "TH." and "CU." are not part of the field name used for tickets. Therefore use "SLUMP" not "TH.SLUMP" etc.

<PRE>
TH.SESSION_NO, TH.TRANS_NO,
TH.CUST_NO, TH.TICKET_NO, TH.TICKET_DATE,
TH.SLUMP, TH.MILES, TH.TICKET_TIME, TGT_ARRIVE_JOB_DT
TH.SALESPERSON, TH.SYS_LOC, TH.PLANT_NO,
TH.TAX_AUTHORITY, TH.JOB_PO_LOC, TH.JOB_LOT,
TH.JOB_BLOCK, TH.ORDER_CODE, TH.ORDER_SESSION_NO,
TH.ORDER_TRANS_NO, TH.ORDER_LOAD_NO, TH.TRUCK_NO, TH.TRAILER_1,
TH.TRAILER_2, TH.SOURCE_FLAG, TH.VOID_FLAG,
TH.PRICED_FLAG, TH.OFFICE_PRICE_FLAG, TH.ZONE,
TH.COD_FLAG,
TH.ELAPSED_TIME,
TH.BATCH_START_DT, TH.BATCH_END_DT,
TH.LEAVE_PLANT_DT, TH.ARRIVE_JOB_DT,
TH.BEGIN_POUR_DT, TH.END_POUR_DT,
TH.LEAVE_JOB_DT, TH.RETURN_PLANT_DT,
TH.CUSTOMER_PO, TH.DRIVER, TH.PAYMENT_AMOUNT,
TH.CHECK_DATE, TH.CHECK_NO,
TH.BANK_NO, TH.SHIP_TO_1, TH.SHIP_TO_2,
TH.SHIP_TO_3, TH.SHIP_TO_4, TH.DELV_INST_1,
TH.DELV_INST_2, TH.DELV_INST_3, TH.DELV_INST_4,
TH.WEATHER,
TH.WEIGHMASTER, TH.CUSTOM_1, TH.CUSTOM_2,
TH.USAGE_TYPE,
TD.LINE_NO, TD.COMMENT_FLAG, TD.UNIT_PRICE,
TD.QTY_SOLD,
TD.PRODUCT_CODE, TD.UNIT_OF_MEASURE,
TD.DESCRIPTION,
TD.TAX_CODE, TD.TAX_CODE_2, TD.TAX_CODE_3,
TD.PRICE_SOURCE,
TD.GROSS_WEIGHT, TD.TARE_WEIGHT, TD.WEIGHT_UMS,
TD.SCALE_WEIGHT_FLAG,
TH.COMMENT_1, TH.COMMENT_2, TH.NOTES_1, TH.NOTES_2, TH.ORDER_BALANCE,
TH.AMT_TEND, TH.INV_ADJUST_FLAG, TH.CLOSED_FLAG, TD.UNIT_PCT_DISC, TD.QTY_DELIVERED,
TD.QTY_ORDERED, TD.ORDER_LINE_NO,
CU.NAME, CU.ADDRESS_1, CU.ADDRESS_2, CU.CITY,
CU.STATE, CU.ZIP, CU.TERMS_CLASS CUST_TERMS_CLASS,
CU.USER_1 CUST_USER_1,
CU.USER_2 CUST_USER_2,
CU.NOTES_1 CUST_NOTES_1,
CU.NOTES_2 CUST_NOTES_2,
CU.NOTES_3 CUST_NOTES_3,
CU.NOTES_4 CUST_NOTES_4,
TA.DESCRIPTION TAX_AUTHORITY_NAME,
PL.PLANT_NAME PLANT_ADDR1, PL.ADDRESS_1 PLANT_ADDR2, PL.ADDRESS_2 PLANT_ADDR3,
DR.DRIVER_NAME,
PR.PRODUCT_TYPE,
PR.ROLLUP_FLAG,
PR.DESCRIPTION_1 PROD_DESCRIPTION_1,
PR.DESCRIPTION_2 PROD_DESCRIPTION_2,
PR.BASE_PRODUCT,
PR.LIST_PRICE,
CT.DESCRIPTION TERMS_CLASS_DESC,
PC.SUBTOTAL PCL_SUBTOTAL,
UM.SUBTOTAL UMS_SUBTOTAL,
UM.UMS_TYPE, UM.EXPANDED_UMS,
TR.PLATE_NUMBER, TR.OWNER_CODE,
TR.LEGAL_MAX_WEIGHT,
TR.VIN_NUMBER,
TR.TRUCK_MAKE, TR.TRUCK_MODEL, TR.TRUCK_YEAR,
OW.OWNER_NAME,
UC.DESCRIPTION USAGE_DESC,
SP.DESCRIPTION SALESPERSON_NAME,
WM.NAME WM_NAME, WM.LICENSE_NO WM_LICENSE_NO,
WM.LICENSE_EXP_DATE WM_LICENSE_EXP_DATE,
WM.USER_1 WM_USER_1, WM.USER_2 WM_USER_2,
WM.SIGNATURE_IMAGE WM_SIGNATURE_IMAGE,
WM.SIGNATURE_IMAGE_EXT WM_SIGNATURE_IMAGE_EXT
</PRE>

==Calculated Fields==
<PRE>
CALC_CUSTADDR1 CALC_CUSTADDR2 CALC_CUSTADDR3 CALC_CUSTADDR4
CALC_EXTAMOUNT
CALC_PRICEDTICKET
CALC_SUBTOTAL
CALC_SALESTAX
CALC_TICKETTOTAL
CALC_BALDUE
UNIT_PRICE
UNIT_PCT_DISC
TAX_CODE
CALC_TICKETSTODAY
CALC_MATLTOTAL
CALC_DELVTOTAL
CALC_WEIGHMASTER
COND_PRICEDTICKET
COND_WEIGHTS
COND_COMMENT
COND_LINE_1
COND_COD
COND_MANUALWEIGHT
COND_WEIGHMASTER
CALC_NONTAXTOTAL
ORDER_NOTES_1 ORDER_NOTES_2
CALC_PREVORDERBAL
CALC_NEWORDERBAL
COND_CONCRETETICKET
CALC_TAXABLETOTAL
CALC_CHANGEDUE
CALC_DISCTOTAL
CALC_NETDUEAFTERDISC
CALC_TICKETSTODATE
ORDER_DELV_TIME
COND_ORDER_PLUS
TAXCOL1_AMOUNT
TAXCOL2_AMOUNT
TAXCOL3_AMOUNT
TAXCOL1_LABEL
TAXCOL2_LABEL
TAXCOL3_LABEL
ORDER_CEMENT
ORDER_PCT_CALCIUM
ORDER_PCT_AIR
CALC_ORDERTOTAL
ORDER_TAKEN_BY
ORDER_TAKEN_ON
ORDER_CONTACT
ORDER_PHONE_NO
ORDER_PREV_TRUCK
ORDER_PREV_DRIVER
COND_PRODTYPE_MIX
COND_PRODTYPE_ING
COND_PRODTYPE_AGG
COND_PRODTYPE_DEL
CALC_LISTSUBTOTAL
CALC_LISTTAXTOTAL
CALC_LISTTOTAL
CALC_SAVINGS
</PRE>

===Calc Items with U/M===
<PRE>
CALC_NET_WEIGHT Unit Type:Weight
GROSS_WEIGHT Unit Type:Weight
TARE_WEIGHT Unit Type:Weight
CALC_DELVTODATE Unit Type:Quantity (Qty for an order)
CALC_QTYTODAY Unit Type:Quantity (Qty by Job Name)
CALC_ORDQTYDELV Unit Type:Quantity
CALC_ORDQTYREMAIN Unit Type:Quantity
MILES Unit Type:Miles
QTY_SOLD Unit Type:Quantity
QTY_DELIVERED Unit Type:Quantity
QTY_ORDERED Unit Type:Quantity
CALC_ORDQTYAMT Unit Type:Quantity
LEGAL_MAX_WEIGHT Unit Type:Weight
CALC_L1_QTY_ORDERED Unit Type:Quantity
CALC_L1_QTY_DELIVERED Unit Type:Quantity
CALC_L1_QTY_REMAINING Unit Type:Quantity)
</PRE>

==Copies, Multiple Copies, Samepage Copies & New Page==
<PRE>
SAME PAGE COPIES
Top of Form COPIES X, SAMEPAGE (Replace X with Number of copies)
Bottom of Form BEGINCOPY X (ADD DETAIL BELOW) (Replace X with the copy number) (eg. BEGINGCOPY 1)
After Copy X ENDCOPY (eg. ENDCOPY )

NEWPAGE NEWPAGE (ADD DETAIL BELOW)
</PRE>

Ticket Form Fields

2024-09-05T17:58:47Z

Hhildreth: /* Ticket Fields */

==Ticket Fields==

'''Note:''' These is the list of fields direct from the select query. Aliases such as "TH." and "CU." are not part of the field name used for tickets. Therefore use "SLUMP" not "TH.SLUMP" etc.

<PRE>
TH.SESSION_NO, TH.TRANS_NO,
TH.CUST_NO, TH.TICKET_NO, TH.TICKET_DATE,
TH.SLUMP, TH.MILES, TH.TICKET_TIME, TGT_ARRIVE_JOB_DT
TH.SALESPERSON, TH.SYS_LOC, TH.PLANT_NO,
TH.TAX_AUTHORITY, TH.JOB_PO_LOC, TH.JOB_LOT,
TH.JOB_BLOCK, TH.ORDER_CODE, TH.ORDER_SESSION_NO,
TH.ORDER_TRANS_NO, TH.ORDER_LOAD_NO, TH.TRUCK_NO, TH.TRAILER_1,
TH.TRAILER_2, TH.SOURCE_FLAG, TH.VOID_FLAG,
TH.PRICED_FLAG, TH.OFFICE_PRICE_FLAG, TH.ZONE,
TH.COD_FLAG,
TH.ELAPSED_TIME,
TH.BATCH_START_DT, TH.BATCH_END_DT,
TH.LEAVE_PLANT_DT, TH.ARRIVE_JOB_DT,
TH.BEGIN_POUR_DT, TH.END_POUR_DT,
TH.LEAVE_JOB_DT, TH.RETURN_PLANT_DT,
TH.CUSTOMER_PO, TH.DRIVER, TH.PAYMENT_AMOUNT,
TH.CHECK_DATE, TH.CHECK_NO,
TH.BANK_NO, TH.SHIP_TO_1, TH.SHIP_TO_2,
TH.SHIP_TO_3, TH.SHIP_TO_4, TH.DELV_INST_1,
TH.DELV_INST_2, TH.DELV_INST_3, TH.DELV_INST_4,
TH.WEATHER,
TH.WEIGHMASTER, TH.CUSTOM_1, TH.CUSTOM_2,
TH.USAGE_TYPE,
TD.LINE_NO, TD.COMMENT_FLAG, TD.UNIT_PRICE,
TD.QTY_SOLD,
TD.PRODUCT_CODE, TD.UNIT_OF_MEASURE,
TD.DESCRIPTION,
TD.TAX_CODE, TD.TAX_CODE_2, TD.TAX_CODE_3,
TD.PRICE_SOURCE,
TD.GROSS_WEIGHT, TD.TARE_WEIGHT, TD.WEIGHT_UMS,
TD.SCALE_WEIGHT_FLAG,
TH.COMMENT_1, TH.COMMENT_2, TH.NOTES_1, TH.NOTES_2, TH.ORDER_BALANCE,
TH.AMT_TEND, TH.INV_ADJUST_FLAG, TH.CLOSED_FLAG, TD.UNIT_PCT_DISC, TD.QTY_DELIVERED,
TD.QTY_ORDERED, TD.ORDER_LINE_NO,
CU.NAME, CU.ADDRESS_1, CU.ADDRESS_2, CU.CITY,
CU.STATE, CU.ZIP, CU.TERMS_CLASS CUST_TERMS_CLASS,
CU.USER_1 CUST_USER_1,
CU.USER_2 CUST_USER_2,
CU.NOTES_1 CUST_NOTES_1,
CU.NOTES_2 CUST_NOTES_2,
CU.NOTES_3 CUST_NOTES_3,
CU.NOTES_4 CUST_NOTES_4,
TA.DESCRIPTION TAX_AUTHORITY_NAME,
PL.PLANT_NAME PLANT_ADDR1, PL.ADDRESS_1 PLANT_ADDR2, PL.ADDRESS_2 PLANT_ADDR3,
DR.DRIVER_NAME,
PR.PRODUCT_TYPE,
PR.ROLLUP_FLAG,
PR.DESCRIPTION_1 PROD_DESCRIPTION_1,
PR.DESCRIPTION_2 PROD_DESCRIPTION_2,
PR.BASE_PRODUCT,
PR.LIST_PRICE,
CT.DESCRIPTION TERMS_CLASS_DESC,
PC.SUBTOTAL PCL_SUBTOTAL,
UM.SUBTOTAL UMS_SUBTOTAL,
UM.UMS_TYPE, UM.EXPANDED_UMS,
TR.PLATE_NUMBER, TR.OWNER_CODE,
TR.LEGAL_MAX_WEIGHT,
TR.VIN_NUMBER,
TR.TRUCK_MAKE, TR.TRUCK_MODEL, TR.TRUCK_YEAR,
OW.OWNER_NAME,
UC.DESCRIPTION USAGE_DESC,
SP.DESCRIPTION SALESPERSON_NAME,
WM.NAME WM_NAME, WM.LICENSE_NO WM_LICENSE_NO,
WM.LICENSE_EXP_DATE WM_LICENSE_EXP_DATE,
WM.USER_1 WM_USER_1, WM.USER_2 WM_USER_2,
WM.SIGNATURE_IMAGE WM_SIGNATURE_IMAGE,
WM.SIGNATURE_IMAGE_EXT WM_SIGNATURE_IMAGE_EXT
</PRE>

==Calculated Fields==
<PRE>
CALC_CUSTADDR1 CALC_CUSTADDR2 CALC_CUSTADDR3 CALC_CUSTADDR4
CALC_EXTAMOUNT
CALC_PRICEDTICKET
CALC_SUBTOTAL
CALC_SALESTAX
CALC_TICKETTOTAL
CALC_BALDUE
UNIT_PRICE
UNIT_PCT_DISC
TAX_CODE
CALC_TICKETSTODAY
CALC_MATLTOTAL
CALC_DELVTOTAL
CALC_WEIGHMASTER
COND_PRICEDTICKET
COND_WEIGHTS
COND_COMMENT
COND_LINE_1
COND_COD
COND_MANUALWEIGHT
COND_WEIGHMASTER
CALC_NONTAXTOTAL
ORDER_NOTES_1 ORDER_NOTES_2
CALC_PREVORDERBAL
CALC_NEWORDERBAL
COND_CONCRETETICKET
CALC_TAXABLETOTAL
CALC_CHANGEDUE
CALC_DISCTOTAL
CALC_NETDUEAFTERDISC
CALC_TICKETSTODATE
ORDER_DELV_TIME
COND_ORDER_PLUS
TAXCOL1_AMOUNT
TAXCOL2_AMOUNT
TAXCOL3_AMOUNT
TAXCOL1_LABEL
TAXCOL2_LABEL
TAXCOL3_LABEL
ORDER_CEMENT
ORDER_PCT_CALCIUM
ORDER_PCT_AIR
CALC_ORDERTOTAL
ORDER_TAKEN_BY
ORDER_TAKEN_ON
ORDER_CONTACT
ORDER_PHONE_NO
ORDER_PREV_TRUCK
ORDER_PREV_DRIVER
COND_PRODTYPE_MIX
COND_PRODTYPE_ING
COND_PRODTYPE_AGG
COND_PRODTYPE_DEL
</PRE>

===Calc Items with U/M===
<PRE>
CALC_NET_WEIGHT Unit Type:Weight
GROSS_WEIGHT Unit Type:Weight
TARE_WEIGHT Unit Type:Weight
CALC_DELVTODATE Unit Type:Quantity (Qty for an order)
CALC_QTYTODAY Unit Type:Quantity (Qty by Job Name)
CALC_ORDQTYDELV Unit Type:Quantity
CALC_ORDQTYREMAIN Unit Type:Quantity
MILES Unit Type:Miles
QTY_SOLD Unit Type:Quantity
QTY_DELIVERED Unit Type:Quantity
QTY_ORDERED Unit Type:Quantity
CALC_ORDQTYAMT Unit Type:Quantity
LEGAL_MAX_WEIGHT Unit Type:Weight
CALC_L1_QTY_ORDERED Unit Type:Quantity
CALC_L1_QTY_DELIVERED Unit Type:Quantity
CALC_L1_QTY_REMAINING Unit Type:Quantity)
</PRE>

==Copies, Multiple Copies, Samepage Copies & New Page==
<PRE>
SAME PAGE COPIES
Top of Form COPIES X, SAMEPAGE (Replace X with Number of copies)
Bottom of Form BEGINCOPY X (ADD DETAIL BELOW) (Replace X with the copy number) (eg. BEGINGCOPY 1)
After Copy X ENDCOPY (eg. ENDCOPY )

NEWPAGE NEWPAGE (ADD DETAIL BELOW)
</PRE>

Configuring Keystone for E-Ticketing

2024-07-24T14:48:17Z

Hhildreth: /* Configuration */

==Introduction==

Keystone 3.4 and higher support Keystone Online Ticketing (E-Ticketing).

==Configuration==

The configuration process is currently a mixture of Keystone options and manual editing using IBConsole. This will be improved in a future Keystone release. '''If more than one company is utilizing E-Ticketing, make that company its own folder so that there is no overlap of tickets.'''

# Using Keystone System Option Maintenance, set the following two options for the DEFAULT user to checked:
#: System-Wide->Doc Imaging Active
#: System-Wide->Doc Imaging Installed
# Logout/Login to Keystone, under Document Imaging open the Doc System Maintenance option. Add the following record:
#: Doc Sys ID: 1
#: Description: Keystone Online Ticketing
#: DB Type: Interbase
# Under Document Imaging open the Doc Type Maintenance option. Add the following record:
#: Doc Type ID: 11
#: Description: Keystone Online Tickets
#: Doc System ID: 1
#: Source App: E
#: Source Table: T
#: Doc Type: TK
# Add a second record:
#: Doc Type ID: 12
#: Description: Keystone Online Batch Weights
#: Doc System ID: 1
#: Source App: E
#: Source Table: B
#: Doc Type: BW
# Using IBConsole, open the CCWDOC.IB database, and open the DOTDOCPATH table. Add the following record:
#: PATH_ID: 1
#: DESCRIPTION: Keystone Online Tickets
#: PATH: <the path on the server where you want to store e-tickets (suggestion: D:\CCGH\BACKUP\Tickets)>
# Open the DOTDOCTYPE table. Update both records in the table, set DOC_PATH_ID to 1.

==Invoice Form==

To include e-ticket images on invoices, add these lines to the bottom of the invoice form(s):

<pre>
! ---------- Ticket Document Image
DETAIL 5
LINE 4 COLUMN 1 LEFT 80 IMAGEFIELD TICKET DOC_ID
</pre>

Configuring Keystone for E-Ticketing

2024-04-26T17:28:22Z

Hhildreth: /* Configuration */

==Introduction==

Keystone 3.4 and higher support Keystone Online Ticketing (E-Ticketing).

==Configuration==

The configuration process is currently a mixture of Keystone options and manual editing using IBConsole. This will be improved in a future Keystone release. '''If more than one company is utilizing E-Ticketing, make that company its own folder so that there is no overlap of tickets.'''

# Using Keystone System Option Maintenance, set the following two options for the DEFAULT user to checked:
#: System-Wide->Doc Imaging Active
#: System-Wide->Doc Imaging Installed
# Logout/Login to Keystone, under Document Imaging open the Doc System Maintenance option. Add the following record:
#: Doc Sys ID: 1
#: Description: Keystone Online Ticketing
#: DB Type: Interbase
# Under Document Imaging open the Doc Type Maintenance option. Add the following record:
#: Doc Type ID: 11
#: Description: Keystone Online Tickets
#: Doc System ID: 1
#: Source App: E
#: Source Table: T
#: Doc Type: TK
# Add a second record:
#: Doc Type ID: 12
#: Description: Keystone Online Batch Weights
#: Doc System ID: 1
#: Source App: E
#: Source Table: B
#: Doc Type: BW
# Using IBConsole, open the CCWDOC.IB database, and open the DOTDOCPATH table. Add the following record:
#: PATH_ID: 1
#: DESCRIPTION: Keystone Online Tickets
#: PATH: <the path on the server where you want to store e-tickets (suggestion: D:\CCGH\Tickets)>
# Open the DOTDOCTYPE table. Update both records in the table, set DOC_PATH_ID to 1.

==Invoice Form==

To include e-ticket images on invoices, add these lines to the bottom of the invoice form(s):

<pre>
! ---------- Ticket Document Image
DETAIL 5
LINE 4 COLUMN 1 LEFT 80 IMAGEFIELD TICKET DOC_ID
</pre>

Quote Form Fields

2023-11-17T19:21:36Z

Hhildreth: /* Calculated Fields */

Quote form Fields
(Oct. 10, 2019 ver. 3.6)

===Selected Fields===

<PRE>
CAST(' + IntToStr(i) + ' AS INTEGER) LOCPRODCLASS,
QH.PROSPECT_NO, QH.JOB_PO_LOC, QH.SALESPERSON, QC.D_AND_B_RATING,
QH.FOLLOW_UP_DATE, QH.WON_LOST_FLAG, QH.REASON_CODE,
QH.EXPIRATION_DATE, QH.SESSION_NO, QH.TRANS_NO, QD.LINE_NO,
QH.*, QD.*,
QC.NAME,
QC.ADDRESS_1,
QC.ADDRESS_2,
QC.CITY,
QC.STATE,
QC.ZIP,
QC.CLASS,
QC.D_AND_B_RATING,
QC.PHONE_NO CUST_PHONE_NO,
QC.FAX_NO CUST_FAX_NO,
(0) TAX_RATE,
SL.DESCRIPTION SLSPN_NAME,
SL.JOB_TITLE SLSPN_JOB_TITLE,
SL.PHONE_NO SLSPN_PHONE_NO,
SL.CELL_NO SLSPN_CELL_NO,
SL.FAX_NO SLSPN_FAX_NO,
SL.EMAIL SLSPN_EMAIL,
SL.USER_1 SLSPN_USER_1,
SL.USER_2 SLSPN_USER_2,
SL.SIGNATURE_IMAGE SL_SIGNATURE_IMAGE,
SL.SIGNATURE_IMAGE_EXT SL_SIGNATURE_IMAGE_EXT,
CT.DESCRIPTION TERMS_DESC,
PL.PLANT_NAME, PL.PLANT_SCREEN_ID,
PL.ADDRESS_1 PLANT_ADDRESS_1, PL.ADDRESS_2 PLANT_ADDRESS_2,
PL.PHONE_NO PLANT_PHONE_NO,
PR.PRODUCT_TYPE, PR.PLANT_NO PROD_PLANT_NO,
PL2.PLANT_NAME PROD_PLANT_NAME, PL2.PLANT_SCREEN_ID PROD_PLANT_SCREEN_ID,
UC.DESCRIPTION USAGE_DESC
FROM ' + VIEW_QTPROSP_CUST_LIST + ' QC
INNER JOIN ' + TBL_QTJOBHD + ' QH ON (QH.PROSPECT_NO = QC.PROSPECT_NO)
INNER JOIN ' + TBL_QTJOBDT + ' QD ON (QH.SESSION_NO = QD.SESSION_NO) AND (QH.TRANS_NO = QD.TRANS_NO)
LEFT OUTER JOIN ' + TBL_ARSLSPER + ' SL ON (QH.SALESPERSON = SL.CLASS_NO)
LEFT OUTER JOIN ' + TBL_ARCTMCLS + ' CT ON (QH.TERMS_CLASS = CT.CLASS_NO)
LEFT OUTER JOIN ' + TBL_ARPROD + ' PR ON (PR.PRODUCT_CODE = QD.PRODUCT_CODE)
LEFT OUTER JOIN ' + TBL_ARPLANT + ' PL ON (PL.PLANT_NO = QH.PLANT_NO)
LEFT OUTER JOIN ' + TBL_ARPLANT + ' PL2 ON (PL2.PLANT_NO = PR.PLANT_NO)
LEFT OUTER JOIN ' + TBL_DIUSECLS + ' UC ON (UC.CLASS_NO = QH.USAGE_TYPE)
</PRE>

===Calculated Fields===
<PRE>
CALC_CUSTADDR1
CALC_CUSTADDR2
CALC_CUSTADDR3
CALC_CUSTADDR4
CALC_RETADDR1
CALC_RETADDR2
CALC_RETADDR3
CALC_RETADDR4
CALC_SYSDATE
CALC_ORDTAXABLE
CALC_ORDNONTAX
CALC_ORDSUBTOTAL
CALC_ORDTAXTOTAL
CALC_ORDTOTAL
CALC_LISTSUBTOTAL
CALC_LISTTAXTOTAL
CALC_LISTTOTAL
CALC_SAVINGS
CALC_DISCOUNT
CALC_COSTTOTAL
CALC_PROFIT
COND_PRTRETADDR
COND_INTERNAL
COND_PRTLISTS
CALC_USERID
CALC_EXTPRICE
CALC_DISC_UNITPRICE
CALC_DISC_EXTPRICE
COND_COMMENT
CALC_DISCTOTAL
CALC_DISC_ORDSUBTOTAL
CALC_DISC_ORDTOTAL
CALC_UNIT_DISC
CALC_UNIT_TAX
CALC_UNIT_NET
CONDITION_1
CONDITION_2
CONDITION_3
CONDITION_4
CONDITION_5
CONDITION_6
CONDITION_7
CONDITION_8
CALC_DISCTAXTOTAL
CALC_DISCTAX_ORDTOTAL
CALC_DISCSAVINGS
COND_PRODTYPE_MIX
COND_PRODTYPE_ING
COND_PRODTYPE_AGG
COND_PRODTYPE_DEL
CALC_UMS
CALC_UMSTOTAL
COND_PRODUCTTOTALS
CALC_UMSTOTALLINE (AFTER DETAIL)
CONTACT_EMAIL
</PRE>

===Salesperson Signature Image===

To print the salesperson's signature image on the quote form, use this line in the form file:

<pre>
COLUMN 1 LEFT 20 IMAGEFIELD SL_SIGNATURE SALESPERSON
^^^^^^^^^^^ -- the field in the quote table representing the Salesperson Id
^^^^^^^^^^^^ -- this specifies the salesperson signature image
^^ -- controls the horizontal width of the signature image
</pre>

Ticket Form Fields

2023-08-09T20:22:43Z

Hhildreth: /* Ticket Fields */

==Ticket Fields==

'''Note:''' These is the list of fields direct from the select query. Aliases such as "TH." and "CU." are not part of the field name used for tickets. Therefore use "SLUMP" not "TH.SLUMP" etc.

<PRE>
TH.SESSION_NO, TH.TRANS_NO,
TH.CUST_NO, TH.TICKET_NO, TH.TICKET_DATE,
TH.SLUMP, TH.MILES, TH.TICKET_TIME, TGT_ARRIVE_JOB_DT
TH.SALESPERSON, TH.SYS_LOC, TH.PLANT_NO,
TH.TAX_AUTHORITY, TH.JOB_PO_LOC, TH.JOB_LOT,
TH.JOB_BLOCK, TH.ORDER_CODE, TH.ORDER_SESSION_NO,
TH.ORDER_TRANS_NO, TH.ORDER_LOAD_NO, TH.TRUCK_NO, TH.TRAILER_1,
TH.TRAILER_2, TH.SOURCE_FLAG, TH.VOID_FLAG,
TH.PRICED_FLAG, TH.OFFICE_PRICE_FLAG, TH.ZONE,
TH.COD_FLAG,
TH.ELAPSED_TIME,
TH.BATCH_START_DT, TH.BATCH_END_DT,
TH.LEAVE_PLANT_DT, TH.ARRIVE_JOB_DT,
TH.BEGIN_POUR_DT, TH.END_POUR_DT,
TH.LEAVE_JOB_DT, TH.RETURN_PLANT_DT,
TH.CUSTOMER_PO, TH.DRIVER, TH.PAYMENT_AMOUNT,
TH.CHECK_DATE, TH.CHECK_NO,
TH.BANK_NO, TH.SHIP_TO_1, TH.SHIP_TO_2,
TH.SHIP_TO_3, TH.SHIP_TO_4, TH.DELV_INST_1,
TH.DELV_INST_2, TH.DELV_INST_3, TH.DELV_INST_4,
TH.WEATHER,
TH.WEIGHMASTER, TH.CUSTOM_1, TH.CUSTOM_2,
TH.USAGE_TYPE,
TD.LINE_NO, TD.COMMENT_FLAG, TD.UNIT_PRICE,
TD.QTY_SOLD,
TD.PRODUCT_CODE, TD.UNIT_OF_MEASURE,
TD.DESCRIPTION,
TD.TAX_CODE, TD.TAX_CODE_2, TD.TAX_CODE_3,
TD.PRICE_SOURCE,
TD.GROSS_WEIGHT, TD.TARE_WEIGHT, TD.WEIGHT_UMS,
TD.SCALE_WEIGHT_FLAG,
TH.COMMENT_1, TH.COMMENT_2, TH.NOTES_1, TH.NOTES_2, TH.ORDER_BALANCE,
TH.AMT_TEND, TH.INV_ADJUST_FLAG, TH.CLOSED_FLAG, TD.UNIT_PCT_DISC, TD.QTY_DELIVERED,
TD.QTY_ORDERED, TD.ORDER_LINE_NO,
CU.NAME, CU.ADDRESS_1, CU.ADDRESS_2, CU.CITY,
CU.STATE, CU.ZIP, CU.TERMS_CLASS CUST_TERMS_CLASS,
CU.USER_1 CUST_USER_1,
CU.USER_2 CUST_USER_2,
CU.NOTES_1 CUST_NOTES_1,
CU.NOTES_2 CUST_NOTES_2,
CU.NOTES_3 CUST_NOTES_3,
CU.NOTES_4 CUST_NOTES_4,
TA.DESCRIPTION TAX_AUTHORITY_NAME,
PL.PLANT_NAME PLANT_ADDR1, PL.ADDRESS_1 PLANT_ADDR2, PL.ADDRESS_2 PLANT_ADDR3,
DR.DRIVER_NAME,
PR.PRODUCT_TYPE,
PR.ROLLUP_FLAG,
PR.DESCRIPTION_1 PROD_DESCRIPTION_1,
PR.DESCRIPTION_2 PROD_DESCRIPTION_2,
PR.BASE_PRODUCT,
CT.DESCRIPTION TERMS_CLASS_DESC,
PC.SUBTOTAL PCL_SUBTOTAL,
UM.SUBTOTAL UMS_SUBTOTAL,
UM.UMS_TYPE, UM.EXPANDED_UMS,
TR.PLATE_NUMBER, TR.OWNER_CODE,
TR.LEGAL_MAX_WEIGHT,
TR.VIN_NUMBER,
TR.TRUCK_MAKE, TR.TRUCK_MODEL, TR.TRUCK_YEAR,
OW.OWNER_NAME,
UC.DESCRIPTION USAGE_DESC,
SP.DESCRIPTION SALESPERSON_NAME,
WM.NAME WM_NAME, WM.LICENSE_NO WM_LICENSE_NO,
WM.LICENSE_EXP_DATE WM_LICENSE_EXP_DATE,
WM.USER_1 WM_USER_1, WM.USER_2 WM_USER_2,
WM.SIGNATURE_IMAGE WM_SIGNATURE_IMAGE,
WM.SIGNATURE_IMAGE_EXT WM_SIGNATURE_IMAGE_EXT
</PRE>

==Calculated Fields==
<PRE>
CALC_CUSTADDR1 CALC_CUSTADDR2 CALC_CUSTADDR3 CALC_CUSTADDR4
CALC_EXTAMOUNT
CALC_PRICEDTICKET
CALC_SUBTOTAL
CALC_SALESTAX
CALC_TICKETTOTAL
CALC_BALDUE
UNIT_PRICE
UNIT_PCT_DISC
TAX_CODE
CALC_TICKETSTODAY
CALC_MATLTOTAL
CALC_DELVTOTAL
CALC_WEIGHMASTER
COND_PRICEDTICKET
COND_WEIGHTS
COND_COMMENT
COND_LINE_1
COND_COD
COND_MANUALWEIGHT
COND_WEIGHMASTER
CALC_NONTAXTOTAL
ORDER_NOTES_1 ORDER_NOTES_2
CALC_PREVORDERBAL
CALC_NEWORDERBAL
COND_CONCRETETICKET
CALC_TAXABLETOTAL
CALC_CHANGEDUE
CALC_DISCTOTAL
CALC_NETDUEAFTERDISC
CALC_TICKETSTODATE
ORDER_DELV_TIME
COND_ORDER_PLUS
TAXCOL1_AMOUNT
TAXCOL2_AMOUNT
TAXCOL3_AMOUNT
TAXCOL1_LABEL
TAXCOL2_LABEL
TAXCOL3_LABEL
ORDER_CEMENT
ORDER_PCT_CALCIUM
ORDER_PCT_AIR
CALC_ORDERTOTAL
ORDER_TAKEN_BY
ORDER_TAKEN_ON
ORDER_CONTACT
ORDER_PHONE_NO
ORDER_PREV_TRUCK
ORDER_PREV_DRIVER
COND_PRODTYPE_MIX
COND_PRODTYPE_ING
COND_PRODTYPE_AGG
COND_PRODTYPE_DEL
</PRE>

===Calc Items with U/M===
<PRE>
CALC_NET_WEIGHT Unit Type:Weight
GROSS_WEIGHT Unit Type:Weight
TARE_WEIGHT Unit Type:Weight
CALC_DELVTODATE Unit Type:Quantity (Qty for an order)
CALC_QTYTODAY Unit Type:Quantity (Qty by Job Name)
CALC_ORDQTYDELV Unit Type:Quantity
CALC_ORDQTYREMAIN Unit Type:Quantity
MILES Unit Type:Miles
QTY_SOLD Unit Type:Quantity
QTY_DELIVERED Unit Type:Quantity
QTY_ORDERED Unit Type:Quantity
CALC_ORDQTYAMT Unit Type:Quantity
LEGAL_MAX_WEIGHT Unit Type:Weight
CALC_L1_QTY_ORDERED Unit Type:Quantity
CALC_L1_QTY_DELIVERED Unit Type:Quantity
CALC_L1_QTY_REMAINING Unit Type:Quantity)
</PRE>

==Copies, Multiple Copies, Samepage Copies & New Page==
<PRE>
SAME PAGE COPIES
Top of Form COPIES X, SAMEPAGE (Replace X with Number of copies)
Bottom of Form BEGINCOPY X (ADD DETAIL BELOW) (Replace X with the copy number) (eg. BEGINGCOPY 1)
After Copy X ENDCOPY X (Replace X with the copy number) (qg. ENDCOPY 1)

NEWPAGE NEWPAGE (ADD DETAIL BELOW)
</PRE>