XLReporter Getting Started Version 10.0
SyTech, Inc.
The Complete Reporting Solution
Information in this document is subject to change without notice. SyTech, Inc. assumes no responsibility for any errors or omissions that may be in this document. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the prior written permission of SyTech, Inc.
Copyright 2000 – 2012, SyTech, Inc. All rights reserved. XLReporter is a trademark of SyTech, Inc. Microsoft® is a registered trademark of Microsoft, Inc. All registered names are the property of their respective owners.
Contents XLReporter
7
Welcome ....................................................................................................................................7 XLReporter Editions ..................................................................................................................9
Installation
10
Standard, Suite, Professional Setup..........................................................................................10 Installing Microsoft .NET Framework 2.0.................................................................10 Team Server Setup ...................................................................................................................10 Installing Internet Information Services (IIS) ............................................................10 Setting up the IIS .......................................................................................................11 Manual Configuration................................................................................................11 Windows Firewall Settings ........................................................................................13 Configuring Users......................................................................................................14
Getting Started
15
Creating Your First Project ......................................................................................................15 Registration ..............................................................................................................................15 Evaluation License.....................................................................................................15 Full License................................................................................................................16 Checking Your Installation ......................................................................................................16 General.......................................................................................................................16 Real Time...................................................................................................................16 Getting Results .........................................................................................................................16
Team Client
17
Overview..................................................................................................................................17 Requirements .............................................................................................................17 Installation................................................................................................................................17
Resources
19
Documentation .........................................................................................................................19 Other Resources .......................................................................................................................19
Getting Started
-5-
XLReporter Welcome Welcome to XLReporter, an innovative product that provides reporting, viewing and sharing of Excel reports and forms from a single workstation to any place in your organization. XLReporter uses Microsoft Excel as its “design studio” to design report and form templates. A template is an Excel worksheet that contains the framework of your report together with connections to your data servers, e.g., real time, history or relational database. A powerful set of management functions provide additional presentation and analysis capability beyond the standard features of Excel.
Reports Reports are produced in two distinct ways, automatically and interactively. Automatic reports are produced periodically or on events by XLReporter’s scheduler, without any human intervention. Unlike other Excel reporting products, XLReporter does not require Excel to be visible or constantly active and in certain cases, Excel is not even required! Completed reports are stored according to your own report naming convention and can be automatically sent to printer, e-mail, web server, PDF or HTML. Additional tools such as file management and FTP transfer are provided.
Interactive reports are produced from custom templates which contain variables that the user specifies. The input method the user uses, together with security settings is part of the template design. When the template is used, the user specifies report parameters and gets the report immediately.
Getting Started
-7-
Interactive reports can be created on a single workstation or from any workstation in your organization provided the user has the appropriate security credentials.
Forms Interactive Forms is a component to deploy Excel forms across your network to gather and store information to a central location. The application is ideal for any Industry that collects data manually, such as user recordings and laboratory results, and requires a central place to organize the data so that it is accessible for reporting purposes. An interactive form implementation can start on a standalone workstation and grow over time to a team of workstations, each submitting their own completed forms. Since no knowledge of SQL or software programming is required, it can be implemented easily by anyone with just a basic understanding of Excel.
Data entry is performed in a viewer which has the “feel” of Excel so all the features of the form are consistent with the template that was designed in Excel. Using the viewer, completed forms can be submitted for permanent storage. The viewer also provides features to view, update and print forms that are already archived. With other applications, form templates maybe difficult to create and update since they use their own “custom” template design tools which may be unfamiliar to you. Interactive Forms uses the comfortable environment of Microsoft Excel so all the power of Excel such as calculations, formatting and validation is at your fingertips to produce sophisticated user entry forms.
-8-
Getting Started
option
option
Report from historians e.g., OPC-HDA
option
option
Team
Suite
Report from relational databases e.g., SQL Server
Professional
Standard
XLReporter Editions
Template design entirely in Microsoft Excel Unlimited templates Use government and regulatory templates Dynamic range support for all Excel features Data visualization beyond Excel Export to database, process, smartphone and XML Automatic reporting on periodic and event triggers Automatic output to printers, Excel files and web pages Report from real time servers e.g., OPC
option
Standard 30 day product support One year of product support and major upgrades Interactive reports from the local workstation Interactive forms from the local workstation Analytic calculations from real time servers Report from analytic server Secure PDF and Excel file viewer Automatic web site management Automatic output to encrypted PDF (built-in driver)
option
Automatic output to email
option
Interactive reports from any networked workstation Interactive forms from any networked workstation User security management Client reporting Client viewing Client report sharing Thin Client Install No client Excel licenses required
Getting Started
-9-
Installation Standard, Suite, Professional Setup The Standard, Suite and Professional editions are used for automatic reporting and interactive reporting from the workstation where the product is installed. The following software is required for all editions: • Microsoft Windows Operating System • Microsoft Excel 2003 or higher • Microsoft .NET Framework 2.0 or higher version If you are unsure what version (if any) of Microsoft .NET Framework you have installed, begin the installation and if your system does not meet the requirement, you will be notified.
Installing Microsoft .NET Framework 2.0 The Microsoft .NET Framework 2.0 installation is available on the installation CD by running dotnetfx.exe. This installation must be performed by an Administrator of the system.
Team Server Setup The Team edition is used for automatic reporting and interactive reporting from any workstation in your organization. In addition to the requirements given in the previous section, the Team edition also requires Internet Information Services (IIS) to be activated in the operating system and a virtual directory to be created. These additional steps can be performed after the installation is completed.
Installing Internet Information Services (IIS) Internet Information Services (IIS) is provided by Microsoft and is delivered as part of the operating system. By default, IIS is not installed and so it has to be done manually by an Administrator of the system. The procedure for installing and configuring IIS depends on the operating system. Windows XP To install, open the Windows Control Panel and select Add or Remove Programs. Select Add/Remove Windows Components to display a list of Windows Components. Check Internet Information Services (IIS) and click Next to install IIS. Windows 2003 Server To install, open the Windows Control Panel and select Add or Remove Programs. Select Add/Remove Windows Components to display a list of Windows Components. Select Application Server and click Details. Check Internet Information Services (IIS) and click OK. Click Next to install IIS. Windows Vista / Windows 7 To install, open the Windows Control Panel and select Programs and Features. Select Turn Windows Features on or off to display a list of Windows Features. Check Internet Information Services and click OK to install IIS.
- 10 -
Getting Started
Setting up the IIS In order to use IIS, a virtual directory must be configured together with other configuration. A batch file called IISmanage.bat, has been provided to perform this work for you. The batch file is located in the installation directory and must be run with Administrator rights. In operating systems like Windows Vista and Windows 7 this means right-clicking the file and selecting Run as Adminstrator even if you are currently logged on as an administrator. In older operating systems, you can double-click the file to run. When run, you are prompted for 3 items • version of IIS installed (5, 6 or 7), • architecture of the operating system (32 or 64) • full installation path of XLReporter (e.g., C:\XLReporter). In the following, we describe how you can obtain the answers to the above prompts. Once specified, IIS is configured and a virtual directory called XLRweb is created. Caution, if you are on a 64 bit operating system and have IIS 6 installed the batch file will enable 32 bit applications. This is a global setting and will affect all other web sites and virtual directories configured in IIS. Determining the version of IIS Installed To determine the version of IIS installed, open the Windows Control Panel and select Administrative Tools, Internet Information Services or Internet Information Services Manager. If it is available, select Help, About Internet Information Services to view the version of IIS installed. If this option is not available, in the left pane, select Internet Information Services at the top of the tree. The version appears in the right pane under the Version heading. When prompted for the version by the batch file, specify only the “major” version, e.g., for IIS 7.5, specify the version as 7. Determining if the Operating System is 32 or 64 bit The easiest way to determine if the operating system is 32 or 64 bit is to open System from the Windows Control Panel. If the operating system is 64 bit it will be indicated somewhere in the dialog, either as 64 bit operating system or x64. If this does not appear, the operating system is 32 bit.
Manual Configuration In some cases, the batch file may produce an error in which case you may need to manually configure IIS. Registering ASP.NET v2.x (32 bit) In the Internet Information Services Manager, under Default Web Site, if you do not see the aspnet_client folder, ASP.NET v2.x may not be registered on your system. To register, open a command prompt and enter: On 32 bit systems: c:\windows\Microsoft.NET\Framework\v2.0.50727\aspnet_regiis.exe –iru On 64 bit systems: c:\windows\Microsoft.NET\Framework64\v2.0.50727\aspnet_regiis.exe –iru IIS version 5.1 To add a virtual directory, open Internet Information Services. In the left pane, expand the tree and right click on the branch Default Web Site. From the popup, select New, Virtual Directory… to open the Virtual Directory Creation Wizard.
Getting Started
- 11 -
Enter the Alias as XLRweb and click Next. This will be name that remote users will use to reference the web site. For Directory, use the Browse… pushbutton to select the install directory and click Next. For our purposes, no other configuration is required so click Next and then Finish. Right-click the XLRweb virtual directory and select Properties. Under the ASP.NET tab, set the ASP.NET version to 2.0.50727 and click OK. IIS version 6.0 (32 bit) To add a virtual directory, open the Internet Information Services (IIS) Manager. In the left pane, expand the tree and right click on the branch Default Web Site. From the popup, select New, Virtual Directory… to open the Virtual Directory Creation Wizard. Enter the Alias as XLRweb and click Next. This will be name that remote users will use to reference the web site. For Directory, use the Browse… pushbutton to select the install directory and click Next. For our purposes, no other configuration is required so click Next and then Finish. Right-click the XLRweb virtual directory and select Properties. Under the Virtual Directory tab, in the Application Settings section, click Create to create the XLRweb application. Set Execute Permissions to Scripts only. Under the ASP.NET tab, set the ASP.NET version to 2.0.50727 and click OK. In the left pane, select the Web Service Extensions folder. In the right pane, for ASP.NET v2.0.50727 set the Status to Allowed. IIS version 6.0 (64 bit) Enabling 32 bit Applications Caution, if you are on a 64 bit operating system and have IIS 6 installed the batch file will enable 32 bit applications. This is a global setting and will affect all other web sites and virtual directories configured in IIS. To convert IIS to 32 bit, open a command prompt window and enter: cscript c:\inetpub\adminscripts\adsutil.vbs SET W3SVC/AppPools/Enable32bitAppOnWin64 1 Finally, IIS needs to be reset to have the changes take effect. From the command prompt, enter: iisreset Creating the Virtual Directory To add a virtual directory, open the Internet Information Services (IIS) Manager. In the left pane, expand the tree and right click on the branch Default Web Site. From the popup, select New, Virtual Directory… to open the Virtual Directory Creation Wizard. Enter the Alias as XLRweb and click Next. This will be name that remote users will use to reference the web site. For Directory, use the Browse… pushbutton to select the install directory and click Next. For our purposes, no other configuration is required so click Next and then Finish. Right-click the XLRweb virtual directory and select Properties.
- 12 -
Getting Started
Under the Virtual Directory tab, in the Application Settings section, click Create to create the XLRweb application. Set Execute Permissions to Scripts only. Under the ASP.NET tab, set the ASP.NET version to 2.0.50727 and click OK. In the left pane, select the Web Service Extensions folder. In the right pane, for ASP.NET v2.0.50727 (32 bit) set the Status to Allowed. IIS version 7.0 and above (32 bit) To add a virtual directory, open the Internet Information Services (IIS) Manager. In the left pane, expand the tree, expand Web Sites (or Sites) and right click on the branch Default Web Site. From the popup, select Add Application… to open the Add Application dialog. Enter the Alias as XLRweb. This will be name that remote users will use to reference the web site. For Physical path, use the Browse… pushbutton and select the install directory. Click OK. IIS version 7.0 and above (64 bit) Enabling 32 bit Applications In IIS version 7.0, enabling 32 bit applications can be done at an application pool level. To ensure no other virtual directories are affected, a new application pool will be created. To add the application pool, open the Internet Information Services (IIS) Manager. In the left pane, expand the tree and right click on the branch Application Pools. From the popup, select Add Application Pool… to open the Add Application Pool dialog. Enter the Name as XLRwebPool and click OK. In the right pane, right click XLRwebPool and select Advanced Settings. Under General, set Enable 32 Bit Applications to True. Click OK. Creating the Virtual Directory To add a virtual directory, open the Internet Information Services (IIS) Manager. In the left pane, expand the tree, expand Web Sites (or Sites) and right click on the branch Default Web Site. From the popup, select Add Application… to open the Add Application dialog. Enter the Alias as XLRweb. This will be name that remote users will use to reference the web site. For Physical path, use the Browse… pushbutton and select the install directory. For Application Pool select XLRwebPool. Click OK.
Windows Firewall Settings If the Windows Firewall is turned on, an exception must be made in order for Team Clients to access the Team Server. Windows 7 Access the Windows Firewall settings from the Windows Control Panel. Select Allow a program or feature through Windows Firewall. From the list of programs, check World Wide Web Services (HTTP). You may have to click the Change settings button in order to check this setting. Other Windows Versions Access the Windows Firewall settings from the Windows Control Panel. Under the Exceptions tab click Add port. Set the Name to Web HTTP Server and the Port Number to 80 then click OK.
Getting Started
- 13 -
Configuring Users Remote users can only connect to the Team server if they have the appropriate login credentials and privileges assigned. The specification of the user account details is performed in the Project Explorer by the Edit, User Accounts menu option.
Here you can Add, Modify and Delete users and assign them specific access rights.
- 14 -
Getting Started
Getting Started Creating Your First Project With installation complete, open the Project Explorer. If this is the first time the software has been installed, the left pane of the display will be blank and the New dialog will be displayed.
Specify a Name for your project (e.g., XLRproject) and the servers that will be used by the project to provide the report data. Check the Use off-line option if XLReporter has been installed on a workstation that does not have access to the servers. This would be the case if template development and testing is performed “off line” where the servers are not available. In off-line mode, XLReporter simulates data from the servers selected. This option can be changed at any time by modifying the project (File, Modify from the Project Explorer). Verify that the Default File Extension is compatible with your version of Excel. As an option, the Interactive Reports provided with the product can be installed by selecting Standard Charts and Standard Templates. (We recommend you install them). These can be added or removed at any time by modifying the project. Click OK to create your project. If you are prompted, restart the Project Explorer.
Registration Two types of software licenses are provided:
Evaluation License From the Project Explorer, select Registration and enter the information required. Click Start Trial to start the evaluation. When the evaluation period expires, you can re-open this display and click Extend Trial.
Getting Started
- 15 -
Full License On purchasing the product, you will either be sent a hardware key or be provided a software key. In the case of a software key, open Registration and click Enter Key to obtain your Lock code. Send your Lock code together with your serial number to SyTech either by e-mail to
[email protected] or by phone to obtain the software Key to enable the product.
Checking Your Installation An application is provided to ensure that all the reporting components are installed correctly. Open the Project Explorer and from the Tools menu option select System Check….
General On the General tab, click Test to conduct a general system check. Please note if any of the tests display a Fail status. If a failure is detected, follow the instructions in the lower area of the display. For more information, refer to the Reference Guide.
Real Time Select the Real Time tab to conduct a real time system check. Add real time tags by selecting an empty row and clicking on the browse pushbutton (…). Select the desired real time tags then click OK. To read the values continuously from your server, click the Read pushbutton. For values in the server that can be written to, click Stop (if reading is in progress) and then enter a value in the Value column and click Write.
Getting Results With your installation checked out, it is time to create your first report. From the Project Explorer menu, select Documentation, Getting Results and follow the comprehensive tutorials we have provided. - 16 -
Getting Started
Team Client Overview If you are a user that requires producing reports from your station then you will need to be setup as a Team client. A Team client can only be created if the Team edition of the product has been installed and is accessible to the client station.
Requirements The following software is required on a Team client station • Microsoft Windows operating system. • Microsoft .NET Framework 2.0 or higher version. Before you connect to the Team server, make sure you have obtained the following information from your Team administrator: • The station name of the Team Server • A valid Team Username and Password
Installation To install, open a web browser on the remote client station and enter the following URL: http://StationName/XLRweb/Setup.htm StationName is the name of the workstation or server where the Team edition has been installed. This name would be assigned by the Team administrator.
Click the Install button on the web page. If the prerequisite software is not installed a message will indicate this otherwise the Setup dialog is opened.
Getting Started
- 17 -
Specify a valid Team user and password, select your language and click OK to install the client software on your workstation. Once the installation has completed, from the Start menu, under the program group, click on Team Explorer. From Team Explorer display, the Team applications can be accessed.
- 18 -
Getting Started
Resources Documentation A comprehensive set of manuals are available to help you every step of the reporting journey. • Getting Started (this document) • Getting Results • Reference Guide • Team Guide • Server Guide • Files Guide • iForm Guide • XMailer Reference Guide • XLViewer Reference Guide • XWeb Director Reference Guide
Other Resources In addition to the documentation provided, visit www.TheReportCompany.com. Here you will find a searchable Knowledge Base of helpful hints and frequently asked questions as well as the latest information on the product.
Getting Started
- 19 -
