Difference between revisions of "Add a Local ID Generator"

From IMSMA Wiki
Jump to: navigation, search
Line 1: Line 1:
 +
Local ID generators are used when generating a Local ID in a Data Entry Form. The Local ID of a Data Entry Template is built up five parts:
 +
# ''Local ID Name'' from the Local ID generator
 +
# divider (usually hyphen) i.e. -
 +
# ''System Name'' set in IMSMA Client Configuration Tool (optional)
 +
# divider (usually hyphen) i.e. -
 +
# ''Incremented Number'' from the Local ID generator
 +
which for an Activity may look like ''CR-MAG HQ-1'' or for a Victim ''Vic-MACC3-4581''.
 +
 +
{| class="wikitable"
 +
|-
 +
| '''Local ID Name''' || A text string that represents the item category or subcategory. For example, a completion report could be represented by “CR.”
 +
|-
 +
| '''System Name''' || A value specified in the Client Configuration Tool of the {{IMSMANG}} [[Starting and Stopping IMSMANG | TrayLauncher]] where system administrators can set a separate system name for each computer where {{IMSMANG}} is installed. For example, the MAG Head quarter's computer could have “MAG HQ” as a system name while a regional installation could have “ MAG R1.”
 +
|-
 +
| '''Incremented Number''' || A value that increases each time a new ID is generated. Information managers can specify the next number to be generated when the local ID generator button is clicked. For example, a new local ID starting with CR-MAG HQ-1 and proceeding to CR-MAG HQ-2 and so on will be generated each time the Completion Report local ID generator is clicked.
 +
|}
 +
 
To add a local ID generator:
 
To add a local ID generator:
 
<ol>
 
<ol>
 
<li>Open the '''Customisation''' menu, and then select '''Data Entry Form Templates > Local ID Generator'''.</li>
 
<li>Open the '''Customisation''' menu, and then select '''Data Entry Form Templates > Local ID Generator'''.</li>
−
::The Local ID Generator window displays.
+
The Local ID Generator window displays.
 
<li>Click the [[File:FieldTemplateIcon.png|20px | Add]] button.</li>
 
<li>Click the [[File:FieldTemplateIcon.png|20px | Add]] button.</li>
−
::The Local ID Generator window displays.
+
The Local ID Generator window displays.
  
 
[[File:AddLocalIDGeneratorWindow.png|240px|''Add a local ID generator'']]
 
[[File:AddLocalIDGeneratorWindow.png|240px|''Add a local ID generator'']]
Line 11: Line 28:
 
<li>In the '''Next Number''' field, enter the number you want to assign to the next object of that type that is added to IMSMA.  
 
<li>In the '''Next Number''' field, enter the number you want to assign to the next object of that type that is added to IMSMA.  
 
IMSMA will automatically assign the next sequential number to each subsequent object of the same type that is added to IMSMA. </li>  
 
IMSMA will automatically assign the next sequential number to each subsequent object of the same type that is added to IMSMA. </li>  
−
::Local ID generators are typically comprised of the following components:
 
−
::[Local ID Name]-[System Name]-[Incremented Number]. For example, CR-MAG HQ-1.
 
−
 
−
{| class="wikitable"
 
−
|-
 
−
| '''Local ID Name''' || A text string that represents the item category or subcategory. For example, a completion report could be represented by “CR.”
 
−
|-
 
−
| '''System Name''' || A value specified in the Client Configuration Tool of the {{IMSMANG}} [[Starting and Stopping IMSMANG | TrayLauncher]] where system administrators can set a separate system name for each computer where {{IMSMANG}} is installed. For example, the MAG Head quarter's computer could have “MAG HQ” as a system name while a regional installation could have “ MAG R1.”
 
−
|-
 
−
| '''Incremented Number''' || A value that increases each time a new ID is generated. Information managers can specify the next number to be generated when the local ID generator button is clicked. For example, a new local ID starting with CR-MAG HQ-1 and proceeding to CR-MAG HQ-2 and so on will be generated each time the Completion Report local ID generator is clicked.
 
−
|}
 
  
 
<li> Click the '''Save''' button.
 
<li> Click the '''Save''' button.
−
::If you do not want to save the local ID generator, click the '''Cancel''' button.</li>
+
If you do not want to save the local ID generator, click the '''Cancel''' button.</li>
 
<li> Click the '''Done''' button to close the Local ID Generator window and return to the IMSMA Navigation window.</li>
 
<li> Click the '''Done''' button to close the Local ID Generator window and return to the IMSMA Navigation window.</li>
 
</ol>
 
</ol>

Revision as of 21:02, 7 November 2014

Local ID generators are used when generating a Local ID in a Data Entry Form. The Local ID of a Data Entry Template is built up five parts:

  1. Local ID Name from the Local ID generator
  2. divider (usually hyphen) i.e. -
  3. System Name set in IMSMA Client Configuration Tool (optional)
  4. divider (usually hyphen) i.e. -
  5. Incremented Number from the Local ID generator

which for an Activity may look like CR-MAG HQ-1 or for a Victim Vic-MACC3-4581.

Local ID Name A text string that represents the item category or subcategory. For example, a completion report could be represented by “CR.”
System Name A value specified in the Client Configuration Tool of the IMSMANG TrayLauncher where system administrators can set a separate system name for each computer where IMSMANG is installed. For example, the MAG Head quarter's computer could have “MAG HQ” as a system name while a regional installation could have “ MAG R1.”
Incremented Number A value that increases each time a new ID is generated. Information managers can specify the next number to be generated when the local ID generator button is clicked. For example, a new local ID starting with CR-MAG HQ-1 and proceeding to CR-MAG HQ-2 and so on will be generated each time the Completion Report local ID generator is clicked.

To add a local ID generator:

  1. Open the Customisation menu, and then select Data Entry Form Templates > Local ID Generator.

    2. The Local ID Generator window displays.

  2. Click the Add button.

    3. The Local ID Generator window displays.

    Add a local ID generator

  3. Enter the name for the new local ID generator in the Prefix field.
  4. In the Next Number field, enter the number you want to assign to the next object of that type that is added to IMSMA. IMSMA will automatically assign the next sequential number to each subsequent object of the same type that is added to IMSMA.
  5. Click the Save button. If you do not want to save the local ID generator, click the Cancel button.
  6. Click the Done button to close the Local ID Generator window and return to the IMSMA Navigation window.
Configuring the Items ID Generator
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Add_a_Local_ID_Generator&oldid=17704"