Catalog load configuration properties

We can configure the load properties to change the behavior of Catalog Upload when loading catalog data. We can edit the load configuration files to add, update, or remove settings.

The default location for the load configuration files for Catalog Upload is...

Do not modify the files at that location. Change the properties by creating a custom wc-loader-businessobject.xml file containing the changed properties. Edit properties to the BusinessObjectMediator element. The element resembles the following example:

Property Description Configuration file available for property use
actionOnError Control the action on error.We can set the following values for this property:

    0
    Upon encountering an error, throw an exception and exit (default value).

    1
    On soft delete error go to next. A soft delete error is an attempt to delete a non-existent attribute or value.

All configuration files.
allowChangeAttributeType Control behavior of ATTRUSAGE column of ATTR table during a load operation when the column is set to null. We can set the following values for this property:

    true
    Allowed values can be added to attributes even if the ATTRUSAGE is null. In this case, the ATTRUSAGE is set to 1 (default value).

    false
    An exception would be thrown in this case.

Note: When we use Catalog Upload, the default value for the allowChangeAttributeType flag is false.

Business object configuration files for attributes, such as:

  • wc-loader-AD-attribute-allowed-values.XML

  • wc-loader-AD-attribute-and-allowed-values.XML

attributeValueValidation Indicates whether to validate the attribute value. The attribute value is mandatory except within a product and defining attribute relationship.We can set the following values for this property:

    true
    Enables validation (default value).

    false
    Disables validation.

Note: The attributeValueValidation flag is configured to be false when using Catalog Upload.

Business object configuration files for attributes, such as:

  • wc-loader-catalog-entry-AD-attribute-relationship.XML

buildSearchIndex Requests that the Solr search index is to be built for category and catalog entry information. We can set the following values for this property:

    delta
    Indicates that a Delta build of the search index is required (default value).

    full
    Indicates that a full build is required.

    none
    That no search index build is to be requested.

All configuration files.
createParentProductWhenMissing Indicates whether to create the missing parent product of the catalog entry if no parent product is provided.We can set the following values for this property:

    true
    The mediator creates the missing parent product.

    false
    The missing parent product is not created (default value).

Business object configuration files for catalog entries, such as:

  • wc-loader-catalog-entry.XML

DataCacheInvalidationEnabled Indicates whether the load operation inserts records into the CACHEIVL database table for the object that is being loaded. These records are picked up when the DynaCacheInvalidation URL command runs to clear the data cache in the WebSphere Commerce server. Use this property to ensure that the data cache is invalidated so the Management Center can pick up the new object changes.We can set the following values for this property:

    true
    The data cache is invalidated

    false
    The default value. The data cache is not invalidated as part of the load process.

Load order and business object configuration files. If we want the property to apply to all objects that are being loaded, include the property within the load order configuration file. To have the property apply to only a specific object, include the property within the appropriate business object configuration file.

By default, all catalog upload load order configuration files include this property with a value of true.

deleteSKUFromExistingParentProductWhenNewParentIsDifferent Indicates whether to delete existing parent product of a SKU if the new parent product is different.We can set the following values for this property:

    true
    The existing parent product of a SKU is deleted when adding a SKU to a new parent product (default value).

    false
    The existing parent product of a SKU is not deleted when adding a SKU to a new parent product. We must manually remove the old product to avoid a SKU that has more than one parent product.

Business object configuration files for catalog entries that have child SKUs, such as:

  • wc-loader-catalog-entry-parent-product.XML

DeltaIndexingThresholdUponWorkspaceApproval Delta indexing threshold for workspace indexes. If the threshold value is reached when a workspace approval occurs, a full index runs instead of a delta index. Load order configuration files for loading objects that can be searched.
fixSEO Configure the load operation to replace invalid characters in the Keyword column for an SEO URL with the underscore "_" character. We must apply the interim fix for APAR to use this configuration property. We can set the following values for this property:

    true
    When an input file includes invalid characters in the Keyword column for an SEO URL, the load operation replaces any invalid characters with an underscore character.

    false
    The load operation does not replace the invalid characters and an error occurs.

Business object configuration files for loading catalog entry objects with the CatalogEntrySEOMediator business object mediator. For instance:

  • wc-loader-catalog-entry.XML

initAttribute Indicates whether to implicitly initialize the attribute allowed value if it is not defined. We can set the following values for this property:

    true
    The attribute allowed value is implicitly initialized if it not defined.

    false
    The attribute allowed value is not implicitly initialized.

Business object configuration files for attribute dictionary attribute can catalog entry relationships, such as:

  • wc-loader-catalog-entry-AD-attribute-relationship.XML

initAttributeDictionary Indicates whether to initialize the attribute dictionary for the store. We can set the following values for this property:

    true
    The attribute dictionary is initialized. When you load attribute dictionary attributes into a store, if the store does not have an attribute dictionary, an attribute dictionary is created.

    false
    The attribute dictionary is not initialized (default value).

Business object configuration files for catalogs and catalog entries, such as:

  • wc-loader-catalog.XML

  • wc-loader-catalog-entry.XML

markForDelete Indicates whether to perform a physical delete or flag an object as marked for delete. We can set the following values for this property:

    true
    The mediator marks for delete.

    This value is the default value for the CatalogEntryMediator business object mediator.

    false
    The mediator performs a physical delete.

    This value is the default value for the CatalogGroupMediator business object mediator.

Business object configuration files for catalog entries that use the CatalogEntryMediator, such as:

  • wc-loader-catalog-entry.XML

The CatalogGroupMediator business object mediator supports the markForDelete property. We can configure this property in the business object configuration file for loading categories.

  • wc-loader-catalog-group.XML

rollbackForAnyException Indicates whether the load operation rolls back all of the data that is processed after the last committed record when any type of exception occurs. This property is supported for use only with the data load order configuration file. We can set this property within the configuration for each load item or within the parent <_config:LoadOrder> element to have the property setting apply to all load items. We can set the following values for this property:

    true
    The upload operation rolls back all of the data that is processed after the last committed record when any type of exception occurs. For instance, when incorrect input data causes a NumberFormatException or similar exception. The number of records that are processed before the records are committed is determined by the value for the commit count attribute in the load order configuration file.

    false
    The upload operation does not always roll back all of the data that is processed after the last committed record when any type of exception occurs. If an SQL exception occurs, the utility does roll back all of the processed data after the last committed record. If a different type of exception occurs, the utility rolls back only the data that is not successfully processed. The load operation commits the successfully processed records. This value is the default value.

Load order configuration files.
shareAssignedAttributeValues Indicates whether Catalog Upload supports reusing assigned values when duplicate values are included for different catalog entries in the input file.We can set the following values for this property:

    true
    Assigned values are shared when the input file includes duplicate values (default value).

    false
    Assigned values are not shared and the utility creates separate records for each duplicate assigned value.

Business object configuration files for loading catalog entry and attribute relationships.

  • wc-loader-catalog-entry-AD-attribute-relationship.XML

Support for reusing assigned values during a load operation is enabled by default.

summaryReportLevel Indicates whether to include extra information within the summary report that is generated for the load process. If this property is not specified the default summary report generates. We can set the following values for this property:

    1
    ID resolver information is included within the summary report. This information is appended to the default summary report information.

    0
    The ID resolver information is not included within the summary report. The default value.

Load order configuration files.
supportMultipleValuesForADAttributes Indicates whether to support multiple values for attribute dictionary attributes. We can set the following values for this property:

    true
    Enables support (default value).

    false
    Disables support.

Business object configuration files for attribute dictionary attribute can catalog entry relationships, such as:

  • wc-loader-catalog-entry-AD-attribute-relationship.XML

syncSalesCatalogs Indicates whether to synchronize the product relationships in linked sales catalogs when the load process creates a product under a category. If this flag is set to true, the load process searches all of the sales catalogs that this category is linked to. If the category-product relationship does not exist in a catalog, the load process creates the relationship in the catalog.We can set the following values for this property:

    true
    Enables synchronization.

    false
    Disables synchronization (default value).

Business object configuration files for catalog entries, such as:

  • wc-loader-catalog-entry.XML

  • wc-loader-catalog-entry-parent-catalog-group.XML

validateAttribute Indicates whether to run the validation logic. This flag also checks whether the SKU and the product have compatible defining attributes when it moves a SKU under this product. We can set the following values for this property:

    true
    Validation logic determines whether the attributes or allowed values to be create/update/delete belong to the current store (default value).

    false
    Validation logic does not check attributes. Setting this property to false can improve performance. Ensure that the attributes or allowed values belong to the current store.

Business object configuration files for attribute dictionary attributes, such as:

  • wc-loader-AD-attribute-and-allowed-values.XML

validateCatalog Indicates whether to validate the catalog for the store. Validation checks if more than one master catalog is created for a store. If the store support sales catalog, checking whether a catalog entry already belongs to more than one master category. The validation checks if an attribute allowed value can be set to default in the current store.We can set the following values for this property:

    true
    Validation occurs.

    false
    Validation does not occur (default value).

Business object configuration files for catalogs, categories, and catalog entries, such as:

  • wc-loader-catalog.XML

  • wc-loader-catalog-group.XML

  • wc-loader-catalog-entry.XML

  • wc-loader-catalog-entry-parent-catalog-group.XML

validateCatalogEntry Indicates whether to run the validation logic for catalog entry. We can set the following values for this property:

    true
    Validation logic checks the types of the SKU and product when adding a SKU under a product. This check is to make sure that the SKU is really a SKU and product is really a product.

    false
    Validation logic does not check the types of the SKU and product when adding a SKU under a product (default value).

Business object configuration files for catalog entries, such as:

  • wc-loader-AD-attribute-and-allowed-values.XML

  • wc-loader-catalog-entry-parent-product.XML

validateCatalogGroup Validates whether the category belongs to the specified catalog.We can set the following values for this property:

    true
    Validation occurs.

    false
    Validation does not occur (default value).

Note: If you set the value to true, we must set the batchSize to 1 because the validation depends on the committed data in the database. See Configure the data load order.

Business object configuration files for categories, such as:

  • wc-loader-catalog-group.XML

validateDelete Validates whether a category that is being deleted includes child categories. We can set the following values for this property:

    true
    Validation occurs to check whether a child category exists. If a child category exists, the load operation does not delete the specified parent category included in the input file.

    The load operation completes this check only when categories are being explicitly deleted during a load operation. The load operation does not perform this validation when the markForDelete configurable property is set to true.

    false
    Validation does not occur. The load operation deletes the specified category and can delete child categories (default value).

Business object configuration files for categories that use the CatalogGroupMediator business object mediator, such as:

  • wc-loader-catalog-group.XML

validateScope Validation occurs to check whether the store specified within the input file exists within the current organization root. We can set the following values for this property:

    true
    Validation occurs to check whether the store belongs to the current organization. If the store is not within the organization, the utility does not load data for the store.

    false
    Validation does not occur. (default value).

All business object configuration files for loading catalog data.