...

Name	Type	Required	Description
datasource	ref urn:com.cohga.server.datasource.jdbc#1.0:datasource	yes	reference to the data source that this data definition should use to generate its data
table	string	yes	The name of the table that provides the data
key	string	no	If this data definition is generating data relating to an entity then this is the column name that contains the entities id
prefix	string	no	The prefix value will be inserted into the generated SQL statement immediately after the SELECT, for example DISTINCT
trim	boolean	no	If `true` the generated SQL will ensure that the id's are compared against a trimmed version of the id stored in the database. This helps with systems like Pathway, where some tables store padded id's

...

Name	Type	Cardinality
parameter	urn:com.cohga.server.data.database#1.0:parameter	1 0..n
cache	urn:com.cohga.server.cache#1.0:cache	0..1

...

The cache settings are only used for data source data connections that have a key specified, since it's the key that's used as the cache index
If no cache tag is specified then the data will still be cached, but it will use the default cache configuration, to disable caching you need to set disable to true inside the cache definition
If no parameters are specified then the server will generate parameters based on the columns in the underlying table, in this case you should also not include any from tags since joins are not supported, where tags are ok though.

Anchor

	parameter
	parameter

parameter

...

Sub-tags

None

Content

None

Examples

Code Block

	xml
	xml
title	Basic data definition where output is based on columns in the underlying table
linenumbers	true


<data:datadefinition id="roadDetails">
	<datasourcedataconnection datasource="datasource.main" table="ROADS" key="RD_NAME" prefix="DISTINCT"/>
</data:datadefinition>

Code Block

	xml
	xml
title	Sample data definition with caching parameters explicitly set

...

Code Block

xml	xml
linenumbers	true

<data:datadefinition id="roadDetails">
	<datasourcedataconnection datasource="datasource.main" table="ROADS" key="RD_NAME" prefix="DISTINCT">
		<from table="PLANS"/>
		<where clause="PLANS.ID=ROADS.PLAN_ID"/>
		<parameter name="name" label="Name" column="RD_NAME"/>
		<parameter name="suffix" label="Suffix" column="RD_SUFFIX"/>
		<parameter name="type" label="Type" column="RD_TYPE"/>
		<parameter name="altname" label="Alt. Name" column="ALT_NAME"/>
		<parameter name="altsuffix" label="Alt. Suffix" column="ALT_SUFFIX"/>
		<parameter name="alttype" label="Alt. Type" column="ALT_TYPE"/>
		<parameter type="integer" name="class" label="Class" column="CLASS_CODE"/>
		<parameter type="url" name="plan" label="Plan" column="'http://imgsvr:8080/gis/documents/plan_'|PLANS.PLAN_CODE|'.pdf'" text="Open"/>
		<cache>
			<maxElementsInMemory>500</maxElementsInMemory>
			<eternal>false</eternal>
			<timeToIdleSeconds>60</timeToIdleSeconds>
			<timeToLiveSeconds>300</timeToLiveSeconds>
			<overflowToDisk>true</overflowToDisk>
			<maxElementsOnDisk>20000</maxElementsOnDisk>
			<diskPersistent>false</diskPersistent>
			<diskExpiryThreadIntervalSeconds>120</diskExpiryThreadIntervalSeconds>
			<memoryStoreEvictionPolicy>LRU</memoryStoreEvictionPolicy>
		</cache>
	</datasourcedataconnection>
</data:datadefinition>

Code Block

	xml
	xml
title	Sample data definition with caching disabled

Code Block

xml	xml	linenumbers	true

<data:datadefinition id="roadDetails">
	<datasourcedataconnection datasource="datasource.main" table="ROADS" key="RD_NAME" prefix="DISTINCT">
		<from table="PLANS"/>
		<where clause="PLANS.ID=ROADS.PLAN_ID"/>
		<parameter name="name" label="Name" column="RD_NAME"/>
		<parameter name="suffix" label="Suffix" column="RD_SUFFIX"/>
		<parameter name="type" label="Type" column="RD_TYPE"/>
		<parameter name="altname" label="Alt. Name" column="ALT_NAME"/>
		<parameter name="altsuffix" label="Alt. Suffix" column="ALT_SUFFIX"/>
		<parameter name="alttype" label="Alt. Type" column="ALT_TYPE"/>
		<parameter type="integer" name="class" label="Class" column="CLASS_CODE"/>
		<parameter type="url" name="plan" label="Plan" column="'http://imgsvr:8080/gis/documents/plan_'|PLANS.PLAN_CODE|'.pdf'" text="Open"/>
		<cache disable="true"/>
	</datasourcedataconnection>
</data:datadefinition>

Code Block

	xml
	xml
title	Sample data definition with caching parameters supplied by a cache configuration (so the cache definition can be reused)

...

Code Block

xml	xml
linenumbers	true

<data:cache id="test.cache">
	<maxElementsInMemory>500</maxElementsInMemory>
	<eternal>false</eternal>
	<timeToIdleSeconds>60</timeToIdleSeconds>
	<timeToLiveSeconds>300</timeToLiveSeconds>
	<overflowToDisk>true</overflowToDisk>
	<maxElementsOnDisk>20000</maxElementsOnDisk>
	<diskPersistent>false</diskPersistent>
	<diskExpiryThreadIntervalSeconds>120</diskExpiryThreadIntervalSeconds>
	<memoryStoreEvictionPolicy>LRU</memoryStoreEvictionPolicy>
</data:cache>

<data:datadefinition id="roadDetails">
	<datasourcedataconnection datasource="datasource.main" table="ROADS" key="RD_NAME" prefix="DISTINCT">
		<from table="PLANS"/>
		<where clause="PLANS.ID=ROADS.PLAN_ID"/>
		<parameter name="name" label="Name" column="RD_NAME"/>
		<parameter name="suffix" label="Suffix" column="RD_SUFFIX"/>
		<parameter name="type" label="Type" column="RD_TYPE"/>
		<parameter name="altname" label="Alt. Name" column="ALT_NAME"/>
		<parameter name="altsuffix" label="Alt. Suffix" column="ALT_SUFFIX"/>
		<parameter name="alttype" label="Alt. Type" column="ALT_TYPE"/>
		<parameter type="integer" name="class" label="Class" column="CLASS_CODE"/>
		<parameter type="url" name="plan" label="Plan" column="'http://imgsvr:8080/gis/documents/plan_'|PLANS.PLAN_CODE|'.pdf'" text="Open"/>
		<cache id="test.cache"/>
	</datasourcedataconnection>
</data:datadefinition>

Code Block

	xml
	xml
title	A data definition for supplying a list of values (no key is defined), probably for a cascading input parameter for a search

...

Code Block

xml	xml
linenumbers	true

<data:datadefinition id="suburbRoads">
	<datasourcedataconnection datasource="datasource.main" table="PROPERTY" prefix="DISTINCT">
		<parameter name="suburb" label="Suburb" column="PRSUB_NAME"/>
		<parameter name="roadname" label="Road Name" column="PRROD_NAME"/>
	</datasourcedataconnection>
</data:datadefinition>

Code Block

	xml
	xml
title	Another data definition for supplying a list of values, probably for a triple field cascading input parameter for a search

...

Code Block

xml	xml
linenumbers	true

<data:datadefinition id="suburbRoadType">
	<datasourcedataconnection datasource="datasource.main" table="PROPERTY" prefix="DISTINCT">
		<parameter name="suburb" label="Suburb" column="PRSUB_NAME"/>
		<parameter name="roadname" label="Road Name" column="PRROD_NAME"/>
		<parameter name="roadtype" label="Road Type" column="PRROD_TYPE"/>
	</datasourcedataconnection>
</data:datadefinition>

...

Versions Compared

Old Version 3

New Version 4

Key

parameter

Sub-tags

Content

Examples

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

parameter

Sub-tags

Content

Examples