Skip to main content

Global Configuration

Settings Page​

General​

This section includes general settings that allow you to change the plugin's behavior. It will also include general product settings that will apply to all products. Some of the general product settings might also appear in the product settings. This means that the product settings can override general settings for that specific product.

API URL and Token​

The API URL is a core setting that connects the plugin to a platform. By default, this is connected to the Expivi production platform. In exceptional circumstances, the setting can be changed to a different platform.

As described during the installation, the token field allows users to enter the API token generated from the Backoffice.
Make sure only to use an API key of type "Viewer Token" here, as it only provides read access. It is also recommended to enter your website's domain in the "Host" field to limit the accessibility of the token.

warning

Ensure no extra spaces or new lines are added in the field, rendering the token invalid.

Upload URL​

Based on your product configuration, you may have attributes like 'image upload', 'svg image' or 'svg canvas'. These attributes allow users to upload assets like images. These assets need to be stored on your server. This settings field allows you to define a URL of an API that stores and retrieves the assets.

To help you out, we have already created a file that will act as an API upon placement in your website's root folder. You can download the file here: https://download.expivi.com/woocommerce-upload.zip.

Once placed in the root folder of your website, you can enter the setting field like: https://www.your-website.com/upload.php.

Price selector​

WooCommerce's templates might have different definitions of how the price should be displayed on the product page. Usually, the price HTML element will have a selector of p.price, our default value. If this is changed, you can update the new selector here.

Price calculation​

Calculating the correct price for your product is essential. By default, our configurator will detect your website's language and use that to retrieve the correct price defined through the Backoffice. The "Use website language" option will use get_locale() functionality with a fallback to en-US.

For example, when using the locale en-US, the first part is declared as the language and the second part as the country. The language will be used to define the translations for the attributes, while the country is used for the pricing.

For most cases, this will work as expected; however, if you want your users to switch between languages (multilingual store), it might lead to some issues. When switching between languages (by using a third-party plugin), the locale will automatically change the 'country' part, which might conflict with your preferences. This happens because there is a limited list of language/country combinations to define a correct locale. See list of locales here. For example, the fr-US locale is not possible, as French is not a standard language in the United States.

The "Use country of store location" option will override this behavior by including a 'country' property as an addition to the locale. This option will use WooCommerce store country method with a fallback to us. This will make it possible to show your website in French while displaying US prices.

This functionality provides a couple of hooks to override the behavior, please visit the Advanced Settings page for more info.

Reconfigure button​

Enabling this option will display a "Reconfigure button" for Expivi products in the cart. This allows the user to reconfigure their products after they have been added to the cart. For convenience, there is also a text field to change the button text.

Append options to hook​

The Expivi plugin depends heavily on WooCommerce hooks to provide a good shop experience and grow along with your e-commerce solution. This means that if a WooCommerce theme does not support the core list of hooks/functionality provided by the WooCommerce plugin, the Expivi plugin might not work well. For example, the woocommerce_before_add_to_cart_button and woocommerce_after_add_to_cart_button hooks are required to show the 3D visualization on the product page. The Expivi plugin requires only one of the two hooks, which makes it possible to easily switch if the other hooks are missing.

In addition, this functionality also allows you to change the position of the "Add to cart" button to be either on top or at the bottom of the product page.

Blacklisted words and Notification​

Some Expivi products will contain attributes of type text_input or text_to_image for showing text on the 3D product and/or to supply text to the order details. However, some users might abuse this by using foul language or offensive words. This settings field will help you censor certain words in these input fields to keep your product professional and avoid brand damage.

In the "Blacklisted words" field, you can enter a list of words that needs to be censored. All words will automatically be lowercase to avoid redundant case-sensitive combinations. All words need to be separated by a comma. Example: hello,world,these,text,will,be,censored.

The "Blacklisted notification" text field helps you define the notification that will be displayed if a censored word is detected. This settings field accepts HTML to personalize the notification.

The "Resolve blacklisted words" field will help you define what action needs to be taken when a censored word is detected. It is possible to choose to either not act upon it, filter the word, or replace the word with asterisks.

note

The "Blacklisted words" field is an essential way to censor certain words. For more advanced functionality, it is possible to use the WebPurify plugin in the Backoffice. This plugin will work for both the text inputs and images.

Generated Product Visibility​

By default, when a "Simple" product is ordered, the Expivi configuration is attached to the order details, which will be shown during the checkout and finally in the order for the shop owner. If the cart process is set to "Multiple" or "Grouped," the ordered product will generate new WooCommerce products based on the linked products but with different prices. These generated products are required to help the e-commerce experience be consistent and avoid breaking third-party plugins' support. The visibility settings will help keep the shop and catalog clean by hiding the generated products.

Read more about it on the Product Configuration page.

Save My Design​

The "Save My Design" feature is a functionality that helps users save their product configuration and optionally share it with a representative.

Form and Templates​

The forms that are displayed to the user are fully customizable in templates. It is possible to create any kind of fields that the user should enter before they can save the design. The template will also be used for validation, so attributes like pattern, type, required, or length will validate the user's input.

Supported types:

Supported attributes:

  • type - Attribute is required as it is the basis for validating the types described above.
  • data-required - Describes if the field is required to be filled by the user.
  • pattern - Regex pattern used for validation.
  • min / max - Minimum and/or maximum value for fields of type number.
  • step - Attribute to specify the legal number between intervals. Used for type number.
  • min_length / max_length - Minimum and/or maximum value for fields of type tel.
note

We recommend not using this functionality to generate quotes. The designs are only saved, so they can be viewed later. Any other data in the form is not saved.

Representative and Additional Email Address​

This feature will add a button in the success message to let the user decide whether to send the form and design to the company's representative. The option is optional to the user.

Getting a copy of the email sent to the customer is also possible. This can be done by filling in the "Additional email address" field.

Expivi offers the ability to generate print-ready files based on products configured by the user. This feature will only work if you have products that make use of print-ready files. It is recommended to leave this feature off if you do not have any products that make use of them.

This feature requires an API key of type "Team Owner Token."

Once enabled, it will detect if the product contains SVG attributes and automatically generate the print-ready files during checkout. The link to the print-ready files will be visible in the order for the shop owner.

warning

Do not share this token, as it provides read-and-write access to your account. It is recommended to enter your website's domain in the "Host" field to limit the usability of the token.