ddi:physicaldataproduct_proprietary:3_0_Beta

Global Elements

ProprietaryRecordLayout (ProprietaryRecordLayoutType): [substitution: p:BaseRecordLayout]

DataItemAddress (DataItemAddressType): Provides minimum information on data item address system such as uses variable ID or Name etc.

DefaultNumericDataType (r:NumericRepresentationType): Declares the most common data type used for numeric data.

DefaultTextDataType (r:TextRepresentationType): Declares the most common data type used for textual data.

DefaultDateTimeDataType (r:DateTimeRepresentationType): Declares the most common data type used for date-time data.

CodedDataAsNumeric (r:NumericRepresentationType): Indicates that coded data should be treated as numeric, and defines the numeric type

CodedDataAsText (r:TextRepresentationType): Indicates that coded data should be treated as text, and defines the text type

VariableReference (r:ReferenceType): Reference to the variable description in the Logical Product

DefaultVariableSchemeReference (r:ReferenceType):

ProprietaryDataType (r:CodeValueType): Allows an override of the default data type, using the language of the proprietary software. A controlled vocabulary is recommended.

ProprietaryOutputFormat (r:CodeValueType): Indicates the proprietary output format.

DataItem (DataItemType): A single point of data within the file, which may carry an over-ride of the specified default datatype.

Complex Types

ProprietaryRecordLayoutType: A record layout for data in proprietary system files.

• Content:
  • Extends: p:BaseRecordLayoutType
  • Base Content
    • Extends: r:IdentifiableType
    • Base Content
      • Extends: AbstractIdentifiableType
      • Base Content
        • Sequence of:
          • [Reference] (Name) - min. 0 - max. unbounded
            • Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
      • Base Attributes
        • id (BaseIDType) - required
          • Assigned ID, unique within its maintainable object.
        • urn (xs:anyURI) - optional
          • DDI-structured URN of the element as described in Part I of the Technical Documentation.
        • action (ActionCodeType) - optional
          • Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
      • Extended Attributes
        • isIdentifiable (xs:boolean) - fixed: true
    • Extended Content
      • Sequence of:
        • [Reference] (PhysicalStructureReference)
        • CharacterSet (r:CodeValueType)
          • 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".
        • ArrayBase (xs:integer)
          • 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.
  • Extended Content
    • Sequence of:
      • [Reference] (r:Software)
        • Software used by this record layout.
      • [Reference] (DataItemAddress) - min. 0
        • Provides minimum information on data item address system, such as variable ID or Name, etc.
      • [Reference] (DefaultNumericDataType) - min. 0
        • Declares the most common data type used for numeric data.
      • [Reference] (DefaultTextDataType) - min. 0
        • Declares the most common data type used for textual data.
      • [Reference] (DefaultDateTimeDataType) - min. 0
        • Declares the most common data type used for date-time data.
      • Choice Of: - min. 0
        • [Reference] (CodedDataAsNumeric)
          • Indicates that coded data should be treated as numeric, and defines the numeric type
        • [Reference] (CodedDataAsText)
          • Indicates that coded data should be treated as text, and defines the text type
      • [Reference] (DefaultVariableSchemeReference)
        • References the VariableScheme of the variables in the record. Can be overridden at the level of the DataItem.
      • [Reference] (r:ProprietaryInfo) - min. 0
        • Contains information proprietary to the software package which produced the data file. This is expressed as a set of name-value pairs.
      • [Reference] (DataItem) - min. 0 - max. unbounded
        • Describes a data item in the record.

DataItemAddressType: Provides minimum information on data item address system, such as variable ID or Name, etc.

• Content:
  • Sequence of:
    • [Reference] (r:Description) - max. unbounded
      • Description of the data item address

DataItemType: A single point of data within the file, which may carry an over-ride of the specified default datatype.

• Content:
  • Sequence of:
    • [Reference] (VariableReference)
      • Reference to the variable description in the Logical Product
    • [Reference] (ProprietaryDataType) - min. 0
      • Allows an override of the default data type, using the language of the proprietary software. A controlled vocabulary is recommended.
    • [Reference] (ProprietaryOutputFormat) - min. 0
      • Indicates the proprietary output format.
    • [Reference] (r:ProprietaryInfo) - min. 0
      • Contains proprietary information specific to the data item. This is expressed as a set of name-value pairs.