You can create a configurator by simply clicking on the
+ New configurator button in the drafts page. You will get a pop-up in which you can choose a name for the configurator and a template. The following templates are available:
Empty- no settings or data are added beforehand
Simple- some basic controls for a 2D configurator UI exist in the template
Empty configurator with custom JS- no settings except the ones for custom JS is added
Responsive (navigation bottom)- includes a fully responsive UI with navigation at the bottom of the page
Responsive (navigation right)- includes a fully responsive UI with navigation on the right side of the page
When you add a new configurator, a draft is created automatically.
A draft is an unpublished version of a configurator. In a draft you can edit your data and the configurator design. You can preview your changes in your draft and can decide when your draft is ready to be published.
As soon as your draft is published, you have a live configurator, ready to be used and embedded on your website.
Deleting a draft will not be available until one published version exists.
Published configurator (link)
If there is a published version of the configurator, it can be accessed by everyone through a link. The link can be found on the dashboard or on the embed page. The structure of the link looks something like:
If the configurator isn't used anymore, it can be unpublished through the button in the drafts page. This action will delete the published version of the configurator, but it will not delete anything from the history.
Each draft that has ever been published is archived in the history. If something doesn't look good in your published configurator, you can always access the previous version in the history (preview the configurator as well as entering the editor in readonly mode).
In order to find the desired history version, you can enter a description text each time you publish the configurator.
Besides the initial draft which gets created upon configurator setup, you can of course create a new draft by clicking the
+ New draft button in the drafts page. (Tip: This also gives you the possibility to create a new configurator based on an existing draft).
A new draft is always based on the published configurator version.
There is a limit of 10 drafts that can exist at the same time per configurator. This means there can be 10 different unpublished versions of a configurator. To avoid chaos we recommend the following naming conventions for draft:
|In a "dev" draft you work productively on a configurator. There should never be more than one dev draft.|
|This draft can be deleted and is only used for looking up things in the configurator or for test purposes.|
|A "hotfix" draft is for small changes and should be published quickly. The draft should always be named with a short description of its purpose.|
|This draft is used when someone reviews the development of the configurator.|
Instead of your name, you can also describe the changes or adaptions that you will implement in this draft. e.g.: "dev price calculation"
You have several interaction possibilities with drafts (see three dot menu):
- Editing ... this will enter the configurator editor and allows you to apply changes
- Preview ... will preview the draft configurator in a new tab, do not use this link for embedding. The only main purpose of the preview is, to test your changes while developing a configurator.
- Clone ... Creates a new draft or configurator based on this draft version
A checkout cannot be tested in a preview. Checkouts just work for published configurators.
Assign asset bundle and configurators
After you have entered the configurator editor you can of course start editing the configurator logic, but at some point you probably want to use assets inside the configurator.
In this case, an asset bundle must be assigned to a configurator. This can be done clicking on the asset drawer in the top center, which lets you select your desired asset bundle. All versions of the asset bundle should now be listed, you probably want to assign the newest version at the top to your configurator. This will be done by clicking on the
+ icon on the left of the desired version.
Component and groups
In order to build your configurator logic, you can create components and cluster them together in groups.
The content of those components is Hive code, for more information see Hive introduction.
Embed finished configurator
After you have successfully created your first configurator, it is ready to publish, simple hit
Publish button in the top center in the configurator editor. This will create a new version (as already discussed above) and redirect you to the drafts page.
You can now embed your configurator wherever you want, for more info see embedding.