Arendar 2005 Report Utility User Manual
Contents
1. Parameters Serial Number Is Null lt Param Serial Number IsNull gt 1 AND lt Column gt 15 NULL VI Technology Inc 5 9 Arendar Report Utility User Manual Plugins NULL and NOT NULL parameters require additional evaluation parameters Suppose you specify a Serial Number that can be NULL The parameter tree creates additional parameters for NULL inputs to help you handle nullable criteria The Is Null parameter returns 1 if the parameter value is NULL or O otherwise The lt Param Serial Number IsNull gt 1 AND lt Column gt IS NULL string evaluates a criteria based on nullable parameters WHERE lt Param Serial Number IsNull gt 1 AND PRD_9 UUT Serial Number IS NULL If the Serial Number parameter is specified to be NULL the previous logical expression evaluates to True for those records where Serial Number is null If the Serial Number parameter is NOT NULL this logical expression always evaluates to False because the first half of the expression evaluates to 0 1 Query Testing Click the Test button to interactively edit and execute queries When executed the selected queries in the Query Plan control shown in Figure 5 10 are executed After completion selecting different queries in the Query Plan control displays the query string and results for that query You can modify all query strings directly from this dialog box D Query Plan Tester We2. VI TECHNOLOGY Arendar 2005 Report Utility User Manual Month 2005 12345 67 Contact VI Technology Inc 3700 W Parmer Ln Ste 200 Austin TX 78727 512 327 3348 info vi tech comwww vi tech com Copyright Under the copyright law this publication may not be reproduced or transmitted in any form electronic or mechanical including photocopying recording storing in an information retrieval system or translating in whole or in part without the prior written consent of VI Technology Inc Trademarks Arendar is a registered trademark of VI Technology Inc VI Technology is a trademark of VI Technology Inc Products and names listed are trademarks or trade names of their respective companies 2003 2004 VI Technology Inc All rights reserved Contents About This Manual Ore ani Z ation EE v UM te v Related Documentation ee eecesceseesseeesecsseceeeeseeeseecsaecsaesseceaeeeaeesaecaecsseeeeeeaaecnaeens vi Chapter 1 Arendar Test Data Management System OVERVIEW AE LESSER 1 1 E Ota genge edb didacticas 1 1 Deploying Arend ar ege 1 2 Arendar System Database AAA 1 3 Ee ren EEN 1 4 Test Hierarchy cesses tienen oe ea i aay eel a eee ee 1 4 Chapter 2 Introduction to the Arendar Report Utility OVENI E Worta tegt erter Eeer eren Eeer EE 2 1 User Rolesor ae ates eee eee eee 2 1 Report Utility Interface cecilia iii 2 2 Main UA 2 2 Ele Menu tn at lle 2 2 Kap et de dE AE AE AE AER 2 3 TEE 2 3 EI 2 3 ele HE 2
3. Description ES Operator Name Part Name Part Number Part Version ES Pass ES Result String ES Result Value ES Station Id ES Test End Date EB Test Start Date Test Version EBUUT Serial N Custom Pr ES meu STRING 255 Date STRING 255 STRING 255 STRING 100 STRING 100 STRING 50 Boolean STRING 255 Double STRING 255 Date Date STRING 50 STRING 255 STRING 255 Ned Zhang 04 21 2003 Sample Product Sample Product 4 20937 1 0 1 0 RED Figure 1 5 Execution and Configuration Properties in a Test Procedure The Results Data portion of the Arendar system database is the information that is written to the Arendar TDM database at test runtime to store an instance of test results You create an object representing a Product Test Execution through calls to the Arendar API The Product Test Execution object retrieves configuration parameter data and execution properties from the Test Structure side of the Arendar Database During a test execution Execution Properties and Results Tables are populated with values The Arendar system marks each test execution with a unique execution ID VI Technology Inc 1 5 Arendar Report Utility User Manual CHAPTER 2 Introduction to the Arendar Report Utility This chapter describes the function and user interface of the Arendar Report Utility Overview The Arendar Report Utility enables Arendar users to develop and publish programm
4. This chapter describes the purpose structure and components of the Arendar test data management TDM software and the Arendar System Databse Overview The Arendar TDM software package is a scalable set of applications for configuring storing retrieving and reporting test data Arendar has NET ActiveX and COM interfaces so that you can use any development environment to manage your test data Components Arendar includes the following modules and applications e Administration Utility Configures Oracle Microsoft SQL Server and Microsoft SQL Server 2000 Desktop Engine MSDE databases for storing automated test station data e Dashboard Runs on the Web server and provides encryption and security to access data and reports of any test station from any PC connected to the Internet e Data Viewer Retrieves data and generates analytical charts from the database e Server Module Interfaces the Oracle Microsoft SQL Server or Microsoft SQL Server 2000 Desktop Engine MSDE centralized database with all test stations e Station Client Communicates between your test station and Arendar Server Module with NET ActiveX and COM interfaces to send your test results into Arendar TDM system database e Data Import Agent Runs as a background process that analyzes and imports data from legacy applications into the Arendar TDM system e Data Import Wizard Walks the user through the process of mapping and converting legacy
5. al Excel Report Provides automated report generation with Microsoft Excel super 8 6 2004 7 09 34 AM super 9 21 2004 7 44 07 AM Figure 6 2 Plugin Manager You can upload the NET assembly containing the plugin to the database as a BLOB Binary Large OBject When the Report Utility requires a plugin it loads the plugin from the local computer and checks the plugin version against the latest version in the database If the plugin does not exist locally or the version is out of date the report utility automatically downloads the latest assembly from the database and loads the plugin dynamically Plugins can also define the actions and attachments that they support The plugin s specific actions and attachments are used during report development Arendar Report Utility User Manual 6 2 vi tech com APPENDIX A Troubleshooting For more information about the Arendar Administration Utility contact VI Technology by visiting www vi tech com or by calling 512 327 3348 VI Technology Inc A 1 Arendar Report Utility User Manual Index A administration utility 1 1 Arendar deployment 1 2 Arendar Report Utility See report utility 2 1 Arendar test data management system See test data management system C communication settings 3 3 components test data management system 1 1 configuration properties 1 4 customizing reports 6 1 D dashboard 1 1 data import agent 1 1 import wizard 1 1 viewe
6. communication configuration options Database Settings Database System Type The Database System Type setting determines which database system Arendar uses The options are Microsoft SQL Server and Oracle Database When using MSDE select Microsoft SQL Server Database Server Name Database Service Name For the Microsoft SQL Server the Database Service Name is the name of your database server The name can be a partially or fully qualified Domain Name Server DNS name for example myserver mydomain com Arendar Report Utility User Manual 3 2 vi tech com Chapter 3 For an Oracle Database the Database Service Name is the net service name of the Arendar database You can configure the net services using the Oracle Net Manager utility Database Catalog Database Schema Name For the Microsoft SQL Server the Database Schema Name is the name of the database catalog you are using for example MyDatabase For an Oracle Database this is the username schema under which the Arendar system stores the data Use Windows NT Integrated Security This setting enables the database to use the Windows NT integrated security option This allows the clients to connect using the Windows user that is currently logged on in that computer Use Specified Username and Password This setting allows clients to connect to the database server using the specified name and password System Settings Working Folder Path The Working Folder Pat
7. Binary Large OBject which can be downloaded for editing D Icon Manager File View Dx General ig BarChart_01 Arendarico ES fal x alt BarChart_02 4KB Bei ChartSettings see renga J Database gt ea RS Excel Description IK Filter_remove2 Find L Hyperlink Navini Print DAReport dmin E Repo Created By l Root Created Date 3 16 2004 10 22 40 AM RH Save Modified By QAReportAdmin 2 sort Sphere_Blue fm lt Modified Date 3 16 2004 10 22 41 AM Count 21 Figure 6 1 Icon Manager Plugin Manager The Plugin Manager shown in Figure 6 2 is launched from the Tools menu Report Administrators only A plugin is a NET assembly with a public creatable class implementing the VITechnology Arendar CustomReports IPlugin interface Plugins can be created edited and deleted All edits are final Also plugins can be imported from and exported to XML from the File menu Plugins support automatic code updates from the Arendar database A default icon is selectable for each plugin definition You can develop plugins and add them to the Arendar Report Utility for custom report types O VI Technology Inc 6 1 Arendar Report Utility User Manual Report Managers ES Plugin Manager Pie View Excel Report Icon 2 Hyperlink Plugin Name Description Created By Created Date Modified By Modified Date o General Assembly Action Tags Attachment Tags
8. Start Date and End Date values of lt ANY gt specifies no date restrictions on the query The parameter tree creates additional parameters for optional inputs to help you handle optional criteria The Is Any parameter returns 1 if the parameter value is lt ANY gt or 0 otherwise The lt Param End Date IsAny gt 1 OR lt Criteria gt string evaluates a criteria based on optional parameters In this example the WHERE criteria string would be WHERE lt Param Start Date IsAny gt 1 OR PRD_3 Test Start Date gt lt Param Start Date gt AND lt Param End Date IsAny gt 1 OR PRD_3 Test End Date lt lt Param End Date 1Day gt if the Start Date parameter is left as lt ANY gt lt Param Start Date IsAny gt 1 In that case the WHERE criteria lt Param Start Date IsAny gt 1 OR PRD_3 Test Start Date gt lt Param Start Date gt would always evaluate to True because the first half of the logical expression would be 1 1 which is always true When you select lt ANY gt the first expression in the WHERE criteria is always short circuited to True If you enter a value other than lt ANY gt the first half of the logical expression would be 0 1 which is always False In that case the WHERE criteria is determined by the second expression after the OR NULL and NOT NULL Parameters
9. lt ANY gt RIK GEG Figure 5 4 Parameters Tab General Tab You can display Parameters using two input control types e TextBox Allows the use to enter text directly e ComboBox Allows the developer to display a list for the user to choose from You can specify the parameter name default value and data type Available data types are Boolean Date Double Integer and String You can also specify whether the input parameter is required accepts a NULL value or accepts a NOT NULL value NULL is a database field value representing an empty or null field VI Technology Inc 5 3 Arendar Report Utility User Manual Plugins A value of lt ANY gt specifies that the operator has chosen not to provide a value for the parameter and is not a valid input for required parameters You can select default values of NULL NOT NULL lt ANY gt and dates from the parameter menu button on the right of the parameter default value 5 Parameter Editor Name Serial Number Data Type Sting Required Control Type ComboBox Allow Null Allow Not Null I r r Default Value lt ANY gt EN E Description Tuut Figure 5 5 General Tab ComboBox Tab The ComboBox tab shown in Figure 5 6 contains parameter attributes specific to ComboBox parameter control types You can specify the drop down style to use with the ComboBox The drop down styles are as follows e DropDown User can selec
10. to 12 31 1999 23 59 59 would be included The day 1 1 2000 would not be included in the returned values as you might expect To resolve this problem use the 1 day parameter in the WHERE string instead WHERE PRD_3 Test Start lt lt Param End Date 1Day gt End Date Date gt lt Param Start Date gt AND PRD_3 Test This will add one day to the End Date value you entered effectively making the End Date inclusive Boolean Parameters Parameters Pass ls True ls False Boolean parameters return 1 if True or O if False Boolean parameters have special values of Is True and 1 Is False These parameters return 1 if the expression evaluates to True or 0 otherwise If you enter False into a Boolean parameter the Boolean parameter returns 0 the Is True parameter returns 0 and the Is False parameter returns 1 Arendar Report Utility User Manual 5 8 vi tech com Chapter 5 Optional Parameters Parameters Start Date Is Any 1 Day lt Param Start Date ls4ny gt 1 OR lt Criteria gt End Date Is Any 1 Day KParam End Date Is ny gt 1 OR lt Criteria gt UI Optional parameters add an extra level of complexity Suppose you specify optional Start and End dates Both parameters have default values of lt ANY gt Selecting lt ANY gt means there is no limit on that parameter Having both
11. vi tech com Chapter 1 Test Administration Software Utility Station Data Client Browser Dashboard Database Server Figure 1 2 Arendar Single Test System Environment Refer to the Arendar 2005 Developer Manual for information on using the Server and Station Client Arendar System Database The Arendar system implements a TDM system database that stores Test Structure and Results Data as shown in Figure 1 3 Database Figure 1 3 Arendar System Database VI Technology Inc 1 3 Arendar Report Utility User Manual Arendar Test Data Management System Test Structure The Test Structure contains all structural information including hierarchical and specific information about each Product Test Test Procedure and Results Table A Product Test is a top level test object that holds information specific to the product such as the product name part number version description and pass fail result on the test for that product A product can be a physical device under test or any other type of test that can produce a pass fail result or return a measurement such as measuring air quality A Test Procedure is an object related to a product test that holds information specific to a test step or a test plan The test procedure stores calculated single value results of the test such as signal averages signal maximum signal minimum dynamic range and distortion calculations as well as the pass
12. 3 bake GE 2 3 EXPORT EE 2 3 FEA stiecht duced ea shaasscauseneden EEEE E E E idas 2 3 View Mel acta na 2 3 Fools Me EEN 2 4 Plugin Manset oneroso necia 2 4 CA AA RN TO 2 4 Help Melia lil a a 2 5 Comi ii a lili ads 2 5 About Arendar Report Utility ooonconncnncnnncnocococnnoncnancnn nono nonnncnnncna nono n con acns 2 5 About VI Techn logy ssscissssecusssiesetsssoresscngteesuseduesscnstbtteanentsepessssqaeehuteouesaden 2 5 Chapter 3 Installation and Configuration Installing the Report Utility iia Bs ee RAG BG nee tenes 3 1 Logging OA hae hee 3 1 Database EE 3 2 VI Technology Inc ill Arendar Report Utility User Manual Contents Database System Type miis ere ea ie ie 3 2 Database Server Name Database Service Name 3 2 Database Catalog Database Schema Name 3 3 Use Windows NT Integrated Security ee eeceseeseeeeeeeseeeeceeeeseeeneeenee 3 3 Use Specified Username and Password 3 3 Working Polder Path iso gudde ores dE a AE neta 3 3 If Database is not available oo cece cssccesseceeececenceceeeesaeceeaaeseaaeceeeeeeeeesas 3 3 Enable Use of MSMQ to Send and Receive Test Data oooooccnncccncnonccncconns 3 3 Use Local Intermediate les 3 4 Write Test Data Directly to Database AAA 3 4 Arendar Update Manager 3 4 Chapter 4 Running a Report Chapter 5 Plugins Velilla tind Givi tie a ee eco ee 5 1 Hyperlink UE EE 5 1 Excel Plusi count ellas arta 5 2 General E GE 5 2 IEN Ke EE 5 2 Parameters TDi ged 5 3 VE EHM Ke D
13. All child objects will be deleted as well Edit Select Edit to alter the settings of the selected report Refer to Chapter 5 Plugins and Chapter 6 Report Managers for more information on editing reports Import Select Import to add a report onto your system from an XML file Export Select Export to automatically save all reports listed in the Report Utility in XML format Exit Select Exit to exit the Report Utility View Menu Select View Refresh to refresh the list of reports in the Report Utility window and display any changes made to reports by other users on the network VI Technology Inc 2 3 Arendar Report Utility User Manual Introduction to the Arendar Report Utility Tools Menu The Tools menu contains two options Icon Manager and Plugin Manager shown in Figure 2 3 5 Arendar Report Utility Fie View MEAS Help Icon Manager EI plugin Manager BGS Wu Base Station Mig Report bia URL Created By Created Date Modified By Modified Date Plugin Plugin Version Post to Web Description Test Default super 11 15 2004 3 20 01 PM super 11 15 2004 3 40 34 PM Excel Report 1 0 1736 23986 Figure 2 3 Plugin Manager The Plugin Manager allows you to change the plugin utility of a report Tools Menu Refer to Chapter 5 Plugins for more information about using the Plugin Manager Icon Manager The Icon Manager allows you to create add and chan
14. EE 5 3 ComboBox Taberna 5 4 Queries Tare A AA RAE NT eed 5 6 Date Paranti nec a EEN Ne 5 8 Boolean Parameters otitis tieso 5 8 Optional Parameters aia ii fle eee 5 9 NULL and NOT NULL Parameter 5 9 Query Tesei inicia 5 10 ee EN KC EE 5 11 Report Bases ici it ltd 5 11 ee id els 5 11 Attachments Ta a lino antes 5 12 Chapter 6 Report Managers Toon Managers AA A NO ANN 6 1 Plusi Manera a a nets 6 1 Appendix A Troubleshooting Arendar Report Utility User Manual iv vi tech com About This Manual The Arendar Administration Utility User Manual provides information about using the Arendar Administration Utility as part of an Arendar Test Data Management TDM System This manual is intended for test system developers and administrators Organization This document is organized as follows Chapter 1 Arendar Test Data Management System describes the components and deployment of the Arendar Test Data Management system and the structure and function of the Arendar System Database Chapter 2 Introduction to the Arendar Report Utility Introduction to the Arendar Report Utility describes the function and use of the report utility software Chapter 3 Installation and Configuration describes the product interface and provides instructions for installing launching and configuring the Report Utility and lists database system and communication setting options Chapter 4 Running a Report describes how to specify parameters an
15. Execute F5 First Pass Yield Query String Defects Group Counts SELECT TBL_5 Defect Category AS Defect Category Count as Defect Count FRI OM ProductT ests Def SName SPC Defect Data PRD_3 Results Defects Group Counts Defect Categ Defect Count Scratched 322 Dented 269 Warped 165 Too Long 148 Fractured 114 Too Short 104 Bad Cast 27 Execution Time 14 561 seconds D jetumed Records 7 Figure 5 10 Query Plan Arendar Report Utility User Manual 5 10 vi tech com Chapter 5 Actions Tab Use the Actions tab shown in Figure 5 11 to perform actions with the parameters and query results entered by the user Y Excel Report Noise Test Report General Details Parameters Queries Actions Attachments Actions Count 3 Action Query Parameter Details gt Excel Insert Quer Noise Test Query Raw Data A1 Excel Activate C Raw DatalAl Excel Activate W Noise Report o laz Figure 5 11 Actions Tab For the Excel Plugin the following actions are available EN IN EEN Report Base e Execute Query Forces the report utility to execute a query This is typically not required because queries are automatically executed This action provides developers with exact control of query execution when memory management is a concern e Unload Query Forces the report utility to unload query results from memory This is typic
16. al Plugins Queries Tab Use the Queries tab shown in Figure 5 8 to create the queries needed to retrieve report data A report can be composed of multiple queries with results dependent on the input parameters entered by the user For example a report query might return different results based on the value of a Serial Number parameter entered by a user F Excel Report Base Station Mfg Report General Details Parameter Queries Count 17 Name Yield First Pass Yield Failing Units Failing Stations Histogram Data Histogram Data Histogram Data Histogram Data Histogram Data Histogram Data Histogram Data Histogram Data Query Type Query String Defects Total Coun OQL Defects Group Cou OQL DAL OGL OOL DOL BL DaL DaL UL OGL DAL oL oL SELECT Count as Total Defect Count FRI SELECT SELECT CAST Query_1 PassCount AS floal SELECT CAST QRY_FirstPassPassing Cour SELECT TOP 7 Count AS Failure Count SELECT TOP 7 ORY_PASSING Station ID SELECT Count AS Samples SELECT Count AS Count SELECT Count AS Count SELECT Count AS Count SELECT Count AS Count SELECT Count AS Count SELECT Count AS Count SELECT ae AS Count Test KIKI EI E Figure 5 8 Queries Tab The query editor dialog box shown in Figure 5 9 allows you to specify a query name type OQL or SQL and query string To aid in creating the query string
17. ally not required because queries are automatically unloaded upon report completion This action gives you exact control of query resources when memory management is a concern as is the case with a report containing many large queries Excel Report e Insert Query Inserts query contents into an Excel workbook at the location specified by the worksheet and cell e Insert Query with Heade Inserts query contents and header information into an Excel workbook at the location specified by the worksheet and cell e Insert Parameter Inserts parameter contents entered by the user into an Excel workbook at the location specified by the worksheet and cell e Insert Parameter with Header Inserts parameter contents and header information entered by the user into an Excel workbook at the location specified by the worksheet and cell VI Technology Inc 5 11 Arendar Report Utility User Manual Plugins e Execute Macro Executes the specified macro If the report is to be posted to the Web macro code that displays dialog boxes forms or other user interface components generates an error in the Arendar Web Dashboard e Activate Worksheet Activates the specified worksheet in an Excel workbook This is typically done at the end of report generation just before saving so that the desired worksheet is activated on next open e Activate Cell Activates the specified cell in an Excel worksheet This is typically done at the end of report ge
18. atically generated reports in a multi user environment The utility allows for automation of complex reports using report plugins Plugins generate a specific kind of report such as Excel text or HTML Depending on the plugin text images plots and hyperlinks can all be incorporated into the final report After a report has been defined by a report developer any Arendar user can generate the report directly from the report utility or on the Web through the Arendar Web Dashboard The Report Utility supports importing and exporting serializing to XML files of all objects User Roles The following permissions are granted by the Arendar Report Utility to the three classes of users e Report Developer Permissions to create edit and delete reports and icons e Report Administrator Permissions to modify icons and plugins e All Arendar users Permissions to execute reports Table 1 User Roles Tasks Report Administrator Report Developer All Arendar Users Edit Plugins Yes Edit Icons Yes Edit Reports Yes Run Reports Yes Yes Yes O VI Technology Inc 2 1 Arendar Report Utility User Manual Introduction to the Arendar Report Utility Report Utility Interface Main Window The main report window shown in Figure 2 1 displays all the reports available in the Arendar database 5 Arendar Report Utility File View Tools Help o D Ge 184 Report Sum
19. d run a report in the Arendar Report Utility Chapter 5 Plugins provides instructions on using the Icon Manager and the Plugin Manager to customize reports Chapter 6 Report Managers describes how to use the plugins that ship with the Arendar Report Utility software Appendix A Troubleshooting provides contact information for VI Technology Conventions The following conventions are used in this document Bold text indicates user interface elements menu commands and options Bold Arial text indicates classes methods properties and objects Courier text indicates text entered by the user code examples literal values pathnames filenames and extensions Italic text indicates document titles and key terms lt name gt is a string that is replaced by actual values parameter is a string that is an optional parameter in a command VI Technology Inc v Arendar Report Utility User Manual About This Manual Related Documentation The following documents provide additional information about the Arendar application e Arendar 2005 Developer Manual Provides a comprehensive description of all classes properties and objects available for each of the supported programming languages e Arendar 2005 Data Viewer User Manual Describes how to use the Arendar Data Viewer for viewing and retrieving test data Arendar Report Utility User Manual vi vi tech com CHAPTER 1 Arendar Test Data Management System
20. data files for importing into an Arendar TDM system This application also generates that configuration files used by the Data Import Agent O VI Technology Inc 1 1 Arendar Report Utility User Manual Arendar Test Data Management System Deploying Arendar You can deploy Arendar in either of the following environments e Implement Arendar in an enterprise environment as shown in Figure 1 1 to create a TDM system with multiple test stations saving test data into a single database You also can have multiple clients that use either the Data Viewer or the Dashboard components to review data stored in the database e Implement Arendar as a stand alone system in a single test station environment as shown in Figure 1 2 to create a self contained system that administers the test stores the data and results on a database located in the system and then allows you to view the data using tools residing on that system Data j Ii crower HEE re as ET DO SCH Dashboard cs Le A Manutacturing Research and Design aca SST Industry Standard Database dE Administration E Data za Utility E Browser om a pu Dep ra CE Ls Lesch 5 Dashboard Ki Server JE Browser H Dashboard Figure 1 1 Arendar Report Utility User Manual Arendar Enterprise Envorinment 1 2
21. fail result of the test step or test plan A Results Table holds one dimensional 1D or two dimensional 2D tabular data from your tests such as raw waveform data measured by the test system and analyzed data array results like spectral analysis Test Hierarchy Figure 1 4 shows the test hierarchy of the Sample_Product_A_Test which is made up of the In_Process_Test and Final_Test Test Procedures and a Waveform_Table Results Table E Sample_Product_4 Test E In_Process_Test E Dutput_Test FF Waveform_Output_Test ES Waveform_Table Total_Power_Test E Final_Test E Dutput_Test Waveform_Output_Test Total_Power_Test Figure 1 4 Sample_Product_A_Test Test Structure For each Product Test and Test Procedure the Test Structure includes Configuration Properties as indicated by the icon and Execution Properties as indicated by the EB icon Configuration Properties are those attributes that describe the test They include properties such as Test Version or Part Number as shown in Figure 2 1 Main Report Window Execution Properties are those attributes that are meant to store test data during an execution Operator Name Result Value and UUT Serial Number are examples of Execution Properties Their values are populated during test runtime Arendar Report Utility User Manual 1 4 vi tech com Properties Chapter 1 Name Data Type Value System Pr Created By Created Date
22. ge icons in your Report Utility interface Refer to Chapter 6 Report Managers for more information about using the Icon Manager Arendar Report Utility User Manual 2 4 vi tech com Chapter 2 Help Menu Use the Help menu shown in Figure 2 4 to get additional information about VI Technology and the Arendar software F Arendar Report Utility OB Is Contents About Arendar Report Utility tion About YI Technology E test Default Created By super Created Date 11 15 2004 3 20 01 PM Modified By super Modified Date 11 15 2004 3 40 34 PM Plugin Excel Report Plugin Version 1 01736 23986 True Figure 2 4 Help Menu Contents Select Help Contents to open the HTML version of the Arendar 2005 Report Utility User Manual About Arendar Report Utility Select Help A bout Arendar Report Utility to display version information about the software About VI Technology Select Help A bout VI Technology to display information regarding VI Technology Inc O VI Technology Inc 2 5 Arendar Report Utility User Manual CHAPTER 3 Installation and Configuration This chapter provides instructions for installing launching and configuring the Report Utility and lists database system and communication setting options Installing the Report Utility TBD Installer not developed yet Logging On When you first launch the Arendar Report Utility a Logon windo
23. h is the full path to the folder the client uses as the main working folder The default value is a folder named ClientDataFolder located within the installation root directory If Database is not available This combo box provides a set of options to load the client test definitions while the database is not accessible The options include Load Local Catalogs Silently Load Local Catalogs Verbosely or Do Not Load Local Catalogs Communication Settings Enable Use of MSMQ to Send and Receive Test Data This setting configures the Arendar client to send data to the server using Microsoft Message Queue MSMQ as the transfer method For this setting you must install and configure the Arendar Server to support MSMQ e Queue Server Address Enter the name or address of the server configured to handle MSQM The address can be a partial or fully qualified DNS name for example myserver mydomain com e Server Queue Name Enter the name of the MSMQ queue configured on the server The default is DMServerQueue VI Technology Inc 3 3 Arendar Report Utility User Manual Installation and Configuration Use Local Intermediate Files This setting specifies the remote location to which data are written before they are sent to the database If the network is not available the system ensures the transfer at a later time After the intermediate files are transferred to the specified remote location the server processes the files and e
24. mary Base Station Mfg Report Y Gia E tes URL Default Created By super Created Date 11 15 2004 3 20 01 PM Modified By super Modified Date 11 15 2004 3 40 34 PM Plugin DI Excel Report Plugin Version 1 0 1736 23986 Post to Web Description Figure 2 1 Main Report Window The main report window contains a list of available reports on the left and a Report Summary on the right The Report Summary includes report type history URL plugin interface and developer comments File Menu From the File menu shown in Figure 2 2 reports can be imported from and exported to XML files You use the toolbar buttons to create edit delete and execute reports 5 Arendar Report Utility ON View Tools Help Run Cp New Delete Del SI test Edit CHE Default Import Export Created By super Created Date 11 15 2004 3 20 01 PM Modified By super Modified Date 11 15 2004 3 40 34 PM Exit Alt F4 Plugin Excel Report Plugin Version 1 0 1736 23986 Post to Web Description Figure 2 2 File Menu Arendar Report Utility User Manual 2 2 vi tech com Chapter 2 Run Select Run to launch the report selected in the report list displayed in the main window Refer to Chapter 4 Running a Report for more information New Select New to generate a new report in the application chosen from the New submenu Delete Select Delete to delete the object selected in the report list
25. neration just before saving so that the desired cell is activated on next open Attachments Tab Use the Attachments tab shown in Figure 5 12 to upload an Excel workbook template x1s to the database for use when generating the report If left empty or cleared the Excel plugin creates a new Excel workbook when run with default worksheets of Sheet 1 Sheet 2 and Sheet3 J Excel Report Noise Test Report General Details Parameters Queries Action Excel Workbook Template 44 Noise Test Report xls Bl x Template Size 27 KB Cancel Sek Figure 5 12 Attachments Tab Developing an Excel template is an iterative process where the report under development is run and the created workbook is populated with data You format the data by creating charts tables text and images until an acceptable report is created Then you delete the data inserted by the report utility upload the final empty template into the report definition and save Arendar Report Utility User Manual 5 12 vi tech com CHAPTER 6 Report Managers This chapter provides instructions on using the Icon Manager and the Plugin Manager to customize reports Icon Manager The Icon Manager shown in Figure 6 1 is launched from the Tools menu Report Administrators only Icons may be created edited and deleted All edits are final Icons may be imported and exported to XML from the File menu The icon file is saved to the database as a BLOB
26. nters the data into the database The Remote Files Path is the remote location where the intermediate files are placed for later processing by the Arendar System server Write Test Data Directly to Database This setting specifies that the Arendar System writes data directly to the database You must install either SQL Server or Oracle on the client machine EI Note This option does not provide protection if the network goes down Arendar Update Manager After a successful logon the Arendar Report Utility checks the database for current component versions The software automatically downloads and installs the latest versions of sub components if necessary Arendar Update Manager da Downloading latest version of DMReport dll Downloading DMReport dll Figure 3 3 Arendar Update Manager Arendar Report Utility User Manual 3 4 vi tech com CHAPTER 4 Running a Report This chapter explains how to specify parameters and run a report in the Arendar Report Utility Any Arendar user can run a defined report Highlight the report to execute and select Run from the File menu or click the Run toolbar button Depending on the report plugin a report configuration interface displays If the plugin utilizes the default report configuration window a report window with the report title description and optional image displays along with any defined parameters needed to generate a report Figure 4 1 shows the configuration wind
27. ow for a Noise Test report that requires you to enter the desired serial number to report on Required parameters have an asterisk next to the parameter label A value of lt ANY gt signifies no value entered for that parameter and is not a valid value for a required parameter After you specify all relevant parameters click the Create Report button The Report Utility generates the report based on the input parameters L Report Configuration Noise Test Report This report presents the waveform captured from 4 noisy sinewave generator This report can be downloaded for inspection as an Excel workbook Report Configuration Serial Number lt ANY gt A96568 Required Create Report Cancel Figure 4 1 Report Configuration Window VI Technology Inc 4 1 Arendar Report Utility User Manual CHAPTER 5 Plugins This chapter describes how to use the plugins that ship with the Arendar Report Utility software Overview A plugin is a NET assembly with a public creatable class implementing the ViITechnology Arendar CustomReports IPlugin interface Plugins allow the Arendar Report Utility to generate a number of report types Plugins they support automatic code updates from the Arendar database and can be imported and exported to XML You can develop custom plugins for the Arendar Report Utility to create expanded report types The Arendar Report Utility ships wi
28. r 1 1 database settings 3 2 deploying Arendar enterprise environment 1 2 stand alone system 1 2 E enterprise environment 1 2 execution properties 1 4 H help troubleshooting A 1 hyperlink report 6 1 icon manager 2 4 6 1 L logging on to report utility 3 1 O VI Technology Inc P plugin manager 2 4 6 1 plugins Excel 5 2 hyperlink 5 1 list editor 5 5 overview 5 1 queries 5 6 query editor 5 7 product test 1 4 Q queries creating 5 6 testing 5 10 R related documentation 1 vi report managers icon 6 1 plugin 6 1 report utility interface 2 2 logging on 3 1 overview 2 1 running report 4 1 update manager 3 4 user roles 2 1 results table 1 4 running report 4 1 S server module 1 1 settings communication 3 3 database 3 2 system 3 3 stand alone test system deploying 1 2 figure 1 3 station client 1 1 Arendar Report Utility User Manual Index system database figure 1 3 settings 3 3 T test data management system components administration utility 1 1 dashboard 1 1 data import agent 1 1 data import wizard 1 1 data viewer 1 1 server module 1 1 station client 1 1 overview 1 1 test structure configuration properties 1 4 execution properties 1 4 product test 1 4 results table 1 4 test procedure 1 4 troubleshooting A 1 Arendar Report Utility User Manual vi tech com
29. s an Excel workboo Details Tab Cancel Apply Figure 5 2 General Tab The Details Tab shown in Figure 5 3 summarizes the following report definition attributes e Plugin e Plugin Version e Created By e Created Date e Modified By e Modified Date Select Post to Web if you want the report to be accessible through the Arendar Web Dashboard ei Note Optional Selecting the default value in the Config URL field displays the default report configuration window if running from the windows Report Utility or the default configuration page in the Web dashboard Selecting a custom URL launches a Web browser and navigates to the specified URL Arendar Report Utility User Manual 5 2 vi tech com Chapter 5 Y Excel Report Noise Test Report General Details Parameters Queries Actions Attachments Plugin SI Excel Report Plugin Version 1 0 0 Created By super Created Date 8 4 2004 1 01 52 PM Modified By super Modified Date 11 5 2004 1 45 16 PM Config URL Attributes Post to Web Figure 5 3 Details Tab Parameters Tab Use the Parameters tab shown in Figure 5 4 to specify inputs required by the user to generate the desired report A common example is Serial Number where the generated report is dependent on the serial number requested Y Excel Report Noise Test Report Parameters Count 1 Name Control Type Data Type Default Value Serial Number ComboBox String
30. t from list or enter value directly e DropDownList User can select an option from the list only 5 Parameter Editor General ComboBox Drop Down Style Combo List Type Query String Display Member Value Member DropDown DAL SELECT PRD_1 UUT Serial Number AS UUT Serial Number FROM ProductT ests Def Name Naise Test PRD_1 UUT Serial Number r Figure 5 6 ComboBox Tab The Combo List Types ar as followse e OQL Selection list is obtained by executing an OQL query e SQL Selection list is obtained by executing an SQL query e List Selection list is specified by the developer Arendar Report Utility User Manual 5 4 vi tech com Chapter 5 If the list type is OQL or SQL the Query String Display Member and Value Member fields are enabled To aid in creating the query string the Arendar Data Viewer can be launched from the Data Viewer button Refer to the Arendar Data Viewer manual for a description of Data Viewer operation After the query is created in the Data Viewer you can continue editing it directly from the Query String textbox For example the Data Viewer might create an OQL string to query for all Serial Numbers in product Noise Test SELECT PRD_1 UUT Serial Number AS UUT Serial Number FROM ProductTests Def Name Noise Test PRD_1 A typical modification is to remove duplicate values from the returned dataset To do this yo
31. th two plugins Hyperlink and Excel Hyperlink Plugin Hyperlink reports redirect the user to the specified URL using the default browser This is useful for directing users to a Web page with custom reporting logic ES Hyperlink VI Technology Home Page Hyperlink Icon EI Name Characterization Report Config URL http www vi tech com CharacterizationR eport aspx Attributes Iw Post to Web Description Custom ASP NET web page walking the user through creating a custom characterization report Figure 5 1 Hyperlink Report To define a hyperlink report you can specify an icon to display for the report as well as a name description URL and whether the hyperlink should be accessible from the Arendar Web Dashboard VI Technology Inc 5 1 Arendar Report Utility User Manual Plugins Excel Plugin The Excel plugin allows developers to define reports using an Excel workbook General Tab The General tab shown in Figure 5 2 specifies the report Name Description and optionally an icon and image Y Excel Report Noise Test Report fal Report Image 11 KB Icon Name Description Details Parameters Actions Queries Attachments x tal Expected Image Size 200 x 175 pixels Noise Test Report This report presents the waveform captured from a noisy sinewave generator This report can be downloaded for inspection a
32. the Arendar Data Viewer can be launched from the Data Viewer button Refer to the Arendar Data Viewer manual for a description of Data Viewer operation Arendar Report Utility User Manual 5 6 vi tech com Chapter 5 Query Editor Query Parameters Parameters Serial Number gt l Query Parameter lt Param Serial Number Insert Query Name Query Type Noise Test Query Joon Y Query String SELECT PRD_9 UUT Serial Number AS UUT Serial Number TBL_16 Time AS Time ES TBL_16 Voltage AS Voltage FROM ProductT ests Def Name Noise Test PRD_9 ResultsT ables D ef Name Noise Test Vi able Name Raw Das D TBL_16 WHERE PRD_9 UUT Serial Number lt Param Serial Number gt ORDER BY TBL_16 Time Figure 5 9 Query Editor After the query is created in the Data Viewer you can continue editing it directly from the Query String textbox For example the Data Viewer might create an OQL string to query for Serial Number Time and Voltage in product Noise Test where the Serial Number is sN001 SELECT PRD_9 UUT Serial Number AS UUT Serial Number TBL_16 Time AS Time TBL_16 Voltage AS Voltage FROM ProductTests Def Name Noise Test PRD_9 ResultsTables Def Name Noise Test Table Name Raw Data TBL_16 WHERE PRD_9 UUT Serial Number SNOO1 ORDER BY TBL_16 Time If you enter a desired val
33. u can directly enter the DISTINCT keyword to return only distinct values SELECT DISTINCT PRD_1 UUT Serial Number AS UUT Serial Number FROM ProductTests Def GName Noise Test PRD_1 To return only the top 25 values enter the following SELECT DISTINCT TOP 25 PRD_1 UUT Serial Number AS UUT Serial Number FROM ProductTests Def GName Noise Test PRD_1 After you specify a query string you must choose the field from the returned dataset that is to be displayed and optionally a different value field if the chosen value differs from the displayed value If the combo list type is List the List Editor button is enabled You use the List Editor dialog box to specify a list of options for the user to select from You can optionally specify a different display member for the list than the value member An example of this situation is using product IDs Perhaps you need to specify a product ID 1 2 3 but 1t is more meaningful to display a list of product names to select from Milk Eggs Butter List Editor Listltems Count 3 IV Different Display Member i 7 Ena Figure 5 7 List Editor When you are finished click the Test button to see the interface presented to the user without exiting the editing window ei Note Clicking the Close button will not generate the report when testing O VI Technology Inc 5 5 Arendar Report Utility User Manu
34. ue for the serial number filter instead of filtering by Serial Number SN001 you can insert the Parameter value in place of the criteria SNO01 by selecting Insert from the Parameter tree SELECT PRD_9 UUT Serial Number AS UUT Serial Number TBL_16 Time AS Time TBL_16 Voltage AS Voltage FROM ProductTests Def Name Noise Test PRD_9 ResultsTables Def Name Noise Test Table Name Raw Data TBL_16 WHERE PRD_9 UUT Serial Number lt Param Serial Number gt ORDER BY TBL_16 Time Notice that the quotes surrounding SN001 must be removed The report utility will enclose the input parameter in the appropriate database delimiter for the criteria data type VI Technology Inc 5 7 Arendar Report Utility User Manual Plugins Date Parameters WHERE PR Parameters Start Date 1 Day End Date 1 Day Date parameters have special values of 1 Day This allows for inclusive end dates For example suppose you specify Start Date and End Date input parameters for a report The WHERE criteria in the query string might look like the following End Date D_3 Test Start Date gt lt Param Start Date gt AND PRD_3 Test lt lt Param End Date gt With the WHERE criteria the end date is not inclusive If you were to enter 1 1 1990 for the start date and 1 1 2000 for the end date only dates up
35. w opens as shown in Figure 3 1 Test Data Management Username Password Database 451051 ARENDAR ARENDAR E Figure 3 1 Entering User Name and Password Contact your system administrator for your username password and database settings if you do not know them already O VI Technology Inc 3 1 Arendar Report Utility User Manual Installation and Configuration To change the database settings select the icon The Arendar Program Settings window opens as shown in Figure 3 2 Arendar Program Settings DataBase Settings Database System Type Microsoft SQL Server z Database Server Name MYSERVER Database Catalog ARENDAR Use Windows NT Integrated Security C Use a specified user name and password User name Password System Settings Working Folder Path C Program Files Vl Technology 4rendar Cli If Database is not avaliable Load Local Copy Catalogs Silently y Communication Settings Enable use of MSMO to send and receive test data Queue Server Name MYSERVYER Queue Name DMServerQueue C Use local intermediate files KE White test data directly into database Help Figure 3 2 Arendar Program Settings Window The Arendar Program Settings window allows you to configure the settings that determine the server and database catalog database location security permissions and communication methods The following sections describe database system and
Download Pdf Manuals
Related Search