PIM Quickstart

Basic steps to configure PIM for initial use

Before any items are entered or imported into PIM for the first time, it must be configured to classify and categorize your products. This guide details the following steps which are required to prepare PIM for initial data entry.

  • Create Attributes

  • Map Attributes

  • Create Primary Hierarchy

  • Create Attribute Groups

  • Create first item

This guide assumes there is no data currently in PIM. Once the required attributes are mapped in the initial setup, they cannot be modified.

Item attributes are used to define a product characteristic. For example, a product name, an identity number, and a product description are common attributes of any product. Attributes are key-value pairs (e.g. Color: red) that hold information for each property of the product. ‌

The first step for configuring PIM is to create the basic attributes that are needed for the items. This list contains the 5 required attributes.

NOTE: The 5 required attributes are the minimal set needed to get PIM operational. It is best practice to enter as many applicable attributes as possible during this setup phase to reduce the number of steps to get PIM configured for your specific deployment. Additional details on creating items attributes can found in this KB article.

Name

Attribute specifications

Function in PIM

SKU (Mandatory)

Each SKU value must be unique

This attribute serves as the primary identifier for items to be created in PIM

Title

A text type attribute is recommended

This attribute helps PIM identify the display name of the product

Primary Image 

A text type attribute is recommended  

This attribute helps PIM identify the main image of the product for thumbnail purposes

Active (Mandatory)

Must be a Boolean type attribute

Name the attribute to Active which can be set to TRUE/FALSE

Required to maintain the status of item to Active/Disabled

Variant Attribute

A text type attribute is recommended

This attribute helps fabric applications identify the attributes that drive variants for items (for example - color, size)

 

Create attribute

Navigate to the Attributes page from the left panel and select Items.

Click New Attribute button on the top of the page.

In the Create item attribute dialog box that appears, complete the following.

Select attribute type section

  • Click on button for relevant attribute type

Title and description section

  • Provide the Attribute Title you want to appear when assigning to items

  • Enter a Description for your reference

  • Complete other options such as Subtype or Date formate if applicable.

Business validations section

  • Enter any relevant Business validations and customizations dependent on the attribute selected.

Click Save.

 

Create item attribute
Create item attribute

The second step for configuring PIM is to map the basic mandatory attributes to the attributes used by the merchant. For example, PIM uses terms like "SKU" to refer to a unique product identifier while some merchants use the terms "UPC" or "Part Number." Each of the basic attributes must be mapped to exactly one attribute from the following list of attributes

 

Attribute name

Attribute Type

Attribute specs

SKU

Text

Serves as the primary identifier for items to be created in PIM

Each SKU value must be unique

Must be set to mandatory

Product title

Text

Identifies the display name of the product with PIM user interface

Is recommended for use on the storefront as the item title

Is recommended to be set to mandatory

Primary product image

Text

Serves as the thumbnail image in Copilot PIM

Can be set as optional. Copilot PIM will display a blank image placeholder in the user interface if no value is given.

Active

Boolean

Maintains the status of an item as Active/Inactive on your storefront
(only items where status is set to Active=TRUE will be available for the commerce API to consume)

Recommended name is Active

Must be set to Mandatory

Variant

Text

This attribute helps fabric applications identify the attributes that drive variants for items, for example - color or size.

 

 

Map item attributes

Select Settings in the left column, then select Attribute mapping.

Select the Map Item Attributes tab.

Use each dropdown to select the item attribute to map to PIM basic attribute. Detail for each are contained in the table below.

Click on the Save button.

 

Map item attributes
Map item attributes

The third step is to set up your primary hierarchies. Their role is to organize your products into categories and subcategories that share common item attributes. Each item in your catalog will be assigned to a single Primary Hierarchy so creating logical categories gives you greater control over what attributes are required or optional for all items assigned to each Primary Hierarchy.

For example, if the hierarchy for couches is Furniture > Living Room > Sofas, you can add attributes to each of these categories to control what information will appear on the product detail page for items that belong to the Primary Hierarchy, Furniture > Living Room > Sofas.

 

Create primary hierarchy

Navigate to Hierarchies and click Primary.

Click the + circle in the bottom of the vertical menu.

Add a Title to the empty category.

Click Enter/Return and the category will be created.

Click the newly-created Category name to add subcategories. A new level will appear to the right of the selected category.

Repeat the steps above for each the new category and subcategory.

NOTE: For first-time PIM users, a blank screen appears with a single empty category.

 

Primary hierarchy
Primary hierarchy

Attribute groups enable merchants to cluster various attributes together to make it easier to manage large volumes of product information. Attribute groups are not required, however they are highly beneficial if you plan to use more than15 item attributes for your catalog.

Example attribute groups are:

  • Basic info such as product title, description, and primary image
  • Media such as product animations

Attributes not specifically included in a group will appear in the Others attribute group.

Details for creating Attribute Groups can be found on the PIM Settings KB page.

The last step for configuring PIM is to enter the data for your first item. This will ensure the basic configuration is complete. After verifying the initial entry, you will have the option to load more individually or perform bulk imports of data.

 

Create item

Select Catalog from the left panel and then select Items.

Click New Item at the top of the page.

Browse to or search the relevant subcategory from the Select a hierarchy node dialog box. Selecting a subcategory of the primary hierarchy (LEVEL: 0) is required and only the last subcategory in the hierarchy can be selected.

Click Next.

Pick hierarchy
Pick hierarchy
Select Attribute Group, then click on the Edit button in the attribute panel.
Create item
Create item

Populate the attribute value fields in each attribute group section. At a minimum, the SKU is required to create and save an item in PIM. The required values for each attribute group will vary based on the Hierarchy node selected in the beginning of the process and all mandatory attribute fields must be entered to publish the item to your storefront.

Here are a few example attribute fields that will vary based on how you configured PIM. An asterisk “*” character indicates the field is required.

  • SKU - the unique identifier assigned to the item. This is required to create and save the item.
  • Product Title - title that will appear when item is visible on a webpage
  • Product Image - URL of the image to represent the product or service

Click Save.

Enter attributes
Enter attributes

When all mandatory attribute values have been entered, the attribute group status indicator will change from Not Started to Completed.

Continue adding attribute values to each attribute group included in that item.

Once all mandatory attribute values have been populated, the Publish button will be enabled. When Publish is clicked, the item will be live. This indicates the content is available for the commerce API to consume and display the product details on your website.

Last update: Sep 01, 2022

Have any questions?
Let's Talk.