U07 Auxiliary Table Maintenance
U0736 Document
This update is used to create a new document by using a template. The generated documents then can be used from multiple workflow modules of LeasePak. A variety of documents can be created by using custom templates. The update requires valid SQL select statements to retrieve a record from database. The update merges the retrieved information into the selected document template to generate a document. Users can also create documents through dxGeneration (Batch).
LeaePak supported workflow modules are: Application, Collection, Collateral, Customer Service, Insurance, Maturing, Recovery, Lease Summary, and dxGeneration.
Requires Automated Lease Document Generation module. Contact your NETSOL representative for more information.
Selection Criteria
Introductory Notes
U0736 Add/Change option consists of multiple screens describing step by step process including required files and fields to create a new document and to change an existing document. The order of the screens will remain same for both Add and Change option.
Screen and Fields
Option Description
- Required
-
The document options menu allows the user to add, change, or delete documents. To perform an action, double click the option name from the list.
- Add (Button) – Add a new document.
- Change (Button) – Change settings for an existing document.
- Delete (Button) – Delete an existing document.
- Done (Button) – To exit from update
Data Definition SQL
Introductory Notes
This screen is used to define the data definition selection criteria. The data definition selection criteria includes the database fields which are required to retrieve information from database and to merge that retrieved information into the selected template to generate a document.
Screen and Fields
ID
- Display
-
The ID of each set of SQL statement will be displayed. This is an auto-generated number for the SQL statements and cannot be modified.
Select Statement (SQL)
- Display
-
Displays the selected SQL select statement. These SQL select statements will be used to collect data from database to merge into the document template for this document. The first SQL statement must be at ROOT level. The Root level SQL statement determines the key by the help of the provided parameters to insert into the subsequent SQL select statements. These parameters are set up by enclosing them in curly brackets. Following is a simple example of a root level SQL statement to determine the key for a workflow module:
select * from rls where lse_s = ‘{arg.lse_s}’
In the above statement, the {arg.lse_s} is an argument for a lease number. The parameter passed in the argument of the SQL statement will be used in workflow modules to access this document.
Database equivalent: rds.info_s
Level
- Required
-
Select level for SQL select statement from dropdown list. The level for ID must be at ROOT level. Level defines the relationship between the SQL statements to be executed in order to merge the data into a document template. For more SQL statements set the level according to the required hierarchy and relationship of fields requires information from database.
Up/Down Button
- Optional
-
The Up and Down allow the users to define the sequence of the SQL queries to execute and to merge into the selected document template.
Add Button
- Optional
-
(Button) Click on this button to add the SQL statement including the Level, Name, and Group fields. Clicking on Add button enables the lower panel of the screen to enter SQL statement for a document.
Change Button
- Optional
-
(Button) Click on this button to modify the existing SQL statement and any other fields of that particular SQL statement. Select the existing SQL statement and click on Change button will load the details of that particular SQL statement.
Delete Button
- Optional
-
(Button) Use Delete button to delete SQL statement.
Name
- Optional
-
Enter the name of the XML element that will be created for each record returned by executing the provided SQL select statement. XML name will be required in the next screen for this update in the process of testing the SQL select statements. The provided text in this field will become XML element name in the XML output file. The format of this input field is comprises of following criteria:
- It must start with a letter or underscore
- Only letters, digits, and underscores are allowed
- Should not start with the letters of xml (or XML, or Xml, etc.)
- Must not contain spaces
Group
- Optional
-
Enter group for SQL select statement. Group defines a group of records from SQL select statements that will be used later in this update for XML to create a sample document. Group contains the retrieved records by executing the SQL select statement. This field is same as Name field and is used to create a document. The data validation rules are same as of Name field.
SQL
- Required
-
Enter the SQL select statement. The provided SQL select statement will be used to retrieve data from database to merge into the selected document template.
Will this SQL statement return multiple records? (WebMerge Only)
- Optional
-
Requires WebMerge subscription to use this service. Selection of this checkbox determines whether the entered SQL select statement will return multiple records. Selection of this checkbox does not support to create MS Word type of documents.
Update/Cancel Button
- Optional
-
Use Update button to add a new SQL statement and to modify the existing SQL statement. The added or modified record then will be displayed in the above section of this screen. Clicking on the Cancel button will disable this section of the screen and shifts the control to the upper section without saving any changes.
Next/Cancel Button
- Optional
-
Click on Next button to save the data entered on this screen and proceed to next screen of this update. Clicking on Cancel confirm from users whether to exit from the update.
Data Definition Testing
Introductory Notes
This screen helps users to test SQL select statements provided in the prior screen to retrieve information from database. This is an optional step of this update. Users can skip this step and can move to the next screen by clicking on the Next button.
Screen and Fields
Data definition selection criteria key
- Display
-
Displays the data definition selection criteria key. This is the SQL statement argument parameter provided in the prior screen at root level.
Enter Application/Lease/Asset/Vendor/Broker
- Required
-
The label of this field will appear based on selection criteria key. This is the key parameter found in root level SQL select statement provided in prior screen and displayed in the "Data definition selection criteria key" field. Enter the number of the required key. If selection criteria key is a lease number, the label will be "Enter Lease". If selection criteria key is an asset number, then the label will be "Enter Asset".
Create XML File
- Optional
-
The create XML file helps users to test the provided select SQL statement in XML form. Clicking on this button opens a new window with XML data retrieved from database by using the set of SQL select statement provided in the prior screen. Here is a sample XML file.
Create JSON File
- Optional
-
The create JSON file helps users to test the provided select SQL statement in JSON file. Clicking on this button opens a new window with data retrieved in JSON file format from database by using the set of SQL select statements provided in the previous screen. Click to see a sample JSON file. WebMerge documents are only supported to test in JSON file format.
Users can verify the retrieved information from database by viewing debug file named docgen.log. The docgen.log file can be found in LeasePak directory of the system where it is installed. Set following in the leasepak.ini file to view docgen.log:
[debug]LogFile=1
Back/Next/Cancel (Button)
-
(Button) Click on Back button to move to previous screen without saving changes. Click on Next button to save changes and move to the next screen. The Cancel button confirms whether to exit or continue with the update. Select desired option. The Yes button exits from this update without saving changes whereas user will remain on same screen on selection of No button.
Accessibility
Introductory Notes
This screen is used to select the workflow modules. Selection of workflow modules at this screen will help users to access the generated document from the selected workflow module. LeasePak selects the workflow modules by default based on the data definition selection criteria key as displayed in prior screen. The selected data definition criteria key must match with the required key to be accessed from the selected workflow module.
Screen and Fields
Data definition selection criteria key
- Display
-
Displays the data definition selection criteria key. This is the SQL statement argument parameter provided in the prior screen at root level.
Workflow
- Display
-
The list of existing LeasePak workflow modules will be displayed. The dxGeneration option works with dxGenrtaion Interface only. If dxGeneration option is accessible than the selected document can be generated by using dxGeneration interface. In the case dxGeneration option is deactivated and not selectable then user will not be able to use this particular document with dxGeneration interface.
Required Key(s)
- Display
-
The required key with respect to the workflow module will be displayed.
Accessible?
- Optional
-
Selection of the checkbox determines whether the document is to be accessed by that workflow module. By default LeasePak selects the respective workflow module depending on the data definition selection criteria key matching the required workflow module key. Users can select additional workflow modules as required..
If the data definition selection criteria key does not match with the required key, then the document selected in this update cannot be accessed from that workflow module. Also, the option will be disabled.
Back/Next/Cancel (Button)
-
(Button) Click on Back button to move to previous screen without saving changes. Click on Next button to save changes and move to the next screen. The Cancel button confirms whether to exit or continue with the update. Select desired option. The Yes button exits from this update without saving changes whereas user will remain on same screen on selection of No button.
Document Template Type
Introductory Notes
This screen is used to select the type of document to generate. Select one of the option from the following to proceed further:
Screen and Fields
MS Word Document Template
Introductory Notes
This screen appears if user has selected "MS Word Document Template" from previous screen. Use this screen to select MS word document template that will be used to merge the data from database. The selected template will be used to generate a document.
Screen and Fields
MS word Document Template
- Optional
-
Select this option if template document is required in MS Word form. LeasePak selects this option by default.
WebMerge Document Template
- Optional
-
Select this option if document is required to be generated by WebMerge. This is another option for creating document template. To use this option user must subscribe with WebMerge service.
Back/Next/Cancel (Button)
-
(Button) Click on Back button to move to previous screen without saving changes. Click on Next to save changes and move to the next screen. The Cancel button confirms whether to exit or continue with the update. Select desired option. The Yes button exits from this update without saving changes whereas user will remain on same screen on selection of No button.
Template Filename
- Required
-
Type the full Windows path (including the driver letter, if any) or click
to select .docx template file . The selected template file name will be copied from the location specified to the template directory as defined in U0712 Custom General→Document Generation Customizations.
WebMerge Document Template
Introductory Notes
This screen appears if user has selected "WebMerges Document Template" from "Document Template Type" screen. To use WebMerge document template users must subscribe with WebMerge providing services.
Screen and Fields
WebMerge Document ID
- Required
-
Enter the WebMerge document ID. Users must be authorized to use WebMerge services to generate WebMerge document.
WebMerge Document Key
- Required
-
Enter the WebMerge document key.
Database equivalent: rdx.wm_doc_key_s
Always Merge documents in test mode?
- Optional
-
This field determines whether the document generated by the WebMerge is in test mode. It is preferred to use this checkbox to avoid multiple documents from cost perspective. WebMerge prints watermarks in the generated document while in test mode.
Database equivalent: rdx.wm_test_mode_c
Back/Next/Cancel (Button)
-
(Button) Click on Back button to move to previous screen without saving changes. Click on Next button to save changes and move to the next screen. The Cancel button confirms whether to exit or continue with the update. Select desired option. The Yes button exits from this update without saving changes whereas user will remain on same screen on selection of No button.
Document Generation Testing
Introductory Notes
This screen is used to sample test the selected document. Users can proceed further without performing sample test, as this is an optional step of this update while creating a document.
Screen and Fields
Data Definition Selection Criteria Key
- Display
-
The selected data definition selection criteria key found in the SQL select statement provided in prior screen will be displayed.
Enter Application/Lease/Lessee/Asset
- Required
-
LeasePak determines the label of this field based on the selection criteria key. If the selection criteria key is application, than the label will be Application. If selection criteria key is Asset, then "Enter Asset" will appear. Same is the case with all other options as found in selection criteria key.
Generate Document
- Optional
-
Clicking on this button will create a sample document with merged data that was retrieved based on selection criteria key. LeasePak stores the generated document in the following location:
{drive}:\Users\{user}\Documents\NetSol\LeasePak.NET.30\docs\
The generated document will be removed from the above location once user logs off from LeasePak application.
Back/Next/Cancel (Button)
-
(Button) Click on Back button to move to previous screen without saving changes. Click on Next button to save changes and move to next screen. The Cancel button confirms whether to exit or continue with the update. Select desired option. The Yes button exits from this update without saving changes whereas user will remain on same screen on selection of No button.
Document Information
Introductory Notes
Use this screen to enter document information. The provided information will be used to generate a document.
Screen and Fields
Document ID
- Required
-
Enter ID of the selected document.
Document Description
- Required
-
Enter the description of the selected document.
Generated Document Filename
- Required
-
Enter a name for the generated document file. This name will be used to store the generated document.
The created file extensions can either be
.docxor.pdf. LeasePak determines the generated file extension based on the installation of Word on the system of the user who initiates the document, either from a workflow module or from dxGeneration. If the generated filename has an extension of.docx, then LeasePak will create a word document irrespective of the Word installation.It is highly recommended to include the date, time, and the primary selection key used for generating the document. The key should be the same as provided in the prior screens as a selection criteria key.
For Example
A file name ofPayoff_Quote_{month}_{lse_s}can be entered where
{month}= the current month in which document is generated.
{lse_s}= this is the key found in the selection criteria key.
Thelse_sis lessee number for whom the letter is generated for.
The following table explains the tags that can be used to name a document:
Tags Sample Value Description {year} 2019 Current year value that will be used in YYYY format. {month} 201904 Current month value that will be used in YYYYMM format. {date} 20180429 Current date value that will be used in YYYYMMDD format. {hour} 20190429T15 Current time value that will be used in YYYYMMDDTHH format {min} 20190429T1527 Current time value that will be used in YYYYMMDDTHHmm format. {time} 20190429T152751 Current time value that will be used in YYMMDDTHHmmss format.
Enabled
- Optional
-
This field determines whether the document can be used by the workflow module or by dxGeneration
Back/Next/Cancel (Button)
-
(Button) Click on Back button to go to previous screen without saving changes. Click on Next button to save changes and move to the next screen. The Cancel button confirms whether to exit or continue with the update. Select desired option. The Yes button exits from this update without saving changes whereas user will remain on same screen if No button is selected.
Document Summary
Introductory Notes
This is an informational only screen. The fields on this screen will be disabled. The fields on this screen shows the key information of the selected document template to generate. This is the final information U0736 will use to create a document. The information displayed on this screen is gathered from the information provided in the prior screens of this update. Users can use "Back" button to make required changes.
Screen and Fields
Document ID
- Display
-
Displays the document ID provided in the previous screen.
Document Description
- Display
-
Displays the document description provided in the previous screen.
Generated Document Filename
- Display
-
Displays the generated document file name provided in the previous screen.
Enabled
- Display
-
This field determines whether the document can be accessed from the selected workflow module or dxGeneration.
Accessibility
- Display
-
Displays the list of all workflow modules. The selected workflow modules are the modules from where user can access the generated document.
MS Word Template Filename
- Display
-
Displays the MS word template file name provided in the prior screen. If a document already exist with same file name in the defined directory location of U0712 Custom General→Document Generation Customizations then the following message will be displayed as a confirmation to overwrite the existing file. Select Yes or No button as required.
image required.
The template filename will be copied into the document template directory defined in U0712 Custom General→Document Generation Configuration when the Finish button is clicked.
Export SQL
- Display
-
Click on this button to export SQL of this document.
Back/Finish/Cancel Button
- Display
-
Click on Back button to go back to the previous screen without saving changes. Click on Finish button to generate a document. This button will save the changes and generate a document in the specified directory location. Clicking on the Cancel button prompts the following message for confirmation. Select one of the option. The Yes button exits from this update without saving changes whereas user will remain on same screen if No button is selected.
Document Summary (WebMerge)
Introductory Notes
The above screen appears if user has selected WebMerge option from "Document Template Type" screen. The field’s description would be same as of prior screen except the following:
Screen and Fields
WebMerge Document ID
- Display
-
Displays the WebMerge document as provided in the previous screen.
WebMerge Document Key
- Display
-
Displays the WebMerge document key as provided in the previous screen.
Always mereg document in test mode
- Display
-
Displays as set in the previous screen. If this field is selected, then the generated document will be in test mod. This field determines whether to generate a document in test mode by WebMerge. The test mode option of WebMerge prints the watermarks in the generated document.
Back/Finish/Cancel Button
- Display
-
Click on Back button to go back to the previous screen without saving changes. Click on Finish button to generate a document. Clicking this button will save he changes and generate a document in the specified directory location. Clicking on the Cancel button prompts the following message for confirmation. Select one of the option. The Yes button exits from this update without saving changes whereas user will remain on same screen on selection of No button.
Reference Guide |
Table of Contents
© 2025 NETSOL Technologies. All rights reserved.
The information contained in this document is the sole property of NETSOL Technologies, Inc. Use of the information contained herein is restricted. Conditions of use are subject to change without notice. NETSOL Technologies, Inc. assumes no liability for any inaccuracy that may appear in this document nor does it have the obligation to update any of the information contained herein; the contents of this document do not constitute a promise or warranty. The software described in this document is furnished under license and may be used or copied only in accordance with the terms of said license. Unauthorized use, alteration, or reproduction of this document without the written consent of NETSOL Technologies, Inc. is prohibited.
The information contained in this document is the sole property of NETSOL Technologies, Inc. Use of the information contained herein is restricted. Conditions of use are subject to change without notice. NETSOL Technologies, Inc. assumes no liability for any inaccuracy that may appear in this document nor does it have the obligation to update any of the information contained herein; the contents of this document do not constitute a promise or warranty. The software described in this document is furnished under license and may be used or copied only in accordance with the terms of said license. Unauthorized use, alteration, or reproduction of this document without the written consent of NETSOL Technologies, Inc. is prohibited.