ArticleFeature
Synopsis
struct ArticleFeature {
string symbolicName;
string displayName;
string symbolicValue;
string displayValue;
boolean visible;
}
The ArticleFeature structure is used as the element type of the return value of the getArticleFeatures operation (§getArticleFeatures). It has the following fields:
symbolicName
This field contains the symbolic name of the feature. The symbolic name is never an empty string. If the article is based on OCD product data, the symbolic feature name is equal to an OCD property name.
displayName
This field contains the feature name as displayed to the user. If the feature is visible, the display name of the feature is never an empty string.
symbolicValue
This field contains the symbolic value of the feature. If the article is based on OCD product data, the symbolic value is equal to the OCD property value of the OCD property identified by the symbolic name. The symbolic value may be an empty string, even if the display value is not an empty string.
displayValue
This field contains the feature value as displayed to the user. The display value may be an empty string, even if the feature is visible, or the symbolic value is not an empty string.
visible
This field is set to true if the feature’s display name and possibly display value are displayed to the user. If set to false, the feature is internal and not to be displayed to the user.
A visible ArticleFeature, when displayed to the user, always results in a single line. If the description of a feature consists of multiple lines (as may be the case when the getArticleFeatures operation is called with the description option set to true), the sequence returned by this operation contains multiple subsequent instances of ArticleFeature with equal symbolicName and symbolicValue, each representing one line of the feature’s description.
If the description option of the getArticleFeatures operation was set to true, the displayName field of returned ArticleFeature structures does not necessarily represent the features name. Instead, display name and display value should be treated as a pair of strings, at least one of them not empty, to be displayed in a single line.
Depending on the underlying product data, the display name as stored in the ArticleFeature structure may end with a colon (:), possibly followed by space. This should be taken into account when display name and display value are concatenated before they are displayed to the user.1
Footnotes
-
When the Online Configurator concatenates the display name and value of a feature line to build the feature text returned by the
getArticleDataandgetItemPropertiesoperations, it behaves as follows: If the name is empty, the value is used (should not happen); otherwise, if the value is empty, the name is used; otherwise, if name ends with a colon (:), name and value are separated by space; otherwise, if the name ends with a colon followed by a single space character (U+0020), nothing is inserted between name and value; otherwise, name and value are separated by a colon followed by a single space. ↩