DMS Data Types

General Structure

The data in a JCR consists of a tree of nodes with associated properties. Data is stored in the properties, which may hold simple values such as numbers and strings or binary data of arbitrary length. Nodes may optionally have one or more types associated with them which dictate the kinds of properties, number and type of child nodes, and certain behavioral characteristics of the nodes. Nodes may point to other nodes via a special reference type property. In this way nodes in a JCR offer both referential integrity and object oriented concept of inheritance. Additional node types include the referenceable node type which allows the user to reference said node through use of a universally unique identifier. Another popular type is the versionable type. This makes the repository track a document's history and store copies of each version of the document.

Configuring the Caching Behavior of JCR Sources

You can configure the caching behavior for your JCR sources by using properties which you can set in your carnot.properties file.

Streaming Threshold

With the property Carnot.Configuration.ContentStreamingThreshold you can configure if a content should be downloaded via the download servlet. In case the size of a document content is below the value of this property, the content will be cached. If the content size is higher, the content download and upload is streamed using the dms-content servlet. The default value is 500.

Maximum Cache Size

The property Carnot.Configuration.MaximumCacheItems determines the maximum cache size. If this size is exceeded, the least-recently-used JCR objects (cached in a fixed size map) will be removed. The default value is 100.

Maximum Caching Time

The property Carnot.Configuration.CacheTTL determines the maximum caching time. In case this time is exceeded, the least-recently-used JCR objects will be removed. The default value is 60000 ms.

Stardust DMS Data Types

Stardust offers the following Document Management Service data types:

Document Data Type

To create a Document Data Type:

Create a Document Data
Figure: Create a Document Data Type.

Properties

General

In the Properties dialog, select General. The following properties are available in this section:

DMS Document Properties - General
Figure: DMS Document Properties - General

In the properties dialog select DMS Document entry. In the Declared Types section you can choose the data type to assign to your document:

DMS Document Properties Settings
Figure: DMS Document Properties Settings

In the Details part the details of the selected data type is displayed. If you select the check box Display Imported Model Elements as Groups then the references for the declared types are also displayed.

DMS Document Properties Settings
Figure: DMS Document Properties Settings

Note

Note that the assignment of the structured data type Enumeration is not supported for Document Data Types.

Document List Data Type

The Document List data type can contain zero or many objects of the type Document Data. These are needed to represent the result of the following DMS operations:

Please refer to the chapter Document Service Operation Application Type for information on these operations.

The type Document List is also used for the Process Attachment feature to represent all process attachments. Pleaser refer to the section Process Attachments Example of the DMS Operation Tutorial for detailed information on the process attachment usage.

To create a document list data type select Data > Document List in the diagrams toolbar palette:

Create a Document List Data Type.
Figure: Create a Document List Data Type.

Properties

In the properties dialog select DMS Document List entry. In the Declared Types section you can choose the data type to assign to your document list:


Figure: DMS Document List Properties Settings

In the Details part the details of the selected data type is displayed. If you select the check box Display Imported Model Elements as Groups then the references for the declared types are also displayed.


Figure: DMS Document List Properties Settings

Note

Note that the assignment of the structured data type Enumeration is not supported for Document List Data Types.

Folder Data Type

To create a folder data type select Data > Folder in the diagrams toolbar palette:

Create a Folder Data Type.
Figure: Create a Folder Data Type.

Properties

In the properties dialog select DMS Folder entry. In the Declared Types section you can choose the data type to assign to your folder data:

DMS Folder Properties Settings
Figure: DMS Folder Properties Settings

In the Details part the details of the selected data type is displayed. If you select the check box Display Imported Model Elements as Groups then the references for the declared types are also displayed.


Figure: DMS Folder Properties Settings

Note

Note that the assignment of the structured data type Enumeration is not supported for Folder Data Types.

Folder List Data Type

The Folder List data type can contain zero or many objects of the Folder Data type. These are needed to represent the result of the following DMS operations:

Please refer to the chapter Document Service Operation Application Type for information on these operations.

To create a folder list data type select Data > Folder List in the diagrams toolbar palette:

Create a Folder List Data Type.
Figure: Create a Folder List Data Type.

Properties

In the properties dialog select DMS Folder List entry. In the Declared Types section you can choose the data type to assign to your folder list data:

DMS Folder List Properties Settings
Figure: DMS Folder List Properties Settings

In the Details part the details of the selected data type is displayed. If you select the check box Display Imported Model Elements as Groups then the references for the declared types are also displayed.


Figure: DMS Folder List Properties Settings

Note

Note that the assignment of the structured data type Enumeration is not supported for Folder List Data Types.

Metadata

Metadata are available for documents, document lists, folders and folder lists. It can be selected in the Declared Types entry of the data elements.

Default Metadata

If the type default is selected as in the following screenshot:

Default Type
Figure: Choose default Type.

the metadata access point is a list of ResourceProperty:

Metadata Access Point
Figure: Access Point Type ResourceProperty List

Dereferentiation paths can then be specified:

Specifying the Dereferentiation Paths.
Figure: Specifying the Dereferentiation Paths.

User-Defined Metadata

Structured data defined for the process model can be used to specify non-default metadata for documents and folders (not for document lists or folder lists).

In the following example screenshot the structured type Product is a user-defined data structure:

Choose a User-defined Data Structure.
Figure: Choose a User-defined Data Structure.

The access point metadata will then have the type SimpleStruct:

Access Point Type SimpleStruct
Figure: Access Point Type SimpleStruct

Dereferentiation paths can then be specified:

Specifying the Dereferentiation Paths.
Figure: Specifying the Dereferentiation Paths.

Manual Activity Mapped only to the Document Data

When a single direct document data mapping exists with the manual activity (manual activities are mapped only to the document data), then the behavior for document data and manual activity panel is as follows:

In-Out Data Mapping

The Upload Document option is provided in the manual activity panel.

Upload Document
Figure: Upload Document

The document view toolbar is displayed in-line with Activity toolbar.

Activity Toolbar with Document Viewer panel
Figure: Activity Toolbar with Document Viewer panel