Add Custom Defined Fields - Revision history

Alnaucler at 16:08, 15 June 2017

2017-06-15T16:08:47Z

← Older revision		Revision as of 18:08, 15 June 2017
Line 3:		Line 3:
	[[Image:DIM category.png\|600px\|center]]		[[Image:DIM category.png\|600px\|center]]
	<ol>		<ol>
	<li>~~From~~ the '''Customisation''' menu~~, select~~ '''Data Inventory Manager'''.</li>		<li>In the '''Customisation''' menu → '''Data Inventory Manager'''.</li>
	<li>'''[[Filter Item Attributes \| Search]]''' the Data Inventory Manager before you add a CDF in order to make sure that a suitable system field does not already exist.</li>		<li>'''[[Filter Item Attributes \| Search]]''' the Data Inventory Manager before you add a CDF in order to make sure that a suitable system field does not already exist.</li>
	<li>In the left pane of the Data Inventory Manager window, select the item and the data category to which you would like to add a CDF.</li>		<li>In the left pane of the Data Inventory Manager window, select the item and the data category to which you would like to add a CDF.</li>

Alnaucler at 21:43, 12 June 2017

2017-06-12T21:43:30Z

← Older revision		Revision as of 23:43, 12 June 2017
Line 4:		Line 4:
	<ol>		<ol>
	<li>From the '''Customisation''' menu, select '''Data Inventory Manager'''.</li>		<li>From the '''Customisation''' menu, select '''Data Inventory Manager'''.</li>
			<li>'''[[Filter Item Attributes \| Search]]''' the Data Inventory Manager before you add a CDF in order to make sure that a suitable system field does not already exist.</li>
	<li>In the left pane of the Data Inventory Manager window, select the item and the data category to which you would like to add a CDF.</li>		<li>In the left pane of the Data Inventory Manager window, select the item and the data category to which you would like to add a CDF.</li>
	<li>In the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li>		<li>In the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li>

Alnaucler at 21:15, 12 June 2017

2017-06-12T21:15:47Z

← Older revision		Revision as of 23:15, 12 June 2017
Line 77:		Line 77:
	When you have completed entering the values for the list, click the '''Done''' button.		When you have completed entering the values for the list, click the '''Done''' button.

	{{Note\|You can also translate the label and, if applicable, list option values by clicking the '''Translate''' button at this time. See [[Translate Custom Defined ~~Field Labels~~]] for more information. }}		{{Note\|You can also translate the label and, if applicable, list option values by clicking the '''Translate''' button at this time. See [[Translate Custom Defined Fields]] for more information. }}

	{{NavBox HowTo Data Elements}}		{{NavBox HowTo Data Elements}}
	[[Category:NAA]]		[[Category:NAA]]

Alnaucler at 20:43, 12 June 2017

2017-06-12T20:43:56Z

← Older revision		Revision as of 22:43, 12 June 2017
Line 54:		Line 54:
	\|}		\|}
	</li>		</li>
			{{note\| When creating single-select enumeration lists, information managers should include a “Not specified” value, which users can select when no value was provided in the data collection. This value facilitate creating statistics and data quality work.
			Data type cannot be changed after creation of the CDF.}}

	<li>Enter a description for the custom defined field in the '''Description''' field.</li>		<li>Enter a description for the custom defined field in the '''Description''' field.</li>
	<li>Go through the checklist for implementation of '''[[Custom Defined Fields]]'''.</li>		<li>Go through the checklist for implementation of '''[[Custom Defined Fields]]'''.</li>

Alnaucler at 20:37, 12 June 2017

2017-06-12T20:37:06Z

← Older revision		Revision as of 22:37, 12 June 2017
Line 20:		Line 20:
	::* cannot start with a digit.</li>		::* cannot start with a digit.</li>
	<li>Enter a label in the Label field. The label is the default custom defined field’s name that the user will see in the Data Entry Form Manager window. </li>		<li>Enter a label in the Label field. The label is the default custom defined field’s name that the user will see in the Data Entry Form Manager window. </li>
	<li>Select the data type for the custom defined field from the '''Data Type''' list.		<li>Select the data type for the custom defined field from the '''Data Type''' list. The general recommendation is to avoid text fields if the CDF will be used for search/filter, statistics, maps and/or data quality. Users will enter data differently in text fields e.g. many different spellings of an organisation name so it is preferable to use data entry widgets where the user selects over text widget.

	{\| class="wikitable"		{\| class="wikitable"
Line 32:		Line 32:
	\|-		\|-
	\| Date		\| Date
	\| ~~Month, day, year~~		\| timestamp (2016-12-01 15:33:59.187)
	\|-		\|-
	\| Number		\| Number
	\| ~~≤15 decimal points~~		\| with 6 decimals
	\|-		\|-
	\| Organisation		\| Organisation
	\| Allows the user to select ~~organisational data~~		\| Allows the user to select an Organisation
	\|-		\|-
	\| Place		\| Place
	\| Allows the user to select ~~place data~~		\| Allows the user to select a Place
	\|-		\|-
	\| Country Structure		\| Country Structure
	\| Allows the user to select ~~country~~ structure ~~level data~~		\| Allows the user to select from the Country structure
	\|-		\|-
	\| Multiple Select		\| Multiple Select

Alnaucler at 20:25, 12 June 2017

2017-06-12T20:25:26Z

← Older revision		Revision as of 22:25, 12 June 2017
Line 55:		Line 55:
	</li>		</li>
	<li>Enter a description for the custom defined field in the '''Description''' field.</li>		<li>Enter a description for the custom defined field in the '''Description''' field.</li>
			<li>Go through the checklist for implementation of '''[[Custom Defined Fields]]'''.</li>
	</ol>		</ol>
	=== Display options for single-select and text CDFs===__NOEDITSECTION__		=== Display options for single-select and text CDFs===__NOEDITSECTION__
Line 65:		Line 66:

	=== Adding values for multi- and single-select CDFs===__NOEDITSECTION__		=== Adding values for multi- and single-select CDFs===__NOEDITSECTION__
	~~<li>~~If you selected the ''Multiple Select'' or ''Single Select'' option, click the [[Image:FieldTemplateIcon.png]] button.~~</li>~~		If you selected the ''Multiple Select'' or ''Single Select'' option, click the [[Image:FieldTemplateIcon.png]] button.
	[[Image:CDF value.png\|center\|300px\|''Add multi- and single-select value window'']]		[[Image:CDF value.png\|center\|300px\|''Add multi- and single-select value window'']]
	<div align="center">		<div align="center">
	''Add multi- and single-select value window''		''Add multi- and single-select value window''
	</div>		</div>
	~~<li>~~Enter the value for the list in the '''Value''' field.~~</li>~~		Enter the value for the list in the '''Value''' field.
	~~<li>~~When you have completed entering the values for the list, click the '''Done''' button.~~</li>~~		When you have completed entering the values for the list, click the '''Done''' button.

	{{Note\|You can also translate the label and, if applicable, list option values by clicking the '''Translate''' button at this time. See [[Translate Custom Defined Field Labels]] for more information. }}		{{Note\|You can also translate the label and, if applicable, list option values by clicking the '''Translate''' button at this time. See [[Translate Custom Defined Field Labels]] for more information. }}

Alnaucler at 21:43, 11 June 2017

2017-06-11T21:43:25Z

← Older revision		Revision as of 23:43, 11 June 2017
Line 1:		Line 1:
	{{New_6.0\|Custom defined fields must have a unique combination of item, '''name''' and data type. }}		{{New_6.0\|Custom defined fields must have a unique combination of item, '''name''' and data type. }}

	~~To add a custom defined field~~:		[[Image:DIM category.png\|600px\|center]]
	<ol>		<ol>
	<li>From the '''Customisation''' menu, select '''Data Inventory Manager'''.</li>		<li>From the '''Customisation''' menu, select '''Data Inventory Manager'''.</li>
	~~:The Data Inventory Manager window displays.~~
	<li>~~From~~ the left pane of the Data Inventory Manager window, select the item and the data category to which you would like to add a CDF.</li>		<li>In the left pane of the Data Inventory Manager window, select the item and the data category to which you would like to add a CDF.</li>
	<li>~~From~~ the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li>		<li>In the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li>
	~~:The CDF Editor window displays.~~

	[[Image:CDFEditor.png\|center\|500px\|''CDF Editor Window'']]		[[Image:CDFEditor.png\|center\|500px\|''CDF Editor Window'']]
Line 55:		Line 54:
	\|}		\|}
	</li>		</li>
	<li>Enter a description for the custom defined field in the '''Description''' field.		<li>Enter a description for the custom defined field in the '''Description''' field.</li>
	[[Image:CDF display format.png\|center\|500px\|''~~Disply~~ formats'']]		</ol>
			=== Display options for single-select and text CDFs===__NOEDITSECTION__
			[[Image:CDF display format.png\|center\|500px\|''Display formats'']]
	<div align="center">		<div align="center">
	''Display formats''		''Display formats''
	</div~~></li~~>		</div>
	~~<li>~~For Text and Single Select CDFs, there are two different display formats to choose between.		For Text and Single Select CDFs, there are two different display formats to choose between.
	{{New_6.0 \| In version 6.0 two different display formats for Text fields has been introduced.}}~~</li>~~		{{New_6.0 \| In version 6.0 two different display formats for Text fields has been introduced.}}
	~~<li>If you selected the ''Multiple Select'' or ''Single Select'' option, click the [[Image:FieldTemplateIcon.png]] button.~~
	~~:The Add window displays.</li>~~
	~~<li>Enter the value for the list in the '''Value''' field.~~

	~~{{note\|When entering~~ values for ~~lists, be sure to:~~		=== Adding values for multi- and single-select CDFs===__NOEDITSECTION__
	*Enter values in the order that you would like them to display to the user		<li>If you selected the ''Multiple Select'' or ''Single Select'' option, click the [[Image:FieldTemplateIcon.png]] button.</li>
	*Enter values in the language in which the users will use IMSMA		[[Image:CDF value.png\|center\|300px\|''Add multi- and single-select value window'']]
	}}</li>		<div align="center">
	~~<li>Do one of the following:~~		''Add multi- and single-select value window''
	*If you ~~would like to save the value and enter additional values, click~~ the '''~~Save~~''' ~~button.~~		</div>
	*If you have completed entering the values for the list, click the ~~'''Done'''~~ button.</li>		<li>Enter the value for the list in the '''Value''' field.</li>
	<li>~~If you selected the~~ ''~~Single Select~~'' ~~option, chose an option from the Selection Display field to display the CDF as either a list of radio buttons or as a combo box.~~		<li>When you have completed entering the values for the list, click the '''Done''' button.</li>

	~~{{note\|You can also translate~~ the ~~label and, if applicable,~~ list ~~option values by clicking~~ the '''~~Translate~~''' ~~button at this time~~. ~~See [[Translate Custom Defined Field Labels]] for more information.~~
	}}</li>
	<li>~~Do one of~~ the ~~following:~~
	*To save the ~~custom defined field and close the CDF Editor window~~, click the '''~~Save~~''' button.
	~~:If the custom defined field information is successfully saved, the CDF Editor window closes and the custom defined field is listed in the Data Inventory Manager window.~~

	{{~~note~~\|~~If you would like to add~~ the ~~custom defined field to existing data entry form templates~~, ~~you will need to update and republish the data entry form template.~~		{{Note\|You can also translate the label and, if applicable, list option values by clicking the '''Translate''' button at this time. See [[Translate Custom Defined Field Labels]] for more information. }}
	}}
	*To discard the custom defined field and close the CDF Editor window, ~~click~~ the '''~~Cancel~~''' button.
	~~</li></ol>~~

	{{NavBox HowTo Data Elements}}		{{NavBox HowTo Data Elements}}
			[[Category:NAA]]

Dionysia at 21:46, 27 January 2016

2016-01-27T21:46:19Z

← Older revision		Revision as of 23:46, 27 January 2016
Line 1:		Line 1:
	{{New_6.0\|Custom defined fields must have a unique combination of item, '''name''' and data type.		{{New_6.0\|Custom defined fields must have a unique combination of item, '''name''' and data type. }}
	}}

	To add a custom defined field:		To add a custom defined field:
Line 9:		Line 8:
	<li>From the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li>		<li>From the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li>
	:The CDF Editor window displays.		:The CDF Editor window displays.
	~~</ol>~~

	[[Image:CDFEditor.png\|center\|500px\|''CDF Editor Window'']]		[[Image:CDFEditor.png\|center\|500px\|''CDF Editor Window'']]
	<div align="center">		<div align="center">
	''CDF Editor Window''		''CDF Editor Window''
	</div>		</div></li>

	<~~ol start="4"~~>
	<li>Enter a name in the Name field. The name should be		<li>Enter a name in the Name field. The name should be
	# maximum 60 characters long		# maximum 60 characters long
Line 25:		Line 21:
	::* cannot start with a digit.</li>		::* cannot start with a digit.</li>
	<li>Enter a label in the Label field. The label is the default custom defined field’s name that the user will see in the Data Entry Form Manager window. </li>		<li>Enter a label in the Label field. The label is the default custom defined field’s name that the user will see in the Data Entry Form Manager window. </li>
	<li>Select the data type for the custom defined field from the '''Data Type''' list.~~</li>~~		<li>Select the data type for the custom defined field from the '''Data Type''' list.
	~~</ol>~~

	{\| class="wikitable"		{\| class="wikitable"
Line 59:		Line 54:
	\|-		\|-
	\|}		\|}
			</li>
	<~~ol start="7"~~>		<li>Enter a description for the custom defined field in the '''Description''' field.
	<li>Enter a description for the custom defined field in the '''Description''' field.~~</li><br/>~~
	[[Image:CDF display format.png\|center\|500px\|''Disply formats'']]		[[Image:CDF display format.png\|center\|500px\|''Disply formats'']]
	<div align="center">		<div align="center">
	''Display formats''		''Display formats''
	</div>		</div></li>
			<li>For Text and Single Select CDFs, there are two different display formats to choose between.
	<li>For Text and Single Select CDFs, there are two different display formats to choose between.~~</li>~~		{{New_6.0 \| In version 6.0 two different display formats for Text fields has been introduced.}}</li>
	{{New_6.0 \| In version 6.0 two different display formats for Text fields has been introduced.}}		<li>If you selected the ''Multiple Select'' or ''Single Select'' option, click the [[Image:FieldTemplateIcon.png]] button.
	<li>If you selected the ''Multiple Select'' or ''Single Select'' option, click the [[Image:FieldTemplateIcon.png]] button.~~</li>~~		:The Add window displays.</li>
	:The Add window displays.		<li>Enter the value for the list in the '''Value''' field.
	<li>Enter the value for the list in the '''Value''' field.~~</li>~~
	~~</ol>~~

	{{note\|When entering values for lists, be sure to:		{{note\|When entering values for lists, be sure to:
	*Enter values in the order that you would like them to display to the user		*Enter values in the order that you would like them to display to the user
	*Enter values in the language in which the users will use IMSMA		*Enter values in the language in which the users will use IMSMA
	}}		}}</li>
			<li>Do one of the following:
	<~~ol start="11"~~>
	<li>Do one of the following:~~</li>~~
	*If you would like to save the value and enter additional values, click the '''Save''' button.		*If you would like to save the value and enter additional values, click the '''Save''' button.
	*If you have completed entering the values for the list, click the '''Done''' button.		*If you have completed entering the values for the list, click the '''Done''' button.</li>
	<li>If you selected the ''Single Select'' option, chose an option from the Selection Display field to display the CDF as either a list of radio buttons or as a combo box.~~</li>~~		<li>If you selected the ''Single Select'' option, chose an option from the Selection Display field to display the CDF as either a list of radio buttons or as a combo box.
	~~</ol>~~

	{{note\|You can also translate the label and, if applicable, list option values by clicking the '''Translate''' button at this time. See [[Translate Custom Defined Field Labels]] for more information.		{{note\|You can also translate the label and, if applicable, list option values by clicking the '''Translate''' button at this time. See [[Translate Custom Defined Field Labels]] for more information.
	}}		}}</li>
			<li>Do one of the following:
	<~~ol start="13"~~>
	<li>Do one of the following:~~</li>~~
	*To save the custom defined field and close the CDF Editor window, click the '''Save''' button.		*To save the custom defined field and close the CDF Editor window, click the '''Save''' button.
	:If the custom defined field information is successfully saved, the CDF Editor window closes and the custom defined field is listed in the Data Inventory Manager window.		:If the custom defined field information is successfully saved, the CDF Editor window closes and the custom defined field is listed in the Data Inventory Manager window.
	~~</ol>~~

	{{note\|If you would like to add the custom defined field to existing data entry form templates, you will need to update and republish the data entry form template.		{{note\|If you would like to add the custom defined field to existing data entry form templates, you will need to update and republish the data entry form template.
	}}		}}

	~~<ol>~~
	*To discard the custom defined field and close the CDF Editor window, click the '''Cancel''' button.		*To discard the custom defined field and close the CDF Editor window, click the '''Cancel''' button.
	</ol>		</li></ol>

	{{NavBox HowTo Data Elements}}		{{NavBox HowTo Data Elements}}

Alnaucler at 16:06, 3 July 2015

2015-07-03T16:06:09Z

← Older revision		Revision as of 18:06, 3 July 2015
Line 17:		Line 17:

	<ol start="4">		<ol start="4">
	<li>Enter a name in the Name field. The name should be ~~no longer than~~ 60 characters and ~~should not~~ contain ~~periods (~~.), ~~underscores~~ (_)~~, or~~ capital ~~letters. In addition it~~ cannot start with a digit.</li>		<li>Enter a name in the Name field. The name should be
			# maximum 60 characters long
			# only allowed characters are a - z and 0 - 9 i.e. <br/>
			::* cannot contain . , / \ ( ) ! ? - @
			::* cannot contain space/blanks
			::* cannot contain capital/upper case character
			::* cannot start with a digit.</li>
	<li>Enter a label in the Label field. The label is the default custom defined field’s name that the user will see in the Data Entry Form Manager window. </li>		<li>Enter a label in the Label field. The label is the default custom defined field’s name that the user will see in the Data Entry Form Manager window. </li>
	<li>Select the data type for the custom defined field from the '''Data Type''' list.</li>		<li>Select the data type for the custom defined field from the '''Data Type''' list.</li>

Alnaucler at 19:14, 1 March 2015

2015-03-01T19:14:43Z

← Older revision		Revision as of 21:14, 1 March 2015
Line 1:		Line 1:
	{{New_6.0\|Custom defined fields must have a unique combination of item, '''name''', and data type.		{{New_6.0\|Custom defined fields must have a unique combination of item, '''name''' and data type.
	}}		}}