Steps and PreSteps

Required fields: Name, Type, SQL

Useful for validating a value. This Step type expects the provided SQL query to return a value of 1 in the first column if the check passes, otherwise any other value will be classed as a fail.

{
  "Type": "Check",
  "Name": "Item Exists",
  "SQL": "SELECT CASE WHEN COUNT(*) > 0 THEN 1 ELSE 0 END FROM ITM WHERE TenantID = :Tenant AND InstanceID = :InstanceID AND ItemCode = :ItemCode"
}

Required fields: Name, Type, SQL

Used to retrieve extra keys of data for use in later steps. This may be used in a case when an ItemCode is provided as an input to the page and you have a Get step to get the ItemID and ItemName for the item.

This step will take the first row of returned data and add each column of list of usable parameters with the key being the column name.

{
  "Type": "Get",
  "Name": "Get ItemID And Name",
  "SQL": "SELECT ITM.ItemID AS ItemID, ITM.ItemName AS ItemName FROM ITM WHERE TenantID = :Tenant AND InstanceID = :InstanceID AND ItemCode = :ItemCode"
}

Required fields: Name, Type, SQL, SaveTo

Used to retrieve a list of data for use in later steps. This may be used in a case where a PackSlipNumber is provided as an input to the page and you have a GetMultiple step to get all of the lines for the job.

This step will take all of the rows of returned data and save them into the parameters under the value of SaveTo.

{
  "Type": "GetMultiple",
  "Name": "Get Lines For Job",
  "SQL": "SELECT PCK1.ItemCode, PCK1.Quantity FROM PCK INNER JOIN PCK1 ON PCK.JobID = PCK1.JobID WHERE InstanceID = :InstanceID AND PackSlipNumber = :PackSlipNumber"
}

Required fields: Name, Type, SQL

A counterpart to the Get Step type, except this data will be returned and displayed to the user instead of being used as a parameter for future steps.

This may be used in a case where an ItemCode is provided as an input to the page and you have a Fetch step to get the ItemID and ItemName for the item.

{
  "Type": "Fetch",
  "Name": "Get ItemID And Name",
  "SQL": "SELECT ITM.ItemID AS ItemID, ITM.ItemName AS ItemName FROM ITM WHERE TenantID = :Tenant AND InstanceID = :InstanceID AND ItemCode = :ItemCode"
}

ENG 12215 Add a HTML prefix (HTML_) to output data column query results as HTML so that hyperlinks or image links can be used.

Required fields: Name, Type, SQL

Used to retrieve a list of data that will be returned and displayed to the user.

This may be used in a case where a PackSlipNumber is provided as an input to the page and you return the list of all lines on that job to the user.

{
  "Type": "Query",
  "Name": "Get Lines For Job",
  "SQL": "SELECT PCK1.ItemCode, PCK1.Quantity FROM PCK INNER JOIN PCK1 ON PCK.JobID = PCK1.JobID WHERE InstanceID = :InstanceID AND PackSlipNumber = :PackSlipNumber"
}

ENG 12215 Add a HTML prefix (HTML_) to output data column query results as HTML so that hyperlinks or image links can be used.

Required fields: Name, Type, SQL

Optional fields: InsertIDParameter

Used to execute an arbitrary piece of SQL where the return data does not matter.

This will be an INSERT or UPDATE query in most cases.

If you are inserting a record and you want its ID for use in a later query, the InsertIDParameter field can be provided with a value of the key to save the ID.

{
  "Type": "Command",
  "Name": "Update Attribute",
  "InsertIDParameter": "TestAttributeID",
  "SQL": "INSERT INTO ATR (ReferenceID, ReferenceType, AttributeName, AttributeValue) VALUES (111, 'PCK', 'TestAttribute', 'ValueHere')"
}

Required fields: Name, Type, SQL

Used to dynamically choose the next page for a PGE. The returned first column of the SQL should return a PageID or null. If the value is not null, it will be used in preference to the NextPage defined in the PageDefinition.

A use case for this is where you may want to process different order types down 2 different paths of PGE chaining based on the prefix of the PackSlipNumber.

{
  "Type": "NextPage",
  "Name": "Determine Next Page",
  "SQL": "SELECT CASE WHEN PackSlipNumber LIKE "SPEC%" THEN 111 ELSE null END FROM PCK WHERE InstanceID = :InstanceID AND JobID = :JobID"
}

Required fields: ExitParameter

Used to stop processing of page steps early if the value of the specified parameter in the ExitParameter field is 1. This should be used in combination with a Get step which will retrieve and set the parameter.

A use case for this is when a BinCode is a page input and the page steps will create cycle counts for all ULD1 lines in the BIN and then trigger an event on completion. If there are no ULD records in the BIN, we do not want to fire the trigger, so we should stop processing the page steps early.

{
  "ExitParameter": "HasULDs"
}

Required fields: Name, Type, Trigger, KeyParameter

Optional fields: PrinterParameter, PrinterCode, TenantIDParameter, TenantID, WarehouseIDParameter, WarehouseID

Conditional fields: ConnoteIDParameter

Used to trigger an event of the type specified in Trigger. KeyParameter should be the ID of the relevant record to that trigger type. For example, PCK_CREATE > JobID. This can be used to custom trigger events which will run EXP records watching the custom trigger.

PrinterParameter, TenantIDParameter and WarehouseIDParameter should be supplied if these values are to be sourced from parameter inputs where the value of these fields is the name of the parameter to use. Otherwise, these values can be hardcoded in to the step with PrinterCode, TenantID and WarehouseID.

If the trigger is CON_PRINTLABEL, the ConnoteIDParameter field should be provided. The value should be the parameter name to source the ConnoteID from.

{
  "Type": "Trigger",
  "Name": "Fire Dev Special Trigger",
  "Trigger": "DEV_SPECIAL",
  "KeyParameter": "JobID",
  "PrinterCode": "PrinterID",
  "TenantID": 11,
  "WarehouseID": 11
}

Required fields: Name, Type, ExportFileTypeName, ExportFileTypeFunction, ExportFileTypeFormat, ExportFileSaveDriver, ExportFileSavePath, DocumentKey

Optional fields: TenantIDParameter, TenantID, WarehouseIDParameter, WarehouseID, ExportFileTypeNameParameter, ExportFileTypeFunctionParameter, ExportFileTypeFormatParameter, ExportFileSaveDriverParameter, ExportFileSavePathParameter, DocumentKeyParameter

Used to send a file export. Most of the data here should mimic what is set in EXP. This adds the ability to fire off these independently of a trigger event and to dynamically iterate and send data to custom locations.

Each field can either be sourced as a static value or dynamically from the parameters. One of these must be provided but both are not needed. An example use case of using a parameter might be to send the file export to the email in the DeliveryEmail of the pack job.

{
  "Type": "ExportFile",
  "Name": "Send Pack Manifest",
  "ExportFileTypeNameParameter": "ExportNameParam",
  "ExportFileTypeFunction": "GenericSQL_123",
  "ExportFileTypeFormat": "XML",
  "ExportFileSaveDriverParameter": "DeliveryEmail",
  "DocumentKey": "JobID",
  "WarehouseID": 11
}

Required fields: Name, Type, SeriesID, ParameterName

Used to get the next value for a specified SeriesID and save it as a parameter to used under the name specified in ParameterName.

This is hand when you need to create records such as a PCK where you may wish to source the PackSlipNumber from a series.

{
  "Type": "Sequence",
  "Name": "Determine Next Page",
  "SeriesID": 111,
  "ParameterName": "NextPackSlipNumber"
}

Required fields: Name, Type, SQL, Steps

Optional fields: ElseSteps

Used to run Steps conditionally based on some sort of flag.

If SQL returns a result of 1, it will run the list of Steps. If it comes back with a result that is not 1, it will run the ElseSteps, if configured.

{
  "Type": "Subroutine",
  "Name": "Subroutine Example",
  "SQL": "SELECT CASE WHEN JobStatus = 'Completed' THEN 1 ELSE 0 FROM PCK WHERE PCK.JobID = :JobID",
  "Steps": [...]
}

Required fields: Name, Type, SQL, Steps

Optional fields: MaxLoopsParameter, MaxLoops

Used to repeat a set of Steps when a condition is true. It will continuously run the SQL query and if that returns a value of 1, it will then run the configured Steps. This will repeat until the SQL query returns 0 or the maximum number of loops is hit. The default is 100 times.

{
  "Type": "Loop",
  "Name": "Keep Picking!",
  "SQL": "SELECT CASE WHEN JobStatus != 'Completed' THEN 1 ELSE 0 FROM PCK WHERE PCK.JobID = :JobID",
  "Steps": [...]
}

There are a range of internal functions that are exposed to be accessible to PGEs to create completely custom workflows. Details on the usage for each internal function is available from the Development Team.

• Function_MoveULD

• Function_CreateULD

• Function_CalculateULDPutawayDestinations

• Function_CalculateShadowPackAllocation

• Function_UpsertGenericAttributeForRecord

• Function_UpsertItemAttribute

• Function_GetFromDimensioner

• Function_PrintItemLabel

• Function_PrintULDLabel

• Function_SetULDHoldStatus

• Function_TransferStock

• Function_UpdatePackJobCarrier

• Function_AdjustULDStock

• Function_Transports_HTTPPush

• Function_Transport_LabelPrint

• Function_Transports_Email

• Function_Transports_S3

• Function_Transports_SQS

• Function_CreatePackJobFromSalesOrder

• Function_GetSalesOrderLines

• Function_AddPickLineToPackJobWave

• Function_AddPickLineToPackJob

• Function_CreatePackLogisticUnit

• Function_AddPackLineToLogisticUnit

• Function_RecordPickFromULD

• Function_AddReceiptToReceiptingJob

• Function_AddReceiptToULD

• Function_CompletePackJob

  ENG 9358 Supported optional fields:

  • ConnoteNumberParmeter

  • CartonCountParameter

  • PalletCountParameter

  • PalletTypeParameter

  • QtyChepPalletsParameter

  • QtyLoscamPalletsParameter

  • QtyPlainPalletsParameter

  • ShipmentCubicParameter

  • ShipmentWeightParameter

  • TotalPaletHeightParameter

  • ArticleDataParameter

    This is an array which can contain multiple sets of:

    • LogisticUnitBoxTypeBarcodeParameter (optional)

    • LogisticUnitWeightParameter

    • LogisticUnitWidthParameter

    • LogisticUnitHeightParameter

    • LogisticUnitDepthParameter

• Function_CompleteWave

• Function_CreateAutoWave

  • param $ExtraFields can be used on the custom autowavers

• Function_AttemptCloseSalesOrder

• Function_UploadFile ENG 10569

  Required dynamic parameters to upload a file to the external storage:

  • DocumentKey - mandatory

  • DocumentType - mandatory, can also be defined statically on step

  • DocumentComment - can also be defined statically on step; backup text is PGE step

  • DocumentData - mandatory

  • DocumentPrefix

  • DocumentFormat

  • AllowedFormats

Output SQL results to display on the .wms webUI.

Parameters:

• Location - Banner (hardcoded)

• Colour - Success, Warning, Danger

• Returns the message from the first row of the SQL result which is then displayed in the banner on the .wms webUI.

{
  "Platforms": [
    "WEB"
  ],
  "Parameters": [
  ],
  "Steps": [
    {
      "Type": "Output",
      "Name": "Transfer Created",
      "SQL": " SELECT 'Success <a href=\"/?module=stock&submodule=profile&ItemID=\" target=\"_blank\">SNE704</a>'",
      "Location": "Banner",
      "Colour": "Success"
    },{
      "Type": "Output",
      "Name": "Transfer Created",
      "SQL": " SELECT 'Danger <a href=\"/?module=stock&submodule=profile&ItemID=\" target=\"_blank\">SNE704</a>'",
      "Location": "Banner",
      "Colour": "Danger"
    },
    {
      "Type": "Output",
      "Name": "Transfer Created",
      "SQL": " SELECT 'Warning <a href=\"/?module=stock&submodule=profile&ItemID=\" target=\"_blank\">SNE704</a>'",
      "Location": "Banner",
      "Colour": "Warning"
    },
    {
      "Type": "Output",
      "Name": "Transfer Created NOT SHOWN",
      "SQL": " SELECT 'WarningNOT <a href=\"/?module=stock&submodule=profile&ItemID=\" target=\"_blank\">SNE704</a>'",
      "Location": "DoesNotShow",
      "Colour": " Warning"
    }
  ]
}