DDI 3.1 XML Schema Documentation (2009-10-18)
© DDI Alliance 2009 - licensed under the terms of the GNU Lesser General Public License
complexType "ProprietaryRecordLayoutType"
Namespace:
Content:
complex, 7 attributes, 16 elements
Defined:
Includes:
definitions of 12 elements
Used:
XML Representation Summary
<...
    action
 = 
("Add" | "Update" | "Delete")
    id
 = 
xs:string
    isVersionable
 = 
"true"
    objectSource
 = 
xs:anyURI
    urn
 = 
xs:anyURI
    version
 = 
xs:string
    versionDate
 = 
(xs:dateTime | xs:date | xs:gYearMonth | xs:gYear | xs:duration)
    >
   
Content: 
UserID*, VersionResponsibility?, VersionRationale*, PhysicalStructureReference, CharacterSet?, ArrayBase?, r:Software, DataItemAddress?, DefaultNumericDataType?, DefaultTextDataType?, DefaultDateTimeDataType?, (CodedDataAsNumeric | CodedDataAsText)?, DefaultVariableSchemeReference, r:ProprietaryInfo?, DataItem*
</...>
Content Model Elements (16):
All Direct / Indirect Based Elements (1):
Known Usage Locations
Annotation
A record layout for data in proprietary system files.
Type Definition Detail
Type Derivation Tree
      r:VersionableType (extension)
          p:BaseRecordLayoutType (extension)
              ProprietaryRecordLayoutType (extension)
XML Source (w/o annotations (13); see within schema source)
<xs:complexType name="ProprietaryRecordLayoutType">
<xs:complexContent>
<xs:extension base="p:BaseRecordLayoutType">
<xs:sequence>
<xs:element minOccurs="0" name="CharacterSet" type="r:CodeValueType"/>
<xs:element minOccurs="0" name="ArrayBase" type="xs:integer"/>
<xs:element ref="r:Software"/>
<xs:element minOccurs="0" ref="DataItemAddress"/>
<xs:element minOccurs="0" ref="DefaultNumericDataType"/>
<xs:element minOccurs="0" ref="DefaultTextDataType"/>
<xs:element minOccurs="0" ref="DefaultDateTimeDataType"/>
<xs:choice minOccurs="0">
<xs:element ref="CodedDataAsNumeric"/>
<xs:element ref="CodedDataAsText"/>
</xs:choice>
<xs:element ref="DefaultVariableSchemeReference"/>
<xs:element minOccurs="0" ref="r:ProprietaryInfo"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DataItem"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (defined in this component only; 12/16)
ArrayBase
Type:
xs:integer, predefined, simple content
Sets the array base for any arrays used in the definition (that is, whether the first value is in position 0 or 1, etc.). This may be the data array in a delimited data file or the measure array for measures that are bundled and stored in a single location. Array base is generally set to either 0 or 1. There is no override provided as systems processing a record would use a consistent array base.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ArrayBase" type="xs:integer"/>

CharacterSet
Type:
r:CodeValueType, simple content
Character set used in the data file (e.g., US ASCII, EBCDIC, UTF-8). This is a required field. If the character set is not known, for example for some proprietary data files, enter "unspecified".
Simple Content
xs:string
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CharacterSet" type="r:CodeValueType"/>

CodedDataAsNumeric
Type:
Indicates that coded data should be treated as numeric, and defines the numeric type
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="CodedDataAsNumeric"/>

CodedDataAsText
Type:
r:TextRepresentationType, complex content
Indicates that coded data should be treated as text, and defines the text type
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="CodedDataAsText"/>

DataItem
Type:
DataItemType, complex content
Describes a data item in the record.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DataItem"/>

DataItemAddress
Type:
DataItemAddressType, complex content
Provides minimum information on data item address system, such as variable ID or Name, etc.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="DataItemAddress"/>

DefaultDateTimeDataType
Type:
Declares the most common data type used for date-time data.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="DefaultDateTimeDataType"/>

DefaultNumericDataType
Type:
Declares the most common data type used for numeric data.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="DefaultNumericDataType"/>

DefaultTextDataType
Type:
r:TextRepresentationType, complex content
Declares the most common data type used for textual data.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="DefaultTextDataType"/>

DefaultVariableSchemeReference
Type:
r:ReferenceType, complex content
References the VariableScheme of the variables in the record. Can be overridden at the level of the DataItem.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="DefaultVariableSchemeReference"/>

r:ProprietaryInfo
Type:
r:ProprietaryInfoType, complex content
Contains information proprietary to the software package which produced the data file. This is expressed as a set of name-value pairs.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:ProprietaryInfo"/>

r:Software
Type:
r:SoftwareType, complex content
Software used by this record layout.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="r:Software"/>

XML schema documentation generated with DocFlex/XML SDK 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set