Database DMS

This document management system module retrieves a list of document associated with an entity from a database.

The information required when configuring the DB DMS is provided by a data definition, the dms tag links an entity to the data definition which is then used to retrieve a list of attributes to display to the user along with a URL that can be used to display the document in question.

Any number of attributes can be retrieved from the database for display to the user.

Namespace

urn:com.cohga.server.dms.provider.db#1.0

Tags

dms

Properties

Name

Type

Required

Description

id

string

yes

unique identifier

entity

ref urn:com.cohga.server.entity#1.0

yes

The entity that this DMS will provide documents for

name

string

yes

The name of this DMS

datadefinition

ref urn:com.cohga.server.data#1.0:datadefinition

yes

A reference to a data definition that will supply the attributes and URL link for each document

acl

ref urn:com.cohga.server.acl#1.0:acl

no

A reference to an ACL to attach to the dms. Only available since Weave 2.5.16.

Sub-tags

Name

Type

Cardinality

acl

urn:com.cohga.server.acl#1.0:acl

0..1

Content

None

Notes

  • The name is used because there may be more than one DMS attached to an
    entity type and this helps the user differentiate beween them

Examples

A simple example that uses a table that has a description and url column

<data:datadefinition id="property_doclink">
	<datasourcedataconnection datasource="docsource" table="PROPERTY_DOCLINK" key="PID">
		<parameter column="description"/>
		<parameter column="url"/>
	</datasourcedataconnection>
</data:datadefinition>

<dbdms:dms id="old_docs">
	<name>Uploaded Documents</name>
	<entity>property</entity>
	<datadefinition>property_doclink</datadefinition>
</dbdms:dms>

Creating a list of documents to display properties in google maps.
The data definition constructs the url by concatenating a the first part of a google maps search to a pre-formatted address column from the database.

<data:datadefinition id="property_google">
	<datasourcedataconnection datasource="docsource" table="PROPERTY_DOCLINK" key="PID">
		<parameter name="url" type="url" text="Display in Google Maps" url="'http://maps.google.com.au/?q='|address"/>
		<parameter column="address"/>
	<datasourcedataconnection>
</data:datadefinition>

<dbdms:dms id="google">
	<name>Google Maps</name>
	<entity>property</entity>
	<datadefinition>property_google</datadefinition>
</dbdms:dms>