Bizzkit plugins

To integrate Bizzkit products like PIM, DAM, and Ecommerce Search with your CMS and enhance the Builder.io user interface, you need to install the Bizzkit plugins.

Registering plugins

Plugins must be registered within a space in Builder.io before they are available to users. This can be done by navigating to the settings of the desired space and then, within the Integrations category, clicking "Edit" under Plugins:

Next, insert the URLs for each plugin you wish to include and save:

The URLs for the Bizzkit products are as follows:

1
2
3
4
5
6
7

https://{CompanyName}-content.bizzkit.cloud/plugins/dam-file.system.js
https://{CompanyName}-content.bizzkit.cloud/plugins/ecs-dynamic-products.system.js
https://{CompanyName}-content.bizzkit.cloud/plugins/ecs-products.system.js
https://{CompanyName}-content.bizzkit.cloud/plugins/pim-brand.system.js
https://{CompanyName}-content.bizzkit.cloud/plugins/pim-categories.system.js
https://{CompanyName}-content.bizzkit.cloud/plugins/content-hub.system.js?pluginId=@bizzkit/content-hub
https://{CompanyName}-content.bizzkit.cloud/plugins/pim-global-list-item.system.js?pluginId=@bizzkit/pim-global-list-item

The PIM Global List Item plugin requires additional setup. See here

Editor plugins

The plugins offered by Bizzkit are of a type called "Editor plugin". This means they can be used as field types in Builder.io models:

When creating new content for your model, the custom field editor will display for entering data into the field:

Using plugins with custom components

Similar to data models, editor plugins can also be used as input types in custom components:

This ensures that users can only select values provided by the plugin integration, while offering an easy-to-use interface.

Reference

The plugins can be referenced by their respective type names and contain their own payload formats as described below. Note that only certain plugins can be used as targeting attributes.

DAM

• Type: Bizzkit DAM File
• Payload:

1
2
3
4
5

{
  "fileId": string,
  "croppingId": null | string,
  "filePath": string
}

• Targeting attribute: No

Ecommerce Search product

• Type: Bizzkit ECS Product
• Payload:

1
2
3
4

{
  "id": string,
  "segmentId": string
}

• Targeting attribute: No

Ecommerce Search product list

• Type: Bizzkit ECS Product List
• Payload:

1
2
3
4
5
6

[
  {
    "id": string,
    "segmentId": string
  }
]

• Targeting attribute: No

PIM brand

• Type: Bizzkit PIM Brand
• Payload:

1

string // The brand's system/unique name

• Targeting attribute: Yes

PIM global list item

• Type: Bizzkit PIM Global List {globalListSystemName}
• Payload:

1

string // The system name of the global list item

• Targeting attribute: Yes

PIM product category

• Warning: This plugin is deprecated in version 25 and will be removed in version 26. Use PIM product category targeting instead.
• Type: Bizzkit PIM Categories
• Payload:

1
2
3
4

{
  "id": string,
  "systemName": string
}

• Targeting attribute: No

PIM product category targeting

• Type: Bizzkit PIM Categories Targeting
• Payload:

1

string // The product category systemName

• Targeting attribute: Yes

PIM Global List Item plugin setup

The PIM Global List Item plugin requires some additional setup.
After registering the plugin, click the "Edit Plugin Settings" button to register the PIM Global Lists for which you want to create editor plugins.

The system name of the global list in PIM must be set exactly the same as in PIM, as well as the segmentation ID and culture name. The entered segmentation ID and culture name affect the values displayed to the user, so they should be appropriate for the intended user. For each global list registered this way, a field type is added with the name "Bizzkit pim global list {globalListSystemName}".

UI plugins

Another type of plugin is a plugin used to enhance the Builder.io user interface with additional functionality. For example, the Bizzkit Content Hub plugin adds a new tab to the Builder.io sidebar: