Preferences define the configuration of your Site. By altering Preference values, you can alter the behaviour of your Site. Some Preferences provide only read-only information and are not editable by you.

Preference value types are one of the following:

  • STRING. Text value.
  • NUMBER. Numeric value.
  • BOOLEAN. Checkbox toggle.

List of editable Preferences

General

Preference Name Value Type Description
COMPANY_ADDRESS STRING Street address of the company.
COMPANY_CITY STRING City of the company.
COMPANY_COUNTRY STRING Country of the company.
COMPANY_EMAIL STRING Email address for the company.
COMPANY_LOGO_URL STRING URL to the logo of the company.
COMPANY_NAME STRING Name of the company.
COMPANY_PHONE STRING Phone number for the company.
COMPANY_SITE_URL STRING Website URL of the company
COMPANY_VAT_ID STRING VAT ID of the company
COMPANY_ZIP_CODE STRING Zip code of the company
DEFAULT_LOCALE_CODE STRING Default locale for the Site to use for root URL. Supported values: fi_FI, en_US. Default en_US.
DEFAULT_TITLE_TAG_POSTFIX STRING Default Title tag postfix. Default - {{site.name}}
SITE_FAVICON_URL STRING URL of image to use as favicon.

User Authentication and Registration

Preference Name Value Type Description
SITE_REGISTRATION_ENABLED BOOLEAN Allow new users to register to the Site
SITE_REGISTRATION_PRIVATE_USER_ENABLED BOOLEAN Enable registration as a private user.
SITE_REGISTRATION_BUSINESS_USER_ENABLED BOOLEAN Enable registration as a business user.
SITE_REGISTRATION_BUSINESS_USER_DEFAULT BOOLEAN Default to registering as a business user.
SITE_REGISTRATION_TELEPHONE_ENABLED BOOLEAN Ask telephone during registration. Default false
SITE_REGISTRATION_QUOTE_ONLY_TELEPHONE_ENABLED BOOLEAN Ask telephone only on quotations. Default false
AUTH_PROVIDER_LOCAL_ENABLED BOOLEAN Enable Local Credential Authentication on the Site
AUTH_PROVIDER_AZURE_AD_B2C_ENABLED BOOLEAN Enable Azure AD B2C Authentication on the Site
AUTH_PROVIDER_AZURE_AD_B2C_TENANT_NAME STRING Name of the Tenant in Azure AD B2C. The subdomain part of the domain.
AUTH_PROVIDER_AZURE_AD_B2C_CLIENT_ID STRING Client ID from Azure AD B2C
AUTH_PROVIDER_AZURE_AD_B2C_CLIENT_SECRET STRING Client Secret from Azure AD B2C
AUTH_PROVIDER_AZURE_AD_B2C_POLICY_FOR_LOGIN STRING Name of the Policy to use for Login
AUTH_PROVIDER_AZURE_AD_B2C_POLICY_FOR_REGISTER STRING Name of the Policy to use for Register

Profiles

Preference Name Value Type Description
PROFILE_INITIAL_ACCOUNT_BALANCE NUMBER Initial amount of account balance for new Profiles

Service life time

Preference Name Value Type Description
DAYS_FROM_EXPIRE_TO_DISCONTINUE NUMBER The count of days before a Service is Discontinued after being Expired. Default 30.
INVOICE_SERVICE_BILLING_GROUP_DAYS_BEFORE_EXPIRE NUMBER The count of days before the Service expire time that the next Invoice is created. Default 0, Invoice is created on the expire date.
SERVICE_EXPIRATION_DELAY_IN_DAYS NUMBER The offset of days for setting the Service in to EXPIRED state, after the expire time has been reached. Default 0, Service is set to EXPIRED state on the date of the expiration.
SELF_SERVICE_CANCEL_ENABLED BOOLEAN Allow customers to cancel services by themselves. Default true.

Invoicing

Preference Name Value Type Description
INVOICE_MINIMUM_PAYMENT_PERIOD NUMBER The count of days to the due date at least when creating invoice from contract with billing day. Default 7.
INVOICE_DEFAULT_PAYMENT_PERIOD NUMBER The count of days to the due date at most when creating invoice from contract with billing day. Default 13.
INVOICE_EXCLUDE_UNESSENTIAL_ITEMS_ENABLED BOOLEAN Hide unessential invoice items from showing and being passed through invoicing integrations. Default false.

UI and Features

Preference Name Value Type Description
FRONTEND_PROFILE_SELECTOR_AFTER_LOGIN_ENABLED BOOLEAN Show Profile selector modal after login
FRONTEND_SHOP_CATEGORY_PRODUCT_DEFAULT_ORDER STRING Define product ordering in category. Possible values: cheapest-first (Price - lowest first), cheapest-last (Price - highest first), position-id (Recommended)
FRONTEND_SHOP_CATEGORY_PRODUCT_DEFAULT_PAGE_SIZE NUMBER Set how many products are fetched at a time on a Category page
FRONTEND_SHOP_FRONT_PAGE_ALIAS_PATH STRING URL Path which is shown on the front page. ex. /pages/terms-of-use
FRONTEND_SIDEMENU_LINK_PRIVACY_POLICY_ENABLED BOOLEAN Show side menu link to privacy-policy Page.
FRONTEND_SIDEMENU_LINK_PRIVACY_POLICY_EXTERNAL_ENABLED BOOLEAN Use external link for the side menu link of Privacy Policy. If false, internal Page is used.
FRONTEND_SIDEMENU_LINK_PRIVACY_POLICY_EXTERNAL_LINK STRING URL of an external Contact page.
FRONTEND_SIDEMENU_LINK_TERMS_OF_USE_ENABLED BOOLEAN Show side menu link to terms-of-use Page.
FRONTEND_SIDEMENU_LINK_TERMS_OF_USE_EXTERNAL_ENABLED BOOLEAN Use external link for the side menu link of Terms of Use. If false, internal Page is used.
FRONTEND_SIDEMENU_LINK_TERMS_OF_USE_EXTERNAL_LINK STRING URL of an external Terms of Use page.
FRONTEND_SIDEMENU_LINK_CONTACT_ENABLED BOOLEAN Show side menu link to contact Page.
FRONTEND_SIDEMENU_LINK_CONTACT_EXTERNAL_ENABLED BOOLEAN Use external link for the side menu link of Contact. If false, internal Page is used.
FRONTEND_SIDEMENU_LINK_CONTACT_EXTERNAL_LINK STRING URL of an external Contact page.
FRONTEND_SPLIT_USER_NAMES_ENABLED BOOLEAN Show different input fields for firstname and lastname in registering
FRONTEND_SHOP_MAINTENANCE_MODE BOOLEAN Disable shop and show a maintenance message.
FRONTEND_VAT_AUTO_DETECT BOOLEAN Show prices with VAT when VAT is applicable to user.
FRONTEND_VAT_INCLUDE_BY_DEFAULT BOOLEAN Show prices with VAT by default.
FRONTEND_VAT_SHOW_TOGGLE BOOLEAN Show VAT toggle in the sidemenu.
PAYMENT_METHOD_INVOICE_ENABLED BOOLEAN Show Invoice as a payment option
PAYMENT_METHOD_STRIPE_ENABLED BOOLEAN Show Stripe as a payment option
INVOICE_DELIVERY_METHOD_EXTERNAL_EMAIL_ENABLED BOOLEAN Allow customer's invoices to be delivered via email using an external service provider. Requires Financial Management integration
INVOICE_DELIVERY_METHOD_EXTERNAL_MAIL_ENABLED BOOLEAN Allow customer's invoices to be delivered via paper mail using an external service provider. Requires Financial Management integration
INVOICE_DELIVERY_METHOD_EXTERNAL_EINVOICE_ENABLED BOOLEAN Allow customer's invoices to be delivered via electronic invoice using an external service provider. Requires Financial Management integration

Analytics

Preference Name Value Type Description
ANALYTICS_INTEGRATIONS_GOOGLE_ANALYTICS_ENABLED BOOLEAN Enable Google Analytics tracking.
ANALYTICS_INTEGRATIONS_GOOGLE_ANALYTICS_ID STRING Tracking code for Google Analytics.
ANALYTICS_INTEGRATIONS_GOOGLE_TAG_MANAGER_ENABLED BOOLEAN Enable Google Tag Manager.
ANALYTICS_INTEGRATIONS_GOOGLE_TAG_MANAGER_ID STRING TrackId for Google Tag Manager.
ANALYTICS_INTEGRATIONS_FACEBOOK_PIXEL_ENABLED BOOLEAN Enable Facebook Pixel tracking.
ANALYTICS_INTEGRATIONS_FACEBOOK_PIXEL_ID STRING PixelID for Facebook Pixel.
ANALYTICS_INTEGRATIONS_SEGMENT_ENABLED BOOLEAN Enable Segment tracking.
ANALYTICS_INTEGRATIONS_SEGMENT_KEY STRING API Write Key for Segment.
ANALYTICS_INTEGRATIONS_PILVI_ENABLED BOOLEAN Enable Pilvi Analytics tracking. Planned
ANALYTICS_INTEGRATIONS_PILVI_ID STRING Pilvi Tracking for Facebook Pixel. Planned

Marketing Automation

Preference Name Value Type Description
MARKETO_PRIVATE_API_KEY STRING Marketo Private API key.
MARKETO_LEAD_TRACKING_ENABLED STRING Enable Marketo Lead Tracking
MARKETO_LEAD_TRACKING_MUNCHKIN_ID STRING Marketo MunchinID
MARKETO_LEAD_TRACKING_ASSOCIATION_METHOD_BROWSER_ENABLED STRING Enable Lead Tracking via Browser, using Marketo Forms 2
MARKETO_LEAD_TRACKING_ASSOCIATION_METHOD_BROWSER_SERVER_URL STRING Marketo Server URL. Default //app-sjint.marketo.com
MARKETO_LEAD_TRACKING_ASSOCIATION_METHOD_BROWSER_FORM_ID STRING Marketo Forms 2 Form ID to be used for lead association

Email

Preference Name Value Type Description
EMAIL_SENDER_EMAIL STRING Reply-to address.
EMAIL_SENDER_FROM_EMAIL STRING Email from address. Default platform-noreply@pilvi.com.
EMAIL_SENDER_NAME STRING Email sender name. Default empty string.
SERVICE_PROVISIONING_DEFAULT_EMAIL_ADDRESS STRING Email address to ordered services information sent from products having email provisioning method.