Batch Control Devices

From KeystoneIntranet
Jump to navigation Jump to search

Batch Interface

CommandAlkon Eagle Batch Ticket Export

Batch Control Links

Batch Control Links are handled through the Device Server.

Supported Functions Number of Products Product Code Length
Batch Control Type PROTOCOL Documents/Links Send Ticket Void Ticket Poll Weights Mix Designs Test Link Default Maximum Default Maximum Keystone Version
Auto-Control TransNet TRANSNET Setting up a TRANSNET batch control interface in Keystone X X X 4 4 7 7
CA Link-20 LINK20 Link-20 User's Guide
Link-20 (ancient)
X X X 6 6 10 10
CA Universal Link (ULINK) UNIVERSAL ULINK Serial Document
ULINK TCP/IP Document
ULINK to KEYSTONE Field Mappings (as of Keystone 3.1.8)
X X X X X 6 12 10 20 3.3.1.4
Digital Fleet (based on Integra XML) DIGITALFLEETXML Integra XML Specifications X X X 100 100 20 20 4.5.4.0
Email (SMTP) EMAILSMTP Notification of new tickets for Dispatch/Ticketing X None None None None 3.6.11.4
Keystone Batch KEYSTONE ULINK TCP/IP Document X X X X X 12 12 10 20 3.3.1.4
RexCon REXCON ULINK TCP/IP Document X X X X X 6 12 10 20 3.3.1.4
TrakIt (Integra XML) INTEGRAXML Integra XML Specifications X X X 100 100 20 20
TrimFleet (GPS) TRIMBLEXML Trimble XML Specifications X X X None None None None 3.2.7.3
Verifi VERIFI Verifi Ticketing (XML) X None None None None 3.4.5.6

Device Maintenance Sample Configurations

Common Parameters

PROTOCOL		;batch link protocol
PROTOCOLMOD             ;supports special customer modifications
EOLHEX			;batch record end of line sequence in hex (ex: 0D0A) [default=link specific]
ID			;batch link unit ID (ex: 001)
RETRY			;number of retries per batch command [default=3]
CRCTYPE			;batch CRC type (N/B/A/R) [default=R]
DATEFORMAT		;batch date format override (ex: mm/dd/yy) [default=link specific]
IGNOREBATCHWEIGHTS	;do not poll/store batch weights (Y/N) [default=Y]
TIMEOUT			;time to wait for batch control response in MILLISECONDS [default=5000]
TIMEDUEONJOB		;Keystone field to use for Time Due On Job (ULINK only) [default=TGT_ARRIVE_JOB_TIME]
TIMETICKETSENT		;Keystone field to use for Time Ticket Sent (ULINK only) [default=TICKET_TIME]
POLLBATCHWEIGHTS	;time between batch weight polls in SECONDS (0=disabled) [default=60]
SENDMIXTOBATCH		;send Keystone mix design to batch control (Y/N) [default=N]
KEEPALIVE               ;keep communication link open to batch control (Y/N) [default=N]
MIXDESIGNDECIMALS       ;number of decimal places to use when sending water & admix ingredients in the mix design (ULINK only, 1-4) [default=1]
EXTRAPRODUCTS           ;number of extra products to send to batch control (allowed range is 6-12) [default=6 for UNIVERSAL/REXCON, 12 for KEYSTONE]
FMTPRODDESC             ;maximum length for extra product description fields (allowed range is 1-35) [default=16]
FMTQTY                  ;format for QTY_SOLD, ORDER_QTY and CUMUL_QTY fields [default=4.2 for UNIVERSAL/REXCON, 9.2 for KEYSTONE]
FMTQTYSHORT             ;[Keystone 3.2.8+] format for mix QTY_SOLD and QTY_OB fields [default=2.2 for UNIVERSAL/REXCON, 9.2 for KEYSTONE]
FMTTOTAL                ;format for EXT_PRICE, SUB_TOTAL, TAX_TOTAL and ORDER_BALANCE fields [default=5.2 for UNIVERSAL/REXCON, 9.2 for KEYSTONE]
FMTUNITPRICE            ;format for UNIT_PRICE field [default=3.2 for UNIVERSAL/REXCON, 9.2 for KEYSTONE]
DUALPLANTID             ;specify second Plant Id in the case where one batch system can feed two plants
PRODUCTCODELENGTH       ;maximum length for UNIVERSAL/KEYSTONE/REXCON product codes (allowed range is 10-20) [default=10]
PRODUCTCLASS            ;batch/order device only: a list of product classes which must match the line 1 product class in order to send to the device
PRODUCTTYPE             ;batch/order device only: a list of product types which must match the line 1 product type in order to send to the device (Keystone 3.4.6.3+)
FORCEPLANT              ;batch device only: if specified this will be used as the Plant Id when sending/voiding tickets [sent as-is, include leading zeroes if needed ex: 002] (Keystone 3.5.2.2+)
IGNORELOADTIME          ;if specified Keystone will not use the Load Time from the batch results as the ticket Batch Start time (Y/N) [default=N] (Keystone 3.6.16.3+) 
ING_ID_WATER_TEMPER     ;alternate batch weights ingredient id for temper water [default=Temper Water] (Keystone 3.6.23.3+)
ING_ID_WATER_TRIM       ;alternate batch weights ingredient id for trim water [default=Trim Water] (Keystone 3.6.23.3+)
ING_ID_WATER_TRUCK      ;alternate batch weights ingredient id for truck water [default=Truck Water] (Keystone 3.6.23.3+)
ING_ID_WATER_PRELOADED  ;alternate batch weights ingredient id for preloaded water [default=Manual Water] (Keystone 3.6.23.3+) 

;serial devices
COMPORT			;serial port # (ex: 1)
BAUDRATE		;serial port baud rate (ex: 9600)
DATABITS		;serial port # of data bits (7/8)
STOPBITS		;serial port # of stop bits (1/2)
PARITY			;serial port parity (N/O/E/M/S)

;network devices (TCP/UDP)
IPADDRESS		;network IP address (ex: 192.168.1.1)
IPPORT			;network IP port (ex: 7000)
CONNECTTIMEOUT		;network connection timeout (msecs)

;message queues (MSMQ)
MSMQFORMATNAME          ;Microsoft Message Queue Format Name

Keystone Batch

ID=001
PROTOCOL=KEYSTONE
IPADDRESS=192.168.0.3
IPPORT=7000
PRODUCT_SEP=.
SUPPRESSPRINT=Y
POLLBATCHWEIGHTS=30
SENDMIXTOBATCH=Y

ULINK/TCP Generic (incl. Alkon)

ID=001
PROTOCOL=UNIVERSAL
IPADDRESS=192.168.0.3
IPPORT=7000
PRODUCT_SEP=.
SUPPRESSPRINT=Y
POLLBATCHWEIGHTS=30
SENDMIXTOBATCH=Y

PSI Eagle Serial

(NOTE: The ID parameter is critical and must match the Eagle setting!)

PROTOCOL=UNIVERSAL
ID=01
COMPORT=1
BAUDRATE=9600
EOLHEX=0D
DATABITS=8
STOPBITS=1
CRCTYPE=R
TIMEOUT=5000
SUPPRESSPRINT=Y

RexCon (6 extra products)

ID=001
PROTOCOL=REXCON
IPADDRESS=192.168.0.3
IPPORT=7000
PRODUCT_SEP=.
SUPPRESSPRINT=Y
POLLBATCHWEIGHTS=30
SENDMIXTOBATCH=Y
IGNORELOADTIME=Y

RexCon (12 extra products, 20 character product codes)

ID=001
PROTOCOL=REXCON
IPADDRESS=192.168.0.3
IPPORT=7000
PRODUCT_SEP=.
SUPPRESSPRINT=Y
POLLBATCHWEIGHTS=30
SENDMIXTOBATCH=Y
EXTRAPRODUCTS=12
PRODUCTCODELENGTH=20
IGNORELOADTIME=Y

Verifi

The Verifi batch device is meant to be linked from another batch control device. Here is an example from Device Maintenance:

Error creating thumbnail: /bin/bash: /usr/bin/convert: No such file or directory Error code: 127

PROTOCOL=VERIFI
ROOTURL=https://portal.verificoncrete.com/rs/api/1.3/
VERIFIUSER=givenhansco@company.com
VERIFIUSERPASS=**************

Email (SMTP)

This device can be used to send an email notification when a new ticket is generated in either Dispatch or Ticketing.

PROTOCOL=EMAILSMTP
SMTPHOST=<hostname/IP address of SMTP server>
SMTPPORT=<SMTP server IP port (25 default)>
SMTPSSLMETHOD=<SSLv2 | SSLv23 | SSLv3 | TLSv1 | TLSv1_1 | TLSv1_2>
SMTPUSERNAME=<SMTP server login username>
SMTPPASSWORD=<SMTP server login password>
SMTPREADTIMEOUT=<SMTP server read timeout (msec)>
EMAILFROM=<email address of sender>
EMAILSUBJECT=<subject line for the email>
HTMLHEADER=<HTML for header portion of the email body>
HTMLFOOTER=<HTML for footer portion of the email body>

Digital Fleet

PROTOCOL=DIGITALFLEETXML
MSMQFORMATNAME=DIRECT=OS:.\PRIVATE$\fromdispatch