Global Configurations Table

uStore comes with a set of preconfigured global configurations which apply to the entire system.

Some of these configurations may be changed. Since any changes that you make apply to the entire system, they must be done with caution.

Global configurations can be viewed in the following location:

  • Global Settings > System Setup > Global Configurations

To edit a global configuration:

  1. Click the Edit icon of the required configuration.

    The following is an example of the DefaultDisplayQueueID configuration window.

    The window contains the following fields:

    • Name: Name of the global configuration. It is recommended not to change this name.

    • Description: Description of the global configuration.

    • Value: Selected value for this configuration.

    • Application Type: Defines whether the global configuration applies to the backoffice application (AdminApp) or to the storefront (CustomerApp). It is recommended not to change this value.

  2. Edit the Value field and click Save.

The following table lists most global configurations in the system.

The Global Configurations screen lists every configuration that exists in your installation. A configuration that appears there but not in the following table is used internally by uStore and should not be changed.

Name

Description

Default Value

validationKey

Unique server key for the storefront.

This value is set during installation and should not be changed.

decryptionKey

Key used for encryption and decryption of forms, authentication of cookie data and view-state data, and for verification of out-of-process session state identification.

This value is set during installation and should not be changed.

validationKey

Unique server key for the backoffice.

This value is set during installation and should not be changed.

decryptionKey

Key used for encryption and decryption of forms, authentication of cookie data and view-state data, and for verification of out-of-process session state identification.

This value is set during installation and should not be changed.

SessionStateMode

Used by the installer in order to set the Session State mode.
Possible values are InProc and SQLServer.

InProc

TaxRoundingMethod

Determines how tax prices are rounded up.

Possible values are Ceiling, Floor and Round.

Round

MarketingProductsGroups

Marketing product group IDs (comma separated) used by the Cost Center plug-in.

AccessibilityFriendly

Determines whether the storefront is in Accessibility Friendly mode. Accessibility Friendly mode affects validation messages, grid paging and date and time pickers, making them look and behave differently.

False

DefaultDisplayQueueID

Determines which queue is displayed by default when a backoffice user enters the Orders tab. The value can be any Queue ID.

1

ProductDownloadExpirationDays

Expiration period for output download.

Enter the number of days after which the product download option in the storefront expires. Leaving this field empty means there is no expiration period for product download. Entering a zero value will make the product expire immediately.

MinimumAllowedDPI

Determines the minimum allowed DPI for images contained in documents uploaded in the document builder.

A warning message is displayed to the customer if an uploaded image has a DPI lower than the entered value.

Leaving this field empty or a value of 0 means there is no minimum DPI.

150

DefaultCompositeQuantity

When placing an order for a composite product, the Total Price displayed in the storefront is based on the default number of copies. The DefaultCompositeQuantity parameter enables changing this default value.

Enter the default value for the quantity of composite items that can be ordered. When set to Null, the smallest amount defined by the price steps of the product will be used.
The Quantity can be changed in the store when finalizing an order.

FileSubmissionGetViewNumberOfTrials

Determines the number of times the client (browser) tries to retrieve information from the server in the document builder display (document Submission).

30

StagingEnvironment

Sign this uStore installation as a staging environment. For further details, refer to the uStore Installation Guide.

False

ThumbnailPreviewFullSizeByDefault

Determines the size at which the enlarged product preview opens in the storefront. When it is False, the preview opens at a fixed size; when it is True, it opens at the document's original size. The shopper can switch between the two sizes in the preview window.

False

UeditControlWidth

Determines the width of the uEdit application within uStore (Flash version only).

920

UeditControlHeight

Determines the height of the uEdit application within uStore (Flash version only).

540

SingleSignOnTimeout

The period of time, in minutes, after which the given single sign on URL expires.

60

P3PHeader

P3P is the Platform for Privacy Preferences. The value describes a compact policy with tokens such as CAO PSA OUR.

TouchPointNameFormat

Format of Touch Point names created by uStore for email products (1G only).
Use {0} for Item ID, {1} for Encrypted order ID, {2} for sequential order ID, {3} for Store ID, {4} for Customer ID.

Example:

uStore_{1}_{0}

ShowCurrencyCode

Determines whether to show the currency abbreviation (for example USD, EUR, CHF) next to the price.

True

UproduceOutputFileNameFormat

Format of uProduce output file name.

Use {0} for document name, {1} for Encrypted order ID, {2} for Item ID, {3} for sequential order ID, {4} for Product ID, {5} for Store ID, {6} for the Customer ID.

Example:

{0}_O_{1}_{2}

UproduceOutputFileNameFormatForGroup

Format of uProduce output file name for groups of aggregated items.

Use {0} for document name, {1} for Group ID, {2} for Group Name.

Example:

{0}_AggregationGroup{1}

DeploymentMode

Used by uStore Update Application to determine whether uStore is deployed in a cluster.

Possible values are SingleServer or cluster.

SingleServer

AssetUploadLimit

Determines the maximum allowed size (in MB) for images uploaded in the Customization and uEdit pages.

15

ThumbnailCreationTimeout

Determines the timeout (in seconds) for creating thumbnails in the document builder display (document submission).

300

HighQualityImages

Determines whether to use high quality images in the document builder display (document submission). Setting the value to True may impact performance.

False

EnableOptimizations

Determines whether to enable JavaScript and CSS bundling and minification.

True

MaxDrafts

The maximum number of draft orders kept in the Last Draft Orders section. When a shopper has more than this, the oldest drafts are removed from the section. They are not deleted, but they are no longer offered as drafts.

3

ProofSetTimeout

Determines the timeout (in seconds) for generating a proof set when calculating number of copies per recipient according to a value defined in the process job.

60

AllowBrowserAutoComplete

In the storefront, determines whether the browser's auto complete feature is used. It can be set to False in order to enhance security.

True

OrderQueue_PageSize

Determines the number of orders shown on each page of the order queues. Can be set to a maximum of 500 orders per page.

50

UserEmailValidation_RegEx

Regular expressions used to validate user email addresses.

^([\w\!\#$&,:;()\%\'\*\+\-\/\=\?\^\`{\|\}\~]+\.)*[\w\!\#$&,:;()\%\'\*\+\-\/\=\?\^\`{\|\}\~]+@((((([a-zA-Z0-9]{1}[a-zA-Z0-9\-]{0,62}[a-zA-Z0-9]{1})|[a-zA-Z])\.)+[a-zA-Z]{1,6})|(\d{1,3}\.){3}\d{1,3}(\:\d{1,5})?)$

UserEmailValidation_RegExNG

The regular expression the storefront applies to an email address as it is typed, in the personal information and address forms. uStore also checks the address against UserEmailValidation_RegEx when it is saved, so change both if you change the rule.

^(?!.*\.\.)(?!.*\.$)[A-Za-z0-9]+(?:[._%+-][A-Za-z0-9]+)*@[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?(?:\.[A-Za-z]{2,})+$

KeepClientImagesNumOfDays

How many days an image a customer uploaded stays listed in the gallery of an image selector control, during customization. At the default of -1 every image the customer has uploaded is listed. An older image is hidden from the gallery and is not deleted, and an image the customer has already selected remains listed whatever its age. See Setting Up Dial Input Controls.

-1

MerchantIconMaxWidth

The maximum width allowed for a merchant logo icon.

450

MerchantIconMaxHeight

The maximum height allowed for a merchant logo icon.

80

UEditReadyFontTimeout

The timeout (in milliseconds) for loading fonts in uEdit or in the rich text editor.

10000

ProductionDateFormat

The date format used in recipient lists.

M/d/yyyy

FileAttachmentDefaultExtensions

Default extensions used when creating a new file attachment property.

PDF, PPT, PPTX, DOC, DOCX, EPS, EPSF, JPG, JPEG

RefreshPreviewTimeout

The number of times the storefront checks whether the preview's proof job has finished, before it stops waiting. The first ten checks are one second apart and the rest two seconds apart, so the default of 25 waits about 40 seconds. Raise it for products whose preview takes longer to generate.

25

PrepressInProgressTimeoutMinutes

The timeout (in minutes) for keeping an item in the "Prepress In Progress" queue before moving it to the "Failed Jobs" queue. To ignore the timeout and leave the item in the "Prepress In Progress" queue, enter "0".

60

FedEx_Currency_MXN

The code FedEx expects for the Mexican peso, which uStore sends in place of the store's own currency code when it asks FedEx for rates.

The key name is a pattern: add FedEx_Currency_ followed by any ISO 4217 code to map that currency too. Without a mapping, uStore sends the ISO code as it is, and FedEx returns no rates for a currency it names differently. The rows below are the mappings uStore ships with, not the only ones you can add.

NMP

FedEx_Currency_GBP

The code FedEx expects for the pound sterling. See FedEx_Currency_MXN.

UKL

FedEx_Currency_CHF

The code FedEx expects for the Swiss franc. See FedEx_Currency_MXN.

SFR

CsvDelimiter

Defines the delimiter which is used to separate fields in Text CSV files. Note: for the Tab delimiter write "TAB", for other delimiters use the delimiter character.

,

CachedXlimFilesKeepHours

Defines the expiry period, in hours, for keeping cached proof results of XLIM documents in uStore's file system.

24

XMCampaignAnalyticsCacheDuration

Defines the expiry period, in hours, for keeping cached Cross Media Analytic reports.

When a storefront user requests to view the analytics of a XM campaign in the Order History page, if this period expired, updated reports will be re-generated.

24

XMInstanceIDDraftCashDurationDraft

The duration, in minutes, during which the instance ID is cached for draft orders.

20

AnonymousUsersKeepDays

The duration, in days, for keeping anonymous users which were created when anonymous users entered a B2C store.

30

RemoveDeletedUsers

Determines whether the garbage collector removes data of deleted users from the database and file system.

False

AlwaysGenerateProof

Determines whether a proof is automatically produced for each ordered item. A proof is not generated only if this key is set to False and the Let the User Generate a Proof checkbox is cleared in the product's Proof section.

True

ResizeImageInSlideShow

Determines whether to resize the images which are displayed by the slide show control used in the Customization and Product Details pages.

True

AdminPasswordPolicy

The backoffice login password policy, written using regular expression.

Important! If you change the policy, you must change the validation message accordingly in Global Settings > Localization > {language} > Admin Resources > Admin_Password_Policy.

(?=.{9,})(?=.*?[^\w\s])(?=.*?[0-9])(?=.*?[A-Z]).*?[a-z].*

GdprConfirmationEnabled

If set to True, the "Show GDPR confirmation checkbox in storefront" option in the Store Setup Advanced tab is selected by default for each new store.

When the checkbox is selected, shoppers must verify that the recipient list(s) used in their orders are GDPR compliant, i.e. recipient lists are free from data subjects who asked to be deleted or didn't consent to being included in the specific operation.

See Making your Stores GDPR Compliant.

False

GdprCleanupEnabled

If set to true, "Turn on automatic deletion of personal information" checkbox in the Store Setup Advanced tab is selected by default for each new store.

When the checkbox is selected, a daily deletion mechanism of recipient lists, instances and uploaded files (of both composite products and File Attachment property) is carried out. Recipient lists, outputs, instances etc. that were created over 30 days ago in the backoffice or storefront are automatically deleted.

See Making your Stores GDPR Compliant.

False

GdprRLExpirationDays_Storefront

Period in days from upload or creation of the recipient list or uploaded files (of both composite products and File Attachment property) until it is automatically deleted from the storefront.

See Making your Stores GDPR Compliant.

30 days

GdprRLExpirationDays_Backoffice

Period in days from arrival of the order to the backoffice until the recipient list/XM campaign instance/uploaded files (of both composite products and File Attachment property) is automatically deleted.

See Making your Stores GDPR Compliant.

30 days

GdprRLExpirationNotificationDays

Define the number of days before the recipient list/XM campaign instance/uploaded files (of both composite products and File Attachment property) expires in the backoffice to be displayed in the order list.

See Making your Stores GDPR Compliant.

7 days

TaxForShippingMethod

Define the way tax is applied to the shipping price when shipping products of different tax groups.

When selecting "Proportional", calculation of the shipping tax takes into account the different tax rates of products within a shipment. For example, if the shipment contains both exempt and taxable products, the portion of the shipping charge allocated to the taxable products is taxable, while the shipping price portion attributed to the exempt products is exempt.

Set to "Max" to select the highest tax rate of all product tax groups and apply it to the total shipping price.

See Setting Up Tax.

Proportional

StaticProductPDFToThumbnails

Define how many thumbnails will be created from the PDF file of a static product. These thumbnails are what the customer sees as the product's previews in the storefront.

The thumbnails cannot be switched off: a value below 1 is treated as 1. Raising the value increases the disk space the thumbnails occupy, and the time it takes to create them, which happens each time the product's PDF is uploaded.

See Setting Up Static Documents.

2

StaticProductPreflight

When creating a static product with a PDF document, preflight data is recorded for the document. The data includes page information such as size and color space.

False

AllowOverridingManualShippingPrice

Determines whether the administrator can override the manual shipping price, as calculated in the storefront.

If set to True, when choosing in the Orders page- Ready for Delivery queue - the "Create New Delivery" action, a Shipping Price field is added.

See General and Print Queues.

False

GdprProofDeletion

Define whether to delete the generated proof files.

This requires that the "Turn on automatic deletion of personal information" checkbox (Store Setup > Advanced tab) is selected.

When set to True, the generated proof files will be deleted as part of the automatic deletion mechanism.

See Making your Stores GDPR Compliant.

False

ExcelSupportsEmptyValues

This key is applicable to static products in NG stores with single-page flow that support automatic recalculation.

This key determines if the Pricing Excel file can handle pricing in cases of undefined properties in the storefront.

If set to true, the Excel can recalculate in case of undefined property values.

If set to false, the Excel will not recalculate the price in case of undefined property values, and the storefront user will receive a notification to complete all fields.

True

ExcelCacheExpirationMinutes

Excel pricing results are cached for performance improvement, and are purged after the defined number of minutes.

This is especially important for the recalculation of the price in the cart, that can pull the price from the cache instead of recalculating the Excel for every product in the cart.

Use a positive number (1 and above) of minutes.

The default value -1 indicates a period of one week.

This may cause inaccuracy when using the NOW() or Today() functions in the Excel, which rely on recalculation of the Excel more often.

You cannot prevent the Excel from being cached, however you can set the purging interval as low as 1 minute using this key.

See Setting Property Dependency with Excel Pricing.

-1

TaxWebhookConfig

A default configuration for TaxWebhook. To enable the TaxWebhook, set the "taxWebhookEnabled" key to true and configure a URL.

See Setting Up Tax.

{ "taxWebhookEnabled": false, "url": "", "signatureKey": "e6b64dd5-dba2-471f-b386-e4fd65829cf3", "storedProcedureName": "Order_DetailsXmlForTax" }

GDPRProofExpirationDays

If this key is added, uStore will retain proofs no longer than the number of days specified in this key.

This key will be functional only if GdprProofDeletion is set to True.

When GDPRProofExpirationDays is used, the system uses the keys: GdprRLExpirationDays_storefront, GdprRLExpirationDays_Backoffice only to specify the days to retain recipient lists and not proofs.

uStoreSharedOutputFolderExpirationDays

If this key is added, uStore will retain files in the shared "Output" folder according the key’s value. The system will consider the modification date of the file and not its creation date.

ManufacturerWebhookConfig

A default configuration for the Manufacturer webhook. To enable this webhook, configure the required parameters.

{
"url": "",
"signatureKey": "8bc8ed71-c92c-449b-ae4d-f0ddf54eae28",
"customConfiguration": ""
}

CartExportWebhookConfig

The configuration of the cart export webhook, which sends cart item information to an external service. The value holds the signature key used to hash and validate the JSON at both ends; the webhook's address is set separately, in Store Setup > General. See Configuring the Cart Export Webhook.

{
"signatureKey": "11111111-c92c-449b-ae4d-f0ddf54eae28"
}

FedexSupportedLabelType

The file format that FedEx produces the shipping label in. FedEx accepts ZPLII, EPL2, PDF and PNG. uStore passes the value on without checking it. See Printing labels on a thermal printer.

PDF

FedexSupportedLabelSize

The label stock that FedEx produces the shipping label on. FedEx accepts PAPER_4X6, PAPER_4X675, PAPER_4X8, PAPER_4X9, PAPER_7X475, PAPER_85X11_TOP_HALF_LABEL, PAPER_85X11_BOTTOM_HALF_LABEL, PAPER_LETTER, STOCK_4X6, STOCK_4X8, STOCK_4X9, and the 4x675, 4x85, 4x9 and 4x105 document-tab stocks. uStore passes the value on without checking it. See Printing labels on a thermal printer.

PAPER_4X6

DuplicationMaxItems

The maximum number of items a shopper can create at once when duplicating a cart item or reordering. Above this number the storefront refuses the operation and states the limit. An item whose recipient list comes from USADATA cannot be duplicated at all.

15

CalculateCostOnAddToCart

Calculate costs when adding a product to the cart.

False

CalculateCouponDeductionOnRLPrice

Calculates coupon deduction on recipient list price.

True

CalculateTaxBeforeCouponDeduction

Calculates tax before coupon deduction.

False

EnableRecipientListValidation

Enables validation for recipient lists.

True

EnableSearchHistory

Enables search history.

True

FileSubmissionUploadPaperSizeTolerance

Paper size tolerance for submission file uploads.

5

HandleEXIFOrientation

Handles file orientation from EXIF metadata.

True

PreviewProofThroughPdf

Determines how the storefront preview is produced. When it is False, the preview's proof is generated as a JPG file. When it is True, the proof is generated as a PDF file and then converted to JPG. Either way the proof is recorded in uStore as a JPG.

False

FDX_AddressValidation_NON_US_Phone_RegEx

FedEx - regex for non-US phone

\d{6,16}

FDX_AddressValidation_US_Phone_RegEx

FedEx - regex for US phone

\d{10}

FDX_AddressValidation_US_Zip_RegEx

FedEx - regex for US address validation

\d{5,5}

UPS_AddressValidation_NON_US_Phone_RegEx

UPS - regex for non-US phone

\d{6,15}

UPS_AddressValidation_US_Phone_RegEx

UPS - regex for US phone

\d{10,15}

UPS_AddressValidation_US_Zip_RegEx

UPS - regex for US address validation

\d{5,5}

UPS_EarliestTimeReady

The start of the window uStore tells UPS the package will be ready for collection, as four digits in 24-hour time. It is sent only when the delivery's Pickup Type is On Call Air. See General and Print Queues.

0900

UPS_LatestTimeReady

The end of the window uStore tells UPS the package will be ready for collection, as four digits in 24-hour time. It is sent only when the delivery's Pickup Type is On Call Air. See General and Print Queues.

1700

Proof_JPG_Resolution

Resolution of the JPG proof.

Null

RadAsyncUploadChunkSize

Chunk size for file uploading.

256000

UnusedPromotionCodeKeepMinutes

Length of time in minutes for storing unused promo code.

30

ProofResultsKeepMinutes

Number of minutes for storing the proof result.

60

RedundantUploadedRLFilesKeepHours

Number of hours for keeping redundant recipient lists.

2

DeletedUsersKeepDays

Number of days for storing deleted users.

2

NonActivatedUsersKeepDays

Number of days for storing non-activated users.

2

FileAttachmentKeepDays

Number of days for keeping file attachments.

1

FileSubmissionKeepDays

Number of days for keeping file submissions

5

UPS_UseNegotiatedRates_Backoffice

Whether or not to use UPS negotiated rates for the backoffice.

True

UPS_UseNegotiatedRates_StoreFront

Whether or not to use UPS negotiated rates for the storefront.

False

ImageDialAssetsExpirationDays_Storefront

Asset files uploaded in the storefront during the customization of dynamic product image dials will now be automatically deleted after a set period of time from their last usage.

-1 (no deletion)

PackagingCalculatorLogicPluginDefID

The method by which packages are selected for delivery based on product weight.

This is relevant for delivery providers such as FedEx and UPS.

See Setting Up Delivery.

1072 (default value for installations of uStore version 25.2 and above)

242 (default value for installations prior to uStore 25.2)
EnfocusSwitchUser

The user for the Enfocus Switch workflow provider. This has to be an existing user in your Enfocus Switch installation.

  
EnfocusSwitchPassword

The password of the user of the Enfocus Switch workflow provider. Once saved, the password is encrypted.

  
OrderJobTicketFileFormat

The format of the downloaded job ticket: PDF or DOC.

 DOC

ShowCopiesForDuplication

Displays the popup where the shopper selects the number of copies to duplicate in the cart.

This option is not available in uStore Connect Enterprise.

True

DefaultOrdersDisplayDays

Determines the default date range selected in the Orders screen in the backoffice. Accepted values are 0, 3, 7, 30, and 90, corresponding to Today and the last 3, 7, 30, and 90 days. A value of 0 shows today's orders only.

Any other value defaults to 0 (Today).

This key is not included by default and must be added manually.

See Handling Orders.

0 (Today)
UstoreDomainWebHookURL

The external domain URL that uStore gives to clearing providers for their webhook calls. It must contain the protocol and the server address, and no path - for example https://mystore.example.com or https://192.168.0.1. uStore adds the rest of the webhook address itself.

The address must be reachable from the internet by the clearing provider.

The value is used by every clearing method that relies on webhooks, including Authorize.Net and PayPal REST. PayPal REST requires an https address.

Note: Changing this value also updates the Helicon proxy configuration.

See Creating an Authorize.Net Clearing Model.

Taken from the external server address of the installation. It can be empty.
HideDeprecatedClearings

Determines whether deprecated clearing models are offered for selection. When it is True, a deprecated model is not offered in a store's clearing list or in the lists for a new clearing model, and it cannot be opened for editing unless a store is using it.

Set it to False to work with deprecated models again. See Deprecated clearing models.

 True. The key is not created by the installation, and the behavior is the same as True until you add it.