The importer uses this file to create the folder structure and the handles for the hippo documents. This file is validated by the importer against its schema (XSD) if it is specified in the parameterization file (xsdStructureValidator). If the xml is considered valid the importer will process the structure xml, if it is invalid the importer shuts down and logs the error in the log file. 

The structure xml file has the following structure:

  • Structure 
    • Folders 
      • Properties 
        • Value(s) 
  • Mixins 
  • Translation 
  • Folders 
    • Properties 
      • Value(s) 
  • Mixins 
  • Translation 
  • Folders 
    • etc... 
  • Resources 
    • Resources 

Definitions of elements and their attributes

  • Structure: initialization of the structure 
    • startnode: UUID of the parent node of the structure described in the current file 
  • Folder: Hippo document folder 
    • name attribute: name of the node that represents this folder 
    • xillio_id: unique id 
    • type: primary node type definition 
    • foldertype: folder type declaration to add to properties that are defined in the parameterization file under the folder type defaults (???) 
  • Property: property of the node
    • name: name of the property 
  • Value: value of the property. Use multiple value elements if a property should have multiple values. 
  • Mixin: name of the mixin that should be added. Use multiple mixin elements if multiple mixins must be added. 
  • Translation: Name of the folder in the CMS interface for the specified language attribute 
    • language: language code for which the folder name applies, leave this attribute empty for a general name that should equal for al languages 
  • Resource: the handle for a Hippo document 
    • xillio_id: unique id 
    • filename: name of the content xml file for the current Hippo document 

Example of a simple structure xml file

<?xml version="1.0" encoding="UTF-8"?>
<Structure startnode=" /content/documents/project" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="d:/Projects/SampleProject/4-Import/HippoImporter/schemas/structure.xsd">
<Folder name="sample-pages" xillio_id="790CD25F0EE787F90A45592390C37E0B" type="hippostd:folder" foldertype="">
<Property name="hippotranslation:locale" type="string">
<Value><![CDATA[en]]></Value>
</Property>
<Property name="hippotranslation:id" type="string">
<Value><![CDATA[790CD25F0EE787F90A45592390C37E0B]]></Value>
</Property>
<Translation language=""><![CDATA[Sample pages]]></Translation>
<Resource name="sample-page-1" xillio_id="D7B26D89B7D2641CFED632020B11753F" filename="D7B26D89B7D2641CFED632020B11753F.xml"/>
<Resource name="Sample-page-2" xillio_id="158920E61AE17470FD88B16584E54916" filename="158920E61AE17470FD88B16584E54916.xml"/>
<Resource name="Sample-page-3" xillio_id="AF3DCDF55EFD7B95B31C236FDFDC4C03" filename="AF3DCDF55EFD7B95B31C236FDFDC4C03.xml"/>
<Resource name="sample-page-4" xillio_id="4DAA706B0A26E99E7688BC30E9B5A074" filename="4DAA706B0A26E99E7688BC30E9B5A074.xml"/>
<Folder name="more-sample-pages" xillio_id="4B958338271063CF3C73DB5E41690914" type="hippostd:folder" foldertype="">
<Property name="hippotranslation:locale" type="string">
<Value><![CDATA[en]]></Value>
</Property>
<Property name="hippotranslation:id" type="string">
<Value><![CDATA[4B958338271063CF3C73DB5E41690914]]></Value>
</Property>
<Translation language=""><![CDATA[More sample pages]]></Translation>
<Resource name="sample-page-5" xillio_id="846A01D7D4B5469443A5CAB8BC3FEDAE" filename="846A01D7D4B5469443A5CAB8BC3FEDAE.xml"/>
<Resource name="sample-page-6" xillio_id="9518437C4CED23021AE77351B30DCF40" filename="9518437C4CED23021AE77351B30DCF40.xml"/>
<Resource name="sample-page-7" xillio_id="2984FA51E48C019EF2EA5A777C3BBC2F" filename="2984FA51E48C019EF2EA5A777C3BBC2F.xml"/>
</Folder>
</Folder>
</Structure>

Example of an image xml file

<?xml version="1.0" encoding="UTF-8"?> 
<Resource name="sample-image.jpg" xillio_id="3D1A7E0CEE2A8B661E92148A040A288B" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="d:/Projects/Politie/4-Import/HippoImporter/schemas/resources.xsd">
<Input name="sample-image.jpg" xillio_id="A2831B7102BCB7E42277B419EAA5F445" type="sampleproject:imageset">
<Mixin><![CDATA[hippo:harddocument]]></Mixin>
<Property name="hippo:availability">
<Value><![CDATA[live]]></Value>
<Value><![CDATA[preview]]></Value>
</Property>
<Property name="hippogallery:filename">
<Value><![CDATA[sample-image.jpg]]></Value>
</Property>
<Property name="hippogallery:description">
<Value><![CDATA[Sample Image (alt text)]]></Value>
</Property>
<Input name="hippogallery:original" xillio_id="B035961103BE2197CF3261B6A119D8C6" type="hippogallery:image">
<Property name="jcr:mimeType">
<Value><![CDATA[image/jpeg]]></Value>
</Property>
<Property name="jcr:lastModified">
<Value><![CDATA[2011-11-21T17:16:00.000+0100]]></Value>
</Property>
<Property name="jcr:data">
<Value><![CDATA[sample-image-original.jpg]]></Value>
</Property>
<Property name="hippogallery:width">
<Value><![CDATA[400]]></Value>
</Property>
<Property name="hippogallery:height">
<Value><![CDATA[500]]></Value>
</Property>
</Input>
<Input name="hippogallery:thumbnail" xillio_id="7476107A98636A328C096334736DC93B" type="hippogallery:image">
<Property name="jcr:mimeType">
<Value><![CDATA[image/jpeg]]></Value>
</Property>
<Property name="jcr:lastModified">
<Value><![CDATA[2011-11-21T17:16:00.000+0100]]></Value>
</Property>
<Property name="jcr:data">
<Value><![CDATA[sample-image-thumbnail.jpg]]></Value>
</Property>
<Property name="hippogallery:width">
<Value><![CDATA[60]]></Value>
</Property>
<Property name="hippogallery:height">
<Value><![CDATA[48]]></Value>
</Property>
</Input>
<Input name="sampleproject:w184h112" xillio_id="A848250A412FAAD992438D9013F11060" type="hippogallery:image">
<Property name="jcr:mimeType">
<Value><![CDATA[image/jpeg]]></Value>
</Property>
<Property name="jcr:lastModified">
<Value><![CDATA[2011-11-21T17:16:00.000+0100]]></Value>
</Property>
<Property name="jcr:data">
<Value><![CDATA[sample-image-184x112.jpg]]></Value>
</Property>
<Property name="hippogallery:width">
<Value><![CDATA[184]]></Value>
</Property>
<Property name="hippogallery:height">
<Value><![CDATA[112]]></Value>
</Property>
</Input>
<Input name="sampleproject:w89h112" xillio_id="9F406B649751F4A48E20509C5AAF9E9F" type="hippogallery:image">
<Property name="jcr:mimeType">
<Value><![CDATA[image/jpeg]]></Value>
</Property>
<Property name="jcr:lastModified">
<Value><![CDATA[2011-11-21T17:16:00.000+0100]]></Value>
</Property>
<Property name="jcr:data">
<Value><![CDATA[sample-image-89x112.jpg]]></Value>
</Property>
<Property name="hippogallery:width">
<Value><![CDATA[89]]></Value>
</Property>
<Property name="hippogallery:height">
<Value><![CDATA[112]]></Value>
</Property>
</Input>
</Input>
</Resource>

Example of an asset xml file

<?xml version="1.0" encoding="UTF-8"?> 
<Resource name="sample-asset.pdf" xillio_id="453C3070EDC5A6F713634D3D63576ED7" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="d:/Projects/SampleProject/4-Import/HippoImporter/schemas/resources.xsd"> 
<Mixin><![CDATA[hippo:translated]]></Mixin>
<Translation language=""><![CDATA[sample-asset.pdf]]></Translation>
<Input name="sample-asset.pdf" xillio_id="0E06238D8BF08B4A16C3839BCF4E23EF" type="hippogallery:exampleAssetSet">
<Mixin><![CDATA[hippo:harddocument]]></Mixin>
<Property name="hippo:availability">
<Value><![CDATA[live]]></Value>
<Value><![CDATA[preview]]></Value>
</Property>
<Input name="hippogallery:asset" xillio_id="39FC4025B083886A854AB0E10BE9881B" type="hippo:resource">
<Property name="jcr:mimeType">
<Value><![CDATA[application/pdf]]></Value>
</Property>
<Property name="jcr:lastModified">
<Value><![CDATA[2011-11-21T14:54:00.000+0100]]></Value>
</Property>
<Property name="jcr:data">
<Value><![CDATA[453C3070EDC5A6F713634D3D63576ED7.pdf]]></Value>
</Property>
</Input>
</Input>
</Resource>


Continue to: Link Resolution