Custom (Hooks) Parameter Group

The Order Manager includes hundreds of System Parameters that can be used to tailor the program to a merchant's way of doing business. To change a system parameter, go to the Maintenance Menu and double-click "Set System Parameters" from the list of links, or select System Parameters from the Quick Clicks on the Main Menu. For instructions, review the Knowledge Base page, Set System Parameters.

For ease of use, the system parameters are divided into "Parameter Groups" with related functions. This article describes the parameters that are part of the Custom (Hooks) parameter group.

There is no written documentation for the Custom Programming Interface at this time, however, it is possible to purchase training time to speak with a developer or technical support representative, if you are interested in using this feature. Contact Stone Edge Tech Sales or Support at 610-994-3699.

 

Parameter Name

Comments

CustomAdjustInventoryCall

Optional. Name of function in custom module that program should call when any AdjustQOH button is clicked.

CustomAfterAutoApproveCall

Optional. Name of function in custom module that program should call after an order is automatically approved with the AutoApprove function.  This does not occur when processing orders on import. Requires CustomModuleDatabase and CustomModuleName.

CustomAfterImportCall

Optional. Name of function in custom module that program should call as the last step after importing orders from a shopping cart.

CustomAfterImportTrackNumCall

Optional. Name of function in custom module that program should call after each tracking number is processed by the Import CSV Tracking Numbers form.

CustomAfterPackSKUCall

Name of custom function to call prior to marking a SKU as "packed" in Pack Orders. No Arguments passed in the function call. The following global variables will be available:

Formvar = Which SKU has been packed

Formvar3 = OM Order # being packed

CustomAfterProcessOrderCall

Optional. Name of function in custom module that program should call as the last step when processing imported orders.

CustomAfterReadScaleCall

Optional. Name of function in custom module that program should call after reading an electronic scale at Pack & Ship.

CustomAllowedToCall

Optional. Name of function in custom module that program should call before performing misc. functions, e.g. Return, Exchange, Add/Edit line item, edit CC info, etc. at View Orders form. Requires CustomModuleDatabase and CustomModuleName.

CustomAuditFunction

Custom function to call after the audit report is printed when the Print button is clicked on the Daily Audit form.

CustomBatchPrintForm

Name of form to use in place of the Batch Print form

CustomBeforeStatusUpdateCall

Name of custom function to call prior to updating the status of orders or line items. No Arguments passed in the function call. The following global variables will be available:

Formvar = Which Event has been called (See Status Events table)(required)

Formvar2 = Order Number affected (required)

FormVar3 = Line Item Number (optional if 0)

FormVar4 = T/F to update all line items (usually if updating an order event) (Optional)

Formvar5 = Order Status as pulled from Status Events table or passed to function (optional if null)

Formvar6 = Line Item Status as pulled from Status Events table or passed to function (optional if null)

FormVar7 = Notes for the order status change (optional)

FormVar8 = notes for the Line Item status Change (optional)

FormVar9 = T/F to send to SETI Website (optional)

CustomCarrierPackAndShipCall

Lets you use custom carriers at Pack & Ship. If the shipping method has a LabelTemplate, you can also print shipping labels for it.

CustomChangeSKUCall

Optional. Name of function in custom module that program should call right before processing each line item from new imported orders. XML imports only.

CustomCreditCardButtonCall

Name of custom function to call when custom function button at Credit Card form is clicked. Requires CustomCreditCardButtonLabel, CustomModuleDatabase and CustomModuleName.

CustomDropShipCall

Optional. Name of function in custom module that program should call when any of the "order drop ship" buttons at View Orders is clicked.

CustomFillBackOrdersCall

Optional. Name of function in custom module that program should call when Fill Backorders button is clicked.

CustomFillOrderCall

Optional. Name of function in custom module that program should call when processing orders to check & update inventory, etc..

CustomFormDatabase

Name of Access database where custom forms are located. Optional. Must be located in same directory as store's Order Manager database.

CustomFulfillmentCall

Function to call for sending fulfillment orders.

CustomImportFunction

Name of custom function to call for importing orders. Leave blank to use standard import function.

CustomMainMenu

Name of custom form to use in place of standard Main Menu.

CustomMainMenuCall

Custom function call to conditionally load a form at startup. Function should return the form name, otherwise the system will look at the CustomMainMenu parameter to load a specific form other than Main Menu. If both parameters not set the Main Menu will load.

CustomManualAfterAddItemCall

Name of Custom Function to run after a line item is added to a Manual Order. Variables Passed: Formvar = item number added

CustomManualAfterApprovalCall

Optional. Name of function in custom module that program should call after manually approving an order. Requires CustomModuleDatabase and CustomModuleName.

CustomManualAfterSaveCall

Optional. Name of function in custom module that program should call after saving a manually-entered order. Requires CustomModuleDatabase and CustomModuleName.

CustomManualAfterUnApprovalCall

Optional. Name of function in custom module that program should call after manually un-approving an order. Requires CustomModuleDatabase and CustomModuleName.

CustomManualApprovalCall

Optional. Name of function in custom module that program should call before manually approving an order. Requires CustomModuleDatabase and CustomModuleName.

CustomManualApprovalForm

Name of form that appears after saving an order at the Manual Orders form. Leave blank if you do not want a form to open at that time.

CustomManualButton1Call

Name of custom function to call when custom function button #1 at Manual Orders form is clicked. Requires CustomManualButton1Label, CustomModuleDatabase and CustomModuleName.

CustomManualButton1Label

Label for custom function button #1 at Manual Orders form. See CustomManualButton1Call.

CustomManualButton2Call

Name of custom function to call when custom function button #2 at Manual Orders form is clicked. Requires CustomManualButton2Label, CustomModuleDatabase and CustomModuleName.

CustomManualButton2Label

Label for custom function button #2 at Manual Orders form. See CustomManualButton2Call.

CustomManualButton3Call

Name of custom function to call when custom function button #3 at Manual Orders form is clicked. Requires CustomManualButton3Label, CustomModuleDatabase and CustomModuleName.

CustomManualButton3Label

Label for custom function button #3 at Manual Orders form. See CustomManualButton3Call.

CustomManualOrdersForm

Name of form to use for entering Manual Orders

CustomManualSaveCall

Optional. Name of function in custom module that program should call before saving a manually-entered order. Requires CustomModuleDatabase and CustomModuleName.

CustomManualSetupCall

Call used when Manual Orders form is opened, and each time the form is cleared for a new order.

CustomModuleDatabase

Name of database where custom modules are located. Used with CustomManualButton1Call, CustomModuleName, etc. Optional. Must be located in same directory as store's Order Manager database.

CustomModuleName

Name of module in external database (specified in CustomModuleDatabase) that should be loaded into current .mdb.

CustomOrderButton1Call

Name of custom function to call when custom function button #1 at main Orders form is clicked. Requires CustomOrderButton1Label, CustomModuleDatabase and CustomModuleName.

CustomOrderButton1Label

Label for custom function button #1 at main Orders form. See CustomOrderButton1Call.

CustomOrderButton2Call

Name of custom function to call when custom function button #2 at main Orders form is clicked. Requires CustomOrderButton2Label, CustomModuleDatabase and CustomModuleName.

CustomOrderButton2Label

Label for custom function button #2 at main Orders form. See CustomOrderButton2Call.

CustomPOSAfterAddItemCall

Name of Custom Function to run after a line item is added to a POS Order (New POS Only). Variables passed:

Formvar = Item Number Added

FormVar2 = Order Number

FormVar3 = Store ID Number

CustomPreAllocationCall

Call to custom function to review order prior to inventory allocation (NEW IMPORT SYSTEM ONLY!)

CustomPreAllocationRulesCall

Call to custom function to review order after inventory allocation but before approval rules applied (NEW IMPORT SYSTEM ONLY!)

CustomPreApprovalRulesCall

Call to custom function to review order prior to approval rules being called (NEW IMPORT SYSTEM ONLY!)

CustomPreCardProcessingCall

Call to custom function to review order prior to card processing (NEW IMPORT SYSTEM ONLY!)

CustomPreCardRulesCall

Call to custom function to review order after card processing but before approval rules (NEW IMPORT SYSTEM ONLY!)

CustomProcessOrderCall

Optional. Name of function in custom module that program should call when processing imported orders.

CustomRefillCall

Optional. Name of function in custom module that program should call to check inventory for orders added with the ReOrder button at View Orders.

CustomReturnFunction

Custom function to call when items are returned to inventory due to Return, Exchange, Cancel/Delete line item or order, Revise, Force Backorder, etc.

CustomShippingFunction

Name of custom function to call for calculating shipping charges. Leave blank to use standard shipping calculations.

CustomStartupCall

Optional. Name of function in custom module that program should call on initial entry into Order Manager, or whenever store is opened.

CustomStatusUpdateCall

Optional. Name of function in custom module that program should call when order status is changed by Status Update rules or manually.

CustomYahooProductImportCall

Name of custom function to call for importing products from Yahoo.

EditCustomerForm

Form to open when user clicks Add or Edit at View Customers form.

HoursToGMT

Number of hours to add or subtract to get to Greenwich Mean Time

PackingFormFilter

Normally left blank. Sets special filter for use at Packing Form. Example: Option10='ID'

ShowHiddenParms

Show special parameters that are only required for custom installations?

SpecialMenu

An entry here adds a button to the Main Menu, provides the caption for the button, and is also the name of the form to open when the button is clicked

SRUsePriceOffer

Custom Parameter for one client. Leave set to False!

StartupAppIcon

Full pathname of Icon to use for program

StartupAppTitle

Title to display on main window's title bar

StartupGraphic

Full pathname of graphic to use on Splash screen instead of standard graphics. This will be a static image - no animation.

StartupHideToolbars

Set to TRUE to hide all of Access' tool bars

StartupMenuBar

Name of menu bar to display. Should usually be empty. To hide standard Access menu bar, set to "Order Manager Menu" (without the quotes).

StripHTMLFromName

Remove HTML tags from Product Names as they are imported from your shopping cart?

StripSKU

For special sites that have Supplier ID in parentheses at end of each SKU

StripSKUDelimiter

Order Manager will strip any characters to the left of the character entered here from an incoming SKU prior to building sub-SKUs.

ViewCustomersForm

Form to open when user clicks View Customers at Main Menu

 

 

Created: 10/6/11

 

 

 

Go to Top