SAP document structure
ImageMaster SAP documents i.e. documents that will be registered in SAP and later be accesses via SAP have to have a well defined structure. The ImageMaster for SAP ContentServer needs certain information to pass to SAP. SAP queries document information to display the document components (files of a document). So the metadata structure and the information have to be adequately prepared before archiving. See the ImageMaster FIS document structure below.
<?xml version="1.0" encoding="UTF-8"?>
<tns:operation name='archive' xmlns:tns='http://imafis.imaes.ecm.tsystems.com/' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://imafis.imaes.ecm.tsystems.com/ Metadata.xsd '>
<revision>
<documentType name='InvoiceWI' />
<metadata>
<attribute name='InvoiceWI.InvoiceNo'>321</attribute>
<attribute name='InvoiceWI.Barcode'>BAbfec41bf-8fee-49c3-a2e7-66f78e4551a8</attribute>
<attribute name='InvoiceWI.Supplier'>CocaCola</attribute>
<attribute name='InvoiceWI.InvoiceDateTime'>2000-01-01T12:34:56.739+02:00</attribute>
<attribute name='InvoiceWI.InvoiceDate'>2000-01-01</attribute>
</metadata>
<content key='NMTOKEN'>
<properties>
<property key='compId'>data</property>
</properties>
<data>
<binaryObject batchFileName='data.txt' originalFileName='Odata.txt' hashAlgorithm='MD5' mimeType='text/plain' />
</data>
</content>
</revision>
</tns:operation>
Figure 409: ImageMaster FIS document structure (one content object)
<?xml version="1.0" encoding="UTF-8"?>
<tns:operation name='archive' xmlns:tns='http://imafis.imaes.ecm.tsystems.com/' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://imafis.imaes.ecm.tsystems.com/ Metadata.xsd '>
<revision>
<documentType name='InvoiceBC' />
<metadata>
<attribute name='InvoiceBC.InvoiceNo'>324</attribute>
<attribute name='InvoiceBC.Barcode'>DAbfec41bf-8fee-49c3-a2e7-66f78e4551a8</attribute>
<attribute name='InvoiceBC.Supplier'>Shell</attribute>
<attribute name='InvoiceBC.InvoiceDateTime'>2000-01-01T12:34:56.739+02:00</attribute>
<attribute name='InvoiceBC.InvoiceDate'>2000-01-01</attribute>
</metadata>
<content key='NMTOKEN'>
<properties>
<property key='compId'>data1</property>
</properties>
<data>
<binaryObject batchFileName='data1.txt' originalFileName='Odata1.txt' hashAlgorithm='MD5' mimeType='text/plain' />
</data>
</content>
<content key='NMTOKEN'>
<properties>
<property key='compId'>data2</property>
</properties>
<data>
<binaryObject batchFileName='data2.txt' originalFileName='Odata2.txt' hashAlgorithm='MD5' mimeType='text/plain' />
</data>
</content>
</revision>
</tns:operation>
Figure 410: ImageMaster FIS document structure (multiple content objects)
Item |
Description |
---|---|
Content key |
The content objects of a document have to be defined with a valid content key. A valid content key can contain all NMTOKEN characters e.g. a UUID. The content keys of the content objects have to be unique within a document. NMTOKEN in the figure above is a placeholder for an actual value. |
Content property “compId” |
Each content object has a content property with the name “compId” which defines the SAP component name compliant to the SAP ArchiveLink specification. A SAP component name defines an alphabetical order for the parts of the document. The content property with the name compId has to be provided with the value data if there only is one content object in a document. If there are multiple content objects in a document, the content properties with the name compId have to be provided with the value starting with data1 for the first content object. Subsequent content objects proceed with data2, data3 etc. |
Binary object “mimeType” |
This mime type is the mimeType of the binary file. It is used to tell SAP the type of the content. |
Table 246: SAP Messenger items |
Since version 9.4.2 and the SAPCUDRevisionFilterExtension installed the content properties can be omitted. These will be set automatically in the order of the content objects contained in the content list starting with “data1-dataN” respectively data for one content object. If you want to have control over component numbering set the content properties a described above.
The SAP content server reserved compId values “note” and “descr” will be ignored during every SAP Messenger or SAPExtension processing.
Also see the related recommendation SAP document structure.