KeystoneIntranet - User contributions [en]

Keystone Cloud Tunnel (Cloudflare)

2026-08-28T13:52:37Z

Jquinn: /* Installation & Configuration of Customer Server */

==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===
# Transfer Keystone update to the server.
# 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
# Once the update is complete and Cloudflare is setup. Load the update via system maintenance -> Updates -> Load Update.
## This will release the update to all other workstations.

==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)

Ticket Form Fields

2026-08-26T17:44:29Z

Jquinn: /* How to Print a Mix Design */

==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

--CC FEE FIELDS--
FEE_PAID (TOTAL FEE PAID)
PAY_CLASS (SHOWS THE PAY CLASS USED)
</PRE>

==How to Print a Mix Design==
<PRE>
DETAIL 4
LENGTH XX
FIELD COMP_PRODUCT_CODE
FIELD COMP_QTY_ASSEMBLY
FIELD COMP_UMS
FIELD COMP_DESCRIPTION_1
FIELD COMP_INGREDIENT_TYPE_DESC
</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
CALC_BATCHWEIGHTS (Allows Re-Print of Batch Weights) (COLUMN 15 LEFT 50 FORMAT MEMO FIELD CALC_BATCHWEIGHTS)

--CC CALC FIELDS--
CALC_TOTALPAID (ticket payment amount plus credit card fee payment amount)
</PRE>

===Calc Items with U/M===
<PRE>
CALC_NET_WEIGHT Unit Type:Weight (CALC_NET_WEIGHT_TN)
GROSS_WEIGHT Unit Type:Weight (GROSS_WEIGHT_TN)
TARE_WEIGHT Unit Type:Weight (TARE_WEIGHT_TN)
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

2026-08-26T17:44:08Z

Jquinn: /* How to Print a Mix Design */

Ticket Form Fields

2026-08-26T17:43:45Z

Jquinn:

==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

--CC FEE FIELDS--
FEE_PAID (TOTAL FEE PAID)
PAY_CLASS (SHOWS THE PAY CLASS USED)
</PRE>

==How to Print a Mix Design==
<PRE>
FIELD COMP_PRODUCT_CODE
FIELD COMP_QTY_ASSEMBLY
FIELD COMP_UMS
FIELD COMP_DESCRIPTION_1
FIELD COMP_INGREDIENT_TYPE_DESC
</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
CALC_BATCHWEIGHTS (Allows Re-Print of Batch Weights) (COLUMN 15 LEFT 50 FORMAT MEMO FIELD CALC_BATCHWEIGHTS)

--CC CALC FIELDS--
CALC_TOTALPAID (ticket payment amount plus credit card fee payment amount)
</PRE>

===Calc Items with U/M===
<PRE>
CALC_NET_WEIGHT Unit Type:Weight (CALC_NET_WEIGHT_TN)
GROSS_WEIGHT Unit Type:Weight (GROSS_WEIGHT_TN)
TARE_WEIGHT Unit Type:Weight (TARE_WEIGHT_TN)
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>

Keystone Cloud Tunnel (Cloudflare)

2026-08-12T18:09:53Z

Jquinn: /* 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 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-12T18:09:43Z

Jquinn: /* 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 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 API 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-12T18:09:25Z

Jquinn: /* 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 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)
[[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-12T18:08:35Z

Jquinn: /* 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 Cloud Flare Setup (https://ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[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-12T18:08:13Z

Jquinn: /* Existing 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 (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[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-12T18:01:02Z

Jquinn: /* Existing 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.
# 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 (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[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-12T18:00:49Z

Jquinn: /* Existing 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.
# 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.
#

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[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-06T17:23:06Z

Jquinn: /* Last Steps */

==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.
# 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.

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[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-06T15:49:27Z

Jquinn: /* Last Steps */

==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.
# 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.

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[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
# '''(Hold off on this for now - We need to make sure all third party interfaces are switched over to Cloudflare first)''' Make sure the relay is disabled or uninstalled Command prompt - (sc delete ksrelay_service)

Keystone Cloud Tunnel (Cloudflare)

2026-08-06T15:49:03Z

Jquinn: /* Last Steps */

==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.
# 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.

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[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
# ===(Hold off on this for now - We need to make sure all third party interfaces are switched over to Cloudflare first)=== Make sure the relay is disabled or uninstalled Command prompt - (sc delete ksrelay_service)

Keystone Cloud Tunnel (Cloudflare)

2026-08-06T15:48:41Z

Jquinn: /* Closing */

==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.
# 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.

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[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
# (Hold off on this for now - We need to make sure all third party interfaces are switched over to Cloudflare first) Make sure the relay is disabled or uninstalled Command prompt - (sc delete ksrelay_service)

Keystone Cloud Tunnel (Cloudflare)

2026-08-06T15:48:31Z

Jquinn: /* Closing */

==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.
# 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.

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

==Closing==
# Make sure Paul is aware of the customers that are moved from Keystone Relay
# (Hold off on this for now - We need to make sure all third party interfaces are switched over to Cloudflare first) Make sure the relay is disabled or uninstalled Command prompt - (sc delete ksrelay_service)

Keystone Cloud Tunnel (Cloudflare)

2026-08-06T15:45:31Z

Jquinn: /* Closing */

==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.
# 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.

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

==Closing==
# Make sure Paul is aware of the customers that are moved from Keystone Relay
# Make sure the relay is disabled or uninstalled Command prompt - (sc delete ksrelay_service)

Keystone Cloud Tunnel (Cloudflare)

2026-08-06T13:35:59Z

Jquinn: /* Closing */

==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.
# 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.

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

==Closing==
# Make sure Paul is aware of the customers that are moved from Keystone Relay
# Make sure the relay is disabled or uninstalled (sc delete ksrelay_service)

Keystone Cloud Tunnel (Cloudflare)

2026-08-06T13:32:38Z

Jquinn: /* Existing 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.
# 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.

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

==Closing==
# Make sure Paul is aware of the customers that are moved from Keystone Relay

Keystone Cloud Tunnel (Cloudflare)

2026-08-06T13:32:29Z

Jquinn: /* Existing 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.
# 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.

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

==Closing==
# Make sure Paul is aware of the customers that are moved from Keystone Relay

Keystone Cloud Tunnel (Cloudflare)

2026-08-05T20:31:52Z

Jquinn: /* 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===
(TBD - the idea is to download the web update and release it so workstations will update, but 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.)

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

==Closing==
# Make sure Paul is aware of the customers that are moved from Keystone Relay

Keystone Cloud Tunnel (Cloudflare)

2026-08-05T17:50:13Z

Jquinn: /* Installation & Configuration of Customer Server */

==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===
(TBD - the idea is to download the web update and release it so workstations will update, but 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.)

==Website Setup==
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

Keystone Cloud Tunnel (Cloudflare)

2026-08-05T17:46:46Z

Jquinn: /* 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===
(TBD - the idea is to download the web update and release it so workstations will update, but 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.)

===Website Setup===
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup (ksXXXXXX.ghapi.net (See example Below)
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

Keystone Cloud Tunnel (Cloudflare)

2026-08-05T17:45:33Z

Jquinn: /* 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===
(TBD - the idea is to download the web update and release it so workstations will update, but 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.)

===Website Setup===
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[File:Cloudflare setup.jpg]]
[[File:Cloudflare setup2.jpg]]
[[File:Cloudflare setup3.jpg]]

Keystone Cloud Tunnel (Cloudflare)

2026-08-05T17:28:02Z

Jquinn:

==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===
(TBD - the idea is to download the web update and release it so workstations will update, but 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.)

===Website Setup===
# Navigate to Manage Business
# Access the Business
# Change the Following:
# Keystone Connection String = DNS Name from the Cloud Flare Setup
# Keystone Port = 443
# Keystone API Key = (Using the Support Tool)
[[:File:Cloudflare setup.jpg]]
[[:File:Cloudflare setup2.jpg]]
[[:File:Cloudflare setup3.jpg]]

File:Cloudflare setup3.jpg

2026-08-05T17:27:58Z

Jquinn: File uploaded with MsUpload

File uploaded with MsUpload

File:Cloudflare setup2.jpg

2026-08-05T17:27:02Z

Jquinn: File uploaded with MsUpload

File uploaded with MsUpload

File:Cloudflare setup.jpg

2026-08-05T17:25:58Z

Jquinn: File uploaded with MsUpload

File uploaded with MsUpload

Ticket Form Fields

2026-07-29T19:39:13Z

Jquinn: /* 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

--CC FEE FIELDS--
FEE_PAID (TOTAL FEE PAID)
PAY_CLASS (SHOWS THE PAY CLASS USED)
</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
CALC_BATCHWEIGHTS (Allows Re-Print of Batch Weights) (COLUMN 15 LEFT 50 FORMAT MEMO FIELD CALC_BATCHWEIGHTS)

--CC CALC FIELDS--
CALC_TOTALPAID (ticket payment amount plus credit card fee payment amount)
</PRE>

===Calc Items with U/M===
<PRE>
CALC_NET_WEIGHT Unit Type:Weight (CALC_NET_WEIGHT_TN)
GROSS_WEIGHT Unit Type:Weight (GROSS_WEIGHT_TN)
TARE_WEIGHT Unit Type:Weight (TARE_WEIGHT_TN)
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

2026-07-29T19:38:27Z

Jquinn: /* 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

--CC FEE FIELDS--
FEE_PAID (TOTAL FEE PAID)
PAY_CLASS (SHOWS THE PAY CLASS USED)
</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
CALC_BATCHWEIGHTS (Allows Re-Print of Batch Weights) (COLUMN 15 LEFT 50 FORMAT MEMO FIELD CALC_BATCHWEIGHTS)
</PRE>

===Calc Items with U/M===
<PRE>
CALC_NET_WEIGHT Unit Type:Weight (CALC_NET_WEIGHT_TN)
GROSS_WEIGHT Unit Type:Weight (GROSS_WEIGHT_TN)
TARE_WEIGHT Unit Type:Weight (TARE_WEIGHT_TN)
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>

Invoice Form Fields

2026-04-09T19:23:20Z

Jquinn:

[[CATEGORY: FORMS]]
Fields available for the invoice form.

NOTE: In most cases just the field name is used. In some cases an alias is used and both the actual field name and the alias will be presented - in this case use the alias name on the form.

Examples:
<PRE>
IV.SESSION_NO INV_SESSION_NO,
IV.TRANS_NO INV_TRANS_NO,
SP.DESCRIPTION SALESPERSON_NAME,
</PRE>
Use:
<PRE>
INV_SESSION_NO
INV_TRANS_NO
SALESPERSON_NAME
</PRE>

A ticket Image can be added as:
<pre>
Add ticket form to invoice....
! ---------- Ticket Document Image
DETAIL 5
LINE 4 COLUMN 1 LEFT 80 IMAGEFIELD TICKET DOC_ID

</pre>

To add a Voided message for voided invoices:
<PRE>
IF CALC_VOIDFLAGMSG
LINE 32 FONTSIZE 48 COLOR clRed BOLD ON
COLUMN 30 TEXT VOID
COLOR clBlack FONTSIZE 8
ENDIF
</PRE>

To add a PAID message for paid invoices:
<PRE>
IF CALC_INVBAL
COLUMN 20 TEXT
ELSE
BOLD ON FONTSIZE 48 COLOR clRed
COLUMN 1 CENTER 80 TEXT PAID
ENDIF
BOLD OFF
ENDIF
</PRE>

To have Void & Paid toggle in the same form:
<PRE>
IF CALC_VOIDFLAGMSG
COLUMN 30 FONTSIZE 48 COLOR clRed BOLD ON
COLUMN 1 CENTER 80 TEXT VOID
COLOR clBlack FONTSIZE 8
ELSE
IF CALC_INVBAL
COLUMN 20 TEXT
ELSE
BOLD ON
FONTSIZE 48
COLOR clRed
COLUMN 1 CENTER 80 TEXT PAID
ENDIF
BOLD OFF
ENDIF
</PRE>

To add a Barcode or Payment Link:
<PRE>
For QR Code:
LINE +1 COLUMN 15 LEFT 40 FORMAT BARCODE_QR FIELD CALC_LINK_PAYMENT_QR

For payment link:
COLUMN 15 LEFT 12 FORMAT PDF_HYPERLINK FIELD CALC_LINK_PAYMENT
</PRE>

==Invoice Form Fields==
<PRE>
IV.SESSION_NO INV_SESSION_NO,
IV.TRANS_NO INV_TRANS_NO,
IV.CUST_NO,
IV.INVOICE_NO,
IV.INVOICE_DATE,
SALES_TAX,
SALES_TAX_1,
SALES_TAX_2,
SALES_TAX_3,
IV.DEBIT_AMOUNT INVOICE_TOTAL,
IV.DISC_OFFERED DISC_AVAILABLE,
IV.DISC_VALID_DATE DISC_DATE,
NON_TAXABLE_1,
NON_TAXABLE_2,
NON_TAXABLE_3,
IV.PRIOR_AR_BALANCE,
IV.TAX_AUTHORITY,
IV.JOB_DESC,
IV.AGING_1,
IV.AGING_2,
IV.AGING_3,
IV.AGING_4,
IV.AGING_5,
IV.FINCHG_1,
IV.FINCHG_2,
IV.FINCHG_3,
IV.FINCHG_4,
IV.FINCHG_5,
IV.INVOICEMESSAGE_1,
IV.INVOICEMESSAGE_2,
IV.INVOICEMESSAGE_3,
IV.INVOICEMESSAGE_4,
IV.RETURNADDR_1,
IV.RETURNADDR_2,
IV.RETURNADDR_3,
IV.RETURNADDR_4,
IV.UMS_1,
IV.UMS_2,
IV.UMS_3,
IV.UMS_4,
IV.UMS_5,
IV.UMSTOTAL_1,
IV.UMSTOTAL_2,
IV.UMSTOTAL_3,
IV.UMSTOTAL_4,
IV.UMSTOTAL_5,
IV.CUST_NAME,
IV.CUST_ADDRESS_1,
IV.CUST_ADDRESS_2,
IV.CUST_CITY,
IV.CUST_STATE,
IV.CUST_ZIP,
IV.CREDIT_TERMS,
IV.DISCOUNT_MESSAGE,
(0) SPLIT_RATE, temporary
(0) SPLIT_LIMIT,
IV.PLANT_NAME,
IV.PLANT_SCREEN_ID,
IV.PLANT_ADDRESS_1,
IV.PLANT_ADDRESS_2,
IV.PLANT_PHONE_NO,
IV.SPACE_BETWEEN_TICKETS,
IV.NONTAX_TOTAL,
IV.TICKET_COMMENTS,
IV.PRODUCT_TOTALS,
IV.PRINT_CASH,
IV.PRINT_PRICED,
IV.PRINT_UNPRICED,
IV.CUST_COD_FLAG,
IV.CUST_USER_1,
IV.CUST_USER_2,
IV.DUE_DATE,
IV.VOID_FLAG,
IV.PLANT_NO INV_PLANT_NO,
IV.DIVISION_NO,
IV.CREDIT_AMOUNT,

// customer fields
CU.TAX_ID CUST_TAX_ID,

// sales header fields
SH.SESSION_NO TCK_SESSION_NO,
SH.TRANS_NO TCK_TRANS_NO,
SH.TICKET_NO,
SH.TICKET_DATE,
SH.SLUMP,
SH.MILES,
SH.TICKET_TIME,
SH.SALESPERSON,
SH.CUST_CLASS,
SH.SYS_LOC,
SH.PLANT_NO,
SH.JOB_PO_LOC,
SH.JOB_LOT,
SH.TRUCK_NO,
SH.TRAILER_1,
SH.TRAILER_2,
SH.SOURCE_FLAG,
SH.VOID_FLAG,
SH.PRICED_FLAG,
SH.OFFICE_PRICE_FLAG,
SH.ZONE,
SH.COD_FLAG,
SH.ELAPSED_TIME,
SH.BATCH_START_DT,
SH.BATCH_END_DT,
SH.LEAVE_PLANT_DT,
SH.ARRIVE_JOB_DT,
SH.BEGIN_POUR_DT,
SH.END_POUR_DT,
SH.LEAVE_JOB_DT,
SH.RETURN_PLANT_DT,
SH.CUSTOMER_PO,
SH.DRIVER,
SH.JOB_CLASS,
SH.PAYMENT_AMOUNT,
SH.CHECK_DATE,
SH.CHECK_NO,
SH.BANK_NO,
SH.SHIP_TO_1,
SH.SHIP_TO_2,
SH.SHIP_TO_3,
SH.SHIP_TO_4,
SH.DELV_INST_1,
SH.DELV_INST_2,
SH.DELV_INST_3,
SH.DELV_INST_4,
SH.ORDER_CODE,
SH.JOB_BLOCK,
SH.CUSTOM_1,
SH.CUSTOM_2,
SH.USAGE_TYPE,
SH.DOC_LINK,

// sales detail fields
SD.LINE_NO TCK_LINE_NO,
SD.COMMENT_FLAG,
SD.UNIT_PRICE,
SD.LIST_PRICE,
SD.UNIT_DISC,
SD.STD_DISC,
SD.QTY_SOLD,
SD.PRODUCT_CODE,
SD.UNIT_OF_MEASURE,
SD.DESCRIPTION,
SD.TAX_CODE,
SD.TAX_CODE_2,
SD.TAX_CODE_3,
SD.PRICE_SOURCE,
SD.GROSS_WEIGHT,
SD.TARE_WEIGHT,
SD.WEIGHT_UMS,
SD.SCALE_WEIGHT_FLAG,
SD.EXT_PRICE, .99.27

// salesperson fields
SP.DESCRIPTION SALESPERSON_NAME,

// product fields
PR.ROLLUP_FLAG,
PR.PRODUCT_TYPE,
PR.DESCRIPTION_1 PROD_DESCRIPTION_1,
PR.DESCRIPTION_2 PROD_DESCRIPTION_2,
PR.BASE_PRODUCT

// usage class fields
UC.DESCRIPTION USAGE_DESC, .32

// plant fields
PT.PLANT_NAME TCK_PLANT_NAME,
PT.PLANT_SCREEN_ID TCK_PLANT_SCREEN_ID,

// division fields
//DV.DIVISION_NO,
DV.DIVISION_NAME,

// tax authority fields
TA.DESCRIPTION TAX_AUTH_DESC
</PRE>

==Calculated Fields==
<PRE>
CALC_RETADDR1, CALC_RETADDR2, CALC_RETADDR3,
CALC_RETADDR4, CALC_INVOICEDATE, CALC_CUSTADDR1,
CALC_CUSTADDR2, CALC_CUSTADDR3, CALC_CUSTADDR4,
CALC_INVMSG1, CALC_INVMSG2, CALC_INVMSG3,
CALC_INVMSG4, CALC_CREDITTERMS, CALC_INVOICENO,
CALC_SUBTOTAL, CALC_NONTAXTOTAL, CALC_SALESTAX,
CALC_INVTOTAL, UNIT_PRICE, CALC_EXTPRICE,
CALC_TAXIND, CALC_TAXAUTH, CALC_DISCOUNTLINE,
CALC_DISCTOTAL, CALC_NFAGING1, CALC_NFAGING2,
CALC_NFAGING3, CALC_NFAGING4, CALC_NFAGING5,
CALC_NFAGING4&5, CALC_FINCHGBAL, CALC_AGING1,
CALC_AGING2, CALC_AGING3, CALC_AGING4,
CALC_AGING5, CALC_AGING4&5, CALC_DISCBALDUE,
COND_NONTAXTOTAL, CALC_UMS, CALC_UMSTOTAL,
COND_PRODUCTTOTALS, CALC_UMSTOTALLINE, JOB_PO_LOC,
CALC_DISCDATE, CALC_TAXRATEPCT, CALC_TAXINDYN,
CALC_MATLTOTAL, CALC_DELVTOTAL, QTY_SOLD,
CALC_TKROLL_MATLTOTAL, CALC_TKROLL_DELVTOTAL, CALC_TKROLL_TAXTOTAL,
CALC_TKROLL_TKTTOTAL, CALC_TAXABLETOTAL, ORDER_CODE,
TAX_RATE, SPLIT_RATE, SPLIT_LIMIT,
PLANT_NAME, PLANT_SCREEN_ID, PLANT_ADDRESS_1,
PLANT_ADDRESS_2, PLANT_PHONE_NO, CUST_USER_1,
CUST_USER_2, CALC_PAYMENTTOTAL, CALC_NETDUE,
CALC_PRIORARBAL, CALC_NEWARBAL, TICKET_JOB,
PS_DESCRIPTION, PS_QUANTITY, PS_U_OF_M,
PS_PRODUCT_CODE, PS_UNIT_PRICE, PS_EXT_PRICE,
CALC_VOIDFLAGMSG,
PS_TAX_IND,
TS_PLANT_NO, TS_TICKET_NO,
COND_TICKET_LINE_1,
COND_PRICE_ROLLUP,
COND_COD_CUST, COND_CASH_CUST,
TAX_DESC_1, TAX_DESC_2, TAX_DESC_3,
DOC_ID,
CALC_INVBAL
</PRE>

Invoice Form Fields

2026-04-09T19:21:50Z

Jquinn:

[[CATEGORY: FORMS]]
Fields available for the invoice form.

NOTE: In most cases just the field name is used. In some cases an alias is used and both the actual field name and the alias will be presented - in this case use the alias name on the form.

Examples:
<PRE>
IV.SESSION_NO INV_SESSION_NO,
IV.TRANS_NO INV_TRANS_NO,
SP.DESCRIPTION SALESPERSON_NAME,
</PRE>
Use:
<PRE>
INV_SESSION_NO
INV_TRANS_NO
SALESPERSON_NAME
</PRE>

A ticket Image can be added as:
<pre>
Add ticket form to invoice....
! ---------- Ticket Document Image
DETAIL 5
LINE 4 COLUMN 1 LEFT 80 IMAGEFIELD TICKET DOC_ID

</pre>

To add a Voided message for voided invoices:
<PRE>
IF CALC_VOIDFLAGMSG
LINE 32
FONTSIZE 48
COLOR clRed
BOLD ON
COLUMN 30 TEXT VOID
COLOR clBlack
FONTSIZE 8
ENDIF
</PRE>

To add a PAID message for paid invoices:
<PRE>
IF CALC_INVBAL
COLUMN 20 TEXT
ELSE
BOLD ON FONTSIZE 48 COLOR clRed
COLUMN 1 CENTER 80 TEXT PAID
ENDIF
BOLD OFF
ENDIF
</PRE>

To have Void & Paid toggle in the same form:
<PRE>
IF CALC_VOIDFLAGMSG
COLUMN 30 FONTSIZE 48 COLOR clRed BOLD ON
COLUMN 1 CENTER 80 TEXT VOID
COLOR clBlack FONTSIZE 8
ELSE
IF CALC_INVBAL
COLUMN 20 TEXT
ELSE
BOLD ON
FONTSIZE 48
COLOR clRed
COLUMN 1 CENTER 80 TEXT PAID
ENDIF
BOLD OFF
ENDIF
</PRE>

To add a Barcode or Payment Link:
<PRE>
For QR Code:
LINE +1 COLUMN 15 LEFT 40 FORMAT BARCODE_QR FIELD CALC_LINK_PAYMENT_QR

For payment link:
COLUMN 15 LEFT 12 FORMAT PDF_HYPERLINK FIELD CALC_LINK_PAYMENT
</PRE>

==Invoice Form Fields==
<PRE>
IV.SESSION_NO INV_SESSION_NO,
IV.TRANS_NO INV_TRANS_NO,
IV.CUST_NO,
IV.INVOICE_NO,
IV.INVOICE_DATE,
SALES_TAX,
SALES_TAX_1,
SALES_TAX_2,
SALES_TAX_3,
IV.DEBIT_AMOUNT INVOICE_TOTAL,
IV.DISC_OFFERED DISC_AVAILABLE,
IV.DISC_VALID_DATE DISC_DATE,
NON_TAXABLE_1,
NON_TAXABLE_2,
NON_TAXABLE_3,
IV.PRIOR_AR_BALANCE,
IV.TAX_AUTHORITY,
IV.JOB_DESC,
IV.AGING_1,
IV.AGING_2,
IV.AGING_3,
IV.AGING_4,
IV.AGING_5,
IV.FINCHG_1,
IV.FINCHG_2,
IV.FINCHG_3,
IV.FINCHG_4,
IV.FINCHG_5,
IV.INVOICEMESSAGE_1,
IV.INVOICEMESSAGE_2,
IV.INVOICEMESSAGE_3,
IV.INVOICEMESSAGE_4,
IV.RETURNADDR_1,
IV.RETURNADDR_2,
IV.RETURNADDR_3,
IV.RETURNADDR_4,
IV.UMS_1,
IV.UMS_2,
IV.UMS_3,
IV.UMS_4,
IV.UMS_5,
IV.UMSTOTAL_1,
IV.UMSTOTAL_2,
IV.UMSTOTAL_3,
IV.UMSTOTAL_4,
IV.UMSTOTAL_5,
IV.CUST_NAME,
IV.CUST_ADDRESS_1,
IV.CUST_ADDRESS_2,
IV.CUST_CITY,
IV.CUST_STATE,
IV.CUST_ZIP,
IV.CREDIT_TERMS,
IV.DISCOUNT_MESSAGE,
(0) SPLIT_RATE, temporary
(0) SPLIT_LIMIT,
IV.PLANT_NAME,
IV.PLANT_SCREEN_ID,
IV.PLANT_ADDRESS_1,
IV.PLANT_ADDRESS_2,
IV.PLANT_PHONE_NO,
IV.SPACE_BETWEEN_TICKETS,
IV.NONTAX_TOTAL,
IV.TICKET_COMMENTS,
IV.PRODUCT_TOTALS,
IV.PRINT_CASH,
IV.PRINT_PRICED,
IV.PRINT_UNPRICED,
IV.CUST_COD_FLAG,
IV.CUST_USER_1,
IV.CUST_USER_2,
IV.DUE_DATE,
IV.VOID_FLAG,
IV.PLANT_NO INV_PLANT_NO,
IV.DIVISION_NO,
IV.CREDIT_AMOUNT,

// customer fields
CU.TAX_ID CUST_TAX_ID,

// sales header fields
SH.SESSION_NO TCK_SESSION_NO,
SH.TRANS_NO TCK_TRANS_NO,
SH.TICKET_NO,
SH.TICKET_DATE,
SH.SLUMP,
SH.MILES,
SH.TICKET_TIME,
SH.SALESPERSON,
SH.CUST_CLASS,
SH.SYS_LOC,
SH.PLANT_NO,
SH.JOB_PO_LOC,
SH.JOB_LOT,
SH.TRUCK_NO,
SH.TRAILER_1,
SH.TRAILER_2,
SH.SOURCE_FLAG,
SH.VOID_FLAG,
SH.PRICED_FLAG,
SH.OFFICE_PRICE_FLAG,
SH.ZONE,
SH.COD_FLAG,
SH.ELAPSED_TIME,
SH.BATCH_START_DT,
SH.BATCH_END_DT,
SH.LEAVE_PLANT_DT,
SH.ARRIVE_JOB_DT,
SH.BEGIN_POUR_DT,
SH.END_POUR_DT,
SH.LEAVE_JOB_DT,
SH.RETURN_PLANT_DT,
SH.CUSTOMER_PO,
SH.DRIVER,
SH.JOB_CLASS,
SH.PAYMENT_AMOUNT,
SH.CHECK_DATE,
SH.CHECK_NO,
SH.BANK_NO,
SH.SHIP_TO_1,
SH.SHIP_TO_2,
SH.SHIP_TO_3,
SH.SHIP_TO_4,
SH.DELV_INST_1,
SH.DELV_INST_2,
SH.DELV_INST_3,
SH.DELV_INST_4,
SH.ORDER_CODE,
SH.JOB_BLOCK,
SH.CUSTOM_1,
SH.CUSTOM_2,
SH.USAGE_TYPE,
SH.DOC_LINK,

// sales detail fields
SD.LINE_NO TCK_LINE_NO,
SD.COMMENT_FLAG,
SD.UNIT_PRICE,
SD.LIST_PRICE,
SD.UNIT_DISC,
SD.STD_DISC,
SD.QTY_SOLD,
SD.PRODUCT_CODE,
SD.UNIT_OF_MEASURE,
SD.DESCRIPTION,
SD.TAX_CODE,
SD.TAX_CODE_2,
SD.TAX_CODE_3,
SD.PRICE_SOURCE,
SD.GROSS_WEIGHT,
SD.TARE_WEIGHT,
SD.WEIGHT_UMS,
SD.SCALE_WEIGHT_FLAG,
SD.EXT_PRICE, .99.27

// salesperson fields
SP.DESCRIPTION SALESPERSON_NAME,

// product fields
PR.ROLLUP_FLAG,
PR.PRODUCT_TYPE,
PR.DESCRIPTION_1 PROD_DESCRIPTION_1,
PR.DESCRIPTION_2 PROD_DESCRIPTION_2,
PR.BASE_PRODUCT

// usage class fields
UC.DESCRIPTION USAGE_DESC, .32

// plant fields
PT.PLANT_NAME TCK_PLANT_NAME,
PT.PLANT_SCREEN_ID TCK_PLANT_SCREEN_ID,

// division fields
//DV.DIVISION_NO,
DV.DIVISION_NAME,

// tax authority fields
TA.DESCRIPTION TAX_AUTH_DESC
</PRE>

==Calculated Fields==
<PRE>
CALC_RETADDR1, CALC_RETADDR2, CALC_RETADDR3,
CALC_RETADDR4, CALC_INVOICEDATE, CALC_CUSTADDR1,
CALC_CUSTADDR2, CALC_CUSTADDR3, CALC_CUSTADDR4,
CALC_INVMSG1, CALC_INVMSG2, CALC_INVMSG3,
CALC_INVMSG4, CALC_CREDITTERMS, CALC_INVOICENO,
CALC_SUBTOTAL, CALC_NONTAXTOTAL, CALC_SALESTAX,
CALC_INVTOTAL, UNIT_PRICE, CALC_EXTPRICE,
CALC_TAXIND, CALC_TAXAUTH, CALC_DISCOUNTLINE,
CALC_DISCTOTAL, CALC_NFAGING1, CALC_NFAGING2,
CALC_NFAGING3, CALC_NFAGING4, CALC_NFAGING5,
CALC_NFAGING4&5, CALC_FINCHGBAL, CALC_AGING1,
CALC_AGING2, CALC_AGING3, CALC_AGING4,
CALC_AGING5, CALC_AGING4&5, CALC_DISCBALDUE,
COND_NONTAXTOTAL, CALC_UMS, CALC_UMSTOTAL,
COND_PRODUCTTOTALS, CALC_UMSTOTALLINE, JOB_PO_LOC,
CALC_DISCDATE, CALC_TAXRATEPCT, CALC_TAXINDYN,
CALC_MATLTOTAL, CALC_DELVTOTAL, QTY_SOLD,
CALC_TKROLL_MATLTOTAL, CALC_TKROLL_DELVTOTAL, CALC_TKROLL_TAXTOTAL,
CALC_TKROLL_TKTTOTAL, CALC_TAXABLETOTAL, ORDER_CODE,
TAX_RATE, SPLIT_RATE, SPLIT_LIMIT,
PLANT_NAME, PLANT_SCREEN_ID, PLANT_ADDRESS_1,
PLANT_ADDRESS_2, PLANT_PHONE_NO, CUST_USER_1,
CUST_USER_2, CALC_PAYMENTTOTAL, CALC_NETDUE,
CALC_PRIORARBAL, CALC_NEWARBAL, TICKET_JOB,
PS_DESCRIPTION, PS_QUANTITY, PS_U_OF_M,
PS_PRODUCT_CODE, PS_UNIT_PRICE, PS_EXT_PRICE,
CALC_VOIDFLAGMSG,
PS_TAX_IND,
TS_PLANT_NO, TS_TICKET_NO,
COND_TICKET_LINE_1,
COND_PRICE_ROLLUP,
COND_COD_CUST, COND_CASH_CUST,
TAX_DESC_1, TAX_DESC_2, TAX_DESC_3,
DOC_ID,
CALC_INVBAL
</PRE>

Invoice Form Fields

2026-04-09T19:17:14Z

Jquinn:

[[CATEGORY: FORMS]]
Fields available for the invoice form.

NOTE: In most cases just the field name is used. In some cases an alias is used and both the actual field name and the alias will be presented - in this case use the alias name on the form.

Examples:
<PRE>
IV.SESSION_NO INV_SESSION_NO,
IV.TRANS_NO INV_TRANS_NO,
SP.DESCRIPTION SALESPERSON_NAME,
</PRE>
Use:
<PRE>
INV_SESSION_NO
INV_TRANS_NO
SALESPERSON_NAME
</PRE>

A ticket Image can be added as:
<pre>
Add ticket form to invoice....
! ---------- Ticket Document Image
DETAIL 5
LINE 4 COLUMN 1 LEFT 80 IMAGEFIELD TICKET DOC_ID

</pre>

To add a Voided message for voided invoices:
<PRE>
IF CALC_VOIDFLAGMSG
LINE 32
FONTSIZE 48
COLOR clRed
BOLD ON
COLUMN 30 TEXT VOID
COLOR clBlack
FONTSIZE 8
ENDIF
</PRE>

To add a PAID message for paid invoices:
<PRE>
IF CALC_INVBAL
COLUMN 20 TEXT
ELSE
BOLD ON
FONTSIZE 48
COLOR clRed
COLUMN 1 CENTER 80 TEXT PAID
ENDIF
BOLD OFF
ENDIF
</PRE>

To add a Barcode or Payment Link:
<PRE>
For QR Code:
LINE +1 COLUMN 15 LEFT 40 FORMAT BARCODE_QR FIELD CALC_LINK_PAYMENT_QR

For payment link:
COLUMN 15 LEFT 12 FORMAT PDF_HYPERLINK FIELD CALC_LINK_PAYMENT
</PRE>

==Invoice Form Fields==
<PRE>
IV.SESSION_NO INV_SESSION_NO,
IV.TRANS_NO INV_TRANS_NO,
IV.CUST_NO,
IV.INVOICE_NO,
IV.INVOICE_DATE,
SALES_TAX,
SALES_TAX_1,
SALES_TAX_2,
SALES_TAX_3,
IV.DEBIT_AMOUNT INVOICE_TOTAL,
IV.DISC_OFFERED DISC_AVAILABLE,
IV.DISC_VALID_DATE DISC_DATE,
NON_TAXABLE_1,
NON_TAXABLE_2,
NON_TAXABLE_3,
IV.PRIOR_AR_BALANCE,
IV.TAX_AUTHORITY,
IV.JOB_DESC,
IV.AGING_1,
IV.AGING_2,
IV.AGING_3,
IV.AGING_4,
IV.AGING_5,
IV.FINCHG_1,
IV.FINCHG_2,
IV.FINCHG_3,
IV.FINCHG_4,
IV.FINCHG_5,
IV.INVOICEMESSAGE_1,
IV.INVOICEMESSAGE_2,
IV.INVOICEMESSAGE_3,
IV.INVOICEMESSAGE_4,
IV.RETURNADDR_1,
IV.RETURNADDR_2,
IV.RETURNADDR_3,
IV.RETURNADDR_4,
IV.UMS_1,
IV.UMS_2,
IV.UMS_3,
IV.UMS_4,
IV.UMS_5,
IV.UMSTOTAL_1,
IV.UMSTOTAL_2,
IV.UMSTOTAL_3,
IV.UMSTOTAL_4,
IV.UMSTOTAL_5,
IV.CUST_NAME,
IV.CUST_ADDRESS_1,
IV.CUST_ADDRESS_2,
IV.CUST_CITY,
IV.CUST_STATE,
IV.CUST_ZIP,
IV.CREDIT_TERMS,
IV.DISCOUNT_MESSAGE,
(0) SPLIT_RATE, temporary
(0) SPLIT_LIMIT,
IV.PLANT_NAME,
IV.PLANT_SCREEN_ID,
IV.PLANT_ADDRESS_1,
IV.PLANT_ADDRESS_2,
IV.PLANT_PHONE_NO,
IV.SPACE_BETWEEN_TICKETS,
IV.NONTAX_TOTAL,
IV.TICKET_COMMENTS,
IV.PRODUCT_TOTALS,
IV.PRINT_CASH,
IV.PRINT_PRICED,
IV.PRINT_UNPRICED,
IV.CUST_COD_FLAG,
IV.CUST_USER_1,
IV.CUST_USER_2,
IV.DUE_DATE,
IV.VOID_FLAG,
IV.PLANT_NO INV_PLANT_NO,
IV.DIVISION_NO,
IV.CREDIT_AMOUNT,

// customer fields
CU.TAX_ID CUST_TAX_ID,

// sales header fields
SH.SESSION_NO TCK_SESSION_NO,
SH.TRANS_NO TCK_TRANS_NO,
SH.TICKET_NO,
SH.TICKET_DATE,
SH.SLUMP,
SH.MILES,
SH.TICKET_TIME,
SH.SALESPERSON,
SH.CUST_CLASS,
SH.SYS_LOC,
SH.PLANT_NO,
SH.JOB_PO_LOC,
SH.JOB_LOT,
SH.TRUCK_NO,
SH.TRAILER_1,
SH.TRAILER_2,
SH.SOURCE_FLAG,
SH.VOID_FLAG,
SH.PRICED_FLAG,
SH.OFFICE_PRICE_FLAG,
SH.ZONE,
SH.COD_FLAG,
SH.ELAPSED_TIME,
SH.BATCH_START_DT,
SH.BATCH_END_DT,
SH.LEAVE_PLANT_DT,
SH.ARRIVE_JOB_DT,
SH.BEGIN_POUR_DT,
SH.END_POUR_DT,
SH.LEAVE_JOB_DT,
SH.RETURN_PLANT_DT,
SH.CUSTOMER_PO,
SH.DRIVER,
SH.JOB_CLASS,
SH.PAYMENT_AMOUNT,
SH.CHECK_DATE,
SH.CHECK_NO,
SH.BANK_NO,
SH.SHIP_TO_1,
SH.SHIP_TO_2,
SH.SHIP_TO_3,
SH.SHIP_TO_4,
SH.DELV_INST_1,
SH.DELV_INST_2,
SH.DELV_INST_3,
SH.DELV_INST_4,
SH.ORDER_CODE,
SH.JOB_BLOCK,
SH.CUSTOM_1,
SH.CUSTOM_2,
SH.USAGE_TYPE,
SH.DOC_LINK,

// sales detail fields
SD.LINE_NO TCK_LINE_NO,
SD.COMMENT_FLAG,
SD.UNIT_PRICE,
SD.LIST_PRICE,
SD.UNIT_DISC,
SD.STD_DISC,
SD.QTY_SOLD,
SD.PRODUCT_CODE,
SD.UNIT_OF_MEASURE,
SD.DESCRIPTION,
SD.TAX_CODE,
SD.TAX_CODE_2,
SD.TAX_CODE_3,
SD.PRICE_SOURCE,
SD.GROSS_WEIGHT,
SD.TARE_WEIGHT,
SD.WEIGHT_UMS,
SD.SCALE_WEIGHT_FLAG,
SD.EXT_PRICE, .99.27

// salesperson fields
SP.DESCRIPTION SALESPERSON_NAME,

// product fields
PR.ROLLUP_FLAG,
PR.PRODUCT_TYPE,
PR.DESCRIPTION_1 PROD_DESCRIPTION_1,
PR.DESCRIPTION_2 PROD_DESCRIPTION_2,
PR.BASE_PRODUCT

// usage class fields
UC.DESCRIPTION USAGE_DESC, .32

// plant fields
PT.PLANT_NAME TCK_PLANT_NAME,
PT.PLANT_SCREEN_ID TCK_PLANT_SCREEN_ID,

// division fields
//DV.DIVISION_NO,
DV.DIVISION_NAME,

// tax authority fields
TA.DESCRIPTION TAX_AUTH_DESC
</PRE>

==Calculated Fields==
<PRE>
CALC_RETADDR1, CALC_RETADDR2, CALC_RETADDR3,
CALC_RETADDR4, CALC_INVOICEDATE, CALC_CUSTADDR1,
CALC_CUSTADDR2, CALC_CUSTADDR3, CALC_CUSTADDR4,
CALC_INVMSG1, CALC_INVMSG2, CALC_INVMSG3,
CALC_INVMSG4, CALC_CREDITTERMS, CALC_INVOICENO,
CALC_SUBTOTAL, CALC_NONTAXTOTAL, CALC_SALESTAX,
CALC_INVTOTAL, UNIT_PRICE, CALC_EXTPRICE,
CALC_TAXIND, CALC_TAXAUTH, CALC_DISCOUNTLINE,
CALC_DISCTOTAL, CALC_NFAGING1, CALC_NFAGING2,
CALC_NFAGING3, CALC_NFAGING4, CALC_NFAGING5,
CALC_NFAGING4&5, CALC_FINCHGBAL, CALC_AGING1,
CALC_AGING2, CALC_AGING3, CALC_AGING4,
CALC_AGING5, CALC_AGING4&5, CALC_DISCBALDUE,
COND_NONTAXTOTAL, CALC_UMS, CALC_UMSTOTAL,
COND_PRODUCTTOTALS, CALC_UMSTOTALLINE, JOB_PO_LOC,
CALC_DISCDATE, CALC_TAXRATEPCT, CALC_TAXINDYN,
CALC_MATLTOTAL, CALC_DELVTOTAL, QTY_SOLD,
CALC_TKROLL_MATLTOTAL, CALC_TKROLL_DELVTOTAL, CALC_TKROLL_TAXTOTAL,
CALC_TKROLL_TKTTOTAL, CALC_TAXABLETOTAL, ORDER_CODE,
TAX_RATE, SPLIT_RATE, SPLIT_LIMIT,
PLANT_NAME, PLANT_SCREEN_ID, PLANT_ADDRESS_1,
PLANT_ADDRESS_2, PLANT_PHONE_NO, CUST_USER_1,
CUST_USER_2, CALC_PAYMENTTOTAL, CALC_NETDUE,
CALC_PRIORARBAL, CALC_NEWARBAL, TICKET_JOB,
PS_DESCRIPTION, PS_QUANTITY, PS_U_OF_M,
PS_PRODUCT_CODE, PS_UNIT_PRICE, PS_EXT_PRICE,
CALC_VOIDFLAGMSG,
PS_TAX_IND,
TS_PLANT_NO, TS_TICKET_NO,
COND_TICKET_LINE_1,
COND_PRICE_ROLLUP,
COND_COD_CUST, COND_CASH_CUST,
TAX_DESC_1, TAX_DESC_2, TAX_DESC_3,
DOC_ID,
CALC_INVBAL
</PRE>

Notification Devices

2026-02-03T16:42:57Z

Jquinn: /* KEYSTONEONLINE Parameters */

==Introduction==
Keystone supports several different types of notification devices. These are meant to send notifications based on certain events.

==Device Types==

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Device Type
! Description
! NOTIFYTYPE
! PROTOCOL
! Parameters
! Keystone Version
|-
| [[#Dispatch Event|Dispatch Event]]
| Sent when a dispatch status event occurs
| DISPATCH
| KEYSTONEONLINE ROADKING HAULHUB CIDRA HOLCIM CARBONCURE AGGHAULHUB
| [[#Dispatch Event KEYSTONEONLINE|(see below)]] [[#Dispatch Event ROADKING|(see below)]] [[#Dispatch Event HAULHUB|(see below)]] [[#Dispatch Event CIDRA|(see below)]] [[#Dispatch Event HOLCIM|(see below)]] [[#Dispatch Event CARBONCURE|(see below)]] [[#Dispatch Event AGGHAULHUB|(see below)]]
| 3.6 3.6.15.5 4.3.9.7 4.3.9.7 4.4 4.5.4.0 4.5.5.9
|-
| [[#Notify Batch Weights|Notify Batch Weights]]
| Sent when batch weights are received from a batch control
| BATCHWEIGHTS
| EMAILSENDGRID EMAILSMTP KOBATCHWEIGHTS <s>DOTPA</s> <s>HAULHUB</s>
| [[#Notify Batch Weights EMAILSENDGRID|(see below)]] [[#Notify Batch Weights EMAILSMTP|(see below)]] [[#Notify Batch Weights KOBATCHWEIGHTS|(see below)]] [[#Notify Batch Weights DOTPA|(see below)]] [[#Notify Batch Weights HAULHUB|(see below)]]
| 3.6.11.5 3.6.10 3.6.9 4.1.2.2 4.3.5.2
|-
| [[#Notify Order Complete|Notify Order Complete]]
| Sent when an order is considered complete
| ORDERCOMPLETE
| EMAILSENDGRID EMAILSMTP
| [[#Notify Order Complete EMAILSENDGRID|(see below)]] [[#Notify Order Complete EMAILSMTP|(see below)]]
| 3.6.11.5 3.6.10
|-
| [[#Order Route Update|Order Route Update]]
| Sent when an order route is added/changed
| ORDERROUTE
| KEYSTONEONLINE
| [[#Order Route Update KEYSTONEONLINE|(see below)]]
| 3.6.99.58
|}

===Dispatch Event===
Dispatch Event devices will forward dispatch status events to external devices.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>http://ghwebgps.azurewebsites.net/DispatchAPI</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,3,8,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:Contractor Portal.png]]

====ROADKING Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://roadkingtech.com</nowiki>
|
| X
|-
| INFO_COMPANY
| RoadKing Company Name
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,2,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====HAULHUB (Concrete) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:HaulHub Setup.png]]

====CIDRA SmartHatch Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERIDKEY
| ID Key specific to the customer
|
|
|
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://shapi.cidraconcrete.com/interface</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| GHKEvent
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:CIDRA SETUP.png]]

====HOLCIM (Concretely) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERIDKEY
| Id Key specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.concretely.co/api/orders/provider</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| integration/keystone
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====Carbon Cure Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERNAME
| Supplier Name
|
|
|
| X
|-
| APIKEY
| API Key specific to the customer
|
|
|
| X
|-
| APIKEYID
| API Key Id specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://uploads.carboncure.com/</nowiki>
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 2, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|-
| TEST
| Send notifications to test folder
| Y/N
| N
| Use Y when testing
|
|}

====HAULHUB (Aggregate) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| DOTAGENCYCODE
| DOT agency code
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

===Notify Batch Weights===
Notify Batch Weights devices will send a notification when batch weights are received from the batch control associated with a plant.

[[File:Email Batch Weights (Send Grind).png]]

====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

=====Default Email Format=====
Subject: Load Ship Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Ticket:</td><td>[TICKET_NO]</td></tr>
<tr><td>Batch Time:</td><td>[BATCH_END_DT]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr><td>Truck:</td><td>[TRUCK_NO]</td></tr>
<tr><td>Mix:</td><td>[PRODUCT_CODE_1] - [DESCRIPTION_1]</td></tr>
<tr><td>Load Size:</td><td>[QTY_SOLD_1]</td></tr>
<tr><td>Cumul Qty:</td><td>[CUMUL_QTY_1]</td></tr>
<tr><td>Order Qty:</td><td>[ORDER_QTY_1]</td></tr>
<tr></tr>
<tr><td>Plant Name:</td><td>[PLANT_NAME]</td></tr>
<tr><td>Address:</td><td>[PLANT_ADDR_1]</td></tr>
<tr><td></td><td>[PLANT_ADDR_2]</td></tr>
<tr></tr>
</table>
<table>
<tr><th>Material</th><th>Targets</th><th>Actual</th><th>% Error</th><th>% Moist</th></tr>
<tr>
<td>[BW_INGRED_ID_n]</td>
<td>[BW_INGRED_TARGETWEIGHT_n]</td>
<td>[BW_INGRED_ACTUALWEIGHT_n]</td>
<td>[PCT_ERROR]</td>
<td>[BW_INGRED_PCTMOISTURE_n]</td>
</tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

====KOBATCHWEIGHTS Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API URL Root
|
|
| X
|
|-
| RESOURCE
| API URL Resource
|
| PostBatchWeights
|
|
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business Name
|
|
| X
|
|-
| PRINTFORMAT
| Batch Weights image render format
| MARCOTTE blank (not implemented)
| blank
|
|
|-
| FONTNAME
| Font Name for image render
|
| Courier New
|
|
|-
| FONTSIZE
| Font Size for image render
|
| 12
|
|
|-
| IMAGEHEIGHT
| Height in pixels for image render
|
| 288
|
|
|-
| IMAGEWIDTH
| Width in pixels for image render
|
| 768
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|-
| SHOWWATERTEMPER
| Show or hide Temper Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRIM
| Show or hide Trim Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRUCK
| Show or hide Truck Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERMANUAL
| Show or hide Manual (Preloaded) Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|}

====<s>DOTPA Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://mobile.penndot.gov/vendorapi_eticketing/api</nowiki>
|
| 4.1.2.2
|-
| RESOURCE
| API Resource Name
|
| ticket
|
| 4.1.2.2
|-
| AUTHUSERNAME
| API Authentication User Name
|
| (internal)
|
| 4.1.2.2
|-
| AUTHPASSWORD
| API Authentication Password
|
| (internal)
|
| 4.1.2.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.1.2.2
|-
| CONVLBTOTN
| Convert pounds to tons
| Y/N
| N
|
| 4.1.2.2
|-
| CONVOZTOGL
| Convert ounces to gallons
| Y/N
| N
|
| 4.1.2.2
|-
| BATCHPROTOCOL
| Send notification for specific batch protocols
| CSV list
| (all)
|
| 4.1.2.2
|}

====<s>HAULHUB Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
| 4.3.5.2
|-
| RESOURCE
| API Resource Name
|
| tickets
|
| 4.3.5.2
|-
| CUSTOMERAPIKEY
| API Key specific to customer
|
|
| X
| 4.3.5.2
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
| X
| 4.3.5.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.3.5.2
|}

===Notify Order Complete===
Notify Order Complete devices will send a notification when:
*any order has its Order Status changed to Completed
:-OR-
*a non-plus order has all its non-void loads in To Job or later status


Additionally, these conditions must also met met:
*at least one contact associated with the order has "Email OrdCmp" set
*all non-void tickets have an associated E-Ticket PDF


====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

[[File:OCEMAIL (Send Grid) (Order Complete Email).png]]

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

=====Default Email Format=====
Subject: Order Complete Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr></tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

===Order Route Update===
Order Route Update devices will notify external devices when an order route is added or changed.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://api-gh-prod.azurewebsites.net/api</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|}

File:Contractor Portal.png

2026-02-03T16:42:50Z

Jquinn:

Contractor Portal Example

Notification Devices

2026-01-27T19:37:21Z

Jquinn: /* HAULHUB (Concrete) Parameters */

==Introduction==
Keystone supports several different types of notification devices. These are meant to send notifications based on certain events.

==Device Types==

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Device Type
! Description
! NOTIFYTYPE
! PROTOCOL
! Parameters
! Keystone Version
|-
| [[#Dispatch Event|Dispatch Event]]
| Sent when a dispatch status event occurs
| DISPATCH
| KEYSTONEONLINE ROADKING HAULHUB CIDRA HOLCIM CARBONCURE AGGHAULHUB
| [[#Dispatch Event KEYSTONEONLINE|(see below)]] [[#Dispatch Event ROADKING|(see below)]] [[#Dispatch Event HAULHUB|(see below)]] [[#Dispatch Event CIDRA|(see below)]] [[#Dispatch Event HOLCIM|(see below)]] [[#Dispatch Event CARBONCURE|(see below)]] [[#Dispatch Event AGGHAULHUB|(see below)]]
| 3.6 3.6.15.5 4.3.9.7 4.3.9.7 4.4 4.5.4.0 4.5.5.9
|-
| [[#Notify Batch Weights|Notify Batch Weights]]
| Sent when batch weights are received from a batch control
| BATCHWEIGHTS
| EMAILSENDGRID EMAILSMTP KOBATCHWEIGHTS <s>DOTPA</s> <s>HAULHUB</s>
| [[#Notify Batch Weights EMAILSENDGRID|(see below)]] [[#Notify Batch Weights EMAILSMTP|(see below)]] [[#Notify Batch Weights KOBATCHWEIGHTS|(see below)]] [[#Notify Batch Weights DOTPA|(see below)]] [[#Notify Batch Weights HAULHUB|(see below)]]
| 3.6.11.5 3.6.10 3.6.9 4.1.2.2 4.3.5.2
|-
| [[#Notify Order Complete|Notify Order Complete]]
| Sent when an order is considered complete
| ORDERCOMPLETE
| EMAILSENDGRID EMAILSMTP
| [[#Notify Order Complete EMAILSENDGRID|(see below)]] [[#Notify Order Complete EMAILSMTP|(see below)]]
| 3.6.11.5 3.6.10
|-
| [[#Order Route Update|Order Route Update]]
| Sent when an order route is added/changed
| ORDERROUTE
| KEYSTONEONLINE
| [[#Order Route Update KEYSTONEONLINE|(see below)]]
| 3.6.99.58
|}

===Dispatch Event===
Dispatch Event devices will forward dispatch status events to external devices.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>http://ghwebgps.azurewebsites.net/DispatchAPI</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,3,8,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====ROADKING Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://roadkingtech.com</nowiki>
|
| X
|-
| INFO_COMPANY
| RoadKing Company Name
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,2,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====HAULHUB (Concrete) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:HaulHub Setup.png]]

====CIDRA SmartHatch Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERIDKEY
| ID Key specific to the customer
|
|
|
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://shapi.cidraconcrete.com/interface</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| GHKEvent
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:CIDRA SETUP.png]]

====HOLCIM (Concretely) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERIDKEY
| Id Key specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.concretely.co/api/orders/provider</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| integration/keystone
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====Carbon Cure Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERNAME
| Supplier Name
|
|
|
| X
|-
| APIKEY
| API Key specific to the customer
|
|
|
| X
|-
| APIKEYID
| API Key Id specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://uploads.carboncure.com/</nowiki>
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 2, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|-
| TEST
| Send notifications to test folder
| Y/N
| N
| Use Y when testing
|
|}

====HAULHUB (Aggregate) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| DOTAGENCYCODE
| DOT agency code
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

===Notify Batch Weights===
Notify Batch Weights devices will send a notification when batch weights are received from the batch control associated with a plant.

[[File:Email Batch Weights (Send Grind).png]]

====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

=====Default Email Format=====
Subject: Load Ship Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Ticket:</td><td>[TICKET_NO]</td></tr>
<tr><td>Batch Time:</td><td>[BATCH_END_DT]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr><td>Truck:</td><td>[TRUCK_NO]</td></tr>
<tr><td>Mix:</td><td>[PRODUCT_CODE_1] - [DESCRIPTION_1]</td></tr>
<tr><td>Load Size:</td><td>[QTY_SOLD_1]</td></tr>
<tr><td>Cumul Qty:</td><td>[CUMUL_QTY_1]</td></tr>
<tr><td>Order Qty:</td><td>[ORDER_QTY_1]</td></tr>
<tr></tr>
<tr><td>Plant Name:</td><td>[PLANT_NAME]</td></tr>
<tr><td>Address:</td><td>[PLANT_ADDR_1]</td></tr>
<tr><td></td><td>[PLANT_ADDR_2]</td></tr>
<tr></tr>
</table>
<table>
<tr><th>Material</th><th>Targets</th><th>Actual</th><th>% Error</th><th>% Moist</th></tr>
<tr>
<td>[BW_INGRED_ID_n]</td>
<td>[BW_INGRED_TARGETWEIGHT_n]</td>
<td>[BW_INGRED_ACTUALWEIGHT_n]</td>
<td>[PCT_ERROR]</td>
<td>[BW_INGRED_PCTMOISTURE_n]</td>
</tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

====KOBATCHWEIGHTS Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API URL Root
|
|
| X
|
|-
| RESOURCE
| API URL Resource
|
| PostBatchWeights
|
|
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business Name
|
|
| X
|
|-
| PRINTFORMAT
| Batch Weights image render format
| MARCOTTE blank (not implemented)
| blank
|
|
|-
| FONTNAME
| Font Name for image render
|
| Courier New
|
|
|-
| FONTSIZE
| Font Size for image render
|
| 12
|
|
|-
| IMAGEHEIGHT
| Height in pixels for image render
|
| 288
|
|
|-
| IMAGEWIDTH
| Width in pixels for image render
|
| 768
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|-
| SHOWWATERTEMPER
| Show or hide Temper Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRIM
| Show or hide Trim Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRUCK
| Show or hide Truck Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERMANUAL
| Show or hide Manual (Preloaded) Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|}

====<s>DOTPA Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://mobile.penndot.gov/vendorapi_eticketing/api</nowiki>
|
| 4.1.2.2
|-
| RESOURCE
| API Resource Name
|
| ticket
|
| 4.1.2.2
|-
| AUTHUSERNAME
| API Authentication User Name
|
| (internal)
|
| 4.1.2.2
|-
| AUTHPASSWORD
| API Authentication Password
|
| (internal)
|
| 4.1.2.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.1.2.2
|-
| CONVLBTOTN
| Convert pounds to tons
| Y/N
| N
|
| 4.1.2.2
|-
| CONVOZTOGL
| Convert ounces to gallons
| Y/N
| N
|
| 4.1.2.2
|-
| BATCHPROTOCOL
| Send notification for specific batch protocols
| CSV list
| (all)
|
| 4.1.2.2
|}

====<s>HAULHUB Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
| 4.3.5.2
|-
| RESOURCE
| API Resource Name
|
| tickets
|
| 4.3.5.2
|-
| CUSTOMERAPIKEY
| API Key specific to customer
|
|
| X
| 4.3.5.2
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
| X
| 4.3.5.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.3.5.2
|}

===Notify Order Complete===
Notify Order Complete devices will send a notification when:
*any order has its Order Status changed to Completed
:-OR-
*a non-plus order has all its non-void loads in To Job or later status


Additionally, these conditions must also met met:
*at least one contact associated with the order has "Email OrdCmp" set
*all non-void tickets have an associated E-Ticket PDF


====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

[[File:OCEMAIL (Send Grid) (Order Complete Email).png]]

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

=====Default Email Format=====
Subject: Order Complete Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr></tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

===Order Route Update===
Order Route Update devices will notify external devices when an order route is added or changed.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://api-gh-prod.azurewebsites.net/api</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|}

Notification Devices

2026-01-27T19:36:10Z

Jquinn: /* HAULHUB (Concrete) Parameters */

==Introduction==
Keystone supports several different types of notification devices. These are meant to send notifications based on certain events.

==Device Types==

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Device Type
! Description
! NOTIFYTYPE
! PROTOCOL
! Parameters
! Keystone Version
|-
| [[#Dispatch Event|Dispatch Event]]
| Sent when a dispatch status event occurs
| DISPATCH
| KEYSTONEONLINE ROADKING HAULHUB CIDRA HOLCIM CARBONCURE AGGHAULHUB
| [[#Dispatch Event KEYSTONEONLINE|(see below)]] [[#Dispatch Event ROADKING|(see below)]] [[#Dispatch Event HAULHUB|(see below)]] [[#Dispatch Event CIDRA|(see below)]] [[#Dispatch Event HOLCIM|(see below)]] [[#Dispatch Event CARBONCURE|(see below)]] [[#Dispatch Event AGGHAULHUB|(see below)]]
| 3.6 3.6.15.5 4.3.9.7 4.3.9.7 4.4 4.5.4.0 4.5.5.9
|-
| [[#Notify Batch Weights|Notify Batch Weights]]
| Sent when batch weights are received from a batch control
| BATCHWEIGHTS
| EMAILSENDGRID EMAILSMTP KOBATCHWEIGHTS <s>DOTPA</s> <s>HAULHUB</s>
| [[#Notify Batch Weights EMAILSENDGRID|(see below)]] [[#Notify Batch Weights EMAILSMTP|(see below)]] [[#Notify Batch Weights KOBATCHWEIGHTS|(see below)]] [[#Notify Batch Weights DOTPA|(see below)]] [[#Notify Batch Weights HAULHUB|(see below)]]
| 3.6.11.5 3.6.10 3.6.9 4.1.2.2 4.3.5.2
|-
| [[#Notify Order Complete|Notify Order Complete]]
| Sent when an order is considered complete
| ORDERCOMPLETE
| EMAILSENDGRID EMAILSMTP
| [[#Notify Order Complete EMAILSENDGRID|(see below)]] [[#Notify Order Complete EMAILSMTP|(see below)]]
| 3.6.11.5 3.6.10
|-
| [[#Order Route Update|Order Route Update]]
| Sent when an order route is added/changed
| ORDERROUTE
| KEYSTONEONLINE
| [[#Order Route Update KEYSTONEONLINE|(see below)]]
| 3.6.99.58
|}

===Dispatch Event===
Dispatch Event devices will forward dispatch status events to external devices.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>http://ghwebgps.azurewebsites.net/DispatchAPI</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,3,8,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====ROADKING Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://roadkingtech.com</nowiki>
|
| X
|-
| INFO_COMPANY
| RoadKing Company Name
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,2,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====HAULHUB (Concrete) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:HaulHub Setup.png|thumb]]

====CIDRA SmartHatch Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERIDKEY
| ID Key specific to the customer
|
|
|
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://shapi.cidraconcrete.com/interface</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| GHKEvent
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:CIDRA SETUP.png]]

====HOLCIM (Concretely) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERIDKEY
| Id Key specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.concretely.co/api/orders/provider</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| integration/keystone
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====Carbon Cure Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERNAME
| Supplier Name
|
|
|
| X
|-
| APIKEY
| API Key specific to the customer
|
|
|
| X
|-
| APIKEYID
| API Key Id specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://uploads.carboncure.com/</nowiki>
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 2, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|-
| TEST
| Send notifications to test folder
| Y/N
| N
| Use Y when testing
|
|}

====HAULHUB (Aggregate) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| DOTAGENCYCODE
| DOT agency code
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

===Notify Batch Weights===
Notify Batch Weights devices will send a notification when batch weights are received from the batch control associated with a plant.

[[File:Email Batch Weights (Send Grind).png]]

====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

=====Default Email Format=====
Subject: Load Ship Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Ticket:</td><td>[TICKET_NO]</td></tr>
<tr><td>Batch Time:</td><td>[BATCH_END_DT]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr><td>Truck:</td><td>[TRUCK_NO]</td></tr>
<tr><td>Mix:</td><td>[PRODUCT_CODE_1] - [DESCRIPTION_1]</td></tr>
<tr><td>Load Size:</td><td>[QTY_SOLD_1]</td></tr>
<tr><td>Cumul Qty:</td><td>[CUMUL_QTY_1]</td></tr>
<tr><td>Order Qty:</td><td>[ORDER_QTY_1]</td></tr>
<tr></tr>
<tr><td>Plant Name:</td><td>[PLANT_NAME]</td></tr>
<tr><td>Address:</td><td>[PLANT_ADDR_1]</td></tr>
<tr><td></td><td>[PLANT_ADDR_2]</td></tr>
<tr></tr>
</table>
<table>
<tr><th>Material</th><th>Targets</th><th>Actual</th><th>% Error</th><th>% Moist</th></tr>
<tr>
<td>[BW_INGRED_ID_n]</td>
<td>[BW_INGRED_TARGETWEIGHT_n]</td>
<td>[BW_INGRED_ACTUALWEIGHT_n]</td>
<td>[PCT_ERROR]</td>
<td>[BW_INGRED_PCTMOISTURE_n]</td>
</tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

====KOBATCHWEIGHTS Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API URL Root
|
|
| X
|
|-
| RESOURCE
| API URL Resource
|
| PostBatchWeights
|
|
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business Name
|
|
| X
|
|-
| PRINTFORMAT
| Batch Weights image render format
| MARCOTTE blank (not implemented)
| blank
|
|
|-
| FONTNAME
| Font Name for image render
|
| Courier New
|
|
|-
| FONTSIZE
| Font Size for image render
|
| 12
|
|
|-
| IMAGEHEIGHT
| Height in pixels for image render
|
| 288
|
|
|-
| IMAGEWIDTH
| Width in pixels for image render
|
| 768
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|-
| SHOWWATERTEMPER
| Show or hide Temper Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRIM
| Show or hide Trim Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRUCK
| Show or hide Truck Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERMANUAL
| Show or hide Manual (Preloaded) Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|}

====<s>DOTPA Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://mobile.penndot.gov/vendorapi_eticketing/api</nowiki>
|
| 4.1.2.2
|-
| RESOURCE
| API Resource Name
|
| ticket
|
| 4.1.2.2
|-
| AUTHUSERNAME
| API Authentication User Name
|
| (internal)
|
| 4.1.2.2
|-
| AUTHPASSWORD
| API Authentication Password
|
| (internal)
|
| 4.1.2.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.1.2.2
|-
| CONVLBTOTN
| Convert pounds to tons
| Y/N
| N
|
| 4.1.2.2
|-
| CONVOZTOGL
| Convert ounces to gallons
| Y/N
| N
|
| 4.1.2.2
|-
| BATCHPROTOCOL
| Send notification for specific batch protocols
| CSV list
| (all)
|
| 4.1.2.2
|}

====<s>HAULHUB Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
| 4.3.5.2
|-
| RESOURCE
| API Resource Name
|
| tickets
|
| 4.3.5.2
|-
| CUSTOMERAPIKEY
| API Key specific to customer
|
|
| X
| 4.3.5.2
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
| X
| 4.3.5.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.3.5.2
|}

===Notify Order Complete===
Notify Order Complete devices will send a notification when:
*any order has its Order Status changed to Completed
:-OR-
*a non-plus order has all its non-void loads in To Job or later status


Additionally, these conditions must also met met:
*at least one contact associated with the order has "Email OrdCmp" set
*all non-void tickets have an associated E-Ticket PDF


====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

[[File:OCEMAIL (Send Grid) (Order Complete Email).png]]

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

=====Default Email Format=====
Subject: Order Complete Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr></tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

===Order Route Update===
Order Route Update devices will notify external devices when an order route is added or changed.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://api-gh-prod.azurewebsites.net/api</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|}

File:HaulHub Setup.png

2026-01-27T19:35:49Z

Jquinn:

Haul Hub setup

Notification Devices

2025-10-10T13:32:55Z

Jquinn: /* Notify Batch Weights */

==Introduction==
Keystone supports several different types of notification devices. These are meant to send notifications based on certain events.

==Device Types==

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Device Type
! Description
! NOTIFYTYPE
! PROTOCOL
! Parameters
! Keystone Version
|-
| [[#Dispatch Event|Dispatch Event]]
| Sent when a dispatch status event occurs
| DISPATCH
| KEYSTONEONLINE ROADKING HAULHUB CIDRA HOLCIM CARBONCURE AGGHAULHUB
| [[#Dispatch Event KEYSTONEONLINE|(see below)]] [[#Dispatch Event ROADKING|(see below)]] [[#Dispatch Event HAULHUB|(see below)]] [[#Dispatch Event CIDRA|(see below)]] [[#Dispatch Event HOLCIM|(see below)]] [[#Dispatch Event CARBONCURE|(see below)]] [[#Dispatch Event AGGHAULHUB|(see below)]]
| 3.6 3.6.15.5 4.3.9.7 4.3.9.7 4.4 4.5.4.0 4.5.5.9
|-
| [[#Notify Batch Weights|Notify Batch Weights]]
| Sent when batch weights are received from a batch control
| BATCHWEIGHTS
| EMAILSENDGRID EMAILSMTP KOBATCHWEIGHTS <s>DOTPA</s> <s>HAULHUB</s>
| [[#Notify Batch Weights EMAILSENDGRID|(see below)]] [[#Notify Batch Weights EMAILSMTP|(see below)]] [[#Notify Batch Weights KOBATCHWEIGHTS|(see below)]] [[#Notify Batch Weights DOTPA|(see below)]] [[#Notify Batch Weights HAULHUB|(see below)]]
| 3.6.11.5 3.6.10 3.6.9 4.1.2.2 4.3.5.2
|-
| [[#Notify Order Complete|Notify Order Complete]]
| Sent when an order is considered complete
| ORDERCOMPLETE
| EMAILSENDGRID EMAILSMTP
| [[#Notify Order Complete EMAILSENDGRID|(see below)]] [[#Notify Order Complete EMAILSMTP|(see below)]]
| 3.6.11.5 3.6.10
|-
| [[#Order Route Update|Order Route Update]]
| Sent when an order route is added/changed
| ORDERROUTE
| KEYSTONEONLINE
| [[#Order Route Update KEYSTONEONLINE|(see below)]]
| 3.6.99.58
|}

===Dispatch Event===
Dispatch Event devices will forward dispatch status events to external devices.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>http://ghwebgps.azurewebsites.net/DispatchAPI</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,3,8,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====ROADKING Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://roadkingtech.com</nowiki>
|
| X
|-
| INFO_COMPANY
| RoadKing Company Name
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,2,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====HAULHUB (Concrete) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====CIDRA SmartHatch Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERIDKEY
| ID Key specific to the customer
|
|
|
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://shapi.cidraconcrete.com/interface</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| GHKEvent
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:CIDRA SETUP.png]]

====HOLCIM (Concretely) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERIDKEY
| Id Key specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.concretely.co/api/orders/provider</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| integration/keystone
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====Carbon Cure Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERNAME
| Supplier Name
|
|
|
| X
|-
| APIKEY
| API Key specific to the customer
|
|
|
| X
|-
| APIKEYID
| API Key Id specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://uploads.carboncure.com/</nowiki>
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 2, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|-
| TEST
| Send notifications to test folder
| Y/N
| N
| Use Y when testing
|
|}

====HAULHUB (Aggregate) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| DOTAGENCYCODE
| DOT agency code
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

===Notify Batch Weights===
Notify Batch Weights devices will send a notification when batch weights are received from the batch control associated with a plant.

[[File:Email Batch Weights (Send Grind).png]]

====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

=====Default Email Format=====
Subject: Load Ship Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Ticket:</td><td>[TICKET_NO]</td></tr>
<tr><td>Batch Time:</td><td>[BATCH_END_DT]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr><td>Truck:</td><td>[TRUCK_NO]</td></tr>
<tr><td>Mix:</td><td>[PRODUCT_CODE_1] - [DESCRIPTION_1]</td></tr>
<tr><td>Load Size:</td><td>[QTY_SOLD_1]</td></tr>
<tr><td>Cumul Qty:</td><td>[CUMUL_QTY_1]</td></tr>
<tr><td>Order Qty:</td><td>[ORDER_QTY_1]</td></tr>
<tr></tr>
<tr><td>Plant Name:</td><td>[PLANT_NAME]</td></tr>
<tr><td>Address:</td><td>[PLANT_ADDR_1]</td></tr>
<tr><td></td><td>[PLANT_ADDR_2]</td></tr>
<tr></tr>
</table>
<table>
<tr><th>Material</th><th>Targets</th><th>Actual</th><th>% Error</th><th>% Moist</th></tr>
<tr>
<td>[BW_INGRED_ID_n]</td>
<td>[BW_INGRED_TARGETWEIGHT_n]</td>
<td>[BW_INGRED_ACTUALWEIGHT_n]</td>
<td>[PCT_ERROR]</td>
<td>[BW_INGRED_PCTMOISTURE_n]</td>
</tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

====KOBATCHWEIGHTS Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API URL Root
|
|
| X
|
|-
| RESOURCE
| API URL Resource
|
| PostBatchWeights
|
|
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business Name
|
|
| X
|
|-
| PRINTFORMAT
| Batch Weights image render format
| MARCOTTE blank (not implemented)
| blank
|
|
|-
| FONTNAME
| Font Name for image render
|
| Courier New
|
|
|-
| FONTSIZE
| Font Size for image render
|
| 12
|
|
|-
| IMAGEHEIGHT
| Height in pixels for image render
|
| 288
|
|
|-
| IMAGEWIDTH
| Width in pixels for image render
|
| 768
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|-
| SHOWWATERTEMPER
| Show or hide Temper Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRIM
| Show or hide Trim Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRUCK
| Show or hide Truck Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERMANUAL
| Show or hide Manual (Preloaded) Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|}

====<s>DOTPA Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://mobile.penndot.gov/vendorapi_eticketing/api</nowiki>
|
| 4.1.2.2
|-
| RESOURCE
| API Resource Name
|
| ticket
|
| 4.1.2.2
|-
| AUTHUSERNAME
| API Authentication User Name
|
| (internal)
|
| 4.1.2.2
|-
| AUTHPASSWORD
| API Authentication Password
|
| (internal)
|
| 4.1.2.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.1.2.2
|-
| CONVLBTOTN
| Convert pounds to tons
| Y/N
| N
|
| 4.1.2.2
|-
| CONVOZTOGL
| Convert ounces to gallons
| Y/N
| N
|
| 4.1.2.2
|-
| BATCHPROTOCOL
| Send notification for specific batch protocols
| CSV list
| (all)
|
| 4.1.2.2
|}

====<s>HAULHUB Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
| 4.3.5.2
|-
| RESOURCE
| API Resource Name
|
| tickets
|
| 4.3.5.2
|-
| CUSTOMERAPIKEY
| API Key specific to customer
|
|
| X
| 4.3.5.2
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
| X
| 4.3.5.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.3.5.2
|}

===Notify Order Complete===
Notify Order Complete devices will send a notification when:
*any order has its Order Status changed to Completed
:-OR-
*a non-plus order has all its non-void loads in To Job or later status


Additionally, these conditions must also met met:
*at least one contact associated with the order has "Email OrdCmp" set
*all non-void tickets have an associated E-Ticket PDF


====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

[[File:OCEMAIL (Send Grid) (Order Complete Email).png]]

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

=====Default Email Format=====
Subject: Order Complete Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr></tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

===Order Route Update===
Order Route Update devices will notify external devices when an order route is added or changed.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://api-gh-prod.azurewebsites.net/api</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|}

Notification Devices

2025-10-10T13:31:24Z

Jquinn: /* Notify Batch Weights */

==Introduction==
Keystone supports several different types of notification devices. These are meant to send notifications based on certain events.

==Device Types==

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Device Type
! Description
! NOTIFYTYPE
! PROTOCOL
! Parameters
! Keystone Version
|-
| [[#Dispatch Event|Dispatch Event]]
| Sent when a dispatch status event occurs
| DISPATCH
| KEYSTONEONLINE ROADKING HAULHUB CIDRA HOLCIM CARBONCURE AGGHAULHUB
| [[#Dispatch Event KEYSTONEONLINE|(see below)]] [[#Dispatch Event ROADKING|(see below)]] [[#Dispatch Event HAULHUB|(see below)]] [[#Dispatch Event CIDRA|(see below)]] [[#Dispatch Event HOLCIM|(see below)]] [[#Dispatch Event CARBONCURE|(see below)]] [[#Dispatch Event AGGHAULHUB|(see below)]]
| 3.6 3.6.15.5 4.3.9.7 4.3.9.7 4.4 4.5.4.0 4.5.5.9
|-
| [[#Notify Batch Weights|Notify Batch Weights]]
| Sent when batch weights are received from a batch control
| BATCHWEIGHTS
| EMAILSENDGRID EMAILSMTP KOBATCHWEIGHTS <s>DOTPA</s> <s>HAULHUB</s>
| [[#Notify Batch Weights EMAILSENDGRID|(see below)]] [[#Notify Batch Weights EMAILSMTP|(see below)]] [[#Notify Batch Weights KOBATCHWEIGHTS|(see below)]] [[#Notify Batch Weights DOTPA|(see below)]] [[#Notify Batch Weights HAULHUB|(see below)]]
| 3.6.11.5 3.6.10 3.6.9 4.1.2.2 4.3.5.2
|-
| [[#Notify Order Complete|Notify Order Complete]]
| Sent when an order is considered complete
| ORDERCOMPLETE
| EMAILSENDGRID EMAILSMTP
| [[#Notify Order Complete EMAILSENDGRID|(see below)]] [[#Notify Order Complete EMAILSMTP|(see below)]]
| 3.6.11.5 3.6.10
|-
| [[#Order Route Update|Order Route Update]]
| Sent when an order route is added/changed
| ORDERROUTE
| KEYSTONEONLINE
| [[#Order Route Update KEYSTONEONLINE|(see below)]]
| 3.6.99.58
|}

===Dispatch Event===
Dispatch Event devices will forward dispatch status events to external devices.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>http://ghwebgps.azurewebsites.net/DispatchAPI</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,3,8,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====ROADKING Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://roadkingtech.com</nowiki>
|
| X
|-
| INFO_COMPANY
| RoadKing Company Name
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,2,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====HAULHUB (Concrete) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====CIDRA SmartHatch Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERIDKEY
| ID Key specific to the customer
|
|
|
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://shapi.cidraconcrete.com/interface</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| GHKEvent
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:CIDRA SETUP.png]]

====HOLCIM (Concretely) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERIDKEY
| Id Key specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.concretely.co/api/orders/provider</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| integration/keystone
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====Carbon Cure Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERNAME
| Supplier Name
|
|
|
| X
|-
| APIKEY
| API Key specific to the customer
|
|
|
| X
|-
| APIKEYID
| API Key Id specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://uploads.carboncure.com/</nowiki>
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 2, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|-
| TEST
| Send notifications to test folder
| Y/N
| N
| Use Y when testing
|
|}

====HAULHUB (Aggregate) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| DOTAGENCYCODE
| DOT agency code
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

===Notify Batch Weights===
Notify Batch Weights devices will send a notification when batch weights are received from the batch control associated with a plant.

====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

=====Default Email Format=====
Subject: Load Ship Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Ticket:</td><td>[TICKET_NO]</td></tr>
<tr><td>Batch Time:</td><td>[BATCH_END_DT]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr><td>Truck:</td><td>[TRUCK_NO]</td></tr>
<tr><td>Mix:</td><td>[PRODUCT_CODE_1] - [DESCRIPTION_1]</td></tr>
<tr><td>Load Size:</td><td>[QTY_SOLD_1]</td></tr>
<tr><td>Cumul Qty:</td><td>[CUMUL_QTY_1]</td></tr>
<tr><td>Order Qty:</td><td>[ORDER_QTY_1]</td></tr>
<tr></tr>
<tr><td>Plant Name:</td><td>[PLANT_NAME]</td></tr>
<tr><td>Address:</td><td>[PLANT_ADDR_1]</td></tr>
<tr><td></td><td>[PLANT_ADDR_2]</td></tr>
<tr></tr>
</table>
<table>
<tr><th>Material</th><th>Targets</th><th>Actual</th><th>% Error</th><th>% Moist</th></tr>
<tr>
<td>[BW_INGRED_ID_n]</td>
<td>[BW_INGRED_TARGETWEIGHT_n]</td>
<td>[BW_INGRED_ACTUALWEIGHT_n]</td>
<td>[PCT_ERROR]</td>
<td>[BW_INGRED_PCTMOISTURE_n]</td>
</tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

====KOBATCHWEIGHTS Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API URL Root
|
|
| X
|
|-
| RESOURCE
| API URL Resource
|
| PostBatchWeights
|
|
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business Name
|
|
| X
|
|-
| PRINTFORMAT
| Batch Weights image render format
| MARCOTTE blank (not implemented)
| blank
|
|
|-
| FONTNAME
| Font Name for image render
|
| Courier New
|
|
|-
| FONTSIZE
| Font Size for image render
|
| 12
|
|
|-
| IMAGEHEIGHT
| Height in pixels for image render
|
| 288
|
|
|-
| IMAGEWIDTH
| Width in pixels for image render
|
| 768
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|-
| SHOWWATERTEMPER
| Show or hide Temper Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRIM
| Show or hide Trim Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRUCK
| Show or hide Truck Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERMANUAL
| Show or hide Manual (Preloaded) Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|}

====<s>DOTPA Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://mobile.penndot.gov/vendorapi_eticketing/api</nowiki>
|
| 4.1.2.2
|-
| RESOURCE
| API Resource Name
|
| ticket
|
| 4.1.2.2
|-
| AUTHUSERNAME
| API Authentication User Name
|
| (internal)
|
| 4.1.2.2
|-
| AUTHPASSWORD
| API Authentication Password
|
| (internal)
|
| 4.1.2.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.1.2.2
|-
| CONVLBTOTN
| Convert pounds to tons
| Y/N
| N
|
| 4.1.2.2
|-
| CONVOZTOGL
| Convert ounces to gallons
| Y/N
| N
|
| 4.1.2.2
|-
| BATCHPROTOCOL
| Send notification for specific batch protocols
| CSV list
| (all)
|
| 4.1.2.2
|}

====<s>HAULHUB Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
| 4.3.5.2
|-
| RESOURCE
| API Resource Name
|
| tickets
|
| 4.3.5.2
|-
| CUSTOMERAPIKEY
| API Key specific to customer
|
|
| X
| 4.3.5.2
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
| X
| 4.3.5.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.3.5.2
|}

[[File:Email Batch Weights (Send Grind).png]]

===Notify Order Complete===
Notify Order Complete devices will send a notification when:
*any order has its Order Status changed to Completed
:-OR-
*a non-plus order has all its non-void loads in To Job or later status


Additionally, these conditions must also met met:
*at least one contact associated with the order has "Email OrdCmp" set
*all non-void tickets have an associated E-Ticket PDF


====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

[[File:OCEMAIL (Send Grid) (Order Complete Email).png]]

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

=====Default Email Format=====
Subject: Order Complete Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr></tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

===Order Route Update===
Order Route Update devices will notify external devices when an order route is added or changed.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://api-gh-prod.azurewebsites.net/api</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|}

File:Email Batch Weights (Send Grind).png

2025-10-10T13:30:40Z

Jquinn:

Email Batch Weights Send Grid

Quote Form Fields

2025-10-09T20:18:34Z

Jquinn:

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,
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>

Notification Devices

2025-05-12T18:40:53Z

Jquinn: /* EMAILSENDGRID Parameters */

==Introduction==
Keystone supports several different types of notification devices. These are meant to send notifications based on certain events.

==Device Types==

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Device Type
! Description
! NOTIFYTYPE
! PROTOCOL
! Parameters
! Keystone Version
|-
| [[#Dispatch Event|Dispatch Event]]
| Sent when a dispatch status event occurs
| DISPATCH
| KEYSTONEONLINE ROADKING HAULHUB CIDRA HOLCIM CARBONCURE AGGHAULHUB
| [[#Dispatch Event KEYSTONEONLINE|(see below)]] [[#Dispatch Event ROADKING|(see below)]] [[#Dispatch Event HAULHUB|(see below)]] [[#Dispatch Event CIDRA|(see below)]] [[#Dispatch Event HOLCIM|(see below)]] [[#Dispatch Event CARBONCURE|(see below)]] [[#Dispatch Event AGGHAULHUB|(see below)]]
| 3.6 3.6.15.5 4.3.9.7 4.3.9.7 4.4 4.5.4.0 4.5.5.9
|-
| [[#Notify Batch Weights|Notify Batch Weights]]
| Sent when batch weights are received from a batch control
| BATCHWEIGHTS
| EMAILSENDGRID EMAILSMTP KOBATCHWEIGHTS <s>DOTPA</s> <s>HAULHUB</s>
| [[#Notify Batch Weights EMAILSENDGRID|(see below)]] [[#Notify Batch Weights EMAILSMTP|(see below)]] [[#Notify Batch Weights KOBATCHWEIGHTS|(see below)]] [[#Notify Batch Weights DOTPA|(see below)]] [[#Notify Batch Weights HAULHUB|(see below)]]
| 3.6.11.5 3.6.10 3.6.9 4.1.2.2 4.3.5.2
|-
| [[#Notify Order Complete|Notify Order Complete]]
| Sent when an order is considered complete
| ORDERCOMPLETE
| EMAILSENDGRID EMAILSMTP
| [[#Notify Order Complete EMAILSENDGRID|(see below)]] [[#Notify Order Complete EMAILSMTP|(see below)]]
| 3.6.11.5 3.6.10
|-
| [[#Order Route Update|Order Route Update]]
| Sent when an order route is added/changed
| ORDERROUTE
| KEYSTONEONLINE
| [[#Order Route Update KEYSTONEONLINE|(see below)]]
| 3.6.99.58
|}

===Dispatch Event===
Dispatch Event devices will forward dispatch status events to external devices.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>http://ghwebgps.azurewebsites.net/DispatchAPI</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,3,8,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====ROADKING Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://roadkingtech.com</nowiki>
|
| X
|-
| INFO_COMPANY
| RoadKing Company Name
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,2,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====HAULHUB (Concrete) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====CIDRA SmartHatch Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERIDKEY
| ID Key specific to the customer
|
|
|
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://shapi.cidraconcrete.com/interface</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| GHKEvent
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:CIDRA SETUP.png]]

====HOLCIM (Concretely) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERIDKEY
| Id Key specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.concretely.co/api/orders/provider</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| integration/keystone
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====Carbon Cure Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERNAME
| Supplier Name
|
|
|
| X
|-
| APIKEY
| API Key specific to the customer
|
|
|
| X
|-
| APIKEYID
| API Key Id specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://uploads.carboncure.com/</nowiki>
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 2, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|-
| TEST
| Send notifications to test folder
| Y/N
| N
| Use Y when testing
|
|}

====HAULHUB (Aggregate) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| DOTAGENCYCODE
| DOT agency code
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

===Notify Batch Weights===
Notify Batch Weights devices will send a notification when batch weights are received from the batch control associated with a plant.

====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

=====Default Email Format=====
Subject: Load Ship Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Ticket:</td><td>[TICKET_NO]</td></tr>
<tr><td>Batch Time:</td><td>[BATCH_END_DT]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr><td>Truck:</td><td>[TRUCK_NO]</td></tr>
<tr><td>Mix:</td><td>[PRODUCT_CODE_1] - [DESCRIPTION_1]</td></tr>
<tr><td>Load Size:</td><td>[QTY_SOLD_1]</td></tr>
<tr><td>Cumul Qty:</td><td>[CUMUL_QTY_1]</td></tr>
<tr><td>Order Qty:</td><td>[ORDER_QTY_1]</td></tr>
<tr></tr>
<tr><td>Plant Name:</td><td>[PLANT_NAME]</td></tr>
<tr><td>Address:</td><td>[PLANT_ADDR_1]</td></tr>
<tr><td></td><td>[PLANT_ADDR_2]</td></tr>
<tr></tr>
</table>
<table>
<tr><th>Material</th><th>Targets</th><th>Actual</th><th>% Error</th><th>% Moist</th></tr>
<tr>
<td>[BW_INGRED_ID_n]</td>
<td>[BW_INGRED_TARGETWEIGHT_n]</td>
<td>[BW_INGRED_ACTUALWEIGHT_n]</td>
<td>[PCT_ERROR]</td>
<td>[BW_INGRED_PCTMOISTURE_n]</td>
</tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

====KOBATCHWEIGHTS Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API URL Root
|
|
| X
|
|-
| RESOURCE
| API URL Resource
|
| PostBatchWeights
|
|
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business Name
|
|
| X
|
|-
| PRINTFORMAT
| Batch Weights image render format
| MARCOTTE blank (not implemented)
| blank
|
|
|-
| FONTNAME
| Font Name for image render
|
| Courier New
|
|
|-
| FONTSIZE
| Font Size for image render
|
| 12
|
|
|-
| IMAGEHEIGHT
| Height in pixels for image render
|
| 288
|
|
|-
| IMAGEWIDTH
| Width in pixels for image render
|
| 768
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|-
| SHOWWATERTEMPER
| Show or hide Temper Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRIM
| Show or hide Trim Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRUCK
| Show or hide Truck Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERMANUAL
| Show or hide Manual (Preloaded) Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|}

====<s>DOTPA Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://mobile.penndot.gov/vendorapi_eticketing/api</nowiki>
|
| 4.1.2.2
|-
| RESOURCE
| API Resource Name
|
| ticket
|
| 4.1.2.2
|-
| AUTHUSERNAME
| API Authentication User Name
|
| (internal)
|
| 4.1.2.2
|-
| AUTHPASSWORD
| API Authentication Password
|
| (internal)
|
| 4.1.2.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.1.2.2
|-
| CONVLBTOTN
| Convert pounds to tons
| Y/N
| N
|
| 4.1.2.2
|-
| CONVOZTOGL
| Convert ounces to gallons
| Y/N
| N
|
| 4.1.2.2
|-
| BATCHPROTOCOL
| Send notification for specific batch protocols
| CSV list
| (all)
|
| 4.1.2.2
|}

====<s>HAULHUB Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
| 4.3.5.2
|-
| RESOURCE
| API Resource Name
|
| tickets
|
| 4.3.5.2
|-
| CUSTOMERAPIKEY
| API Key specific to customer
|
|
| X
| 4.3.5.2
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
| X
| 4.3.5.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.3.5.2
|}

===Notify Order Complete===
Notify Order Complete devices will send a notification when:
*any order has its Order Status changed to Completed
:-OR-
*a non-plus order has all its non-void loads in To Job or later status


Additionally, these conditions must also met met:
*at least one contact associated with the order has "Email OrdCmp" set
*all non-void tickets have an associated E-Ticket PDF


====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

[[File:OCEMAIL (Send Grid) (Order Complete Email).png]]

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

=====Default Email Format=====
Subject: Order Complete Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr></tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

===Order Route Update===
Order Route Update devices will notify external devices when an order route is added or changed.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://api-gh-prod.azurewebsites.net/api</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|}

Notification Devices

2025-05-12T18:39:16Z

Jquinn: /* EMAILSENDGRID Parameters */

==Introduction==
Keystone supports several different types of notification devices. These are meant to send notifications based on certain events.

==Device Types==

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Device Type
! Description
! NOTIFYTYPE
! PROTOCOL
! Parameters
! Keystone Version
|-
| [[#Dispatch Event|Dispatch Event]]
| Sent when a dispatch status event occurs
| DISPATCH
| KEYSTONEONLINE ROADKING HAULHUB CIDRA HOLCIM CARBONCURE AGGHAULHUB
| [[#Dispatch Event KEYSTONEONLINE|(see below)]] [[#Dispatch Event ROADKING|(see below)]] [[#Dispatch Event HAULHUB|(see below)]] [[#Dispatch Event CIDRA|(see below)]] [[#Dispatch Event HOLCIM|(see below)]] [[#Dispatch Event CARBONCURE|(see below)]] [[#Dispatch Event AGGHAULHUB|(see below)]]
| 3.6 3.6.15.5 4.3.9.7 4.3.9.7 4.4 4.5.4.0 4.5.5.9
|-
| [[#Notify Batch Weights|Notify Batch Weights]]
| Sent when batch weights are received from a batch control
| BATCHWEIGHTS
| EMAILSENDGRID EMAILSMTP KOBATCHWEIGHTS <s>DOTPA</s> <s>HAULHUB</s>
| [[#Notify Batch Weights EMAILSENDGRID|(see below)]] [[#Notify Batch Weights EMAILSMTP|(see below)]] [[#Notify Batch Weights KOBATCHWEIGHTS|(see below)]] [[#Notify Batch Weights DOTPA|(see below)]] [[#Notify Batch Weights HAULHUB|(see below)]]
| 3.6.11.5 3.6.10 3.6.9 4.1.2.2 4.3.5.2
|-
| [[#Notify Order Complete|Notify Order Complete]]
| Sent when an order is considered complete
| ORDERCOMPLETE
| EMAILSENDGRID EMAILSMTP
| [[#Notify Order Complete EMAILSENDGRID|(see below)]] [[#Notify Order Complete EMAILSMTP|(see below)]]
| 3.6.11.5 3.6.10
|-
| [[#Order Route Update|Order Route Update]]
| Sent when an order route is added/changed
| ORDERROUTE
| KEYSTONEONLINE
| [[#Order Route Update KEYSTONEONLINE|(see below)]]
| 3.6.99.58
|}

===Dispatch Event===
Dispatch Event devices will forward dispatch status events to external devices.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>http://ghwebgps.azurewebsites.net/DispatchAPI</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,3,8,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====ROADKING Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://roadkingtech.com</nowiki>
|
| X
|-
| INFO_COMPANY
| RoadKing Company Name
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,2,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====HAULHUB (Concrete) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====CIDRA SmartHatch Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERIDKEY
| ID Key specific to the customer
|
|
|
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://shapi.cidraconcrete.com/interface</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| GHKEvent
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:CIDRA SETUP.png]]

====HOLCIM (Concretely) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERIDKEY
| Id Key specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.concretely.co/api/orders/provider</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| integration/keystone
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====Carbon Cure Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERNAME
| Supplier Name
|
|
|
| X
|-
| APIKEY
| API Key specific to the customer
|
|
|
| X
|-
| APIKEYID
| API Key Id specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://uploads.carboncure.com/</nowiki>
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 2, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|-
| TEST
| Send notifications to test folder
| Y/N
| N
| Use Y when testing
|
|}

====HAULHUB (Aggregate) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| DOTAGENCYCODE
| DOT agency code
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

===Notify Batch Weights===
Notify Batch Weights devices will send a notification when batch weights are received from the batch control associated with a plant.

====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

=====Default Email Format=====
Subject: Load Ship Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Ticket:</td><td>[TICKET_NO]</td></tr>
<tr><td>Batch Time:</td><td>[BATCH_END_DT]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr><td>Truck:</td><td>[TRUCK_NO]</td></tr>
<tr><td>Mix:</td><td>[PRODUCT_CODE_1] - [DESCRIPTION_1]</td></tr>
<tr><td>Load Size:</td><td>[QTY_SOLD_1]</td></tr>
<tr><td>Cumul Qty:</td><td>[CUMUL_QTY_1]</td></tr>
<tr><td>Order Qty:</td><td>[ORDER_QTY_1]</td></tr>
<tr></tr>
<tr><td>Plant Name:</td><td>[PLANT_NAME]</td></tr>
<tr><td>Address:</td><td>[PLANT_ADDR_1]</td></tr>
<tr><td></td><td>[PLANT_ADDR_2]</td></tr>
<tr></tr>
</table>
<table>
<tr><th>Material</th><th>Targets</th><th>Actual</th><th>% Error</th><th>% Moist</th></tr>
<tr>
<td>[BW_INGRED_ID_n]</td>
<td>[BW_INGRED_TARGETWEIGHT_n]</td>
<td>[BW_INGRED_ACTUALWEIGHT_n]</td>
<td>[PCT_ERROR]</td>
<td>[BW_INGRED_PCTMOISTURE_n]</td>
</tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

====KOBATCHWEIGHTS Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API URL Root
|
|
| X
|
|-
| RESOURCE
| API URL Resource
|
| PostBatchWeights
|
|
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business Name
|
|
| X
|
|-
| PRINTFORMAT
| Batch Weights image render format
| MARCOTTE blank (not implemented)
| blank
|
|
|-
| FONTNAME
| Font Name for image render
|
| Courier New
|
|
|-
| FONTSIZE
| Font Size for image render
|
| 12
|
|
|-
| IMAGEHEIGHT
| Height in pixels for image render
|
| 288
|
|
|-
| IMAGEWIDTH
| Width in pixels for image render
|
| 768
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|-
| SHOWWATERTEMPER
| Show or hide Temper Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRIM
| Show or hide Trim Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRUCK
| Show or hide Truck Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERMANUAL
| Show or hide Manual (Preloaded) Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|}

====<s>DOTPA Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://mobile.penndot.gov/vendorapi_eticketing/api</nowiki>
|
| 4.1.2.2
|-
| RESOURCE
| API Resource Name
|
| ticket
|
| 4.1.2.2
|-
| AUTHUSERNAME
| API Authentication User Name
|
| (internal)
|
| 4.1.2.2
|-
| AUTHPASSWORD
| API Authentication Password
|
| (internal)
|
| 4.1.2.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.1.2.2
|-
| CONVLBTOTN
| Convert pounds to tons
| Y/N
| N
|
| 4.1.2.2
|-
| CONVOZTOGL
| Convert ounces to gallons
| Y/N
| N
|
| 4.1.2.2
|-
| BATCHPROTOCOL
| Send notification for specific batch protocols
| CSV list
| (all)
|
| 4.1.2.2
|}

====<s>HAULHUB Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
| 4.3.5.2
|-
| RESOURCE
| API Resource Name
|
| tickets
|
| 4.3.5.2
|-
| CUSTOMERAPIKEY
| API Key specific to customer
|
|
| X
| 4.3.5.2
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
| X
| 4.3.5.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.3.5.2
|}

===Notify Order Complete===
Notify Order Complete devices will send a notification when:
*any order has its Order Status changed to Completed
:-OR-
*a non-plus order has all its non-void loads in To Job or later status


Additionally, these conditions must also met met:
*at least one contact associated with the order has "Email OrdCmp" set
*all non-void tickets have an associated E-Ticket PDF


====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

[[File:OCEMAIL (Send Grid) (Order Complete Email).png|400px]]

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

=====Default Email Format=====
Subject: Order Complete Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr></tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

===Order Route Update===
Order Route Update devices will notify external devices when an order route is added or changed.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://api-gh-prod.azurewebsites.net/api</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|}

File:OCEMAIL (Send Grid) (Order Complete Email).png

2025-05-12T18:38:57Z

Jquinn: File uploaded with MsUpload

File uploaded with MsUpload

Notification Devices

2025-03-17T19:43:13Z

Jquinn: /* CIDRA SmartHatch Parameters */

==Introduction==
Keystone supports several different types of notification devices. These are meant to send notifications based on certain events.

==Device Types==

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Device Type
! Description
! NOTIFYTYPE
! PROTOCOL
! Parameters
! Keystone Version
|-
| [[#Dispatch Event|Dispatch Event]]
| Sent when a dispatch status event occurs
| DISPATCH
| KEYSTONEONLINE ROADKING HAULHUB CIDRA HOLCIM CARBONCURE AGGHAULHUB
| [[#Dispatch Event KEYSTONEONLINE|(see below)]] [[#Dispatch Event ROADKING|(see below)]] [[#Dispatch Event HAULHUB|(see below)]] [[#Dispatch Event CIDRA|(see below)]] [[#Dispatch Event HOLCIM|(see below)]] [[#Dispatch Event CARBONCURE|(see below)]] [[#Dispatch Event AGGHAULHUB|(see below)]]
| 3.6 3.6.15.5 4.3.9.7 4.3.9.7 4.4 4.5.4.0 4.5.5.9
|-
| [[#Notify Batch Weights|Notify Batch Weights]]
| Sent when batch weights are received from a batch control
| BATCHWEIGHTS
| EMAILSENDGRID EMAILSMTP KOBATCHWEIGHTS <s>DOTPA</s> <s>HAULHUB</s>
| [[#Notify Batch Weights EMAILSENDGRID|(see below)]] [[#Notify Batch Weights EMAILSMTP|(see below)]] [[#Notify Batch Weights KOBATCHWEIGHTS|(see below)]] [[#Notify Batch Weights DOTPA|(see below)]] [[#Notify Batch Weights HAULHUB|(see below)]]
| 3.6.11.5 3.6.10 3.6.9 4.1.2.2 4.3.5.2
|-
| [[#Notify Order Complete|Notify Order Complete]]
| Sent when an order is considered complete
| ORDERCOMPLETE
| EMAILSENDGRID EMAILSMTP
| [[#Notify Order Complete EMAILSENDGRID|(see below)]] [[#Notify Order Complete EMAILSMTP|(see below)]]
| 3.6.11.5 3.6.10
|-
| [[#Order Route Update|Order Route Update]]
| Sent when an order route is added/changed
| ORDERROUTE
| KEYSTONEONLINE
| [[#Order Route Update KEYSTONEONLINE|(see below)]]
| 3.6.99.58
|}

===Dispatch Event===
Dispatch Event devices will forward dispatch status events to external devices.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>http://ghwebgps.azurewebsites.net/DispatchAPI</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,3,8,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====ROADKING Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://roadkingtech.com</nowiki>
|
| X
|-
| INFO_COMPANY
| RoadKing Company Name
|
|
|
| X
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1,2,VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====HAULHUB (Concrete) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====CIDRA SmartHatch Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERIDKEY
| ID Key specific to the customer
|
|
|
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://shapi.cidraconcrete.com/interface</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| GHKEvent
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
|
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

[[File:CIDRA SETUP.png]]

====HOLCIM (Concretely) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERIDKEY
| Id Key specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.concretely.co/api/orders/provider</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| integration/keystone
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====Carbon Cure Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| CUSTOMERNAME
| Supplier Name
|
|
|
| X
|-
| APIKEY
| API Key specific to the customer
|
|
|
| X
|-
| APIKEYID
| API Key Id specific to the customer
|
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://uploads.carboncure.com/</nowiki>
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 2, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|-
| TEST
| Send notifications to test folder
| Y/N
| N
| Use Y when testing
|
|}

====HAULHUB (Aggregate) Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Company Name (sent to DOT)
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from HaulHub
| X
|-
| DOTAGENCYCODE
| DOT agency code
|
|
| Obtain from HaulHub
| X
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
|
| X
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tickets
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use 1, VOID
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

===Notify Batch Weights===
Notify Batch Weights devices will send a notification when batch weights are received from the batch control associated with a plant.

====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWHEADER
| Email Body Batch Weights Section Header HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWDETAIL
| Email Body Batch Weights Section Detail HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| HTMLBWFOOTER
| Email Body Batch Weights Section Footer HTML
|
| [[#Notify Batch Weights Default Email|(see below)]]
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|}

=====Default Email Format=====
Subject: Load Ship Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Ticket:</td><td>[TICKET_NO]</td></tr>
<tr><td>Batch Time:</td><td>[BATCH_END_DT]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr><td>Truck:</td><td>[TRUCK_NO]</td></tr>
<tr><td>Mix:</td><td>[PRODUCT_CODE_1] - [DESCRIPTION_1]</td></tr>
<tr><td>Load Size:</td><td>[QTY_SOLD_1]</td></tr>
<tr><td>Cumul Qty:</td><td>[CUMUL_QTY_1]</td></tr>
<tr><td>Order Qty:</td><td>[ORDER_QTY_1]</td></tr>
<tr></tr>
<tr><td>Plant Name:</td><td>[PLANT_NAME]</td></tr>
<tr><td>Address:</td><td>[PLANT_ADDR_1]</td></tr>
<tr><td></td><td>[PLANT_ADDR_2]</td></tr>
<tr></tr>
</table>
<table>
<tr><th>Material</th><th>Targets</th><th>Actual</th><th>% Error</th><th>% Moist</th></tr>
<tr>
<td>[BW_INGRED_ID_n]</td>
<td>[BW_INGRED_TARGETWEIGHT_n]</td>
<td>[BW_INGRED_ACTUALWEIGHT_n]</td>
<td>[PCT_ERROR]</td>
<td>[BW_INGRED_PCTMOISTURE_n]</td>
</tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

====KOBATCHWEIGHTS Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API URL Root
|
|
| X
|
|-
| RESOURCE
| API URL Resource
|
| PostBatchWeights
|
|
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business Name
|
|
| X
|
|-
| PRINTFORMAT
| Batch Weights image render format
| MARCOTTE blank (not implemented)
| blank
|
|
|-
| FONTNAME
| Font Name for image render
|
| Courier New
|
|
|-
| FONTSIZE
| Font Size for image render
|
| 12
|
|
|-
| IMAGEHEIGHT
| Height in pixels for image render
|
| 288
|
|
|-
| IMAGEWIDTH
| Width in pixels for image render
|
| 768
|
|
|-
| SHOWPCTERROR
| Show or hide "% Error" in ingredient list
| Y/N
| Y
|
| 3.6.16.5+
|-
| SHOWWATERTEMPER
| Show or hide Temper Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRIM
| Show or hide Trim Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERTRUCK
| Show or hide Truck Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|-
| SHOWWATERMANUAL
| Show or hide Manual (Preloaded) Water ingredient type in ingredient list
| Y/N
| Y
|
| 3.6.17.1+
|}

====<s>DOTPA Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://mobile.penndot.gov/vendorapi_eticketing/api</nowiki>
|
| 4.1.2.2
|-
| RESOURCE
| API Resource Name
|
| ticket
|
| 4.1.2.2
|-
| AUTHUSERNAME
| API Authentication User Name
|
| (internal)
|
| 4.1.2.2
|-
| AUTHPASSWORD
| API Authentication Password
|
| (internal)
|
| 4.1.2.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.1.2.2
|-
| CONVLBTOTN
| Convert pounds to tons
| Y/N
| N
|
| 4.1.2.2
|-
| CONVOZTOGL
| Convert ounces to gallons
| Y/N
| N
|
| 4.1.2.2
|-
| BATCHPROTOCOL
| Send notification for specific batch protocols
| CSV list
| (all)
|
| 4.1.2.2
|}

====<s>HAULHUB Parameters</s>====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| ROOTURL
| API Root URL
|
| <nowiki>https://app.haulhub.com/integrations/api/v1</nowiki>
|
| 4.3.5.2
|-
| RESOURCE
| API Resource Name
|
| tickets
|
| 4.3.5.2
|-
| CUSTOMERAPIKEY
| API Key specific to customer
|
|
| X
| 4.3.5.2
|-
| TIMEZONE
| IANA Time Zone for the customer
| (see [https://gist.github.com/aviflax/a4093965be1cd008f172 IANA Time Zone Names])
|
| X
| 4.3.5.2
|-
| TIMEOUT
| API Request Timeout
| milliseconds
| (internal)
|
| 4.3.5.2
|}

===Notify Order Complete===
Notify Order Complete devices will send a notification when:
*any order has its Order Status changed to Completed
:-OR-
*a non-plus order has all its non-void loads in To Job or later status


Additionally, these conditions must also met met:
*at least one contact associated with the order has "Email OrdCmp" set
*all non-void tickets have an associated E-Ticket PDF


====EMAILSENDGRID Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

====EMAILSMTP Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Required
! Keystone Version
|-
| SENDSPACING
| Minimum Spacing between Emails (msec)
| Positive Integer
| 0
|
| 3.6.31.2
|-
| SMTPHOST
| SMTP Server Name or IP Address
|
|
| X
|
|-
| SMTPPORT
| SMTP Server Port
|
| 25
|
|
|-
| SMTPUSERNAME
| SMTP Server Login Username
|
|
|
|
|-
| SMTPPASSWORD
| SMTP Server Login Password
|
|
|
|
|-
| SMTPSSLMETHOD
| SMTP Server SSL Method
| SSLv2 SSLv23 SSLv3 TLSv1 TLSv1_1 TLSv1_2
| (none)
|
|
|-
| SMTPREADTIMEOUT
| SMTP Server Read Timeout
|
|
|
|
|-
| EMAILFROM
| Email From Address
|
|
| X
|
|-
| EMAILSUBJECT
| Email Subject Line
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLHEADER
| Email Body Header HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|-
| HTMLFOOTER
| Email Body Footer HTML
|
| [[#Notify Order Complete Default Email|(see below)]]
|
|
|}

=====Default Email Format=====
Subject: Order Complete Notification
<table>
<tr><td>Customer:</td><td>[CUST_NO]</td></tr>
<tr><td>Order:</td><td>[ORDER_CODE]</td></tr>
<tr><td>Job:</td><td>[JOB_PO_LOC]</td></tr>
<tr><td>Job Lot:</td><td>[JOB_LOT]</td></tr>
<tr><td>Usage:</td><td>[USE]</td></tr>
<tr><td>Customer P.O.:</td><td>[CUSTOMER_PO]</td></tr>
<tr></tr>
</table>
<table>
<tr></tr>
<tr><td>NOTE: This email was automatically generated.</td></tr>
<tr><td>*** PLEASE DO NOT REPLY TO THIS EMAIL. ***</td></tr>
</table>

===Order Route Update===
Order Route Update devices will notify external devices when an order route is added or changed.

====KEYSTONEONLINE Parameters====
{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| ROOTURL
| API URL Root
|
| <nowiki>https://api-gh-prod.azurewebsites.net/api</nowiki>
|
| X
|-
| AUTHUSERNAME
| (not implemented)
|
|
|
|
|-
| AUTHPASSWORD
| (not implemented)
|
|
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business ID Number
|
|
|
| X
|}

File:CIDRA SETUP.png

2025-03-17T19:34:38Z

Jquinn:

CIDRA DEVICE

Invoice Form Fields

2025-03-06T17:09:00Z

Jquinn:

[[CATEGORY: FORMS]]
Fields available for the invoice form.

NOTE: In most cases just the field name is used. In some cases an alias is used and both the actual field name and the alias will be presented - in this case use the alias name on the form.

Examples:
<PRE>
IV.SESSION_NO INV_SESSION_NO,
IV.TRANS_NO INV_TRANS_NO,
SP.DESCRIPTION SALESPERSON_NAME,
</PRE>
Use:
<PRE>
INV_SESSION_NO
INV_TRANS_NO
SALESPERSON_NAME
</PRE>

A ticket Image can be added as:
<pre>
Add ticket form to invoice....
! ---------- Ticket Document Image
DETAIL 5
LINE 4 COLUMN 1 LEFT 80 IMAGEFIELD TICKET DOC_ID

</pre>

To add a Barcode or Payment Link:
<PRE>
For QR Code:
LINE +1 COLUMN 15 LEFT 40 FORMAT BARCODE_QR FIELD CALC_LINK_PAYMENT_QR

For payment link:
COLUMN 15 LEFT 12 FORMAT PDF_HYPERLINK FIELD CALC_LINK_PAYMENT
</PRE>

==Invoice Form Fields==
<PRE>
IV.SESSION_NO INV_SESSION_NO,
IV.TRANS_NO INV_TRANS_NO,
IV.CUST_NO,
IV.INVOICE_NO,
IV.INVOICE_DATE,
SALES_TAX,
SALES_TAX_1,
SALES_TAX_2,
SALES_TAX_3,
IV.DEBIT_AMOUNT INVOICE_TOTAL,
IV.DISC_OFFERED DISC_AVAILABLE,
IV.DISC_VALID_DATE DISC_DATE,
NON_TAXABLE_1,
NON_TAXABLE_2,
NON_TAXABLE_3,
IV.PRIOR_AR_BALANCE,
IV.TAX_AUTHORITY,
IV.JOB_DESC,
IV.AGING_1,
IV.AGING_2,
IV.AGING_3,
IV.AGING_4,
IV.AGING_5,
IV.FINCHG_1,
IV.FINCHG_2,
IV.FINCHG_3,
IV.FINCHG_4,
IV.FINCHG_5,
IV.INVOICEMESSAGE_1,
IV.INVOICEMESSAGE_2,
IV.INVOICEMESSAGE_3,
IV.INVOICEMESSAGE_4,
IV.RETURNADDR_1,
IV.RETURNADDR_2,
IV.RETURNADDR_3,
IV.RETURNADDR_4,
IV.UMS_1,
IV.UMS_2,
IV.UMS_3,
IV.UMS_4,
IV.UMS_5,
IV.UMSTOTAL_1,
IV.UMSTOTAL_2,
IV.UMSTOTAL_3,
IV.UMSTOTAL_4,
IV.UMSTOTAL_5,
IV.CUST_NAME,
IV.CUST_ADDRESS_1,
IV.CUST_ADDRESS_2,
IV.CUST_CITY,
IV.CUST_STATE,
IV.CUST_ZIP,
IV.CREDIT_TERMS,
IV.DISCOUNT_MESSAGE,
(0) SPLIT_RATE, temporary
(0) SPLIT_LIMIT,
IV.PLANT_NAME,
IV.PLANT_SCREEN_ID,
IV.PLANT_ADDRESS_1,
IV.PLANT_ADDRESS_2,
IV.PLANT_PHONE_NO,
IV.SPACE_BETWEEN_TICKETS,
IV.NONTAX_TOTAL,
IV.TICKET_COMMENTS,
IV.PRODUCT_TOTALS,
IV.PRINT_CASH,
IV.PRINT_PRICED,
IV.PRINT_UNPRICED,
IV.CUST_COD_FLAG,
IV.CUST_USER_1,
IV.CUST_USER_2,
IV.DUE_DATE,
IV.VOID_FLAG,
IV.PLANT_NO INV_PLANT_NO,
IV.DIVISION_NO,
IV.CREDIT_AMOUNT,

// customer fields
CU.TAX_ID CUST_TAX_ID,

// sales header fields
SH.SESSION_NO TCK_SESSION_NO,
SH.TRANS_NO TCK_TRANS_NO,
SH.TICKET_NO,
SH.TICKET_DATE,
SH.SLUMP,
SH.MILES,
SH.TICKET_TIME,
SH.SALESPERSON,
SH.CUST_CLASS,
SH.SYS_LOC,
SH.PLANT_NO,
SH.JOB_PO_LOC,
SH.JOB_LOT,
SH.TRUCK_NO,
SH.TRAILER_1,
SH.TRAILER_2,
SH.SOURCE_FLAG,
SH.VOID_FLAG,
SH.PRICED_FLAG,
SH.OFFICE_PRICE_FLAG,
SH.ZONE,
SH.COD_FLAG,
SH.ELAPSED_TIME,
SH.BATCH_START_DT,
SH.BATCH_END_DT,
SH.LEAVE_PLANT_DT,
SH.ARRIVE_JOB_DT,
SH.BEGIN_POUR_DT,
SH.END_POUR_DT,
SH.LEAVE_JOB_DT,
SH.RETURN_PLANT_DT,
SH.CUSTOMER_PO,
SH.DRIVER,
SH.JOB_CLASS,
SH.PAYMENT_AMOUNT,
SH.CHECK_DATE,
SH.CHECK_NO,
SH.BANK_NO,
SH.SHIP_TO_1,
SH.SHIP_TO_2,
SH.SHIP_TO_3,
SH.SHIP_TO_4,
SH.DELV_INST_1,
SH.DELV_INST_2,
SH.DELV_INST_3,
SH.DELV_INST_4,
SH.ORDER_CODE,
SH.JOB_BLOCK,
SH.CUSTOM_1,
SH.CUSTOM_2,
SH.USAGE_TYPE,
SH.DOC_LINK,

// sales detail fields
SD.LINE_NO TCK_LINE_NO,
SD.COMMENT_FLAG,
SD.UNIT_PRICE,
SD.LIST_PRICE,
SD.UNIT_DISC,
SD.STD_DISC,
SD.QTY_SOLD,
SD.PRODUCT_CODE,
SD.UNIT_OF_MEASURE,
SD.DESCRIPTION,
SD.TAX_CODE,
SD.TAX_CODE_2,
SD.TAX_CODE_3,
SD.PRICE_SOURCE,
SD.GROSS_WEIGHT,
SD.TARE_WEIGHT,
SD.WEIGHT_UMS,
SD.SCALE_WEIGHT_FLAG,
SD.EXT_PRICE, .99.27

// salesperson fields
SP.DESCRIPTION SALESPERSON_NAME,

// product fields
PR.ROLLUP_FLAG,
PR.PRODUCT_TYPE,
PR.DESCRIPTION_1 PROD_DESCRIPTION_1,
PR.DESCRIPTION_2 PROD_DESCRIPTION_2,
PR.BASE_PRODUCT

// usage class fields
UC.DESCRIPTION USAGE_DESC, .32

// plant fields
PT.PLANT_NAME TCK_PLANT_NAME,
PT.PLANT_SCREEN_ID TCK_PLANT_SCREEN_ID,

// division fields
//DV.DIVISION_NO,
DV.DIVISION_NAME,

// tax authority fields
TA.DESCRIPTION TAX_AUTH_DESC
</PRE>

==Calculated Fields==
<PRE>
CALC_RETADDR1, CALC_RETADDR2, CALC_RETADDR3,
CALC_RETADDR4, CALC_INVOICEDATE, CALC_CUSTADDR1,
CALC_CUSTADDR2, CALC_CUSTADDR3, CALC_CUSTADDR4,
CALC_INVMSG1, CALC_INVMSG2, CALC_INVMSG3,
CALC_INVMSG4, CALC_CREDITTERMS, CALC_INVOICENO,
CALC_SUBTOTAL, CALC_NONTAXTOTAL, CALC_SALESTAX,
CALC_INVTOTAL, UNIT_PRICE, CALC_EXTPRICE,
CALC_TAXIND, CALC_TAXAUTH, CALC_DISCOUNTLINE,
CALC_DISCTOTAL, CALC_NFAGING1, CALC_NFAGING2,
CALC_NFAGING3, CALC_NFAGING4, CALC_NFAGING5,
CALC_NFAGING4&5, CALC_FINCHGBAL, CALC_AGING1,
CALC_AGING2, CALC_AGING3, CALC_AGING4,
CALC_AGING5, CALC_AGING4&5, CALC_DISCBALDUE,
COND_NONTAXTOTAL, CALC_UMS, CALC_UMSTOTAL,
COND_PRODUCTTOTALS, CALC_UMSTOTALLINE, JOB_PO_LOC,
CALC_DISCDATE, CALC_TAXRATEPCT, CALC_TAXINDYN,
CALC_MATLTOTAL, CALC_DELVTOTAL, QTY_SOLD,
CALC_TKROLL_MATLTOTAL, CALC_TKROLL_DELVTOTAL, CALC_TKROLL_TAXTOTAL,
CALC_TKROLL_TKTTOTAL, CALC_TAXABLETOTAL, ORDER_CODE,
TAX_RATE, SPLIT_RATE, SPLIT_LIMIT,
PLANT_NAME, PLANT_SCREEN_ID, PLANT_ADDRESS_1,
PLANT_ADDRESS_2, PLANT_PHONE_NO, CUST_USER_1,
CUST_USER_2, CALC_PAYMENTTOTAL, CALC_NETDUE,
CALC_PRIORARBAL, CALC_NEWARBAL, TICKET_JOB,
PS_DESCRIPTION, PS_QUANTITY, PS_U_OF_M,
PS_PRODUCT_CODE, PS_UNIT_PRICE, PS_EXT_PRICE,
CALC_VOIDFLAGMSG,
PS_TAX_IND,
TS_PLANT_NO, TS_TICKET_NO,
COND_TICKET_LINE_1,
COND_PRICE_ROLLUP,
COND_COD_CUST, COND_CASH_CUST,
TAX_DESC_1, TAX_DESC_2, TAX_DESC_3,
DOC_ID,
CALC_INVBAL
</PRE>

Invoice Form Fields

2025-03-06T16:30:44Z

Jquinn:

[[CATEGORY: FORMS]]
Fields available for the invoice form.

NOTE: In most cases just the field name is used. In some cases an alias is used and both the actual field name and the alias will be presented - in this case use the alias name on the form.

Examples:
<PRE>
IV.SESSION_NO INV_SESSION_NO,
IV.TRANS_NO INV_TRANS_NO,
SP.DESCRIPTION SALESPERSON_NAME,
</PRE>
Use:
<PRE>
INV_SESSION_NO
INV_TRANS_NO
SALESPERSON_NAME
</PRE>

A ticket Image can be added as:
<pre>
Add ticket form to invoice....
! ---------- Ticket Document Image
DETAIL 5
LINE 4 COLUMN 1 LEFT 80 IMAGEFIELD TICKET DOC_ID

</pre>

To add a Barcode or Payment Link:
<PRE>
For QR Code:
LINE +1 COLUMN 15 LEFT 40 FORMAT BARCODE_QR FIELD CALC_LINK_PAYMENT_QR
https://ko.keystoneonline.us/CustomerPortal/HPPRedirect/ (System Option)

For payment link:
FIELD CALC_LINK_PAYMENT WIDTH ?? FORMAT PDF_HYPERLINK
</PRE>

==Invoice Form Fields==
<PRE>
IV.SESSION_NO INV_SESSION_NO,
IV.TRANS_NO INV_TRANS_NO,
IV.CUST_NO,
IV.INVOICE_NO,
IV.INVOICE_DATE,
SALES_TAX,
SALES_TAX_1,
SALES_TAX_2,
SALES_TAX_3,
IV.DEBIT_AMOUNT INVOICE_TOTAL,
IV.DISC_OFFERED DISC_AVAILABLE,
IV.DISC_VALID_DATE DISC_DATE,
NON_TAXABLE_1,
NON_TAXABLE_2,
NON_TAXABLE_3,
IV.PRIOR_AR_BALANCE,
IV.TAX_AUTHORITY,
IV.JOB_DESC,
IV.AGING_1,
IV.AGING_2,
IV.AGING_3,
IV.AGING_4,
IV.AGING_5,
IV.FINCHG_1,
IV.FINCHG_2,
IV.FINCHG_3,
IV.FINCHG_4,
IV.FINCHG_5,
IV.INVOICEMESSAGE_1,
IV.INVOICEMESSAGE_2,
IV.INVOICEMESSAGE_3,
IV.INVOICEMESSAGE_4,
IV.RETURNADDR_1,
IV.RETURNADDR_2,
IV.RETURNADDR_3,
IV.RETURNADDR_4,
IV.UMS_1,
IV.UMS_2,
IV.UMS_3,
IV.UMS_4,
IV.UMS_5,
IV.UMSTOTAL_1,
IV.UMSTOTAL_2,
IV.UMSTOTAL_3,
IV.UMSTOTAL_4,
IV.UMSTOTAL_5,
IV.CUST_NAME,
IV.CUST_ADDRESS_1,
IV.CUST_ADDRESS_2,
IV.CUST_CITY,
IV.CUST_STATE,
IV.CUST_ZIP,
IV.CREDIT_TERMS,
IV.DISCOUNT_MESSAGE,
(0) SPLIT_RATE, temporary
(0) SPLIT_LIMIT,
IV.PLANT_NAME,
IV.PLANT_SCREEN_ID,
IV.PLANT_ADDRESS_1,
IV.PLANT_ADDRESS_2,
IV.PLANT_PHONE_NO,
IV.SPACE_BETWEEN_TICKETS,
IV.NONTAX_TOTAL,
IV.TICKET_COMMENTS,
IV.PRODUCT_TOTALS,
IV.PRINT_CASH,
IV.PRINT_PRICED,
IV.PRINT_UNPRICED,
IV.CUST_COD_FLAG,
IV.CUST_USER_1,
IV.CUST_USER_2,
IV.DUE_DATE,
IV.VOID_FLAG,
IV.PLANT_NO INV_PLANT_NO,
IV.DIVISION_NO,
IV.CREDIT_AMOUNT,

// customer fields
CU.TAX_ID CUST_TAX_ID,

// sales header fields
SH.SESSION_NO TCK_SESSION_NO,
SH.TRANS_NO TCK_TRANS_NO,
SH.TICKET_NO,
SH.TICKET_DATE,
SH.SLUMP,
SH.MILES,
SH.TICKET_TIME,
SH.SALESPERSON,
SH.CUST_CLASS,
SH.SYS_LOC,
SH.PLANT_NO,
SH.JOB_PO_LOC,
SH.JOB_LOT,
SH.TRUCK_NO,
SH.TRAILER_1,
SH.TRAILER_2,
SH.SOURCE_FLAG,
SH.VOID_FLAG,
SH.PRICED_FLAG,
SH.OFFICE_PRICE_FLAG,
SH.ZONE,
SH.COD_FLAG,
SH.ELAPSED_TIME,
SH.BATCH_START_DT,
SH.BATCH_END_DT,
SH.LEAVE_PLANT_DT,
SH.ARRIVE_JOB_DT,
SH.BEGIN_POUR_DT,
SH.END_POUR_DT,
SH.LEAVE_JOB_DT,
SH.RETURN_PLANT_DT,
SH.CUSTOMER_PO,
SH.DRIVER,
SH.JOB_CLASS,
SH.PAYMENT_AMOUNT,
SH.CHECK_DATE,
SH.CHECK_NO,
SH.BANK_NO,
SH.SHIP_TO_1,
SH.SHIP_TO_2,
SH.SHIP_TO_3,
SH.SHIP_TO_4,
SH.DELV_INST_1,
SH.DELV_INST_2,
SH.DELV_INST_3,
SH.DELV_INST_4,
SH.ORDER_CODE,
SH.JOB_BLOCK,
SH.CUSTOM_1,
SH.CUSTOM_2,
SH.USAGE_TYPE,
SH.DOC_LINK,

// sales detail fields
SD.LINE_NO TCK_LINE_NO,
SD.COMMENT_FLAG,
SD.UNIT_PRICE,
SD.LIST_PRICE,
SD.UNIT_DISC,
SD.STD_DISC,
SD.QTY_SOLD,
SD.PRODUCT_CODE,
SD.UNIT_OF_MEASURE,
SD.DESCRIPTION,
SD.TAX_CODE,
SD.TAX_CODE_2,
SD.TAX_CODE_3,
SD.PRICE_SOURCE,
SD.GROSS_WEIGHT,
SD.TARE_WEIGHT,
SD.WEIGHT_UMS,
SD.SCALE_WEIGHT_FLAG,
SD.EXT_PRICE, .99.27

// salesperson fields
SP.DESCRIPTION SALESPERSON_NAME,

// product fields
PR.ROLLUP_FLAG,
PR.PRODUCT_TYPE,
PR.DESCRIPTION_1 PROD_DESCRIPTION_1,
PR.DESCRIPTION_2 PROD_DESCRIPTION_2,
PR.BASE_PRODUCT

// usage class fields
UC.DESCRIPTION USAGE_DESC, .32

// plant fields
PT.PLANT_NAME TCK_PLANT_NAME,
PT.PLANT_SCREEN_ID TCK_PLANT_SCREEN_ID,

// division fields
//DV.DIVISION_NO,
DV.DIVISION_NAME,

// tax authority fields
TA.DESCRIPTION TAX_AUTH_DESC
</PRE>

==Calculated Fields==
<PRE>
CALC_RETADDR1, CALC_RETADDR2, CALC_RETADDR3,
CALC_RETADDR4, CALC_INVOICEDATE, CALC_CUSTADDR1,
CALC_CUSTADDR2, CALC_CUSTADDR3, CALC_CUSTADDR4,
CALC_INVMSG1, CALC_INVMSG2, CALC_INVMSG3,
CALC_INVMSG4, CALC_CREDITTERMS, CALC_INVOICENO,
CALC_SUBTOTAL, CALC_NONTAXTOTAL, CALC_SALESTAX,
CALC_INVTOTAL, UNIT_PRICE, CALC_EXTPRICE,
CALC_TAXIND, CALC_TAXAUTH, CALC_DISCOUNTLINE,
CALC_DISCTOTAL, CALC_NFAGING1, CALC_NFAGING2,
CALC_NFAGING3, CALC_NFAGING4, CALC_NFAGING5,
CALC_NFAGING4&5, CALC_FINCHGBAL, CALC_AGING1,
CALC_AGING2, CALC_AGING3, CALC_AGING4,
CALC_AGING5, CALC_AGING4&5, CALC_DISCBALDUE,
COND_NONTAXTOTAL, CALC_UMS, CALC_UMSTOTAL,
COND_PRODUCTTOTALS, CALC_UMSTOTALLINE, JOB_PO_LOC,
CALC_DISCDATE, CALC_TAXRATEPCT, CALC_TAXINDYN,
CALC_MATLTOTAL, CALC_DELVTOTAL, QTY_SOLD,
CALC_TKROLL_MATLTOTAL, CALC_TKROLL_DELVTOTAL, CALC_TKROLL_TAXTOTAL,
CALC_TKROLL_TKTTOTAL, CALC_TAXABLETOTAL, ORDER_CODE,
TAX_RATE, SPLIT_RATE, SPLIT_LIMIT,
PLANT_NAME, PLANT_SCREEN_ID, PLANT_ADDRESS_1,
PLANT_ADDRESS_2, PLANT_PHONE_NO, CUST_USER_1,
CUST_USER_2, CALC_PAYMENTTOTAL, CALC_NETDUE,
CALC_PRIORARBAL, CALC_NEWARBAL, TICKET_JOB,
PS_DESCRIPTION, PS_QUANTITY, PS_U_OF_M,
PS_PRODUCT_CODE, PS_UNIT_PRICE, PS_EXT_PRICE,
CALC_VOIDFLAGMSG,
PS_TAX_IND,
TS_PLANT_NO, TS_TICKET_NO,
COND_TICKET_LINE_1,
COND_PRICE_ROLLUP,
COND_COD_CUST, COND_CASH_CUST,
TAX_DESC_1, TAX_DESC_2, TAX_DESC_3,
DOC_ID,
CALC_INVBAL
</PRE>

Ticket Form Fields

2025-02-27T20:23:39Z

Jquinn: /* 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
CALC_BATCHWEIGHTS (Allows Re-Print of Batch Weights) (COLUMN 15 LEFT 50 FORMAT MEMO FIELD CALC_BATCHWEIGHTS)
</PRE>

===Calc Items with U/M===
<PRE>
CALC_NET_WEIGHT Unit Type:Weight (CALC_NET_WEIGHT_TN)
GROSS_WEIGHT Unit Type:Weight (GROSS_WEIGHT_TN)
TARE_WEIGHT Unit Type:Weight (TARE_WEIGHT_TN)
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>