Specific Information for installation and use of the database Report Tool used with FTSW100 software.

Transcription

1 Database Report Tool This manual contains: Specific Information for installation and use of the database Report Tool used with FTSW100 software. Database Report Tool for use with FTSW100 versions 2.01 and Separate utility to obtain report files from SQL database used by FTSW100. AA Revision1-0 February 2007 Page 1 of 18

2 Table of contents: 1. Database Report Tool overview Supported FTSW100 versions Requirements Compatibility with console integrated FTSW100 Report Generator Installation of database Report Tool Directory location Running the database Report Tool File Menu Option New Report Generate Report Edit Configuration Open Report Close Report Logon / Logout Logging on to Database Logging off from Database Exit Tool Menu Option Configuration Creating a New Report Configuration Preferences Default column name used Configuration Search Folders Default Output Directory Differences: Database Report Tool - Integrated Report Generator Page 2 of 18

3 1. Database Report Tool overview The database report tool is provided as an application to be used for report file generation in association with FTSW100 software. The database report tool will generate reports by extracting information stored to the SQL database used by FTSW100. The Report Tool provides date and time stamped report files in ASCII format to allow for subsequent review. Typical use of report file is to import within worksheet (e.g. Excel ) or other type of software for viewing selected property values. The database report tool is not accessible from the FTSW100 console and must be run as separate application. It may be run simultaneously with FTSW100. The integrated report generator within console requires stored spectrum files with finite archiving period Supported FTSW100 versions The stand-alone database report tool is compatible for report generation with versions 2.01 and 2.10 of FTSW100. The operating system being either Windows 2000 or Windows XP as per original installation and requirements from factory Requirements The software may be installed with an existing installation of FTSW100 for the purpose of reports to be generated from database. In order for proper operation, the following is required: o Functional SQL database from FTSW100 o Properties stored to database - items not stored to database will not be accessible (e.g. F-ratios, reference diagnostics) unless defined as properties within software configuration for appropriate streams Page 3 of 18

4 1.3. Compatibility with console integrated FTSW100 Report Generator Report file configurations produced for the report utility of FTSW100 are compatible with the database Report Tool, however, some properties may not be reported if not within the SQL database. For example, F-ratio PLSplus diagnostics may not be present in database unless it has been linked with an actual property within the database structure. Generally, only the properties identified within the FTSW100 configuration will be available within the database for reporting with the database Report Tool. The integrated Report Generator provided within FTSW100 has typically increased reporting capability with access to items stored with spectrum files. The integrated report tool can only be used, however, when spectrum files (e.g. ABS) are saved by FTSW100. The report tool from database only requires the SQL database to be accessible. NOTE: The database report tool is not accessible via the Console of FTSW100. It is a separate application accessing the database information generated from FTSW100 software. It may be run in parallel with FTSW100 operation. Page 4 of 18

5 2. Installation of database Report Tool Insert the CD media in appropriate drive and select the installation file to install the utility. The following sequence of screen displays will appear when using recommended default selections by pressing Next until completed. Starting window. Select Next. Directory for placement of Report Tool utility. Recommend use of default for FTSW100 ver 2.01 and Select Next. Page 5 of 18

6 Installation of files for utility. Wait until completed. Installation completed. Select Finish. The last display box will define Finish to complete the installation. The installation process will place the following icon on the desktop to provide shortcut in operation. Page 6 of 18

7 2.1. Directory location The installation will create the directory Report Tool under C:\Bomem\Enablir if default selection is used. A custom location may be chosen when Choose Destination Location window appears during install sequence. If chosen with Change button, then a directory for placement of utility may be defined. The standard Windows explorer locator for directories is used. The chosen directory must exist on the hard disk, as no option to create is possible. The default directory upon installation for storage of report files is C:\FTSW100 reports. The directory will be created if not existing during installation. The default output directory may be later changed via Tool and Preferences within the utility. Page 7 of 18

8 3. Running the database Report Tool To run the utility for generation of reports from FTSW100, double click on the icon Report Tool located on the desktop screen. Upon startup of utility, there will be short delay while existing report configurations are read and prepared for subsequent use. The main display for utility is as shown on the right. There are File, Tool and help options on menu bar File Menu Option The File menu is typically main interface to report file generation. The options for New Report, Open Report, Close Report, Logon / Logout, and Exit are available. Page 8 of 18

9 New Report The new report option provides definition of which report configuration to be applied and for what date and time interval. In cases where the report configuration is defined, then it is possible to select the desired report and appropriate date and time from and to. The last configuration in listing is shown while others may be viewed by selecting drop down box to side. The date is selected with use of calendar when box chosen. The time may be selected using drop down box for selection of hour (00 to 23) and minutes (00 to 55 in 5 minute steps) Generate Report Once the date and time covering from and to period and configuration is defined, the report file can be obtained by pressing button Generate Report. Only report configurations available to the tool will be displayed in Configuration line and may be changed using drop-down box to change or assign report configuration desired. If no configuration is displayed, then one must be created. WARNING: Long report periods with large # of properties may take long time. The period from and to should be limited ONLY to days available in database. That is, if 10 days defined for data saving, do not extend beyond 10 days. Extending date will cause longer delay for report to be generated. Page 9 of 18

10 The saving of report file will be verified for name and location by default. This may be removed to use default naming and location without confirmation via Preferences option under Tool. A short delay in preparing report will occur depending upon size and time period of report defined. Once completed, the report will be displayed in worksheet type format with date and time (local PC setting) in leftmost column and defined properties from configuration in remaining columns. NOTE: Detail on preparing or modifying configurations is detailed separately in the document. Refer to Configuration option for detail Edit Configuration If the report configuration is to be modified, viewed, or a new one created, then one may select Edit Configuration. By pressing the Edit Configuration option, the user is brought to basic Configuration Manager for report information. This is the same basic functionality when choosing the main menu option Tool and Configuration sub-menu item. Refer to section Tool Menu Option section for detail on associated functionality for report configuration management. Page 10 of 18

11 Open Report The option to open report allows for currently saved reports to be re-opened and viewed within the worksheet Close Report The option to close report allows for currently open report to be removed. NOTE: It is recommended to always close the report after generating or opening a report. This ensures any previous report is removed from memory Logon / Logout The Logon and Logout options allow for access to the SQL database as used by FTSW100. As the Report Tool requires access to the database to create and generate reports, then the access rights to database must be established. When Logon option is viewed in menu listing, then there is no current logon. When Logout option is viewed in menu listing, then there is current access to SQL database via tool assigned. NOTE: It is recommended to not keep access to SQL database active if not being used for report generation needs Logging on to Database When using Logon option or else when creating or generating a configuration or report, the SQL database used by FTSW100 must be accessed with appropriate control with username and password required. The Username and Password is the same as required for running of FTSW Logging off from Database Use Logout option to release access rights to SQL database from Report Tool Exit Use the Exit option to close the Report Tool application. By exiting the application, the rights to access to database are automatically closed (i.e. automatically logged out). Page 11 of 18

12 3.2. Tool Menu Option The File menu is typically main interface related to report file configuration management and also for setting of base level preferences of Report Tool. The options Configuration and Preferences are available Configuration Selecting Configuration option will start the report Configuration Manager. There are four basic options: 1. OK. Selecting OK will simply close the Configuration Manager. When used in process to generate a new report, the selected report configuration will be used. 2. New. Selecting New will start sequence to prepare new report configuration. 3. Modify. Selecting Modify will allow changes to the desired report configuration to be applied. 4. Delete. Selecting Delete will cause currently selected report configuration to be deleted. [Should be used carefully.] Creating a New Report Configuration Creating a new report configuration will follow a wizard-like process to define name of report configuration and allow selecting stream and property information from database to be viewed within a report. The new report configuration name to be entered and used for subsequent reports generated from tool. Use a name that is meaningful for later use.. Only one stream with associated properties may be defined per report. The available streams for report as available from within the SQL database will be displayed Page 12 of 18

13 Select the desired stream and then Next >. The properties from the selected stream will then be displayed. The number of properties will be directly dependent upon the FTSW100 configuration. Page 13 of 18

14 The properties to be included to the report configuration can be selectively chosen oneby-one (Add>) or by lump of all properties (Add All>). To select desired properties to be placed to report, the property in listing can be viewed and desired property selected by either up and down viewing or by selecting directly with mouse. Once selected, a property may be added and will be shown on left listing. Properties to be removed from report follow the reverse procedure as above. If the initial stream is desired to be changed, then the option to go <Back is possible. If the configuration is to be aborted, then the option Cancel may be used. Once desired properties have been selected for report, then press Next> or Finish. Finish will complete wizard interaction and freeze report configuration. Page 14 of 18

15 Pressing Next> will bring an intermediate step in configuration allowing for customization of column titles and also the column order as defined to the report file. The names from FTSW100 will carry long named identifiers specific to the FTSW100 configuration and property. This may be simplified if desired by selecting property name, which will default as column name in report, and modifying name or by rearranging order as desired. Page 15 of 18

16 Preferences The Report Tool preferences may be customized as matter to simplify repeated use of the tool. Typical need for modification may include requirement to change default directory for report file storage Default column name used Use of long names or formatted short as desired. The recommended use is to use formatted short names by default unless there is real need for differentiation between properties. Page 16 of 18

17 Configuration Search Folders Defines directory for report tool utility to review for any existing report file configurations existing or defined for FTSW100 application. Versions 2.01 and 2.10 of FTSW100 have default location (C:\Bomem\Enablir) for report configurations included on installation Default Output Directory The output directory to place report files generated with tool. By default, the placement will be C:\FTSW100 Reports. For convenience, it is recommended to place in an easy access location. Typical use to extract reports may include removal of reports from the PC unit via a USB key or other such media employed. For cases where the report file will be routinely generated using the Report Tool, there is option to avoid prompting of storage location and verification of file name. If selected, it should be noted that any report generated will take default file naming associated with report configuration name and date period and, also, that it will be placed to directory without option to select. NOTE: The report file generated will over-write any existing file with same date period is defined. If to be changed, then it must be defined when prompted in saving. Page 17 of 18

18 4. Differences: Database Report Tool - Integrated Report Generator The primary differences of the database Report Tool as compared to the integrated version within FTSW100 are outlined below. o Property results are taken from SQL database directly and not from Spectrum files. o Values not present in the database will not be accessible. The values must be defined as properties within the FTSW100 configuration to be logged within the database. o The Report Tool is not accessible within the console and must be run as separate application in parallel to FTSW100. o The report Tool requires a logon to database in order to maintain security aspect. The standard user and password applies as used by console. o Screen display is different while primary functionalities are the same. o Added feature to display report in worksheet format after generating report. Simpler than viewing in text. o Requesting date periods outside of available time of database will extend time duration to retrieve report. The results from database are requested at 1-hour intervals within date period defined for report. Page 18 of 18