content_bundles

Content Bundles

Content bundles is a general format based on the current test plan layout for storing content, annotations on the content, and actions on the content. In general, content bundles should become a base format and test plans use that base format.

There are many uses of content bundles; each use requiring some customization. Some uses I see are: test plans (obviously); holder of on-demand content - storage container feeding the on-demand document source; general source actors - meaning actors that send content - some examples are document source and integrated source/repository; storage for FHIR content.

This document describes the basic format and rules for use. Other documents will describe how to customize the format for a particular purpose.

General layout

Here is the general directory/file layout.

bundle_name/
            index.idx
            bundle.properties
            tom/
                    metadata.xml
                    section.properties
            george/
                    metadata.xml
                    document7.pdf
                    section.properties
            ruth/
                    metadata.xml
                    mydocument.pdf
                    section.properties

Where index.idx contains

tom
ruth
george

Index.idx indicates the order of execution or usage, each line holding a single word which must be a directory peer of index.idx.

Bundle.properties hold properties that describe the overall bundle. This might hold the bundle type and general identifiers. It is metadata for the bundle - metadata in the general sense, not XDS metadata.

The directories inside the bundle are sections - just like in test plans. The order of usage of the test plans is documented in index.idx which is a simple list of the section names, one name per line.

In each section is the file section.properties. This is metadata for the section. Its use and content depend on the bundle type specified in bundle.properties.

The other files in the section are dependent on the bundle type and section type. I have shown some examples here that should be familiar from the current test plan layout.

Bundle.properties and section.properties contain a property by the name of type which indicates the type of the bundle or section. These types drive the expectations of what file/contents are present in other files/directories. Also the type indicates purpose of the bundle so that the code using it can verify the bundle was intended for the purpose at hand. The example shown above demonstrates some general content but is not intended to be a specific use/format based on content bundles.

Sections.properties contain a property by the name of transaction which indicates the transaction type to be generated by the section.