360Works EPAD/Documentation

From 360Works Product Documentation Wiki
Jump to: navigation, search

Contents

360Works EPAD User Guide

Created with IntelliJ IDEA. User: sterling Date: 8/21/13 Time: 6:15 PM To change this template use File | Settings | File Templates.


360Works Plugin Setup Guides

See Plugins_101 for Error reporting, installation, registration, and more.

Function Summary

  • EPADAddShipmentToStatusUpdate ( shipmentId ; trackingNumber ; notes ; shipDate ; shipQty ; shippingInstruction ; shippingMethod ; printJobNumber ; numberOfCartons ; shipWeight ; shipWeightUnit ; shippingName ; shippingAddress1 ; shippingAddress2 ; shippingAddress3 ; shippingAddress4 ; shippingCity ; shippingCountry ; shippingState ; shippingZipCode ; rShipCost ; dcShipCost ; shipCostCurrency ; miscCost ; miscCostCurrency ; miscDescription ; confirmOnBehalf ; confirmBy ; confirmDate ) — Adds shipment data to a pending SHIPPED status update request.
  • EPADConvertTimestampToFM ( epadTimestamp ) —
  • EPADCreateShippedStatusUpdate ( epadHostName ; epadVendorId ; epadUsername ; epadPassword ; epadOrderNumber ) — Initializes a SHIPPED status update request.
  • EPADDownloadManifestFromFTP ( epadOrderNumber ; ftpHostName ; ftpUsername ; ftpPassword ; ftpPort ; ftpDestinationDirectory ) — Downloads an order manifest and queues it in memory.
  • EPADGetNextOrder — Queues up next order in a list retrieved by a call to {@link #EPADGetOrderDownloadList}
  • EPADGetOrderDownloadList ( epadHostName ; epadVendorId ; username ; password ) — Generates a list of orders with READY or DOWNLOADED status for a given vendor and stores the list in memory
  • EPADGetOrderNo — Gets order number for current order in queue
  • EPADGetOrderPackage — Gets order package file name for current order in queue
  • EPADGetStatusDescription — Gets order status description for current order in queue
  • EPADGetStatusID — Gets order status description for current order in queue
  • EPADLastError — Returns an error message associated with the last plug-in function call.
  • EPADLicenseInfo — Returns information about the current license
  • EPADRegister ( licenseKey ; registeredTo ) — Registers the plugin
  • EPADSendDownloadedVerifiedStatusUpdate ( epadHostName ; epadVendorId ; epadUsername ; epadPassword ; epadOrderNumber ; status ) — Submits a DOWNLOADED or VERIFIED status update request.
  • EPADSendErrorStatusUpdate ( epadHostName ; epadVendorId ; epadUsername ; epadPassword ; epadOrderNumber ; error ) — Submits an ERROR status update request.
  • EPADSendShippedStatusUpdate ( epadHostName ; epadUsername ; epadPassword ) — Submits a SHIPPED status update to the EPAD Web service.
  • EPADSetErrorCapture ( errorCapture ) — Suppresses or allows error dialogs to be displayed automatically upon plugin error
  • EPADUploadFilesToFTP ( epadHostName ; epadVendorId ; epadUsername ; epadPassword ; epadOrderNumber ; ftpHostName ; ftpUsername ; ftpPassword ; ftpPort ; ftpDestinationDirectory ; boolean unarchive ) — Downloads a list of orders and queues them in memory.
  • EPADVersion — Returns the version of the plugin

Function Detail

EPADAddShipmentToStatusUpdate ( shipmentId ; trackingNumber ; notes ; shipDate ; shipQty ; shippingInstruction ; shippingMethod ; printJobNumber ; numberOfCartons ; shipWeight ; shipWeightUnit ; shippingName ; shippingAddress1 ; shippingAddress2 ; shippingAddress3 ; shippingAddress4 ; shippingCity ; shippingCountry ; shippingState ; shippingZipCode ; rShipCost ; dcShipCost ; shipCostCurrency ; miscCost ; miscCostCurrency ; miscDescription ; confirmOnBehalf ; confirmBy ; confirmDate )

Adds shipment data to a pending SHIPPED status update request. Can be called multiple times after an initial call to EPADCreateShippedStatusUpdate.

Parameters:

shipmentId
trackingNumber
notes
shipDate
shipQty
shippingInstruction
shippingMethod
printJobNumber
numberOfCartons
shipWeight
shipWeightUnit
shippingName
shippingAddress1
shippingAddress2
shippingAddress3
shippingAddress4
shippingCity
shippingCountry
shippingState
shippingZipCode
rShipCost
dcShipCost
shipCostCurrency
miscCost
miscCostCurrency
miscDescription
confirmOnBehalf
confirmBy
confirmDate

Returns: 1 on success or "ERROR" if an error occurred. An immediate call to EPADLastError will return detailed error info.

EPADConvertTimestampToFM ( epadTimestamp )

Parameters:


EPADCreateShippedStatusUpdate ( epadHostName ; epadVendorId ; epadUsername ; epadPassword ; epadOrderNumber )

Initializes a SHIPPED status update request.

Parameters:

epadHostName
epadVendorId
epadUsername
epadPassword
epadOrderNumber

Returns: 1 on success or "ERROR" if an error occurred. An immediate call to EPADLastError will return detailed error info.

EPADDownloadManifestFromFTP ( epadOrderNumber ; ftpHostName ; ftpUsername ; ftpPassword ; ftpPort ; ftpDestinationDirectory )

Downloads an order manifest and queues it in memory.

Parameters:

epadOrderNumber
ftpHostName
ftpUsername
ftpPassword
ftpPort
Defaults to 21 if left blank.
ftpDestinationDirectory
An existing file path relative to the root of the FTP share where the order manifest lives.

Returns: 1 on success or "ERROR" if an error occurred. An immediate call to EPADLastError will return detailed error info.

EPADGetNextOrder

Queues up next order in a list retrieved by a call to EPADGetOrderDownloadList

Returns: 1 if there is another item in the queue or 0 if not

EPADGetOrderDownloadList ( epadHostName ; epadVendorId ; username ; password )

Generates a list of orders with READY or DOWNLOADED status for a given vendor and stores the list in memory

Parameters:

epadHostName
epadVendorId
epadUsername
epadPassword

Returns: 1 on success or "ERROR" if an error occurred. An immediate call to EPADLastError will return detailed error info.

EPADGetOrderNo

Gets order number for current order in queue

Returns: Order Number

EPADGetOrderPackage

Gets order package file name for current order in queue

Returns: Package File Name

EPADGetStatusDescription

Gets order status description for current order in queue

Returns: Status Description

EPADGetStatusID

Gets order status description for current order in queue

Returns: Status ID

EPADLastError

Returns an error message associated with the last plug-in function call. If the last call did not result in an error, returns nothing. Be sure to call this function before any other if the result of another plug-in function call returns the word "ERROR".

Returns: An error message

EPADLicenseInfo

Returns information about the current license

Returns: A return-separated list of license information

EPADRegister ( licenseKey ; registeredTo )

Registers the plugin

Parameters:

licenseKey
registeredTo

Returns: 1 on success or "ERROR" if an error occurred. An immediate call to EPADLastError will return detailed error info.

EPADSendDownloadedVerifiedStatusUpdate ( epadHostName ; epadVendorId ; epadUsername ; epadPassword ; epadOrderNumber ; status )

Submits a DOWNLOADED or VERIFIED status update request.

Parameters:

epadHostName
epadVendorId
epadUsername
epadPassword
epadOrderNumber
status
DOWNLOADED or VERIFIED

Returns: 1 on success or "ERROR" if an error occurred. An immediate call to EPADLastError will return detailed error info.

EPADSendErrorStatusUpdate ( epadHostName ; epadVendorId ; epadUsername ; epadPassword ; epadOrderNumber ; error )

Submits an ERROR status update request.

Parameters:

epadHostName
epadVendorId
epadUsername
epadPassword
epadOrderNumber
error
GENERIC, CORRUPTED_PACKAGE, CORRUPTED_FILE, INCORRECT_DATA or REJECTED

Returns: 1 on success or "ERROR" if an error occurred. An immediate call to EPADLastError will return detailed error info.

EPADSendShippedStatusUpdate ( epadHostName ; epadUsername ; epadPassword )

Submits a SHIPPED status update to the EPAD Web service.

Parameters:

epadHostName
epadUsername
epadPassword

Returns: 1 on success or "ERROR" if an error occurred. An immediate call to EPADLastError will return detailed error info.

EPADSetErrorCapture ( errorCapture )

Suppresses or allows error dialogs to be displayed automatically upon plugin error

Parameters:

errorCapture
1 to suppress dialogs, 0 to allow them (0 by default)

Returns: 1

EPADUploadFilesToFTP ( epadHostName ; epadVendorId ; epadUsername ; epadPassword ; epadOrderNumber ; ftpHostName ; ftpUsername ; ftpPassword ; ftpPort ; ftpDestinationDirectory ; boolean unarchive )

Downloads a list of orders and queues them in memory.

Parameters:

epadHostName
epadVendorId
epadUsername
epadPassword
epadOrderNumber
ftpHostName
ftpUsername
ftpPassword
ftpPort
Defaults to 21 if left blank.
ftpDestinationDirectory
An existing file path relative to the root of the FTP share where the zip archive will be stored.
unarchive
A boolean flag (1 or 0 in FileMaker) that will determine whether to unpack the zip archive or download it as-is.

Returns: 1 on success or "ERROR" if an error occurred. An immediate call to EPADLastError will return detailed error info.

EPADVersion

Returns the version of the plugin

Returns: A version number
Personal tools
Namespaces

Variants
Actions
Plug-in Products
Other Products
Navigation
Toolbox