Create and manage Pre-config rules

Let end-users configure products based on your rules, to be able to sell and handle complex product offerings.

Pre-config is an advanced plugin that offers bundling or configuration of products. You can set up rules on what product should be bundled/configured with other products and also decide if some service should be added to the configuration.

Example of a pre-config setup in an e-commerce webshop:

A pre-config setup can be used in multiple use cases, such as configuring a car with the correct motor, tires, audio system, roof rack, towbar, and so on, or a computer with the needed RAM, processor, hard drives, operating systems, etc.


Overview

Add new Pre-config rule

Handling pre-config rules

PAPI metadata


Overview

The pre-config management plugin is available from the main navigation bar. If the pre-config icon is not presented directly, click the 3-dots icon to expand the menu.

Filters

You can apply filtering criteria to find relevant pre-config rules. Filtering can be done based on specific asset information; Name, Main product, Main category, Linked product, Linked Category, Pre-config service product, and Status. Multiple criteria can be added to reduce the number of rules found. 

The current filter criteria are presented above the grid. 

  • You can remove a specific criterion by clicking the [x] in the relevant pill.
  • You can remove all criteria by clicking Clear all.

Grid

All pre-configs matching the current filter criteria are presented in the grid. If there are more than the number set for Items per page (default 20) you can browse through the pages from the lower right corner. You can also change the number of items to be presented per page by clicking the arrow button.


Add new Pre-config rule

To register a new pre-config rule, do the following:

  1. Click the plus icon (Add pre-config rule) in the upper right corner:
  2. The Add a new rule window is presented. Register information as follows:

    • Name: Specify a name for the rule (mandatory).
    • Description: Specify a description for the rule.
    • Pre-config service product: Select a product that may be used as a service.

      Note: The service product could for example be a service to mount a screen protector to a mobile phone. A service/action performed on the main product (with or without linked products).

    • Pre-selected: Select if the linked product(s) should be pre-selected in front-end application.
    • Reset on change: Select whether a specific action should be available in the front-end application. Example of usage:
      • "No": The end-user is allowed to replace linked products (not remove) from the pre-configured product selection. 
      • "Yes": The end-user is only allowed to remove linked products from the pre-configured product selection.
    • Must have stock: Select whether the linked products need to be in stock to be selectable.
    • Allow non accessory linked products: Select whether linked products need to be accessories (have some relation) to the main product.
    • Status: Select whether the rule should be Active or Inactive once saved.
      • An activated pre-config rule will be available in PAPI after a publish, note that you must have included the pre-config metadata provider in your PIM setup to have the data available in PAPI
      • You can always use MAPI to fetch data, then you are responsible for handling inactive/active as our business rules request.
  3. Click Save when you are done. 

Handling pre-config rules

Click a rule from the grid to open the details panel. The panel consists of 4 tabs; Details, Main Products, Linked Products and History. See the following sections for more information.

You can enlarge the panel by clicking the Expand button in the upper right corner. To delete the rule, click the trashbin icon (Remove) in the upper right corner.

Details tab

The information presented in the Details tab is the same as when creating a new rule, see Add new pre-config rule for more information.

The name and ID of the rule are presented at the top:

In addition, you can link a Custom icon to the pre-config. Click Add media, and select the relevant icon from the library:

You can remove the icon by hovering and clicking the "-" symbol. To replace the icon, you can click the pencil symbol and select another icon.

Main products tab

A main product in a pre-config rule is a product that the configuration is added to, like the mobile phone, car, or computer. The rule can apply to several main products:

You can add products in two ways; either by selecting products one-by-one (Add products), or by selecting one/more categories (Add categories). In the latter case, the configuration will be added to all products residing in the selected categories. 

To remove a category, click the X button (Remove) to the left of it.

To remove one/more products, select relevant products and click the X button (Remove products) on top of the products table.

Linked products tab

A linked product in a pre-config rule is a product that can be selected as an accessory or service to the main product. There can be several linked products in the config:

You can add products in two ways; either by selecting products one-by-one (Add products), or by selecting one/more categories (Add categories). In the latter case, the configuration will apply to all products residing in the selected categories. 

To remove a category, click the X button (Remove) to the left of it.

To remove one/more products, select relevant products and click the X button (Remove products) on top of the products table.

History tab

All actions performed on a pre-config rule are saved and presented in this tab. You can see who created/updated the rule, which changes were made and when:

PAPI Metadata

To use pre-config in PAPI, you need to get the plugin registered with the Metadata provider in your PIM setup, then the pre-config rules will be available in the main product "metadata" with the needed information/relations.

{
...
"metadata": [{
        "id": "preconfig",
        "value": {
          "preConfig": [... array of rules ...]
        }
  }
]
...
}

Example of one pre-config rule in the metadata

{
    "id": "635f233252faff000151667f",
    "name": "Mount screen protector",
    "description": "A nice descriptive text",
    "customIconAssetId": null,
    "preSelected": false
    "resetOnChange": false,
    "excludeOutOfStockLinkedProduct": false,
    "allowNonAccessoryLinkedProducts": false,
    "serviceProduct": [
        "635f233252faff000151667f"
    ],
    "linkedCategories": [
        "635f233252faff000151667f"
    ],
    "linkedProducts": [
        "635f233252faff000151667f"
  ]
}