Import (Supplier catalog) – novomind iPIM Documentation

The import is the first step in the catalog process. In this step, the supplier's items and the associated item data are loaded into the system or entered manually. In the process, the appropriate iPIM Supply items are created respectively updated. The iPIM Supply items are the intermediate stage between the supplier's items and the final iPIM products.

Import configuration

Before the first import of supplier items and the associated item data via an appropriate file, you need to configure the import procedure. To do so, you need to access the import configuration first.

Call up the appropriate catalog.
In the "Catalog Process" tab, click on "Import" or select the option "Import" from the "Configuration" menu to access the import configuration page.

Configure the import for .xlsx files

In order to configure the import of an .xlsx catalog file, proceed as follows:

From the "Import mode" menu , select the appropriate import mode:
- "Full assortment" for an initial import that is used to create new items or to replace the current items of a catalog. Items which are already contained in the catalog will be deleted in the process of the import.
- "Assortment update" for a follow-up import that is used to add new items to a catalog or to update the current items. Important: For adding new items or updating existing items, the complete attribute set has to be provided.
Optional: If you selected the import mode "Assortment update", possibly tick the checkbox "Update existing items" to specify that current items of a catalog are updated by the import.
Optional: If you selected the import mode "Assortment update", possibly tick the checkbox "Skip unchanged items" to specify that only items where changes occurred are updated by the import. (since version 5.8)
From the "Format" menu , select the option "Excel 2007-2013 XLSX".
In the "Excel sheet name" field , enter the name of the corresponding sheet of the import file.
In the "Attribute name in row" field , enter the table row number of the column headers that contain the attribute names (usually "1").
In the "Data area from row" field , enter the number of the table row in which the data to be imported start (usually "2").
Optional: In the field "Data area from column" field , enter the number of the table column in which the data to be imported starts.
Optional: In the "Data area to column" field , enter the number of the table column in which the data to be imported ends.
Optional: Tick the "Import hidden columns" checkbox to specify that also the data from hidden columns of the import file are imported.
In the "Unique item ID column" field , enter the name of the colum that contains a unique item identifier such as the supplier item number.
Optional: Add another unique item identifier. To do so, click on the button and enter the corresponding column name of the import file in the input field that appears below.
In the "Supplier item name" field , enter the column name of the import file that contains the supplier item name.
Via the "Error level for constraint violation" menu , specify which message appears in case that the import contains items which can't be allocated.
Via the "Default missing attributes mode" menu , specify how to proceed if attributes are missing in the import file. For example, this means that an imported .xslx file does not contain a corresponding column. You can choose between the options:
- Report missing attributes: Missing attributes are reported as such. This applies to attributes for which a transformation rule is set up.
- Delete missing attributes: Missing attributes are deleted from all the items of the catalog, even if only particular items were imported.
- Take over missing attributes from previous import: If attributes are missing, their values from the previous import are taken over. The transformation can be carried out without having to modify the transformation rules.
- Ignore missing attributes: The missing of attributes is ignored during the import. However, the transformation rules need to be modified before the transformation rule can be carried out.
- Report missing attributes if used in catalog: Missing attributes are reported as such. This applies both to attributes for which a transformation rule is set up as well as to attributes which are in use for the catalog items.
Via the "Default missing items mode" menu , specify how to proceed if catalog items are missing in the import file. You can choose between the options:
- Ignore missing items: The missing of items is ignored entirely.
- Report missing items: Missing items are listed in the import report as such.

In order to finalise the configuration of the import parameters, click on the button . A success message is shown. The import can now be run.
In order to cancel the process, click on the button .

Once the items of a catalog were synchronized with iPIM, for further imports you can only use the import mode “Assortment update”.

Import configuration for .csv files

In order to configure the import of a .csv catalog file, proceed as follows:

From the "Import mode" menu , select the appropriate import mode:
- "Full assortment" for an initial import that is used to create new items or to replace the current items of a catalog. Items which are already contained in the catalog will be deleted in the process of the import.
- "Assortment update" for a follow-up import that is used to add new items to a catalog or to update the current items. Important: For adding new items or updating existing items, the complete attribute set has to be provided.
Optional: If you selected the import mode "Assortment update", possibly tick the checkbox "Update existing items" to specify that current items of a catalog are updated by the import.
Optional: If you selected the import mode "Assortment update", possibly tick the checkbox "Skip unchanged items" to specify that only items where changes occurred are updated by the import. (since version 5.8)
From the "Format" menu , select the option "CSV".
Enter a delimiter in the “Delimiter” field . The separator (e.g. a semicolon) separates the individual values in a row within the .csv file.
Select the character encoding of the .csv file from the “Encoding” menu .
Enter a quote character in the “Quote character” field . The quote character is the character used in the .csv file to escape the character used as a separator, should it appear as a normal character.
Select the format used for line breaks in the .csv file from the “Line separator” menu .
Optional: Enter a quote escape character in the “Quote escape” field . A quote escape character is used in .csv files to escape the quote character being used.
Optional: Enter an escape character for the quote escape character in the “Escape quote escaping character” field . An escape character for the quote escape character is used in .csv files to escape the quote escape character being used.
In the "Unique item ID column" field , enter the name of the colum that contains a unique item identifier such as the supplier item number.
Optional: Add another unique item identifier. To do so, click on the button and enter the corresponding column name of the import file in the input field that appears below.
In the "Supplier item name" field , enter the column name of the import file that contains the supplier item name.
Via the "Error level for constraint violation" menu , specify which message appears in case that the import contains items which can't be allocated.
Via the "Default missing attributes mode" menu , specify how to proceed if attributes are missing in the import file. You can choose between the options:
- Report missing attributes: Missing attributes are reported as such. This applies to attributes for which a transformation rule is set up.
- Delete missing attributes: Missing attributes are deleted from all the items of the catalog, even if only particular items were imported.
- Take over missing attributes from previous import: If attributes are missing, their values from the previous import are taken over. The transformation can be carried out without having to modify the transformation rules.
- Ignore missing attributes: The missing of attributes is ignored during the import. However, the transformation rules need to be modified before the transformation rule can be carried out.
- Report missing attributes if used in catalog: Missing attributes are reported as such. This applies both to attributes for which a transformation rule is set up as well as to attributes which are in use for the catalog items.
Via the "Default missing items mode" menu , specify how to proceed if catalog items are missing in the import file. You can choose between the options:
- Ignore missing items: The missing of items is ignored entirely.
- Report missing items: Missing items are listed in the import report as such.

In order to finalise the configuration of the import parameters, click on the button . A success message is shown. The import can now be run.
In order to cancel the process, click on the button .

Once the items of a catalog were synchronized with iPIM, for further imports you can only use the import mode “Assortment update”.

Import configuration for .json files

In order to configure the import of a .json catalog file, proceed as follows:

From the "Import mode" menu , select the appropriate import mode:
- "Full assortment" for an initial import that is used to create new items or to replace the current items of a catalog. Items which are already contained in the catalog will be deleted in the process of the import.
- "Assortment update" for a follow-up import that is used to add new items to a catalog or to update the current items. Important: For adding new items or updating existing items, the complete attribute set has to be provided.
Optional: If you selected the import mode "Assortment update", possibly tick the checkbox "Update existing items" to specify that current items of a catalog are updated by the import.
Optional: If you selected the import mode "Assortment update", possibly tick the checkbox "Skip unchanged items" to specify that only items where changes occurred are updated by the import. (since version 5.8)
From the "Format" menu , select the option "JSON (generic)".
Enter The JSON key of the root node in the “Root node” field . The root node is the node where the item data begins.
Enter the delimiter for the values of a value set in the “Key concetanation character” field .
Enter the character for concetanating nested JSON keys in the “Key concetanation character” field .
Optional: Enter the JSON key at which a grouping begins in the “Key” field .
Optional: Enter the JSON key of the field by which to group in the “Field” field .
Optional: To add additional fields for entering JSON keys for a grouping, click the button .
In the "Unique item ID column" field , enter the name of the JSON Key that represents a unique item identifier such as the supplier item number.
Optional: Add another unique item identifier. To do so, click on the button and enter the corresponding JSON key in the input field that appears below.
In the "Supplier item name" field , enter the JSON key that represents the supplier item name.
Via the "Error level for constraint violation" menu , specify which message appears in case that the import contains items which can't be allocated.
Via the "Default missing attributes mode" menu , specify how to proceed if attributes are missing in the import file. You can choose between the options:
- Report missing attributes: Missing attributes are reported as such. This applies to attributes for which a transformation rule is set up.
- Delete missing attributes: Missing attributes are deleted from all the items of the catalog, even if only particular items were imported.
- Take over missing attributes from previous import: If attributes are missing, their values from the previous import are taken over. The transformation can be carried out without having to modify the transformation rules.
- Ignore missing attributes: The missing of attributes is ignored during the import. However, the transformation rules need to be modified before the transformation rule can be carried out.
- Report missing attributes if used in catalog: Missing attributes are reported as such. This applies both to attributes for which a transformation rule is set up as well as to attributes which are in use for the catalog items.
Via the "Default missing items mode" menu , specify how to proceed if catalog items are missing in the import file. You can choose between the options:
- Ignore missing items: The missing of items is ignored entirely.
- Report missing items: Missing items are listed in the import report as such.

In order to finalise the configuration of the import parameters, click on the button . A success message is shown. The import can now be run.
In order to cancel the process, click on the button .

Once the items of a catalog were synchronized with iPIM, for further imports you can only use the import mode “Assortment update”.

Configure the import for .xml files

In order to configure the import of a .xml catalog file, proceed as follows:

From the "Import mode" menu , select the appropriate import mode:
- "Full assortment" for an initial import that is used to create new items or to replace the current items of a catalog. Items which are already contained in the catalog will be deleted in the process of the import.
- "Assortment update" for a follow-up import that is used to add new items to a catalog or to update the current items. Important: For adding new items or updating existing items, the complete attribute set has to be provided.
Optional: If you selected the import mode "Assortment update", possibly tick the checkbox "Update existing items" to specify that current items of a catalog are updated by the import.
Optional: If you selected the import mode "Assortment update", possibly tick the checkbox "Skip unchanged items" to specify that only items where changes occurred are updated by the import. (since version 5.8)
From the "Format" menu , select the option "XML".
Enter The XML tag of the root node in the “Root node” field . The root node is the node where the product data begins. The full path of the root node must be specified here, with the individual tags separated by a defined delimiter.
Enter the delimiter for linking XML tags in the “Key concatenation character” field . The delimiter is used to separate individual XML tags from one another when specifying paths..
Optional: Enter the XML tag at which a grouping begins, in the “Key” field .
Optional: the XML tag by which to group, in das „Field“-Feld eingeben.
Optional: To add additional fields for entering XML tags for a grouping, click the button .
Enter the path of the XML tag containing a unique item identifier (e.g. the supplier’s item number) in the "Attribute with unique item key" field , enter the path of the XML tag that contains a unique item identifier (e.g. the supplier’s item number).
Optional: To specify an additional unique article identifier, if required, click on the button and enter the path of the relevant XML tag into the input field that appears subsequently.
Enter the path of the XML tag containing the item name (from the supplier) in the "Supplier item name" field , enter the path of the XML tag containing the item name (from the supplier).
Via the "Error level for constraint violation" menu , specify which message appears in case that the import contains items which can't be allocated.
Via the "Default missing attributes mode" menu , specify how to proceed if attributes are missing in the import file. You can choose between the options:
- Report missing attributes: Missing attributes are reported as such. This applies to attributes for which a transformation rule is set up.
- Delete missing attributes: Missing attributes are deleted from all the items of the catalog, even if only particular items were imported.
- Take over missing attributes from previous import: If attributes are missing, their values from the previous import are taken over. The transformation can be carried out without having to modify the transformation rules.
- Ignore missing attributes: The missing of attributes is ignored during the import. However, the transformation rules need to be modified before the transformation rule can be carried out.
- Report missing attributes if used in catalog: Missing attributes are reported as such. This applies both to attributes for which a transformation rule is set up as well as to attributes which are in use for the catalog items.
Via the "Default missing items mode" menu , specify how to proceed if catalog items are missing in the import file. You can choose between the options:
- Ignore missing items: The missing of items is ignored entirely.
- Report missing items: Missing items are listed in the import report as such.

In order to finalise the configuration of the import parameters, click on the button . A success message is shown. The import can now be run.
In order to cancel the process, click on the button .

Once the items of a catalog were synchronized with iPIM, for further imports you can only use the import mode “Assortment update”.

Edit import configurations

In order to edit the import configuration of a particular catalog, proceed as follows:

Call up the catalog.
In the "Catalog Process" tab click on "Import" or select the option "Import" from the drop-down menu "Configuration" to access the import configuration page.
Make the desired changes.

In order to save your changes, click on the button.
In order to cancel the process, click on the button.

Execute import

In order to execute the import of items and the associated item data by uploading an appropriate file, proceed as follows:

Call up the appropriate catalog and go to the "Catalog process" tab.

In the "Import" section, click on the button to call up the corresponding dialog box.

Drag the catalog file over the drop area and drop it there. Or click on the button to call up the file via the file manager.The file is loaded into the cache and the file name is shown below the drop area.
Possibly tick the "Test import" checkbox if you want to run a mere test import with a limited number of items.
If you ticked the "Test import" checkbox , enter the number of table rows to be skipped in the input field "Enter row offset".

Via the "Missing attributes mode" menu , select how to proceed if attributes are missing in the import file.
Via the "Missing item mode" menu , select how to proceed if catalog items are missing in the import file.

In order to trigger the import, click on the button. In the process was successful, the corresponding iPIM Supply attributes are generated respectively updated. Following this, a corresponding process message appears and import statistics are shown. Depending on whether the process was successful, partially successful or unsuccessful, the status traffic light changes to the corresponding color.
In order to cancel the process, click on the button.

Before running an import, make sure that the file format of the import file is the same as the file format that was set in the import configuration.

Import report

The import report shows you a list of essential information about the most recent import. These are broken down by processes, events and results. In addition, there is a list of general messages and error reports. The latter are grouped in separate sections by errors and by items.

Access the import report

In order to access the import report for the most recent import, click on the "Import report" button. Then you will be directed to the corresponding overview page.

Unfold and collapse info sections

In order to unfold a particular info section, click on thebutton in the respective section.
In order to collapse a particular info section, click on thebutton in the respective section.

Download the most recently imported file

In the "Report" section you can download the most recently imported file. To do so, proceed as follows:

In the "Results" column, click on the file name of the import file. The file is then downloaded. It can usually be found in your local download folder.

Delete unimported items

You can delete catalog items which couldn't be imported during an assortment update from the item list of the catalog. You can either delete them grouped by errors or you can delete them individually.

When importing, select the option “Report missing items” so that all unimported items are listed in the overview page of the import statistics.

Delete unimported items grouped by errors

To delete all unimported items grouped by errors from the catalog item list, proceed as follows:

In the row of the respective error in the "Report grouped by error" section, click on the button. Then the corresponding input window appears.
Click on the button to confirm the deleting of the items. Afterwards the items will vanish from the item list of the catalog.

Delete unimported items individually

To delete an individual unimported item from the item list of the catalog, proceed as follows:

In the row of the respective item in the "Report grouped by item" section, click on the button. Then the corresponding prompt window appears.
Click on the button to confirm the deleting of the item. Afterwards the item will vanish from the item list of the catalog.

Export report data

This screenshots shows the user interface under version 5.8.

In the "Export" section you can export report data of a import report, whereby the exported data can be filtered regarding various parameters. To do so, proceed as follows:

From the "Select attribute set" menu , select a report type. You can choose between the options:
- "Item messages" for an export of item messages only
- "Process report" for an export of the whole import report including the item messages
From the "Select export format" menu , select the file format of the export file (.xslx or .csv).
From the "Select item status" menu , possibly select an item status.
From the "Select code" menu , possibly select an error code (since version 5.8).
Click on the button to trigger the export. The export file can usually be found in your local download folder.

Use cases

Configure the import for a catalog file in .xlsx format

In this example, the import is configured for the initial import of the .xlsx format catalog file shown above:

Select the option “Full Assortment” from the “Import mode” menu .
Select the option “Excel 2007-2013 (XLSX)” from the “Format” menu .
Enter the name of the worksheet in the “Excel sheet name” field . (In this example, 'Tabelle1').
Enter the row number of the column headers containing the attribute names in the “Attribute names in row” field . (In this example, '1').
Enter the row number where the item data begins, in the “Data area from” field . (In this example '2').
Enter the name of the column containing the item identifiers in the “Unique item ID column” field . (In this example, 'Article number').
Enter the name of the column containing the article names in the “Supplier item name” field . (In this example, 'Article name').
Optional: Adjust the settings for ambiguous items, missing attributes, and missing items as desired.

In order to finalise the configuration of the import parameters, click on the button . A success message is shown. The import can now be run.
In order to cancel the process, click on the button .

Configure the import for a catalog file in .csv format

In this example, the import is configured for the initial import of the .csv format catalog file shown above:

Select the option “Full Assortment” from the “Import mode” menu .
Select the option “CSV” from the “Format” menu .
Enter a semicolon (;) in the “Separator” field .
Enter the name of the column containing the item identifiers in the “Unique item ID column” field . (In this example 'Article number').
Enter the name of the column containing the article name in the “Supplier item name” field . (In this example 'Article name').
Optional: Adjust the settings for ambiguous items, missing attributes, and missing items as desired.
Click on the button to to complete the configuration of the import parameters. A success message is shown. The import can now be run.

Configure import for a catalog file in .json format

{
    "items":[
        {
            "Brand": "KMZ",
            "Article number":2707,
            "Article name":"Coffeemaster 2000",
            "Model number":"CM2000-W",
            "Devicetype":"Coffee Maker",
            "Body color":"Offwhite"
        },
        {
            "Brand": "KMZ",
            "Article number":2809,
            "Article name":"Coffeemaster 2000",
            "Model number":"CM2000-B",
            "Devicetype":"Coffee Maker",
            "Body color":"Black"
        },
        {
            "Brand": "KMZ",
            "Article number":2909,
            "Article name":"Coffeemaster 2000",
            "Model number":"CM2000-PG",
            "Devicetype":"Coffee Maker",
            "Body color":"Pale green"
        }
    ]
}

In this example, the import is configured for the initial import of the .json format catalog file shown above:

Select the option “Full Assortment” from the “Import mode” menu .
Select the option “JSON (generic)” from the “Format” menu .
Enter the root node of the .json file in the “start node” field The root node is the node where item data begins. (In this example, 'items').
Enter the key that represents the unique article identifier, in the “Unique item ID column” field . (In this example, 'Article number').
Enter the key that represents the article name, in the “Supplier item name” field . (In this example, 'Article name').
Optional: Adjust the settings for ambiguous items, missing attributes, and missing items as desired.

In order to finalise the configuration of the import parameters, click on the button . A success message is shown. The import can now be run.
In order to cancel the process, click on the button .

Configure import for a catalog file in .xml format

In this example, the import is configured for the initial import of the .xml format catalog file shown above:

Select the option “Full Assortment” from the “Import mode” menu .
Select the option “XML” from the “Format” menu .
Enter the XML tag of the root node for the item data in the “Root node” field The root node is the node where the data for individual items begins. (In this example “CATALOG_ARTICLE”).
Leave the underscore in the "Key concatenation character" field as it is.
Enter The XML tag that contains the item identifier, in the “Unique item ID column” field (In this example, 'ARTICLE_ARTICLENUMBER' for the supplier article number.).
Enter the XML tag that contains the article name, in the “attribute with unique article key” field (In this example 'ARTICLE_ARTICLENAME'. ).
Click on the button to to complete the configuration of the import parameters. A success message is shown. The import can now be run.

FAQ

Basics

What role does the import play in the catalog process?

The import is the first step in the four-step catalog process. In this step, the supplier's items and the associated item data are loaded into the system or entered manually.

What happens to the imported data in the background on a technical level?

In the process, the appropriate iPIM Supply items are created respectively updated. The iPIM Supply items are the intermediate stage between the supplier's items and the final iPIM products.

Import configuration

Which import modes are available and what are they used for?

You can choose between "Full assortment" for an initial import that is used to create new items or to replace the current items of a catalog, and "Assortment update" for a follow-up import that is used to add new items or to update existing items.

What is the purpose of the "Unique item ID column" field?

In this field, you enter the name of the import file column that contains a unique item identifier, such as the supplier item number.

Can hidden columns of an import file also be imported?

Yes, to do so you need to tick the checkbox "Import hidden columns" to specify that also the data from hidden columns of the import file are imported.

Which import modes are available and what are they used for?

What happens to items already contained in the catalog in "Full assortment" mode?

In "Full assortment" mode, items which are already contained in the catalog are deleted in the process of the import, since this mode replaces the current items entirely.

How do you specify that existing items are actually updated in "Assortment update" mode?

To do so, you need to tick the checkbox "Update existing items" if you selected the import mode "Assortment update".

Can the "Full assortment" mode still be used after a catalog's items have been synchronized with iPIM?

No, once the items of a catalog were synchronized with iPIM, for further imports you can only use the import mode "Assortment update".

Can the "Full assortment" mode still be used after a catalog's items have been synchronized with iPIM?

No, once the items of a catalog were synchronized with iPIM, for further imports you can only use the import mode "Assortment update".

Handling missing attributes and items

What exactly happens with the "Delete missing attributes" option?

With this option, missing attributes are deleted from all the items of the catalog, even if only particular items were imported.

What does the "Take over missing attributes from previous import" option mean?

If attributes are missing, their values from the previous import are taken over. The transformation can be carried out without having to modify the transformation rules.

What is the difference between "Ignore missing attributes" and "Report missing attributes if used in catalog"?

With "Ignore missing attributes", the missing of attributes is ignored entirely during the import, but the transformation rules need to be modified before the transformation can be carried out. With "Report missing attributes if used in catalog", missing attributes are reported as such instead, provided they are used somewhere in the catalog, for example via a transformation rule or because the attribute is in use for the catalog items.

Execute import

What absolutely needs to be checked before running an import?

Before running an import, make sure that the file format of the import file is the same as the file format that was set in the import configuration.

Import report

How can unimported items be removed from the item list after an assortment update?

Users can delete catalog items which couldn't be imported during an assortment update from the item list of the catalog, either grouped by errors or individually. To make sure all unimported items are listed in the import statistics, select the option "Report missing items" when importing.

Rights

What needs to be done so that newly granted rights for users take effect immediately?

In order to make newly added rights effective for users outside of the regular synchronisation, you must carry out a master data synchronisation for users and roles. This can be done in the "Schedules" tab.

Rights

The following rights are required to use the process step “Import”:

Key	Identifier	Description
ipim-supply.catalogs.process	iPIM Supply – Catalog process	Right to call up catalogs respectively their “Catalog process” tab
ipim-supply.catalogs.process.import.configure	iPIM Supply – Catalog process – Import – Configure import process	Right to use the import configuration
ipim-supply.catalogs.process.import.start	iPIM Supply – Catalog process – Import – Start import process	Right to trigger an import
ipim-supply.catalogs.process.import.view-reports	iPIM Supply – Catalog process – Import – View import reports	Right to call up import reports as well as the right to access the “Reports” tab

In order to be able to access iPIM Supply, a user needs to be related to at least one supplier.
In order to make newly added rights effective for users outside of the regular synchronisation, you must carry out a master data synchronisation for users and roles. This can be done in the “Schedules” tab.
The identifier of rights are not shown correctly here as hyphens are shown as half square dashs. In order to search for a particular right in iPIM CC, copy the key to the clipboard and search for the key.