KB: Metadata Requirements for the Upload Client (ULC)
- Tobias Svenberg
Introduction: This article provides detailed guidance on the metadata file required for documents uploaded through the Upload Client (ULC) in order for the portal to automaticaly store the meta data in the Projektstruktur portal. Here illustrated with an example XML file. A metadata file is essential for automatic metadata storage in the portal.
Example XML File: Below is an excerpt from the provided example XML file, E-60-1-0100.xml, showing the structure and elements:
<?xml version="1.0" encoding="utf-8" ?>
<metadata sourceFile="P:\Clients\Client\Project\Drawings and Records\E\Design\E-60-1-0100.dwg" path="{DrawingsRoot}\E\Design" xmlns="urn:ulc-metadata-schema">
<layouts>
<layout name="Layout1">
<components>
<component name="FRAME-A1">
<fields></fields>
</component>
<component name="StampA1">
<fields>
<field>
<name><![CDATA[COMPANY]]></name>
<value><![CDATA[EXAMPLE]]></value>
</field>
<!-- Additional fields here -->
</fields> </component>
<!-- Additional components here -->
</components>
</layout>
<!-- Additional layouts here -->
</layouts>
<!-- Additional metadata elements here -->
</metadata>Metadata File Naming Convention:
In order for Projektstruktur to properly pick up the correct meta data the file and allow the meta data for the file to validated the names need to match as outlined below:
Document Name:
E-60-1-0100.dwgMetadata File:
E-60-1-0100.xml
Metadata File Structure:
Root element:
<metadata>with attributessourceFileandpath.Child element:
<layouts>containing layout details.Example of a layout element:
<layout name="Layout1">.
Target Location Variable:
Example from XML:
path="{DrawingsRoot}\E\Design".
Metadata Elements:
layouts: Contains layout information.layout: Details of a specific layout in the document.components: Contains component information.fields: Holds the fields of a component.
Conclusion: This article provides an overview of the required structure and elements for a metadata file accompanying documents uploaded through the ULC, using E-60-1-0100.xml as an example. The structure and examples shown here should guide users in creating their metadata files correctly.
Attached is an xml example:
