inFORM Decisions Information Portal

User Tools

Site Tools

Trace:
pub:databasemapping

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
pub:databasemapping [2015/07/13 12:06] – [Overview of User's Guide] kenpub:databasemapping [2022/06/25 17:02] (current) – external edit 127.0.0.1
Line 5: Line 5:
  
 ===== Introduction===== ===== Introduction=====
-Database Mapping, a new module of iDocs, supports the user when merging an application overlay with a database directly, e.g. iForms, iChecks ACH. The following information is designed to assist the user.   +Database Mapping, a new module of iDocs Version 6.90 (11/28/2017), that supports the user when merging an application overlay (Forms, Check, ACH) with a database directly. The following information is designed to assist the user.   
  
 ===== Overview of User's Guide ===== ===== Overview of User's Guide =====
  
-Access to Database Mapping is found within the main menu of the “Work with Form Applications”, “Work with Checks Applications” or the “Work with ACH” applications.+Access to Database Mapping is found within the main menu of the “Work with Form Applications”, “Work with Checks Applications” or the “Work with ACH” applications. Select an option to perform the desired action.
  
 {{pub:databasescreenprint1.png|---- {{pub:databasescreenprint1.png|----
 }} }}
  
- Navigate to the two new Database Mapping options, “19=Work with database map” and “20 Merge with database map” by selecting the “More Options” key, F23. + Navigate to the two new Database Mapping options, “19=Work with database map” or “20 Merge with database map” by selecting the “More Options” key, F23. 
-{{:pub:databasesscreenprint2.png?&900|----}}+ 
 +{{pub:databasesscreenprint2.png?&950|----}} 
  
  
-[[DatabaseMappingMergerFormwithdatabase]] 
  
 ===== Work with Database Mapping - Option 19 ===== ===== Work with Database Mapping - Option 19 =====
Line 28: Line 29:
 **Exploring the Edit Database Map Screen** **Exploring the Edit Database Map Screen**
  
-**Master file (Optional to the user)**+**Master file**
  
-Data entered into the master file field becomes a report’s header; each record prints on a spool page.+(Optional) The data contained on the master file will be treated as the header part of the report, and each record will be printed on a spool page.
  
-**Level file (Optional to the user)** +**Level file** 
  
-Level file data is the detail within a report. You can indicate the number of level records to print on a spool page. +(Optional) The data contained on the Level file will be treated as the detail part of the report. You can indicate the number of level records to print on a spool page. 
  
 **Master Field and Level Field** **Master Field and Level Field**
  
-If both the Master file and Level file are used, these fields must be specified. The files are linked by Master Field and Level Field.   +These fields must be specified if both the Master file and Level file are used. The files are linked by Master Field and Level Field.  
-Below is a sample report: +  
 +A sample report appear below:
  
 {{pub:masterfieldlevelfieldsamplereport.png|}} {{pub:masterfieldlevelfieldsamplereport.png|}}
Line 52: Line 53:
 {{pub:numberoflevelrecordsperfieldsmpl.png|}} {{pub:numberoflevelrecordsperfieldsmpl.png|}}
  
-Below shows the results when the entered value is 2 and there are 5 records in the level file:+Changing the entered value is 2 would restrict the output to 2 level records per page resulting in 3 spool file pages for a level file containing 5 records:
  
 {{pub:levelrecordsexamplewithvalue2.png|}} {{pub:levelrecordsexamplewithvalue2.png|}}
  
-Note: Because the footer data prints only on the last page, footer data is seen on page 3 of this 3 page report. +Note: There is a total of 3 pages, but because the footer data prints only on the last page, footer data is seen on page 3 of this 3 page report (not on pages 1 or 2). 
  
 {{pub:levelrecordsexamplefooterpage.png|}} {{pub:levelrecordsexamplefooterpage.png|}}
Line 62: Line 63:
 **Email Output Spool Manually** **Email Output Spool Manually**
  
-To email output spool manually, select Y (Yes). After the merge process is complete, a prompt screen allows the input of an email address and subsequent sending. In burst mode, the prompt screen will display for each part of the bursting process.+If the user wants to email output manually, this indicator should be 'Y' (Yes). After the merge process is complete, a email prompt screen allows the input of an email address and subsequent sending. If bursting is specified, the email prompt screen will display for each part of the bursting process.
  
 **Fax Output Spool Manually** **Fax Output Spool Manually**
Line 70: Line 71:
 **Retain Output after Email/Fax** **Retain Output after Email/Fax**
  
-This option allows for the retention or deletion of the output spool after it is manually faxed or emailed.  A “Y” value in this field will retain the data while an “N” value will delete all data.+This option allows for the retention or deletion of the output spool after it is manually faxed or emailed.  A “Y” value in this field will retain the data, while an “N” indicates the output will be deleted after the email or fax is sent.
  
 ===== Working with the Master Field ===== ===== Working with the Master Field =====
  
-From the ‘Edit Database Map’ screen, press F7 to open the “Database Field Maintenance screen”.  To add a new field, press F6.  To edit an existing field, select option #1.  +From the ‘Edit Database Map’ screen, press F7 to open the “Database Field Maintenance screen”. 
 {{pub:databasemapfieldmaintscreen.png|}} {{pub:databasemapfieldmaintscreen.png|}}
  
-The Map Field Maintenance screen looks similar to the interface of the Spool DataMap Field Maintenance screen, but the Map Field Maintenance no longer uses: From Row, To Row, From Column, To Column.  The new, more functional fields are: Date format, Edit code and Function. +From the Database Map Field Maintenance screen, press F6 to add a new field, or select option #1 to edit an existing field. 
-Note: The iDocs User Guide only briefly refers to the above mentioned new fields. The below provides a more in-depth explanation of the fields. +
  
 {{pub:mapfieldmaintscreen.png|}} {{pub:mapfieldmaintscreen.png|}}
 +
 +The Map Field Maintenance screen looks similar to the interface of the Spool DataMap Field Maintenance screen, but it no longer uses the **From Row**, **To Row**, **From Column**, **To Column** fields.  New fields **Date format**, **Edit code** and **Function** have been added.
 +
 +Below is a in-depth explanation of the fields described in the iDocs User Guide. 
  
 **Date format** **Date format**
Line 121: Line 124:
 ===== Working with the Level Field ===== ===== Working with the Level Field =====
  
-From the ‘Edit Database Map’ screen, select F8 to open the “Database Map Field Maintenance” screen.  Use F6 to add a new field or option #1 to edit an existing field. +From the ‘Edit Database Map’ screen, select F8 to open the “Database Map Field Maintenance” screen.  
 {{pub:levelfieldscreenprint.png|}} {{pub:levelfieldscreenprint.png|}}
 +
 +From the Database Map Field Maintenance screen, press F6 to add a new field or select option #1 to edit an existing field.
  
 {{pub:levelfieldscreenprint2.png|}} {{pub:levelfieldscreenprint2.png|}}
Line 135: Line 139:
 ===== Working with the Footer field ===== ===== Working with the Footer field =====
  
-From the ‘Edit Database Map’ screen, press F9 to open the “Database Field Maintenance” screen.  To add a new field select F6. To edit an existing field, use option #1. +From the ‘Edit Database Map’ screen, press F9 to open the “Database Field Maintenance” screen.  
 Note: The footer fields are available only when the level file is defined for database mapping.  Note: The footer fields are available only when the level file is defined for database mapping. 
  
 {{pub:footerfieldmaintscreen.png|}} {{pub:footerfieldmaintscreen.png|}}
 +
 +From the Database Map Field Maintenance screen, press F6 to add a new field, or select option #1 to edit an existing field.
  
 {{pub:footerfieldmaintscreen2.png|}} {{pub:footerfieldmaintscreen2.png|}}
Line 148: Line 153:
 {{pub:footerfieldfunctionexample.png|}} {{pub:footerfieldfunctionexample.png|}}
  
-To display all the valid level fields within database mapping, select F4 (List) within the “Field Name” field.  +At the '**Field Name**' field screen, press F4 to display all the valid level fields within database mapping.  
 Only the level fields defined for database mapping are selectable.  Only the level fields defined for database mapping are selectable. 
  
-Note: Conditionally fields are not available when using the footer field. +Note: With the footer field, the conditional fields are not available. 
  
 ===== Bursting and Sorting ===== ===== Bursting and Sorting =====
Line 159: Line 164:
 If both Master and Level files are specified, the bursting function will be defined for the Master Field.  If both Master and Level files are specified, the bursting function will be defined for the Master Field. 
  
-When using the sorting feature, it is recommended that the user designate at least one field to be sorted if the file (master or level) did not define any key field.  +Sorting feature recommendations:   
 +Specify at least one field to be sorted if the file (master or level) did not define any key field.  
 If sorting is not indicated, the file will be sorted by either key fields or sorting fields. If sorting is not indicated, the file will be sorted by either key fields or sorting fields.
  
-For example, the following setting will arrange the output result using the database’s email address field.+For example, the following setting will break the output result by the email address field from the database.
  
 {{pub:burstingandsortingsettingexample.png|}} {{pub:burstingandsortingsettingexample.png|}}
Line 177: Line 183:
 The built-in special fields from the list above include:  The built-in special fields from the list above include: 
  
-1. *DATE: return the current system date. You can format the output value with field ‘Date format’ +  *  *DATE: return the current system date. You can format the output value with field ‘Date format’  
- +  *  *DOCNAME: return the name of a current map. 
-  +  *  *DOCTEXT: return the description of a form, check or ACH. 
-2. *DOCNAME: return the name of a current map. +  *  *PAGENBR: return the current page number. This field is useful when you merge an overlay with a map, and wish to auto number pages. 
- +  *  *TIME: return the system time with format HH:MM:SS. 
-3. *DOCTEXT: return the description of a form, check or ACH. +  *  *USER: return the user name of a current job. 
- +  *  *COPYRIGHT: User defined field. This field will return the value that the user has assigned.
-4. *PAGENBR: return the current page number. This field is useful when you merge an overlay with a map, and wish to auto number pages. +
- +
-5. *TIME: return the system time with format HH:MM:SS +
- +
-6. *USER: return the user name of a current job. +
  
 An example of a user-defined special field, a field returning a value assigned by the user, is the *COPYRIGHT option above.   An example of a user-defined special field, a field returning a value assigned by the user, is the *COPYRIGHT option above.  
- 
-To define a new field press F11 from the ‘Edit Database Map’ screen to open the User-Defined Field screen. 
  
 {{pub:userdefinedfieldscreen1.png|}} {{pub:userdefinedfieldscreen1.png|}}
 +To define a new field press F11 from the ‘Edit Database Map’ screen to open the //User-Defined// Field screen.
 {{pub:userdefinedfieldscreen2.png|}} {{pub:userdefinedfieldscreen2.png|}}
  
 Note: Only User-defined fields are editable or removable in the maintenance screen. Note: Only User-defined fields are editable or removable in the maintenance screen.
- 
- 
 To define a new user-defined field, press F6: To define a new user-defined field, press F6:
  
Line 211: Line 207:
 This action is similar to ‘Merge with Spool Mapping’. This action is similar to ‘Merge with Spool Mapping’.
  
-{{pub:mergeappwithdatabasemapscreen.png|}}+{{pub:mergeappwithdatabasemapscreen.png?900|}} 
 + 
 +**Outq name** : enter the output queue name \\ 
 +**Copies**         : enter the number of copies \\ 
 +**Font**         : select to change the default font name by press F8 \\ 
 +**Spool file name** : change the default output PCL name (FMGLASER) \\ 
 +**Override Master/Level File**: If a user wants to change the master file or level file which is defined in form, he can manually input the override file name on these fields. \\ 
 +**Manual Email (Fax):** there are 03 valid values on these fields 
 +  * **Blank**          : use the value of form definition. 
 +  * **Y**          : enforce the output PCL is emailed despite the ‘Manual Email (Fax)’ setting in form definition.  
 +  * **N**          : enforce the output PCL is ignored to email despite the ‘Manual Email (Fax)’ setting in form definition. 
 +**F6=Override Master (Level) Cond**: Change the conditional settings (filters) of master (level) file  
 + 
 +{{pub:databasemapfieldconditions.png?900|}} 
 + 
 +From the override condition screen, a user is able to see the condition settings of current form and then can override the conditions.
  
 **API of merge** **API of merge**
Line 217: Line 228:
 You also can use the IMRGDBMAP command to merge a database map with an application. You also can use the IMRGDBMAP command to merge a database map with an application.
  
-{{pub:mergewithappapi.png|}}+{{pub:mergewithappapi.png?900|}}
  
  
 The application name can be a form, a check or an ACH name. The application name can be a form, a check or an ACH name.
  
 +**Application name** : enter the application name.\\
 +**Outq name**     : enter the output queue name.\\
 +**Copies**     : enter the number of copies.\\
 +**Font**        : select to change the default font ID.\\
 +**Spool file name**  : change the default output PCL name (FMGLASER).\\
 +**Override Master/Level File** : If a user wants to change the master file or level file which is defined in form, he can manually input the override file name on these fields.\\
 +**Manual Email (Fax) :** there are 03 valid values on these fields
 +  * **Blank** : use the value of form definition.
 +  * **Y** : enforce the output PCL is emailed despite the ‘Manual Email (Fax)’ setting in form definition. 
 +  * **N** : enforce the output PCL is ignored to email despite the ‘Manual Email (Fax)’ setting in form definition.
 +**Override Master (Level) File Condition**: Change the conditional settings (filters) of master (or level) file by enter a SQL statement, for example
 +
 +{{pub:mergewithappapi2.png?900|}}
 ===== Some Helpful Tips to Define an Application ===== ===== Some Helpful Tips to Define an Application =====
  
pub/databasemapping.1436814386.txt.gz · Last modified: 2022/06/25 17:02 (external edit)