diff --git a/next/404.html b/next/404.html index c35b120..560629a 100644 --- a/next/404.html +++ b/next/404.html @@ -461,6 +461,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Docs/Address/index.html b/next/Docs/Address/index.html index 8ed69dc..ae02917 100644 --- a/next/Docs/Address/index.html +++ b/next/Docs/Address/index.html @@ -482,6 +482,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Docs/Carrier_Service/index.html b/next/Docs/Carrier_Service/index.html index 0c133c2..8d13eb9 100644 --- a/next/Docs/Carrier_Service/index.html +++ b/next/Docs/Carrier_Service/index.html @@ -541,6 +541,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Docs/Database/index.html b/next/Docs/Database/index.html index e8f8188..5b882a7 100644 --- a/next/Docs/Database/index.html +++ b/next/Docs/Database/index.html @@ -552,6 +552,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Docs/Events/index.html b/next/Docs/Events/index.html index 0ca8e70..6c84029 100644 --- a/next/Docs/Events/index.html +++ b/next/Docs/Events/index.html @@ -591,6 +591,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Docs/FormPS1583/index.html b/next/Docs/FormPS1583/index.html index 4772fd8..71785c6 100644 --- a/next/Docs/FormPS1583/index.html +++ b/next/Docs/FormPS1583/index.html @@ -482,6 +482,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Docs/HTTP_API_Server/index.html b/next/Docs/HTTP_API_Server/index.html index 4106748..80d598c 100644 --- a/next/Docs/HTTP_API_Server/index.html +++ b/next/Docs/HTTP_API_Server/index.html @@ -12,7 +12,7 @@ - + @@ -552,6 +552,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Docs/HiddenConfigs/index.html b/next/Docs/HiddenConfigs/index.html new file mode 100644 index 0000000..3cef370 --- /dev/null +++ b/next/Docs/HiddenConfigs/index.html @@ -0,0 +1,1490 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Configuration Flags - PostalPoint Plugin Development + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    + +
    + + + + + +

    Configuration Flags

    +

    In the Advanced settings of PostalPoint, there is a tool to manually get and set settings by ID.

    +

    Most PostalPoint settings are available in the Settings screen, and their IDs can be found in the JSON file created by running a database backup.

    +

    However, there are some special "hidden" setting options that can override default behavior.

    +

    Warning: PostalPoint is tested with these settings at their default values (usually, unset). There is a small chance of bugs being created by changing a value.

    +
      +
    • approved_shipper_receipt_disclaimer: Set non-empty to add a disclaimer on printed receipts: "Note: A non-postal surcharge was added to x items"
      • +
    • disable_hid_feedback: Set non-empty to skip sending scan feedback commands (error beep, etc) to the USB HID POS barcode scanner.
      • +
    • disable_keyboard_shortcuts: Set non-empty to disable the Function key row keyboard navigation shortcuts.
      • +
    • disablesettingsbackup: Set non-empty to skip backing up settings with the database.
      • +
    • dymo_twin_roll_selection: Set label roll selection when using a Dymo twin label printer: 0=auto, 1=left, 2=right, default is 1.
      • +
    • easypost_allow_wallet_billing: Set truthy to allow EasyPost wallet accounts with TOS that restricts resale.
      • +
    • mailboxslipoverride: Change the print size of a mailbox package slip, which is normally 4x6, but defaults to 4x3 when using a QL label printer and DK2243 labels. Set to "4x6" or "4x3" to force a size.
      • +
    • mute_sounds: Set non-empty to disable sound effects.
      • +
    • postalpoint_lan_server_port: Override the port used for the internal web server. This must match on all installations that need to communicate.
      • +
    • postalpoint_lan_server_bind_address: Override the IP address to bind the internal web server to. Default is "0.0.0.0".
      • +
    + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/next/Docs/Parcel/index.html b/next/Docs/Parcel/index.html index 5e371ad..8a56e64 100644 --- a/next/Docs/Parcel/index.html +++ b/next/Docs/Parcel/index.html @@ -9,7 +9,7 @@ - + @@ -470,6 +470,34 @@ + + +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + diff --git a/next/Docs/Receipt/index.html b/next/Docs/Receipt/index.html index 9e05efb..7b72f2e 100644 --- a/next/Docs/Receipt/index.html +++ b/next/Docs/Receipt/index.html @@ -472,6 +472,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Docs/ReceiptPrinter/index.html b/next/Docs/ReceiptPrinter/index.html index 834a9ec..50321eb 100644 --- a/next/Docs/ReceiptPrinter/index.html +++ b/next/Docs/ReceiptPrinter/index.html @@ -472,6 +472,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Docs/TrackingBarcode/index.html b/next/Docs/TrackingBarcode/index.html index 1fb2c89..49fed55 100644 --- a/next/Docs/TrackingBarcode/index.html +++ b/next/Docs/TrackingBarcode/index.html @@ -472,6 +472,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Examples/01Minimal/index.html b/next/Examples/01Minimal/index.html index 0ad45e2..e6fd84b 100644 --- a/next/Examples/01Minimal/index.html +++ b/next/Examples/01Minimal/index.html @@ -470,6 +470,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Examples/02Basic/index.html b/next/Examples/02Basic/index.html index 0b72227..e681759 100644 --- a/next/Examples/02Basic/index.html +++ b/next/Examples/02Basic/index.html @@ -470,6 +470,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Examples/03Shipping/index.html b/next/Examples/03Shipping/index.html index a79a06b..c2f804a 100644 --- a/next/Examples/03Shipping/index.html +++ b/next/Examples/03Shipping/index.html @@ -470,6 +470,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Examples/04CardProcessor/index.html b/next/Examples/04CardProcessor/index.html index 9290530..f5dc310 100644 --- a/next/Examples/04CardProcessor/index.html +++ b/next/Examples/04CardProcessor/index.html @@ -470,6 +470,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Examples/05CryptoProcessor/index.html b/next/Examples/05CryptoProcessor/index.html index ef7a1a9..97a2553 100644 --- a/next/Examples/05CryptoProcessor/index.html +++ b/next/Examples/05CryptoProcessor/index.html @@ -470,6 +470,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Plugin API/barcode/index.html b/next/Plugin API/barcode/index.html index 211cc4f..fb30181 100644 --- a/next/Plugin API/barcode/index.html +++ b/next/Plugin API/barcode/index.html @@ -470,6 +470,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • @@ -959,6 +987,17 @@ +
    • + +
  • + + + + barcode.registerDropOffCarrierScanHandler(carrier, fn) + + + +
    • @@ -1553,6 +1592,17 @@ + + +
  • + + + + barcode.registerDropOffCarrierScanHandler(carrier, fn) + + + +
    • @@ -1592,6 +1642,7 @@
  • .addPrepaidBarcode(trackingBarcodeData)
  • .inject(barcodeData)
  • .onPrepaidScan(f)
    • +
  • .registerDropOffCarrierScanHandler(carrier, fn)
    • @@ -1767,6 +1818,51 @@ If the barcode is handled by this function, it shall return a TrackingBarcode ob +

    +

    barcode.registerDropOffCarrierScanHandler(carrier, fn)

    +

    Register to handle prepaid drop off scans for a particular shipping carrier. +Scans are kept in a local, disk-backed queue and the function registered here will be +called when a queued barcode is processed for the provided carrier. +This function is intended for carrier drop-off reimbursement programs such as ASO and FASC.

    +

    Kind: static method of barcode
    +Throws:

    + + + + + + + + + + + + + + + + + + + + + +
    ParamTypeDescription
    carrierstringCarrier name to register for.
    fnfunctionAsync function to pass scan details to. Returns true if processed, false if not processed (but the barcode should be removed from queue), or throws an Error if it should be retried later. See example for data and usage.
    +

    Example
    +

    global.apis.barcode.registerDropOffCarrierScanHandler("FedEx", function (data) {
+    global.apis.alert(`Carrier: ${data.carrier}, Tracking number: ${data.tracking}, `
+        + `Raw scanned barcode: ${data.barcode}, `
+        + `UNIX timestamp of scan: ${data.timestamp}, Scan UUID: ${data.uuid}`,
+        "Processing DropOffCarrierScan data");
+
+    return false; // Not processed but should be discarded
+    return true; // Processed, discard from queue
+    throw new Error("Failed to process, try again later");
+});
+

    diff --git a/next/Plugin API/database/index.html b/next/Plugin API/database/index.html index 2614b15..df470ea 100644 --- a/next/Plugin API/database/index.html +++ b/next/Plugin API/database/index.html @@ -470,6 +470,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Plugin API/fs/index.html b/next/Plugin API/fs/index.html index bd004cd..8c581d2 100644 --- a/next/Plugin API/fs/index.html +++ b/next/Plugin API/fs/index.html @@ -470,6 +470,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Plugin API/global functions/index.html b/next/Plugin API/global functions/index.html index 4765507..1b554fd 100644 --- a/next/Plugin API/global functions/index.html +++ b/next/Plugin API/global functions/index.html @@ -470,6 +470,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Plugin API/graphics/index.html b/next/Plugin API/graphics/index.html index 510d276..adc4194 100644 --- a/next/Plugin API/graphics/index.html +++ b/next/Plugin API/graphics/index.html @@ -470,6 +470,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • diff --git a/next/Plugin API/httpserver/index.html b/next/Plugin API/httpserver/index.html index cfe882a..e4fafd5 100644 --- a/next/Plugin API/httpserver/index.html +++ b/next/Plugin API/httpserver/index.html @@ -470,6 +470,34 @@ +
  • + + + + + + + + Configuration Flags + + + + + + + + +
    • + + + + + + + + + +
  • @@ -1607,7 +1635,7 @@ installations of PostalPoint on the LAN.

    httpserver.sendRequestToRemote(data, endpointID, serverAddress, serverPort) ⇒ Promise.<Object>

    Send a HTTP request to another PostalPoint installation on the local network.

    Kind: static method of httpserver
    -Returns: Promise.<Object> - - The JSON reply.
    +Returns: Promise.<Object> - The JSON reply.
    Throws: