EVault Reports User Guide Version 2.74

Transcription

1 EVault Reports User Guide Version 2.74

2 Revision: This manual has been updated for Version 2.74 (January 2015). Software Version: 2.74 (January 2015) 2015 EVault Inc. EVault, A Seagate Company, makes no representations or warranties with respect to the contents hereof and specifically disclaims any implied warranties of merchantability or fitness for any particular purpose. Furthermore, EVault reserves the right to revise this publication and to make changes from time to time in the content hereof without obligation of EVault to notify any person of such revision of changes. All companies, names and data used in examples herein are fictitious unless otherwise noted. No part of this document may be reproduced, transmitted, transcribed, stored in a retrieval System or translated into any language including computer language, in any form or by any means electronic, mechanic, magnetic, optical, chemical or otherwise without prior written permission of: EVault, A Seagate Company c/o Corporation Trust Center 1209 Orange Street Wilmington, New Castle Delaware EVault, EVault Software, EVault SaaS, and EVault DeltaPro, are registered trademarks of EVault, A Seagate Company. All other products or company names mentioned in this document are trademarks or registered trademarks of their respective owners. Acknowledgements: Two encryption methods, DES and TripleDES, include cryptographic software written by Eric Young. The Windows versions of these algorithms also include software written by Tim Hudson. Bruce Schneier designed Blowfish encryption. Part of the software embedded in this product is gsoap software. Portions created by gsoap are Copyright Robert A. van Engelen, Genivia Inc. All Rights Reserved. THE SOFTWARE IN THIS PRODUCT WAS IN PART PROVIDED BY GENIVIA INC., AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The EVault Software Agent, EVault Software CentralControl, and EVault Software Director applications provide encryption options for 128/256-bit AES (Advanced Encryption Standard). Advanced Encryption Standard algorithm (named Rijndael, pronounced Rain Doll ) was developed by cryptographers Dr. Joan Daemen and Dr. Vincent Rijmen. This algorithm has been chosen by the National Institute of Standards and Technology (NIST) of the U.S. Department of Commerce to be the Federal Information Processing Standard (FIPS). The EVault Software Agent and EVault Software Director applications include the security feature of over-the-wire (OTW) encryption.

3 Table of Contents 1 Introduction and Overview Vault/Reports Relationship... 2 Overview of Product Set... 2 Vaults and EVault Reports... 3 SQL Server Requirements... 3 Overview of the Reporting System... 4 Replication and EVault Reports Extractors Getting Started... 6 Launch Report Viewer or Report Manager... 6 Main Menu for Reports... 7 Report Options Performance and Security Considerations Report Types Activity Details Report Backup and Restore Summary Report Backup Details Report Backup Status Report Customers Report Environment Information Report Grouped Storage Details (Data Age) Report Grouped Storage Details (Original Bytes) Report Grouped Storage Details Report Storage Details (Last Backup) Report Storage Details (Original Bytes) Report Storage Details Report Storage Totals (Data Age) Report Storage Totals (Original Bytes) Report Storage Totals Report Vault Extractor Status Report Vault Summary (Data Age) Report Vault Summary (Original Bytes) Report Vault Summary Report Report Manager Select Report Subscription i

4 All Reports Single Report Create a New Subscription Description Tab Delivery Tab Scheduling Tab Report Parameters Tab Customers Tab Subscription Summary Tab Edit an Existing Subscription Report Groups EVault Reports Typical Installation Prerequisites SQL Server Reporting Services Configuration Installation Overview Typical Installation SSL Implementation Modify, Repair/Upgrade and Uninstall Modify Repair Upgrade Uninstall Migrating from EVault Reports Disabling User Access and Web Services Stopping the SQL Server Agent Service Backing up the EVault Reports Version 2.70 Database Installing EVault Reports Disabling Access to EVault Reports and Web Services Stopping the SQL Server Agent Service Restoring the 2.70 EVault Reports Database Repairing EVault Reports Verifying the EVault Reports Compatibility Mode Starting the SQL Server Agent Service Enabling Access and Verifying the Installation Removing Previous Versions of EVault Reports Upgrading to EVault Reports ii

5 6 EVault Reports Custom Installation Diagram of Component Interaction Loader (Web Service) Token Manager (Web Service) Report Viewer (Web Application) Login (Web Application) Configuration Files Data Loader Web.config Token Manager Web.config Report Viewer Web.config Installing Components Prerequisites SQL Server Reporting Services Configuration Installation Overview Custom Installation Steps SSL Implementation Single Sign On (SSO) Implementation Login Token Manager Web Service Interface Appendix Allowing Another User to Access Reporting Services EVault Reports Extractor (SynchWeb) FAQ Error collecting storage information Internal error. The underlying connection was closed. Unable to connect to the remote server Internal error. Invalid URL: The format of the URL could not be determined Extractor fails for a corrupted customer billing code Missing Extractions can cause inaccuracies in Reports Pool Size on Reports Definitions Storage Totals (Data Age) Report IIS Versions and MIME Types iii

6 1 Introduction and Overview The EVault Software vault platform provides disk-to-disk enterprise data protection service. The platform is used by customers to provide an in-house solution to their backup needs, and by Managed Service Providers (MSPs) who resell the backup service to end users. Customers often want to see detailed information about their backups. These details include such things as: Backup status Are my backups occurring when they need to? Storage details How much storage are backup sessions adding? Storage totals How much storage is used by my backups? Environment information What platforms and EVault Agent versions are used? Backup and restore summary Are backups and restores succeeding? Backup details When, and how much data was backed up? Activity details How often are backups or restores occurring? Page 1

7 1.1 Vault/Reports Relationship Overview of Product Set This diagram shows the relationship between EVault Reports and other EVault-related products: Offline Restore Offline Backup QuickShip Mobile Vault Export Import EVault Reporting System Reports via Web Browser Agent Online Restore Online Backup Director Vault Synch Web Agent VBA Primary Pool Data CentralControl Management of Agents and Tasks Director Console ( GUI) Agent Network Attached Storage Secondary Pool Data Figure 1. - Overview of Product Set Note: The arrows show general communication (mainly data and control) between the different parts of the system. Only the parts circled in Figure 1 are described in this document. Page 2

8 Vaults and EVault Reports It is strongly recommended to run the database on a different machine than the one the Director is installed on. Note: Using the same database engine and/or instance that the Director uses, is not supported. By default, the Director uses SQL Express, which is not supported for EVault Reports. You may use SQL Server 2008 R2 for the Director, instead of SQL Express. But as mentioned above, it is not supported for use with EVault Reports and Director together in the same SQL engine. SQL Server Requirements Before you install EVault Reports, a supported version of Microsoft SQL Server must be installed, with the following requirements: SQL Server Option Features Services Authentication Collation Instance name Requirement Database Engine Services, Reporting Services SQL Server Agent Mixed Mode (SQL Server and Windows authentication) Any case-insensitive collation Any instance name; no restrictions SQL Server should be installed on a system that is not externally visible, configured with default settings, and ready for use. When SQL Server and EVault services are installed on different servers, TCP/IP and Named Pipes must be enabled for the database instance. SQL credentials must also be specified for connecting to the database from remote servers. EVault Reports can use the same SQL Server instance as Web CentralControl. However, for scalability and environments with many Agents and vaults, it is preferable to use separate SQL Server instances for Web CentralControl and EVault Reports. Page 3

9 Overview of the Reporting System This diagram shows the main components for EVault Reports. The IIS system may be local or remote from the vault. 1. EVault Reporting System ed Reports Director Vault Synch Web Pool Data 2. Loader IIS Viewer 5. Report Subscription 3. Subscriptions & Reports EVault Reports SQL Database 4. Figure 2. - Overview of Reporting System The following steps occur to produce reports. The following list only provides an overview. Details are described later. A Reports Extractor program runs for the vault (manually or scheduled) and collects the raw data. (Note: To ensure the reports are accurate and timely, the extractor should be run on the same frequency as your backups. That is, if you have daily backups, your extractor should be run daily.) The extractor sends the data to the EVault Reports Loader Web service (on an IIS Server). The Loader Web Service stores the data on the SQL database. A user logs in to EVault Reports using a Web browser. The User selects one of the available reports and provides additional filtering and sorting criteria. (Or, a "subscription" can automatically send reports via .) The Report Viewer web application pulls the appropriate data from the database, formats it, and sends it as a report, using reporting services, to the user. Page 4

10 Replication and EVault Reports Extractors Replication is the process of copying backup data from one vault to another vault. This ensures that your vault data is secure in case the main vault is affected by a hardware crash or physical destruction. It provides a method of providing an alternate vault for backups and restores, for uninterrupted service. Replication can occur in one-to-one (1:1), many-to-one (N:1), or many-to-one-to-one (N:1:1) scenarios. The following paragraphs describe each replication type, and indicate where to install the EVault Reports Extractor in each replication scenario. For more information, see the EVault Reports Extractor Guide. One-to-One Replication With Director 6 and later versions, 1:1 replication allows customer data on a main (Active) vault to be backed up (logically replicated) to a secondary (Passive) vault. If the main vault fails you are still protected with the secondary vault. If you are using 1:1 replication, install the EVault Reports Extractor application on both the Active and Passive vaults. When you install the application, it detects the Active state and count on the vault and determines if the vault is Active or Passive. Many-to-One Replication With Director 6 and later versions, N:1 replication allows local Agents to send backups to local Satellite vaults at LAN speeds. The Satellite vaults then send the data to a main, centralized vault (Base vault). Local users can back up to and restore from the local Satellite vault. However, if the local vault fails, the users can still back up to and restore from the main vault (Base Vault), over the Internet. If you are using N:1 replication, install the EVault Reports Extractor application on the Base vault. When backups are completed on the Satellite vault, some of the backup information might be missing from the generated reports because the information is unavailable to the EVault Reports Extractor application. Many-to-One-One Replication With Director 7.0 and later versions, you can implement N:1:1 replication. In N:1:1 replication, Satellite vaults collect backup data from Agents, data is replicated automatically to an Active Base vault, and is then replicated from the Active Base vault to a Passive Base vault. If you are using N:1:1 replication, install the EVault Reports Extractor application on both the Active Base vault and Passive Base vault. Page 5

11 1.2 Getting Started EVault Reports may be run as separate components on different machines, with a custom installation. A simple (typical) installation allows users to easily get started, enable subscriptions, and produce reports. Launch Report Viewer or Report Manager Figure 3. - Default Login for Reports The default login to Report Viewer and Report Manager allows you to start ( launch ) the programs from here. Note that you will not see this screen for a Custom Installation that installs the forms authentication component. There is a default Login screen for Reports (See section 5 in this Guide). To access the Report Manager, you can enter a URL directly. Page 6

12 Main Menu for Reports Figure 4. - Main Menu for Reports Once the reporting system is installed, set up, and running, you can access the reports using Internet Explorer by: Logging in to the EVault Reports web site, Selecting a particular report (see Figure 5), Choosing filtering, sorting, and display options, and then viewing or printing the report (see Figure 5). Note: When logging on with Windows authentication, the report viewer page does not display a logout option. Closing the viewer will end the session. Page 7

13 Report Options In these reports, you may specify full names, partial names (with wildcards), or choose everything associated with a field. For example, you can select one vault by its name, or many that start with a partial name, or all vaults by leaving the Vault field blank. The percent symbol (%) and the asterisk symbol (*) can also be used for "everything". With partial names, * means "one character or more", and the? means "one single character". Figure 5. - Example Report Options Filtering options allow the user to narrow down what information will be displayed in the report. The filtering accepts wildcards. For example filtering for Server* will return information about Server, Server1, ServerSQL, etc. Sorting options allow the user to organize the display by a specific column, sorting can be done one column and organized in ascending or descending order. Sorting options vary depending on the type of report. Report Display Options vary depending on the report that was chosen. HTML and PDF are always available. Comma-delimited Excel format can be generated for many of the Detailed reports. Page 8

14 1.3 Performance and Security Considerations For optimal performance, it is recommended that the SQL database server should not be shared with other applications. For security concerns, the Reports Database, Data Loader and Token manager should be run securely inside a firewall-protected network. Page 9

15 2 Report Types Reports are created from the data that a vault (extractor) has sent to the EVault Reports database. When you run a report, the data is formatted and a report is produced. While the data is being accessed in the database, you may see the status in the following sequential steps: Loading data is being uploaded; not ready for viewing. Loaded data is uploaded, waiting for processing; not ready for viewing. Updating data is uploaded, being processed; not ready for viewing. Ready data is uploaded, processed; ready for viewing. There may also be an error message: Failed - data is uploaded, but processing failed. The user will be able to see the following reports (see figure 5 - Main Menu for Reports), from the Report Viewer, or from an (subscription): Activity Details Report Backup and Restore Summary Report Backup Details Report Backup Status Report Customers Report Environment Information Report Grouped Storage Details (Data Age) Report Grouped Storage Details (Original Bytes) Report Grouped Storage Details Report Storage Details (Last Backup) Report Storage Details (Original Bytes) Report Storage Details Report Storage Totals (Data Age) Report Storage Totals (Original Bytes) Report Storage Totals Report Vault Extractor Status Report Vault Summary (Data Age) Report Vault Summary (Original Bytes) Report Vault Summary Report Page 10

16 Note: Original Bytes refers to the size of the user s actual data on their machine. It is the size of the data that is protected by the backups. Data Age refers to reports that show the age of data, grouped from 1-90 days, days, and over 365 days. 2.1 Activity Details Report This report lists the results of backup and restore activity. It provides an easy way of identifying systems that are backing up successfully, or those for which restore sessions are failing. This report displays the following information: Vault Name of the vault Customer The customer shortname as defined on the vault Computer Name of the computer registered to the vault Job - Name of the Job registered to the vault Date Date and time when the backup took place Activity Type May be Backup or Restore Result May be Successful, Failed or Unknown Figure 6. - Activity Details Report Page 11

17 2.2 Backup and Restore Summary Report This report can be used in order to understand the backup and restore activity over time for the protected systems. In addition to textual information, the report presents a graph to make the information easier to understand. This report displays the following information: Number of Vaults Number of vaults queried Number of sessions Number of Backup, Restore or Backup and Restore sessions identified in the selection Number of Successes Number of sessions that completed successfully (possibly with warnings or errors) Number of Failures Number of sessions that reported failure or did not report their completion status Percentage of Successes Percentage of sessions that have completed successfully Percentage of Failures Percentage of sessions that have failed Note: The graph displays the number of successful and failed sessions over time. Figure 7. - Backup and Restore Summary Report Page 12

18 2.3 Backup Details Report This report lists the successful and failed backup attempts over time. All successful backup sessions include additional details such as backup session duration, Original Size in GB, size of Delta, etc. This report displays the following information: Vault Name of the vault. Customer The customer shortname as defined on the vault. Computer Name of the computer registered to the vault. Job - Name of the Job registered to the vault. Backup Date Date and time of the backup session. Safeset the Safeset number created during this backup session. Backup Duration length of time that the backup session took. Original Size (GB) the amount of data that was backed up during this backup session. Delta Size (MB) the amount of changes extracted during the backup session (prior to compression). Result Result of the session, this value can be: Successful, Failed or unknown. Figure 8. - Backup Details Report Page 13

19 2.4 Backup Status Report This report lists successful, failed or missed backups for the last 24 hours, 3 and 7 days. It provides a simple, single-glance view of overall health of the backup solution. This report displays the following information: Vault Name of the vault. Customer The customer shortname as defined on the vault. Computer Name of the computer registered to the vault. Job - Name of the Job registered to the vault. Last Backup Date Date and time of the last backup session. Backup Duration The amount of time that the last backup session ran for. Original Size (GB) The amount of data in Gigabytes that was protected during the backup session. Delta Size (MB) The amount of data that was extracted by DeltaPro (prior to compression). Status Backup status of the Job. The status can be displayed as: Successful - last backup session completed successfully Failed - last backup session failed or is still running No Backup Last backup session completed more than 24, 72 or 168 hours ago (the time window is user selectable) Unknown Backup status is missing or the Job never backed up Figure 9. - Backup Status Report Page 14

20 2.5 Customers Report This report lists the service customers and vaults on which they reside. Support personnel and Resellers would find this report of most use. This report displays the following information: Vault Name of the vault. Customer The customer short name as defined on the vault. Customer name The full customer name as defined on the vault. Figure Customers Report Page 15

21 2.6 Environment Information Report This report lists the Operating System, OS version and Agent version for each computer that the Reports user has access to. The report can help when planning upgrade, migration or when attempting to identify environment details of all protected systems. This report displays the following information: Vault Name of the vault. Customer The customer shortname as defined on the vault. Computer Name of the computer registered to the vault. OS Type Operating System installed on the computer. OS Version Reported version of the Operating System. Agent Version Version of the EVault Agent installed on the computer. Agent Type Type of the Agent (e.g., Server, Desktop, SBE). Figure Environment Information Report Page 16

22 2.7 Grouped Storage Details (Data Age) Report This report shows the Vaults, Customers, Computers and Jobs that apply to your filter selection. It shows the number of Active (Online) Safesets associated with each Job (and totals), Computer, Customer, and Vault. Data Age refers to reports that show the age of data, grouped from 1-90 days, days, and over 365 days. Figure Grouped Storage Details (Data Age) Report Page 17

23 2.8 Grouped Storage Details (Original Bytes) Report This report shows the Vaults, Customers, Computers and Jobs that apply to your filter selection. It shows the number of Active (Online) Safesets associated with each Job (and totals), Computer, Customer, and Vault. Original Bytes refers to the size of the user s actual data on their machine. It is the size of the data that is protected by the backups. Figure Grouped Storage Details (Original Bytes) Report Page 18

24 2.9 Grouped Storage Details Report This report provides a breakdown of storage information for each Job, and then groups them by computer, customer and vault. Customers who want detailed information about storage for all or particular computers can use this report. This report displays the following information: Vault Name of the vault. Customer The customer short name as defined on the vault. Computer Number of computers registered on each vault. Job - Name of the Job registered to the vault. Active Safesets Number of Safesets that are available online for each Job. Original Size (GB) Total amount of data in Gigabytes that can be restored from all the online Safesets. Diskspace on Vault (GB) Amount of space utilized on the vault for each Job in Gigabytes. Figure Grouped Storage Details Report Page 19

25 2.10 Storage Details (Last Backup) Report This report shows the Original (Native) size of the last backup (Active/Online safeset), the disk space (physical size) for that pool, and the dates of the backup, prior to your selected date in the filter. The report shows the size, in GB, of the last safeset in the range, the number of Active (Online) Safesets, the date in your selected range, and the Job, Computer, Customer and Vault in your filter, associated with these Safesets. Figure Storage Details (Last Backup) Report Page 20

26 2.11 Storage Details (Original Bytes) Report This report shows the Original (Native) size of the user s actual data (Active/Online safesets) on their machine. It is the size of the data that is protected by the backups. The report shows the size, in GB, of the last safeset in the range, the number of Active (Online) Safesets, the date in your selected range, and the Job, Computer, Customer and Vault associated with these safesets. Figure Storage Details (Original Bytes) Report Page 21

27 2.12 Storage Details Report This report provides additional level of detail compared to the Storage Totals Report. Storage information is listed for each day and each Job. Results of this report can be exported to Excel or Access for further processing and to identify storage trends. This report displays the following information: Vault Name of the vault. Customer The customer short name as defined on the vault. Computer Name of the computer registered to the vault. Job - Name of the Job registered to the vault. Date Date of backup. Active Safesets Number of Online Safesets on the specific date. Original Size (GB) Amount of data that could be restored from all active Safesets. Diskspace on Vault (GB) Amount of data that was used by the Job on the specific date. Figure Storage Details Report Page 22

28 2.13 Storage Totals (Data Age) Report This report is similar to the "Storage Totals Report". It gives a table of numbers (Vaults, Customers, Computers and Jobs as of now) and a graph of disk space, from 1 to 90 days, 91 to 365 days, and older than 365 days. Figure Storage Totals (Data Age) Report Page 23

29 2.14 Storage Totals (Original Bytes) Report This report is similar to Storage Totals Report except that this gives the storage size as Original Bytes. This refers to the size of the user s actual data on their machine. It is the size of the data that is protected by the backups. The report displays the following information: Number of Vaults Number of vaults queried. Number of Customers Number of customers queried. Number of Computers Number of computers matching the selection. Number of Jobs Number of Jobs found that match the selection. Total Storage Space Total Original data size stored by these Jobs. Figure Storage Totals (Original Bytes) Report Page 24

30 2.15 Storage Totals Report This report provides the user with information on storage. Information can be obtained for a specific date range in order to see the storage fluctuation over time. To make the information easier to digest, a graph is included. All customers interested in storage footprint on the vaults (like EVault Protect customers) will find this report helpful. This report displays the following information: Number of Vaults Number of vaults queried. Number of Customers Number of customers queried. Number of Computers Number of computers matching the selection. Number of Jobs Number of Jobs found that match the selection. Total Storage (Disk Space) Amount of data stored by the Jobs. Note: The Storage Totals Report can be resource-intensive. Generating reports with time selections of greater than one month will take a longer period of time to complete. Totals are valid for the end date of the report run. Figure Storage Totals Report Page 25

31 2.16 Vault Extractor Status Report This report lists each vault that the user has access to and provides information on when each of the vaults last updated the EVault Reports. Support personnel and vault operators should use this report to assure that EVault Reports are providing up-to-date information. This report displays the following information: Name Name of the vault. Updated Date and time when information was last updated. Status - Current Status - Red means that the vault has not updated the EVault Reports in the last 24 hours. Black means it has. While the data is being accessed in the database, you may see the status in the following sequential steps: Loading data is being uploaded; not ready for viewing. Loaded data is uploaded, waiting for processing; not ready for viewing. Updating data is uploaded, being processed; not ready for viewing. Ready data is uploaded, processed; ready for viewing. There may also be an error message: Failed - data is uploaded, but processing failed. Figure Vault Extractor Status Report Page 26

32 2.17 Vault Summary (Data Age) Report This report is similar to the Vault Summary Report, which shows Vaults, Customers, OS, Computers, Jobs and Storage size. This report shows the storage size as diskspace used from 1-90 days, days, and over 365 days. Figure Vault Summary (Data Age) Report Page 27

33 2.18 Vault Summary (Original Bytes) Report This report is similar to the Vault Summary Report, which shows Vaults, Customers, OS, Computers, Jobs and Storage size. This report shows the storage size as Original (Native) bytes. This refers to the size of the user s actual data on their machine. It is the size of the data that is protected by the backups. Figure Vault Summary (Original Bytes) Report Page 28

34 2.19 Vault Summary Report This report provides a breakdown of storage information for each vault. Customers who want to get detailed information on storage for all vaults, or particular vault can use this report. This report displays the following information: Vault Name of the vault. Customers The number of customers on the vault OS A breakdown of Operating Systems backing up to the vault. Computers Number of computers registered on the vaults, by OS. Jobs Number of Jobs for each computer. Storage Amount of data stored on the vault, by OS. Figure Vault Summary Report Page 29

35 3 Report Manager The EVault Report Manager is a separate stand-alone program that runs on the IIS Server. From a web browser a user can set parameters for the reports and subscriptions. Once the parameters are set, the reports are automatically sent via Select Report Subscription When you run the Report Manager from your browser, you are taken to the first (main) page. The Subscription tab presents a pre-defined dropdown list of report types from which you can select. You cannot add or delete from this list of report types. Figure Report subscription selection From here, you can select (click on) a single report, if you know which one you want, or you can select "All Reports" from the dropdown list. This will show you all the existing subscriptions for reports that have at least one subscription. The "Show Schedule" button toggles on/off for displaying "Schedules" for a specific subscription, or for all subscriptions. The fields displayed are: Report Name, Description, Schedule, Last Run, and Status. Page 30

36 All Reports If you chose "All Reports" in Select Reports, you will see a list of all Reports that have subscriptions. Figure List of All Reports "All Reports" displays a list of subscriptions for the Reports that have at least one subscription attached to each one. From here, you can Create a new subscription, or Edit or Delete an existing subscription that you have selected (clicked on). The list displays these fields: Report Name (Types) Description - your description, one for each subscription, per report Schedule - the schedule you selected. Note: This may not appear if you have turned the "Show Schedule" button off. Last Run - when it was last run Status - latest status Page 31

37 Single Report If you have selected a single report, you can create a new subscription with the Create button. Or, if you select (click on) a subscription on a report, you can now Edit or Delete, as well as Create. Note: If there is no activity (by you) on any screen for a period of time (the default is 20 minutes), your session will "expire". Click New Session to return to the Subscriptions screen. Page 32

38 3.2 Create a New Subscription Choose a report and click Create. You can have multiple subscriptions for each report type. Description Tab Figure New - Description Tab Enter a description of your choice in the field. Click Next to proceed to the next screen. Note that the Description field must have one or more characters in it. Click the red X icon to continue. Page 33

39 Delivery Tab Figure New - Delivery Tab The Delivery tab lets you define where you want the report sent. In the subject are reserved words (ie: variables). You can use them or replace them with your own words. This line becomes the "Subject" line in the s. Comments are optional. They will appear in the body of the . The "From" address on these s can be specified by the Administrator, in Microsoft SQL Server Reporting Services. See Chapter 5 - EVault Reports Installation. You must have at least one valid "To" address. All addresses must be valid. Valid here means "syntactically" correct. addresses cannot be checked for being a "real" (working) address. That will show as an error in the status when the is attempted. Multiple addresses are separated by semicolons. CC and BCC are optional. The "Render Format" choices are dependent on how the report was created with "Report Display Options". HTML is available for all reports, but PDF documents and CSV files may be unavailable for some reports. Click Next to proceed. Page 34

40 Scheduling Tab Figure New - Scheduling Tab The Scheduling tab lets you enter a start and stop date. If there is no stop date, it will run forever. Between these start and stop dates you can select to run the report one of: hourly, daily, weekly, monthly or just once. Choose a "Begin" and "Stop" day from the calendars (click the calendar icon). Or, if you select (highlight) one of the Month, Day or Year fields, you can use the up and down arrows to increase/decrease the date. You may have multiple subscriptions to cover all Reports for many different times and dates and cycles. Choose one of Hour, Day, Week, Month, or Once from the dropdown list. Hour - This runs the schedule at the time interval you select, regardless of day, week or month. So, for example, you can choose every hour, or two hours, or three and a half hours as your interval. Choose a time for the first time. Day - You may want to have some of your Reports sent on a particular day of the week, or only on certain days. Or you may want your Reports every certain number of days, regardless of the day of the week. Choose one or more days from Sun to Sat every weekday (Mon, Tues, Wed, Thu, and Fri), repeat every # of days (1 = every day, 2 = every second day, 3 = every third day, and so on), starting from the time you select. Page 35

41 Week - You may want some of your Reports to come every week, or second week, etc. on a certain day, at a particular time of day. Choose to repeat every 1, or 2 or 3, etc. weeks, on the following (Sun through Sat) days, starting from the time you select. Month - You may want some of your Reports every month, either by the week of the month, or a calendar day, or days. Choose one or more of the months, and then choose either a week or calendar day. Week of the month is first, second, third, fourth or last. Calendar day is 1st, 2nd, 3rd and so forth. You can specify single days, separated by commas (for example: 1,2,3) or a range (for example: 5-12), or both (for example: 1,2,3,5-12,24-26). Once - If you only need a report one time only, you can choose a time to start it. This can be as little as the next five minutes. Choose a start date and time. This can be down to a five-minute time setting. For example, 10:25 AM, or 3:15 PM. Time Zones The Scheduling Tab shows "all times are expressed in" followed by the local machine's time zone setting - for example "EST". This is followed by the Greenwich Mean Time (GMT) offset. To change time zones, you much change the time on your PC, and reboot the machine to have EVault Reports show the change. Page 36

42 Report Parameters Tab The Report Parameters tab lets you choose what fields (columns) you want in the report. You can select what you want, as well as what you want it sorted by, and in Ascending or Descending order. The parameters are dependent on the particular report. Figure Report Parameters Tab If you do not enter a value for one of the blank fields, it will assume ALL Vaults, Customers, Computers, Types, etc. A value of ALL will appear in the summary as a percent symbol (%). You can sort the report by one of the fields, and have it in either Ascending or Descending order. Note: Depending on the report you have selected, there may be more or less fields to use. For example, if a report uses a date range, you will have a Date field. The Time Zone field allows you to set (customize, to match your area) the time zone as an offset for all data in the report. Page 37

43 Customers Tab The Customers tab lets you choose to report on ALL Customers, or you can enter one or more names. Figure New - Customers Tab You must type the names in. The Customer here is the "short" name. See the "Customers Report" for examples. The short name does not contain spaces, commas or semicolons, whereas the full (descriptive) Customer name may contain them. If you enter more than one customer name, they can be separated by either a space, comma or semicolon, or a new line (the Enter key). Duplicate names are not allowed here. You cannot enter the same name more than once. Page 38

44 Subscription Summary Tab The Subscription Summary tab lets you review your parameters before you click Finish. Or you can click Cancel to end without saving your changes. Figure Subscription Summary Tab Once you have created a new subscription, you may choose to edit or delete it from the Subscriptions screen. Page 39

45 3.3 Edit an Existing Subscription The six tabs in Edit are the same as Create Subscription: Description tab - describes your selected subscription. From here, you can only change the text in the Description field. Note: You do not need to click after each tab. You only need to click "Update" once for this subscription, after you have modified all the tabs that you require. The "Cancel" button lets you get out without saving your changes. Delivery tab - lets you define where you want the report sent. In the subject are reserved words (ie: variables). You must have at least one valid "To" address. Multiple addresses are separated by semicolons. "Render Format" can be an HTML , a PDF document, or a CSV file. Scheduling tab - lets you enter a start and stop date. If there is no stop date, it will run forever. Between these start and stop dates you can select to run the report hourly, daily, weekly, monthly or just once. Report Parameters tab - lets you choose what fields (columns) you want in the report. You can select Activity Type, and Results, as well as what you want it sorted by, and in Ascending or Descending order. Customers tab - lets you choose to report on ALL Customers, or you can enter one or more names. You must type the name in, one customer to a line. Subscription Summary tab - lets you review your parameters before you click the "Update" button. Or you can Click "Cancel" to end without keeping your changes. If you go back to one of the tabs, and make changes there, you can click the Update button from there. Note: Both Edit and Create may give you informational error messages that warn you of an incorrect situation. For example, you cannot have an empty list, or use duplicate Customer names. Figure Example Error Message Click the red "X" icon to correct and re-enter the information. Page 40

46 3.4 Report Groups The Report Group tab manages group association with reports. These groups are used to limit users to seeing only those reports in the group. There is a default group that includes all reports in the group. You can create your own group and choose what reports are available to that group. See "XML Login File Format" in Section 6 of this manual for information about assigning users to groups. See Section 2 of this manual for a description of the reports available. Figure Report Groups - Default Page 41

47 You can create a new group, or edit or delete an existing one, and select reports to be available to that group. Figure Report Groups - New Page 42

48 4 EVault Reports Typical Installation The installation kit can install EVault Reports as a Simple/Typical installation, or as a Custom installation, on a fresh (new) system. The Simple installation allows you to install everything on one machine, and get going rapidly. The machine can be the vault machine, or a separate one. Note that migrating from EVault Reports 2.70 requires some manual steps. See Migrating from EVault Reports The Custom installation (see the next chapter) allows you to install the separate pieces on multiple machines. It can also have more security and customization. 4.1 Prerequisites A supported version of Microsoft SQL Server, with SQL Server Reporting Services, must be installed and running. Internet Information Services (IIS) server 7 is required. ASP.NET 3.5 SP1 Framework is required. Page 43

49 4.2 SQL Server Reporting Services Configuration EVault Reports uses SQL Server Reporting Services for sending reports. An administrator must configure the Sender Address and SMTP Server for the reports to be sent. From Microsoft SQL Server 2008 R2 > Configuration Tools, click Reporting Services Configuration Manager. Select your machine and instance. Click Settings to specify your Sender Address and SMTP Server. Figure Configure Report Server For information about how to allow a user other than the default administrator to access these services, see Allowing Another User to Access Reporting Services on page 88. Page 44

50 4.3 Installation Overview The same installation kit installs all of the web reporting components for the Typical Installation, or the Custom Installation. Reports Database Loader (Web Service) Report Viewer Token Manager (Web Service) Login NT Authentication Report Manager Note: "Token Manager" and "Login" are not needed or installed for the Typical Installation. For a Custom Installation, you would use these components. You can add or remove any of these components after an installation with the Modify option. The SynchWeb (Extractor) program is not a part of the EVault Reports installation. It is a vault component, and is installed on the vault system. See Chapter 4 of this Guide. After this EVault Reports installation, you must configure the SynchWeb program to give it the name and address of the Reports database, so that the vault can send its report data there. Briefly, the installation steps (discussed in detail later) are: Start the installation - Welcome screen View Support Notes Accept software license agreement Choose to run a Typical installation Group access to reports SQL Server setup Report viewer Integrate with Web CentralControl Begin the installation When the installation finishes, start the browser (optional). You must also configure settings (with SQL Server "Configuration Tools") for subscription reports to be ed. Page 45

51 4.4 Typical Installation This section describes the steps involved in the installation. The installation runs from InstallShield, which takes the user through the steps. Welcome Dialog: Simply states what product is being installed. View Notes: Allow the user to read information on the product being installed. Both Release Notes and Support Notes can be read and printed from this dialog. Software License Agreement: Ensure the user accepts the terms of the software license agreement before installing the software. Install Type: Choose a Simple (Typical) installation. This will install all of the necessary components on the same machine. Figure Install Type - Typical Page 46

52 The installation checks to see whether or not ASP.NET is currently installed and enabled. If ASP.NET is not enabled, the installation will enable (register) it. Note: The.NET Framework is a development and execution environment that allows different programming languages and libraries to work together seamlessly to create Windows-based applications that are easier to build, manage, deploy, and integrate with other networked systems. See Microsoft s web site for more information. You only see this message the first time on a new installation. Access Restriction: Figure Access Restriction Access Restriction allows you to decide who will be able to view Reports. Page 47

53 SQL Server Setup - Select SQL Server: Figure SQL Server Setup For this Typical installation, your SQL server is local. The authentication requires the login ID and password that the DBA used to create the database. This component requires SQL Server and SQL Server Reporting Services. The Reports Database is responsible for installing the report templates as well as the Web Reporting database, views and stored procedures. As a security measure, you have to enable Named Pipes and TCP/IP protocols. Use "SQL Server Configuration Manager". Figure Named Pipes and TCP/IP Protocols Page 48

54 Report Viewer - MS SQL Server Reporting Services Username. This is the username and password required to access Reporting Services, rather than the SQL database. Generally, this is a domain account or a local account on the Reporting Services machine that has access to the Reporting Services website/web service. Figure Report Viewer account This allows the Viewer to connect to the SQL Server Reporting Services. Page 49

55 Integrate with Web CentralControl. You must select a Web CentralControl that will interface with the EVault Reports. You can choose it now, or later. Figure Report Viewer account Integration to Web CentralControl Page 50

56 Integrate with Web CentralControl later. If the Web CentralControl is not available right now, you can configure it later. Figure Report Viewer account Could not connect Begin the Installation Figure Begin the installation It runs automatically from here. You see the "InstallShield Wizard Complete" screen. Page 51

57 Do you wish to open the start page in your Browser now? This is optional. Figure Open the Start page If you say yes, you are brought to the start page to be able to select (Launch) the Reports Viewer, or the Reports Manager. Figure Report Viewer and Report Manager Page 52

58 4.5 SSL Implementation SSL (Secure Socket Layer) can be used for Internet security for Login, Report Viewer and Report Manager through Internet Explorer and HTTPS. SSL uses a cryptographic system that uses two keys to encrypt data a public key known to everyone and a private or secret key known only to the recipient of the message. By convention, URLs that require an SSL connection start with https: instead of The following steps are intended to be used by an Administrator familiar with EVault Reports and Microsoft s SSL functionality. Follow Microsoft's instructions for obtaining and installing an SSL certificate on IIS and to use HTTPS protocol. No changes are necessary on the Report Manager. You should now be able to access the sites using https with the IE browser. Page 53

59 4.6 Modify, Repair/Upgrade and Uninstall If you run the Installation program again, after you have installed EVault Reports, you have a choice of doing a Modify, Repair/Upgrade or Uninstall. You Modify an existing installation, to add or remove components. You Repair an existing installation in case or corruption. You Remove (uninstall) an existing installation when you do not want it anymore. Figure Modify, Repair/Upgrade or Uninstall Page 54

60 Modify Figure Modify installed components See the Custom Installation chapter for more information on the components here. Reports Database Loader (Web Service) Report Viewer Token Manager (Web Service) Login NT Authentication Report Manager Note: "Token Manager" and "Login" are not needed or installed for the Typical Installation. For a Custom Installation (See Chapter 5), you would use these components. You can add or remove any of these components after an installation with the Modify option. See Chapter 5 "Custom Installation" for details on each of the components listed here. Note: If you de-select everything, you will be doing a complete uninstall. Page 55

61 Repair If you run the installation kit with the same version as the EVault Reports that are already installed, you see the "Repair" option. Figure Repair all components You are prompted for the EVault Reports SQL Server, and the authentication for it. Then you are asked: Do you wish to Repair all currently installed components? Upgrade Before upgrading EVault Reports, back up the UserCustomer.xml file in the main directory of the ERLogin web application (C:\inetpub\ERLogin). An upgrade sometimes overwrites the UserCustomer.xml file. If this occurs, users will not be able to log in. You can then restore the backed up UserCustomer.xml file. Page 56

62 Note: This version of EVault Reports cannot be upgraded directly from an earlier 2.70 version, just by using upgrade on the installation kit. The next section of this Guide describes how to upgrade/migrate from version 2.70 to the current version. If you have a version of EVault Reports earlier than 2.70, you must upgrade it to 2.70 before you can upgrade it. See the Release Notes for previous supported versions. Uninstall If you run the uninstall option, you are prompted to remove or leave the SQL database that holds the reporting data. Figure Uninstall - Remove or Leave Database If you want to remove the database, you are prompted for the EVault Reports SQL Server, and the authentication for it. You next see a message: "Are you sure you want to proceed?" to complete the uninstallation. Page 57

63 5 Migrating from EVault Reports 2.70 If you are using EVault Reports 2.70, you cannot directly upgrade to EVault Reports Instead, you must: Migrate from EVault Reports version 2.70 to EVault Reports version 2.71 using the following steps: o Back up your existing database. o Install EVault Reports 2.71 on a platform supported for EVault Reports o o Restore the original database on the new database. Run a repair after installing EVault Reports and restoring the database. This updates the restored version 2.70 database to version Upgrade EVault Reports from version 2.71 to version You cannot use EVault Reports version 2.70 components with EVault Reports version 2.71 components. You must move all components to the new version of EVault Reports and the operating system. Note: Migrations from versions prior to 2.70 are not supported. 5.1 Disabling User Access and Web Services In a distributed installation, these services might be installed on different computers. You must stop all services before continuing the migration. To disable user access and web services: 1. Disable access to the EVault Reports Loader Web Service. 2. Disable access to the EVault Reports Token Manager Web Service. 3. Disable access to the EVault Reports Report Viewer. 4. Disable access to the EVault Reports Report Manager. 5. Disable access to the EVault Reports Login page (if used). 5.2 Stopping the SQL Server Agent Service To stop the SQL Server Agent Service on the original database computer: 1. Click Start > Administrative tools > Services. 2. Find the SQL Server Agent for the SQL instance where the EVault Reports database is installed. 3. Right-click the service and click Stop. 5.3 Backing up the EVault Reports Version 2.70 Database 1. Launch SQL Server Management Studio. Page 58

64 2. Connect to the server. 3. Expand the databases. 4. Right-click the EVault Reports database and select Choose Tasks. 5. Choose Backup. 5.4 Installing EVault Reports 2.71 Install EVault Reports 2.71 on a platform supported for EVault Reports This installation will later be upgraded to EVault Reports Note: You cannot install EVault Reports 2.71 on Windows Server 2012 with SQL Server Instead, install EVault Reports 2.71 on Windows Server 2012 with SQL Server 2008 R2 installed. You can then upgrade the SQL Server version to SQL Server When you install the new operating system and associated components, verify that you have configured each application and computer to replicate the previous environment. Your new environment should use the same external domain name, so that you will not need to update the vault extraction configuration files and end user s bookmarks. Do not connect your new computers to the computers used for the EVault Reports version 2.70 installation. Install the Reports Database component on the correct computer before recovering the database. If you do not install the Reports Database in the correct sequence, Jobs and report templates are not installed and the reports do not function. If your previous installation used the sample EVault Reports login page, you must copy the UserCustomer.xml file from the old computer to the new computer. The UserCustomer.xml file is located in the main directory of the ERLogin web application (C:\inetpub\ERLogin). 5.5 Disabling Access to EVault Reports and Web Services To disable access to EVault Reports and Web Services on the new computers: 1. Disable access to the EVault Reports Loader Web Service. 2. Disable access to the EVault Reports Token Manager Web Service. 3. Disable access to the EVault Reports Report Viewer. 4. Disable access to the EVault Reports Report Manager. 5. Disable access to the EVault Reports Login page (if used). 5.6 Stopping the SQL Server Agent Service To stop the SQL Server Agent Service on the new computer: 1. Click Start > Administrative Tools > Services. 2. Navigate to SQL Server Agent. 3. Right-click the SQL Server Agent and select Stop. Page 59

65 5.7 Restoring the 2.70 EVault Reports Database To restore the EVault Reports database to the new EVault Reports installation: 1. Copy the backup database file you created in Backing up the EVault Reports Version 2.70 Database to the new EVault Reports 2.71 computer. 2. Launch SQL Server Management Studio and connect to the EVault Reports 2.71 database server. 3. Right-click Databases and select Restore. 4. Select the EVault Reports database in the To database field. 5. Click From database and select the 2.70 database backup in the Source for restore area. 6. Click Restore in the Select the backup sets to restore area. 7. Click Options in the Select Page pane and select Overwrite the existing database (WITH REPLACE). 8. Click OK. If you receive a message indicating the database is in use, verify that you have disabled user access, web services, and all Jobs. After you complete your verification, try to restore again. 5.8 Repairing EVault Reports 1. Install EVault Reports. 2. Select Repair to update the restored database. 5.9 Verifying the EVault Reports Compatibility Mode To verify that the database is set to SQL Server 2008: 1. Launch SQL Server Management Studio and connect to the EVault Reports 2.71 database server. 2. Right-click the database and select Properties. 3. Choose Options. 4. Verify that the Compatibility level field displays SQL Server 2008 (100). Page 60

66 5.10 Starting the SQL Server Agent Service 1. Click Start > Administrative Tools > Services. 2. Navigate to the SQL Server Agent. 3. Right-click the SQL Server Agent and select Start Enabling Access and Verifying the Installation To enable access and verify the EVault Reports installation: 1. Enable access to the EVault Reports Loader Web Service. 2. Enable access to the EVault Reports Token Manager Web Service. 3. Enable access to the EVault Reports Report Viewer. 4. Enable access to the EVault Reports Report Manager. 5. Enable access to the EVault Reports Login page (if used). 6. Verify you can log in to EVault Reports using the same method you used for EVault Reports version Removing Previous Versions of EVault Reports After verifying that your EVault Reports 2.71 installation is working correctly, remove all previous versions of EVault Reports Upgrading to EVault Reports 2.74 After EVault Reports has been successfully migrated from version 2.70 to version 2.71, run the EVault Reports 2.74 installation kit to upgrade EVault Reports to version Before upgrading EVault Reports, back up the UserCustomer.xml file in the main directory of the ERLogin web application (C:\inetpub\ERLogin). An upgrade sometimes overwrites the UserCustomer.xml file. If this occurs, users will not be able to log in. You can then restore the backed up UserCustomer.xml file. Page 61

67 6 EVault Reports Custom Installation A Custom Installation can be done "fresh" on a clean system. You can also customize through the Modify option on a system that has the same version of EVault Reports. See section The installation allows you to install everything on one machine, or install components individually in a distributed environment. The machine can be the vault machine, or a separate one. Note that upgrading an earlier 2.70 EVault Reports to a 2.71 version requires some manual steps. See the migration chapter of this guide. 6.1 Diagram of Component Interaction The following diagram illustrates how each of the components in the reporting system interact with each other. The login site does not come as part of the installation process. This site refers to a central login site that should already exist on the corporate web site. If one does not already exist, it will need to be created. For information about how to modify your login site to integrate the EVault Reports system, refer to the Single Sign On (SSO) Implementation section. Figure TCP Initiation Communication Interaction Notes: Port 1433 is the default port for the SQL Server Agent. Port 80 is the default HTTP port. Page 62

68 Loader (Web Service) This component installs the data loader web service. This service is responsible for sending data passed by the data extractor to the Reports Database. Notes: This component needs to be installed on an IIS Server. This component requires the Reports Database to already be installed (or selected during installation of this component). Token Manager (Web Service) The Token Manager is responsible for creating and managing authentication tokens to allow users to view reports through the Report Viewer web application. Notes: This component needs to be installed on an IIS Server. This component requires the Reports Database to already be installed (or selected during installation of this component). Report Viewer (Web Application) This component installs the Report Viewer web application. Notes: This component needs to be installed on an IIS Server. This component requires the Token Manager to already be installed (or selected during installation of this component). Login (Web Application) This component creates a sample log so that a user can view reports immediately after installation (without configuring a login application). Page 63

69 6.2 Configuration Files Each of the web components contains configuration files called web.config which are located in the root directory for each component s installation. Since these components all interact together in a distributed architecture, each component contains the locations of the other components that it interacts with. The installation process updates these settings. If for some reason components are not communicating with each other, these settings may need to be verified. These files are XML-based. Each web.config file contains a section at the top of the file called <appsettings>. The following subsections describe the settings that are needed for component interaction. Data Loader Web.config The Data Loader needs a connection to the Web Reporting database. For example: <add key="databaseconnectionstring" value= server=<ip address>; database=webrep; uid = sa; pwd=password; /> Token Manager Web.config The Token Manager also needs a connection to the Web Reporting database. For example: <add key="databaseconnectionstring" value="server=<ip address>; database=webrepbeta; uid=sa; pwd=;" /> Report Viewer Web.config The Report Viewer needs the locations of the Token Manager, the SQL Server Reporting Services, and the login page. The location of the login page is used to redirect users when they log out of the Report Viewer application. Here are some example settings: <add key="loginurl" value=" address>/login/login.aspx" /> <add key="webrep.reports.viewer.tokenmanager.tokenmanager" value=" address>/tokenmanager/tokenmanager.asmx"/> <add key="webrep.reports.viewer.reportservice.reportingservice" value=" address>/reportserver/reportservice.asmx"/> The Report Viewer requires a Windows account user name and password that has privileges to connect to the SQL Server Reporting Services machine. The credentials are populated with information collected from the user: <add key="rsusername" value="" /> <add key="rspassword" value="" /> <add key="rsdomain" value="" /> Page 64

70 6.3 Installing Components By default, the installer assumes that you are doing a new, clean installation of EVault Reports, using the Custom Installation feature. If you have previously installed EVault Reports through Custom Installation, you can use the Modify option to add the required components. The installation kit can install EVault Reports as a Simple/Typical Installation (see Chapter 5), or a Custom Installation (this chapter). Simple installation allows you to install everything on one machine for a rapid start. Custom installation allows you to install separate pieces on many machines. It can also provide more security and customization. 6.4 Prerequisites Microsoft Windows Server 2008 R2 (64-bit, Standard, Enterprise or Datacenter) Microsoft SQL Server 2008 R2, with SQL Server Reporting Services, needs to be installed and running. This is not part of the EVault Reports installation. Internet Information Services (IIS) server 7 is required. This is not part of the EVault Reports installation. ASP.NET (3.5) Framework is required. (EVault Reports does not install this, but it does register it.) 6.5 SQL Server Reporting Services Configuration EVault Reports uses SQL Server Reporting Services to send reports. An Administrator must configure the Sender Address and SMTP Server for the reports to be sent. From Microsoft SQL Server 2008 R2 > Configuration Tools, click Reporting Services Configuration Manager. Select your machine and instance. Click Settings to specify your Sender Address and SMTP Server. Page 65

71 6.6 Installation Overview The same installation kit installs all of the web reporting components for the Typical Installation, or the Custom Installation, on a fresh (new) system. Note that upgrading an earlier 2.70 EVault Reports to a 2.71 version requires some manual steps. Reports Database (install this first) Loader (Web Service) Report Viewer Token Manager (Web Service) Login NT Authentication Report Manager Note: You can add or remove any of these components after an installation with the Modify option. The SynchWeb (Extractor) program is not a part of the EVault Reports installation. It is a vault component, and is installed on the vault system. Refer to the EVault Extractor Guide. After this EVault Reports installation, you must configure the SynchWeb program to give it the name and address of the Reports database, so that the vault can send its report data there. Briefly, the installation steps (discussed in detail in the next section) are: Start the installation - Welcome screen View Support Notes Accept software license agreement Choose to run a Custom installation Select Features (components to install) Allow access to Reports SQL Server setup Select SQL database Select installation path for Login Enter Login virtual directory name Login configuration Information Configure Report Viewer Report Viewer virtual directory name Page 66

72 Reporting Services username Report Viewer configuration information Report Manager installation path Report Manager virtual directory name Integration to Web CentralControl Begin the installation Note: For custom installations, if you install the Report Viewer component and the NT authentication component on the same server, it is not necessary to install the Token Manager or Login components. You can install the Report Viewer without the NT authentication component, but you must also install the Token Manager and Login components. For example, the SQL Database, Report Manager and Loader components could be on <Server1>. The Report Viewer component could be on <Server2>. And the Token Manager and Login components could be installed on <Server3>. Or, for example, the SQL Database, Report Manager and Loader components could be on <Server1> and the Report Viewer and NT authentication components could be on <Server2>. Note: When logging on with Windows authentication, the report viewer page does not display a logout option. Closing the viewer will end the session. Page 67

73 6.7 Custom Installation Steps This section describes the steps involved in the installation. The installation runs from InstallShield, which guides the user through the steps. Welcome Dialog: Simply states what product is being installed. View Notes: Allow the user to read information on the product being installed. Support Notes can be read and printed from this dialog. Software License Agreement: Ensure the user accepts the terms of the software license agreement before installing the software. Install Type: Choose an Advanced (Custom) installation. The Custom installation allows you more flexibility with the installation. The components can be installed on different machines, instead of all together on one. Figure Install Type - Custom The installation checks to see if ASP.NET is currently installed and enabled. If ASP.NET is not enabled, the installation will enable (register) it. Note: The.NET Framework is a development and execution environment that allows different programming languages and libraries to work together seamlessly to create Windows-based applications that are easier to build, manage, deploy, and integrate with other networked systems. See Microsoft s web site for more information. You only see this message the first time on a new installation. Page 68

74 Select Features: Figure Select Custom Features Note: You cannot select Login and NT Authentication together. Page 69

75 Access Restriction: Figure Access Restriction Access Restriction allows you to decide who will be able to view reports. Page 70

76 SQL Server Setup - Select SQL Server: Figure SQL Server Setup Select Server The authentication requires the login ID and password that the DBA used to create the database. Page 71

77 SQL Server Setup - Select SQL Database: Figure Select SQL Database Note: If you are selecting a name for the database, in a Custom Installation, you must not use "ReportServer" or "ReportServerTempDB" for the name if you are creating a new one. These are reserved names. Also, the database must be empty, or populated from a previous installation. You may see a warning message: The database selected for installation either must be empty, or filled with the tables from a previous EVault Reports installation. The currently selected database does not meet these requirements. Please select another database. You are prompted to create this Database. Page 72

78 After the Reports Database has been installed, check that the SQL Agent has started. This component requires SQL Server and SQL Server Reporting Services. The Reports Database is responsible for installing the report templates as well as the Web Reporting database, views and stored procedures. As a security measure, you have to enable Named Pipes and TCP/IP protocols. Use "SQL Server Configuration Manager". Figure Named Pipes and TCP/IP Protocols Login - Select Installation Path: Figure Configuring Login Page 73

79 Login - Enter Virtual Directory Name Figure Virtual Directory Name Note: The default here, ERLogin, is intended to be different from the default Login directory name that Web CentralControl uses. If you are installing both products on one server, if any Virtual Directory Names are the same, one will overwrite the other. You will have this problem if they are on different machines. Page 74

80 Login - Configuration Information Figure Login Configuration Information If you are using a different machine for the Token Manager, or the Report Viewer, enter the IP address, or DNS name of the machine. Page 75

81 Configuring Report Viewer Figure Configuring Report Viewer - Installation Path Page 76

82 Enter Virtual Directory Name Figure Configuring Report Viewer - Virtual Directory Name Page 77

83 14 - Reporting Services Username. This is the username and password required to access Reporting Services (not the SQL database). Generally, this is a domain account or a local account on the Reporting Services machine that has access to the Reporting Services website/service. Figure Configuring Report Viewer - Reporting Services Username Page 78

84 Report Viewer - Configuration Information. Figure Report Viewer - Configuration Information Note: If the other components are still to be installed after the current setup, you should still enter the web addresses of those components in this configuration screen. The connection attempt will fail, and give a message such as: Could not connect to the following <...> due to 404 not found. Continue assuming remote site will be installed or configured separately from this installation? You should answer Yes to this and continue the installation. Page 79

85 Report Manager - Installation Path Figure Report Manager - Installation Path Page 80

86 Report Manager - Virtual Directory Name Figure Report Manager - Virtual Directory Name Page 81

87 Report Manager Integration to Web CentralControl Figure Report Manager Integration to Web CentralControl Enter the web addresses where the Web CentralControl applications reside. You are asked InstallShield has now collected all the necessary information. Would you like to begin the installation? The installation runs automatically from here. You see the "InstallShield Wizard Complete" screen. Note that you will not see a start screen (like Typical) for a Custom Installation. There is a default (Sample) Login screen for Reports. To access the Report Manager, you can enter a URL directly. For example: Page 82

88 Sample Login A sample login page can be installed through the installation kit, which will give basic login functionality. This login page is not secure and is intended for testing and evaluation of the EVault Reports system only. SECURITY NOTE: The passwords are kept in plain text in an xml file, which creates a security risk. This Sample login page should be removed when the EVault Reports system authentication is integrated into an existing User Management System. See the section on Single Sign On (Chapter 7) to see how to integrate the EVault Reports System. Figure Sample Login The sample login page uses an xml file to control the user access. This file is located in the Login's installed directory, in a file called UserCustomer.xml. By default, there is a default group (one that has access to all customers) configured in the file with the username "login" and the password "password". This user should be changed after installation. Page 83

89 There are several sample users included to show how to create new users and associate them with customers: user id "username" and password "password" in reportgroup A: This user would have access to only customer "aaa" and "bbb". user id "guest" and password "password" in reportgroup B: This user would have access to only customers "ccc", "ddd", and "eee". To add new users to the Web Reporting System, copy one of the example reportgroups, change the username and password, and associate the appropriate customer(s) to it. XML Login File Format The format of the xml file is as follows: <?xml version="1.0" encoding="utf-8"?> <UserList> <User id="login" password="password" reportgroup="<default>"> <Customer name="<all>" /> </User> <User id="username" password="password" reportgroup="a"> <Customer name="aaa" /> <Customer name="bbb" /> </User> <User id="guest" password="password" reportgroup="b"> <Customer name="ccc" /> <Customer name="ddd" /> <Customer name="eee" /> </User> </UserList> Where: login - is the users login. username- is the username of the user. password-: is the password associated with that user. reportgroup-: allows a user in this group to be able to see the Reports associated with this customer. Page 84

90 customer name-: is the shortname of a customer this user should be associated with. If the user should be able to see all the customers, the option "<ALL>" can be specified. Otherwise, the customer name must match exactly with the customer's short name on the vault. There can be one or more customers associated with the same user. To associate more users, add another <Customer name="xxx" /> line in the <User id> section. 6.8 SSL Implementation SSL (Secure Socket Layer) can be used for Internet security for Login, Report Viewer and Report Manager through Internet Explorer and HTTPS. SSL uses a cryptographic system that uses two keys to encrypt data a public key known to everyone and a private or secret key known only to the recipient of the message. By convention, URLs that require an SSL connection start with https: instead of The following steps for a Custom Installation are intended to be used by an Administrator familiar with EVault Reports and Microsoft s SSL functionality. Note: Steps 2 and 3 are not included in a Simple Installation. Follow Microsoft's instructions for obtaining and installing an SSL certificate on IIS and to use HTTPS protocol. The web.config for the Login must be changed to point to the secure Report Viewer by changing the web.config file. Find the key "ReportServerUrl" and change the first part of the value from " to " The web.config for the Report Viewer must be changed to point to the secure Login and secure Report Manager by changing the web.config file. Find the key "LoginUrl" and change the first part of the value from " to " Find the key "SubscriptionUrl" and change the first part of the value from " to " No changes are necessary on the Report Manager. You should now be able to access the sites using https with the IE browser. Page 85

91 7 Single Sign On (SSO) Implementation This section shows MSPs how to integrate EVault Reports into their systems so that users can retain their sign-ins, and be able to access the EVault Reports system. 7.1 Login The Web Reporting System authentication is embedded into the existing User Management System. After a user successfully logs into it from the MSP s User Management System, the User Management System needs to do the following steps so that the user can access the Web Reporting System. Request a token (a GUID string) from the Token Manager Web Service and pass the login name and the customer list that belongs to the login user, to the Token Manager Web Service. otokenmanager.createtokenfromxml(usercustomerxml, out stoken); or otokenmanager.createtoken(login, CustomerArray, out stoken); Append this token string to the URL of the hyperlink, or to the link button that will redirect to the Web Reporting System when clicked. Reporting System URL]/smartlink.aspx?token=[sToken] Login Page User Name: Password: OK 1: Provide User Credentials 6: Redirect the user to the user specific page 4: Pass control to the web Reporting application along with the Token: Web Reporting Web Application Existing User Management System 2: Verify User Credentials 3: If the verification succeeds save Authentication Token along with other information required by the Web Reporting system Authentication Sharing Web Service 5: Obtain all the information from the Sharing Service based on the Token Figure Flow of SSO Elements Page 86

92 7.2 Token Manager Web Service The purpose of this web service is to provide a set of interfaces that can be called from the MSP s existing User Management System and the Web Reporting System. This allows sharing of user and customer information, and the login token, between systems. Interface int DeleteToken ([in] string tokenid) Delete token; This is called from the Web Reporting System when user logs out or Session times out. tokenid: token to be deleted return: 0: success, non-0: fail int CreateToken ([in] string userid, [in] string[] customerarray, [out] string tokenid) Create Token for the user. This is called from the MSP s existing User Management System to get a token needed for the Web Reporting System for the user. userid: login name customerarray: customer list that belongs to the current user tokenid: token that was generated from the token manager web service Return: 0: success, non-0: fail int CreateTokenFromXML ([in] string userinfoxml, [out] string tokenid) Create Token for the user. This is called from the MSP s existing User Management System to get a token needed for the Web Reporting System for the user. The user and customer information that is passed to the Token Manager Web Service is an XML string. userid: login name userinfoxml: string that contains the customer list and other information that belongs to the current user. tokenid: the token returned from the Token Manager Web Service. Return: 0: success, non-0: fail int ValidateToken([in] string tokenid, [out] bool isvalid, [out] string userid) Validate token. This is called by the Web Reporting System when user is redirected from MSP s User Management System to the Web Reporting System. tokenid: token generated by the Token Manager Web Service. isvalid: returns true if the token is in the Web Reporting System; otherwise returns false. userid: login name associated with the token in the Web Reporting System. Return: 0: success, non-0: fail Page 87

93 8 Appendix 8.1 Allowing Another User to Access Reporting Services To allow a user other than the default administrator to access SQL Server Reporting Services, create another user account (for example, EVRSupport) in the Administrator group, and perform the following procedure. 1. Install EVault Reports under the account name of the new administrator (for example, EVRSupport). 2. From Microsoft SQL Server 2008 R2 > Configuration Tools, click Reporting Services Configuration Manager. 3. The Reporting Services Configuration Connection page opens. Specify your Server Name and Report Server Instance. Click Connect. 4. The reporting services Connect page opens. Click Report Manager URL. 5. The Report Manager URL page opens. Click the URL that displays. Page 88

94 6. The Windows Security page opens. Enter the User name and Password for the default administrator. Click OK. 7. The reporting services Home page opens. Click the EVaultReports folder. 8. A page opens for the EVaultReports folder. On the menu bar, click Folder Settings. Page 89

95 9. On the page that opens, click Security. 10. On the page that opens, click Edit Item Security. 11. A page called Message from webpage opens. Click OK. Page 90

96 12. On the page that opens, click New Role Assignment. 13. The New Role Assignment page opens. In the Group or user name field, enter the user name of the (new) administrator who performed this installation. Enable Browser and Content Manager within the Role list. Click OK. 14. Close your browser. The new administrator should now be able to view EVault Reports correctly. Page 91

97 8.2 EVault Reports Extractor (SynchWeb) FAQ The following is a list ( Frequently Asked Questions ) of some of the errors that a user can get when using the SynchWeb program. An explanation of the error and a suggested resolution is provided. Error collecting storage information Problem: Usually this error indicates a problem with the pool system. Resolution: The vault administrator should perform VVPoolOp /checkcrc JOB <JobID> or VVPoolOp /ssiverall JOB <JobID> to discover details about the problem. Example: Jan06 10:06 VVLT-E-0003 Error collecting storage information. Job name = bad, Tid = System.Runtime.InteropServices.SEHException: External component has thrown an exception. at Pool.PoolProperties.getJobPhysicalSize(PoolProperties*, _Job* ) at Evault.SynchWeb.Bridge.DataAccess.getStorageRecords(UInt32 JobID, StorageRecord[]& record) at Evault.SynchWeb.Collector.Collector.collectStorageRecords(Object stateinfo) Internal error. The underlying connection was closed. Unable to connect to the remote server Problem: This is an indication of a network problem in communication between the vault and the Loader web service. Resolution: Check your connection and retry the extraction. Example: Jan06 13:48 VVLT-E-0003 Internal error. System.Net.WebException: The underlying connection was closed: Unable to connect to the remote server. at System.Net.HttpWebRequest.CheckFinalStatus() at System.Net.HttpWebRequest.EndGetRequestStream(IAsyncResult asyncresult) at System.Net.HttpWebRequest.GetRequestStream() at System.Web.Services.Protocols.SoapHttpClientProtocol.Invoke(String methodname, Object[] parameters) at Evault.SynchWeb.Sender.Service.Loader.EraseAll(Guid vaultid) at Evault.SynchWeb.Sender.Sender.create(VaultRecord vr, DateTime dt) at Evault.SynchWeb.Sender.SeedSender.open(VaultRecord vr, DateTime dt) at Evault.SynchWeb.Collector.SnapshotReader.fire_startData(VaultRecord vr, DateTime dt) at Evault.SynchWeb.Collector.SnapshotReader.readSession(Session s) at Evault.SynchWeb.Controller.sendOnly() at Evault.SynchWeb.Controller.Main(String[] args) Internal error. Invalid URL: The format of the URL could not be determined. Problem: This is an indication of an invalid address of the Loader web service. Resolution: Verify the address stored in Conf\SychWeb.cfg file and fix the URL of the loader web service. Page 92

98 Example: Jan05 10:26 VVLT-E-0003 Internal error. System.UriFormatException: Invalid URI: The format of the URI could not be determined. at System.Uri.Parse() at System.Uri..ctor(String uristring, Boolean dontescape) at System.Uri..ctor(String uristring) at System.Web.Services.Protocols.WebClientProtocol.set_Url(String value) at Evault.SynchWeb.Sender.ServiceSettings.set_Url(String value) at Evault.SynchWeb.Controller.sendOnly() at Evault.SynchWeb.Controller.Main(String[] args) Extractor fails for a corrupted customer billing code. Error: Invalid billing record for location.cid. Resolution: First fix the billing code problem on the vault for the extractor to run without errors. Then, manually delete the csv file generated for the above log and remove the corresponding data in session.dat file. Example: Jan25 08:09 VVLT-I-0001 Collecting location records for customer e... Jan25 08:09 VVLT-E-0003 Invalid billing record for location.cid=2, bid=212, name=e Jan25 08:09 VVLT-I Collecting account records... Jan25 08:09 VVLT-E-0003 Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxxxxxx-xxxxxxxxxxxx). Exception details: System.FormatException: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). at System.Guid..ctor(String g) Missing Extractions can cause inaccuracies in Reports. Problem: The extractor does not run for a long period. This could be due to a vault upgrade problem. These missing Extractions can cause inaccuracies in Reports. Resolution: This is expected behavior, as designed. You may notice that the "Storage Reports for all Safesets Report" shows the Original size of safesets for all tasks repeats the same original size for the entire period. This behavior is to be expected, as there would have been no Extractions during that time period. So the extractor, when it finally runs would have no way of calculating what safesets were online/offline during that time. The extractor can only show the state of the vault from before and after the time period. Page 93

99 8.3 Pool Size on Reports Version 4 and version 5 Vaults (pools) may show up differently in a Storage Totals Report. This section describes how the version 5 pool is calculated/shown. Definitions Data Aging - Weighted average (calculated) of the age of safesets as a percentage of the total pool size. Original data size - size of the files as was reported at the time of the backup. Compressed size - in v4 pools, it is the size of the safeset in the pool. In v5, it has no meaning. Pool Size - Physical size of the pool files in the pool. This includes the actual data, plus some management overhead. Typically this is used for billing. Storage Totals (Data Age) Report In CentralControl, when you look at safesets, you can see their Backup Age as New, 3 Months +, and 1 Year +. These are the ages of the safesets themselves. This information, as well as the physical size of the pool on the vault is used to calculate the Data Age chart. The Data Age Report displays a pie chart of data age, from 1-90 days, days and over 365 days The chart shows a "weighted average" (of the total pool size) based on the age of the safesets. Page 94

100 The extractor reports these numbers, and so to be accurate, the extractor should be run at least daily. The three range values in the Data Age Report represent the Diskspace on the vault. These are shown as a percentage of the total pool size on the vault. The GB values are not absolute numbers (for the ages), but are relative to the total amount of Diskspace. This amount is calculated for each time the extractor is run. So, if there is a large re-seed, the next extractor will see an increase in the total amount of Diskspace used, and the chart will change accordingly / relatively (weighted average) to show this. It will not simply "bump up" the size of the 1-90 days segment. 8.4 IIS Versions and MIME Types Note: IIS 6.0 does not serve unknown MIME types. The Report Viewer may return images that are blank (with an X instead of the graph, or report). This is because the Report Viewer has requested a file from an IIS 6.0 Web Server and the file has an extension that is not a defined MIME type on the web server. Earlier versions of IIS include a wildcard character MIME mapping, which permits IIS to serve any file regardless of its extension. IIS 6.0 does not include this wildcard character MIME mapping and does not serve any type of extension that is not defined at the MimeMap node in the IIS database. This behavior is Microsoft s design in this version. You may define a specific MIME type, or add the wildcard mapping to the IIS MIME map, through the IIS Microsoft Management Console (MMC). See article ID in Microsoft s Knowledge Base articles. This article was previously published under Q Page 95