Configuration XcalibuR configurators

Documentation: XcalibuR configurator plugin for Shopware 6

1. open the menu item → in the Shopware backend

2. you can now add a new configurator to your installation via the button. Any number of configurator instances can be created here, but one is completely sufficient.

3. fill in the corresponding configuration fields and then save them:

Basic data configurator

Title (required)

Enter a title here by which you can recognize your XcalibuR configurator by name.
Example: My Blazor configurator (blazor.xcr.my-domain.com)

Use this configurator for the stand-alone configurator page

Activate this slider to set the XcalibuR configurator as a stand-alone configurator.
This means that this configurator can be used as an empty configurator via the "https://meine-domain.com/xcalibur/configurator/" page.

URL of the configurator (required)

Enter the URL here that you can use to start the XcalibuR configurator without Shopware. Example: "https://blazor.xcr.meine-domain.com".

PDF print layout ID (required)

Enter the ID of the print template in XcalibuR that is to be used as a template for exporting a configuration as a PDF (example: fa31525c-ccc5-44cd-8d90-65eb665ae333).

If you do not know your print template ID, you can request it directly from Diomex or determine it as follows:

1. Open your XcalibuR configurator directly (i.e. outside the store)
2. Create a valid configuration
3. Click on "Export" in the NavBar and click on the name of the desired style sheet (e.g. "Standard")
   
4. A new browser tab will now open with the corresponding PDF file. At the top of the URL you will now find the ID of your print template behind the parameter "OrderPrintTemplateId=":
   

Included tax rate of the prices transmitted by the configurator (required)

Enter 19 here by default to store the tax rate for 19%.

Tax rate for configured products (required)

Select a standard tax rate for the configured products. The default tax rate must be stored in the store. A new tax rate can be created under Settings → Shop → Taxes in the Shopware 6 admin area.

Currency of the configurator prices (required)

Select the default currency for the configurator. The currency must be stored in the store and a new currency can be created under Settings → Shop → Currencies in the Shopware 6 admin area

3D image generation

If Onmiverse is available to you as a rendering service, you can generate 3D images for the individual configurations and save them on the article. To do this, activate 3D image generation in the plugin configuration. The IDs of the selected rendering templates as well as the resolution and the desired quality are entered in the corresponding fields.

Design configurator

Select design

You can either use the burgdigital standard design by activating the Use standard design checkbox or alternatively select an individual design. You can enter a design created by Diomex (input: name of the design) or the complete URL to a stylesheet file (CSS)

Comfort functions

Show connect button

The configurator offers you the option of connecting to an existing configuration so that you can edit it in parallel. This is done in real time and changes are displayed in all open configuration sessions (even on different devices).

This can be useful if a consultant wants to support an end customer with the configuration, e.g. to resolve configuration errors that are not always immediately apparent.

To connect to a configuration, you need the corresponding URL. This is displayed in the configurator when you click on the "Connect" button. A link then looks like this, for example: "https://meine.domain.com/xcalibur/configurator/?ConfiguratorId=3e2aaef0-7c33-4f76-a23a-0d55adcbd425"

If no further parameters are specified, the XcalibuR configurator is called up with the standard Diomex layout (usually the koinor design) instead of the design that is used in the store.

This is important to know because the layout can also be used to hide buttons. This means that the interface for the customer in the store may look different from the configurator of the specialist consultant who does not use the design.

IMPORTANT: Connecting only works as long as at least one configuration session is still open. If all participants have finished their configuration, it is no longer possible to connect to it.

If you activate the selection field, you can select any target page.
This target page must be created in advance in the Shopware 6 admin area under Content → Shopping Experiences.

Show share button

XcalibuR offers you the option of sharing a created configuration so that you can edit it as a copy. Changes in a copy never affect the original.

This can be useful if a consultant wants to make an alternative suggestion to an end customer for a configuration. Or the communication does not take place at the same time and therefore linking to a configuration is out of the question.

To call up a copy of a configuration, you need the corresponding URL. This is displayed in the configurator when you click on the "Share" button. A link then looks like this, for example: "https://meine.domain.com/xcalibur/configurator/?ConfigurationId=ae5f3e60-ef12-4015-8e4b-62af06b7ff01"

If no further parameters are specified, the XcalibuR configurator is called up with the standard Diomex layout (usually the koinor design) instead of the design that is used in the store.

If you activate the selection field, you can select any target page.
This target page must be created in advance in the Shopware 6 admin area under Content → Shopping Experiences.

Show "Receive configuration as PDF" button

If the slider is active, an additional button is displayed in the open configurator ( ).
This button then opens a form in which at least the first name, surname and email must be entered in order to have the configuration sent to you as a PDF. Additional fields can be added in the lower configuration area via additional fields in the "Receive configuration as PDF" form.

The email that is sent can be edited using the email template XcalibuR Receive configuration as PDF (Settings → Shop → Email templates → Receive XcalibuR configuration as PDF).

• Email address for BCC of "Receive configuration as PDF"
  If a customer has a configuration sent to them as a PDF, a blind copy of the email is automatically sent to the address entered in this field.
• Additional fields in the "Receive configuration as PDF" form
  At this point, additional fields can be added to the form for sending a configuration by e-mail.
  Possible fields (in addition to the standard fields First name of customer, Last name of customer and E-mail address of customer) are

Show "Request to furniture store" button

If the controller is active, an additional button is displayed in the open configurator ().

This button then opens a form in which at least first name, surname and e-mail must be entered.
When the form is sent, the configuration is sent as a PDF to the address entered underEmail addressfor "Request to furniture store".
Additional fields can also be added here via additional fields in the "Request to furniture store" form.

The email that is sent can be edited using the email template XcalibuR Send configuration to store (Settings → Shop → Email templates → Send XcalibuR configuration to store).

• Additional fields in the "Request to furniture store" form
  At this point, additional fields can be added to the form for sending a configuration by email (see above).
• The customer automatically receives a copy of the email for "Request to furniture store".
  If the button is activated, the customer will also receive the configuration sent to the furniture store at the email address they entered in the form.

URL to the privacy policy

Please be sure to fill in this field if you want the user to be asked to confirm the privacy policy when receiving the configuration as a PDF and sending the request to the furniture store. Simply enter the URL of your data protection page.

Configure comfort functions via Flow-Builder

Since the update of the XcalibuR configurator plugin to version 5.12.3, it is possible to configure the two comfort functions Request to furniture store and Receive configuration as PDF for e-mail delivery yourself using so-called flow events. Shopware Standard offers this option in the settings.

Advantages of the feature

You can use the feature to determine

• When an email should be sent.
• Which email template should be used.
• Which further actions should be executed when the event occurs.

In order for the mail to be sent via the flow builder, an important configuration must be made in the configurator. This is explained in the next step.

Switch for integrating the convenience functions in the flow builder

At present, you can first decide for yourself whether the mail should be sent via the Flow Builder. To do this, you must select your configurator under the menu item → → and activate the switch Email dispatch via Flow Builder under Convenience functions. If this is active, the mail is sent via the Flow Builder. If not activated, the standard mail dispatch from the configurator plugin will be used.

To determine the trigger for sending the form, follow the next step.

Configure XcalibuR Flow Event Trigger in the Flow Builder

1. Open the settings of your store and click on Flow-Builder.
2. Click on the Add flow button .
3. In the General tab, you must give the event a name under General information. E.g. Furniture store request sent. A description is optional.
4. Activate the Active button and open the Flow tab.

5. Selecttrigger . The triggers provided by the XcalibuR plugin are located under the XcalibuR folder. E.g. Furniture store request sent.

   
6. Save flow changes

This completes the setup of the trigger (or flow event). But to determine which actions should be executed when this event is triggered, you have to configure this event. The next step explains how to assign the actions to this event.

Configuring actions in the XcalibuR flow event

1. If you are under Settings → Flow Builder, click on the three dots of the flow you want to edit and click on Edit.
2. Under the Flow tab, you can add an action (THEN).
3. A small card should now appear. Now click on Select action ... and select an action such as Send email.
4. Now you can configure this action yourself as desired. You can either use the default sender address or enter a user-defined one. You can also specify the recipient of the e-mail. If you want the customer who has filled out the form to receive an email, select Guest customer under Recipient.
5. There is something important to note under Email template. If your flow event is based on a furniture store inquiry being sent, then select the appropriate email template, such as Send XcalibuR configuration to store.

The advantage of the flow builder is that several actions can be executed there. You can also decide which actions should still be executed when the flow is triggered.

Help functions

Show help request button

You can use this function if you want to integrate a form (directly from the store or e.g. from a ticket system) into the configurator. If the controller is active, an additional button is displayed in the open configurator under "Advice" ()

This button then calls up the URL in the configuration field URL to the external or internal help page and also transmits the respective bxbConfiguratorId, the bxbConfigurationId and the URL of the XcalibuR configurator(bxbConfiguratorUrl).

Using the Configurator-Id or the Configuration-Id in combination with the URL of the XcalibuR configurator, you can, for example, generate a link via which a service employee can connect to the corresponding configuration in order to edit it in parallel (see "Show connect button") or call up a copy of the configuration (see "Show share button").

URL to the external or internal help page

Here you enter the URL to which you will be redirected when you click the Request help button.

Support telephone number under "Help & Support"

A support telephone number can be entered here, which is displayed to the customer as an additional button () under the "Advice" tab. If no entry is made here, no field will appear in the configurator under "Advice".