Upgrading from Version 6

Transcription

1 Upgrading from Version 6 Before Upgrading Before you upgrade, there are some settings that should be noted and some configuration that can be done in advance to make the upgrade easier. Enabled Servers From the XLReporter program group, open Registration. Under Data Servers, note the Real Time and Historical servers currently configured. Cautionary Note: If the Historical is set to DeltaV, support for the DeltaV OSI-PI historian has been discontinued and it is not recommended that you upgrade. The latest version of XLReporter does support the DeltaV Continuous Historian through its OPC-HDA interface. Configuration Settings From the XLReporter program group, open Configuration. Under Group, select Registered Add-Ins. Note any Module configured. Under Group, select Directories. Note each directory configured. XLReporter Upgrade Guide - 1 -

2 Under Group, select Collector. Note if Initial wait is greater than 0, Unload is set to N and if a Protect code is set. If a Protect Code is set, this means that the Password to Modify has been set on at least one of the templates in Excel. You will have to reconfigure this password in the new version. This should have been noted when it was set originally, it is not visible here. If the Historical is set to InTouch Classic in Registration, you should note the specific settings configured. Under Group, select InTouch History and note all the settings configured. Schedule Settings From the XLReporter program group, open Schedule Designer. In the Schedule Designer, select Scheduler, Setup. Note if Show Scheduler in the Taskbar is checked, if Install as a Service is checked and if the Poll Time for Events is greater than 1. If Install as a Service is checked, you should note what Windows user the service is running under. Open the Windows Control Panel, Administrative Tools, Services. In the Services list, locate XLReporter Scheduler Service and note the Log On As setting. In the Schedule Designer, select Activate, Schedules. Note every schedule listed with an x in the leftmost column. These are the active schedules XLReporter Upgrade Guide

3 Scheduler Startup If the Scheduler is not installed as a Windows service it may be started up by another means. If there is an HMI system on the machine, the HMI startup may be starting the Scheduler or a shortcut to the Scheduler may be put in the Windows startup folder. Note how the Scheduler is started on the machine. Active Templates The next step is to identify the active templates configured (e.g., templates currently being used). This step is optional but is a good idea because it avoids unnecessary upgrading. From the Schedule Designer, open each active schedule noted. From the commands configured, note the template used. The template is specified in the first parameter. For example, if the command is UpdateSheet FlowSummary.Template The template is FlowSummary. Open each identified template in Excel. Select XLReporter, Connection Configurator. In the leftside list, note any History Group or Database Group connection configured. The Name of the group corresponds with a file in the Input directory. XFiler If you are using XFiler to perform file management like deleting old files, copying reports to a shared folder or moving older reports to an archive folder you must take note of all the management it is performing because XFiler is not available in the latest version of XLReporter. Its functionality has been replaced with another application. Closing down Components Close down all open XLReporter components including the Scheduler. Close down any instance of Excel you may have opened. Back up Configuration At this point you are ready to uninstall the current version of XLReporter and install the latest version. Before doing so, it may be a good idea to back up the current configuration. The easiest way to do this is to back up the Input directory identified earlier. Upgrading the Solution Removing the Current Version From the XLReporter program group, select Uninstall and perform an Automatic uninstall. This will remove the current version from your system. After uninstall is complete, it is a good idea to remove the XLReporter add-ins completely from Excel. Open Excel and ignore any prompts that may appear. From the File menu or Office button select Excel Options. Select Add-Ins and click the Go button.. Uncheck XLRdesign and XLRcore. You will be prompted to delete these from the list. Click Yes and close Excel. Installing the New Version Run the installation for XLReporter on the system. After installation is complete, from the XLReporter program group, open Project Explorer. You will be prompted to create a new project. Set the Folder to where you want the project located and the Name to what you wish to name the project. Under Servers, specify Real Time and Historical based on the Servers noted from the previous version. Click OK to create the project. XLReporter Upgrade Guide - 3 -

4 If the Historical Server for the project is set to Wonderware InTouch Classic, you are prompted for some directory settings. Ensure that the Application Path matches the DB Path and Data Path matches the Default Log Path noted before upgrading. In the Modify dialog, set the Default File Extension to.xls. Click OK to complete the project setup. Installing the XLReporter Add-Ins From the Project Explorer double click Report Templates to open Excel. The Microsoft Office Customization Installer will prompt you to install the XLReporter and xlrstreamexcel add-ins. Click Install for both of these. The XLReporter menu should now appear in Excel. Close Excel. Importing Files into the Project Templates, schedules and other configuration files should be saved under the Input directory of the project. Using Windows Explorer, browse to the Input directory noted from the previous version. From this directory copy the following files: 1. All the templates identified before upgrading. Each template consists of two files, a.xls file and a.xld file. 2. Any history group file identified. History group files have the file extension.grp. 3. Any database group identified. Database groups consist of two files, a.sql file and a.tcl file. 4. Any active schedule identified before upgrading. This will have the file extension.sch. 5. The file XLRschedule.act. Paste these files into the Input directory of the new project. Browse to the Function directory identified before upgrading. Copy the file XLRdatabase.reg and paste it to the Input directory of the project. Browse to the Output directory identified before upgrading. Copy any report file that you wish to bring into the project and paste it to the Reports folder of the project. Upgrading the Project From the Project Explorer select File, Upgrade Files. Right-click the project name again and select Refresh. Now all the files should be available under the folders in the Project Explorer. Updating the Schedule The CopyBook and CopySheet commands available in version 6 are no longer supported by XLReporter. Report Naming Convention The report naming convention is no longer part of the Schedule (e.g., CopyBook and CopySheet commands) but instead is configured as part of the template. From the Project Explorer, expand the Schedules folder and double-click on the Startup Schedule listed. Leave the Schedule Designer open. From the Project Explorer, expand the Report Templates folder. For each template listed, doubleclick to open it in Excel XLReporter Upgrade Guide

5 In Excel, select XLReporter, Template, Report Names. The naming convention will be defined here. Return to the Schedule Designer and locate the CopyBook command that corresponds to the template. Select the line, right-click and select Modify. Copy the Target Workbook setting from the window and click Cancel. Return to Excel with the Report Names window opened. Select the row beneath WORKBOOK and click Modify. Paste the copied setting to the Target setting. Return to the Schedule Designer and locate any CopySheet command that corresponds to the template. The CopySheet command will actually refer to the report workbook, rather than the template. For example, if the CopyBook command is configured as CopyBook FlowSummary Flow{MMM}{YY} Any CopySheet command configured would reference Flow{MMM}{YY}. For each identified CopySheet command, select the line, right-click and select Modify. For Workbook.Worksheet, identify the worksheet to the right of the period. For example, if Workbook.Worksheet is set to Flow{MMM}{YY}.Template, the worksheet is Template. For Target Worksheet, copy the setting. Note if Overwrite Target is checked. Click Cancel to close the window. Return to Excel with the Report Names window opened. Under WORKSHEET locate the worksheet identified from the CopySheet command. Highlight the row and click Modify. Paste the copied setting for Target and click OK. If Overwrite Target was checked, check Allow Target Overwrite. Click OK to save the Report Name settings and close the window. Select XLReporter, Template, Save to save the template and close Excel. Copying Completed Reports If you were using CopyBook command to copy the completed report to another folder you must modify the schedule line to use the MoveBook command instead. This command is found under the Transfer category. The Source parameter should be specified as the name of the template and the Target parameter specified as the full name (including path) to where you would like to copy the report. For Options, be sure to leave Delete Source unchecked so that a copy of the report is moved. By setting the Source parameter to the template, it will follow the report naming convention of the template and copy the latest report to the Target specified. Publishing to PDF If you were previously publishing reports to PDF the only way do so was to configure a PrintBook or PrintSheet command with the Printer set to XLRtoPDF. This could be restrictive as the name of the PDF file was either than exact name of the report workbook (in the case of PrintBook) or the name of the workbook combined with the worksheet (in the case of PrintSheet). The latest version provides 2 new commands, SaveBookPDF and SaveSheetPDF which allow you to specify the name of the PDF file you wish to create (if needed). These commands are found under the Publish category. While the PrintBook and PrintSheet commands will still create the PDF files, you may want to convert these over to SaveBookPDF or SaveSheetPDF for the future. Restoring Configuration From the Project Explorer, select Edit, Settings. Select the General tab. Restore the Initial Wait and Unload settings previously noted if they do not match the current settings. To change a value, select it and right-click. Select the Excel tab. If any Registered Add-In was noted, add it to the next available Registered Add-In setting. If a Protect Code was previously set, set the Password to Modify to it. XLReporter Upgrade Guide - 5 -

6 Setting up the Scheduler In the Schedule Designer, select Scheduler, Setup. If Install as a Service was checked previously, select Run as a Service. Specify the Account as the Log on As setting noted before upgrading. Specify the Password for the Account. Otherwise, select Run in the Taskbar. If Show Scheduler in Taskbar was checked, set the Startup Mode to Background, otherwise leave it as Normal. Click OK to save and close. The Schedule Designer can now be closed. If the Scheduler was not installed as a Windows service but was started up in another way, locate where that is configured and make sure the path specified for the Scheduler (XLRSchedule.exe) is correct. If the Scheduler was started up from a shortcut in the Windows startup folder, locate this shortcut, right-click and select Properties. If you used default install paths then this setting should change from: C:\Program Files\XLReporter\XLRschedule.exe To C:\XLReporter\XLRschedule.exe Likewise, if the Scheduler was started from the HMI, ensure that the path to XLRschedule.exe is correct. Scheduler Service Considerations If the Scheduler is configured to run as a service and the Account specified is not the account you are currently logged in as you must log on to that windows account. Once logged on you should open the Project Explorer and ensure that the project loads correctly. Double-click on Report Templates to open Excel and install the XLReporter Add-ins like you did previously. You can now log off this account. Starting the Scheduler When the Scheduler is started you may receive the error Sch010: File version incorrect. To correct this, from the Project Explorer double-click the Schedules folder to open the Schedule Designer. Select Scheduler, Select Schedules. In the Select Schedules dialog ensure that every schedule you want to run is selected (appears with a green play button in the leftmost column) and click OK. This will rebuild XLRschedule.act to the latest version. You should now be able to start the Scheduler without any errors. Restoring XFiler Functionality If you were using XFiler in the original version, all its functionality (and more) is available in the File Management application. From the Project Explorer double-click File Management to open the Filer Designer. Here you can create configurations to perform the file management originally performed by XFiler. Once all the configurations are complete, access any schedule configured in the project and replace the original RunApplication command for XFiler to a ManageFiles command specifying the configuration you created in the Filer Designer. This command is located in the Maintain category. General Cleanup To ensure that no files from version 6 are used with the latest installation, you should rename the old installation folder (C:\Program Files\XLReporter by default). Once the system is up and running you can delete this folder permanently from the system. Registering the New Version The upgrade is now complete. Contact SyTech to register the new version XLReporter Upgrade Guide