Difference between revisions of "Publish a Data Entry Form Template"

From IMSMA Wiki
Jump to: navigation, search
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
==Good practice==__NOEDITSECTION__
 +
<ol>
 +
<li>By adding a Page header and Page footer on each page, fields are prevented from drifting upwards when editing a published template again.
 +
<li>Verify in the Logical tree that only 1 item is used.
 +
[[Image:Broken widget.png|200px|center]]<br/>
 +
<div align="center">
 +
'' Choose button is an indication that the widget is old''
 +
</div>
 +
<li>Verify in the Logical tree that no widgets are old which may cause problems.
 +
<li>Save the template before Publishing.
 +
</ol>
 +
 +
==Publish a Data Entry Form template==__NOEDITSECTION__
 
Publishing a Data Entry Form template makes the template available to other IMSMA users for data entry.  
 
Publishing a Data Entry Form template makes the template available to other IMSMA users for data entry.  
 +
<ol>
 +
[[Image:DEF designer buttons.png|600px|center]]<br/>
  
{{note|If you think you might need to change the Data Entry Form at a later time, you should first save the Data Entry Form so that you can modify the existing Data Entry Form template. Otherwise, you will need to recreate the Data Entry Form template.
+
<li>Click the '''Publish''' button in the Data Entry Form template designer window.</li>
}}
+
<br/>[[Image:Publish DEF.png|400px|center]]<br/>
 
 
To publish a Data Entry Form template:
 
<ol>
 
<li>Click the '''Publish''' button.</li>
 
The Form Publisher window displays.
 
 
<li>Enter a name for the report in the '''Data Entry Form Name''' field. The Data Entry Form Name is a required value. When entering a Data Entry Form name, note that:</li>
 
<li>Enter a name for the report in the '''Data Entry Form Name''' field. The Data Entry Form Name is a required value. When entering a Data Entry Form name, note that:</li>
 
*The name can be no longer than 38 characters.  
 
*The name can be no longer than 38 characters.  
Line 13: Line 23:
 
</ol>  
 
</ol>  
  
{{note|If you enter a name used by an already published Data Entry Form template, the existing Data Entry Form template will be overwritten. To prevent this from happening, be sure to enter a unique Data Entry Form name.  
+
{{Note|If you enter a name used by an already published Data Entry Form template, the existing Data Entry Form template will be set to ''Inactive''. }}
}}
 
  
 
<ol start="4">
 
<ol start="4">
Line 24: Line 33:
  
 
<ol start="4">
 
<ol start="4">
<li>Click the [[Image:UserManual_ParentOrganisationsIcon.png]] button to select an organisation. Note that in order to publish the Data Entry Form, it must be associated with an organisation.</li>
+
<li>Click the [[Image:Select and Organisation.png]] button to select an organisation. Note that in order to publish the Data Entry Form, it must be associated with an organisation.</li>
 
:The Organisation Selection window displays.
 
:The Organisation Selection window displays.
 
<li>From the Organisation Selection window:</li>
 
<li>From the Organisation Selection window:</li>
Line 32: Line 41:
 
:The selected organisation’s name displays in the '''Organisation''' field.
 
:The selected organisation’s name displays in the '''Organisation''' field.
 
</ol>
 
</ol>
 +
{{Note | The Organisation ''IMSMA'' is normally used for indicating that the Data Entry Form template is general i.e. not a special made template for one organisation.}}
 
<li>Click the '''Publish''' button.</li>
 
<li>Click the '''Publish''' button.</li>
 
:A message displays indicating the form was published successfully. If a Data Entry Form template exists with the same name, the existing template will be marked as inactive. Data Entry Forms using the now inactive template can still be viewed from the Location Summary or Item Summary windows.  
 
:A message displays indicating the form was published successfully. If a Data Entry Form template exists with the same name, the existing template will be marked as inactive. Data Entry Forms using the now inactive template can still be viewed from the Location Summary or Item Summary windows.  
 +
{{Note | The following information is mandatory:
 +
# Data Entry Form name
 +
# Organisation }}
 +
<li> The Publish Data Entry Form Template function will continue with first checking  if all multi-select options exist in the database.<br/>
 +
<br/>[[Image:Missing MS options.png|600px|center]]
 +
<div align="center">
 +
''Click on the button Show details and exactly which field is missing what will be shown</div><br/>
 +
<li>The next check is if all the '''[[Reconcile CDFs When Publishing a Data Entry Form | CDFs in the template exists]]''' in the database.
 
</ol>
 
</ol>
 
{{Important|The following errors may occur.
 
Error: A Data Entry Form name is required to publish this template.
 
Cause: You did not enter a Data Entry Form name.
 
 
Error: An Organisation must be selected before a Data Entry Form Template can be published.
 
Cause: You did not specify an organisation.
 
}}
 
 
 
{{NavBox HowTo Data Entry Forms}}
 
{{NavBox HowTo Data Entry Forms}}
 
+
[[Category:NAA]]
[[Category:ELR]]
 

Latest revision as of 15:37, 19 March 2019

Good practice

  1. By adding a Page header and Page footer on each page, fields are prevented from drifting upwards when editing a published template again.
  2. Verify in the Logical tree that only 1 item is used.
    Broken widget.png

    Choose button is an indication that the widget is old

  3. Verify in the Logical tree that no widgets are old which may cause problems.
  4. Save the template before Publishing.

Publish a Data Entry Form template

Publishing a Data Entry Form template makes the template available to other IMSMA users for data entry.

    DEF designer buttons.png

  1. Click the Publish button in the Data Entry Form template designer window.

  2. Publish DEF.png

  3. Enter a name for the report in the Data Entry Form Name field. The Data Entry Form Name is a required value. When entering a Data Entry Form name, note that:
    • The name can be no longer than 38 characters.
    • The name can contain special characters.
Note.jpg If you enter a name used by an already published Data Entry Form template, the existing Data Entry Form template will be set to Inactive.
  1. Enter the version number for the Data Entry Form in the Version field.
Note.jpg The version number is not required. If you do not enter a version, IMSMA will assign a version of “1.0” to the Data Entry Form template.
  1. Click the Select and Organisation.png button to select an organisation. Note that in order to publish the Data Entry Form, it must be associated with an organisation.
  2. The Organisation Selection window displays.
  3. From the Organisation Selection window:
    1. Click the row for the organisation that you would like to select as being the report owner.
    2. Click the OK button.
    3. The selected organisation’s name displays in the Organisation field.
    Note.jpg The Organisation IMSMA is normally used for indicating that the Data Entry Form template is general i.e. not a special made template for one organisation.
  4. Click the Publish button.
  5. A message displays indicating the form was published successfully. If a Data Entry Form template exists with the same name, the existing template will be marked as inactive. Data Entry Forms using the now inactive template can still be viewed from the Location Summary or Item Summary windows.
    Note.jpg The following information is mandatory:
    1. Data Entry Form name
    2. Organisation
  6. The Publish Data Entry Form Template function will continue with first checking if all multi-select options exist in the database.

    Missing MS options.png
    Click on the button Show details and exactly which field is missing what will be shown

  7. The next check is if all the CDFs in the template exists in the database.