Administration parameters configure key features and functions of the InStore colleague app.
Copy for LLM
View as Markdown
Administration parameters are set in the InStore Center and control key features and functions of InStore, allowing you to customize your integration via a business tool. For example, you can set which tenders to accept, the minimum amount of cash to store in a cash drawer, or when to print receipts. Parameters are categorized into the following:
- Cash management parameters
- General parameters
- Print parameters
- Refund parameters
- Store Front parameters
- Tender parameters
To use administration parameters, create one or more parameter sets in the InStore Center. Each environment must have at least one default parameter set. You can add additional sets to override values in the default parameter set at the environment, location, or workstation level. For example, you might set a default value of $20.00 for
Drawer_Reserve_Amount at the environment level, then create a workstation-level parameter set to override it to $100.00 for a workstation that handles returns and requires a larger float.Some parameters are set as
Immutable by default, which means they cannot be overwritten by another parameter set. 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.
New parameters are deactivated by default. To use a new parameter, activate it in one or more of your parameter sets.
Cash management parameters
Cash management parameters control cash handling processes, such as managing cash counts, drawer floats, and safe reserves, and include the following:
| 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 parameters
General parameters control operational settings for the application, including session timeouts and device-related configurations, and include the following:
| 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 parameters
Print parameters control the management of printing functionalities, such as enabling a physical printer or altering receipt formats, and include the following:
| 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 parameters
Refund parameters control configurable options for processing refunds, including thresholds for cash refunds and accepted tender types, and include the following:
| 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 parameters
Store Front parameters control various front-end actions and user permissions, such as applying discounts and managing item returns, and include the following:
| Parameter | Description | Default |
|---|---|---|
Allow_Add_Coupon | Determines whether authorized users can enter a coupon code to apply to a cart—for example, to a sale cart or order cart. | false |
Allow_Amount_Off_Line_Item | Determines whether authorized users can enter an amount-off discount on a payment line item in the InStore colleague app; limited by the Maximum_Percent_Off_Line_Item value. | true |
Allow_Order_Item | Determines whether authorized users can order items for delivery or pickup instead of a take-with sale. If true, the item detail view (in the InStore colleague app catalog) displays the ORDER ITEM option. This option is enabled only for users whose role includes the OrderItems permission. | true |
Allow_Manage_Cash | If set to true, users authorized by role can access features within the Manage Cash menu option. The Manage Cash user interface is administrative in nature and is not optimized for small screen sizes. | true |
Allow_Manage_Devices | If set to true, users authorized by role can access features within the Manage Devices menu option. The Manage Devices user interface is administrative in nature and is not optimized for small screen sizes. | true |
Allow_Payment_Line_Item_Delete | Determines whether authorized users can delete a payment line item (including its quantity) from the cart in the InStore colleague app. | true |
Allow_Percent_Off_Line_Item | Determines whether authorized users can enter a percent-off discount on a payment line item in the InStore colleague app; limited by the Maximum_Percent_Off_Line_Item value. | true |
Allow_Price_Change_On_Line_Item | Determines whether authorized users can change the price on a payment line item in the InStore colleague app. For a given line item, the amount of change cannot exceed the Maximum_Percent_Off_Line_Item calculation. For example, if an item costs 40 and the maximum percent is set to 20%, then the maximum possible discount is 8. | true |
Allow_Receipted_Return | Determines whether authorized users can return item quantities from a retrieved purchasing sale/order transaction. If true, the RETURN ITEM option is displayed on Transaction Search results page. This option is enabled only for users whose role includes the ReceiptedReturns permission. | true |
Allow_Refund_Line_Item_Delete | Determines whether authorized users can delete a refund/return line item (including its quantity) from the cart in the InStore colleague app. | true |
Allow_Remove_Cart | If true, displays the option that allows the user to remove the current cart and attached Customer to prepare for the next shopper’s cart. | false |
Allow_Resume_Cart | Determines whether authorized users can retrieve in-progress carts that were previously suspended in this store. Use this in combination with the Allow_Suspend_Cart parameter. The true setting is honored only if your organization uses the controlled feature Suspend and Retrieve. | false |
Allow_Save_Cart_As_Wishlist | Determines whether authorized users can save a cart of sale/order items as a named wishlist to an attached Customer's account. | false |
Allow_Save_Item_To_Wishlist | Determines whether authorized users can save a selected item quantity to a new or existing wishlist on an attached Customer’s account. | false |
Allow_Sell_Item | Determines whether authorized users can sell items as a take-with (cash and carry) sale. To hide the Add to Sale option in the InStore colleague app, set this parameter to false and set the Default_Scan_Mode parameter to Order. | true |
Allow_Suspend_Cart | Determines whether authorized users can set aside an in-progress cart to retrieve for more processing later in this store; used in combination with the Allow_Resume_Cart parameter. The true setting is honored only if your organization uses the controlled feature Suspend and Retrieve. | false |
Allow_Unreceipted_Return | Determines whether authorized users can refund an item quantity without retrieving the purchasing sale/order transaction. If true, the item detail view (in the InStore colleague app catalog) displays the RETURN ITEM option. This option is enabled only for users whose role includes the UnreceiptedReturns permission. | true |
Automatic_Logout_After_Financial_Transaction | Determines whether the system logs the user out after payment, refund, and cash management transactions when a workstation is shared by multiple cashiers. If false, the user remains logged in for the next transaction. | false |
Capture_Suspend_Cart_Identifier | Determines whether an identifier is requested during the suspend process of the Suspend and Retrieve feature. If true, the user receives a prompt for a scanned or typed identifier that must be presented later during the retrieval process. The true setting is honored only if your organization uses the Suspend and Retrieve controlled feature. If false, no prompts are generated. | false |
Collected_Shipping_Address_Info | Determines the shipping address fields that are displayed when the user rings up an order for a guest or attached Customer. Use the Required_Shipping_Address_Info parameter to specify which fields are required. | country, title, salutation, firstName, lastName, streetName, streetNumber, additionalStreetInfo, postalCode, city, region, state, company, department, building, apartment, pOBox, additionalAddressInfo |
Default_Scan_Mode | Controls the default cart type to which scanned exact-match items are added. The user can choose to place a scanned item into a different cart type, if available. To hide the Add to Sale option in the InStore colleague app, set this parameter to Order and set the Allow_Sell_Item parameter to false. Available options are: Sale, Order, or Return. | Sale |
Enable_Soft_Login_with_PIN | Determines whether the system allows users to login using a 4-digit PIN (soft login). If true, users can use the Switch User menu option to pause their session, then log back in by providing their PIN only. If false, after users log out and their session ends, they must log in using their username and password to regain entry (hard login). | false |
Mask_Soft_Login_PIN | Determines whether the system masks the users' PINs. If true, asterisks are displayed instead of digits. If false, the PIN digits remain visible on-screen. Requires Enable_Soft_Login_with_PIN to be set to true. | false |
Maximum_Percent_Off_Line_Item | The percentage discount that an authorized user by role can enter on a payment line item in the InStore colleague app. Enter a value from 1 to 100. To remove this option in the user interface, set the Allow_Percent_Off_Line_Item parameter to false. In addition to calculating line item discounts based on percentage, this value also serves as a limit for amount-off and price change discounts. | 20 |
Required_Shipping_Address_Info | Sets the mandatory shipping address fields for guest and existing customer orders. Use the Collected_Shipping_Address_Info parameters to define the address fields to display on the form. | country, firstName, lastName, streetName, streetNumber, postalCode, city |
Soft_Login_Expiration_Time | The number of seconds after which the InStore colleague app login times out. | 480 (8 minutes) |
Tender parameters
Pay by Link and Pay on Account are not enabled by default. To accept these tenders, contact the InStore support team.
Tender parameters control accepted payment methods, including cash, cards, and other digital tenders, and include the following:
| 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 |
Maximum_QuickPay_Cash_Options | Maximum number of QuickPay cash buttons shown on the Cash payment screen. Accepted values: 1 to 9. | 6 |
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. | 0.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. InStore enforces a 30-character limit on the purchase order number length. InStore saves the number to Composable Commerce and displays it in the 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 |