Changes

Custom Defined Fields

7,556 bytes removed, 21:14, 19 June 2017

no edit summary

{{TOC right}}

IMSMA {{IMSMANG}} allows you to create, change, and remove delete fields which are not predefined in IMSMA. These fields are referred to as custom defined fields Custom Defined Fields (CDFs). CDFs can be added to items and Auxiliary data but not to the Data Entry Form items (accident, land, activity, location, education, QM, and victim) and to country structure area, explosive ordnance, organisation, and placeitem.

CDFs added to accident, land, activity, location, education, QM, and victim can be added to Data Entry Form templates so that they become part of the paper-based Data Entry Form ([[:Image:uMFig142.png|Figure 142]]). [[Image:uMFig142.png|center|500px|''Figure 142. CDFs and Data Entry Form Items'']] After users add data to the Data Entry Form and the Data Entry Form is approved, the data entered into the custom defined field can be viewed in the Summary window ([[:Image:uMFig143.png|Figure 143]]).  [[Image:uMFig143.png|center|500px|''Figure 143. Custom Defined Field Viewable in Summary Window'']] You can enter data for CDFs that are added to place, explosive ordnance, organisation, or country structure area via their applicable Editor windows ([[:Image:uMFig144.png|Figure 144]]).  [[Image:uMFig144.png|center|500px|''Figure 144. CDFs in the Editor Window'']] ==Workflow=How to Add Custom Defined Fields==={| class="wikitable"|-| [[File:Note.jpg | 40px]] || Custom defined fields must have a unique combination of item, label, and data type. |} To add a custom defined field:__NOEDITSECTION__

<ol>

<li>From [[Add Custom Defined Fields| Add the CDFs]] in 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 data category to which you would like to add ol type=a CDF.</li><li>From the right pane of the Data Inventory Manager window, click establish that the [[Image:FieldTemplateIcon.png]] button.</li>The CDF Editor window displays ([[:Image:uMFig145.pngFilter Item Attributes|Figure 145]]).</ol> [[Image:uMFig145.png|center|500px|''Figure 145. CDF Editor Window''field does not already exists]] <ol start="4"><li>Enter a label in the Label field. The label is the default custom defined field’s name that the user how will see in the Data Entry Form Manager window. The label should data be no longer than 50 characters and should not contain periods (.) or underscores (_).</li>used?<li>Select the which data type for the custom defined field from the Data Type list.</li>?</ol> {| class="wikitable" width="600"|-| align="center" colspan="2" | '''Table 46. Data Types for Custom Defined Fields'''|-| width="225pt" | '''Data Type'''| width="375pt" | '''Description and Comments'''|-| Text Field || ≤250 characters|-| Date || Month, day, year|-| Number || ≤15 decimal points|-| List Multiple Selections || Allows the user to select zero or more values provided in the '''List Values''' field. |-| List One Selection || Allows the user to select one value from provided values in the '''List Values''' field.|} <ol start="6"><li>Enter a description for the custom defined field in the Description field.</li><li>If the CDF is active, check the Active checkbox.</li><li>If you selected the ''List Multiple Selection'' or ''List One Selection'' option, click the Add them to [[Image:FieldTemplateIcon.pngAccess the Data Entry Form Template Designer Window | Data Entry Form templates]] button.</li>:The Add window displays.<li>Enter the value for so users may add data into the list in the '''Value''' fieldCDFs.</li></ol>

{| class="wikitable"|-| [[FileImage:NoteuMFig142.jpg png| 40pxcenter|600px|''CDFs and Data Entry Form Items'']] || 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 language in which the users will use IMSMA|}</li>

<ol start="10"><li>Do one of Add the following:</li>*If you would like CDFs to save the value and enter additional values, click [[Summary Templates | Summary window templates]] so the '''Save''' button.*If you users may see the data they have completed entering the values for the list, click the '''Done''' button. <li>Enter a description for the custom defined field in the '''Description''' fieldentered.</li></ol>

{| class="wikitable"|-| [[FileImage:NoteuMFig143.jpg png| 40px]] center|500px| You can also translate the label and, if applicable, list option values by clicking the ''Custom Defined Field Viewable in Summary Window'Translate''' button at this time. |}]]

<ol start="12"li> Add the CDFs to the [[Use iReport | printing iReport templates]].</li><li>Do one of Consider if the following:CDF should be included in existing [[Building Searches | Saved searches]] or if a new Saved search should be created.</li>*To save <li> Consider if the custom defined field and close CDFs should be included in statistic iReports.</li> <li> Consider if a [[Customise Sub-Themes | sub-theme]] should be created for the CDF Editor window, click the Save buttonCDFs.</li> If the custom defined field information is successfully saved, <li> Consider if the CDF Editor window closes and the custom defined field is listed should be included in the Data Inventory Manager window. After the custom defined field is addedother statistic reports, maps, it becomes available from the folder of the data category in which it was created in the Data Entry Form Manageretc.</li>

</ol>

{| class="wikitable"|-| [[File:{Note.jpg | 40px]] || If you would like Auxiliary data and Task CDFs are automatically added to add the custom defined field to existing Data Entry Form templates, the designated area in the Editor windows. As administrator you will need to update and republish cannot control placement nor size of the Data Entry Form templatecontrols.|}}

<ol>*To discard the custom defined field and close the CDF Editor window, click the '''Cancel''' button.</ol> ===How to view and/or change custom defined fields===You can change the label, description, and active status of CDFs. You can also change the values for multiple selection or single selection CDFs. To view and/or change custom defined fields:<ol><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 data category to which you would like to add a CDF.</li><li>Click the [[Image:FieldViewIconuMFig144.png]] button.</li>:The CDF Editor window displays. <li>Change the information as needed. Note that you can only change the label or description.</li></ol> {| class="wikitable"|-| [[File:Note.jpg center| 40px]] 450px|| List values can only be changed if the custom defined field is not yet used in a published Data Entry Form template.|} <ol start="5"><li>Do one of the following:</li>*To save the custom defined field and close the Custom Defined Field Editor window, click the '''Save''' button.</ol> {| class="wikitable"|-| [[File:Note.jpg | 40px]] || If you would like to update the custom defined field in 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 Custom Defined Field Editor window, click the '''Cancel''' button. </ol> ===How to inactivate custom defined fields==={| class="wikitable"|-| [[File:Note.jpg | 40px]] || A custom defined field cannot be removed if it is on a published Data Entry Form template. |} To inactivate a custom defined field:<ol><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 data category that contains the CDF you would like to inactivate.</li><li>From the right pane of the Data Inventory Manager window, click the row of the custom defined field you would like to inactivate.</li><li>Do one of the following:</li>*Click the [[Image:ActivityIcon.png]] button. The status of the CDF changes to Inactive.*Click the [[Image:FieldViewIcon.png]] button to display the CDF Editor window. From the CDF Editor window, uncheck the Active checkbox and click the '''Save''' button. </ol> {| class="wikitable"|-| [[File:Note.jpg | 40px]] || If you would like to remove the custom defined field from existing Data Entry Form templates, you will need to update and republish the Data Entry Form template.|} ===How to translate custom defined field labels===The following procedures allow you to translate the custom defined field label that displays CDFs in the Data Entry Form. It also allows you to translate the list values for multiple-selection and single-selection lists.  {| class="wikitable"|-| [[File:Note.jpg | 40px]] || You can also translate CDF labels, multiple -selection list, and single-selection list values via a translation file. |} To translate custom defined fields: <ol><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 data category that contains the CDF you would like to translate.</li><li>From the right pane of the Data Inventory Manager, click the row of the custom defined field that you would like to translate.</li><li>Click the [[Image:FieldViewIcon.png]] button.</li>:The CDF Editor window displays. <li>From the CDF Editor window, click the '''Translate''' button.</li>:The Translated Terms List window displays.<li>Select the language for which you would like to provide a translation from the list ([[:Image:uMFig146.png|Figure 146]]).</li> </ol> [[Image:uMFig146.png|center|500px|''Figure 146. Translated Terms List Window'']] <ol start="7"><li>Click the row of the term that you would like to translate.</li><li>Click the [[Image:FieldViewIcon.png]] button.</li>The Translated Terms Editor window displays ([[:Image:uMFig147.png|Figure 147]]). </ol> [[Image:uMFig147.png|center|''Figure 147. Translated Terms Editor'']] <ol start="9"><li>Enter the translated term in the '''Translation''' field.</li><li>Do one of the following:</li>*To save the translation, click the '''Save''' button. *To discard the translation, click the '''Cancel''' button. </ol>

{{NavBox HowTo Data Entry FormsElements}}[[Category:NAA]]

• ← Older edit

Alnaucler

NoPublic, bureaucrat, administrator

6,632

edits