Concepts

Describes the model and the assumptions behind the client

Relation Types

The client requires several relation types:

deep_dependency: defines a deep dependency between a document and its resources. The left ID is the source and the right ID the destination of this relation.
flat_dependency: defines a flat dependency between a document and its resources. The left ID is the source and the right ID the destination of this relation.
pub_search: relates a literature set (i.e. an object with the object type literature_set) with a search

Every object is one of the following (this list is not complete):

_default_objtype: Default object type
document: An object containing a document
image: An object containing an image
literature set: A literature set consists (i.e. is linked to) document, image, etc. (via a literature_set relation)
_search: The results of a search are linked to search object (via a pub_search relation)

The client requires several folders:

root: the root of all folders. The only folder that has itself as its own parent
/system: contains all relevant system folders
/system/applications: Contains application specific config (among other objects).
/system/applications/<applicationname>/supporting_documents: Supporting documents for an application.
/system/custom
/system/users: contains the home folder structure of the users (carts, config, home, searches). home contains the folder Literature Sets.
/templates: contains templates
/basic_data_tables: contains basic data tables
/images
/documents

The registry path /HKCU/Software/cmn contains several keys:

Locks: contains information which objects are locked locally (i.e. which are checked out) and objects they depend on.
The key for the lock itself has the name <repository>:<object ID> and its value is the absolute file name of the object's content file (e.g. cmn_test:42)
The key for the dependencies are contained in the key <repository>:<object ID>.dependencies. They are built like the key for the object itself (e.g. cmn_test:42.dependencies/cmn_test:23)