Installation and Configuration Guide Tips & Hints April 2008 CitectSCADA Reports Manager Installation Guide V1.0 1
Issue History Doc Rev CVS Rev Status Date Modified by Summary of Amendments 1 Final 12/04/2008 Document created CitectSCADA Reports Manager Installation Guide V1.0 2
Table of Contents Issue History... 2 Table of Contents... 3 Preparation... 4 Software Requirements... 4 Hardware Requirements... 4 Health Check for Reporting Services... 4 Install CitectSCADA Reports... 5 Deploy CitectSCADA Reports... 5 Configure Historian Database... 5 Deploy Reports... 8 Access Published Reports from Network... 12 Troubleshooting... 17 CitectSCADA Reports Manager Installation Guide V1.0 3
Preparation Software Requirements 1. CitectSCADA Reports (CSR) V4.0+ 2. MS SQL Server 2005 including Report Server 3. Reporting Manager (SCADA Reports) Hardware Requirements 1. Computer hardware specifications same as for CitectSCADA Reports Health Check for Reporting Services Before you start installing the reports, please ensure that Reporting Services are installed and configured correctly. 1. Launch <Computer Management> console 2. Expand <Services and Application> node 3. Locate <Internet Information Services> 4. Find the web site of <Report Server> under <Web Sites / Default Web Site> 5. Right mouse click on the selected web site and then select <Browse> as shown below. 6. Ensure that no error is reported CitectSCADA Reports Manager Installation Guide V1.0 4
Install CitectSCADA Reports Run Setup.exe from the medium and follow prompts. Deploy CitectSCADA Reports Configure Historian Database A historian data source can be located on a different machine. The following steps will guide you to building the database connection. 1. Launch <Citect Reporting Manager> from the program menu 2. In <Citect Reporting Manager> window, right mouse click on <Historian database> node and then select <Register> on the dropdown menu as shown below. If your CSR server is on the same machine, you can select <Import CSR connections> on the dropdown menu. CitectSCADA Reports Manager Installation Guide V1.0 5
3. On the <Connect to a Historian database> window, select MS SQL server instance where your Historian database resides, and enter the authentication and historian database name. Then click on <OK> button. 4. The selected Historian database will appear under the Historian node. Right mouse your historian database and then select <Install package> on the dropdown menu. CitectSCADA Reports Manager Installation Guide V1.0 6
5. On the <Value pack installation> window, select the <Value Pack> on the right pane and then click on <Install> button as shown below. 6. Verify the pack is installed successfully from the message box and then click on <Close> button to complete the value installation as shown below. CitectSCADA Reports Manager Installation Guide V1.0 7
Deploy Reports 1. Right mouse click on <Citect SCADA Standard Report Pack> and then select <Deploy reports> on the dropdown menu. 2. Enter the computer name or IP address of Report Server. If you use different SQL server instance other than SCADAReports, you need to modify the reporting service URL accordingly. For example, if you use the default SQL instance, you should remove <$SCADAReports> from the <URL> field as shown below. CitectSCADA Reports Manager Installation Guide V1.0 8
3. Click on the dropdown button in the <Data source> field and then select <New>. Note that if the selected reporting server is not configured correctly, you will receive an error message resulting from this action. 4. On the <New reporting data source> window, leave all as the defaults and then click on <Create> button. If you do want to use <Browse> to create a new data connection, make sure that the selected database has the <Report Value Pack> installed otherwise an error would occur. CitectSCADA Reports Manager Installation Guide V1.0 9
5. The newly configured data source for reporting will appear in the <Data source> field. If you have to configure multiple data sources for reporting, you have to deploy one at a time. In addition, you need to specify different report folders. In our case, the reports folder is the default. Once you complete all entries, click on <Deploy> button. 6. You can see from the message box that deploying the reports is in progress. Click on <Ok> button on the popup message box as shown below. CitectSCADA Reports Manager Installation Guide V1.0 10
7. Test one of deployed reports with <Citect SCADA Report Manager> as shown below. 8. Test one of deployed reports with <Internet Information Services> as shown below. Congratulations! You have just successfully deployed CitectSCADA Reports on the reporting server. CitectSCADA Reports Manager Installation Guide V1.0 11
Access Published Reports from Network Installation and Configuration Guide 1. On the reporting server machine, launch <Computer Management Console> and locate <Local Users and Groups>. Create a user group e.g., <Report Users> and add all users who are allowed to gain access to the published reports as shown below. Click OK to close the console. 2. On the same machine, launch <SQL Server Management Studio> and select <Reporting Services> as server type. Enter the server name and authentication and then click on <Connect> button. It is noted that in the following example, <SCADAReports> is the name of SQL server instance. CitectSCADA Reports Manager Installation Guide V1.0 12
3. On <SQL Server Management Studio>, locate the <Home> folder from the object tree and you will see that the <Citect Reports> folder will appear under this node. Select the <Home> node, right mouse click on it and then select <Properties> from the dropdown menu. 4. On <Folder Properties> window, click on <Add Group or User > button. CitectSCADA Reports Manager Installation Guide V1.0 13
5. Enter <Report users> in the field and then click on <OK> button as shown below. 6. The new user group will appear on the list. Select appropriate roles you wish to assign to this user group. And then click on <OK> button. CitectSCADA Reports Manager Installation Guide V1.0 14
7. Go to the properties of <Home> folder again; you will see the local machine name appears in front of the user group, which means that the user group used here is local. You could also use a domain user group for access permissions. 8. You can define your own roles to manager or access the Citect reports. Right mouse click on <System Roles> under <Security> node and then select <New System Role > CitectSCADA Reports Manager Installation Guide V1.0 15
9. On <System Role Properties> windows, enter <EEMUA Reports> or other name, and then select tasks you would like this role to have. 10. Assign the <EEMUA Reports> role the user group <Report Users>. Now all users you have configured in this user group should be able to access the published reports from your network. CitectSCADA Reports Manager Installation Guide V1.0 16
Troubleshooting 1. When creating a new data source in the report deployment as shown page 9 step 3, you may receive the following errors if the reporting service URL is incorrect. Make sure that the reporting services URL matches the installed instance of the report server. 2. The following errors are the result of incorrect configuration of Reporting Services. In this case, you need to contact Microsoft Support or your database administrator. CitectSCADA Reports Manager Installation Guide V1.0 17
CitectSCADA Reports Manager Installation Guide V1.0 18