Scripting for Handheld WMS

Server based Scripting for the Handheld WMS

The following is a tutorial on Handheld WMS server side scripting capabilities where certain areas have been opened to modification using scripts. Currently, Visual Basic (VB) is the only scripting language supported.

Writing scripts

Any text editor can be used to write a script and any file naming convention may be used with the exception of spaces-- do not use spaces in the script file name.  Generally VB Scripts should use the ".vbs" extension, but this is not required.  The script consists of one or more functions (described below). 

For more information on VBScript visit Microsoft's VBScript explanation.

Notes:

• Do not place any VBScript commands outside of a function in the script.  These commands will execute upon the initialization of the script and may cause problems.  Also, do not write anything to the screen or attempt to ask any questions of the user as these will not work and may cause the system to halt.
• There can be multiple functions in the same script file.
• Any changes to a script requires the Cadacus WCF service to be restarted.
• Please do not use MsgBox or anything else requiring a user interaction in a live, production script as the script will cause the operation to crash.

Step-by-step instructions

1. In the EDI System Setup, select the "Files & Paths" tab and check the "Enable Scripting" box.  Enter a directory on the SYSPRO application server where the scripts will be stored.

Notes: 

• do not use a path with spaces in the directory name(s).  If the path does include a space, use the "short' name for the directory with the space in it, for example, "progra~1", instead of "Program Files"
• Use the "Server" option
• To temporarily disable scripting, uncheck the "Enable Scripting" box
• If SQL is used in the script, enter the username and password here, as well (note, the password is hidden after the window is saved and closed)

2. Move script to the folder path defined on the application server in the above example step.

3. In the Cross-Reference section of the EDI Menu, select the Handheld WMS Script Definitions menu, and choose "New".  In this example, the Module is "Job Receipts" and the Action is "On Verify":

4. Modify the query, as needed (example below).  Note "HandheldWMS" is the class name.

Public Function GetExpiryDate(ValidationXml) ' As String
  dim ExpiryDate, sJob, sCmd
  sJob = HandheldWMS.ElementText("Job")
  sCmd = "Select something from table where Job='" & sJob & "'"
                                                'return date in YYYY/MM/DD format
  ExpiryDate = HandheldWMS.SQLExecuteScaler(sCmd)
  HandheldWMS.StartXML

  if len(HandheldWMS.SQLError) > 0 then
    HandheldWMS.StatusXML HandheldWMS.Problem
    HandheldWMS.MessageXML "Problem with SQL call - " & HandheldWMS.SQLError
  else
    if len(ExpiryDate) = 0 then
      HandheldWMS.StatusXML HandheldWMS.Problem
      HandheldWMS.MessageXML "Problem with SQL call - No Date returned"
    else
      HandheldWMS.StatusXML HandheldWMS.Success
      HandheldWMS.InformationXML "LotExpiryDate",ExpiryDate
    end if
  end if

  HandheldWMS.EndXML
  GetExpiryDate = HandheldWMS.ReturnXML
End Function

Reference

When utilizing any of the properties or functions in the script is called, "HandheldWMS" is the class.

Calling a function that does not return a value can be done using either of the following methods.

  Call XXX(Parameter)
     - or -
   XXX Parameter

Information sent from the Handheld WMS to the scripts

• Warehouse
• StockCode
• Quantity
• Bin
• Lot
• Serial
• Reference
• Notation
• SalesOrder
• PurchaseOrder
• Job
• Scrap
• Class
• Route
• LedgerCode

Any of the above information may be returned to the handheld and the information provided will overwrite the original.  In addition the following information may be returned:  LotExpiryDate.

Important:  Please note version 2.7.003 (as seen in the add/remove program listing) is required for all the latest functions.

Connections

Logging*

* If an exception is caught for SQL or SYSPRO calls and the "Log" variable is true, the exception will be written to the log file.

More

Testing outside of SYSPRO

Testing outside of SYSPRO is an advantage during the initial testing stages.  To do so, please add the following section to the "front" of the script shown above.

When testing, a 32-Bit command prompt must be used.  Any other method will result in a Cadacus.HandheldRuntime not found error.

' ---  For testing only, Remove or Comment out before using

set HandheldWMS=CreateObject("Cadacus.HandheldRuntime") 

dim SampleXML
SampleXML = "<CustomValidation><Job>123</Job><Quantity>333</Quantity></CustomValidation>"

HandheldWMS.Company = "O"
HandheldWMS.Server = "SQLserver"
HandheldWMS.Database = "SysproCompanyX"
HandhedWMS.BuildConnectionString "Username","Password"

'on error resume next 

MsgBox GetExpiryDate(SampleXML)

' --- Everything above this line for testing only, Remove or comment out before using

' The rest of the script would be put here.....

Now using cscript, launch the script.  For example:

cscript GetExpiryDate.vbs /x /d

This command launches the script (/x) using the debugger (/d).  For more details on cscript go here.

Debugging does require Microsoft Visual Studios to be installed.