TIBCO Spotfire Metrics Prerequisites and Installation

Transcription

1 TIBCO Spotfire Metrics Prerequisites and Installation Software Release 6.0 November 2013 Two-Second Advantage

2 2 Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, Two-Second Advantage, TIBCO Software Inc., Spotfire, TIBCO Spotfire Metrics, TIBCO Spotfire Metrics Modeler, and TIBCO Spotfire Metrics Service are either registered trademarks or trademarks of TIBCO Software Inc. and/or subsidiaries of TIBCO Software Inc. in the United States and/or other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. Copyright TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

3 3 Contents TIBCO Spotfire Metrics Documentation and Support Services...4 TIBCO Spotfire Metrics Services...5 TIBCO Spotfire Metrics Services Prerequisites...6 IIS Roles Services Settings for TIBCO Spotfire Metrics... 7 TIBCO Spotfire Metrics Services MSI Installation...9 Performing a Silent Installation of TIBCO Spotfire Metrics Services...10 TIBCO Spotfire Metrics Services Manual Installation...11 Creating a Database Deploying Files...12 Create Web Sites Creating a Service Web Site Creating the Spotfire Metrics Viewer...13 Completing the Application Settings for the Application Service...13 Completing the Application Settings for the Spotfire Metrics Viewer...15 Editing the Web Config Files...15 Preparing the Administration Tool...16

4 4 TIBCO Spotfire Metrics Documentation and Support Services All TIBCO documentation is available in the TIBCO Documentation Library, which can be found here: Product-Specific Documentation The following documents for this product can be found in the TIBCO Documentation Library: TIBCO Spotfire Metrics Release Notes TIBCO Spotfire Metrics User Guide TIBCO Spotfire Metrics Optimizing KPI Authoring TIBCO Spotfire Metrics License Agreement System Requirements For a list of system requirements for this product and other TIBCO Spotfire products, visit this site: How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, contact TIBCO Support as follows: For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: If you already have a valid maintenance or support contract, visit this site: Entry to this site requires a user name and password. If you do not have a user name, you can request one. How to Join TIBCOmmunity TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to:

5 5 TIBCO Spotfire Metrics Services TIBCO Spotfire Metrics Services provides the means to gain insight into the performance of your organization, including the following: Connect to different data sources within your organization. Create smart views of your data as key performance indicators (KPIs). Deliver KPIs to users via: Spotfire Metrics Viewer Service accessed through Internet browsers. Mobile Devices. Use in-memory caches to scale support for: Very large data. Very large numbers of users.

6 6 TIBCO Spotfire Metrics Services Prerequisites Your installation of TIBCO Spotfire Metrics Services has specific hardware, experience, software, and database requirements. You must meet the minimum requirements and perform the prerequisite tasks prior to installing Spotfire Metrics, whether you perform the manual service installation or run the MSI installer tool. Knowledge and Experience Requirements The personnel performing installation must have the ability to complete the following: Create a SQL Server database and execute SQL code. Create a Web site in Microsoft Internet Information Services (IIS). Hardware Requirements Minimum requirements include the following: Hardware Memory Processor Disk Space Minimum 8GB Cores: 1; Speed: 2 GHz 1 GB Recommended minimum requirements include the following: Hardware Memory Processor Disk Space Minimum 16 GB Cores: 4; Speed: 2 GHz 5 GB Software Requirements You must be operating on one of the following systems: Microsoft Windows 7, Microsoft Windows 8, Windows Server 2008, Windows Server 2008 R2 or Windows Server The recommended operating system is Windows Server 2008 R2 or Windows Server You must have installed an Application Server and IIS 7.0 or higher, and set the appropriate IIS Roles Services Settings for TIBCO Spotfire Metrics.

7 7 You must have a user or service account to serve as the Application Pool Identity: The application pool account that the Web site is running under IIS must have sufficient permissions to be able to query Active Directory to validate security groups and users. The Application Pool Identity service account requires database owner rights to the TIBCO Spotfire Metrics database. (Alternatively, configure a SQL Server user account in the appropriate Web config file.) You must have the following:.net Framework 4.5. MVC 4.0. See for more information..net Framework 4.5 must be installed after enabling.net If you install these components out of sequence, then on Windows Server 2008, you must register the.net Framework with IIS, as follows: 1. Open an elevated command prompt (that is, right-click CMD.exe and select Run As Administrator.) 2. Browse to the directory containing the ASP.NET IIS Registration Tool (Aspnet_regiis.exe). (For example, it might be C:\Windows\Microsoft.NET\Framework\v >. See MSDN for.net Framework version-specific location of this file.) 3. From this directory, run the command aspnet_regiis.exe -i. Database Server Requirements Spotfire Metrics requires a SQL Server database to store Spotfire Metrics and the Spotfire Metrics Services metadata repository. The database server can be on the same machine as the application server and IIS, or it can be configured on a remote SQL Server instance. SQL Server 2008 R2 or SQL Server 2012 (Standard or Enterprise) SQL Server Management Studio (You can install this from download/details.aspx?id=8961. IIS Roles Services Settings for TIBCO Spotfire Metrics TIBCO Spotfire Metrics requires Microsoft Internet Information Services (IIS) 7.0 or later, and it requires certain Service Roles configuration. In the IIS 7.0 Service Manager, set the following Role Services:

8 8 If you are using Windows 7 or Windows 8, you can find these Role Services settings in Control Panel > Programs > Turn Windows features on or off. Web Management Tools IIS 6 Compatibility IIS 6 Scripting Tools IIS 6 WMI Compatibility IIS 6 Metabase Compatibility IIS Management Console IIS Management Scripts and tools Management Service World Wide Web Services Application Development.Net Extinsibility ASP.NET ISAPI Extensions ISAPI Filters Server-Side Includes Common HTTP Features Default Document Directory Browsing HTTP Errors Static Content Health and Diagnostics HTTP Logging Request Monitor Performance Static Content Compression Security Basic Authentication Request Filtering Windows Authentication

9 9 TIBCO Spotfire Metrics Services MSI Installation With your product download, TIBCO Spotfire includes the TIBCO Spotfire Metrics Services MSI installer. When you run the installer, you must be prepared to provide the following information. For detailed information about any of these items, see their descriptions in the Manual Installation documentation. Database Information: SQL Server name. Either Windows authentication or SQL authentication. Database name. Admin User name. Application Service Information: Application Service Site Name. Application Service Site Port (by default The port must be available). Application Service Host Name. Application Service Pool Name. The domain and login credentials for the AppPool. The path to your Excel spreadsheets directory. Viewer Service Information: Viewer Service Site Name. Viewer Service Port (by default The port must be available). Viewer Service Host Name. Viewer Service Pool Name. The domain and login credentials for the AppPool.

10 10 Performing a Silent Installation of TIBCO Spotfire Metrics Services You can install TIBCO Spotfire Metrics Services silently, if needed. 1. Change to the directory containing the file TIBCO Spotfire Metrics Services Installation file (TIBCO Spotfire Metrics Services.msi). 2. From this directory, open a command window. 3. At the command prompt, type the following command, substituting the appropriate information: msiexec /i "TIBCO Spotfire Metrics Services.msi" SERVICESITE_POOL_NAME="Application Service" SERVICESITE_POOL_IDENTITY_DOMAIN="" SERVICESITE_POOL_IDENTITY_USERNAME="NetworkService" SERVICESITE_POOL_IDENTITY_PWD="" SERVICESITE_NAME="Application Service" SERVICESITE_PORT="8080" SERVICESITE_URL="" PUSHBISITE_POOL_NAME="Viewer Service" PUSHBISITE_POOL_IDENTITY_DOMAIN="" PUSHBISITE_POOL_IDENTITY_USERNAME="NetworkService" PUSHBISITE_POOL_IDENTITY_PWD="" PUSHBISITE_NAME="Viewer Service" PUSHBISITE_PORT="8081" PUSHBISITE_URL="" SQL_SERVER="insightstest1" USEINTEGRATEDSECURITY="1" SQL_USER="" SQL_PWD="" SQL_DATABASE="SpotfireMetrics_V4" ADMIN_USER="mike" SERVICE_INSTALL="C:\inetpub \wwwroot\application Service" PUSHBI_INSTALL="C:\inetpub\wwwroot\Viewer Service" SPREADSHEET="C:\Spreadsheets" /Lime serviceinstalllogfile.txt /passive SERVICESITE_POOL_IDENTITY_DOMAIN, SERVICESITE_POOL_IDENTITY_USERNAME, and SERVICESITE_POOL_IDENTITY_PWD must specify an account that has access to the SQL_SERVER and SQL_DATABASE that are specified in the command. ADMIN_USER is the default user using the Modeler for the first time. This silent installation creates a log file named serviceinstalllogfile.txt in the directory of the installer. Review this log file for pertinent information.

11 11 TIBCO Spotfire Metrics Services Manual Installation This guide walks you through the manual installation for TIBCO Spotfire Metrics Services, the inmemory KPI engine that powers both Spotfire Metrics mobile business intelligence and Spotfire Metrics. We recommend that you install Spotfire Metrics Service using the TIBCO Spotfire Metrics Services MSI Installation (provided with the 6.0 release), and just use these instructions for troubleshooting, or if you have a need of a manual installation. When you run the Spotfire Metrics Service MSI installer, you must know the path to the database The following system components are installed. Spotfire Metrics Services database (requires SQL Server). Spotfire Metrics Services Web server assemblies and resources. Two IIS Web sites: Spotfire Metrics Web Service. Spotfire Metrics Viewer. You can now install the TIBCO Spotfire Metrics Modeler using a separate installer. Creating a Database To begin the installation of TIBCO Spotfire Metrics Services, first create the database. Prerequisites Be sure that you have read and met the prerequisites described in TIBCO Spotfire Metrics Services Prerequisites. 1. Open SQL Server Management Studio. 2. Connect to the hosted data source for Spotfire Metrics. 3. Right-click Logins. 4. Add the Windows service account to run the application pool identity. 5. Right-click the connected data source. 6. Select Create Database. 7. Name the database, and then click OK. (You need this information when you configure the Web config files.) 8. Open the file provided by Spotfire Metrics, BuildDatabase.sql. 9. Add the USE <DATABASE> command to point to the Spotfire Metrics database. 10. Run BuildDatabase.sql against the created Spotfire Metrics database. 11. Click the database to expand, and then expand the Tables folder. 12. Right-click the table dbo.user. 13. Click edit top 200 rows. 14. In the user table, replace NULL with the alias of the default user. 15. Set the user's ActriveState to 1.

12 Run the script MetricsUserUpdate.sql. The message (1 row(s) affected) appears in the Message pane. You are now ready to deploy product files. Deploying Files As part of your TIBCO Spotfire Metrics installation, you received files to install for the web server to work correctly. Prerequisites The database must have been successfully created. Copy the following file folders you received from TIBCO Spotfire to the folder named C:\inetpub \wwwroot: Application Service Viewer Service You are now ready to create the Spotfire Metrics web sites. Create Web Sites When you install TIBCO Spotfire Metrics, you create two web sites: the Spotfire Metrics Application Service web site, and the Spotfire Metrics Viewer web site. Use the Internet Information Services (IIS) Manager to add the two new Spotfire Metrics web sites. Before you set up these web sites, either remove the default web site or set its port bindings to a port you do not intend to use. Creating a Service Web Site The TIBCO Spotfire Metrics Application Service web site gives access to the TIBCO Spotfire Metrics Modeler. Prerequisites The database must have been successfully created, and the Spotfire Metrics files must have been copied to the web service folder. 1. From the Windows Start menu, click Administrative Tools > Internet Information Services (IIS) Manager. (In Windows 7, open Administrative Tools from the Control Panel.) 2. In the IIS Manager Connections pane, expand the server name. 3. Right-click the Sites folder, and from the menu, select Add Web Site. 4. Provide the site name SpotfireMetricsService. 5. Accept the default application pool (the name of the site).

13 13 6. Provide the physical path to the service (for example, browse to and select c:\inetpub\wwwroot \Application Service). 7. In the Port text box, provide an available port number. By default, the port number is set to Be sure that you assign a unique and available port number. 8. For a default installation, leave Host name blank, and then click OK to return to the Connections view. Next, create the Spotfire Metrics Viewer. Creating the Spotfire Metrics Viewer The TIBCO Spotfire Metrics Viewer web site gives access to the Spotfire Metrics KPIs created using the Spotfire Metrics Modeler. Mobile or desktop users access the KPIs in the Spotfire Metrics Viewer via a web browser either on a desktop or a mobile device. Prerequisites The database must have been successfully created, and the Spotfire Metrics files must have been copied to the web service folder. The Spotfire Metrics Service web site has been created. 1. From the Windows Start menu, click Administrative Tools > Internet Information Services (IIS) Manager. (In Windows 7, open Administrative Tools from the Control Panel.) 2. In the IIS Manager Connections pane, expand the server name. 3. Right-click the Sites folder, and from the menu, select Add Web Site. 4. Provide the site name SpotfireMetricsViewer. 5. Accept the default application pool (the name of the site). 6. Provide the physical path to the service (for example, browse to and select c:\inetpub\wwwroot \Metrics Viewer). 7. In the Port text box, provide an available port number. By default, the port number is set to Be sure that you assign a unique and available port number. 8. For a default installation, leave Host name blank, and then click OK to return to the Connections view. Next, configure the application settings for both the Application Service and the Viewer. Completing the Application Settings for the Application Service The TIBCO Spotfire Metrics Service requires additional steps to enable the connection to the IIS service. To complete these steps, return to the Internet Information Services (IIS) Manager Connections pane.

14 14 1. In the Connections pane, expand the connections and click Application Pools. 2. Right-click Application Service Application Pool, and from the menu, click Advanced Settings. 3. For.NET Framework Version, type v Click Process Model, select Identity, and click... (the Properties button) to open the Application Pool Identity dialog. 5. In the Application Pool Identity dialog, select Custom account, and then click Set. 6. In the resulting Set Credentials dialog, provide the service account credentials you established when you created the database. Click OK to verify, and then click OK to accept the change to the application pool identity. 7. Click OK to close the Advanced Settings dialog. Administrative rights are now enabled for the Application Service. 8. Return to the Internet Information Services (IIS) Manager Connections pane and expand the connections and click Application Pools. 9. Right-click Metrics View Application Pool, and from the menu, click Advanced Settings. 10. For.NET Framework Version, type v4.0.

15 15 Complete the application settings for the Spotfire Metrics Viewer. Completing the Application Settings for the Spotfire Metrics Viewer The TIBCO Spotfire Metrics Viewer requires additional steps to enable the connection to the IIS service. To complete these steps, return to the Internet Information Services (IIS) Manager Connections pane. 1. In the Connections pane, expand the connections and click Application Pools. 2. Right-click Application Service Application Pool, and from the menu, click Advanced Settings. 3. For.NET Framework Version, type v4.0. Configure the Web.config files for both the service and the viewer. Editing the Web Config Files Each of the TIBCO Spotfire Metrics web pages includes a Web.config file that must be customized for your installation. You can edit the Web.config files using your favorite text editor. Make sure your text editor adds no special line return characters. Prerequisites The database must have been successfully created. The Spotfire Metrics Web sites have been created. The Application Setings for bot the Application Service and the Spotfire Metrics Viewer have been completed. 1. Browse to the directory where you copied the Service files: c:\inetpub\wwwroot\service\ and open the file Web.config.

16 16 2. Locate the line that specifies your database server and database. The following image is an example of setting the database server name and database name: 3. Save the file. 4. Locate and edit the path to specify the location your Excel spreadsheets. This must be a single path (for example: c:\myspreadsheets). 5. Browse to the directory where you copied the Viewer files: c:\inetpub\wwwroot\viewer and open the file Web.config. 6. Locate the kep "WebServiceRoot" and set the value to the Service URL and port. The following image shows an example: 7. Save the file. Validate your results. Open a browser and browse to each of the two URLs (Service and Viewer). The Application Service should return the default page reading "Welcome to the Spotfire Metrics Application Service". The Application Viewer should show the default ASP landing page with no errors. Possible errors include the following: No access to SQL - App pool identity for Service doesn't have rights to SQL. Port conflict - you specified a port that is not available. The Web.config settings are incorrect. Preparing the Administration Tool TIBCO Spotfire Metrics includes administration tools, which require simple configuration to work in your Spotfire Metricsdeployment. Prerequisites Your database is created. Your Spotfire Metrics Service and Viewer are installed and configured correctly. 1. Copy the administration tool files provided by TIBCO Spotfire, and then paste them to a new Administration directory. 2. Locate the file TIBCO Spotfire Metrics Modeler.exe 3. Run the executable by double-clicking it. 4. An error dialog appears, and then the dialog Manage Server Connections appears

17 17 5. In the Connections Manager, provide a title and the service URL (in the form ServiceName. Optionally, you can provide a description. The is required as part of the URL. If you specified HTTPS binding when you configured the service, specify that instead. 6. Click Open to display the Modeler. For information about configuring the modeler further, see the TIBCO Spotfire Metrics Modeler User's Guide.