Microsoft Word Properties

The adapter reads metadata (document properties like author, last saved) of a Microsoft Word document (.doc or .docx) and outputs the data in a UTF-8-encoded XML document.

Properties

Operation

Defines the operation executed by the function adapter

Possible values: Get: Read document properties from an MS Word document

Parameters

Adapter

Main adapter class (do not change!)

Possible values: de.softproject.integration.adapter.wordheaderadapter.wordHeaderAdapter: Main class (Default)

Status values

1 (successful)	The adapter was executed successfully and the read document properties were outputted as XML document
0	The processed document has a wrong file format
-1 (error)	The processed document is not a valid `.doc` or `.docx` file or other error occurred (see server protocol)

Input

The adapter expects a Microsoft Word document with the ending .doc or .docx as input.

Output

The adapter ouputs an XML document with the following structure:

XML

<WordHeader>
    <Properties>
        <Author>Max Mustermann</Author>
        <Template>Normal.dotm</Template>
        <LastSavedBy>Max Mustermann</LastSavedBy>
        <LastPrinted>2017-12-07T09:24:00Z</LastPrinted>
        <ModifiedOn>2017-12-07T08:24:00Z</ModifiedOn>
        <Revision>3</Revision>
        <EditTime>60</EditTime> <!-- one hour edited in word -->
        <CreatedOn>2017-12-07T08:22:00Z</CreatedOn>
        <Title>Titelproperty</Titel>
        <Subject>Subjectproperty</Subject>
        <Keywords>Keyword</Keywords>
        <Comments>Comment</Comments>
        <Company>Max Mustermann GmbH</Company>
    </Properties>
    <Statistics>
        <Pages>1</Pages>
        <Words>6</Words>
        <Characters>40</Characters>
        <Application>Microsoft Office Word</Application>
        <Lines>1</Lines>
        <Paragraphs>1</Paragraphs>
        <CharactersWithSpaces>45</CharactersWithSpaces>
    </Statistics>
    <UserProperties />
</WordHeader>

Explanation: The element UserProperties is only filled for files with the ending .doc.

Data format changes

Please note that the data format has changed. The formerly German format dd.mm.yyyy hh:mm:ss is now formatted according to ISO-8601 in the UTC timezone yyyy-mm-ddThh:mm:ssZ.