# Products

There are two different types of products:

  • Basic: upload a static 3D model to show it in the 3D viewer.
  • Configurable: customizable, extendable products where you can change part properties individually.

NOTE: Configurable products are not supported in Level 1.


In the Products overview list you can see all your products in one place. The overview can be displayed in a List view or a Thumbnail view. To change the view, click on the icon in the upper right corner of the overview, next to the search textfield.

To find a product, you can search for the Name or the Roomle unique product ID of a product in the search textfield. The search is case-insensitive.


NOTE: If you are not in a Level 1 plan your products are grouped by catalog and you have to select a catalog first.


# Create or remove a product

# Create a basic product

To create a new product

  1. Click on the red plus button inside the overview.

  2. Depending on your level, you must now make the preselection for a Basic Product. Therefore click on UPLOAD. If you are in Level 1, this step is not relevant for you.

  3. Upload your 3D content. In the section 3D model, select the file using the button CHOOSE FILE or drag and drop the file and click UPLOAD.

  4. You will see a preview of the 3D model and two bars visualising the number of triangles and textures with an indication if this content is ready to use in Rubens Admin. You might see the following indications:

    • Content is Perfect will be indicated in green. The number of triangles and textures is fine for Roomle Rubens.
    • Content is OK for Rubens Admin. It Could be better but still ok and it is marked in yellow.
    • Content analysis numbers are Too high. Please correct your data and upload again! means the content has to be reviewed and should be fixed, because the numbers are too high and it should be below the max number inside the complexity limit reference. Otherwise the fast download times and smooth user experience are at risk.

    You can also see a detailed table which contains all information about the uploaded 3D content. This is helpful to evaluate the quality of the content before creating the product.

  5. Click SAVE to save your product and autogenerate the Product images and the Integration links.

You will be redirected to the Products overview where the Processing icon indicates, that the model is still uploading. As long as the upload is not finished, you can only edit the General information. It may take more than one hour until the importing process is finished.

As soon as the upload is finished, you will be notified by an email. Click on the Go to product button in the email or select the product manually in the overview.

Go to Embed a product to integrate your created product.

# Create a configurable product


NOTE: Configurable products are available in Level 2 and higher. Your user account requires Catalog Management Rights. Log in on Rubens Admin (opens new window), open Catalog management and click on the catalog you want to add configurable products to.


  1. Select Components in the top menu bar. Click on Create component (the red plus button) to create a new component.

    1.1 Fill in the Name. Choose a natural key for the External identifier or select Auto generated ID. We recommend using a custom key.

    1.2 Copy and paste an existing Component definition and Save your changes. If you do not have an existing component you can learn how to script in the scripting course.

  2. Upload "External Meshes" in the Import / Export section to use them inside your scripts.

    2.1 If your component is using basic primitives exclusively, you can skip this point. To improve the loading performance we recommend using External Meshes over the AddMesh command with in-line parameters.

    2.2 Read through the Blender Addon Documentation for details on how to create an "External Mesh" from your 3d model.

  3. Create the materials referenced in the component script.

  4. Create the product based on the component script.

    4.1 Navigate to Products and click on Create product with the red plus button. On the dialog choose Configurable.

    4.2 Fill in the Product name. Choose a natural key for the External identifier which makes urls more readable.

    4.3 Scroll down to Product details and fill in the required fields Width, Height and Depth. You can add random numbers here if you do not know the actual size of the product yet.

    4.4 Scroll down to the Configuration definition section. Select SHOW SCRIPT. Add a basic configuration definition using the root-component’s id. See the following configuration definition snippet:

    {
        "componentId": "yourExternalComponentId"
    }
    

    Replace the yourExternalComponentId in the code snippet with the External identifier of your component. Navigate to Components and select a component from the list. Copy the External identifier and paste it to the sample configuration definition above. The basic configuration should look like the following:

    {
        "componentId": "product_samples_level2:coffeemachine"
    }
    

    4.4 Save your changes

    4.5 Click on SHOW CONFIGURATOR in the Configuration definition section to open the configurator view.

    4.6 Refresh the page to load the configuration.

    4.7 You can generate the thumbnails for the product now.

  5. Configure the product

    There are two possible approaches how to configure your product:

    5.1 Configure the product in the configurator view. You can configure the product to set the parameters and save your changes. You can proof this by switching to "SHOW SCRIPT". All parameters are saved.


    NOTE: Parameters set in the configuration will overwrite the default value set in the component.


    5.2 As an alternative approach you can write the parameter values manually in the script. This way default values of the component won’t be overwritten by the item which makes your component more flexible for future changes.

From here you can embed the product on your own website.

If you need to create many configurable products using a lot of components, materials, textures and external geometry the Import / Export section might be helpful for you.

# Remove a product

If you do not need the product anymore, navigate to the Products page. Move the cursor to the product, you want to remove and click on the trash can icon that appears. The product will then no longer be displayed in Rubens Admin. The product still remains in the cloud to maintain connections, therefore existing integrations are not affected by this.

# Embed a product

In the Products overview, select the product you want to embed. Open the product detail page and navigate to the Integration links section.

This section contains various links to work with. The Top image and the Perspective image can be integrated via the link directly or you can open the links in a new browser window and copy the picture to use it.

To embed Roomle Rubens into your webshop, there is an Embed code that is the HTML code that you can simply copy and paste to your website. To give you a better idea of where and how to insert this code, there is a so-called sandbox. Click on the GENERATE SANDBOX button. As soon as the sandbox is created, the button changes its state to Edit on SandBox. Click on it again to open the sandbox. You can also see a complete Integration example, which is helpful if you want to deeply integrate the product into your webshop.

# Manage existing products

To edit an already existing product, select it in the Products overview and click on it.

Update the 3D model

To update the 3D model of an existing product

  • drag and drop the file and click UPLOAD or select the file with CHOOSE FILE to upload it under 3D model.
    • Upload as single file in these extensions: .fbx, .blend, .obj, .3ds, .glTF(.gltf + .glb) or .glTF-binary(.glb)
    • or packed as .zip or .tar.gz.
    • If you do not have 3D data files at hand, you can have a look at our sample products.
    • All files have to meet the 3D asset requirements.

It may take more than one hour until the importing process is finished. As soon as the upload is finished, you will be notified by an email. Click on the Go to product button in the email or select the product manually in the overview.


NOTE: The integration links of your products will change by uploading a new 3D model!


General

Set your Product name and Description and click SAVE in the upper right corner to save your settings. DISCARD will discard your changes.

Get product images

The perspective and top images of the product are autogenerated when it is created and the 3D model is defined.

When you configure a product, the images are not automatically regenerated. To get the images of the current configuration, click on Generate images and Save your changes.

It is also possible to upload your own pictures. To do this, delete the generated images by clicking on the trash can icon. After that, you can upload and use your own images as you wish. It is possible to generate images of the current configuration at any time. Note that all existing images, including your own, will then be overwritten.

To get the product images, go to Integration links, copy the links of the Top image or Perspective image and open it in a browser.

# Create variations


NOTE: The features described below are not available in Level 1.


As soon as you have configurable products, the need to configure and store variations of individual products arises. To create a variation of a product, navigate to the Products overview list.

  • Either navigate to the details page of the product of which you want to create a variation directly here. Scroll down to the Variations section and click the red plus button.
  • Or click on the red plus button directly and then select CHOOSE in the Variation panel and select here the product from which you want to start.

Whichever way you choose, now configure the product in the loaded configurator, enter a Product name and Roomle unique product ID and click SAVE VARIATION. You can repeat this process as many times as you like. Each saved variation is displayed in a list at the bottom of the page.

Variations created in this way are linked among themselves and are always displayed in the Variations section.

# Request renderings


NOTE: The features described below are not available in Level 1.


You can request high quality renderings of your configurable products. To do so, navigate to the detailed view of the desired product. Scroll to the Renderings section and trigger renderings in four steps:

  1. Select all the perspectives you want. The sofa as an example image will give you an idea from which respective angle on the product the image will be created.
  2. Select the desired quality, you can choose between 2K and 4K.
  3. Press the `REQUEST RENDERINGS´ button. A dialog will appear with the total number of requested renderings for final confirmation.
  4. Press START RENDERING.

As soon as your renderings are ready, you will receive an email with a download link.

Render variations of a product

The description above is used to render an existing product. If you want to request renderings of a product variation, there are two ways to do this.

The first way is to create a variation of the product in the Variations section and request the renderings as described above. The variation will then be saved as a new product and can be retrieved at any time.

The second option is to load a page with the configurator in the Renderings section of the desired product via the RENDER VARIATIONS button. Now configure the product according to your wishes, select the desired rendering parameters and start the renderings via the RENDER VARIATION button. Again, a dialog will appear to confirm the request. In this way, no additional product is created.


NOTE: The RENDER VARIATION button will only become active once you have made a change to the existing product.


# Export a 3D model


NOTE: The features described below are not available in Level 1.


You can export your configurable product as a 3D file. To do so, navigate to the detailed view of the desired product and scroll to the Export section.

Select the desired file format and click the EXPORT button. The following file types are supported: blend, glb, abc, dxf, fbx, dae, x3d, ply, stl, usd, usdz and obj. Once the export is ready, you will receive an email with a download link.

If you want to export the product again in another format, simply click the START NEW EXPORT button and start from the top.

Export variations of a product

The description above is used to export the current configuration of an existing product. If you want to export a product variation, there are two ways to do this.

The first way is to create a variation of the product in the Variations section and export it as described above. The variation will then be saved as a new product and can be retrieved at any time.

The second option is to load a page with the configurator in the Export section of the desired product via the EXPORT VARIATIONS button. Now configure the product according to your wishes, select the desired file type and start the export via EXPORT button. In this way, no additional product is created.


NOTE: The EXPORT button will only become active once you have made a change to the existing product.


Export variations of a product

The above description is used to export an existing product. If you want to export a product variation, there are two ways to do this.

The first way is to create a variation of the product in the Variations section and export as described above. The variation will then be saved as a new product and can be retrieved at any time.

The second option is to load a page with the configurator in the Export section of the desired product via the EXPORT VARIATION button. Now configure the product according to your wishes, select the desired File type and start the export via the EXPORT button. In this way, no additional product is created.


NOTE: The EXPORT button will only become active once you have made a change to the existing product.


# Organize product structure

If you have many products, it becomes necessary to structure them to keep track of them. Rubens Admin offers you several ways to organize and structure your products.


NOTE: The features described below are not available in Level 1.


# Sort products

The easiest way to organize your product list is by sorting it. When creating a product, you can set a numeric value in the Sort field under the section Product details. If you do not set a value, it will default to 0. For existing products, you can set the value in the Products overview list. Move your cursor over the value of the Sort order column in the row of the respective product. Click on the value or the appeared pencil icon, enter an integer and press Enter or click outside the input field to save the new value.

The rows will not automatically re-sort unless you have sorted the table by Sort order. To do so, click on the Sort order column name.

# Catalogs

The creation of catalogs and assigning products to them is another way to add a structure to your data.

Click on Catalog management on the dashboard to get to the overview list of your catalogs. The overview can be displayed in a List view or a Thumbnail view. To change the view, click on the icon in the upper right corner of the overview, next to the search textfield.

To find a catalog, you can search for the Name of a catalog or the Roomle internal catalog ID in the search textfield. The search is case-insensitive.

To create a new catalog,

  • click on the red plus button inside the Catalogs overview.

  • Under General, set a Catalog name and a Roomle internal catalog ID. You can also check the Auto generated ID checkbox, then the Roomle internal catalog ID will be automatically generated. The ID is not editable once the catalog was created. If you want to, you can also set a Catalog description.

  • Check the Available for public checkbox if you want to allow any user of the Rubens Configurator to view the products of this catalog. To make the catalog available in the Roomle iOS App or Floorplanner (Web), users must be given explicit permission:

    • The catalog can be assigned directly to a user.
    • As an alternative a catalog can be made visible via the tenant. The user needs the rights in the tenant to see catalogs which are not public. Both of this permissions can currently only be given by the Roomle support team. In Rubens Admin a catalog is only visible to the owner of a catalog.
  • Check the Hidden checkbox if you do not want to display the catalog and the contained products temporarily or for a longer period of time. Embedded configurators will then no longer display the product.

  • Check the Free checkbox to provide the catalog to all users for free. If you deselect this, only users who purchased the catalog have access to it. This feature is rarely used at the moment so we recommend to activate Free, otherwise embedded configurators will not display the product.

Note, that it is not possible to delete or archive a catalog.

Under the General tab within a catalog, you can handle different metainformation, like Catalog images and Categories.

You can define three different images for a catalog:

  • the Catalog cover,
  • the Brand logo and
  • the Feature image.

If you want to delete the uploaded image, simply click on the trash can icon beneath it. Click SAVE to save your changes.

# Categories

To further subdivide products within a catalog there are Categories. The first category is created automatically and corresponds to the catalog, which is also reflected by the name.

To add a sub-category, click on the respective category you want to subordinate it to. Click on New category, insert the name of your new sub-category in the appeared textfield and press Enter or click the ADD button. It is not possible to delete a category, once it is created. The name of a category is globally unique.

You do not need to save these changes again.