User Alerts

2026-08-25T23:11:07Z

Pmorey: Created page with "Keystone supports User Alerts which are used to communicate important information to Keystone users. CCTALERT table The key to this feature is the CCTALERT table in the CCWSYS database."

Keystone supports User Alerts which are used to communicate important information to Keystone users.

CCTALERT table

The key to this feature is the CCTALERT table in the CCWSYS database.

Main Page

2026-08-25T23:10:06Z

Pmorey: /* Common System Topics */

{| border="0" cellspacing="0" cellpadding="5" align="right"
|[[Tags & Formatting Guide ]]
|-
|[[GH Wiki Standards Guide ]]
|-
|[[More Wiki Info]]
|}
__NOTOC__
 

Online Support & Documentation System 

{| {{table}}
| align="center" style="background:#f0f0f0;"|'''Announcements'''
| align="center" style="background:#f0f0f0;"|'''What's New'''
|-
|
:[[New Keystone Releases]] 5.3.3 - 7/31/2026
:[[Support Alerts]]
:[https://releasethis.azurewebsites.net Release This!]
:[https://givenhansco.sharepoint.com/:x:/s/supportteam/EVr7IrPNSghNruEGW9odUvcB-MeaRucs3z9tJBJH1RIKJw?e=PE3iQR Keystone 5.x Internal Build Testing Spreadsheet]
:[https://givenhansco.sharepoint.com/:x:/s/supportteam/ET5kQCpCQuBCu46qHGtYwgABmovrGxOC8jOlUtpVITGmng?e=VMY2iN Keystone 4.x Internal Build Testing Spreadsheet]

:[https://ghwebdev.azurewebsites.net Keystone Online Dev Site]
:[https://givenhansco.sharepoint.com/Lists/Share%20Calendars/Color%20Calendar.aspx Company SharePoint Calendar]
|
:[[Support_Alerts#Stop_Windows_Updates_during_Keystone_Update_-_8/8/2026 |Stop Windows Updates during Keystone Update]] 8/8/2026
:[[iSolved Keystone Integration]] Jan. 2025
:[[Support_Alerts#Keystone_Relay_Server_fails_to_start_-_10/19/2025 |Keystone Relay Server fails to start]] 10/19/2025
:[[Support_Alerts#Dispatch_Schedule_order_shows_the_wrong_Qty_Delivered_-_12/5/2024 |Dispatch Schedule order shows the wrong Qty Delivered]] 12/5/24
:[[Support_Alerts#Tickets_may_be_associated_with_the_wrong_invoice_using_Print_Invoices_in_Keystone_4.7_and_4.7.1_-_10/10/2024 |Tickets associated with wrong invoice in Keystone 4.7/4.7.1]] 10/10/24
:[[Do This after updating number of licensed InterBase users]] 2/29/24
:[[Backup/Restore Issues#Before_Restoring_a_company_database,_check_this!_(version_4.0.1+) |Before Restoring a company backup, check this!]] 1/11/22
:[[Install/Update Issues#Keystone_database_upgrade_fails_.28version_4.0.1.2B.29 |Improved handling for database upgrade failures in Keystone 4.0.1+]] 10/27/21
:[[Microsoft Edge Chromium required for Keystone 4]] 08/22/21
:[[Configure InterBase ODBC Access]] 03/05/21
:[[AR: Fix Leading/Trailing Spaces in Jobs|Fix Leading/Trailing Spaces in Jobs]] (09/23/20)
:[[AR: Update Sales Costs from Product Standard Cost|Update Sales Costs from Product Standard Cost]] 11/4/19
:[[Configuring Keystone for E-Ticketing]] 10/04/18
:[[Fixing a Double AR void Invoice]] 10/03/18
|}

= Keystone =
{|border="0" cellspacing="5" cellpadding="5" align="center"
|[[Accounts Receivable And Billing Info |AR]]
|[[Inventory Module|Inv]]
|[[Accounts Payable System|A/P]]
|[[General Ledger System|G/L]]
|[[Payroll System|PR]]
|[[Cash Management System|Cash]]
|[[Job Cost System|JC]]
|[[Keystone Ticket Printing System|Ticketing]]
|[[Keystone Dispatch System |Dispatch]]
|[[Keystone Document Imaging |Doc Img]]
|[[Keystone On Demand | On Demand (mobile)]]
|}

== Keystone Quick Links ==

===Common System Topics===
:[[Keystone REST Server (KServer)]]
:[[Keystone Cloud Tunnel (Cloudflare)]]
:[[Keystone Company Database Backup Utility]]
:[[QueryGen]]
:[[Keystone Security]]
:[[Keystone Constants]] Decodes tables lookup values e.g. payroll run types, cash man. trans types. (Updated 01/06/23)
:[[Keystone Installation and Configuration]]
:[[Command Import]]
:[[User Alerts]]

===Common Software Topics===
:[[Export Tickets to Accounting]] (Including EXF)
:[http://keystonehelp.compucrete.com Customer Help Website]
:[[A/R and Billing: Training Outline]]
:[[DeReconcile Inventory]] Undo 1 or more Inv. Recon sessions. (7/24/13)
:[[Payroll: Federal & State Electronic Filing Guides]]

===External/Third Party Devices===
:[[Device Server and Device Aggregator]]
:[[Device Aggregator/Device Server Issues]]
:[[Batch Control Devices]]
:[[GPS/Status Devices]]
:[[Notification Devices]]
:[[HaulHub (Tickets to State DOT)]]

===Interbase Database===
:[[InterBase]]
:[[Interbase System Table Queries ( RDB$ )]]
:[[Database Tips]] (Restore Empty DB)
:[[InterBase Issues]] 
:[[InterBase#Installation_on_64-bit_Windows_10_Creators_Update_.28Build_1703.29_and_higher | Interbase Install Fix for Windows 10 Creators]] (07/17/17)
:[[Database Corruption]] Using '''GHIBDataPump'''
:[[Configure InterBase ODBC Access]]
:[[Do This after updating number of licensed InterBase users]]

===Windows===
:[[Windows 7 and Keystone]]
:[[Keystone 2.5 Changes]] '''with new directory chart'''

===Keystone Software Info===
====Accounting====
:[[General Ledger: Financial Statements with Bigger Print]]
:[[DeReconcile Inventory]] Undo 1 or more Inv. Recon sessions. (7/24/13)
:[[Sales Tax Handling in Keystone 2.3]] (Includes Sales Tax Collection) 10/15/09 10/13/17
:[[Updating the Base Product Code for 1.8 System]] - Methods for setting up Base Product Codes
:[[Time Calculation Queries]] - Demonstration query for time calculation 5/19/08
:[[Zone History Analysis]] - Analyze Zone Times for Dispatch - 5/15/08

====Forms====
:[[Keystone Forms]]
:[[Sample Forms]]
:[[Keystone Form Colors]] The Color De-Coder Ring. (Yes we support the colors blanched almond and lemon chiffon!)
:[[Payroll: Form Versions]] Now supports '''*SUM''' to total all defs in a check group. (07/07/17)

:[[Invoice Form Fields]] (also includes sample adding ticket image to form)
:[[Ticket Form Fields]]
:[[Quote Form Fields]] 10/10/19
:[[Plant Cash Receipt Form Fields]] 03/07/18
:[[PO Form Fields]] 03/07/2018

:[[AP Check Form Fields]] 12/14/2022

====Config====
:[[Company Database Connection Pooling]]
:[[iSolved Keystone Integration]]
:[[Keystone Constants]] Decodes tables lookup values e.g. payroll run types, cash man. trans types.
:[[Keystone Experimental Features]]
:[[Keystone Security]] (Wiki Page)
:[[Keystone Telemetry]]

===Documents===
:[[Media:Web Update.pdf]]
:[[Keystone Accounting Installer Guidelines]]

===Development Etc===
:[[Online Users Conference 2011]] - 3/2/2011
:[[Keystone 3.x Development]]
:[[Development Topics]]
:[[Development How To]]
:[[Keystone 5.x Developer Information]]

==Batch Controls Importing==
:[[Batch Control Ticket Interfaces]]
:[[Batch Ticket Import]]

==GPS==
*[[GPS System Setup]] Modern GPS System Notes
*[[GPS System Diagnostics]] Diagnostic information for GPS systems

== Keystone Tools ==
:[[Query Export]]
::[[Most Excellent Queries]]
:[[Keystone Email Setup]]
:[[Datascope System | DataScope]]
::[[DataScope Examples]] * [[DataScope G/L Finanacial Statements]]

== Tools for Supporting Keystone ==
:[[QueryGen]]
:[[Importing Accounting Data]]
:[[Communications Tools]]
:[[Keystone Support Backup]] Company Database Backup utility for support

== Troubleshooting ==
:[[Application Server Diagnostics]]
:[[Install/Update Issues]] 
:[[Backup/Restore Issues]] 
:[[Keystone System Cache]] 
:[[Error Messages and Meanings]] 
:[[Restoring the Empty Database Template]] 
:[[Disk Space Issues]] 
:[[PC/Network Support]] 
:[[Remote Desktop Tips]]
:[[Performance Issues]]

= General Info =
:[[Windows Utilities]]
:[http://technet.microsoft.com/en-us/windows/jj728757 Windows Shortcut Keys (TechNet)]

KServer JSON Files

2026-08-25T23:04:58Z

Pmorey: /* Actions */

[[CATEGORY: KSERVER]]
==Introduction==

KServer (Keystone REST Server) is a configurable REST/JSON server that uses JSON text files to define its functionality. This provides great flexibility and allows new functionality to be added easily, in most cases without requiring code changes to the server itself.

See: [[Keystone_REST_Server_(KServer)]] for more on KServer.

==JSON File Contents==

===Sample File===

(TBD)

===Actions===

NOTE: These Actions are preliminary and subject to change!

{| border="3" cellspacing="0" cellpadding="3"
! Syntax
! Type
! HTTP Method(s)
! Parameters
! Return Value
! Description
|-
| Abort(v1)
| before/after
| GET,PUT,POST,PATCH
| v1 is a Boolean expression
| none
| aborts endpoint processing if v1 is true
|-
| ApiNegotiate(v1, v2)
| before
| GET
| v1 is the minimum API level the client supports v2 is the desired API level for the client
| >0 is the negotiated API level <0 an error occurred
| negotiates API level between client and server
|-
| ArrayAsValue(v1)
| after
| GET
| v1 is the JSON array name
| first array element value if length of array is exactly 1
| convert single element array into element value
|-
| ClearCaches()
| before
| GET
| none
| none
| clear all query caches for all DB connections
|-
| FileCopy(v1, v2[, v3])
| before/after
| GET,PUT,POST,PATCH
| v1 is the source file key v2 is the destination file key v3 is True to overwrite existing destination file
| none
| copy a file on the server
|-
| FileKey(v1[, v2])
| before
| GET
| v1 is True to indicate a temporary file, False for existing file v2 is the name of the existing file
| JSONValue containing file key
| obtain file key for server file
|-
| JSON(v1)
| before
| GET
| v1 is the JSON string to parse
| JSONValue representing parsed string
| parse JSON string
|-
| Generator(v1, v2, v3[, v4])
| before
| GET,PUT,POST,PATCH
| v1 is the database name v2 is the generator name v3 is the generator increment v4 is the parameter name for the result
| JSONValue representing generator value (if v4 not specified)
| obtain a database generator value (once per request)
|-
| KAlertDownload
| before
| GET
|
| JSONValue representing number of alerts downloaded
| download alert table from cloud to Keystone
|-
| KAlertUpload
| before
| GET
|
| JSONValue representing number of alerts uploaded
| upload alert table from Keystone to the cloud
|-
| KBackupFileKey(v1, v2)
| before
| GET
| v1 is the database suffix (ex: SYS, DOC, 001) v2 is the subfolder (can be empty)
| JSONValue containing file key
| obtain file key for server database backup file
|-
| KClearSessions()
| before
| GET
| none
| none
| clear all existing Session IDs
|-
| KCommitUpdate(v1, v2)
| before
| GET
| v1 is the update version v2 is the update file key
| none
| commit the update file to the system database
|-
| KCompanyReset()
| before
| GET
| none
| none
| perform actions necessary when list of companies changed
|-
| KContactToCust(v1, v2)
| before
| GET
| v1 is the contact key v2 is the customer id parameter name
| none customer id parameter set if customer found HTTP status 403 if no customer found
| lookup customer based on contact key
|-
| KDBBackup(v1, v2, v3)
| before
| GET
| v1 is the database suffix (ex: sys, doc, 001, 002, etc) v2 is the backup file key v3 is the backup info JSON field name PostData is the Base-64 encoded backup info
| JSON value containing the backup task Id
| initiate a database backup task
|-
| KDBRestore(v1, v2)
| before
| GET
| v1 is the database suffix (ex: sys, doc, 001, 002, etc) v2 is the backup file key
| JSON value containing the restore task Id
| initiate a database restore task
|-
| KDBResume(v1)
| before
| GET
| v1 is the database suffix (ex: sys, doc, 001, 002, etc)
| none
| resume KServer access to the database
|-
| KDBSuspend(v1)
| before
| GET
| v1 is the database suffix (ex: sys, doc, 001, 002, etc)
| none
| suspend KServer access to the database
|-
| KDeviceCmd(v1, v2, v3 [,v4])
| after
| GET, PUT
| v1 is the Plant Id v2 is the command v3 is the JSON object reference v4 is a miscellaneous parameter
| none
| send the command to one or more devices based on the device list for the plant
|-
| KNewDocument(v1, v2, v3)
| after
| GET, PUT
| v1 is the source (temporary) file key v2 is the destination filename v3 is the document type ID
| none
| copy the source file to the destination file using the path from the document type
|-
| KPPTranslate(v1[,v2])
| after
| POST
| v1 is the Payment Processor Trx Type (1=CardConnect Capture, 2=CardConnect Settlement) v2 is the content root
| none
| translate the payment processor specific content to generic backoffice content
|-
| KstqcPostResult(v1 [,v2])
| after
| PUT, POST, PATCH
| v1 is the result JSON object name v2 is the additional error information
| JSONObject representing post status
| returns a formatted Stonemont QC post status result
|-
| KstqcResult(v1, v2)
| after
| GET
| v1 is the result JSON object name v2 is the JSON data object name
| JSONObject representing status
| returns a formatted Stonemont QC status result
|-
| KtrTruckStatus(v1, v2)
| after
| GET
| v1 is the truck status JSON field name v2 is the ticket info JSON array name
| JSONObject representing truck status
| returns a formatted truck status result
|-
| KWriteDoc(v1[, v2])
| after
| PUT, POST, PATCH
| v1 is the JSON object/array reference v2 is the filename suffix
| none
| writes a document to a file
|-
| ListEndPoints(v1)
| before
| GET
| v1 specifies whether to include all endpoints (False) or endpoints with queries (True)
| JSONArray containing EndPoint names
| return list of endpoints for current API root
|-
| LoadData(v1[, v2, v3..v10])
| before
| GET
| v1 specifies the type of data to return: *azureblobs *azurecontainers *kscachestats *ksconfig *ksquerystats *ksserverstats v2 is the internal datatable name (v1 is default) v3..v10 are data-specific parameters
| JSONObject containing requested data
| return requested data
|-
| NextEndPoint(v1[, v2])
| after
| PUT, POST, PATCH
| v1 is the next Endpoint URI to process (absolute URI begins with /, relative does not) v2 is the Endpoint method (GET assumed)
| JSONObject representing result of Endpoint execution (for GET method)
| executes the specified Endpoint
|-
| PostFile(v1)
| before
| PUT, POST, PATCH
| v1 is the filename to write to PostData is the Base-64 encoded file data
| none
| writes PostData to file
|-
| ReadFileChunk(v1, v2, v3)
| before/after
| GET
| v1 is the file key to read from v2 is the start offset v3 is the number of bytes to read
| JSONObject representing file chunk ("filedata" contains Base-64 encoded file chunk)
| reads file chunk
|-
| RemoveFile(v1)
| before
| GET
| v1 is the file key to delete
| none
| deletes a file on the server
|-
| ResultAsCSV(v1[, v2])
| after
| GET
| v1 is the JSON object name (must include metadata) v2 indicates whether to include a header record (False assumed)
| JSONString representing result data converted to CSV
| converts result data to CSV format
|-
| ResultToFile(v1[, v2, v3])
| after
| GET
| v1 is the filename to write result data to (use .csv extension to convert to CSV) v2 is the JSON object name for CSV (must include metadata) v3 indicates whether to write a header record for CSV (False assumed)
| JSONValue representing result data with conversion applied
| exports result data to a file
|-
| TaskStatus(v1)
| before
| GET
| v1 is the Task Id
| JSONValue representing the status of the task
| obtain status of a background task
|-
| UserLogin(v1, v2, v3, v4)
| before
| GET
| v1 is the company ID v2 is the user ID v3 is the encrypted password v4 is the client OS version
| JSONObject representing login session information
| logs in a Keystone On-Demand user
|-
| UserLogout(v1)
| before
| GET
| v1 is the session key
| Null
| logs out a Keystone On-Demand user
|-
| UserSessionExpired(v1)
| before
| GET
| v1 is the user ID
| Null
| indicates that a Keystone On-Demand user is no longer logged in
|-
| WriteFileChunk(v1)
| before/after
| PUT, POST, PATCH
| v1 is the file key to write to PostData is the Base-64 encoded file data
| none
| writes file chunk
|}

===Functions===

NOTE: These Functions are preliminary and subject to change!

{| border="3" cellspacing="0" cellpadding="3"
! Syntax
! Parameters
! Return Value
! Description
|-
| Add(v1, v2 [, .. vn])
| v1 (any) is the first source value v2 (any) is the second source value ... vn (any) is the last source value
| sum of all the source values
| calculate sum of a list of values
|-
| AutoInc(v1, v2)
| v1 (string) is the auto-increment ID v2 (integer) is the increment
| previous value of auto-increment v1 + v2
| increments last stored value of auto-increment by specified value
|-
| Base64Decode(v1)
| v1 (string) is the source base-64 encoded string
| base-64 decoded string v1
| applies base-64 decoding to an input string
|-
| Base64Encode(v1)
| v1 (string) is the source string
| base-64 encoded string v1
| applies base-64 encoding to an input string
|-
| Ceil(v1)
| v1 (any) is the source value
| integer ceiling of v1
| returns the integer ceiling of a value
|-
| ChangeFileExt(v1, v2)
| v1 (string) is the source filename v2 (string) is the new file extension
| source filename with new file extension
| change extension of filename
|-
| Coalesce(v1, [, .. vn])
| v1 (any) is the first value ... vn (any) is the last value
| the first non-null value or Null
| returns the first non-null value in a list of values
|-
| CoalesceStr(v1, [, .. vn])
| v1 (any) is the first value ... vn (any) is the last value
| the first non-empty string value or Null
| returns the first non-empty string value in a list of values
|-
| CompareDatePart(v1, v2 [, v3, v4])
| v1 (datetime) is the source value v2 (integer) is the target year v3 (integer) is the target month v4 (integer) is the target day
| -1 if source value < target values 0 if source value matches target values 1 if source value > target values
| compares a source datetime with target year/month/day
|-
| Concat(v1, v2 [, .. vn])
| v1 (string) is the first source string v2 (string) is the second source string ... vn (string) is the last source string
| all the source strings concatenated together
| concatenate a list of strings
|-
| Config(v1)
| v1 (string) is the configuration parameter name
| value of configuration parameter v1
| obtain value of configuration parameter
|-
| Copy(v1,v2,v3)
| v1 (string) is the source string v2 (integer) is the starting position v3 (integer) is the length to copy
| source string from starting position to starting position + length - 1
| copy a portion of a string
|-
| DateOf(v1)
| v1 (TDateTime) is the source value
| v1 with time portion stripped
| return date portion of TDateTime value
|-
| DayOf(v1)
| v1 (TDateTime) is the source value
| day portion of v1
| return day portion of TDateTime value
|-
| Distance(v1, v2, v3, v4 [,v5])
| v1 (double) is the first coordinate latitude v2 (double) is the first coordinate longitude v3 (double) is the second coordinate latitude v4 (double) is the second coordinate longitude v5 (boolean) is True for metric, False for imperial units
| straight-line distance between two coordinates
| return straight-line distance in kilometers (metric) or miles (imperial)
|-
| Div(v1, v2 [, .. vn])
| v1 (any) is the first source value v2 (any) is the second source value ... vn (any) is the last source value
| division of all the source values
| calculate result of division of a list of values
|-
| ElementOf(v1, v2 [, .. vn])
| v1 (integer) is the array index v2 (any) is the first array value... vn (any) is the last array value
| element v1 of the array or Null if v1 is outside the bounds of the array
| returns a specified element of an array of values
|-
| EncodeDateTime(v1, v2, v3 [, v4, v5, v6, v7])
| v1 (integer) is the year v2 (integer) is the month v3 (integer) is the day v4 (integer) is the hour v5 (integer) is the minute v6 (integer) is the second v7 (integer) is the millisecond
| input values encoded into a TDateTime
| return TDateTime from input values
|-
| EndOfTheDay(v1)
| v1 (TDateTime) is the source value
| last millisecond of v1
| return last millisecond of the day for a date
|-
| EndOfTheMonth(v1)
| v1 (TDateTime) is the source value
| last millisecond of the last day of the month of v1
| return last millisecond of last day of month for a date
|-
| EndOfTheWeek(v1)
| v1 (TDateTime) is the source value
| last millisecond of the last day of the week of v1
| return last millisecond of last day of week for a date
|-
| EndOfTheYear(v1)
| v1 (TDateTime) is the source value
| last millisecond of the last day of the year of v1
| return last millisecond of last day of year for a date
|-
| Eq(v1, v2)
| v1 (any) is the first source value v2 (any) is the second source value
| True if v1 = v2 False if v1 <> v2
| test equality of two values
|-
| ExtractFileExt(v1)
| v1 (string) is the source filename
| source file extension (including leading '.')
| extract extension from filename
|-
| FileExists(v1)
| v1 (string) is the source filename
| True if the file v1 exists
| determine if file exists
|-
| FileKey(v1 [,v2])
| v1 (boolean) is True for a new (temporary) file, False for an existing file v2 (string) is the source filename
| file key
| obtain file key for server file
|-
| Format(v1 [,v2 [, .. vn]])
| v1 (string) is the format string v2 (any) is the first format parameter ... vn (any) is the last format parameter
| v1 formatted using parameters v2..vn
| format a string with parameters
|-
| FormatCurr(v1, v2)
| v1 (string) is the desired currency format v2 (currency) is the source value
| v2 formatted using the format specified by v1
| format a currency value
|-
| FormatDateTime(v1, v2)
| v1 (string) is the desired date/time format v2 (TDateTime) is the source value
| v2 formatted using the format specified by v1
| format a date/time value
|-
| Ge(v1, v2)
| v1 (any) is the first source value v2 (any) is the second source value
| True if v1 >= v2 False if v1 < v2
| test if first value is greater than or equal to the second value
|-
| Generator(v1, v2, v3)
| v1 (string) is the database name v2 (string) is the generator name v3 (integer) is the generator increment
| new generator value
| obtain a database generator value
|-
| Gt(v1, v2)
| v1 (any) is the first source value v2 (any) is the second source value
| True if v1 > v2 False if v1 <= v2
| test if first value is greater than the second value
|-
| High(v1)
| v1 (string) is one of the following data types: * Integer * TDateTime
| highest supported value for the data type
| return the highest value for the data type
|-
| If(v1, v2 [,v3])
| v1 (boolean) is the source condition v2 (any) is the True value v3 (any) is the False value
| v2 if v1 is True v3 (or unchanged) if v1 is False
| evaluate condition and return True or False value
|-
| In(v1, v2 [, .. vn])
| v1 (any) is the input value v2 thru vn (any) are the test values
| True if v1 matches at least one of the test values
| determine if an input value occurs in a list of test values
|-
| IncDay(v1 [,v2])
| v1 (TDateTime) is the source value v2 (integer) is the offset
| v1 with day offset by v2 (1 assumed)
| adjust day within a TDateTime value
|-
| IncHour(v1 [,v2])
| v1 (TDateTime) is the source value v2 (integer) is the offset
| v1 with hours offset by v2 (1 assumed)
| adjust hours within a TDateTime value
|-
| IncMinute(v1 [,v2])
| v1 (TDateTime) is the source value v2 (integer) is the offset
| v1 with minutes offset by v2 (1 assumed)
| adjust minutes within a TDateTime value
|-
| IncMonth(v1, [,v2])
| v1 (TDateTime) is the source value v2 (integer) is the offset
| v1 with month offset by v2 (1 assumed)
| adjust month within a TDateTime value
|-
| IncSecond(v1 [,v2])
| v1 (TDateTime) is the source value v2 (integer) is the offset
| v1 with seconds offset by v2 (1 assumed)
| adjust seconds within a TDateTime value
|-
| IncWeek(v1, [,v2])
| v1 (TDateTime) is the source value v2 (integer) is the offset
| v1 with week offset by v2 (1 assumed)
| adjust week within a TDateTime value
|-
| IncYear(v1, [,v2])
| v1 (TDateTime) is the source value v2 (integer) is the offset
| v1 with year offset by v2 (1 assumed)
| adjust year within a TDateTime value
|-
| IsNull(v1)
| v1 (any) is the source value
| True if V1 is Null False if V1 is not Null
| test for a Null value
|-
| IsNotNull(v1)
| v1 (any) is the source value
| True if V1 is not Null False if V1 is Null
| test for a Non-Null value
|-
| IsStrEmpty(v1)
| v1 (any) is the source value
| True if V1 is Null or an empty string False otherwise
| test for a Null or empty string value
|-
| IsStrNotEmpty(v1)
| v1 (any) is the source value
| True if V1 is not Null and not an empty string False otherwise
| test for a Non-Null, non-empty string value
|-
| KDateTime(v1, v2)
| v1 (TDateTime) is the source date v2 (integer-HHMM) is the source time
| date of v1 combined with time of v2 as TDateTime
| combine Keystone date and time values into a single TDateTime value
|-
| KeystoneVersion()
|
| (string) Keystone version
| return Keystone version
|-
| KMinutesToTime(v1)
| v1 (integer) is the source minutes
| v1 (minutes) converted to hours/minutes as HHMM
| convert minutes to Keystone HHMM
|-
| KProjectedTime(v1, v2, v3, v4, v5, v6 [,v7]) DEPRECATED a/o 4.1.5.1 - use KQueryProjectedTime
| v1 (integer) is the order session number v2 (integer) is the order trans number v3 (integer) is the order load number v4 (currency) is the load size v5 (integer) is the load status v6 (datetime) is the current dispatch time v7 (integer) is the status of the desired projected time
| TDateTime representing the requested projected time (On Job/Return Plant assumed based on load status)
| calculate a projected time based on order and ticket information obtained by querying the database
|-
| KQueryProjectedTime(v1, v2, v3, v4 [,v5])
| v1 (string) is the name of an already active query containing the time fields v2 (currency) is the load size v3 (integer) is the load status v4 (datetime) is the current dispatch time v5 (integer) is the status of the desired projected time
| TDateTime representing the requested projected time (On Job/Return Plant assumed based on load status)
| calculate a projected time based on order and ticket information obtained from already active query
|-
| KSessionNo()
| none
| Keystone session number
| obtain the Keystone session number associated with SessionId
|-
| KSystemOption(v1, v2 [,v3])
| v1 (string) is the section name v2 (string) is the option name v3 (string) is the default value
| Keystone system option for DEFAULT group
| obtain the specified Keystone system option (or default value)
|-
| KTimeOf(v1)
| v1 (TDateTime) is the source value
| v1 with date portion stripped as HHMM
| return time extracted from source value as HHMM
|-
| KTransNo([v1])
| v1 (integer) is the increment (default is 1)
| Keystone trans number
| obtain the next available Keystone trans number
|-
| KUMConvert(v1, v2, v3 [, v4])
| v1 (number) is the source quantity v2 (string) is the source U/M v3 (string) is the target U/M v4 (string) is the product id
| (currency) target quantity
| return source quantity converted to target U/M
|-
| KUpdateFile()
|
| (string) Keystone update filename
| return Keystone update filename from system database
|-
| Le(v1, v2)
| v1 (any) is the first source value v2 (any) is the second source value
| True if v1 <= v2 False if v1 > v2
| test if first value is less than or equal to the second value
|-
| LeftStr(v1, v2)
| v1 (string) is the source value v2 (integer) is the count
| the first v2 characters of v1
| return first n characters of a string
|-
| Lookup(v1, v2, v3, v4, v5 [, .. vn-1, vn])
| v1 (string) is the DataTable name v2 (string) is the DataTable result field name v3 (any) is the default result value v4 (string) is the DataTable lookup field #1 name v5 (any) is the DataTable lookup field #1 value ... vn-1 (string) is the DataTable lookup field #n name vn (any) is the DataTable lookup field #n value
| Value of DataTable result field if record lookup successful (default value otherwise)
| lookup a value in a DataTable
|-
| Low(v1)
| v1 (string) is one of the following data types: * Integer * TDateTime
| lowest supported value for the data type
| return the lowest value for the data type
|-
| Lowercase(v1)
| v1 (string) is the source value
| v1 with all characters converted to lowercase
| lowercase a string
|-
| Lt(v1, v2)
| v1 (any) is the first source value v2 (any) is the second source value
| True if v1 < v2 False if v1 >= v2
| test if first value is less than the second value
|-
| Max(v1, v2 [, .. vn])
| v1 (any) is the first source value v2 (any) is the second source value ... vn (any) is the last source value
| maximum of all the source values
| find maximum of a list of values
|-
| MidStr(v1, v2, v3)
| v1 (string) is the source value v2 (integer) is the start position v3 (integer) is the count
| v3 characters of v1 beginning at position v2
| return a portion of a string
|-
| Min(v1, v2 [, .. vn])
| v1 (any) is the first source value v2 (any) is the second source value ... vn (any) is the last source value
| minimum of all the source values
| find minimum of a list of values
|-
| MinuteDiff(v1, v2)
| v1 (TDateTime) is the first source value v2 (TDateTime) is the second source value
| difference of v1 - v2 in minutes
| return difference in minutes of two TDateTime values
|-
| MinutesBetween(v1, v2)
| v1 (TDateTime) is the first source value v2 (TDateTime) is the second source value
| minutes between v1 and v2 (always a positive integer)
| return positive minutes between two TDateTime values
|-
| MinuteSpan(v1, v2)
| v1 (TDateTime) is the first source value v2 (TDateTime) is the second source value
| span of v1 - v2 in minutes (always positive)
| return positive span in minutes of two TDateTime values
|-
| MonthOf(v1)
| v1 (TDateTime) is the source value
| month portion of v1
| return month portion of TDateTime value
|-
| Mul(v1, v2 [, .. vn])
| v1 (any) is the first source value v2 (any) is the second source value ... vn (any) is the last source value
| multiplication of all the source values
| calculate result of multiplication of a list of values
|-
| Ne(v1, v2)
| v1 (any) is the first source value v2 (any) is the second source value
| True if v1 <> v2 False if v1 = v2
| test inequality of two values
|-
| Negate(v1)
| v1 (any) is the source value
| negative of v1
| negate a value
|-
| Now()
|
| current system date & time
| return current system date & time
|-
| NullIf(v1, v2)
| v1 (any) is the first source value v2 (any) is the second source value
| Null if v1 = v2 v1 if v1 <> v2
| apply NullIf operation to two values
|-
| PathCombine(v1, v2)
| v1 (string) is the file path v2 (string) is the file name
| file path concatenated with path separator and file name
| combine file path and file name
|-
| RightStr(v1, v2)
| v1 (string) is the source value v2 (integer) is the count
| the last v2 characters of v1
| return last n characters of a string
|-
| Round(v1 [, v2])
| v1 (any) is the source value v2 (integer) is the number of decimal places (0 assumed)
| source value rounded to specified decimal places
| round a value
|-
| ServerName()
|
| (string) server name
| return KServer name
|-
| ServerVersion()
|
| (string) server version
| return KServer version
|-
| Split(v1,v2,v3)
| v1 (string) is the source value v2 (string) is the delimiter v3 (integer) is the desired occurrence
| v3rd string delimited by v2 from v1
| extract a string element within a delimited string
|-
| SplitFileLevels(v1,v2)
| v1 (string) is the filename including path v2 (integer) is the number of file levels
| v1
| maintain several versions of a specified file
|-
| StartOfTheDay(v1)
| v1 (TDateTime) is the source value
| first millisecond of v1
| return first millisecond of the day for a date
|-
| StartOfTheMonth(v1)
| v1 (TDateTime) is the source value
| first millisecond of the first day of the month of v1
| return first millisecond of first day of month for a date
|-
| StartOfTheWeek(v1)
| v1 (TDateTime) is the source value
| first millisecond of the first day of the week of v1
| return first millisecond of first day of week for a date
|-
| StartOfTheYear(v1)
| v1 (TDateTime) is the source value
| first millisecond of the first day of the year of v1
| return first millisecond of first day of year for a date
|-
| StringReplace(v1, v2, v3[, v4])
| v1 (string) is the source value v2 (string) is the search value v3 (string) is the replacement value v4 (boolean) is true to replace all occurrences
| v1 replacing first/all occurrences of v2 with v3
| replace a specific pattern within a string
|-
| Sub(v1, v2 [, .. vn])
| v1 (any) is the first source value v2 (any) is the second source value ... vn (any) is the last source value
| subtraction of all the source values
| calculate result of subtraction of a list of values
|-
| TimeOf(v1)
| v1 (TDateTime) is the source value
| v1 with date portion stripped
| return time portion of TDateTime value
|-
| ToBool(v1 [,v2, v3])
| v1 (any) is the source value v2 (string) is the source string representing True v3 (string) is the source string representing False
| v1 converted to boolean (False if NULL)
| return source value converted to boolean
|-
| ToInteger(v1)
| v1 (any) is the source value
| v1 converted to integer (zero if NULL)
| return source value converted to integer
|-
| ToString(v1)
| v1 (any) is the source value
| v1 converted to string (empty string if NULL)
| return source value converted to string
|-
| Trunc(v1)
| v1 (any) is the source value
| integer truncation of v1
| returns the integer truncation of a value
|-
| Uppercase(v1)
| v1 (string) is the source value
| v1 with all characters converted to uppercase
| uppercase a string
|-
| WeekOf(v1)
| v1 (TDateTime) is the source value
| week of the year of v1
| return week of the year of TDateTime value
|-
| WorkDaysInMonth(v1,v2)
| v1 (TDateTime) is the source value v2 (integer) is a control value: 0 = all days are work days 1 = Sat is not a work day 2 = Sun is not a work day 3 = Sat/Sun are not work days
| work days in the month up to and including v1
| return work days in the month up to and including the TDateTime value
|-
| YearOf(v1)
| v1 (TDateTime) is the source value
| year portion of v1
| return year portion of TDateTime value
|}

Notification Devices

2026-08-11T13:02:17Z

Pmorey: /* EMAILSMTP 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 AICRETE GIATEC
| [[#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)]] [[#Dispatch Event AICRETE|(see below)]] [[#Dispatch Event GIATEC|(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 4.6.99.15 5.2.7.6
|-
| [[#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> KEYSTONEONLINE
| [[#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)]] [[#Notify Batch Weights KEYSTONEONLINE|(see below)]]
| 3.6.11.5 3.6.10 3.6.9 4.1.2.2 4.3.5.2 5.2.8.14
|-
| [[#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)
|
|
|}

====AICRETE Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from AICrete
| X
|-
| CUSTOMERAPITOKEN
| API Token specific to the customer
|
|
| Obtain from AICrete
| 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>TBD</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| ticket
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use ???
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====GIATEC Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERUSERNAME
| Username specific to the customer
|
|
| Obtain from GiaTec
| X
|-
| CUSTOMERPASSWORD
| Password specific to the customer
|
|
| Obtain from GiaTec
| 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://smartmix.giatecscientific.com/keystone-worker/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tracking
|
|
|-
| AUTHROOTURL
| Authorization URL Root
|
| <nowiki>https://smartmix.giatecscientific.com/auth</nowiki>
|
|
|-
| AUTHRESOURCE
| Authorization URL Resource
|
| login
|
|
|-
| 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)
|
|
|}

===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 "Variance" and "Variance %" 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 "Variance" and "Variance %" 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
|}

====KEYSTONEONLINE 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
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business GUID
|
|
| X
|
|}

===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-08-11T13:01:52Z

Pmorey: /* 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 AICRETE GIATEC
| [[#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)]] [[#Dispatch Event AICRETE|(see below)]] [[#Dispatch Event GIATEC|(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 4.6.99.15 5.2.7.6
|-
| [[#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> KEYSTONEONLINE
| [[#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)]] [[#Notify Batch Weights KEYSTONEONLINE|(see below)]]
| 3.6.11.5 3.6.10 3.6.9 4.1.2.2 4.3.5.2 5.2.8.14
|-
| [[#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)
|
|
|}

====AICRETE Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from AICrete
| X
|-
| CUSTOMERAPITOKEN
| API Token specific to the customer
|
|
| Obtain from AICrete
| 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>TBD</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| ticket
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use ???
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====GIATEC Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERUSERNAME
| Username specific to the customer
|
|
| Obtain from GiaTec
| X
|-
| CUSTOMERPASSWORD
| Password specific to the customer
|
|
| Obtain from GiaTec
| 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://smartmix.giatecscientific.com/keystone-worker/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tracking
|
|
|-
| AUTHROOTURL
| Authorization URL Root
|
| <nowiki>https://smartmix.giatecscientific.com/auth</nowiki>
|
|
|-
| AUTHRESOURCE
| Authorization URL Resource
|
| login
|
|
|-
| 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)
|
|
|}

===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 "Variance" and "Variance %" 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
|}

====KEYSTONEONLINE 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
|
|
|-
| INFO_BUSINESSID
| Keystone Online Business GUID
|
|
| X
|
|}

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

Main Page

2026-08-08T13:57:33Z

Pmorey:

{| border="0" cellspacing="0" cellpadding="5" align="right"
|[[Tags & Formatting Guide ]]
|-
|[[GH Wiki Standards Guide ]]
|-
|[[More Wiki Info]]
|}
__NOTOC__
 

Online Support & Documentation System 

{| {{table}}
| align="center" style="background:#f0f0f0;"|'''Announcements'''
| align="center" style="background:#f0f0f0;"|'''What's New'''
|-
|
:[[New Keystone Releases]] 5.3.3 - 7/31/2026
:[[Support Alerts]]
:[https://releasethis.azurewebsites.net Release This!]
:[https://givenhansco.sharepoint.com/:x:/s/supportteam/EVr7IrPNSghNruEGW9odUvcB-MeaRucs3z9tJBJH1RIKJw?e=PE3iQR Keystone 5.x Internal Build Testing Spreadsheet]
:[https://givenhansco.sharepoint.com/:x:/s/supportteam/ET5kQCpCQuBCu46qHGtYwgABmovrGxOC8jOlUtpVITGmng?e=VMY2iN Keystone 4.x Internal Build Testing Spreadsheet]

:[https://ghwebdev.azurewebsites.net Keystone Online Dev Site]
:[https://givenhansco.sharepoint.com/Lists/Share%20Calendars/Color%20Calendar.aspx Company SharePoint Calendar]
|
:[[Support_Alerts#Stop_Windows_Updates_during_Keystone_Update_-_8/8/2026 |Stop Windows Updates during Keystone Update]] 8/8/2026
:[[iSolved Keystone Integration]] Jan. 2025
:[[Support_Alerts#Keystone_Relay_Server_fails_to_start_-_10/19/2025 |Keystone Relay Server fails to start]] 10/19/2025
:[[Support_Alerts#Dispatch_Schedule_order_shows_the_wrong_Qty_Delivered_-_12/5/2024 |Dispatch Schedule order shows the wrong Qty Delivered]] 12/5/24
:[[Support_Alerts#Tickets_may_be_associated_with_the_wrong_invoice_using_Print_Invoices_in_Keystone_4.7_and_4.7.1_-_10/10/2024 |Tickets associated with wrong invoice in Keystone 4.7/4.7.1]] 10/10/24
:[[Do This after updating number of licensed InterBase users]] 2/29/24
:[[Backup/Restore Issues#Before_Restoring_a_company_database,_check_this!_(version_4.0.1+) |Before Restoring a company backup, check this!]] 1/11/22
:[[Install/Update Issues#Keystone_database_upgrade_fails_.28version_4.0.1.2B.29 |Improved handling for database upgrade failures in Keystone 4.0.1+]] 10/27/21
:[[Microsoft Edge Chromium required for Keystone 4]] 08/22/21
:[[Configure InterBase ODBC Access]] 03/05/21
:[[AR: Fix Leading/Trailing Spaces in Jobs|Fix Leading/Trailing Spaces in Jobs]] (09/23/20)
:[[AR: Update Sales Costs from Product Standard Cost|Update Sales Costs from Product Standard Cost]] 11/4/19
:[[Configuring Keystone for E-Ticketing]] 10/04/18
:[[Fixing a Double AR void Invoice]] 10/03/18
|}

= Keystone =
{|border="0" cellspacing="5" cellpadding="5" align="center"
|[[Accounts Receivable And Billing Info |AR]]
|[[Inventory Module|Inv]]
|[[Accounts Payable System|A/P]]
|[[General Ledger System|G/L]]
|[[Payroll System|PR]]
|[[Cash Management System|Cash]]
|[[Job Cost System|JC]]
|[[Keystone Ticket Printing System|Ticketing]]
|[[Keystone Dispatch System |Dispatch]]
|[[Keystone Document Imaging |Doc Img]]
|[[Keystone On Demand | On Demand (mobile)]]
|}

== Keystone Quick Links ==

===Common System Topics===
:[[Keystone REST Server (KServer)]]
:[[Keystone Cloud Tunnel (Cloudflare)]]
:[[Keystone Company Database Backup Utility]]
:[[QueryGen]]
:[[Keystone Security]]
:[[Keystone Constants]] Decodes tables lookup values e.g. payroll run types, cash man. trans types. (Updated 01/06/23)
:[[Keystone Installation and Configuration]]
:[[Command Import]]

===Common Software Topics===
:[[Export Tickets to Accounting]] (Including EXF)
:[http://keystonehelp.compucrete.com Customer Help Website]
:[[A/R and Billing: Training Outline]]
:[[DeReconcile Inventory]] Undo 1 or more Inv. Recon sessions. (7/24/13)
:[[Payroll: Federal & State Electronic Filing Guides]]

===External/Third Party Devices===
:[[Device Server and Device Aggregator]]
:[[Device Aggregator/Device Server Issues]]
:[[Batch Control Devices]]
:[[GPS/Status Devices]]
:[[Notification Devices]]
:[[HaulHub (Tickets to State DOT)]]

===Interbase Database===
:[[InterBase]]
:[[Interbase System Table Queries ( RDB$ )]]
:[[Database Tips]] (Restore Empty DB)
:[[InterBase Issues]] 
:[[InterBase#Installation_on_64-bit_Windows_10_Creators_Update_.28Build_1703.29_and_higher | Interbase Install Fix for Windows 10 Creators]] (07/17/17)
:[[Database Corruption]] Using '''GHIBDataPump'''
:[[Configure InterBase ODBC Access]]
:[[Do This after updating number of licensed InterBase users]]

===Windows===
:[[Windows 7 and Keystone]]
:[[Keystone 2.5 Changes]] '''with new directory chart'''

===Keystone Software Info===
====Accounting====
:[[General Ledger: Financial Statements with Bigger Print]]
:[[DeReconcile Inventory]] Undo 1 or more Inv. Recon sessions. (7/24/13)
:[[Sales Tax Handling in Keystone 2.3]] (Includes Sales Tax Collection) 10/15/09 10/13/17
:[[Updating the Base Product Code for 1.8 System]] - Methods for setting up Base Product Codes
:[[Time Calculation Queries]] - Demonstration query for time calculation 5/19/08
:[[Zone History Analysis]] - Analyze Zone Times for Dispatch - 5/15/08

====Forms====
:[[Keystone Forms]]
:[[Sample Forms]]
:[[Keystone Form Colors]] The Color De-Coder Ring. (Yes we support the colors blanched almond and lemon chiffon!)
:[[Payroll: Form Versions]] Now supports '''*SUM''' to total all defs in a check group. (07/07/17)

:[[Invoice Form Fields]] (also includes sample adding ticket image to form)
:[[Ticket Form Fields]]
:[[Quote Form Fields]] 10/10/19
:[[Plant Cash Receipt Form Fields]] 03/07/18
:[[PO Form Fields]] 03/07/2018

:[[AP Check Form Fields]] 12/14/2022

====Config====
:[[Company Database Connection Pooling]]
:[[iSolved Keystone Integration]]
:[[Keystone Constants]] Decodes tables lookup values e.g. payroll run types, cash man. trans types.
:[[Keystone Experimental Features]]
:[[Keystone Security]] (Wiki Page)
:[[Keystone Telemetry]]

===Documents===
:[[Media:Web Update.pdf]]
:[[Keystone Accounting Installer Guidelines]]

===Development Etc===
:[[Online Users Conference 2011]] - 3/2/2011
:[[Keystone 3.x Development]]
:[[Development Topics]]
:[[Development How To]]
:[[Keystone 5.x Developer Information]]

==Batch Controls Importing==
:[[Batch Control Ticket Interfaces]]
:[[Batch Ticket Import]]

==GPS==
*[[GPS System Setup]] Modern GPS System Notes
*[[GPS System Diagnostics]] Diagnostic information for GPS systems

== Keystone Tools ==
:[[Query Export]]
::[[Most Excellent Queries]]
:[[Keystone Email Setup]]
:[[Datascope System | DataScope]]
::[[DataScope Examples]] * [[DataScope G/L Finanacial Statements]]

== Tools for Supporting Keystone ==
:[[QueryGen]]
:[[Importing Accounting Data]]
:[[Communications Tools]]
:[[Keystone Support Backup]] Company Database Backup utility for support

== Troubleshooting ==
:[[Application Server Diagnostics]]
:[[Install/Update Issues]] 
:[[Backup/Restore Issues]] 
:[[Keystone System Cache]] 
:[[Error Messages and Meanings]] 
:[[Restoring the Empty Database Template]] 
:[[Disk Space Issues]] 
:[[PC/Network Support]] 
:[[Remote Desktop Tips]]
:[[Performance Issues]]

= General Info =
:[[Windows Utilities]]
:[http://technet.microsoft.com/en-us/windows/jj728757 Windows Shortcut Keys (TechNet)]

Support Alerts

2026-08-08T13:56:24Z

Pmorey:

==Stop Windows Updates during Keystone Update - 8/8/2026==

PROBLEM: When performing a Keystone update that contains long-running database updates, Windows may decide to install updates and reboot the PC.

EXPLANATION: Windows can install updates at any time and may decide to reboot the PC if necessary to complete the updates if it thinks the PC is "idle." When a Keystone update is in progress and upgrading the company database, since there is no user interaction (keyboard/mouse) Windows may mistakenly believe that the PC is idle and that it is OK to reboot.

SOLUTION: Temporarily "pause" the Windows update service.

# Start a Command Prompt as Administrator.
# Type: net stop wuauserv
# When the Keystone update is complete, type: net start wuauserv

==Keystone Relay Server fails to start - 10/19/2025==

PROBLEM: Even though the Keystone Relay Server service is installed, it does not start when Windows is booted.

EXPLANATION: At JDM it was observed that the service took longer than 30 seconds to start running. (This is likely due to some network protection service.) The default timeout for Windows to start a service is 30 seconds, after which time Windows will abort the service.

SOLUTION: Increase the Windows service start timeout to 60 seconds.

# Start PowerShell using Run As Administrator.
# Type: Set-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control" -Name ServicesPipeTimeout -Value 60000 -Type DWord
# Reboot the server

==Dispatch Schedule order shows the wrong Qty Delivered - 12/5/2024==

PROBLEM: An order with a pre-ticketed load shows the wrong Qty Delivered total.

EXPLANATION: There is some as yet unknown issue where the pre-ticketed load never gets "released" when the truck comes back to the plant on it's previous load. (The DEPART_DT for the pre-ticketed load is NULL.) 
A potential cause is running Beginning of Day between the time the pre-ticketed load is generated and the time the truck returns to the plant from it's previous load.

SOLUTION: The bug has not yet been identified.

Here is a query that can be used to set the DEPART_DT in the pre-ticketed load. This query should be run AFTER the load appears in Loaded status or beyond.

<pre>
UPDATE DITPRJLD PJ
SET PJ.DEPART_DT =
(SELECT PH.BATCH_START_DT FROM ARTPTKHD PH
WHERE (PH.ORDER_SESSION_NO = PJ.ORDER_SESSION_NO) AND
(PH.ORDER_TRANS_NO = PJ.ORDER_TRANS_NO) AND
(PH.ORDER_LOAD_NO = PJ.LOAD_NO))
WHERE
(PJ.DEPART_DT IS NULL) AND
(PJ.STATUS_COL IS NOT NULL) AND
(PJ.STATUS_COL <> 14) AND
(PJ.STATUS_DATETIME BETWEEN :beg_date AND :end_date)
</pre>

==Tickets may be associated with the wrong invoice using Print Invoices in Keystone 4.7 and 4.7.1 - 10/10/2024==

PROBLEM: When printing invoices, tickets may be associated with the wrong invoice or the invoice may not have a debit amount.

EXPLANATION: A bug exists in the ARP_GENINV procedure where the initial query on Z$ARTGENINVSORT is missing an ORDER BY clause. This can cause tickets to be processed out of the sequence in which the records were originally written to the Z$ARTGENINVSORT table, which can cause the two problems listed above.

SOLUTION: This bug is fixed in Keystone 4.7.1.7.

It appears that the invoices that were generated incorrectly can be voided and then re-billed. However, it is important to re-run the identification query below to make sure that the re-billing worked correctly (until the customer is updated to Keystone 4.7.1.7 or higher.)

Here is the query which can identify the invoices with "mis-matched" tickets or invoices that were never fully updated:

<pre>
select distinct iv.session_no, iv.trans_no, iv.cust_no, iv.job_po_loc, iv.invoice_date, iv.invoice_no
from artinv iv
inner join artslshd sh on (sh.ar_session_no = iv.session_no) and (sh.ar_trans_no = iv.trans_no) and
((sh.cust_no <> iv.cust_no) or (coalesce(sh.job_po_loc, '') <> coalesce(iv.job_po_loc, '')))
where (iv.invoice_date >= :start_date) and (iv.void_flag = 'N') and (iv.ticket_invoice = 'N')
union
select iv.session_no, iv.trans_no, iv.cust_no, iv.job_po_loc, iv.invoice_date, iv.invoice_no
from artinv iv
where (iv.invoice_date >= :start_date) and (iv.void_flag = 'N') and (iv.ticket_invoice = 'N') and
(debit_amount = 0) and
(credit_amount = 0) and
(due_date is null) and
(ums_1 is null) and
(job_po_loc is null) and
(plant_no is null)
</pre>

==Batch weights cannot be seen in A/R Ticket Maintenance or A/R Ticket History Inquiry - 7/9/2020==

PROBLEM: Plant tickets with batch weights seem to lose the batch weights once they are imported to the office.

EXPLANATION: A new field (BW_RECKEY) was added to the ticket header tables in Keystone 3.6.11.1. This field links tickets and batch weights together. The A/R Ticket Maintenance, A/R Ticket History Inquiry and Dispatch Batch Weights Report options all use this field to lookup the batch weights.

Due to a bug the "commit" logic in A/R Import Tickets does not copy this new field from the temporary table (Z$ARTPTKHD) to the office table (ARTTCKHD) when the user completes the import ticket process. (Note that the batch weights exist in the batch weights tables, it is just this new link field that doesn't get copied.)

SOLUTION: This bug is fixed in Keystone 3.6.14.5.

Here are three queries that can be run to re-link tickets with their associated batch weights:

Plant Tickets
<pre>
UPDATE ARTPTKHD TH SET TH.BW_RECKEY =
(SELECT MAX(BH.RECKEY)
FROM DITBWHD BH
WHERE (BH.PLANT_NO = TH.PLANT_NO) AND (BH.TICKET_NO = TH.TICKET_NO) AND (CAST(BH.LOAD_DT AS DATE) BETWEEN TH.TICKET_DATE AND TH.TICKET_DATE+7))
WHERE (TH.VOID_FLAG = 'N') AND (TH.BW_RECKEY IS NULL) AND EXISTS
(SELECT 1
FROM DITBWHD BH
WHERE (BH.PLANT_NO = TH.PLANT_NO) AND (BH.TICKET_NO = TH.TICKET_NO) AND (CAST(BH.LOAD_DT AS DATE) BETWEEN TH.TICKET_DATE AND TH.TICKET_DATE+7));
</pre>

Office Tickets
<pre>
UPDATE ARTTCKHD TH SET TH.BW_RECKEY =
(SELECT MAX(BH.RECKEY)
FROM DITBWHD BH
WHERE (BH.PLANT_NO = TH.PLANT_NO) AND (BH.TICKET_NO = TH.TICKET_NO) AND (CAST(BH.LOAD_DT AS DATE) BETWEEN TH.TICKET_DATE AND TH.TICKET_DATE+7))
WHERE (TH.VOID_FLAG = 'N') AND (TH.BW_RECKEY IS NULL) AND EXISTS
(SELECT 1
FROM DITBWHD BH
WHERE (BH.PLANT_NO = TH.PLANT_NO) AND (BH.TICKET_NO = TH.TICKET_NO) AND (CAST(BH.LOAD_DT AS DATE) BETWEEN TH.TICKET_DATE AND TH.TICKET_DATE+7));
</pre>

Invoiced Tickets (this may take a while)
<pre>
UPDATE ARTSLSHD TH SET TH.BW_RECKEY =
(SELECT MAX(BH.RECKEY)
FROM DITBWHD BH
WHERE (BH.PLANT_NO = TH.PLANT_NO) AND (BH.TICKET_NO = TH.TICKET_NO) AND (CAST(BH.LOAD_DT AS DATE) BETWEEN TH.TICKET_DATE AND TH.TICKET_DATE+7))
WHERE (TH.VOID_FLAG = 'N') AND (TH.BW_RECKEY IS NULL) AND EXISTS
(SELECT 1
FROM DITBWHD BH
WHERE (BH.PLANT_NO = TH.PLANT_NO) AND (BH.TICKET_NO = TH.TICKET_NO) AND (CAST(BH.LOAD_DT AS DATE) BETWEEN TH.TICKET_DATE AND TH.TICKET_DATE+7));
</pre>

==Keystone sends the same ticket to a batch control more than once - 11/7/2018==

PROBLEM: Keystone sends the same ticket to a batch control more than once because the Device Aggregator takes too long to respond to the "send ticket" command from the client program.

EXPLANATION: When Keystone Dispatch/Ticketing sends a ticket to the batch control (more correctly, to the Device Aggregator) it expects a response to the “send ticket” command within one (1) second. If it does not get a response in this timeframe, it will pause for 250 milliseconds and then re-send the ticket to the Device Aggregator. It will do this up to three times before giving up.

Normally this should never be an issue. The Device Aggregator is always running on a server on the local network, and it should never take more than one second to respond to the Keystone client programs.

However a situation was discovered at Vitale that caused the Device Aggregator to be “tied up” for about 4 seconds. During this time if a ticket was received the Keystone client program would timeout and re-send it.

Vitale has three Keystone companies. After the last Keystone update (which required a database upgrade) only one of their companies was upgraded, the other two were not (because no one had logged into them.) One of those two companies was “Practice” which is ignored by the aggregator. The second of the two companies was “Mix Import Testing” which was used for their install but which the customer does not login to. This company was *not* flagged as a Practice company. Therefore the aggregator was trying to process any devices in this company, but could not because the company database had not yet been upgraded. This actually causes an error within the aggregator which will force the aggregator to retry loading all the devices from all the companies again one minute later. Each time the aggregator reloads the devices it takes about 4 seconds to complete. During this time “send ticket” commands from Keystone clients cannot be processed. This is what led to the aggregator taking too long to respond to the client.

SOLUTION: After a Keystone update, be sure to login to ALL the companies (even the “Practice” ones!)

The next release build of Keystone (3.4.7) will handle this issue by increasing the client timeout value from one second to ten seconds. The aggregator will also respond immediately to the “send ticket” command instead of waiting until after it was able to send the command out to the device server (where the delay was happening.)

==When changing the number of licensed InterBase users, you must edit CCWIBSV.INI - 10/2/2018==

PROBLEM: When the number of licensed InterBase users is increased/decreased, Keystone 3.x does not recognize the change.

EXPLANATION: Keystone 3.x performs a calculation ONCE to determine the number of licensed InterBase users. It stores the result of this calculation in CCWIBSV.INI.

SOLUTION: Perform this procedure AFTER changing the number of licensed InterBase users:

# Start Notepad, making sure to select “Run As Administrator.”
# Open the ccwibsv.ini file in the folder “C:\Program Files (x86)\GivenHansco\Keystone\Settings.”
# Delete the entire line that begins with “MaxConnections=” as shown below: [[File: IBUsersINIChange.png]]
# Save the file.
# Reboot the server.

==Exception EOleException violation of FOREIGN KEY constraint "Z$ARTINV_FKY_CUST_NO" on table "Z$ARTINV" when running Print Invoices - 1/17/2018==

PROBLEM: When running Print Invoices, you get the following error:

[[File:PrintInvoicesException.PNG|400px]]

EXPLANATION: There is a field in the customer table called STMT_CUST_NO (Statement Customer). There is no integrity on this field -- the user can type whatever they want in it. At Invoicing time, the system checks to see if the STMT_CUST_NO exists, and issues the error above if it does not.

SOLUTION: Use Customer Maintenance to fix the Statement Customer field so that it contains either nothing or a valid customer number.

==A/P and Payroll ACH Export no longer export valid files in Keystone 3.0 thru 3.1 - 1/16/2017==

This issue has been fixed as of Keystone 3.1.1.

NOTE: Not all ACH export files require a security record. If the first column of the first line of the ACH file is a '1', there is no security record and the export file should be accepted.

PROBLEM: When generating an ACH export file in A/P or Payroll in Keystone 3.0 thru 3.1, the ACH file is rejected by the bank.

EXPLANATION: Keystone 3.x is developed on a newer version of Delphi that uses Unicode strings. Each character in a Unicode string is 2 bytes instead of 1. The "security record" at the beginning of the ACH file needs to be output as the older Ansi string style (1 byte per character.) In Keystone 3.0 thru 3.1, this string is output as a Unicode string (2 bytes per character.)

Here is an example of what the security record should look like in the export file:

<pre>$$ADD ID=WARUSXXX BID='NWFACHXXXXXXXX'</pre>

Here is an example of what the security record looks like when exported with Keystone 3.0 thru 3.1:

<pre>$ $ A D D I D = W A R U S X X X B </pre>

WORKAROUND:
* Start IBCONSOLE.
* Go into the company database and open the 'CMTACCT' table.
* Locate the correct ACH bank account and scroll to the 'DD_SECURITY_REC' field.
* The field will display as '(MEMO)'. Double-click the field to open the memo editor.
* Select the *entire* field and copy it to the clipboard using CTRL+C.
* Open the ACH export file in Notepad.
* Select the *entire* first line and press CTRL+V. This will replace the incorrect header with the correct one.
* Save the ACH export file and resubmit.

SOLUTION: Upgrade to Keystone 3.1.1.

==Updating to Keystone 3.x gives message that your Windows version is not supported - 12/17/2016==

PROBLEM: When starting a Workstation after the Server has been updated to Keystone 3.x, the workstation attempts to install the update but issues an error saying that your Windows version is not supported.

EXPLANATION: The Keystone desktop shortcut has been configured for compatibility with Windows XP SP2 (see image below.) This "tricks" the update installer into thinking it is running on Windows XP instead of the actual version of Windows, and refuses to run since Keystone 3.x requires Windows Vista or higher.

[[File:KeystoneShortcutWindowsCompatibility.PNG|400px]]

SOLUTION: Open the desktop shortcut properties, go to the "Compatibility" tab, and un-check the box that says "Run this program in compatibility mode." Restart Keystone and the update will install normally.

==Backup/Restore when upgrading InterBase versions - 11/5/2016==

When upgrading InterBase from one major version to another (for example, IB 7/2007/2009 -> IB XE7) you must backup and restore the Keystone databases (*.IB) as part of the process. You must backup prior to upgrading InterBase, then restore after the upgrade.

There was a time when you could just upgrade InterBase and use the same *.IB file without doing this, but it was never recommended. Now it seems that bad things can happen (such as indexes getting corrupted which results in very slow Keystone performance.)

The company database(s) can be easily done from the Keystone menu using the backup/restore options on the System Maintenance menu.

The document imaging (CCWDOC.IB) and system databases (CCWSYS.IB) must be done manually as outlined at the wiki page below (NOTE: you can skip the company databases when you follow the wiki procedure and instead use the normal Keystone backup/restore options for them.)

[[Interbase_XE_Update|InterBase XE Update]]

==Device Aggregator and Multiple Companies (including Practice) - 8/1/2006==

This issue has been fixed as of Keystone 3.0 -- duplicate devices will be ignored by the Device Aggregator.

A very bizarre issue occurred at Environmental. For some unknown reason, status messages from GPS would suddenly cease to be processed by Keystone Dispatch.

After digging through the logs, Craig and I discussed the issue and discovered this when looking at the Devices setup on their system:

[[File:DevAggMultCos1.png|640px]]

Environmental has their main company as 001 and their Practice company as 002. Looking into the company database configuration table in the Keystone system database, we see that BOTH companies are setup as “Normal” companies:

[[File:800px-DevAggMultCos2.png|800px]]

The Device Aggregator by default will ignore Practice company types, which would have prevented this situation, had their company 002 been properly configured as a PRACTICE company.

Installers should add this to their checklist: ALWAYS configure practice companies as “PRACTICE” company type when adding!

==Keystone 2.9.17 and Keystone Mobile (On-Demand) Server - 6/22/2016==

Due to a combination of circumstances customers who use Keystone On-Demand and are not yet on Keystone 3.x will need to update to Keystone 3.x in order for Keystone On-Demand to work correctly.

Customers who are still on 2.x but have not updated to 2.9.17 should continue to work normally. Once they update to 2.9.17, Keystone On-Demand will not function properly.

My suggestion at this point would be to get any remaining customers who are using Keystone On-Demand but are not yet on 3.0 updated as soon as possible.

==Keystone Updates and "Run As Administrator" - 2/26/2016==

While getting Silvi updated today, Jeff mentioned that GH support had told him that if a Keystone update failed to install that he should right-click the Keystone icon and select “Run As Administrator.”

First point: You should NEVER have to do this. The update is designed with Windows security in mind, and automatically starts itself with the necessary permissions.

Second point: When installing a Keystone update, if you double-click the Keystone icon and the update fails to install, this is an indication of a Windows security configuration issue. If you right-click and select “Run as Administrator” to get the update installed, it will likely lead to problems down the road when users try to run Keystone.

The bottom line is – if there is a problem with a Keystone update install, do not do the “Run as Administrator” shortcut, but work on getting the core Windows configuration issues resolved. In Silvi’s case, once we realized what was going on, it took their IT guy about 10 minutes to straighten this out.

[[#Updating to Keystone 3.x gives message that your Windows version is not supported - 12/17/2016|See also this item for another potential issue with Keystone Updates.]]

==Keystone 2.9.7 - Exception when starting Plant Maintenance - 2/19/2016==

This issue was fixed in Keystone 2.9.8.

PROBLEM:

When opening Plant Maintenance in 2.9.7, you may receive this error:

:EDBException: cdsLookup3: Field ‘BILLING_PLANT_NO’ not found

ANALYSIS:

Note that it is difficult to re-create this in-house, because it requires that someone have started up one of the Dispatch/Ticketing options that also opens the plant lookup. The issue occurs because the office plant lookup query was changed to include the new BILLING_PLANT_NO field, but the Dispatch/Ticketing plant lookup queries were not. All three of these lookup queries share the same “cache key.” So if the Dispatch/Ticketing lookup is cached first, it does NOT contain the new BILLING_PLANT_NO field. When office Plant Maintenance is started, it determines that the plant lookup query does not need to be refreshed and uses the cached version instead. Unfortunately, the cached version does NOT have the new BILLING_PLANT_NO field, leading to the error.

SOLUTION:

This will be fixed in the next build of Keystone. As a workaround, you can check the “Disable Cache Datasets” option in the Keystone Application Server configuration page. (Please keep track of these if you do this as we will want to re-enable cache datasets when the fix is implemented.)

==Trying to issue UPDATE/DELETE query in the XE7 version of IBConsole gets error - 2/11/2016==

A change was made by Embarcadero to the XE7 version of IBConsole. When executing queries within IBConsole, by default only SELECT queries are allowed. Attempting to issue an UPDATE or DELETE query gives the following error:

[[File:XE7IBConsoleUpdateError.png|400px]]

[[InterBase#Using UPDATE/DELETE queries in IBConsole XE7|Please see this topic for the solution.]]

==Keystone 2.9.2 Installer Issue with InterBase XE7 64-bit - 1/7/2016==

This issue was fixed in Keystone 2.9.3

A problem has been discovered in the Keystone 2.9.2 installer. The situation that occurs is this (assuming a new install on a clean machine):

#InterBase XE7 64-bit installed
#Keystone 2.9.2 installed
#After Keystone license screen, an error message appears indicating that the “ISQL.EXE” command could not be executed.

The cause of this is that both InterBase XE7 and Keystone 2.9.2 rely on a shared Windows DLL (MSVCR120.DLL.) There are two versions of this file installed by InterBase XE7 64-bit: the 32-bit version installs into C:\WINDOWS\SYSWOW64 and the 64-bit version installs into C:\WINDOWS\SYSTEM32. After Keystone 2.9.2 is installed, the 32-bit version of MSVCR120.DLL remains but the 64-bit version of MSVCR120.DLL no longer exists. This causes the InterBase “ISQL.EXE” command to fail.

To prevent more customers from experiencing this issue I have pulled the Keystone 2.9.2 update. I’ve got a fix in place and tested and am working on a Keystone 2.9.3 release build. Once this is ready I’ll send another email.

If you encounter this issue on an existing customer after they update to Keystone 2.9.2, please contact me and I will implement a fix. (NOTE: If an existing customer has this problem and installs Keystone 2.9.3 it will NOT fix the issue.)

==Double-click to edit items on-the-fly in Keystone - 8/13/2015==

As of Keystone 2.8.2 there is a new system option (in the System-Wide section) called “Edit On The Fly”.

This option defaults to True.

You can set it to False, which will not allow that user to double-click a lookup item (e.g. Product Code) to launch the file maintenance program associated with that item.

This will allow you to set this option to False for remote desktop users who get into trouble when they double-click a Product Code in Order Maintenance, but instead of double-clicking they triple or quad click.

==Keystone Company Database Backup Fails - 4/9/2015==

This issue was fixed in Keystone 2.6.7

An issue was discovered at Moritz Concrete that was causing backups of the company database within Keystone to fail with the following error:

[[File:KeystoneBackupFails.png|400px]]

Manually running the GBAK command from the command prompt worked fine.

When Keystone backs up the company database, it first uses the InterBase GBAK command to make a backup of the database to a temporary file. This temporary file is (normally) located in the following subfolder underneath the Windows temporary folder:

:<Windows Temp Folder>\GivenHansco\Keystone

Because the “GivenHansco\Keystone” folder doesn’t exist on a new install, Keystone will create this folder the first time the user attempts to backup.

Prior to Keystone 2.6.7, Keystone would “auto-create” this folder *once* for each Application Server run. (In other words, if you reboot the server, causing the Application Server to restart, it would “auto-create” this folder on the next attempt to backup.) As part of attempting to solve the problem at Moritz, Don deleted the files and sub-folders within the Windows temp folder. Since the Application Server was still running, it did not attempt to “auto-create” the necessary folder and this caused Keystone backup to fail.

As of Keystone 2.6.7, this folder will be “auto-created” as needed for every attempt to backup the database.

==Dispatch Schedule gets error "Multiple Rows for Singleton Select" at startup - 12/31/2013==

This issue was fixed in Keystone 2.7.2

For customers that upgraded to versions 2.7.0 or 2.7.1, they may get the following error when they attempt to start the Dispatch Schedule:

:“Multiple Rows for Singleton Select”

To fix this, run the following SQL commands using IBConsole:

<pre>
SET TERM ^ ;

CREATE PROCEDURE IBCO1249_FIX_VOIDLOADS
AS
DECLARE VARIABLE ORDER_SESSION_NO INTEGER;
DECLARE VARIABLE ORDER_TRANS_NO INTEGER;
DECLARE VARIABLE ORDER_LOAD_NO INTEGER;
DECLARE VARIABLE TEMP_CNT INTEGER;
BEGIN
FOR SELECT ORDER_SESSION_NO, ORDER_TRANS_NO, ORDER_LOAD_NO, COUNT(*)
FROM ARTPTKHD
WHERE (ORDER_LOAD_NO IS NOT NULL)
GROUP BY ORDER_SESSION_NO, ORDER_TRANS_NO, ORDER_LOAD_NO
HAVING (COUNT(*) > 1)
INTO :ORDER_SESSION_NO, :ORDER_TRANS_NO, :ORDER_LOAD_NO, :TEMP_CNT
DO
UPDATE ARTPTKHD
SET ORDER_LOAD_NO = NULL
WHERE (ORDER_SESSION_NO = :ORDER_SESSION_NO) AND
(ORDER_TRANS_NO = :ORDER_TRANS_NO) AND
(ORDER_LOAD_NO = :ORDER_LOAD_NO) AND
((VOID_FLAG = 'Y') OR (VOID_SESSION_NO IS NOT NULL));
END
^
</pre>

<pre>
EXECUTE PROCEDURE IBCO1249_FIX_VOIDLOADS;
</pre>
(be sure to COMMIT after this command)

<pre>
DROP PROCEDURE IBCO1249_FIX_VOIDLOADS;
</pre>

==Print Invoices generates duplicate numbers when printing from the preview screen - 5/2/2013==

This issue was fixed in Keystone 2.6.1

We have discovered a problem with Print Invoices (affects all reports but Print Invoices is the worst) when the user prints from the preview screen.

If the user clicks the PRINT button while previewing invoices by using the F12 key, and then immediately hits the F12 key again, this will cause two runs of Print Invoices. Unfortunately only some of the temporary information is cleared between the runs, which causes duplicate invoice numbers and missing tax & g/l transactions.

For now, users should NOT use F12 on the preview screen while previewing invoices. We are working on a fix for Keystone.

==Extra products with strange descriptions appearing in Product Code drop-down list in Ticket Maintenance, Ticket Printing and Order Maintenance - 2/14/2013==

This issue was fixed in Keystone 2.5.24

This was discovered at Twin Cities after updating to Keystone 2.5.23.

There is a bug in the new database procedure that returns the list of products for the Product Code drop-down list. However, as a workaround you can do the following query on the customer’s system and it will fix the drop-down list:

<pre>
UPDATE ARTPROD
SET LINK_PRICE_PRODUCT = null
WHERE (LINK_PRICE_PRODUCT = '');
</pre>

==Dispatch Schedule gives never-ending Access Violation errors at startup - 12/17/2009==

PROBLEM: When starting the Dispatch Schedule, you get a never-ending series of Access Violation error boxes. Also, Dispatch Order Maintenance does not start at all.

EXPLANATION: There are old versions of some Keystone libraries (*.BPL) in the Keystone BIN directory. Files with the '.BPL' extension should exist only in the LIB directory.

SOLUTION: Check the BIN directory under the Keystone root directory for the presence of any files with a '.BPL' extension. If any are found, delete them.

==Sales Tax Calculation Problems Converting to Keystone 2.2==

New Diagnostic Query: [[Keystone 2.2 Sales Tax Conversion Diagnostics]]

==Performance problem when closing out of menu options as of 2.2.4 - 12/10/2008==

Keystone 2.2.4 introduced a performance problem when closing out of menu options. Due to a faulty database trigger, customers with large amounts of historical data would notice that the EXE continued to run for up to 20 seconds after the program was closed. When chaining from one program to another (i.e., editing a vendor from A/P inquiry) the calling program would have to wait for this delay before user input would be accepted.

This performance problem has been fixed as of 2.2.15. It is highly recommended that all 2.2.x customers upgrade to this version as soon as possible.

==Old Device Server (ccdevsv.exe) removed as of 2.2.4 - 10/14/2008==

As of Keystone 2.2.4, the old device server (ccdevsv.exe) has been removed from the installer.

Any customers using the old device server with Keystone 2.2.x should be moved to the new device server/aggregator as soon as possible.

Going forward, there is no guarantee that the old device server will continue to work with Keystone.

==Never copy IB database files between systems! - 10/10/2008==

It is very important when moving Keystone database files between systems that you backup the database on the source system and restore it on the target system.

NEVER COPY .IB FILES BETWEEN SYSTEMS! If the source system is running IB 2007 and the target is running IB 7, the copied .IB file will not work!

==Dispatch - Lose trucks for active orders when End of Day is run on live tickets - 04/30/2008==

PROBLEM: Dispatch End of Day causes trucks to disappear from Schedule Screen.

EXPLANATION: End of Day removes tickets from ARTPTKHD. Data in the ARTPTKHD/DT is required for the loads to show correctly on the schedule screen. All loads for associated with missing tickets disappear. If a truck is in the returning status, it will still show on available truck. Any truck on a load that wasn't returning will disappear.

THE FIX:

View todays tickets that have been imported:
<PRE>
select ticket_no,order_code,order_load_no,truck_no,return_plant_dt from arttckhd t
where ticket_date='4/30'
</PRE>
View the associated loads
<PRE>
select l.* from ditprjld l
where
exists (
select order_session_no,order_trans_no,ticket_no,order_code,order_load_no,truck_no,leave_job_dt from arttckhd t
where ticket_date='4/30'
and t.order_session_no=l.order_session_no and t.order_trans_no=l.order_trans_no and l.load_no=t.order_load_no)
</PRE>

Review Today's loads with no associated plant ticket (revised way to view - 11/10/08)
<PRE>
select l.* from ditprjld l
where tgt_depart_dt>cast('today' as date) and
not exists (
select order_session_no,order_trans_no,ticket_no,order_code,order_load_no,truck_no,leave_job_dt from artptkhd t
where ticket_date=cast('today' as date)
and t.order_session_no=l.order_session_no and t.order_trans_no=l.order_trans_no and l.load_no=t.order_load_no)
AND DEPART_DT IS NOT NULL
</PRE>

Fix any loads that are not Status 8
<PRE>
update ditprjld l
set return_dt=tgt_return_dt,status_col=8
where status_col<>8 and l.return_dt is null and
exists (
select order_session_no,order_trans_no,ticket_no,order_code,order_load_no,truck_no,leave_job_dt from arttckhd t
where ticket_date='4/30'
and t.order_session_no=l.order_session_no and t.order_trans_no=l.order_trans_no and l.load_no=t.order_load_no)
</PRE>

SOLUTION: An upcoming version of keystone will fix this problem.

==A/R Void Invoices - Foreign key violation when using Automatic Reconcile option - 01/10/2008==

PROBLEM: Foreign key violation exception when selecting the Automatic Reconciliation option.

EXPLANATION: The user running the A/R Void Invoice program has never run Print Invoices. The Void Invoice program looks at the A/R G/L account system option that is saved by Print Invoices to determine the A/R G/L account to use for the automatic reconciliation.

WORKAROUND: Login as the user who wants to void the invoice, and run Print Invoices in Preview mode. This will save the appropriate system option.

SOLUTION: Version 2.1 will include a fix which will get the A/R G/L account from the invoice that is being voided.

==HIT User only for GivenHansco Staff - 01/04/2008==

Never give customers the HIT user name and password. The HIT user has special function and security settings, including the bypassing of automatic backups when upgrading database versions.

==Remote Ticketing Systems - Do Not Install by Backup up Office Data - 11/07/2007==

PROBLEM: Remote Ticketing Systems created with an office backup expose the customers system to security risk. Sensitive data can end up at remote locations.

SOLUTION: Follow standard procedure for creating Remote Ticketing Systems. This starts with a clean database. We need to identify all remote systems that may have office data and provide an cleaning script.

==Where are my Trucks?!?!?! - 10/16/2007==

PROBLEM: Truck Disapears while dispatching.

EXPLANATION: The most common cause of this is caused when:
a truck in returning status is assigned to a pre-ticket then
the pre-ticket load is voided then
the Return Truck to Previous order option is selected.

This combinition of events leaves pointers in ARTTRUCK pointing to a voided record, and leaves the load record in a quasi-delivered state.

SOLUTION: Development is redesigning the truck pointer logic to fix this. In the mean time, when possible these problems can be passed to development for further diagnosis.

NOTE: Manipulating Dispatch Data can have severe consequences. The following update will only help specific situations. It is presented here for only emergency cases.

'''The Fix Process:'''
Note: Make sure this is the correct fix for the situation. If the load actually shipped you should try to fix it up. If the load hasn't shipped you can clear it as below.

Examine the truck record...
<PRE>select * from arttruck where truck_no='XXX'</PRE>
Record the Current Order and Load and Last Ticket Information.

Reset the Truck pointers:
<PRE>UPDATE ARTTRUCK
SET LAST_TICKET_SESSION_NO=NULL, LAST_TICKET_TRANS_NO=NULL,CUR_ORDER_SESSION_NO=NULL,CUR_ORDER_TRANS_NO=NULL,CUR_ORDER_LOAD_NO=NULL
WHERE TRUCK_NO='91'</PRE>

Examine the load. If the load is partially completed reset it:
<PRE>UPDATE DITPRJLD
SET STATUS_COL=NULL,STATUS_DATETIME=NULL,TRUCK_NO=NULL,DEPART_DT=NULL,RETURN_DT=NULL
WHERE ORDER_SESSION_NO=94019 AND ORDER_TRANS_NO=7 AND LOAD_NO=1</PRE>

<PRE>select * from gptstatus where truck_no='91' order by seq_no desc</PRE>

==Product Cost Rollup Doesn't seem to be working - 10/12/2007==

PROBLEM: Customer will run product cost rollup, but many of the costs will not be accurately calculated.

EXPLANATION:

Product cost rollup gets the cost from a Cost transaction in the table artprtrx. For several versions of CompuCrete 1.6.x there was a bug where cost changes where not triggering the cost record to be written to Artprtrx. The result is that cost changes were not updated for existing products, and never written at all for older products.

As far as we know, there is no actual bug in Product Cost Rollup. If one is found please advise support. The problem that we see is that even though the product maintenance bug has been fixed for a long time, there will be some lingering products with incorrect or missing costs.

SOLUTION:
Read through [[Identify and Fix Products With No Standard Cost Records]] and check for both missing and out of date costs. If only a few products are problems, you can fix them by changing the cost to a lower cost, then resetting to the current cost. If several products are wrong, then you will need to run the fix query.

==Restore Database leads to Stream Error - 09/13/2007==

PROBLEM: When attempting to restore a company database backup, an error indicating "Stream Read Error" occurs.

EXPLANATION:

The database restore code prior to version 2.0.16 would not properly handle a database size > 2GB. The database would backup correctly, but when attempting to restore will incorrectly state the size of the original database, causing the error.

SOLUTION: Upgrade to Keystone 2.0.16 or later.

==System Lockup after Logging off Server - 05/01/2007==

PROBLEM: After logging off the server while KEYSTONE users are active, the following may occur:

1. Users can no longer log in. The splash screen appears and then hangs.

2. Users who were logged in cannot start additional menu options. The selected option never starts.

3. Users who were logged in cannot log out of KEYSTONE. The message saying that KEYSTONE is ending hangs.

EXPLANATION:

The KEYSTONE Application Server is a DCOM server application. When the server is logged off, the Application Server is sent a message notifying it that the server is logging off. Shortly thereafter, a termination code is sent to the application, which is only partially processed. The Application Server continues to run and service any existing connections, but no new connections are accepted.

PREVENTION:

Once a user logs in to the server, they should never log out. The alternative is to use the "Lock Computer" function in Windows for security.

SOLUTION:

The only solution is to tell the currently logged in users to get out of KEYSTONE as much as possible. Then:

1. On the server where the KEYSTONE Application Server is running, issue the DOS command: <PRE>TELNET 127.0.0.1 6600</PRE>

2. You will see a message from the Application Server. Type: <PRE>KILLSERVER</PRE>

3. You will see a warning message asking you to terminate the Application Server. Type: <PRE>Y</PRE>

4. Now you need to check the Windows Task Manager and verify that the "ccasib6.exe" process is not running. If it is still running, repeat from step 1 until you have verified that the Application Server has terminated.

5. Stop and Restart the Borland Socket Server service through Control Panel->Administrative Tools->Services.

==Classic Conversions - 12/1/2006==

Since the 1.8 classic conversion program has not been (nor will be) updated, the procedure going forward when upgrading a Compucrete classic customer will be to upgrade them from classic to 1.6, then web update to 1.8.

==Web Update Problem - 11/30/2006==

In builds 1.8.14 and 1.8.15, there is a problem with Web Update.

Some symptoms are:

1. The customer previously updated to 1.8.14, they successfully download 1.8.15, release it, restart CC, but it never installs.

2. On multi-user systems, the clients may see "Application Server is older than client" or "Application Server is newer than client" depending on the order they installed the update.

The correct solution is:

1. Open IBConsole

2. Open the CCWSYS.IB database

3. Open the CCTUPD table

4. Verify/change the UPDATE_VERSION field to the correct value

5. Verify/change the PENDING_FLAG field is set to "Y"

6. Commit the change

==CompuCrete 1.8 Upgrades - 11/26/2006==

As a precautionary measure, the following procedure should be done immediately prior to releasing the 1.8 upgrade.

For each company database:

1. Login to the company.

2. Backup the company to hard disk. If any errors occur, STOP!!!

3. Restore the company from the hard disk backup just created.

Once this has been done for each company, release the 1.8 upgrade and login to each company, verifying that the company database upgrade completes without error.

==Interbase fails to accept network connections - 11/3/2006==

PROBLEM: There is a potential issue with Interbase 7.1 refusing to accept incoming network connections.

SYMPTOMS: When the user starts CompuCrete, they see the Activation dialog.

A message in the interbase.log file says:

:Unable to complete network request to host "(servername)".
:Error while listening for an incoming connection.
:An attempt was made to access a socket in a way forbidden by its access permissions.

SOLUTION:

This problem appears to be prevalent in Windows Server 2003. You need to modify the following registry key:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

Look for a key named "ReservedPorts". If you don't see one, create a new multi-string value and give it this name.

Right-click and select Modify.

Add the following line to the end of the list (if there are existing entries):
:3050-3050

Close the registry editor and reboot the server.

==System Tables - 11/30/2005==

It is VERY important that the CCTLIC and CCTUSER tables in the CompuCrete system database NEVER EVER be edited using IBConsole!

These tables contain encoded security fields that are (partially) based on the content of several other fields within the table. If any of those fields are edited with IBConsole, the encoded security fields are no longer valid, and the user will receive the 'User table corrupt' error when they try to log in.

If this happens, the only solution is to delete the affected user records out of CCTUSER and then use CompuCrete User Maintenance to add the users back in.

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T21:09:27Z

Pmorey: /* Creating a New Tunnel */

==Introduction==

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

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

==Preparation==

===Creating a New Tunnel===

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

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

===Recording the Tunnel Configuration===

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

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

==Installation & Configuration of Customer Server==

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

===Existing Customer Setup===
(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.)

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T21:08:50Z

Pmorey: /* Recording the Tunnel Configuration */

==Introduction==

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

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

==Preparation==

===Creating a New Tunnel===

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

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

===Recording the Tunnel Configuration===

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

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

==Installation & Configuration of Customer Server==

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

===Existing Customer Setup===
(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.)

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T21:05:50Z

Pmorey: /* Creating a New Tunnel */

==Introduction==

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

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

==Preparation==

===Creating a New Tunnel===

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

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

===Recording the Tunnel Configuration===

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

# Download the two configuration files from the "Output Dir" created in the previous step.
# Open a browser and login to Keeper.
# Locate the customer you are working on.
# Click on the "API Credentials" folder (create a new folder if this doesn't already exist.)
#:[[Image:Keeper_cloudflare_1.jpg]]
# 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]]
# 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]]

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

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T21:05:34Z

Pmorey: /* Recording the Tunnel Configuration */

==Introduction==

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

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

==Preparation==

===Creating a New Tunnel===

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

# Connect to the internal build testing server (you can teamviewer or RDP.)
# Open a Windows Command prompt.
# Type: CD \CCGH\CFTUNNEL
# Type: MAKECT ##### (where ##### is the Keystone serial number for the customer.)
# When complete, you will see something similar to this:
[[File: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.)
#:[[Image:Keeper_cloudflare_1.jpg]]
# 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]]
# 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]]

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

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T21:04:55Z

Pmorey: /* Recording the Tunnel Configuration */

==Introduction==

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

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

==Preparation==

===Creating a New Tunnel===

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

# Connect to the internal build testing server (you can teamviewer or RDP.)
# Open a Windows Command prompt.
# Type: CD \CCGH\CFTUNNEL
# Type: MAKECT ##### (where ##### is the Keystone serial number for the customer.)
# When complete, you will see something similar to this:
[[File: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.)
#:[[Image:Keeper_cloudflare_1.jpg]]
# 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:
#:[[File:Keeper_cloudflare_2.jpg]]
# 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:
#:[[File:Keeper_cloudflare_3.jpg]]

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

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T21:03:55Z

Pmorey: /* Recording the Tunnel Configuration */

==Introduction==

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

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

==Preparation==

===Creating a New Tunnel===

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

# Connect to the internal build testing server (you can teamviewer or RDP.)
# Open a Windows Command prompt.
# Type: CD \CCGH\CFTUNNEL
# Type: MAKECT ##### (where ##### is the Keystone serial number for the customer.)
# When complete, you will see something similar to this:
[[File: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]]
# 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:
#:[[File:Keeper_cloudflare_2.jpg]]
# 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:
#:[[File:Keeper_cloudflare_3.jpg]]

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

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T21:01:58Z

Pmorey: /* Recording the Tunnel Configuration */

==Introduction==

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

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

==Preparation==

===Creating a New Tunnel===

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

# Connect to the internal build testing server (you can teamviewer or RDP.)
# Open a Windows Command prompt.
# Type: CD \CCGH\CFTUNNEL
# Type: MAKECT ##### (where ##### is the Keystone serial number for the customer.)
# When complete, you will see something similar to this:
[[File: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]]
# 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:
[[File:Keeper_cloudflare_2.jpg]]
# 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:
[[File:Keeper_cloudflare_3.jpg]]

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

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T20:59:33Z

Pmorey: /* Introduction */

==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:
[[File: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===

# 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]]
# 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:
[[File:Keeper_cloudflare_2.jpg]]
# 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:
[[File:Keeper_cloudflare_3.jpg]]

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

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T20:59:15Z

Pmorey: /* Introduction */

==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 prepartion 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:
[[File: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===

# 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]]
# 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:
[[File:Keeper_cloudflare_2.jpg]]
# 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:
[[File:Keeper_cloudflare_3.jpg]]

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

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T20:59:05Z

Pmorey: /* Introduction */

==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 prepartion 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:
[[File: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===

# 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]]
# 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:
[[File:Keeper_cloudflare_2.jpg]]
# 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:
[[File:Keeper_cloudflare_3.jpg]]

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

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T20:58:29Z

Pmorey: /* Recording the Tunnel Configuration */

==Introduction==

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

Because Keystone Cloud Tunnel is based on Cloudflare Tunnels, some prepartion 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:
[[File: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===

# 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]]
# 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:
[[File:Keeper_cloudflare_2.jpg]]
# 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:
[[File:Keeper_cloudflare_3.jpg]]

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

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T20:57:59Z

Pmorey:

==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 prepartion 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:
[[File: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===

# 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]]
# 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:
[[File:Keeper_cloudflare_2.jpg|400px]]
# 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:
[[File:Keeper_cloudflare_3.jpg|400px]]

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

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T20:57:12Z

Pmorey:

==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 prepartion 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:
[[File: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===

# 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|400px]]
# 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:
[[File:Keeper_cloudflare_2.jpg|400px]]
# 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:
[[File:Keeper_cloudflare_3.jpg|400px]]

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

File:Keeper cloudflare 3.jpg

2026-08-03T20:46:14Z

Pmorey: File uploaded with MsUpload

File uploaded with MsUpload

File:Keeper cloudflare 2.jpg

2026-08-03T20:45:06Z

Pmorey: File uploaded with MsUpload

File uploaded with MsUpload

File:Keeper cloudflare 1.jpg

2026-08-03T20:43:06Z

Pmorey: File uploaded with MsUpload

File uploaded with MsUpload

File:Makect.jpg

2026-08-03T20:27:08Z

Pmorey: File uploaded with MsUpload

File uploaded with MsUpload

Keystone Cloud Tunnel (Cloudflare)

2026-08-03T20:25:11Z

Pmorey:

2026-03-14T01:19:38Z

Pmorey:

Main Page

2026-03-14T01:18:55Z

Pmorey:

{| border="0" cellspacing="0" cellpadding="5" align="right"
|[[Tags & Formatting Guide ]]
|-
|[[GH Wiki Standards Guide ]]
|-
|[[More Wiki Info]]
|}
__NOTOC__
 

Online Support & Documentation System 

{| {{table}}
| align="center" style="background:#f0f0f0;"|'''Announcements'''
| align="center" style="background:#f0f0f0;"|'''What's New'''
|-
|
:[[New Keystone Releases]] 5.2.8 - 3/13/2026
:[[Support Alerts]]
:[https://releasethis.azurewebsites.net Release This!]
:[https://givenhansco.sharepoint.com/:x:/s/supportteam/EVr7IrPNSghNruEGW9odUvcB-MeaRucs3z9tJBJH1RIKJw?e=PE3iQR Keystone 5.x Internal Build Testing Spreadsheet]
:[https://givenhansco.sharepoint.com/:x:/s/supportteam/ET5kQCpCQuBCu46qHGtYwgABmovrGxOC8jOlUtpVITGmng?e=VMY2iN Keystone 4.x Internal Build Testing Spreadsheet]

:[https://ghwebdev.azurewebsites.net Keystone Online Dev Site]
:[https://givenhansco.sharepoint.com/Lists/Share%20Calendars/Color%20Calendar.aspx Company SharePoint Calendar]
|
:[[iSolved Keystone Integration]] Jan. 2025
:[[Support_Alerts#Keystone_Relay_Server_fails_to_start_-_10/19/2025 |Keystone Relay Server fails to start]] 10/19/2025
:[[Support_Alerts#Dispatch_Schedule_order_shows_the_wrong_Qty_Delivered_-_12/5/2024 |Dispatch Schedule order shows the wrong Qty Delivered]] 12/5/24
:[[Support_Alerts#Tickets_may_be_associated_with_the_wrong_invoice_using_Print_Invoices_in_Keystone_4.7_and_4.7.1_-_10/10/2024 |Tickets associated with wrong invoice in Keystone 4.7/4.7.1]] 10/10/24
:[[Do This after updating number of licensed InterBase users]] 2/29/24
:[[Backup/Restore Issues#Before_Restoring_a_company_database,_check_this!_(version_4.0.1+) |Before Restoring a company backup, check this!]] 1/11/22
:[[Install/Update Issues#Keystone_database_upgrade_fails_.28version_4.0.1.2B.29 |Improved handling for database upgrade failures in Keystone 4.0.1+]] 10/27/21
:[[Microsoft Edge Chromium required for Keystone 4]] 08/22/21
:[[Configure InterBase ODBC Access]] 03/05/21
:[[AR: Fix Leading/Trailing Spaces in Jobs|Fix Leading/Trailing Spaces in Jobs]] (09/23/20)
:[[AR: Update Sales Costs from Product Standard Cost|Update Sales Costs from Product Standard Cost]] 11/4/19
:[[Configuring Keystone for E-Ticketing]] 10/04/18
:[[Fixing a Double AR void Invoice]] 10/03/18
|}

= Keystone =
{|border="0" cellspacing="5" cellpadding="5" align="center"
|[[Accounts Receivable And Billing Info |AR]]
|[[Inventory Module|Inv]]
|[[Accounts Payable System|A/P]]
|[[General Ledger System|G/L]]
|[[Payroll System|PR]]
|[[Cash Management System|Cash]]
|[[Job Cost System|JC]]
|[[Keystone Ticket Printing System|Ticketing]]
|[[Keystone Dispatch System |Dispatch]]
|[[Keystone Document Imaging |Doc Img]]
|[[Keystone On Demand | On Demand (mobile)]]
|}

== Keystone Quick Links ==

===Common System Topics===
:[[Keystone REST Server (KServer)]]
:[[Keystone Company Database Backup Utility]]
:[[QueryGen]]
:[[Keystone Security]]
:[[Keystone Constants]] Decodes tables lookup values e.g. payroll run types, cash man. trans types. (Updated 01/06/23)
:[[Keystone Installation and Configuration]]
:[[Command Import]]

===Common Software Topics===
:[[Export Tickets to Accounting]] (Including EXF)
:[http://keystonehelp.compucrete.com Customer Help Website]
:[[A/R and Billing: Training Outline]]
:[[DeReconcile Inventory]] Undo 1 or more Inv. Recon sessions. (7/24/13)
:[[Payroll: Federal & State Electronic Filing Guides]]

===External/Third Party Devices===
:[[Device Server and Device Aggregator]]
:[[Device Aggregator/Device Server Issues]]
:[[Batch Control Devices]]
:[[GPS/Status Devices]]
:[[Notification Devices]]
:[[HaulHub (Tickets to State DOT)]]

===Interbase Database===
:[[InterBase]]
:[[Interbase System Table Queries ( RDB$ )]]
:[[Database Tips]] (Restore Empty DB)
:[[InterBase Issues]] 
:[[InterBase#Installation_on_64-bit_Windows_10_Creators_Update_.28Build_1703.29_and_higher | Interbase Install Fix for Windows 10 Creators]] (07/17/17)
:[[Database Corruption]] Using '''GHIBDataPump'''
:[[Configure InterBase ODBC Access]]
:[[Do This after updating number of licensed InterBase users]]

===Windows===
:[[Windows 7 and Keystone]]
:[[Keystone 2.5 Changes]] '''with new directory chart'''

===Keystone Software Info===
====Accounting====
:[[General Ledger: Financial Statements with Bigger Print]]
:[[DeReconcile Inventory]] Undo 1 or more Inv. Recon sessions. (7/24/13)
:[[Sales Tax Handling in Keystone 2.3]] (Includes Sales Tax Collection) 10/15/09 10/13/17
:[[Updating the Base Product Code for 1.8 System]] - Methods for setting up Base Product Codes
:[[Time Calculation Queries]] - Demonstration query for time calculation 5/19/08
:[[Zone History Analysis]] - Analyze Zone Times for Dispatch - 5/15/08

====Forms====
:[[Keystone Forms]]
:[[Sample Forms]]
:[[Keystone Form Colors]] The Color De-Coder Ring. (Yes we support the colors blanched almond and lemon chiffon!)
:[[Payroll: Form Versions]] Now supports '''*SUM''' to total all defs in a check group. (07/07/17)

:[[Invoice Form Fields]] (also includes sample adding ticket image to form)
:[[Ticket Form Fields]]
:[[Quote Form Fields]] 10/10/19
:[[Plant Cash Receipt Form Fields]] 03/07/18
:[[PO Form Fields]] 03/07/2018

:[[AP Check Form Fields]] 12/14/2022

====Config====
:[[Company Database Connection Pooling]]
:[[iSolved Keystone Integration]]
:[[Keystone Constants]] Decodes tables lookup values e.g. payroll run types, cash man. trans types.
:[[Keystone Experimental Features]]
:[[Keystone Security]] (Wiki Page)
:[[Keystone Telemetry]]

===Documents===
:[[Media:Web Update.pdf]]
:[[Keystone Accounting Installer Guidelines]]

===Development Etc===
:[[Online Users Conference 2011]] - 3/2/2011
:[[Keystone 3.x Development]]
:[[Development Topics]]
:[[Development How To]]
:[[Keystone 5.x Developer Information]]

==Batch Controls Importing==
:[[Batch Control Ticket Interfaces]]
:[[Batch Ticket Import]]

==GPS==
*[[GPS System Setup]] Modern GPS System Notes
*[[GPS System Diagnostics]] Diagnostic information for GPS systems

== Keystone Tools ==
:[[Query Export]]
::[[Most Excellent Queries]]
:[[Keystone Email Setup]]
:[[Datascope System | DataScope]]
::[[DataScope Examples]] * [[DataScope G/L Finanacial Statements]]

== Tools for Supporting Keystone ==
:[[QueryGen]]
:[[Importing Accounting Data]]
:[[Communications Tools]]
:[[Keystone Support Backup]] Company Database Backup utility for support

== Troubleshooting ==
:[[Application Server Diagnostics]]
:[[Install/Update Issues]] 
:[[Backup/Restore Issues]] 
:[[Keystone System Cache]] 
:[[Error Messages and Meanings]] 
:[[Restoring the Empty Database Template]] 
:[[Disk Space Issues]] 
:[[PC/Network Support]] 
:[[Remote Desktop Tips]]
:[[Performance Issues]]

= General Info =
:[[Windows Utilities]]
:[http://technet.microsoft.com/en-us/windows/jj728757 Windows Shortcut Keys (TechNet)]

Notification Devices

2026-03-12T23:56:40Z

Pmorey: /* GIATEC 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 AICRETE GIATEC
| [[#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)]] [[#Dispatch Event AICRETE|(see below)]] [[#Dispatch Event GIATEC|(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 4.6.99.15 5.2.7.6
|-
| [[#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)
|
|
|}

====AICRETE Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERAPIKEY
| API Key specific to the customer
|
|
| Obtain from AICrete
| X
|-
| CUSTOMERAPITOKEN
| API Token specific to the customer
|
|
| Obtain from AICrete
| 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>TBD</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| ticket
|
|
|-
| STATUS
| List of statuses to send notification for (comma-delimited)
| 1 thru 8, VOID
| (all statuses)
| Use ???
|
|-
| TRUCKFILTER
| List of trucks to send notification for (comma-delimited)
|
| (all trucks)
|
|
|}

====GIATEC Parameters====

{| border="3" cellspacing="0" cellpadding="3" class="wikitable"
! Parameter
! Description
! Allowed Values
! Default
! Notes
! Required
|-
| COMPANYNAME
| Supplier Name
|
|
|
| X
|-
| CUSTOMERUSERNAME
| Username specific to the customer
|
|
| Obtain from GiaTec
| X
|-
| CUSTOMERPASSWORD
| Password specific to the customer
|
|
| Obtain from GiaTec
| 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://smartmix.giatecscientific.com/keystone-worker/api/v1</nowiki>
|
|
|-
| RESOURCE
| API URL Resource
|
| tracking
|
|
|-
| AUTHROOTURL
| Authorization URL Root
|
| <nowiki>https://smartmix.giatecscientific.com/auth</nowiki>
|
|
|-
| AUTHRESOURCE
| Authorization URL Resource
|
| login
|
|
|-
| 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)
|
|
|}

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