Notification Devices
Jump to navigation
Jump to search
Introduction
Keystone supports several different types of notification devices. These are meant to send notifications based on certain events.
Device Types
| Device Type | Description | NOTIFYTYPE | PROTOCOL | Parameters | Keystone Version |
|---|---|---|---|---|---|
| Dispatch Event | Sent when a dispatch status event occurs | DISPATCH | KEYSTONEONLINE ROADKING HAULHUB CIDRA HOLCIM CARBONCURE AGGHAULHUB |
(see below) (see below) (see below) (see below) (see below) (see below) (see below) |
3.6 3.6.15.5 4.3.9.7 4.3.9.7 4.4 4.5.4.0 4.5.5.9 |
| Notify Batch Weights | Sent when batch weights are received from a batch control | BATCHWEIGHTS | EMAILSENDGRID EMAILSMTP KOBATCHWEIGHTS |
(see below) (see below) (see below) (see below) (see below) |
3.6.11.5 3.6.10 3.6.9 4.1.2.2 4.3.5.2 |
| Notify Order Complete | Sent when an order is considered complete | ORDERCOMPLETE | EMAILSENDGRID EMAILSMTP |
(see below) (see below) |
3.6.11.5 3.6.10 |
| Order Route Update | Sent when an order route is added/changed | ORDERROUTE | KEYSTONEONLINE | (see below) | 3.6.99.58 |
Dispatch Event
Dispatch Event devices will forward dispatch status events to external devices.
KEYSTONEONLINE Parameters
| Parameter | Description | Allowed Values | Default | Notes | Required |
|---|---|---|---|---|---|
| ROOTURL | API URL Root | http://ghwebgps.azurewebsites.net/DispatchAPI | X | ||
| AUTHUSERNAME | (not implemented) | ||||
| AUTHPASSWORD | (not implemented) | ||||
| INFO_BUSINESSID | Keystone Online Business ID Number | X | |||
| STATUS | List of statuses to send notification for (comma-delimited) | 1 thru 8, VOID | (all statuses) | Use 1,3,8,VOID | |
| TRUCKFILTER | List of trucks to send notification for (comma-delimited) | (all trucks) |
ROADKING Parameters
| Parameter | Description | Allowed Values | Default | Notes | Required |
|---|---|---|---|---|---|
| ROOTURL | API URL Root | https://roadkingtech.com | 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
| 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 IANA Time Zone Names) | X | ||
| ROOTURL | API URL Root | https://app.haulhub.com/integrations/api/v1 | |||
| RESOURCE | API URL Resource | tickets | |||
| STATUS | List of statuses to send notification for (comma-delimited) | 1 thru 8, VOID | (all statuses) | ||
| TRUCKFILTER | List of trucks to send notification for (comma-delimited) | (all trucks) |
CIDRA SmartHatch Parameters
| 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 IANA Time Zone Names) | X | ||
| ROOTURL | API URL Root | https://shapi.cidraconcrete.com/interface | |||
| 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) |
HOLCIM (Concretely) Parameters
| Parameter | Description | Allowed Values | Default | Notes | Required |
|---|---|---|---|---|---|
| CUSTOMERIDKEY | Id Key specific to the customer | X | |||
| ROOTURL | API URL Root | https://app.concretely.co/api/orders/provider | |||
| 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
| 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 | https://uploads.carboncure.com/ | |||
| 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
| 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 IANA Time Zone Names) | X | ||
| ROOTURL | API URL Root | https://app.haulhub.com/integrations/api/v1 | |||
| RESOURCE | API URL Resource | tickets | |||
| STATUS | List of statuses to send notification for (comma-delimited) | 1 thru 8, VOID | (all statuses) | Use 1, VOID | |
| TRUCKFILTER | List of trucks to send notification for (comma-delimited) | (all trucks) |
Notify Batch Weights
Notify Batch Weights devices will send a notification when batch weights are received from the batch control associated with a plant.
EMAILSENDGRID Parameters
| 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 | (see below) | |||
| HTMLHEADER | Email Body Header HTML | (see below) | |||
| HTMLFOOTER | Email Body Footer HTML | (see below) | |||
| HTMLBWHEADER | Email Body Batch Weights Section Header HTML | (see below) | |||
| HTMLBWDETAIL | Email Body Batch Weights Section Detail HTML | (see below) | |||
| HTMLBWFOOTER | Email Body Batch Weights Section Footer HTML | (see below) | |||
| SHOWPCTERROR | Show or hide "% Error" in ingredient list | Y/N | Y | 3.6.16.5+ |
EMAILSMTP Parameters
| 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 | (see below) | |||
| HTMLHEADER | Email Body Header HTML | (see below) | |||
| HTMLFOOTER | Email Body Footer HTML | (see below) | |||
| HTMLBWHEADER | Email Body Batch Weights Section Header HTML | (see below) | |||
| HTMLBWDETAIL | Email Body Batch Weights Section Detail HTML | (see below) | |||
| HTMLBWFOOTER | Email Body Batch Weights Section Footer HTML | (see below) | |||
| SHOWPCTERROR | Show or hide "% Error" in ingredient list | Y/N | Y | 3.6.16.5+ |
Default Email Format
Subject: Load Ship Notification
| Customer: | [CUST_NO] |
| Order: | [ORDER_CODE] |
| Ticket: | [TICKET_NO] |
| Batch Time: | [BATCH_END_DT] |
| Job: | [JOB_PO_LOC] |
| Job Lot: | [JOB_LOT] |
| Usage: | [USE] |
| Customer P.O.: | [CUSTOMER_PO] |
| Truck: | [TRUCK_NO] |
| Mix: | [PRODUCT_CODE_1] - [DESCRIPTION_1] |
| Load Size: | [QTY_SOLD_1] |
| Cumul Qty: | [CUMUL_QTY_1] |
| Order Qty: | [ORDER_QTY_1] |
| Plant Name: | [PLANT_NAME] |
| Address: | [PLANT_ADDR_1] |
| [PLANT_ADDR_2] | |
| Material | Targets | Actual | % Error | % Moist |
|---|---|---|---|---|
| [BW_INGRED_ID_n] | [BW_INGRED_TARGETWEIGHT_n] | [BW_INGRED_ACTUALWEIGHT_n] | [PCT_ERROR] | [BW_INGRED_PCTMOISTURE_n] |
| NOTE: This email was automatically generated. |
| *** PLEASE DO NOT REPLY TO THIS EMAIL. *** |
KOBATCHWEIGHTS Parameters
| 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+ |
DOTPA Parameters
| Parameter | Description | Allowed Values | Default | Required | Keystone Version |
|---|---|---|---|---|---|
| ROOTURL | API Root URL | https://mobile.penndot.gov/vendorapi_eticketing/api | 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 |
HAULHUB Parameters
| Parameter | Description | Allowed Values | Default | Required | Keystone Version |
|---|---|---|---|---|---|
| ROOTURL | API Root URL | https://app.haulhub.com/integrations/api/v1 | 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 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
| 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 | (see below) | |||
| HTMLHEADER | Email Body Header HTML | (see below) | |||
| HTMLFOOTER | Email Body Footer HTML | (see below) |
EMAILSMTP Parameters
| 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 | (see below) | |||
| HTMLHEADER | Email Body Header HTML | (see below) | |||
| HTMLFOOTER | Email Body Footer HTML | (see below) |
Default Email Format
Subject: Order Complete Notification
| Customer: | [CUST_NO] |
| Order: | [ORDER_CODE] |
| Job: | [JOB_PO_LOC] |
| Job Lot: | [JOB_LOT] |
| Usage: | [USE] |
| Customer P.O.: | [CUSTOMER_PO] |
| NOTE: This email was automatically generated. |
| *** PLEASE DO NOT REPLY TO THIS EMAIL. *** |
Order Route Update
Order Route Update devices will notify external devices when an order route is added or changed.
KEYSTONEONLINE Parameters
| Parameter | Description | Allowed Values | Default | Notes | Required |
|---|---|---|---|---|---|
| ROOTURL | API URL Root | https://api-gh-prod.azurewebsites.net/api | X | ||
| AUTHUSERNAME | (not implemented) | ||||
| AUTHPASSWORD | (not implemented) | ||||
| INFO_BUSINESSID | Keystone Online Business ID Number | X |