Installing BIRT Analytics 4.4

Transcription

1

2 Pre-requisites... 3 Configuring Microsoft Internet Information Services... 3 Installation... 5 Technical information PORTS (http / https) USERS Windows Services Linux Process Annex I Custom installation type Apache Tomcat Apache Tomcat PostgreSQL Application - Administration - Web Client Apache Tomcat Administration - Web Client Annex II - Multi-servers installation Annex III - HTTPS Acces to Web Client (bafrontend), Administration (baadmin) and FastDB Loader (qloader) by port 8109 and HTTPS Access to Application (qelectron) by port 443 and HTTPS Access to FastDB Web Service (protonws) by port 8109 and HTTPS Access to dubnium by port 8106 and SSL Uninstall BA Observations

3 Pre-requisites - Microsoft Internet Information Services In case of distributed installation only required in server where will be install the Application element (qelectron). Configuring Microsoft Internet Information Services Microsoft Internet Information Services (IIS) 6.0 or higher is a prerequisite to install BIRT Analytics. The Windows administrator must enable the Web Server (IIS) role. The following IIS role services must also be enabled: Application Development ASP.NET IIS 6 Management Compatibility The following section describes how to install Microsoft Internet Information Services in the Windows operating system. If you use a network firewall, ensure that the firewall passes the port number used by IIS. The default port is TCP 80. How to enable IIS 6.0 role services Choose Start Administrative Tools Server Manager. Choose Roles. Choose Add Roles In Before You Begin, Choose Next. In Select Server Roles, select Web Server (IIS) and choose Next. 3

4 In Web Server (IIS), choose Next. In Select Role Services, select ASP.NET. If the Add Roles Wizard appears, choose Add Required Role Services. In Select Role Services, select IIS 6 Management Compatibility. Choose Next. In Confirm Installation Selections, choose Install. In Installation Results, choose Close. Close Server Manager. 4

5 Installation o Create a new folder: [install folder] o Windows: e.g. C:\Actuate\ o Linux: e.g. opt\actuate\ o Copy the installers: o Windows: BIRTAnalytics-4.4.xxx-Windows.zip o Linux: BIRTAnalytics-4.4.xxx-Linux.tar.gz o Uncompress the installer file BIRTAnalytics-4.4.xxx-Windows.zip It will generate the folders: [install folder]\jre64 And the files: o Windows: [install folder]\install.bat C:\Actuate\BIRTAnalytics-4.4.xxx-Windows.jar o Linux: [install folder]\install.sh [install folder]\birtanalytics-4.4.xxx-linux.jar o o Run installation process. o Windows: install.bat (Run as Administrator) o Linux:./install.sh (don't use the root user) Next 5

6 - Accept the terms of license agreement and Next - Select the installation path and Next - Confirmation for creating the directory if not exist 6

7 - Select installation type and Next. o Standard: Ports definition by default. o Custom: Ports definitions customize. (see details in Annex I - Customize) - Select Installation packages and Next. Some packages has dependencies from another. In case of distributed installation should be necessary to inform about the path for other elements. Linux installation is required a distributed installation. 7

8 Windows or Linux Pack Description Dependencies Legal agreement Actutate Software License and Support No Services Agreement JRE Oracle s Java Runtime Environment for No servers Apache Tomcat Apache Tomcat web services container JRE FastDB BIRT Analytics FastDB Server, FastDB Web Apache Tomcat Services and FastDB Loader Demo dataset Demo dataset loading project FastDB Microsoft.Net Framework 4 Microsoft.Net Framework 4 No Administration BIRT Analytics Administration Web Apache Tomcat application Web Client BIRT Analytics Client Web application Apache Tomcat Only Windows Pack Description Dependencies Microsoft Visual C Microsoft Visual C Redistributable No Redistributable PostgreSQL PostgreSQL database Microsoft Visual C Redistributable Microsoft.Net Framework 4 Microsoft.Net Framework 4 No Application BIRT Analytics Web Applications services PostgreSQL (no restrictive) Microsoft.Net Framework 4 8

9 - Select license type and Next: o No, I don t have any yet: You don t have any valid license of BIRT Analytics and you want install with the license by default. (Temporally license until July 4 th 2014, 1 user Admin and 1 user Power, Max. 100 millions records) o Yes, and I want to use it: You have a valid license of BIRT Analytics and you want to use it. (the next step request for the license files) - Select both license files; FastDB license and Application license, and Next. 9

10 - Check the summary with installations settings and Next. - When finished the process, Next. 10

11 - Select the setup shortcuts and Next. o Create shortcuts in the Start-Menu o Create additional shortcuts on the desktop o Select the Programs Group (by default BIRT Analytics) o Create them for current user or all users - Installation finished, Done. 11

12 - Shortcuts in Start-Menu Programs Group and on desktop o BIRT Analytics (by default o BIRT Analytics Administration (by default o FastDB Loader (by default - The installation process will generate these folders in the selected path. (by default BIRTAnalytics) Folder Sub-folder Content 3rdParty JRE64 PostgreSQL Tomcat Administration baadmin ApplicationWS electron Data ApplicationWS Application license FastDB databases, folders; export, import and iworkflow, loader configuration, loader backend database (dubnium.db), loading projects, webservice cache, FastDB license, FastDB backend database (admin.sqlite). PostgreSQL Application backend database (wpt) Tomcat keystore FastDB dubnium Loader qloader WebService WebService (protonws) Log Logs: bafrontend, baadmim, qloader, electron, proton, engine WebClient bafrontend 12

13 Technical information PORTS (http / https) 8111 PostgreSQL 8110 / 8109 protonws, bafrontend, baadmin, qloader 80 / 443 qelectron 8105 / 8106 dubnium USERS PostgreSQL dubnium qloader bafrontend baadmin user / password SYSTEM / PASSWORD SYSTEM / PASSWORD Administrator / PASSWORD Administrator / PASSWORD Windows Services Description Name Start User BIRT Analytics - Apache Tomcat Tomcat_BA Automatic Local System BIRT Analytics FastDB dubnium Automatic Local System BIRT Analytics DDWCron DDWCron Automatic Network Service BIRT Analytics PostgreSQL PostgreSQL_BA Automatic Local System Linux Process Name File Start Start TomcatBA [Installation folder]/installer/scripts/starttomcat.sh Manually Stop TomcatBA [Installation folder]/installer/scripts/stoptomcat.sh Manually Start FastDB [Installation folder]/installer/scripts/startfastdb.sh Manually Stop FastDB [Installation folder]/installer/scripts/stopfastdb.sh Manually 13

14 Annex I Custom installation type When we installing using the type "custom", the installation process will require complete some information for each case, as they are the Ports, Servers and credentials. Apache Tomcat Installing Apache Tomcat will require this information: - Select Port s and Transport Protocol type for Apache Tomcat. o Tomcat shutdown port 8107 o Tomcat manager port 8108 o Tomcat SSL port 8109 o Tomcat default port

15 Apache Tomcat PostgreSQL Application - Administration - Web Client Installing Apache Tomcat PostgreSQL Application Administration and Web Client will require this information: - Select Port s, PostgreSQL credentials, FastDB Web Service Server and Transport Protocol type. o Tomcat shutdown port 8107 o Tomcat manager port 8108 o Tomcat SSL port 8109 o Tomcat default port 8110 o PostgreSQL port 8111 o PostgreSQL user user o PostgreSQL password password o FastDB Web Service server localhost (hostname of server) o FastDB Web Service port

16 Apache Tomcat Administration - Web Client Installing Apache Tomcat Administration and Web Client will require this information: - Select Port s, Application server and Transport Protocol type. o Tomcat shutdown port 8107 o Tomcat manager port 8108 o Tomcat SSL port 8109 o Tomcat default port 8110 o Application server localhost (hostname of server) o Application port 80 16

17 Annex II - Multi-servers installation The installation of BA can be in a standalone server or in multi-servers. Every element of BA should be in a different server, but the more usually distributed installation is in two servers; Server1 for BAapps elements (qelectron, bafrontend and baadmin) and Server2 for BAcore elements (FastDB, protonws and qloader) BACore can be in Linux o Windows O.S. Server. BAapps can be only in Windows. The process is the same as in a standalone installation, but installing only the packages required for each server and using the Custom type in BAapps server (Server1) Before to start verify that in hosts files was add the entry with IP and hostname.domain. In a distributed installation in two servers, must be add in both servers the IP and hostname.domain of both. In Server2 (BAcore) is required to install these packages: o Legal agreement o JRE o Apache Tomcat o FastDB o Demo dataset (optional) 17

18 In Server1 (BAapps) is required to install these packages: o Legal agreement o JRE o Apache Tomcat o Microsoft Visual C Redistributable o PostgreSQL o Microsoft.Net Framework 4 o Application o Administration o Web Client During the install process, will be required the FastDB Web Service server and his port where was installed the BAcore (Server2) 18

19 Annex III - HTTPS In installation process select installation type Custom and complete the information required in any element. (see detail in Annex I Custom installation type) In a standalone installation will require this information: Application port 80 by default. The usually IIS https port is 443. Transport Protocol type https After an installation of BA these are the steps for a HTTPS installation. Before to start, verify that in hosts files was add the entry with IP and hostname.domain. In a distributed installation in two servers, must be add in both servers the IP and hostname.domain of both. It is possible to establish https configuration for each element of BA, and can be apply independently. 19

20 Acces to Web Client (bafrontend), Administration (baadmin) and FastDB Loader (qloader) by port 8109 and HTTPS In a distributed installation in two servers, apply these changes in both servers; SERVER1 BAapps and SERVER2 BAcore. Create a keystore birtanalytics.jks importing the certificate PFX. The keystore keystore.jks it is located by default in this folder: C:\Actuate\BIRTAnalytics\data\Tomcat\ To import a PKCS#12 file into a Java keystore 1. Obtain the following information about your PKCS#12 file: o The password that protects the PKCS#12 file. o The Friendly Name of the certificate contained in the PKCS#12. For example: You can see the Friendly Name (alias name) with this command: (You'll be prompted to enter the source keystore password. Enter the password that protects your PKCS#12 file.) keytool list v -storetype pkcs12 keystore <cert.p12> C:\Actuate\BIRTAnalytics\3erdParty\JRE64\bin>keytool list v storetype pkcs12 keystore C:\Actuate\BIRTAnalytics\data\Tomcat\quite4me.pfx 2. Use the following command to import your PKCS#12 file into a Java keystore: (You'll be prompted to enter the source keystore password. Enter the password that protects your PKCS#12 file.) keytool -importkeystore -srckeystore <cert.p12> -destkeystore <keystore.jks> - srcstoretype pkcs12 -deststoretype JKS -alias <original_alias> -destalias <new_alias> - deststorepass <password> -destkeypass <same_password> For example: C:\Actuate\BIRTAnalytics\3erdParty\JRE64\bin>keytool -importkeystore -srckeystore C:\Actuate\BIRTAnalytics\data\Tomcat\quite4me.pfx -destkeystore C:\Actuate\BIRTAnalytics\data\Tomcat\birtanalytics.jks -srcstoretype pkcs12 -deststoretype JKS -alias 1 -destalias quite4me -deststorepass birtanalytics -destkeypass birtanalytics cert.p12 keystore.jks The name of the PKCS#12 file that contains your new certificate. The output file name for your Java keystore. original_alias This is the Friendly Name of the certificate contained in the PKCS#12 file. Use quotation marks if this name contains spaces. new_alias password This will be the alias of the Java Keystore you are creating. We recommend that you use the same alias as you used during installation in order to ensure there is only one signature per jar. To determine what value was used, open the install.log file and search for "Enter the alias of your private key." This password protects the keystore you are creating. same_password This password protects the private key within the keystore you are creating. Use the same password that you specified for deststorepass. 20

21 For example: You can see the content of keystore with this command: (You'll be prompted to enter the source keystore password. Enter the password that protects your keystore file.) keytool list v keystore <keystore.jks> C:\Actuate\BIRTAnalytics\3erdParty\JRE64\bin>keytool list v keystore C:\Actuate\BIRTAnalytics\data\Tomcat\birtanalytics.jks Enabled SSL in Tomcat In file C:\Actuate\BIRTAnalytics\3erdParty\Tomcat\conf\server.xml modify this section adding the value of specific keystore and password. <!-- Define a SSL HTTP/1.1 Connector on port 8109 This connector uses the JSSE configuration, when using APR, the connector should be using the OpenSSL style configuration described in the APR documentation --> <Connector port="8109" protocol="org.apache.coyote.http11.http11nioprotocol" SSLEnabled="true" maxthreads="150" scheme="https" secure="true" clientauth="false" sslprotocol="tls" keystorefile="c:\actuate\birtanalytics\data\tomcat\keystore.jks" keystorepass="keystorepass"/> The keystore files are located by default in this folder: C:\Actuate\BIRTAnalytics\data\Tomcat\ For example: <Connector port="8109" protocol="org.apache.coyote.http11.http11nioprotocol" SSLEnabled="true" maxthreads="150" scheme="https" secure="true" clientauth="false" sslprotocol="tls" keystorefile="c:\actuate\birtanalytics\data\tomcat\birtanalytics.jks" keystorepass="birtanalytics"/> 21

22 Disable HTTPS access to Application (qelectron) in Administration (baadmin) configuration In a distributed installation in two servers, apply these changes in SERVER1 - BAapps In file C:\Actuate\BIRTAnalytics\Administration\WEB-INF\settings\configuration.xml modify these elements: <electronurl> For example: <electronurl> Disable HTTPS access to qelectron in bafrontend configuration In a distributed installation in two servers, apply these changes in SERVER1 - BAapps In file C:\Actuate\BIRTAnalytics\WebClient\WEB-INF\settings\configuration.xml modify these elements: <electronurl> For example: <electronurl> Disable HTTPS access to FastDB Web Service (protonws) in Application (qelectron) web.config In a distributed installation in two servers, apply these changes in SERVER1 BAapps In file C:\inetpub\wwwroot\qelectron\web.config replace the value of these parameters changing: for For example: <setting name="altbusiness_proton2_database" serializeas="string"> <value> <setting name="altbusiness_proton2analysis_analysis" serializeas="string"> <value> <setting name="altbusiness_proton2importexportws_importexport" serializeas="string"> <value> <setting name="altbusiness_proton2engineering_engineering" serializeas="string"> <value> <setting name="altbusiness_proton2cache_cache" serializeas="string"> <value> <setting name="altbusiness_proton2security_security" serializeas="string"> <value> </AltBusiness.My.MySettings> 22

23 <setting name="ddwdatamining_proton2datamining_datamining" serializeas="string"> <value> <setting name="altiworkflow_proton2campaignworkflow_campaignworkflow" serializeas="string"> <value> <add key="filetransferpage" value=" /> 23

24 Access to Application (qelectron) by port 443 and HTTPS In a distributed installation in two servers, apply these changes in both servers; SERVER1 BAapps and SERVER2 - BAcore Add a certificate to cacerts Java store Open a MSDOS console (CMD) as administrator. In C:\Actuate\BIRTAnalytics\3rdParty\JRE64\bin\ run: keytool -import -trustcacerts -file "C:\Certificates\root.pem" -alias ALIAS -keystore "C:\Actuate\BIRTAnalytics\3rdParty\JRE64\jre\lib\security\cacerts" (You'll be prompted to enter the cacerts keystore password. By default is changeit ) For example: C:\Actuate\BIRTAnalytics\3rdParty\JRE64\bin >keytool -import -trustcacerts -file " C:\Actuate\BIRTAnalytics\data\Tomcat\gdig2.crt" -alias CA_DADDY_Q -keystore " C:\Actuate\BIRTAnalytics\3rdParty\JRE64\jre\lib\security\cacerts " In a distributed installation in two servers, apply these changes in SERVER1 BAapps Import certificate in IIS From IIS Managemente Console Server Certificates - Import - (select PFX certificate) and type the certificate password. Default Web Site (or qelectron site) - Edit Bindings - Add Select https Port = 443 SSL certificate = Select the installed certificate IP address =All unassigned Host name = blank Enable HTTPS access to Application (qelectron) in Administration (baadmin) configuration In a distributed installation in two servers, apply these changes in SERVER1 - BAapps In file C:\Actuate\BIRTAnalytics\Administration\WEB-INF\settings\configuration.xml modify these elements: <electronurl> for <electronurl> For example: <electronurl> 24

25 Enable HTTPS access to Applicaton (qelectron) in Web Client (bafrontend) configuration In a distributed installation in two servers, apply these changes in SERVER1 - BAapps In file C:\Actuate\BIRTAnalytics\WebClient\WEB-INF\settings\configuration.xml modify these elements: <electronurl> for <electronurl> For example: <electronurl> Optional In a distributed installation in two servers, apply these changes in SERVER1 BAapps Default Web Site - SSL Settings Check Require SSL Check ignore Change in Application (qelectron) the configuration in web.config In file C:\inetpub\wwwroot\qelectron\web.config replace the value of these parameters changing: for For example: C:\inetpub\wwwroot\qelectron\Web.config <applicationsettings> <AltBusiness.My.MySettings> <setting name="altbusiness_electroneventsws_events" serializeas="string"> <value> <AltApplication.My.MySettings> <setting name="altapplication_electronsecurityws_securityws" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/SecurityWS.asmx</value> <setting name="altapplication_analysisws_analysisws" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/AnalysisWS.asmx</value> <setting name="altapplication_workspacews_workspacews" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/WorkSpaceWS.asmx</value> <setting name="altapplication_electroneventsws_events" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/Events.asmx</value> 25

26 <setting name="altapplication_electronpluginws_plugin" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/plugin.asmx</value> <setting name="altapplication_electronmetainfws_getmetainf" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/GetMetainf.asmx</value>.. <DDWDataMining.My.MySettings> <setting name="ddwdatamining_localhost_plugin" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/plugin.asmx</value> <setting name="ddwdatamining_localhost_securityws" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/securityWS.asmx</value> <setting name="ddwdatamining_localhost_workspacews" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/workspaceWS.asmx</value> <setting name="ddwdatamining_localhost_getmetainf" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/GetMetainf.asmx</value> <setting name="ddwdatamining_engineringws_engineering" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/Engineering.asmx</value> <setting name="ddwdatamining_analysisws_analysisws" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/AnalysisWS.asmx</value> <AltiWorkflow.My.MySettings> <setting name="altiworkflow_altcoremetainf_getmetainf" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/GetMetainf.asmx</value> <setting name="altiworkflow_workspacews_workspacews" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/WorkspaceWS.asmx</value> <setting name="altiworkflow_electronpluginws_plugin" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/Plugin.asmx</value> <setting name="altiworkflow_electronsecurityws_securityws" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/SecurityWS.asmx</value> <setting name="altiworkflow_electronengineeringws_engineering" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/Engineering.asmx</value> <setting name="altiworkflow_electronimportexportws_importexportws" serializeas="string"> <value> SERVER1.quite4me.com:443/qelectron/ImportExportWS.asmx</value>.. Change in DDW Cron the configuration in DDWCron.exe.config In file C:\Actuate\BIRTAnalytics\ApplicationWS\ddwcron\ DDWCron.exe.config replace the value of this parameters changing: for For example: After this change, is necessary to restart BIRT Analytics DDWCron Service. 26

27 Access to FastDB Web Service (protonws) by port 8109 and HTTPS Change in Application (qelectron) the web.config In a distributed installation in two servers, apply these changes in SERVER1 BAapps In file C:\inetpub\wwwroot\qelectron\web.config replace the value of these parameters changing: for For example: <setting name="altbusiness_proton2_database" serializeas="string"> <value> <setting name="altbusiness_proton2analysis_analysis" serializeas="string"> <value> <setting name="altbusiness_proton2importexportws_importexport" serializeas="string"> <value> <setting name="altbusiness_proton2engineering_engineering" serializeas="string"> <value>htt s://server2.quite4me.com:8109/protonws/services/engineering.engineeringhttpsoap11endpoint/</value> <setting name="altbusiness_proton2cache_cache" serializeas="string"> <value> <setting name="altbusiness_proton2security_security" serializeas="string"> <value> </AltBusiness.My.MySettings> <setting name="ddwdatamining_proton2datamining_datamining" serializeas="string"> <value> <setting name="altiworkflow_proton2campaignworkflow_campaignworkflow" serializeas="string"> <value> value> <add key="filetransferpage" value=" /> 27

28 And replace the value of these parameters changing: localhost:8110 for hostname.domain:8109 For example: <AltBusiness.Proton.ProtonWebFarm.Writers> <add key="exporter" value="server2.quite4me.com:8109" />. <AltBusiness.Proton.ProtonWebFarm.Readers> <add key="server1" value="server2.quite4me.com:8109" /> Change in axis2.xml file of FastDB Web Service (protonws) In a distributed installation in two servers, apply these changes in SERVER2 BAcore In file C:\Actuate\BIRTAnalytics\FastDB\WebService\WEB-INF\conf\axis2.xml uncomment and modify this section adding the elements required. <!-- Comment out next lines if https is enabled in Tomcat (and update the port number accordingly) --> <transportreceiver name="https" class="org.apache.axis2.transport.http.simplehttpserver"> <parameter name="port">8109</parameter> </transportreceiver> 28

29 Access to dubnium by port 8106 and SSL In a distributed installation in two servers, apply these changes in SERVER2 BAcore Change in configuration.xml file of FastDB Web Service (protonws) In file C:\Actuate\BIRTAnalytics\FastDB\WebService\WEB-INF\settings\configuration.xml modify these parameters to true value <ignoredangerous>true</ignoredangerous> <secure>true</secure> Enable SSL in Dubnium In file C:\Actuate\BIRTAnalytics\FastDB\engine_configuration.ini add these parameters: [server] enable_secure_port = 1 By default SSL use port 8106 and auto certificate. --server.ssl_mode arg (=simple) Certificate mode for ssl ('simple'=self-signed certificate, 'complete'=with root CA) --server.dh_filename arg (=dhparams.pem) Diffie-Hellman parameters file --server.rand_filename arg (=ssl.rnd) Random file for ssl calculations --server.certificate arg (=server.pem) Server public certificate --server.private_key arg (=server.key) Server private key --server.private_key_password arg Password for server private key --server.root_ca_certificate arg (=cacert.pem) Root CA public certificate --server.cert_country arg Server certificate data: two character country (US, UK, SP,...) FastDB can work with SSL without these options, as it auto-generates the needed certificates, but it is not really a valid certificate in terms of authentication reliability. If a customer has a valid certificate purchased to a CA (or even a self-generated one) they can use these options to specify required values. These options can also be used in the FastDB auto-generated certificate if you want to set some custom certificate properties such as country, , organization, etc. 29

30 Uninstall BA4.4 IMPORTANT Before uninstall be sure you have backup for all the elements required. o Windows Run [installation path]\uninstall.bat (Run as Administrator) o Linux Run [installation path]\./uninstall.sh In both case; Windows or Linux, delete the folder required. 30

31 Observations If during the installation process appear this Error message: Com.izforge.izpack.api.exception.IzPackException: The following error occurred while executing this line: C:\users\user\AppData\Local\Temp\resource_AntSetupApplication.xml xml:43: exec returned: 1603 More probably you are trying to install in a Windows 7 or Windows 8.1 and is the first time that any version of BIRT Analytics is installed in this computer. Workaround 1 Before to start the BIRT Analytics 4.4 install process, you must install Framework 4.0. (It is necessary restart de computer) Workaround 2 Uninstall BA 4.4. How the install process don t finished, the uninstall process must be manually. From CMD delete the BA services installed. sc delete name service Delete all BIRT Analytics folders. Uninstall Framework 4.0 From Control Panel Programs and Features uninstall Framework 4.0 Install BA 4.4 again from the beginning. 31