# Administration

# Invite a new user


NOTE: Multiple users are not supported in Level 1.


If you want to add a new user to your tenant,

  • navigate to User management on the dashboard.
  • Click on the red plus button in the Users list.
  • Enter the Email address of the user you want to invite.
  • Assign the desired Roles by clicking on the red plus and selecting the respective role. You can assign as many roles as you like.
  • To send the invitation, click on SAVE.

The user will now automatically receive an email in which he must confirm his address to create his account.

# User settings

Manage your personal settings like name, email address and password. When you are logged in, there is an avatar icon in the top right corner. Click on the icon, then on your email address to open the user settings of your account.

# Edit personal data

Under User profile, enter First name and Last name and click SAVE to save your changes. DISCARD will reset your changes.

In this section you can also find the information when your account was registered and when you logged in the last time.

# Change email address

Under Change email address, enter the new email address and your password and click CHANGE. You will receive an email when the email address was successfully changed.

# Change password

Under Change password, you have to enter the Old password and New password and click SAVE PASSWORD.

# Delete user account

If you want to delete your user account, navigate to the Floorplanner user settings (opens new window) and click DELETE ACCOUNT. You will not be able to undo this action. Please be aware that access to Rubens Admin and Floorplanner will no longer be possible afterwards.

# Rubens settings

The Rubens configurator has several properties that can be set and change the appearance. This includes, for example, showing and hiding the AR button or setting an initial floor material. You can find the full list of properties here (opens new window).

You can change the Rubens configurator settings in your tenant account by following these steps:

  1. Click on the hamburger menu on the top left. A drawer menu shows up. Now click on Tenant settings.

  2. Inside the Tenant settings page, you will see a selected configurator ID. If the tenant account has multiple configurators, you can switch between them using a select box.

  3. Type the settings in the textarea on the page. The input has to be valid JSON, see our examples here. To see how it will look, there is a RELOAD PREVIEW button to reload the displayed configurator with the new settings.

  4. As soon as you are happy with the result, click the SAVE button on the top to publish the changes.

# Rubens settings examples

Find a list of examples of the Rubens settings here to understand how they need to be set. You can simply copy and paste the code into the Rubens Admin UI.

# Enable emails

Data type: boolean

If this is set to true the Save draft will be done by sending an email.

{
    "emails": true
} 

# Show or hide buttons

Data type: object

Show or hide different buttons like the AR or Export 3D button here. The full list of buttons can be found here (opens new window).

{
    "buttons": {
        "ar": false,
        "export3d": true
    }
} 

# Set the zoom distance

Data type: number

Set the distance to which the user can zoom in centimeters. The default is the object size divided by 10 or 10 cm.

{
    "zoomDistance": 3
} 

# Set the initial floor material

Data type: string

Set the floor material which is used when loading the configurator.

{
    "initialFloorMaterial": "roomle_floor:DresdenEiche"
} 

# Set the skin

Data type: string

Set the primary color for the Rubens configurator.

{
    "skin": {
        "primary-color": "blue"
    }
} 

# Override translations to change labels for some or all languages

Override translations to change labels for some or all languages. The full list of labels can be found here (opens new window).

{
    "translations": {
        "en": {
            "params": {
                "request-product": "Add to cart"
            }
        }
    }
} 

# Setting multiple properties at once

{
    "emails": true,
    "buttons": {
        "ar": false,
        "export3d": true
    },
    "zoomDistance": 3,
    "initialFloorMaterial": "roomle_floor:DresdenEiche"
} 

# Analytics

Under Analytics you will find information about the use of the embedded configurators. To get there, click on the hamburger menu on the top left. A drawer menu shows up. Now click on Analytics.

# Saved configurations

Under Saved configurations you can see which configurations are saved by users. Once a user uses the Save draft functionality in Rubens, the information about it is saved and can be exported here as a CSV or JSON.

Note that only save draft events which are sent to an email address will be counted. Add "emails": "true" to the configurator settings to activate this feature.

The file can be exported for a selected Period and Configurator ID and contains the following information:

  • link the actual link to the Rubens configurator in which the product is loaded according to the saved configurations.
  • thumbnail the preview image of the saved configuration of the product.
  • creationDate the time at which the configuration was saved.
  • userEmail the email that was specified. This will only appear if the user has given their consent for their email to be used by opening the link in the email sent. Otherwise, this field is empty.
  • action the action that the user performed in the Rubens UI. In the case of saved configurations this is always SaveDraft.
  • partlist contains an aggregated view of the current components (and subcomponents) according to the saved configurations. See more about partlist here

# Prices and billing

  1. There are two easy ways to access your billing information:

    • Open the hamburger menu in the top left corner. Click on Pricing & billing to open the pricing and billing details page.
    • Click on the user profile in the top right corner to open a dropdown menu. The section PRICING & BILLING shows your current account status. Click on the more info button to open the pricing and billing details page.
  2. Choose one of the provided packages and click UPGRADE to add the billing information. If you already purchased a package, you can see a panel with your Billing information on the price and billing page. You can easily update the information by clicking on the change billing information.

  3. A form with your current billing information is shown. Update the information and click on SAVE. Use the GO TO STRIPE button to verify the changes will be printed correctly on your next invoice.