Administration parameters control key behaviors and features in the InStore Center. You manage these parameters in parameter sets, which you assign to environments, locations, or workstations.
New parameters are deactivated by default. To use a new parameter, activate it in one or more of your parameter sets.
Each environment must have a fallback parameter set. You can override this fallback with temporary parameter sets at the environment, location, or workstation level.
Most parameters are set as
Immutable by default. You can toggle this setting off when adding the parameter to a set. If a parameter is immutable at the environment level, you cannot override its value at the location level. Assigning a different value at the location does not override the original value.The InStore application loads parameter sets each time it launches.
Some administration parameters are referenced directly by InStore modules. Others are applied server-side and are not referenced in any module.
Cash management
| Parameter | Description | Default |
|---|---|---|
Blind_Count | If true, hides expected totals during a cash count. | true |
Drawer_Reserve_Amount | Expected float amount for a cash drawer. Reserved from a safe deposit. | 50.00 |
Minimum_Drawer_Cash | Minimum cash to maintain in a cash drawer. | 20.00 |
Safe_Reserve_Amount | Expected float amount for the business day. Reserved from a bank deposit. | 1000.00 |
Summary_or_Detail_Count | Controls whether to enter a detailed count of each denomination or a total during a cash count. Also affects the bank deposit receipt format. Only detail is currently available. | detail |
General
| Parameter | Description | Default |
|---|---|---|
Enable_Device_Bar | Deprecated. The device bar is no longer supported. | - |
Initial_Timeout | Minutes after login before a session timeout warning appears. Users can extend their session. | 25 |
Maximum_Cash_Drawer_Retries | Number of times a user must press OK before a prompt asks, Is the cash drawer closed? No/Yes. Set to 0 if the cash drawer is not connected to the printer. Set to 1, 2, or 3 if connected and you want to wait for the closed-drawer indicator. For more information about cash drawer setup, see Device configuration for cash management. | 3 |
Maximum_Timeout | Minutes after login before the session times out automatically, with no further extension. | 30 |
Reminder_Timeout | Minutes of inactivity before another session timeout warning appears. | 2 |
Supported_Languages | Reserved for future use. | - |
Print
| Parameter | Description | Default |
|---|---|---|
Allow_Defaulted_Customer_Email_Override | If true, customers can override the pre-filled email address on the receipt delivery page. The override applies only to the current order. The substitute email address provided by the customer does not update their record. This parameter is relevant only if a customer is attached to the transaction and if an email address for the customer is retrieved. | true |
Allow_Defaulted_Customer_Phone_Override | If true, users can override the pre-filled phone number for SMS/text receipt delivery. The override applies only to the current order. The substitute phone number provided by the customer does not update their record. This parameter is relevant only if a customer is attached to the transaction and if a phone number for the customer is retrieved | true |
Enable_Printer | Enables printing with a physical printer. If true, set Simulate_Printer to false. | true |
Print_Receipt_for_Bank_Deposit | If true, sends the bank deposit receipt to the default printer and displays it online. If false, displays online only. | false |
Print_Receipt_for_Cash_Count | If true, prints a receipt for cash counts. | false |
Print_Receipt_for_Cash_In | If true, prints a receipt for cash-in transactions. If false, displays online only. | false |
Print_Receipt_for_Cash_Out | If true, prints a receipt for cash-out transactions. If false, displays online only. | false |
Print_Receipt_for_Cash_Transfer_In | If true, prints a receipt for cash transfer-in transactions. If false, displays online only. | false |
Print_Receipt_for_Cash_Transfer_Out | If true, prints a receipt for cash transfer-out transactions. If false, displays online only. | false |
Print_Receipt_for_Nullified_Payment | If true, prints a paper chit after a payment is denied or nullified. | false |
Print_Receipt_for_Safe_Deposit | If true, prints a receipt for safe deposit transactions. If false, displays online only. | false |
Prompt_for_Gift_Receipt | If true, displays a checkbox to generate a gift receipt during checkout or when reprinting a receipt. Uses the configured Gift_Receipt_Template. | true |
Receipt_Print_Options | Available receipt options: Paper (printer), Email, Text, or None. | Paper, Email, None |
Simulate_Cashdrawer | If true, displays an on-screen simulator for cash drawer activities. If you simulate opening the cash drawer, you must also confirm when it is closed to continue with further cash management actions. Requires Simulate_Printer. See Device configuration for cash management. | false |
Simulate_Printer | If true, displays an on-screen simulator for printer activities. Set to true only if Enable_Printer is false. See Device configuration for cash management. | false |
Refund
| Parameter | Description | Default |
|---|---|---|
Allow_Unreferenced_Credit_Refunds | If true, allows refunds to credit cards not used in the original transaction. | false |
Cash_Refund_Threshold | Amount below which cash is refunded (if allowed), instead of the default tender. | 20.00 |
Gift_Receipt_Refund_Options | Allowed tender types for gift receipt refunds: Cash, Voucher, Credit, Debit, Wallet. | Cash, Voucher |
Max_Gift_Receipted_Cash_Refund | Maximum cash refund amount with a gift receipt. | 100.00 |
Max_Unreceipted_Cash_Refund | Maximum cash refund amount without a receipt. | 50.00 |
Receipted_Refund_Options | Allowed tender types for receipted refunds: Cash, Voucher, Credit, Debit, Wallet, and Pay on Account. | Cash, Voucher |
Unreceipted_Refund_Options | Allowed tender types for unreceipted refunds: Cash, Voucher, Credit, Debit, Wallet. | Cash, Voucher |
Store Front
| Parameter | Description | Default |
|---|---|---|
Allow_Add_Coupon | If true, authorized users can enter a coupon code for a cart. | false |
Allow_Amount_Off_Line_Item | If true, authorized users can enter an amount-off discount on a payment line item. Limited by Maximum_Percent_Off_Line_Item. | true |
Allow_Order_Item | If true, authorized users can order items for delivery or pickup. Enabled only for users with the OrderItems permission. | true |
Allow_Payment_Line_Item_Delete | If true, authorized users can delete a payment line item and its quantity from the cart via InStore colleague app. | true |
Allow_Percent_Off_Line_Item | If true, authorized users can enter a percent-off discount on a payment line item via InStore colleague app. Limited by Maximum_Percent_Off_Line_Item. | true |
Allow_Price_Change_On_Line_Item | If true, authorized users can change the price on a payment line item via InStore colleague app. The change cannot exceed the Maximum_Percent_Off_Line_Item value. | true |
Allow_Receipted_Return | If true, authorized users can return item quantities from a retrieved sale/order transaction. Enabled only for users with the ReceiptedReturns permission. The RETURN ITEM option is displayed on Transaction Search results page. | true |
Allow_Refund_Line_Item_Delete | If true, authorized users can delete a refund/return line item from the cart via InStore colleague app. | true |
Allow_Remove_Cart | If true, displays the option to remove the current cart and attached customer. | false |
Allow_Resume_Cart | If true, authorized users can retrieve in-progress carts previously suspended in this store. Requires Allow_Suspend_Cart. This is available only if the Suspend and Retrieve feature is enabled for your account. | false |
Allow_Save_Cart_As_Wishlist | If true, authorized users can save a cart as a wishlist to a customer's account. | false |
Allow_Save_Item_To_Wishlist | If true, authorized users can save an item to a wishlist on a customer's account. | false |
Allow_Sell_Item | If true, authorized users can sell items as a take-with sale. To hide the Add to Sale option, set this to false and set Default_Scan_Mode to Order. | true |
Allow_Suspend_Cart | If true, authorized users can suspend an in-progress cart for later retrieval. Requires Allow_Resume_Cart. This is available only if the Suspend and Retrieve feature is enabled for your account. | false |
Allow_Unreceipted_Return | If true, authorized users can refund an item without retrieving the original transaction by selecting the RETURN ITEM option in the item detail view of the InStore colleague app. Enabled only for users with the UnreceiptedReturns permission. | true |
Automatic_Logout_After_Financial_Transaction | If true, logs out the user after payment, refund, or cash management transactions on shared workstations. If false, the user remains logged in. | false |
Capture_Suspend_Cart_Identifier | If true, prompts for an identifier during the suspend process. Honored only if the Suspend and Retrieve feature is enabled. | false |
Collected_Shipping_Address_Info | Shipping address fields displayed when ringing up an order. Use Required_Shipping_Address_Info to specify required fields. | country, title, salutation, firstName, lastName, streetName, streetNumber, additionalStreetInfo, postalCode, city, region, state, company, department, building, apartment, pOBox, additionalAddressInfo |
Default_Scan_Mode | Default cart type for scanned items. Options: Sale, Order, or Return. To hide Add to Sale, set to Order and set Allow_Sell_Item to false. | Sale |
Enable_Soft_Login_with_PIN | If true, allows users to log in with a 4-digit PIN (soft login). If false, users must log in with username and password after logout. | false |
Mask_Soft_Login_PIN | If true, masks PIN digits with asterisks. Requires Enable_Soft_Login_with_PIN to be true. | false |
Maximum_Percent_Off_Line_Item | Maximum percent discount allowed on a payment line item. Enter a value from 1 to 100. Also limits amount-off and price change discounts. | 20 |
Required_Shipping_Address_Info | Shipping address fields required when ringing up an order. Use Collected_Shipping_Address_Info to define all fields shown. | country, firstName, lastName, streetName, streetNumber, postalCode, city |
Soft_Login_Expiration_Time | Number of seconds before the app times out after soft login. | 480 (8 minutes) |
Tender
Pay by Link and Pay on Account are not enabled by default. To accept these tenders, contact the InStore support team.
| Parameter | Description | Default |
|---|---|---|
Allow_Disconnected_Cash_Drawer_Override | Reserved for future use. Do not set to true. | false |
Allow_Exchange | Reserved for future use. Do not set to true. | false |
Automatically_Capture_Order_Payments | If true, captures card payments for orders at the time of sale. If false, captures when the order ships. | true |
Cards_Accepted | If true, accepts credit and debit cards for payment. | true |
Cash_Accepted | If true, accepts cash for take-with sales. Requires a registered printer and cash drawer. | true |
Cash_Rounding_Mode | Method for cash rounding: None (no rounding), Up (round up), Down (round down), Even (round to nearest). Applies only to cash tenders. | None |
Digital_Wallets_Accepted | If true, accepts digital wallets for payment. | true |
Gift_Cards_Accepted | If true, accepts gift cards (vouchers) for payment. | true |
Maximum_Cash_Accepted | Maximum cash accepted per transaction. | 2000.00 |
Minimum_Card_Amount_Accepted | Minimum amount accepted for credit/debit card payment. | 0.00 |
Maximum_Gift_Card_Accepted | Maximum gift card (voucher) amount accepted per transaction. | 1000.00 |
Order_Payment_Options | Allowed tender types for orders: Cash, Voucher, Credit, Debit, Wallet, Pay on Account. Requires printer and cash drawer for cash. | Credit, Debit, Voucher |
Pay_By_Link_Accepted | If true, accepts Pay By Link for payment. This is available only when a valid business Customer is attached to the Cart. | false |
Pay_By_Link_Minimum_Amount_Due | Minimum cart amount required for Pay By Link to be available. | 0.00 |
Pay_By_Link_Split_Tender | If true, allows Pay By Link to be combined with other tenders. | false |
Pay_On_Account_Accepted | If true, enables Pay On Account tender type. | false |
Pay_On_Account_Minimum_Amount_Due | Minimum amount due before Pay On Account is available. Requires a valid business-account customer. | 00.00 |
Pay_On_Account_Split_Tender | If true, allows Pay On Account to be combined with other payment types. | false |
Prompt_for_Purchase_Order_POA | If true, prompts for a purchase order number during Pay on Account checkout. Saves the number to Composable Commerce and displays it in Merchant Center. | false |
Relabel_QuickPay_ExactAmount | If true, changes the button label on the Cash payment QuickPay screen to custom text (for example, Exact Change). To update the text, edit the cashCollectionExactChange value in the translation.json file in the mist/client folder. If false, displays the calculated exact amount due. | false |