Metadata
From CaisisWiki
(Created page with '= Background = Metadata is a general term used to describe application specific information, which are related to tables, fields and interface, but do not disrupt the integrity o…') |
(→Table Metadata) |
||
| Line 4: | Line 4: | ||
== Table Metadata == | == Table Metadata == | ||
Table level metadata is information related to database tables which represents application specific attributes describing the table. These mappings are superficial and do not modify the database structure, keys, relationships, etc... Such examples include Table Label, Table Description, Relevant Diseases, etc... which are used to describe a table's role in the application. | Table level metadata is information related to database tables which represents application specific attributes describing the table. These mappings are superficial and do not modify the database structure, keys, relationships, etc... Such examples include Table Label, Table Description, Relevant Diseases, etc... which are used to describe a table's role in the application. | ||
| + | === Table Attributes === | ||
| + | |||
| + | ====Table Label==== | ||
| + | The friendly table label (default: actual TableName), i.e., EncExams = Physical Exams | ||
| + | |||
| + | ====Table Description==== | ||
| + | The friendly table description (default: empty string). | ||
| + | |||
| + | ====Form==== | ||
| + | True or False (default) indicating whether a table is a data entry form. | ||
| + | |||
| + | ====NumDisplayColumns==== | ||
| + | The number (default: 2) of columns in which to display the data entry form. | ||
| + | |||
| + | ====LoadByDefault==== | ||
| + | True or False (default) indicating whether the form is loaded as the default form in the Data Entry section. | ||
| + | |||
| + | ====DisplayWithParent==== | ||
| + | True or False (default) whether a form is displayed with it's parent table. i.e., Physical Exams displays with parent Encounter. | ||
| + | |||
| + | ====DisplayWithChild==== | ||
| + | A list (comma separated) of child tables names to display with form. i.e., Encounter displays with Physical Exams and Review Of Systems. | ||
| + | |||
| + | ====GridView==== | ||
| + | True of False (default) indicating if a form is displayed as tabular data (grid). | ||
| + | |||
| + | ====TotalBlankGridRows==== | ||
| + | If GridView=true, controls the number of blank rows to allocate for the form. | ||
| + | |||
| + | ====TotalVisibleBlankGridRows==== | ||
| + | If GridView=true, controls the number of blank rows initially visible. | ||
| + | |||
| + | ====FileName==== | ||
| + | The static file name (optional) of the custom data entry form (.ascx). | ||
| + | |||
| + | ====MostRelevantTables==== | ||
| + | A list (comma separated) of sibling tables. | ||
| + | |||
| + | ====DisplayInMainMenu==== | ||
| + | True (default) or False indicating whether a table's menu will display in the Data Entry Menus. | ||
| + | |||
| + | ====ChronListOption==== | ||
| + | The name of the chron list stored proc item. | ||
| + | |||
| + | ====ChronListText==== | ||
| + | The displayable text column of the chron list stored proc item. | ||
| + | |||
| + | ====AllowAbsentEvent==== | ||
| + | True or False (default) indicating whether the Table allows Absent Events. | ||
| + | |||
| + | ====ProtocolMgmtTopLevelTable==== | ||
| + | True or False (default) indicating whether the table will be used in the Protocol Manager. | ||
| + | |||
| + | ====UseInWorkflows==== | ||
| + | True or False (default) indicating whether the table will be used in the Workflow Builder. | ||
| + | |||
| + | ====Menu==== | ||
| + | The name of the top level menu where to place the form. i.e., Diagnostics > Lab Tests | ||
| + | |||
| + | ====MenuOrder==== | ||
== Field Metadata == | == Field Metadata == | ||
Revision as of 19:39, 30 September 2011
Background
Metadata is a general term used to describe application specific information, which are related to tables, fields and interface, but do not disrupt the integrity of the database structure.
Table Metadata
Table level metadata is information related to database tables which represents application specific attributes describing the table. These mappings are superficial and do not modify the database structure, keys, relationships, etc... Such examples include Table Label, Table Description, Relevant Diseases, etc... which are used to describe a table's role in the application.
Table Attributes
Table Label
The friendly table label (default: actual TableName), i.e., EncExams = Physical Exams
Table Description
The friendly table description (default: empty string).
Form
True or False (default) indicating whether a table is a data entry form.
NumDisplayColumns
The number (default: 2) of columns in which to display the data entry form.
LoadByDefault
True or False (default) indicating whether the form is loaded as the default form in the Data Entry section.
DisplayWithParent
True or False (default) whether a form is displayed with it's parent table. i.e., Physical Exams displays with parent Encounter.
DisplayWithChild
A list (comma separated) of child tables names to display with form. i.e., Encounter displays with Physical Exams and Review Of Systems.
GridView
True of False (default) indicating if a form is displayed as tabular data (grid).
TotalBlankGridRows
If GridView=true, controls the number of blank rows to allocate for the form.
TotalVisibleBlankGridRows
If GridView=true, controls the number of blank rows initially visible.
FileName
The static file name (optional) of the custom data entry form (.ascx).
MostRelevantTables
A list (comma separated) of sibling tables.
DisplayInMainMenu
True (default) or False indicating whether a table's menu will display in the Data Entry Menus.
ChronListOption
The name of the chron list stored proc item.
ChronListText
The displayable text column of the chron list stored proc item.
AllowAbsentEvent
True or False (default) indicating whether the Table allows Absent Events.
ProtocolMgmtTopLevelTable
True or False (default) indicating whether the table will be used in the Protocol Manager.
UseInWorkflows
True or False (default) indicating whether the table will be used in the Workflow Builder.
Menu
The name of the top level menu where to place the form. i.e., Diagnostics > Lab Tests
MenuOrder
Field Metadata
Similar to table metadata, field level metadata is information related to database fields, not the database structure or integrity. These mappings allow the application to have specific attributes related to a field, such as Field Label, Lookup Code, Control Type, etc...
Lookup Codes
Lookup Codes are vocabulary items which are used through the system to provide reuse and uniformity across the application. They are used for restricting data entry values for a consistent range of values. These are often there to aid in data entry, but often do not restrict values outside the range.
