Configs

The following are complete lists of Ruby and JavaScript configs (configuration keys) provided by the Workarea base platform (Core, Admin, Storefront). This document is a work in progress and will eventually describe each config and its usage.

Ruby Configs

  • activity_excluded_types

  • activity_size_on_dashboard

  • address_attributes

    A white list of address attribute names used when saving, copying, resetting, and comparing addresses. An array of symbols.

  • admin_break_points

  • admin_max_most_visited

  • admin_session_timeout

  • admin_visit_excluded_paths

  • allow_payment_address_po_box

    A boolean indicating whether the retailer accepts PO box addresses for lines 1 and 2 of payment addresses entered by consumers in the Storefront. When false, payment address lines 1 and 2 are validated against Workarea.config.po_box_regex. Values matching the regex are invalid. Also, when false, displays a note on the address line 1 field in the Storefront indicating PO box addresses are not accepted.

  • allow_shipping_address_po_box

    A boolean indicating whether the retailer accepts PO box addresses for lines 1 and 2 of shipping addresses entered by consumers in the Storefront. When false, shipping address lines 1 and 2 are validated against Workarea.config.po_box_regex. Values matching the regex are invalid. Also, when false, displays a note on the address line 1 field in the Storefront indicating PO box addresses are not accepted.

  • allowed_login_attempts

    An integer representing the number of allowed login attempts before login disabling is applied. Upon reaching this threshold, the user is locked out for the duration specified by config.lockout_period. Enforced for all logins that go through Storefront::Users::LoginsController, which includes all Storefront and Admin logins.

  • analytics_timezone

  • asset_store

  • asset_types

  • auto_capture

  • auto_refresh_search

  • bulk_action_expiration

  • bulk_action_per_page

  • cache_expirations

  • capybara_browser_height

  • capybara_browser_width

  • cache_expirations

    The time-to-live for various caches throughout the Workarea application. Changing these values will affect application performance and is not recommended. To see how they're each used, do a find in the Workarea source code for that name.

  • cart_recommendations_count

  • category_summary_product_count

  • checkout_expiration

    The duration (ActiveSupport::Duration) for which a cart/order is considered to be checking out, relative to Order#checkout_started_at. Touching checkout updates checkout_started_at, retaining the checking out status. A cart that goes idle beyond this duration must restart checkout. Defaults to 15 minutes. (See Checkout Expiration)

  • checkout_steps

  • completed_order_timeout

  • content_areas

  • content_block_name_search_classes

  • content_block_types

  • content_preview_breakpoints

  • copy_order_ignored_fields

  • countries

  • credit_card_issuers

  • customer_session_timeout

  • customization_types

  • data_file_formats

  • data_file_ignored_fields

  • data_file_operation_ttl

  • data_file_sample_size

  • default_admin_jump_to_result_count

  • default_lock_expiration

  • default_search_boosts

  • default_search_facet_result_sizes

  • default_search_views_factor

  • detail_page_recommendations_count

  • discount_application_order

  • discount_staleness_ttl

  • elasticsearch_mappings.admin

  • elasticsearch_mappings.help

  • elasticsearch_mappings.order

  • elasticsearch_mappings.storefront

  • elasticsearch_settings

  • email_from

    The “from” email address for emails sent by Workarea. Used by Admin and Storefront mailers.

    The Core configuration defaults the value to 'noreply@example.com', however the app template creates the workarea.rb initializer, which sets the value to 'noreply@app_name.test'. For a production application, ask the retailer for the correct value.

  • email_recommendations_count

  • email_to

    The “to” email address for Storefront inquiries (emails sent by customers through the “Contact Us” form).

    The Core configuration defaults the value to 'customerservice@example.com', however the app template creates the workarea.rb initializer, which sets the value to 'customerservice@app_name.test'. For a production application, consult the retailer for the correct value.

  • enforce_host

  • exclude_from_content_search_index

  • favicon_allowed_sizes

  • fulfillment_status_calculators

  • gateways.credit_card

  • gateways.shipping

  • gravatar_options

  • headless_chrome_options

  • host

    The application's canonical hostname.

    The Core configuration defaults the value to www.example.com, however the app template creates the workarea.rb initializer, which sets the value to app_name.test. For a production application, consult the retailer for the correct value.

    Example uses:

    • Used by the Admin and Storefront routers (more specifically, routing helpers following the format foo_url) to construct URLs
    • Used by the Admin and Storefront mailers to construct URLs
    • Prefixed with the current protocol to construct the canonical Storefront URL
    • Used by EnforceHostMiddleware, which redirects a request when the request host doesn't match the configured host (for example, redirecting https://workarea.example/ to https://www.workarea.example/ when Workarea.config.host is www.workarea.example
    • Used to display Storefront URLs (or a portion thereof) within the Admin (for example, the redirect field on a search customization)
    • Displayed consistently in the Admin header
  • images_import_retries

  • inquiry_subjects

  • inventory_policies

  • jpg_encode_options

  • jump_to_navigation

  • localized_active_fields

  • lockout_period

    The duration (ActiveSupport::Duration) for which a user is locked out after reaching the number of failed login attempts specified by config.allowed_login_attempts.

  • low_inventory_threshold

  • max_admin_bookmarks

  • max_admin_related_help

  • max_recommendation_similarities

  • max_searches_to_index

  • max_user_activities

  • meta_description_max_words

  • minimum_content_search_words

  • option_selections_sort

  • order_active_period

    The duration (ActiveSupport::Duration) for which an unplaced order is considered an active cart or checkout, relative to Order#created_at. Unplaced orders created outside this period are considered abandoned, unless checking out. (See Abandoned Carts)

    Also, the duration used to determine orders that need reminding, relative to Order#checkout_started_at. Unplaced orders that contain an email and items, whose checkout_started_at falls outside this period will be sent a reminder email by a scheduled worker (unless already reminded). (See Order Reminding)

    Defaults to 2 hours.

  • order_expiration_period

    The duration (ActiveSupport::Duration) for which an unplaced order is retained, relative to Order#updated_at. Unplaced orders not updated within this period will be destroyed by a scheduled worker. Defaults to 6 months. (See Order Expiration)

  • order_status_calculators

  • password_history_length

  • password_lifetime

  • password_reset_timeout

  • password_strength

  • payment_status_calculators

  • per_page

  • performance_test_comparisons

  • performance_test_max_percentage_of_change

  • performance_test_output_path

  • permissions_fields

  • permitted_facet_params

  • personalized_recommendations_count

  • placeholder_asset_name

  • placeholder_text

  • po_box_regex

    The regular expression used to determine if a given address is a PO box. The default value comes from the pobox-regex project.

  • pricing_calculators

  • product_based_recommendation_default_sources

  • product_copy_default_attributes

  • product_insights_count

  • product_placeholder_image_name

  • product_recommendation_index_page_size

  • product_rule_fields

  • product_templates

  • recent_order_count

  • recommendation_expiration

  • releasable_icons

  • release_session_max_page_views

  • release_session_timeout

  • release_status_calculators

  • score_decay

  • search_dismax_tie_breaker

  • search_exact_match_score

  • search_facet_default_sort

  • search_facet_dynamic_sorting_size

  • search_facet_result_sizes

  • search_facet_size_sort

  • search_facet_sorts

  • search_name_phrase_match_boost

  • search_query_expiration

  • search_query_options

  • search_recommendation_index_page_size

  • search_sufficient_results

  • search_suggestion_min_doc_freq

  • search_suggestions

  • seeds

  • send_email

  • send_transactional_emails

  • shipping_dimensions

  • shipping_options

  • shipping_origin

  • shipping_service_tracking_links

  • sidekiq_critical_queue_size

  • site_name

    The name of the application. Used for display and as a unique identifier.

    Be careful! Changing this value will affect your Mongoid and Elasticsearch configurations and 3rd party web analytics data.

    The Core configuration defaults the value to 'Workarea', however the app template creates the workarea.rb initializer, which sets the value to the name used when creating the application. For a production application, consult the retailer for the correct value.

    Example uses:

    • Used to create MongoDB database names
    • Used to create Elasticsearch index names
    • Included in some web analytics payloads
    • Displayed within the Admin and Storefront in browser titles and page headings
  • skip_enforce_host

  • stale_products_size

  • status_state_indicators

  • storefront_break_points

  • storefront_search_middleware

  • storefront_user_order_display_count

  • tender_types

  • untracked_release_changes_fields

  • user_activity_display_size

  • web_manifest

JavaScript Configs

  • backToTopButton.waypointOffset

  • categorizedAutocompleteFields.uiOptions

  • contentBlocks.loadingTimeout

  • contentEditorForms.previewDebounceValue

  • creditCardNumberWhiteList

  • dashboardCharts

  • date

  • datepickerFields.uiOptions

  • datetimepicker.fieldSuffixes

  • deletionForms.message

  • dialog.errorTemplate.data

  • dialog.errorTemplate.path

  • dialog.options

  • dialog.viewportBuffer

  • dropzones.maxFiles

  • dropzones.maxFilesize

  • formSubmittingControls.changeDelay

  • formSubmittingControls.inputDelay

  • forms.errorLabelClasses

  • helpLookupButtons.keywordElements

  • imageFileExtensions

  • loading.loadingDialogOptions

  • loading.loadingDialogTemplate.data

  • loading.loadingDialogTemplate.path

  • loading.loadingIndicatorOptions.container

  • loading.loadingIndicatorOptions.cssModifiers

  • loading.loadingIndicatorOptions.delay

  • loading.loadingIndicatorOptions.insertionMethod

  • loading.loadingIndicatorTemplate

  • messages.delay

  • pagination.pagesToLoad

  • popupButtons.height

  • popupButtons.width

  • productImagesSortable.cursor

  • productImagesSortable.opacity

  • productImagesSortable.tolerance

  • recommendationsSortables.cursor

  • recommendationsSortables.opacity

  • remoteSelects.ajax

  • remoteSelects.width

  • scrollToButtons.animationSpeed

  • scrollToButtons.topOffset

  • searchFieldsAutocomplete.minLength

  • storefrontBreakPoints

  • storefrontBreakPoints.ie9Matches

  • storefrontBreakPoints.sizes

  • tooltipster

  • validationErrorAnalyticsThrottle

  • wysiwygs.parserRules

  • wysiwygs.uiOptions