Skip to main content
Version: Released

Initialization

This page describes how to initialize the storage configurator.

You will need to know how to set attributes or send events to the configurator πŸ”—

Mandatory data​

Simple launch​

The most common use case: you want to lauch the configurator on an empty project. You only need two things:

Attribute nameAttribute value
data-distribution-idThe id of your application distribution.
data-authentication-tokenYour authentication token.

Note: See the communication page to know how to send an event πŸ”—.

Simple project load​

You can load an already existing project.

The common use case is this one:

To do so, you will need a third attribute:

Attribute nameAttribute value
data-project-uuidThe uuid of the project you want to load.

Alternatively, you can send the project uuid in the initialization event.

const projectToLoad = {
projectUuid: "[The project uuid]"
}
configurator.dispatchEvent(new CustomEvent("configuratorInit", {detail: projectToLoad}));

Optional data​

The best way to configure the optional attributes is to set their value in your application distribution, but you can also choose to configure it in the DOM.

The values you set in the DOM will override the eventual values from the Application Distribution.

See the Storage Configurator integration dedicated page πŸ”—.