Stock Tracker 5 Scripting Reference

addContactEditor

addContactEditor.getContactTypeID
Get the selected contact type ID
addContactEditor.setContactTypeID
Set the selected contact type ID
addContactEditor.getHearSourceID
Get the selected hear source ID
addContactEditor.setHearSourceID
Set the selected hear source ID

app

app.getAppVersion
Get Stock Tracker app version number.
app.getAppBuildInfo
Get Stock Tracker app build info (build date/time).
app.getAppDatabaseVersion
Get Stock Tracker app supported database version. This is the database version that app expects, not the actual version specified in the database.
app.log
Write a line of plain text to the output window.
app.logBold
Write a line of bold text to the output window.
app.logError
Write a line of red text to the output window.
app.logDebug
Write a line of plain text to the output window if scriptDebug global variable is true
app.clearOutput
Clear the output window.
app.generateGUID
Generate a GUID.

checkout

checkout.addService
Add a service to the checkout
checkout.getSelectedDayDate
Get the selected date from the payment transactions list.

contactEditor

contactEditor.getContactID
Get the edited contact ID
contactEditor.getContactTypeID
Get the selected contact type ID
contactEditor.getContactNotesChanged
Gets whether the contact's notes changed
contactEditor.getContactPhoneChanged
Gets whether the contact's phone changed
contactEditor.getContactMobileChanged
Gets whether the contact's mobile changed
contactEditor.getContactAlternatePhoneChanged
Gets whether the contact's alternate phone changed

contacts

contacts.getNoAddressID
Get the default empty address ID. This is 1 by default but can differ if it has been customised in the database.
contacts.addressIDToContactID
Get the contact ID associated with an address (get the address's contact).
contacts.addressIDToContactTypeID
Get the contact type ID for an address.
contacts.contactNumberToContactID
Get the contact ID for a contact number.
contacts.contactIDToContactNumber
Get a contact number from a contact ID.
contacts.getContactName
Get a contact name from a contact ID.
contacts.getContactTypeID
Get a contact type ID from a contact ID.
contacts.getContactStatusID
Get the status ID of a contact.
contacts.setContactStatusID
Set the status ID of a contact.
contacts.getContactStatus
Get the status name of a contact.
contacts.setContactStatus
Set the status of a contact by status name.
contacts.getContactDefaultInvoiceRef
Get a contact's default invoice reference.
contacts.setContactDefaultInvoiceRef
Set a contact's default invoice reference.
contacts.contactInvoiceRefToContactID
Get the first found contact ID with the specified default invoice reference.
contacts.getContactFlagged
Get the flagged status of a contact.
contacts.setContactFlagged
Set the flagged status of a contact.
contacts.getContactNotes
Get the notes from a contact.
contacts.appendContactNotes
Append the notes of a contact.
contacts.clearContactNotes
Clear the notes of a contact. This will delete the contact's notes entirely and cannot be undone.
contacts.getLastCreatedContactId
Get the ID of the last contact created on the local computer.
contacts.getAddressName
Get the full name for an address ID.
contacts.getAddressSurname
Get the surname for an address ID.
contacts.getAddressPostCode
Get the postcode for an address ID.
contacts.showAddressOnMap
Opens the default web browser and displays the location of an address ID.
contacts.showAddressDirectionsOnMap
Opens the default web browser and displays directions to an address ID (from the current computer's site post code).
contacts.showPostCodeDirectionsOnMap
Opens the default web browser and displays directions to a post code (from the current computer's site post code).
contacts.setCustomTabEnabled
Shows or hides the Custom tab in the Contacts Manager.
contacts.getCustomTabEnabled
Gets the Custom tab visible state in the Contacts Manager.
contacts.setCustomTabCaption
Shows or hides the Custom tab in the Contacts Manager.
contacts.getCustomTabCaption
Gets the Custom tab visible state in the Contacts Manager.
contacts.addContact
Creates a new contact including address.
contacts.splitContactName
Automatically split a single string name into 3 separate fields for title, first name and surname respectively.
contacts.getContactTypeFromContactTypeID
Gets the contact type name from a contact type ID

data

data.createGrid
Create an empty 2D array (grid) in the same format returned by loadCsvFile and runSelectQuery etc.
data.clearGrid
Clears an empty 2D array (grid) of all data and sets the rows and columns counts to 0.
data.loadCsvFile
Load data from a CSV file to a Lua 2D array
data.runSelectQuery
Load data from a CSV file to a Lua 2D array
data.runExecQuery
Execute SQL Server code directly to the Stock Tracker database.
data.sqlSafe
Escape a string field to SQL.
data.databaseTableExists
Determine if a database table exists.
data.printGrid
Print a 2D array (grid) returned from data.loadCsvFile or data.runSelectQuery to the output window.
data.getGridColsCount
Get the number columns in a 2D array (grid).
data.getGridRowsCount
Get the number rows (records) in a 2D array (grid).
data.setCell
Set a cell string value within a 2D array (grid) returned from data.loadCsvFile or data.runSelectQuery etc.
data.getCell
Get a cell string value within a 2D array (grid) returned from data.loadCsvFile or data.runSelectQuery etc.
data.printCell
Print a cell string value from within a 2D array (grid) returned from data.loadCsvFile or data.runSelectQuery etc.

date

date.getCurrentDate
Get the current date.
date.getDayOfWeek
Get the day of the week from a date.
date.getDaysInMonth
Get the amount of days in the month of the specified date.
date.getStartOfMonth
Get the start of the month of the specified date.
date.addDays
Adds an amount of days to the specified date.
date.formatDate
Format a date using a format string.

drops

drops.getDropAddressID
Get the address ID for a drop.
drops.getDropContactID
Get the contact ID for a drop.
drops.getDropDate
Get the date for a drop.
drops.getDropVanID
Get the van ID for a drop.
drops.getDropVanName
Get the van name for a drop.
drops.getDropTimeSlotID
Get the time slot ID for a drop.
drops.getDropTimeSlotName
Get the time slot name for a drop.
drops.getDropInstructions
Get the instructions text for a drop.
drops.getDropOptions
Get all ticked drop option names in a drop.
drops.getDropItemIDs
Get all items IDs in a drop.
drops.getDropItemsData
Get the contact ID for a drop.
drops.getItemDropIDs
Get all drop IDs containing an item.

excel

excel.create
Create a new blank Excel workbook.
excel.load
Load an Excel workbook.
excel.duplicate
Create a new Excel workbook based on an existing file.
excel.save
Save an Excel workbook using the original filename.
excel.saveAs
Save an Excel workbook.
excel.close
Close an Excel workbook and quit Excel.
excel.getFilename
Get an Excel workbook filename.
excel.getWorksheetIndex
Get an Excel worksheet index by title.
excel.getCells
Get a range of cells to a 2D array.
excel.setCells
Set a range of cells from a 2D array.
excel.getCell
Get a cell value.
excel.setCell
Set a cell value.
excel.getExcelVisible
Get Excel window visible status.
excel.setExcelVisible
Set Excel window visible status.

invoiceEditor

invoiceEditor.getCustomerAddressID
Get invoice's customer address ID
invoiceEditor.setCustomerAddressID
Set invoice's customer address ID
invoiceEditor.getInvoiceAddressID
Get invoice's invoice address ID
invoiceEditor.setInvoiceAddressID
Set invoice's invoice address ID

invoices

invoices.setCustomTabEnabled
Shows or hides the Custom tab in the Invoices section.
invoices.getCustomTabEnabled
Gets the Custom tab visible state in the Invoices section.
invoices.setCustomTabCaption
Shows or hides the Custom tab in the Invoices section.
invoices.getCustomTabCaption
Gets the Custom tab visible state in the Invoices section.
invoices.invoiceIDToInvoiceNumber
Get a invoice number from a invoice ID.
invoices.invoiceNumberToInvoiceID
Get a invoice ID from a invoice number.
invoices.getSelectedInvoiceIds
Gets the selected Invoice ids.
invoices.printInvoice
Print an invoice to the specified printer.
invoices.printInvoiceToPDF
Print an invoice to a PDF file (requires Bullzip to be installed).
invoices.getInvoicesDateRangeISOString
Get the current data range from the Invoices area as a string with dates in ISO yyyy-mm-dd format.

io.getSpecialFolderPath
Get a special folder path using a CSIDL value
io.extractFilename
Get the filename segment only from a path string.
io.extractPath
Remove filename segment from a path string.
io.createDirectory
Create a directory (also create parent directories as required).
io.showFileInExplorer
Open a Windows Explorer window and select the specified file. Also works for folders.
io.fileExists
Checks whether a file exists.

net

net.getServerName
Get the hostname of the server.
net.setSmtpServerSettings
Set SMTP email server settings before using net.sendEmail.
net.clearSmtpServerSettings
Forget SMTP email server settings previously set using net.setSmtpServerSettings.
net.sendEmail
Send an email in either plain text or HTML format. SMTP server settings must already have been specified by calling to net.setSmtpServerSettings.
net.openUrl
Open a URL in the default broweser.

operators

operators.getCurrentOperatorID
Get current logged in operator ID
operators.getCurrentOperatorName
Get the name of current operator
operators.getName
Get an operator name from an their operator ID

transactionEditor

transactionEditor.getInvoiceIDs
Get all invoice IDs in a transaction.
transactionEditor.getPrintReceipt
Get whether to print a receipt in a transaction.
transactionEditor.setPrintReceipt
Set whether to print a receipt in a transaction.

transactions

transactions.getTransactionsDataForDay
Get all transactions data for the specified date.
transactions.transactionIDToTransactionNumber
Get a transaction number from a transaction ID.
transactions.transactionNumberToTransactionID
Get a transaction ID from a transaction number.
transactions.printReceiptToPDF
Print a receipt to a PDF file (requires Bullzip to be installed).

ui.getScale
Get the current system DPI scale factor.
ui.messageBox
Show a basic message box on top of uppermost window.
ui.showNotification
Show a notification above the system tray for a short time.
ui.printNotification
Similar to ui.showNotification except the message is also printed to the output console.
ui.printNotificationError
Similar to ui.printNotification except the notification text is red and the text printed to the output window is bold.
ui.printNotificationSuccess
Similar to ui.printNotification except the notification text is green.
ui.getCurrentWindowHandle
Get the current Stock Tracker window handle as an integer.
ui.getHandle
Get a handle from a control enum.
ui.createButton
Creates a custom button as a child of the specified control.
ui.deleteControl
Delete a custom control (e.g. button).
ui.showOpenFileDialog
Shows an open file dialog.
ui.showSaveFileDialog
Shows an save file dialog.
ui.showGridViewerDialog
Shows a grid viewer dialog containing the specified cells data.
ui.showCSVViewerDialog
Shows a grid viewer dialog containing the specified cells data.

Events

onOperatorLogin
Event called an operator logs in.
onOperatorLogout
Event called an operator logs out.
onContactAddLoaded
Event called when the Add Contact editor is loaded.
onContactAddSave
Event called just before a contact has been added. Can be cancelled by returning false.
onContactAddSaved
Event called after a contact has been added.
onContactEditorSave
Event called just before a contact has been saved. Can be cancelled by returning false.
onContactEditorSaved
Event called after a contact has been saved.
onContactEditorApplyDefaultInvoiceReference
Event called when the "Apply" default invoice reference button is pressed in the Contact Editor.
onDropMoved
Event called after a drop has been moved.
onPrintDropSheetFooter
Event called just before the drop footer text is printed to a printed drop sheet.
onOverrideDropColour
Event called while setting colour to display a drop in the Drop section.
onInvoiceEditorSave
Event called just before an invoice is saved in the invoice editor.
onInvoiceEditorSaved
Event called just after an invoice has been saved in the invoice editor.
onInvoiceEditorAddressChanged
Event called when a customer or invoice address is changed or cleared in the invoice editor.
onPrintInvoiceFooter
Event called just before the invoice footer text is printed to a printed invoice.
onTransactionEditorLoaded
Event called when the transaction editor loads.