Meta Data

From CaisisWiki

(Difference between revisions)
Jump to: navigation, search
(Meta Data Configuration)
 
(8 intermediate revisions not shown)
Line 1: Line 1:
-
One of the most powerful feature in Caisis 4.0 is the addition of Dynamic Forms and Meta Data. With the addition of these features, the admin has complete control over the look and feel of their data entry forms, as well as focus on their disease specific areas.
+
Translations: [[Meta_Data_it|italiano]]
-
== Meta Data ==
+
One of the most powerful feature in Caisis 4.0 is the addition of Dynamic Forms and Meta Data. With the addition of these features, the admin has complete control over the look and feel of their data entry forms dynamically, but retains complete controls with Static Forms.
-
Meta Data is information about database fields which describe the type of data these fields can hold, as well as the way the user sees these fields (HTML controls). Each table in the database has an associated Meta Data table.
+
-
With this powerful feature, you can easily change a field to be displayed as an html textbox, textarea, select, etc..., without modifying any .NET code or HTML.
+
-
=== Meta Table ===
+
== Meta Data Background ==
 +
By default, all Data Entry Forms are created dynamically from Meta Data. Meta Data is information about database fields which describe the type of data these fields can hold, as well as the way the user sees these fields (HTML controls). Each table in the database has an associated Meta Table.
 +
With this powerful feature, you can easily change a field to be displayed as an html textbox, textarea, select, etc..., without modifying any .NET code or HTML. In addition to setting control types, you can easily suppress fields from the interface, or add special features, such as a number pad or calendar date picker.
 +
Though forms are created dynamically, you will be able to override this feature for a table by creating a Static Form.
-
<table border="1">
+
==Meta Data Configuration==
 +
To configure Meta Data for your Caisis installation, there are three levels of configuration detailed in the tables below.
 +
 
 +
The user interface to update this information can be found within your '''Caisis Administration Tool'''. From the icons on the left select "'''System Config'''" and then "M'''anage Meta Data'''". Please note, currently this interface is only compatible with Internet Explorer.
 +
 
 +
 
 +
===Table Level Configuration===
 +
The first is Table Level Configuration, where you are able to specify friendly table descriptions.
 +
 
 +
<table width="100%" border="1" cellpadding="1" cellspacing="0">
 +
<th>Table Name</th>
 +
<th>Table Label</th>
 +
<th>Table Description</th>
 +
<tr>
 +
<td>The name of the Table (as defined in database).</td>
 +
<td>Friendly label for database table.</td>
 +
<td>A description of the table.</td>
 +
</tr>
 +
</table>
 +
 
 +
===Field Level Configuration===
 +
The second level of configuration is where you specify which fields are displayed on the interfaces. If fields are not specified, a default CaisiTextBox will be used to represent a field. You will also be able to configure what order controls are rendered on Data Entry Forms.
 +
 
 +
<table border="1" cellpadding="1" cellspacing="0">
<th>FieldName</th>
<th>FieldName</th>
<th>DataType</th>
<th>DataType</th>
Line 19: Line 43:
<td>Data Type of the field in the database.</td>
<td>Data Type of the field in the database.</td>
<td>Testing</td>
<td>Testing</td>
-
<td>Supress Fields from being displayed in the data entry form.</td>
+
<td>Supress Fields from the interface.</td>
<td>The display order of the control in the data entry form.</td>
<td>The display order of the control in the data entry form.</td>
<td>Edit this field.</td>
<td>Edit this field.</td>
Line 25: Line 49:
</tr>
</tr>
</table>
</table>
-
==== Meta Table Fields ====
+
 
-
Each Meta Table has
+
 
 +
===Individual Field Level Configuration===
 +
The third level of configuration is Field Level Configuration. This allows you to much more granular configuration of your application. At the Field Level, you can control what [[Caisis Input Controls]] represent your table fields on Data Entry Forms. In addition to specifying control types, you can set properties such as ShowCalendar,ShowNumberPad,etc... as well as setting field widths to control how wide your fields will be rendered.
 +
 
 +
<table width="100%" border="1" cellpadding="1" cellspacing="0">
 +
<th>Attribute Name</th>
 +
<th>Description</th>
 +
<th>Examples</th>
 +
<th>Notes</th>
 +
<tr>
 +
<td>ControlType</td>
 +
<td>One of the various [[Caisis Input Controls]].</td>
 +
<td>EncName shows as CaisisTextBox, which shows field as a text box.</td>
 +
<td></td>
 +
</tr>
 +
<tr>
 +
<td>FieldLabel</td>
 +
<td>A friendly name for a field to display on various Data Entry interfaces.</td>
 +
<td>EncExams could have the display name "Physical Exams".</td>
 +
<td></td>
 +
</tr>
 +
<tr>
 +
<td>FieldDescription</td>
 +
<td>A helpful description of the field. Shown as a help bubble.</td>
 +
<td>EncNotes, "Notes for describing the examination."</td>
 +
<td></td>
 +
</tr>
 +
<tr>
 +
<td>FieldWidth</td>
 +
<td>Controls how wide a control is displayed on the Data Entry interfaces.</td>
 +
<td>A Value "200" will render the control 200 pixels wide.</td>
 +
<td>Needs to be a number.</td>
 +
</tr>
 +
<tr>
 +
<td>ShowCalendar</td>
 +
<td>Shows a calendar control next to a control.</td>
 +
<td>Shows a calendar to choose date to place into a textbox.</td>
 +
<td>True or False value.</td>
 +
</tr>
 +
<tr>
 +
<td>ShowNumberPad</td>
 +
<td>Shows a number pad picker next to a control.</td>
 +
<td>Set to true will show a number pad.</td>
 +
<td>True or False value.</td>
 +
</tr>
 +
<tr>
 +
<td>Required</td>
 +
<td>Controls if a field needs to have a value before saving a form.</td>
 +
<td>EncDate set to Required="true" will trigger validation and forms can't be saved without a value.</td>
 +
<td>True or False value.</td>
 +
</tr>
 +
<tr>
 +
<td>LookupCodvaluee</td>
 +
<td>Renders a control with possible values described by a [[Lookup Codes|Lookup Code]].</td>
 +
<td>EncDataQuality will have a LookupCode value of "DataQuality".</td>
 +
<td>Has to be a CaisisSelect or CaisisComboBox.</td>
 +
</tr>
 +
</table>

Current revision as of 17:37, 17 March 2009

Translations: italiano

One of the most powerful feature in Caisis 4.0 is the addition of Dynamic Forms and Meta Data. With the addition of these features, the admin has complete control over the look and feel of their data entry forms dynamically, but retains complete controls with Static Forms.

Contents

Meta Data Background

By default, all Data Entry Forms are created dynamically from Meta Data. Meta Data is information about database fields which describe the type of data these fields can hold, as well as the way the user sees these fields (HTML controls). Each table in the database has an associated Meta Table. With this powerful feature, you can easily change a field to be displayed as an html textbox, textarea, select, etc..., without modifying any .NET code or HTML. In addition to setting control types, you can easily suppress fields from the interface, or add special features, such as a number pad or calendar date picker. Though forms are created dynamically, you will be able to override this feature for a table by creating a Static Form.

Meta Data Configuration

To configure Meta Data for your Caisis installation, there are three levels of configuration detailed in the tables below.

The user interface to update this information can be found within your Caisis Administration Tool. From the icons on the left select "System Config" and then "Manage Meta Data". Please note, currently this interface is only compatible with Internet Explorer.


Table Level Configuration

The first is Table Level Configuration, where you are able to specify friendly table descriptions.

Table Name Table Label Table Description
The name of the Table (as defined in database). Friendly label for database table. A description of the table.

Field Level Configuration

The second level of configuration is where you specify which fields are displayed on the interfaces. If fields are not specified, a default CaisiTextBox will be used to represent a field. You will also be able to configure what order controls are rendered on Data Entry Forms.

FieldName DataType IsVirtual Suppress Order Edit Delete
Name of the database field. Data Type of the field in the database. Testing Supress Fields from the interface. The display order of the control in the data entry form. Edit this field. Delete this Meta Table Field


Individual Field Level Configuration

The third level of configuration is Field Level Configuration. This allows you to much more granular configuration of your application. At the Field Level, you can control what Caisis Input Controls represent your table fields on Data Entry Forms. In addition to specifying control types, you can set properties such as ShowCalendar,ShowNumberPad,etc... as well as setting field widths to control how wide your fields will be rendered.

Attribute Name Description Examples Notes
ControlType One of the various Caisis Input Controls. EncName shows as CaisisTextBox, which shows field as a text box.
FieldLabel A friendly name for a field to display on various Data Entry interfaces. EncExams could have the display name "Physical Exams".
FieldDescription A helpful description of the field. Shown as a help bubble. EncNotes, "Notes for describing the examination."
FieldWidth Controls how wide a control is displayed on the Data Entry interfaces. A Value "200" will render the control 200 pixels wide. Needs to be a number.
ShowCalendar Shows a calendar control next to a control. Shows a calendar to choose date to place into a textbox. True or False value.
ShowNumberPad Shows a number pad picker next to a control. Set to true will show a number pad. True or False value.
Required Controls if a field needs to have a value before saving a form. EncDate set to Required="true" will trigger validation and forms can't be saved without a value. True or False value.
LookupCodvaluee Renders a control with possible values described by a Lookup Code. EncDataQuality will have a LookupCode value of "DataQuality". Has to be a CaisisSelect or CaisisComboBox.
Personal tools