Data Dictionary: Difference between revisions

From IMSMA Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Under construction | The Data Dictionary is quite an ambitious task and it will take time until more than 1000 fields and 200 tables will be documented}}
{{Warning | Depending on if a database is originally created with 5.x or 6.0 there are differences in Foreign keys' '''CASCADE on delete'''.}}
{{Note | The length of the fields may vary between databases that are migrated from [[Table differences between migrated and non-migrated databases | Legacy databases and databases]] that were created with {{IMSMANG}} of version 5 or newer.}}
{{Note | [''italic''] will highlight something technical such as {{IMSMANG}} database table name.}}
The Data Dictionary has two different user groups:
* non-technical users
* administrators.


The Data Dictionary has two user groups:
There are fields that are shown in the DIM that are of the type calculated fields and they are therefore not included in the Data Dictionary.
* non-technical users
Examples are:  
* administrators
* Calculated area,
and has the ambition to cover both user groups' needs.
* Last updated date and
* Linked IDs.
 
The structure is following the layout of the Data Inventory Manager. The {{IMSMANG}} version 6.0 database contains '''205''' tables but not all of them are described here. Contact your  [[Information Management Team | GICHD IM advisor]] if you have questions about tables.


The {{IMSMANG}} database consists of three main groups of tables:
The maXML schema is described [[XML Documentation | here]].
* Items
** Approved information a.k.a. Item / Summary / CV tables
** Data Entry Forms a.k.a. infoversion tables
** Tables that belongs to both groups
* Task and Auxiliary Data
* Miscellaneous tables
** Data Inventory Manager and templates tables
** Migration tables
** System tables


{{Note | [''italic''] will highlight something technical such as {{IMSMANG}} database table name.}}
The data type used are
* Country structure
* Date
* Integer
* Multi-select (are stored in a separate table ''xx_has_imsmaenum''. and use the look-up table ''imsmaenum'')
* Numeric (may have decimals)
* Organisation
* Place
* Single-select (use the look-up table ''imsmaenum'')
* String (have maximum length)
* Text (no maximum length)
{{NavBox Data Dictionary}}
{{NavBox Data Dictionary}}
[[Category:NAA]]
[[Category:NAA]]

Latest revision as of 12:49, 16 April 2018

Depending on if a database is originally created with 5.x or 6.0 there are differences in Foreign keys' CASCADE on delete.
The length of the fields may vary between databases that are migrated from Legacy databases and databases that were created with IMSMANG of version 5 or newer.
[italic] will highlight something technical such as IMSMANG database table name.

The Data Dictionary has two different user groups:

  • non-technical users
  • administrators.

There are fields that are shown in the DIM that are of the type calculated fields and they are therefore not included in the Data Dictionary. Examples are:

  • Calculated area,
  • Last updated date and
  • Linked IDs.

The structure is following the layout of the Data Inventory Manager. The IMSMANG version 6.0 database contains 205 tables but not all of them are described here. Contact your GICHD IM advisor if you have questions about tables.

The maXML schema is described here.

{{#switch:|subgroup|child=|none=|#default=

}}{{#if:|<td class="navbox-image " style="width:0%;padding:0px 2px 0px 0px;" rowspan={{#expr:1{{#if: Overview DEF

Data Entry Form  · Attachments|+2}}{{#if:Point Types

Geospatial  · Geopoint|+2}}{{#if:Task  · Work item  · Task Child Tables|+2}}{{#if:Assistance Classification  · Cause Classification  · Country Structure  · Needs Classification  · Ordnance Classification  · Organisation  · Places|+2}}{{#if:Enumeration categories  · Other tables  · Table differences between migrated and non-migrated databases|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}}}>
{{{imageleft}}}
}}{{#if:Item Data|<td style="text-align:left;border-left-width:2px;border-left-style:solid;|{{#if:|<td class="navbox-image " style="width:0%;padding:0px 0px 0px 2px;" rowspan={{#expr:1{{#if: Overview DEF

Data Entry Form  · Attachments|+2}}{{#if:Point Types

Geospatial  · Geopoint|+2}}{{#if:Task  · Work item  · Task Child Tables|+2}}{{#if:Assistance Classification  · Cause Classification  · Country Structure  · Needs Classification  · Ordnance Classification  · Organisation  · Places|+2}}{{#if:Enumeration categories  · Other tables  · Table differences between migrated and non-migrated databases|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}{{#if:|+2}}}}>
{{{image}}}
}}}}{{#if: Overview DEF
Data Entry Form  · Attachments|{{#if:Data Dictionary{{#switch:{{#if:|{{{border}}}|child}}|subgroup|child=|none=|#default=

}}{{#ifeq:|Template|{{#ifeq:{{#if:|{{{border}}}|child}}|child||{{#ifeq:{{#if:|{{{border}}}|child}}|subgroup||{{#switch:data dictionary

|doc
|sandbox
|testcases =
|#default = {{#switch:
 |plainlist
 |hlist
 |hlist hnum
 |hlist vcard
 |vcard hlist = 
 |#default = 
 }}
}}

}}}}}}|}}{{#if: DEFs| DEFs<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

Overview DEF

Data Entry Form  · Attachments

}}{{#if:Point Types
Geospatial  · Geopoint|{{#if:Data Dictionary{{#switch:{{#if:|{{{border}}}|child}}|subgroup|child=|none=|#default=

}}{{#ifeq:|Template|{{#ifeq:{{#if:|{{{border}}}|child}}|child||{{#ifeq:{{#if:|{{{border}}}|child}}|subgroup||{{#switch:data dictionary

|doc
|sandbox
|testcases =
|#default = {{#switch:
 |plainlist
 |hlist
 |hlist hnum
 |hlist vcard
 |vcard hlist = 
 |#default = 
 }}
}}

}}}}}} Overview DEF

Data Entry Form  · Attachments|}}{{#if: Geo data| Geo data<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

Point Types

Geospatial  · Geopoint

}}{{#if:Task  · Work item  · Task Child Tables|{{#if: Task | Task <td style="text-align:left;border-left-width:2px;border-left-style:solid;|

Task  · Work item  · Task Child Tables

}}{{#if:Assistance Classification  · Cause Classification  · Country Structure  · Needs Classification  · Ordnance Classification  · Organisation  · Places|{{#if:Auxiliary Data|Auxiliary Data<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

Assistance Classification  · Cause Classification  · Country Structure  · Needs Classification  · Ordnance Classification  · Organisation  · Places

}}{{#if:Enumeration categories  · Other tables  · Table differences between migrated and non-migrated databases|{{#if:Other|Other<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

Enumeration categories  · Other tables  · Table differences between migrated and non-migrated databases

}}{{#if:|{{#if:|{{{group7}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list7}}}

}}{{#if:|{{#if:|{{{group8}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list8}}}

}}{{#if:|{{#if:|{{{group9}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list9}}}

}}{{#if:|{{#if:|{{{group10}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list10}}}

}}{{#if:|{{#if:|{{{group11}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list11}}}

}}{{#if:|{{#if:|{{{group12}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list12}}}

}}{{#if:|{{#if:|{{{group13}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list13}}}

}}{{#if:|{{#if:|{{{group14}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list14}}}

}}{{#if:|{{#if:|{{{group15}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list15}}}

}}{{#if:|{{#if:|{{{group16}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list16}}}

}}{{#if:|{{#if:|{{{group17}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list17}}}

}}{{#if:|{{#if:|{{{group18}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list18}}}

}}{{#if:|{{#if:|{{{group19}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list19}}}

}}{{#if:|{{#if:|{{{group20}}}<td style="text-align:left;border-left-width:2px;border-left-style:solid;|

{{{list20}}}

}}{{#if:|{{#if:Data Dictionary{{#switch:{{#if:|{{{border}}}|child}}|subgroup|child=|none=|#default=

}}{{#ifeq:|Template|{{#ifeq:{{#if:|{{{border}}}|child}}|child||{{#ifeq:{{#if:|{{{border}}}|child}}|subgroup||{{#switch:data dictionary

|doc
|sandbox
|testcases =
|#default = {{#switch:
 |plainlist
 |hlist
 |hlist hnum
 |hlist vcard
 |vcard hlist = 
 |#default = 
 }}
}}

}}}}}} Overview DEF
Data Entry Form  · AttachmentsPoint Types

Geospatial  · Geopoint|}}

{{{below}}}

}}{{#switch:|subgroup|child=

|none=|#default=}}{{#ifeq:|Template|{{#ifeq:|child||{{#ifeq:|subgroup||{{#switch:data dictionary
|doc
|sandbox
|testcases =
|#default = {{#switch:hlist
 |plainlist
 |hlist
 |hlist hnum
 |hlist vcard
 |vcard hlist = 
 |#default = 
 }}
}}

}}}}}}