SAP CDT - Description

Definition

A description is a representation of the properties of an object in natural language and by applying labels to fragments by a markup language.

Dictionary Entry Name

Description. Type

Example (Instance)

1.) Unstructured text content:

<OrderDescription languageCode="en">
	A character string with a specified language.
</OrderDescription>

2.) Structured, markup based, text content:

<TermDescription namespacePrefixCode="html" namespaceURI="http://www.w3.org/1999/xhtml" languageCode="en">
    <html:html xmlns="http://www.w3.org/1999/xhtml" dir="ltr">
       <html:head>
             <html:meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
       </html:head>
       <html:body class="ns-0">
             <html:p>The <html:b>markup language</html:b></html:p>
       </html:body>
    </html:html>
</TermDescription>

Structure

CDT Attributes Category Object Class Term Property Term Representation Term Type Type Name Length Cardinality Remarks
Description   complexType Description   Type XSD string      
  markupLanguageCode Attribute Description Markup Language Code GDT MarkupLanguageCode   0..1  
  languageCode Attribute Description Language Code GDT LanguageCode   0..1  

Detailed Description and Value Ranges

Description contains a "languageCode" attribute for determining the particular language of the element content in accordance with IETF RFC 1766 and [IETF RFC 3066http://www.rfc-editor.org/rfc/rfc3066.txt].

Detailed Description of Attributes and Elements

Attribute/Element Description
languageCode Attribute for determining the particular language of the element content in accordance with IETF RFC 1766 and IETF RFC 3066.
markupLanguageCode Is the coded representation of the allowed of the used markup language for the structured representation of the content.

Facets of Content Component

Facet Description Example
pattern Pattern is a constraint of the content component. The representation of pattern must be based on regular expression defined by W3C XML Schema (Part II). [3-5][0-9] {3}.[0-9]{2}
whiteSpace whiteSpace is a constraint of special characters in the content component. whiteSpace must be one of the following values:
  • preserve - No normalization (changings) of the content component
  • replace - All occurrences of tab (#x9), line feed (#xA), and carriage return (#xD) are replaced with space (#x20)
  • collapse - It implies replace. Additionally, contiguous sequences of spaces (#x20#x20....) are collapsed, and leading and trailing spaces (#x20) are truncated.
whiteSpace value="preserve|replace|collapse"

Integrity Conditions

Not applicable.

Use

Description can be used for the following types of values, for example:

  • Readable additional information for the structured information
  • Descriptions of products and services

Notes

The character string of "Description" is not defined and is therefore system-dependent.
Description should not be used to transfer the following values:

  • Proprietary control information
  • Coded and mutually agreed values
  • Extensive descriptions of values that could otherwise be represented as coded values or identifiers (could be used as a supplement, if necessary).
  • Numerical values
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.