Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

InsertInfo

Synopsis

struct InsertInfo {
    string catalogId;
    string catalogPackageId;

    string articlePackageId;
    string manufacturerId;
    string seriesId;
    string baseArticleNumber;
    string variantCode;
    string finalArticleNumber;
    string ofmlVariantCode
}

The InsertInfo structure is used to collect arguments of the insertOCDArticle operation. It contains the following fields:

catalogId

This field may be set to the identifier of the catalog containing the article as returned by the catalogId field of the CatalogItem structure (§CatalogItem).

This is an optional field. If the client is not able to, or does not want to specify a catalog ID, this field should be set to an empty string.

catalogPackageId

This field may be set to the identifier of the OFML package containing the OFML catalog entry for this article as returned by the catalogPackageId field of the CatalogItem structure (§CatalogItem).

This is an optional field. If the client is not able to, or does not want to specify the catalog package ID, this field should be set to an empty string.

articlePackageId

This field may be set to the OFML package ID of the package containing the product data of the article. If the article has been found in the catalog using the catalog service, it should be set to the value returned by the articlePackageId field of the CatalogItem structure (§CatalogItem).

This is an optional field. If the client is not able to, or does not want to specify the article package ID, it should set this field to an empty string, and it must set the manufacturerId field to a valid value.

If this field is set to a non-empty string, then the identified OFML package must contain the product data for the article.

manufacturerId

This field may be set to the commercial manufacturer ID of the article. If the client is not able to, or does not want to specify the commercial manufacturer ID, this field should be set to an empty string.

If the articlePackageId field does not identify the OFML package containing the product data for the article, then the manufacturerId field must be set to a valid value. The Online Configurator searches for an OFML package that contains product data for the specified manufacturer, series (if specified), and base article number. If more than one such package exists, it is unspecified which package is actually used.

seriesId

This field may be set to the series ID of the article. If the client is not able to, or does not want to specify the series ID, this field should be set to an empty string.

baseArticleNumber

This field must be set to the base article number of the article. If the article has been found in the catalog using the catalog service, it should be set to the value returned by the baseArticleNumber field of the CatalogItem structure (§CatalogItem).

variantCode

This field may be set to the variant code of the article, although it is not recommended to do so unless the product data of the article uses a key/value format for the variant code.

The variant code may be either partial or complete. If the product data of the article uses a key/value format for the variant code then the partial variant code may specify the value of any property. Otherwise a partial variant code may specify only an initial sequence of property values.

If the variant code is specified, it is used to determine the initial configuration of the article. If the client does not want to specify a variant code, it should set this field to an empty string.

finalArticleNumber

This element may be used instead of the variant code to specify the initial configuration of an article.

If both the variant code and final article number are specified (i.e. non-empty), the final article number is ignored.

If the base article number is not specified, and the final article number is specified and not ignored, the basket web service searches the OFML product data for an article matching the final article number. If no such article is found, the insert operation fails. If at least one article is found, the best matching article is used (i.e. the catalog ID, catalog package ID, article package ID and base article number of the best matching article are used as part of the insert info if not yet specified).

The details of the search algorithm, including selection of the best matching article, are implementation defined. However, the catalog ID, catalog package ID, article package ID, manufacturer ID and series ID, if specified as part of the insert info, are taken into account. The selected article is guaranteed to match these parameters, except for the series ID, which is only take as a hint due to limitations of the XCF catalog format and the fact that one OFML package can contain articles of multiple series.

Furthermore, search for a final article number requires that at least one of catalog ID, catalog package ID, article package ID or manufacturer ID is specified as part of the insert info.

Note that the mechanism must be enabled for for article packages supporting this feature by DSR feature maySetFinalArticleSpec.

OfmlVarianCode

  • If the element is specified1, the element basketArticleNumber must be specified too, and the specified OFML variant code must be valid for the article to be inserted.

    If the OFML variant code is specified together with the final article number and/or ordinary variant code, the OFML variant code is used to initialize the new article.

Footnotes

  1. An article number or variant code is specified if the element is present and has a non-empty value. ↩