Victorian Electronic Records Strategy - Forever Digital logo
 


Search
    

4.2 Manifest Schema

A Manifest is an XML-1.0 document. Its XML Schema definition is available at http://www.prov.vic.gov.au/vers/standard/versManifest.xsd and is:

 

<?xml version="1.0" encoding="UTF-8"?>

<xsd:schema

 targetNamespace=”http://www.prov.vic.gov.au/digitalarchive/

 xmlns:xsd=”http://www.w3.org/2001/XMLSchema

 xmlns:dam=”http://www.prov.vic.gov.au/digitalarchive/

 elementFormDefault="qualified" attributeFormDefault="unqualified">

  <xsd:annotation>

    <xsd:documentation xml:lang="en">

Digital Archive Set Manifest Schema –

Copyright 2004 Public Record Office Victoria

    </xsd:documentation>

  </xsd:annotation>

  <xsd:simpleType name="SeriesType">

    <xsd:restriction base="xsd:string">

      <xsd:enumeration value="VPRS"/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:simpleType name="ConsignmentType">

    <xsd:restriction base="xsd:string">

      <xsd:pattern value="[A-Z]{1,2}"/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:simpleType name="MediaType">

    <xsd:restriction base="xsd:string">

      <xsd:enumeration value="CD"/>

      <xsd:enumeration value="DVD"/>

      <xsd:enumeration value="DDS TAPE"/>

      <xsd:enumeration value="LTO TAPE"/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:simpleType name="JobId">

    <xsd:restriction base="xsd:string">

      <xsd:pattern value="[A-Z]{2}\s[0-9]{4}/[0-9]{4}">

        <xsd:annotation>

          <xsd:documentation>

            Pattern example: 'TR 2004/0001'

          </xsd:documentation>

        </xsd:annotation>

      </xsd:pattern>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:simpleType name="ComputerFilename">

    <xsd:restriction base="xsd:string">

      <xsd:maxLength value="256"/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:simpleType name="FileIdentifier">

    <xsd:restriction base="xsd:string">

      <xsd:maxLength value="15"/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:simpleType name="VersRecordIdentifier">

    <xsd:restriction base="xsd:string">

      <xsd:maxLength value="15"/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:simpleType name="VeoTitle">

    <xsd:restriction base="xsd:string">

      <xsd:maxLength value="1024"/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:simpleType name="VeoClassification">

    <xsd:restriction base="xsd:string">

      <xsd:maxLength value="1024"/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:simpleType name="VeoAccessCategory">

    <xsd:restriction base="xsd:string">

      <xsd:maxLength value="1024"/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:simpleType name="VeoDisposalAuthority">

    <xsd:restriction base="xsd:string">

      <xsd:maxLength value="1024"/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:complexType name="VeoDateRange">

    <xsd:sequence>

      <xsd:element name="veo_start_date" type="dam:VeoDate" nillable="true"/>

      <xsd:element name="veo_end_date" type="dam:VeoDate" nillable="true"/>

    </xsd:sequence>

  </xsd:complexType>

  <xsd:simpleType name="VeoDate">

    <xsd:restriction base="xsd:string">

      <xsd:maxLength value="22"/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:simpleType name="SizeKB">

    <xsd:restriction base="xsd:nonNegativeInteger">

      <xsd:maxInclusive value='999000000'/>

    </xsd:restriction>

  </xsd:simpleType>

  <xsd:complexType name="ManifestObjectItem">

    <xsd:sequence>

      <xsd:element name="computer_filename" type="dam:ComputerFilename"/>

      <xsd:element name="file_identifier" type="dam:FileIdentifier" maxOccurs="unbounded"/>

      <xsd:element name="vers_record_identifier" type="dam:VersRecordIdentifier" nillable="true"/>

      <xsd:element name="veo_title" type="dam:VeoTitle"/>

      <xsd:element name="veo_classification" type="dam:VeoClassification"/>

      <xsd:element name="veo_access_category" type="dam:VeoAccessCategory"/>

      <xsd:element name="veo_disposal_authority" type="dam:VeoDisposalAuthority"/>

      <xsd:element name="veo_date_range" type="dam:VeoDateRange"/>

      <xsd:element name="size_kb" type="dam:SizeKB"/>

    </xsd:sequence>

  </xsd:complexType>

  <xsd:complexType name="ManifestObjectList">

    <xsd:sequence>

      <xsd:element name="manifest_object_item" type="dam:ManifestObjectItem" maxOccurs="unbounded"/>

    </xsd:sequence>

  </xsd:complexType>

  <xsd:complexType name="MediaItem">

    <xsd:sequence>

      <xsd:element name="media_written_date" type="xsd:date"/>

      <xsd:element name="media_item_number" type="xsd:integer"/>

      <xsd:element name="media_item_total_number" type="xsd:integer"/>

      <xsd:element name="media_type" type="dam:MediaType"/>

    </xsd:sequence>

  </xsd:complexType>

  <xsd:complexType name="MediaList">

    <xsd:sequence>

      <xsd:element name="media_item" type="dam:MediaItem" maxOccurs="unbounded"/>

    </xsd:sequence>

  </xsd:complexType>

  <xsd:group name="CommonTransferElements">

    <xsd:sequence>

      <xsd:element name="created_timestamp" type="xsd:dateTime"/>

      <xsd:element name="agency_id" type="xsd:integer"/>

      <xsd:element name="series_type" type="dam:SeriesType"/>

      <xsd:element name="series_number" type="xsd:integer"/>

      <xsd:element name="job_id" type="dam:JobId"/>

      <xsd:element name="consignment_type" type="dam:ConsignmentType"/>

      <xsd:element name="consignment_number" type="xsd:integer"/>

      <xsd:element name="manifest_object_list" type="dam:ManifestObjectList"/>

    </xsd:sequence>

  </xsd:group>

  <xsd:complexType name="MediaTransfer">

    <xsd:sequence>

      <xsd:group ref="dam:CommonTransferElements"/>

      <xsd:element name="media_list" type="dam:MediaList"/>

    </xsd:sequence>

  </xsd:complexType>

  <xsd:complexType name="ElectronicTransfer">

    <xsd:sequence>

      <xsd:group ref="dam:CommonTransferElements"/>

    </xsd:sequence>

  </xsd:complexType>

  <xsd:complexType name="SetManifest">

    <xsd:choice>

      <xsd:element name="media_transfer" type="dam:MediaTransfer"/>

      <xsd:element name="electronic_transfer" type="dam:ElectronicTransfer"/>

    </xsd:choice>

    <!-- choice element forces the XML data to have either one electronic transfer or one media transfer included -->

  </xsd:complexType>

  <xsd:element name="set_manifest" type="dam:SetManifest"/>

</xsd:schema>

The contents of the leaf elements are as follows:

  • Created Time Stamp (dam:created_timestamp). This is the date and time the Manifest was created. The date/time is expressed in the form defined in PROS 99/007 (Version 2), Specification 2, section 14.
  • Agency Identifier (dam:agency_identifier). This is the VA number without the leading ‘VA’.
  • SeriesType (dam:series_type). This element contains the type of the series. This will always be the text string “VPRS”.
  • Series Identifier (dam:series_number). This is the VPRS number, without the leading ‘VPRS’.
  • ConsignmentType (dam:consignment_type). This element contains the type of the consignment. The value must consist of one or two alphabetic characters. Normally this would be the text string “P”.
  • ConsignmentNumber (dam:consignment_number). This is the consignment number within the series. This must be four digits long, and padded with leading zeros if necessary.
  • JobId (dam:job_id). This is the Job Identification number allocated by PROV to identify the whole transfer process. Note that there may be many sets exported within one transfer. The Job Identification number must start with two alpha characters, followed by a space, then 4 numeric characters, a forward slash, and finally four further numeric characters. An example is “TR 2006/0001”.
  • Computer Filename (dam:computer_filename). This is the file name of the VEO. It is limited to 256 characters long.
  • FileIdentifier (dam:file_identifier). This is the contents of the vers:FileIdentifier (M102) element in the VEO. It has a maximum length of 15 characters. If the vers:FileIdentifier element is longer than this it should be truncated at the beginning or end to this length.
  • VersRecordIdentifier (dam:vers_record_identifier). This is the contents of the vers:VERSRecordIdentifier (M103) element in the VEO. It has a maximum length of 15 characters. If the vers:VERSRecordIdentifier element is longer than this it should be truncated at the beginning or end to this length.
  • VeoTitle (dam:veo_title). This is the contents of the vers:TitleWords (M35) element. It has a maximum length of 1024 characters. If the vers:TitleWords element is longer than this it should be truncated at the beginning or end to this length.
  • VeoClassification (dam:veo_classification). This contains the classification of the VEO. It has a maximum length of 1024 characters; if the value is longer than this it must be truncated at the beginning or end to this length. The value is generated as follows:
    • if the naa:Function (M50) element is present, the value is the concatenation of naa:FunctionDescriptor (M51), naa:ActivityDescriptor (M52), and naa:ThirdLevelDescriptor (M53) with spaces between.
    • If the vers:Subject (M37) element is present, the value is the concatenation of “(“, the vers:KeywordLevel (M38), “ “, the vers:Keyword (M39), the vers:Subject (recursive), and “)”
    • If neither naa:Function (M50) or vers:Subject (M37) element is present, the value is set to “No classification”.
  • VeoAccessCategory (dam:veo_access_category). This contains the value of the naa:AccessStatus (M29) element, if present, otherwise the text “Not specified”. It has a maximum length of 1024 characters, and must be truncated to this length if longer.
  • VeoDisposalAuthority (dam:disposal_authority). This contains the value of the naa:Sentence (M90) element. It has a maximum length of 1024 characters, and must be truncated to this length if longer.
  • VeoDateRange (dam:date_range). This indicates the date range covered by the VEO. It has a mandatory start and end date. The start date is always the date of registration (i.e. naa:DateTimeRegistered (M57) element). If the VEO is a RecordVEO, the end date is empty (i.e. xsi:nil=”true”). If the VEO is a File VEO, the end date is vers:DateTimeClosed (M144), if present, otherwise it is empty (i.e. xsi:nil=”true”)
  • SizeKB (dam:size_kb). This contains the size of the VEO in kilobytes (1000 bytes). The maximum size is 999000000 kB.
  • Date media written (dam:media_written_date). This is the date the media was written. The date/time is expressed in the form defined in PROS 99/007 (Version 2), Specification 2, section 14.
  • Media Piece Number (dam:media_item_number). This is the sequential number of the piece of media within the collection of media for this Set.
  • Total media count (dam:media_item_total_number). This is the toal number of pieces of media used to export this Set.
  • Media Type (dam:media_type). This is the type of media. Valid values are “CD”, “DVD’, “LTO”, and “DDS”.

back to top

Department for Victorian Communities logo - Link to DVC home Public Record Office Victoria logo - Link to PROV home