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

ItemField

Synopsis

struct ItemField {
    BItemId itemId;
    ColumnId columnId;
    string data;
}

See also: BItemId, ColumnId

This complex type holds the date of a single field (the intersection of basket column and item). It has the following attributes and elements:

itemId (attribute)

the ID of the basket item

columnId (attribute)

the ID of the basket column

data (element)

the data stored in the field, or an empty string if no data has been stored. The descriptions of enumeration types ColumnType (§ColumnType) and BasketItemAttrId (§BasketItemAttrId) contain information about the format of data stored in user-defined and predefined columns.

All attributes and elements are required.

Variable References

The default values of user defined columns, as well as the values set for fields of user defined columns of type Text and EClass, may contain zero or more variable references embedded in their value. Values set for fields of user defined columns of type Number may consist of a single variable reference.

Variable references start with a dollar sign (U+0024), immediately followed by an left parenthesis (U+0028). They end with the next right parenthesis (U+0029).

Most variable references can only be used for items of type Article, Aggregate, PartialPlanning, UserArticle and OCDArticle. The Label reference can be used for any item type.

Label

the label of the item, corresponding to the label element of complex type ItemProperties (§ItemProperties)

ManuName, ManufacturerName

the manufacturer name

ManuId, ManufacturerId

the commercial manufacturer id

SeriesName

the series name

SeriesId

the (commercial) series ID

ArtNr

the default article number; Depending on information provided by OFML data, this is either the base or final article number. For user article items with a non-empty final article number it is the final article number, and the base article number otherwise.

BaseArtNr

the base article number

FinalArtNr

the final article number

VarCode

the variant code

Text

the default description of the article; Depending on information provided by OFML data, this is either the short description, the long description, or the concatenation of both, delimited by a single line feed (U+000A) character.

For user article items with a non-empty long description, the long description is used, otherwise the short description.

ShortText

the short description of the article

LongText

the long description of the article

VarText, VariantText

the feature description of the article; Whereas short and long description solely depend on the article (base article number), the feature description depends on the current configuration of the article.

VarCodes, VariantCodes

coded features of OFML articles; The value is a list of key/value pairs, where subsequent key/value pairs are separated by a single line feed (U+000A) character, and key and value are separated by an equals sign (U+003D). The key is always non-empty, the value may be empty.

The encoded features correspond the the features returned by OFML method getAllArticleFeatures(NULL).

CatImage, CatalogImage

an empty string or an URI for the catalog image. See CatalogImage value of enumeration BasketItemAttrId (§BasketItemAttrId) for more information.

GenImage, GeneratedImage

an empty string or an URI for the generated image. See GeneratedImage value of enumeration BasketItemAttrId (§BasketItemAttrId) for more information.

ArtImage, ArticleImage

an empty string or an URI for the article image. See ArticleImage value of enumeration BasketItemAttrId (§BasketItemAttrId) for more information.

SinglePurchasePrice

SingleSalesPrice

SingleNetPrice

SingleGrossPrice

TotalPurchasePrice

TotalSalesPrice

TotalNetPrice

TotalGrossPrice

the named price of the article; For more information, see documentation of corresponding value of enumeration BasketItemAttrId (§BasketItemAttrId).

PackInfo:<suffix>

packaging information

<suffix> consists of the name of a packaging property, optionally followed by a conversion specification enclosed in left and right square brackets (U+005B, U+005D).

The following table contains the supported packaging property names and the default unit used to report the value:

Width MTR

Height MTR

Depth MTR

Volume MTQ

TareWeight GRM

NetWeight GRM

ItemsPerPackUnit C62

PackUnitsPerArticle C62

The following name is supported for backward compatibility:

TaraWeight GRM

The conversion specification, if present, must consist of a preferred unit code (UNECE unit of measure), optionally followed by the specification of a precision. The precision specification must consist of a colon (U+003A), an optional minus sign (U+002D), and a non-empty sequence of decimal digits (U+0030..U+0039). The precision is clamped to range [0, N], where N is the number of significant decimal digits supported by the used IEEE 754-2008 decimal format (the current implementation uses N=16).

The variable reference expands to an empty string if the position does not have information about the named packaging property, the packaging property name is unknown, or the conversion specification is invalid.

Otherwise, if the variable reference contains a conversion specification, an attempt is made to convert the property value to the specified unit. If conversion fails (as would be the case for conversion from MTR to GRM), the original value will be used.

The amount of the value will then be converted as a fixed point decimal number. If the variable reference specifies a precision, then exactly as many fraction digits will be produced. If the variable reference does not specify a precision, then there will be exactly as many faction digits as necessary to preserve the value. If no fraction digits are produced, there will be no decimal separator either.

Formatting is done according to the rules of the session’s locale. The exact rules for formatting, including the use of grouping, is implementation-defined.

Finally, if the unit is not ‘C62’, then a single space character (U+0020) and the unit will be appended to the formatted value.

Tax:<suffix>

either a particular tax or the position total of all taxes;

<suffix> consists of the name of the pricing procedure and the name of the condition type, separated by colon (U+003A).

If the name of the pricing procedure consists of a single asterisk (U+002A) then it matches the name of an active pricing procedure if and only if there is exactly one active pricing procedure. A leading asterisk followed by a colon may be omitted.

If the condition type name consists of a single asterisk, then the total of all tax lines of the selected pricing procedure is used. If at least one line of the pricing procedure is tagged with TAX then all lines tagged with TAX are considered tax lines. Otherwise, all condition lines with condition class TAX are considered tax lines.

If the condition type name names a particular condition type, then the line for this condition type is used even if the condition class is not TAX.

Lines selected from the pricing procedure that do not exist in the price calculation of the position are ignored. If no lines have been selected, or all selected lines are ignored, the reported monetary amount will be null.

If <suffix> does not adhere to the syntax specified above, no pricing procedure can be selected, or the selected pricing procedure does not have the specified condition type, then an invalid monetary amount is reported

TaxPerUnit:<suffix>

tax per sales unit; This is like Tax:<suffix>, except that the determined value is divided by the position’s quantity.

Note that, depending on the calculation rule of the taxes involved, this value may differ from the value computed for Tax:<suffix> for an otherwise identical position with a quantity of one. Also note that this value cannot be computed, and an invalid monetary amount will be reported, if the quantity of the position is zero.

TaxRate:<suffix>

the tax rate, consisting of condition amount and possibly quantity relation

<suffix> is interpreted as described for Tax:<suffix>, except that an asterisk must not be used for the condition type name.

Access to the variable first determines amount and quantity relation. Both default to an invalid value.

If a pricing procedure line has been selected, and the price calculation of the position contains this line, then the line’s values are used for amount and quantity relation. Note that depending on the calculation rule, the quantity relation may be invalid (for example in case of Percent and FixedAmount).

If a pricing procedure line has been selected, but the line does not exist in the price calculation of the position, then the amount will be zero percent if the calculation rule of the condition type is Percent, and null otherwise.

Once amount and quantity relation have been determined, they are formatted as just the amount if the quantity relation is invalid, or as amount and quantity relation, in that order, separated by space, slash and space (U+0020, U+002F, U+0020).

Note that, while P-BK and derived applications also support Tax:<suffix>, TaxPerUnit:<suffix> and TaxRate:<suffix>, they interpret <suffix> in a different way. Also note that the TaxCategory variable supported by P-BK is not supported at all by EAIWS.