Galigeo for Cognos HTML5 Installation Guide - G18.0

Transcription

1 Galigeo for Cognos HTML5 Installation Guide - G18.0 Copyright 2018 by Galigeo. All Rights Reserved.

2 Table des matières Introduction... 3 About this document... 4 Chapter 1: Prerequisites Architecture Schemas Cognos Server ArcGIS Server ArcGIS Online Galigeo Server Network Client Chapter 2: BI connector installation Where the installation takes place? Installation Steps Chapter 3: Installation of Galigeo web applications Global Overview Where the installation takes place? Deploy GALIGEO_HOME Deploy web applications Configure web applications Specify the GALIGEO_HOME directory Edit the setting of the RMI port Specify the Galigeo repository folder Set Cognos main dispatcher URL Multi-Dispatchers configuration Configure logs files Case of multiple Cognos Portals (optional) Admin Console - local installation of ESRI JS API Font installation Tomcat Configuration Memory Configuration Special characters Chapter 4: Update an existing installation Update BI Connector Update Galigeo web applications Chapter 5 : Uninstall Galigeo Uninstall BI Connector Uninstall web applications Chapter 6 : Configure the components of Galigeo Access to administration console Chapter 7 : Annexes Backup of Galigeo repository Restore Galigeo repository from a backup Knowing the version of Galigeo components / 43

3 Introduction In this chapter: Audience for this guide Document goal Reading conventions 3 / 43

4 About this document AUDIENCE FOR THIS GUIDE This document is aimed at technical staff in charge of the preparation and execution of the Galigeo platform installation as well as operators of the platform. DOCUMENT GOAL This document presents the technical architecture of the Galigeo Solution. It describes the technical prerequisites and the installation steps. READING CONVENTIONS Steps to follow Notice Advice Warning Example 4 / 43

5 Chapter 1: Prerequisites In this chapter: Architecture Schemas Cognos Server ArcGIS Server ArcGIS Online Galigeo Server Network Client Machine 5 / 43

6 1.1 Architecture Schemas GENERAL ARCHITECTURE Galigeo is designed as an n-tier, client-server, architecture deployed on Intranet/Internet: The top most layer is the presentation tier or the user interface. The Galigeo user interface is a thin Internet remote client, such as a web browser. The application tier or the business logic tier, consists of the Cognos BI server, the ArcGIS server and the Galigeo server. This tier controls the data exchange and connections between the presentation tier and the data tier (described below). Note that the Cognos server also controls the authentication/access through the Cognos security model. The last layer is the data tier with database servers where information is stored and retrieved from the DBMS. The complete architecture includes the tools for managing and administering this system: The Galigeo administration module, Cognos Framework Manager and Configuration tool as well as ArcGIS Desktop and Manager (ESRI). Galigeo BI Connector is installed on Cognos server. Galigeo administration module and cartographic viewer are installed on Galigeo Server. ARCHITECTURE SCHEMA FOR THE HTML CLIENT 1.2 Cognos Server The Cognos server delivers the data for the Cognos reports that will be visualized and analyzed in the Galigeo maps. The maps are embedded into the Cognos reports. The Cognos server hosts the BI connector used by Galigeo and its administration console. 6 / 43

7 Item Prerequisite Notices 1st test Cognos Portal present - launch Cognos Portal URL: IBM Server Products: FP1, , FP 1, , , FP 3, FP 4, FP 5, FP 6, FP 12, , FP 3, FP 4, FP 5 Check tests Ex : C10: Cognos , , The Cognos login screen should appear FP1, FP1, , Server components: Cognos Connection Portal: Cognos Viewer, Report Studio, Cognos Administration This server is independent from the one that runs Galigeo webapp Cognos Configuration Tool 2nd test Access to Cognos Viewer connect to Cognos Portal, open and refresh a Cognos report. 3rd test Access to Report Studio Cognos Portal > Launch Menu > Report Studio. 4th test Access to Cognos Administration Cognos Portal > Launch Menu > Cognos Administration. 5th test Access to Cognos Dispatcher - Launch Cognos Dispatcher URL: Ex : servlet/dispatch The Cognos login screen should appear without any applied style. Permissions on reports: Cognos User Account A Cognos user account with the ad hoc permissions is necessary to run the tests. This account is used as Galigeo advanced user. Read Write Execute Permissions on packages : Read Write Access to capability "Specificati on Execution" 7 / 43 See the second test above: Open and refresh a Cognos report.

8 1.3 ArcGIS Server The ArcGIS server can be used as a map service and feature service for the Cognos / Galigeo reports. Galigeo does not require the installation of additional components on the ArcGIS server. Item Prerequisite Notices ArcGIS Server 10.1x, 10.2x, 10.3x, 10.4x, 10.5x, 10.6x 1st test Check ArcGIS Manager launch its url: Ex ArcGIS 10 java: With the following tools: ESRI Products ArcGIS Server Map Service GIS Database ArcMap/ArcGIS for Desktop: for creating map projects ArcGIS Manager to publish and manage map services main/login.jsf The ArcSDE version is independent with Galigeo. The ArcGIS MapServices used by Galigeo must be available via REST from the client machines and also from Galigeo Server machine Not important for Galigeo Galigeo neither accesses directly to the GIS database - The login screen should display. - Connect with an arcgismanager account and access the map services page 2nd test ArcGIS REST API admin available - same thing: Ex ArcGIS 10 : ArcGIS REST API Admin to manage the REST map services (in particular to clear the cache) ArcGIS Server Map service published from a MXD or a MSD with in particular the options "Export Map" and "Query" (to set during the publishing) Check tests 1st test Open the REST url: Ex ArcGIS 10: services The list of available mapservices should be displayed. The use of MSD format is 2nd test Mapservice access via recommended. REST - click on a mapservice: Ex of mapservice REST URL: ggomapservice/mapserver The mapservice properties and layers displays. All ArcGIS supported formats 8 / 43 NA

9 The connection to ArcGIS Server is done both through Galigeo Server and the client. This means that the application server, e.g. Tomcat, and the client (web browser) must see ArcGIS Server. 9 / 43

10 1.4 ArcGIS Online Galigeo offers the possibility to connect automatically to ArcGIS Online (AGOL). The credentials are activated as soon as the appropriate license key is declared in Galigeo Administration console. The connection to ArcGIS Online is done through Galigeo Server, the one that hosts Galigeo cartographic viewer. This means that the application server, e.g. Tomcat, must see arcgis.com without any proxy authentication. 1.5 Galigeo Server The Galigeo server hosts the Galigeo web modules. Softwares pre-requisites: Item OS Prerequisite Windows Server 2008, 2012 all editions RedHat Enterprise Linux 5, 6 Notices NA Check tests NA 1st test (basic): type in a shell command prompt : java version Example of expected result: java version "1.7.0_17" Java Development Kit (JDK) Java Environme 1.7.0_xx nt 1.8.0_xx NA 2nd test: in the application server configuration console, check what Java version is used. Ex Tomcat - Check the parameter «Java Virtual Machine» in the tab «Java» of the configuration console: C:\jdk1.7.0_17\jre\bin\server \jvm.dll Tomcat 7.0.x (jdk 1.7) Applicatio Tomcat 8.0.x (jdk 1.8) n Server Tomcat 8.5.x (jdk 1.8) NA Go to the application server URL. The version number usually displays: Ex Tomcat: We recommend to use a 64 bits Tomcat application server and Java machine. Minimum and recommended resources sizing for Galigeo Tomcat application server (64 bits): 10 / 43

11 Component Minimum Recommended for 5 concurrent users (concurrent sessions) Processor #core Tomcat Memory Disk space (Tomcat + Galigeo) Type Intel Xeon Type Intel Xeon 2 cores 4 cores multithread 4 Go RAM 8 Go RAM 2 Go 10 Go SAS 15k rpm ou SSD For proper operation of HTML5 Print module, image or PDF, it is important that the Galigeo Server has access to base maps, either on internet or intranet. 11 / 43

12 1.6 Network This table lists the ports used for all the modules involved with Galigeo. The ports must be available from the calling application, which may require some adjustment to the appropriate firewall rules. The actual values assigned to ports may be different from the default ones. This is determined during installation of components. Port Protocol Cognos Server Gateway Port HTTP(S) Cognos Server Dispatcher Port RMI Port (Remote Method Invocation : J2EE Standard ) HTTP/ SOAP TCP/IP Opene d on Used by Default Value Firewall rule Cognos Server Galigeo server to query Cognos Server 80 Open in both directions Galigeo <-> Cognos Cognos Server Galigeo server to query Cognos Server 9300 Open in both directions Galigeo <-> Cognos 1099 NA Galigeo Server Galigeo (local) - Galigeo server(local) - BI Connector Galigeo Tomcat Port HTTP(S) Galigeo Server (from Cognos server to Galigeo server) 8080 Open in the direction Cognos à Galigeo - Web Client (from Open in the direction Client à Galigeo - Galigeo Server to query ArcGIS server mapservice ; and basemaps (html5 print) Open in the direction Client à GIS web client to Galigeo server) HTTP Port used by the ArcGIS REST services HTTP(S) GIS Server (from Galigeo server to ArcGIS server) 8399 The Galigeo server must have access to the REST services - Galigeo client: to query ArcGIS server basemaps if any Access to ArcGIS Online HTTPS arcgis.c om to query ArcGIS Online (from Galigeo server to ArcGIS Online) 12 / Open in the direction Galigeo Server à AGOL

13 13 / 43

14 1.7 Client The web browser on the client machine is used to access Cognos Connection Portal and the Cognos/Galigeo cartographic reports within Cognos Report Viewer. Item OS HTML5 Client Web browser Recommended Notices Windows Seven, 8.1, 10 desktop NA Internet Explorer: Not supported Javascript activated FireFox: 52 ESR, 62, 63 Chrome: 69, 70 Check tests NA Go to web browser Menu The IE compatibility mode > About to know its needed by Cognos Viewer version is not supported For proper operation of Galigeo Application, it is important that the client browser has access to base maps, either on internet or intranet. Client machine requirements We recommend to use Windows Seven, 8.1, 10 with 4 to 8 Go of RAM 14 / 43

15 Chapter 2: BI connector installation In this chapter: Where the installation takes place? Installation Steps 15 / 43

16 2.1 Where the installation takes place? The installation takes place on Cognos server. The installation steps described in this chapter concern a new installation. If Galigeo is installation. already installed, see chapter Update an existing After installation, IBM Cognos Service needs to be restarted in order to take into account Galigeo Menu within Cognos Report Viewer. <GGO_CD> is Galigeo CD root directory. Example of <GGO_CD> : \\fileserver\galigeo4cognos_g18.0_cd <COGNOS_HOME> is the installation path for Cognos Server components. Example of <COGNOS_HOME> : D:\products\cognos 16 / 43

17 2.2 Installation Steps Galigeo files installed hereafter are available at <GGO_CD>/Installation/1WebiGeoBI. Update <COGNOS_HOME>/<c10>/webcontent/rv directory (Cognos Report Viewer) with Galigeo files: Go to <GGO_CD>/Installation/1-WebiGeoBI/cognos.webcontent/rv directory Copy the 2 folders cgo, images and the file: If Cognos FP1: CCognosViewer.<cognos_version>ggo.js or Or Cognos to viewer.standalone.core.<cognos_version>ggo.js (FPx): corresponding to Cognos version to the directory <COGNOS_HOME>/<c10>/ webcontent/rv at Cognos Server. No original Cognos file is replaced. Activate CCognosViewer.js or viewer.standalone.core.js Galigeo file: Go to <COGNOS_HOME>/<c10>/webcontent/rv directory: Rename: Cognos FP1: CCognosViewer.js.cognos Cognos to (FPx): viewer.standalone.core.js (Cognos) into viewer.standalone.core.js.cognos CCognosViewer.js (Cognos) into Rename: Cognos FP1: CCognosViewer.<cognos_version>ggo.js (Galigeo) into CCognosViewer.js Cognos to viewer.standalone.core.<cognos_version>ggo.js viewer.standalone.core.js (FPx): (Galigeo) into Update CCognosViewer.js or viewer.standalone.core.js Galigeo file: 17 / 43

18 If Cognos Portal URL is not the default one: C10: Edit the file <COGNOS_HOME>/<c10>/webcontent/rv/<CognosViewer.js viewer.standalone.core.js> At the line includejs("/ibmcognos/rv/cgo/cgolaunch.js"); update the path to cgolaunch.js Example : If Cognos Portal URL is then the line is includejs("/mycognos/rv/cgo/cgolaunch.js"); Update cgolaunch.js file: The file "cgolaunch.js" is the entry point of Galigeo application. Edit file <COGNOS_HOME>/<c10>/webcontent/rv/cgo/cgolaunch.js Update the field cgocallurl It is the URL that redirects to entry point of the application located at Galigeo server. cgo webapp - It is of the form: http(s)://<tomcat_server_name_or_ip>:<tomcat_server_port>/ cgo/entry.jsp. var cgocallurl = " Activate Galigeo menu in Cognos Report Viewer: According to chosen language, copy the file <GGO_CD>/Installation/1-WebiGeoBI/cognos.templates/ps/portal/ viewer-toolbar.<cognos_version>ggo_<en fr de>.xml to the directory <COGNOS_HOME>/<c10>/templates/ps/portal Activate the file toolbar.xml : <COGNOS_HOME>/<c10>/templates/ps/portal/viewer- Rename viewer-toolbar.xml (Cognos) into viewer-toolbar.xml.cognos Rename viewer-toolbar.<cognos_version>ggo_<en fr de>.xml (Galigeo) into viewer-toolbar.xml 18 / 43

19 If Cognos viewer-toolbar.xml file has been customized: Copy viewer-toolbar.xml (Cognos) to viewer-toolbar.xml.cognos Edit viewer-toolbar.<cognos_version>ggo_<en fr de>.xml and copy all the content that is between comments tags <!-- wgoadd: webigeo buttons --> and <!-- End wgoadd: webigeo buttons --> Edit original viewer-toolbar.xml and paste previous copied lines at the end of the file between the tags </button> and </toolbarcontent> Save Stop and restart IBM Cognos Service in order to take into account the new viewer-toolbar.xml template. 19 / 43

20 Chapter 3: Installation of Galigeo web applications In this chapter: Global Overview Where the installation takes place? Deploy web applications Configure web applications Case of multiple Cognos Portals (optionnal) Admin Console - local installation of ESRI JS API Font installation Tomcat Configuration 20 / 43

21 3.1 Global Overview Below find a description of the Galigeo web applications. Web Application cgo.war Galigeo.war Description Notices Contains both Galigeo Administration tool and Server Side BI Connector. Installation and deployment process takes place on the Galigeo Galigeo HTML5 cartographic viewer + server. print module 3.2 Where the installation takes place? The installation takes place on Galigeo server. The installation steps described in this chapter concern a new installation. If Galigeo is installation. already installed, see chapter <GGO_CD> is Galigeo CD root directory. Example of <GGO_CD> : \\fileserver\galigeo4cognos_g18.0_cd <GALIGEO_HOME> is common directory outside Tomcat. Example of <GALIGEO_HOME> : Windows: D:\products\Galigeo <GGO_TOMCAT_HOME> is the root directory of Tomcat Server. Example of <GGO_TOMCAT_HOME> : Windows: D:\products\tomcat 21 / 43 Update an existing

22 3.3 Deploy GALIGEO_HOME Unzip <GGO_CD>/Installation/3-GaligeoHome.zip into a directory outside of the application server (For exemple: C:\Product\Galigeo). Once the archive unzipped, we should have the following directories under the $GALIGEO_HOME directory: Directory Description cache Local cache directory config Configuration files contexts Local configuration for each documents images Images directory for symbols and thumbs logs Application logs shp Map services using the direct shape connection xml Query results in XML format (debug only) WEBIGEO_R Local repository EPOSITORY In most cases, the location of GALIGEO_HOME is specified within the web applications (see chapter 3.5). However it can be overridden using an environment variable GALIGEO_HOME. 3.4 Deploy web applications Stop the GaligeoTomcat Service Go to <GGO_CD>/Installation/2-WebigeoGIS/webapps directory Copy cgo.war and Galigeo.war webapps to <GGO_TOMCAT_HOME>/webapps Restart Tomcat Service. 22 / 43

23 3.5 Configure web applications In this section: Specify the GALIGEO_HOME directory Edit the setting of the RMI port Specify the Galigeo repository folder Set Cognos dispatcher URL Multi-Dispatchers configuration Configure logs files Each of the operations described below require to be taken into account, a restart of Tomcat service. 23 / 43

24 Specify the GALIGEO_HOME directory The GALIGEO_HOME variable specifies the directory where <GGO_CD>/Installation/3GaligeoHome.zip has been unzipped (see Chapter 3.3). This variable needs to be defined in For Galigeo webapp: <GGO_TOMCAT_DIR>\webapps\Galigeo\WEB-INF\web.xml Uncomment the following section and set the correct location: <!-<context-param> <param-name>galigeo_home</param-name> <param-value>c:\galigeo_home</param-value> </context-param> --> For print module: <GGO_TOMCAT_DIR>\webapps\Galigeo\WEB-INF\mapfishprint-printer-factory.xml Set the correct location for the property galigeohome: <bean id="mapprinterfactory" class="com.galigeo.print.ggoprinterservletfactory"> <property name="galigeohome" value="c:/galigeo_home" /> </bean> Notice: use "/" as path separator Edit the setting of the RMI port The RMI (Remote Method Invocation) port has 1099 as default setting (standard J2EE setting). This port is used for information exchange between Galigeo modules and to access to Galigeo repository. This port might be used by another application at the Galigeo server; in this case the default setting has to be altered. To verify which ports that are already in use, open a DOS console and use the command netstat a. To change the RMI port value the steps are: Stop Galigeo Tomcat Service Edit the server file web.xml at the folder <GGO_TOMCAT_HOME>/webapps/cgo/WEB-INF Replace the value of RMI_PORT : <context-param> <param-name>rmi_port</param-name> <param-value><new_rmi_port_value></param-value> </context-param> 24 / 43

25 Restart Galigeo Tomcat Service Example: <context-param> <param-name>rmi_port</param-name> <param-value>1001</param-value> </context-param> Specify the Galigeo repository folder Stop Galigeo Tomcat Service Edit the web.xml server file at the folder <GGO_TOMCAT_HOME>/webapps/cgo/WEB-INF delete the comments tags before, <!--, and after, -->, the contextparam WGO_REPO_HOME Assign the values to the parameter between the tags <param-value> and </param-value> as follows: <context-param> <param-name>wgo_repo_home</param-name> <param-value> <GALIGEO_HOME>/WEBIGEO_REPOSITORY </param-value> </context-param> Restart Galigeo Tomcat Service <context-param> <param-name>wgo_repo_home</param-name> <param-value> D:\products\galigeo\WEBIGEO_REPOSITORY </param-value> </context-param> Set Cognos main dispatcher URL Galigeo application uses Cognos main dispatcher URL to communicate with Cognos server. Stop Galigeo Tomcat Service Edit the file <GGO_TOMCAT_HOME>/webapps/cgo/WEB-INF/classes/ common.properties and update COGNOS_DISPATCHER_URL parameter Restart Galigeo Tomcat Service 25 / 43

26 COGNOS_DISPATCHER_URL = How to get the value of Cognos Dispatcher URL: On Cognos Server open Cognos Configuration tool In Cognos Explorer select Environment node In right panel, within Other URI Settings section get the value of Dispatcher URI for external applications parameter. 26 / 43

27 Multi-Dispatchers configuration When Cognos set-up is multi-dispatchers, extra dispatchers (in addition to main dispatcher) can be configured using EXTRA_DISPATCHERS_URLS. parameter. When this configuration is active, dispatchers, COGNOS_DISPATCHER_URL and EXTRA_DISPATCHERS_URLS, will be used alternatively to communicate with cognos server Stop Galigeo Tomcat Service Edit the file <GGO_TOMCAT_HOME>/webapps/cgo/WEB-INF/classes/ common.properties, uncomment and update EXTRA_DISPATCHERS_URLS parameter as a comma separated list of extra dispatchers URLs Eventually update the value of DISPATCHERS_CHECK_RATE parameter (default is ms) that is the check period of each dispatcher (COGNOS_DISPATCHER_URL and EXTRA_DISPATCHERS_URLS), status, up or down. A down dispatcher is not used anymore until is up again. We recommend that this value should not be below 5000 ms. Restart Galigeo Tomcat Service Ex: one extra dispatcher: EXTRA_DISPATCHERS_URLS = Ex: many extra dispatchers: EXTRA_DISPATCHERS_URLS = dispatch-2:9300/p2pd/servlet/dispatch All dispatchers, COGNOS_DISPATCHER_URL et EXTRA_DISPATCHERS_URLS, must have access, in Cognos repository, to cartographic Cognos reports properties and associated packages properties. 27 / 43

28 Configure logs files "CGO" WEB MODULE Stop Galigeo Tomcat Service Open the file <GGO_TOMCAT_HOME>/webapps/cgo/WEB-INF/classes/log4j.xml Logs files configuration is given in the following table: Parameter value in tags : <appender name="filedebug"... (Change path to logs <param name="file" value="c:/logs/ files) galigeo_cognos_bi.log" />... </appender> Value C:/logs/galigeo_cognos_bi.log Notice Log files location Parameter ref in tags : (Inactivate traces) <logger > <appender-ref ref="filedebug" /> </logger> Value console or filedebug Notices console : traces INFO and FATAL levels redirected to standard output filedebug: traces all levels redirected to the file C:/logs/ galigeo_cognos_bi.log Inactivate traces Comment the tag <appender-ref ref="filedebug" /> Example : <logger > <!-- appender-ref ref="filedebug" /--> </logger> Restart Galigeo Tomcat Service "GALIGEO" WEB MODULE Log configuration is automatic: Cartographic viewer logs are located at <GALIGEO_HOME>/logs/galigeo_map.log Print module logs are located at <GALIGEO_HOME>/logs/ggo_print.log If you want to change log files folder and/or log level, the procedure is: 28 / 43

29 Stop Galigeo Tomcat Service To change path to log directory use -Dggo_log_path=/path_to_log_dir in Tomcat Java Options Example: -Dggo_log_path=C:/app/logs If Tomcat is installed as a service o Open the Tomcat configuration console, o Go to the tab "Java", o In the area «Java Options» add the following line: -Dggo_log_path=/path_to_log_dir If Tomcat starts as a script "startup.bat" o Edit the file <GGO_TOMCAT_HOME>/bin/catalina.bat o At the beginning of the script, add the line: set JAVA_OPTS=%JAVA_OPTS% -Dggo_log_path=/path_to_log_dir To change log level of cartographic viewer: o Edit file log4j.xml <GGO_TOMCAT_HOME>/webapps/Galigeo/WEB-INF/classes/ o Change log level in com.galigeo logger. Log levels by increasing verbosity are: ERROR, INFO, DEBUG Ex: <logger additivity="false" name="com.galigeo"> <level value="debug"/> <appender-ref ref="stdout_file"/> </logger> To change log level of print module: o Edit file <GGO_TOMCAT_HOME>/webapps/Galigeo/WEB-INF/classes/ logback.xml o Change log level in org.mapfish and com.galigeo logger. Log levels by increasing verbosity are: ERROR, INFO, DEBUG Ex: <logger name="org.mapfish" level="debug" /> <logger name="com.galigeo" level="debug" /> Restart Galigeo Tomcat Service 29 / 43

30 3.6 Case of multiple Cognos Portals (optional) In order to do some load balancing, multiple Cognos portals can be deployed on different applications servers. Each instance connects to the same Cognos repository and are usually accessed through a single HTTP proxy. Similarly, BI Connector server side - web application cgo - by deploying it on 2 distinct Galigeo Servers, GALIGEO_1 and GALIGEO_2 for example. The BI Connector called by Cognos portal can access: o Either a local Galigeo repository started by the "local" webapp cgo on GALIGEO_1: it is the default behaviour. o Or with a remote Galigeo repository started by a web application cgo located on a "remote" Tomcat on GALIGEO_2: that feature needs to be activated by following the steps below. On the first BO server, GALIGEO_1, we do a classic deployment of web application cgo: o That server hosts the Galigeo repository. On GALIGEO_1, we have the following configuration (each parameter modification needs a restart of Tomcat service.) : File Parameter Value Example GGO_REPO_PORT_1 <GGO_1_TOMCAT_HOME>/ webapps/cgo /WEB-INF/ web.xml RMI_PORT Used by the Galigeo repository. Also used by the data provider on GALIGEO_1 and the cartographic viewer On the second server, GALIGEO_2, we first need to do a classic installation of cgo : o We configure cgo webapp in order to access the remote repository started by the webapp cgo on the 1st server. On GALIGEO_2, we have the following configuration (each parameter modification needs a restart of Tomcat service.): File <GGO_2_TOMCAT_HOME>/ webapps/cgo /WEB-INF/ web.xml <GGO_2_TOMCAT_HOME>/ webapps/cgo /WEB-INF/ classes/ common.properties Parameter Value Example GGO_REPO_PORT_2 RMI_PORT DISTANT_FILESTO RE_HOST Only used by the shared data registry between the Galigeo connector on SERVER_2 and the cartographic viewer. GALIGEO_1 GALIGEO_ 1 GGO_REPO_PORT_ (à décommenter) DISTANT_FILESTO RE_PORT (à décommenter) 30 /

31 For both Cognos Portals we have the following configuration: File Paramete r Value.http(s)://<PROXY_SERVER>:<PROXY_PORT>/cgo/ <COGNOS_HOME>/ entry.jsp <c10>/webcontent/ cgocallurl rv/cgo/ The HTTP Proxy server load balances between GALIGEO_1 cgolaunch.js and GALIGEO_2 Once the steps are done, the users connecting to any Cognos Portal will see a single Galigeo repository. It is the same for Galigeo Administration Console. 3.7 Admin Console - local installation of ESRI JS API If Galigeo Administrator client web browser has no Internet access, the ESRI javascript API needs to be deployed locally. For this, on Galigeo server, follow the instructions given at: <GGO_TOMCAT_HOME>/webapps/cgo/admin/js_api/arcgis_v32_local_install.txt 3.8 Font installation Installation of the ESRI fonts The fonts contains a library of symbols used by the thematics. Unzip the zip file Tools\font_esri.zip in a folder On Windows, select all the.ttf file, right click then choose "Install" On Unix / Linux the font installation depends on the distribution Installation of Windows fonts on Unix / Linux for print module Windows fonts are used by the HTML5 print module and may be missing on the Unix / Linux server. They need to be installed. This action can be easily accomplished via the native package installer for each Unix / Linux distribution. For example, for a Debian Linux distribution type (like Ubuntu), the following command needs to be issued: sudo apt-get install ttf-mscorefonts-installer 31 / 43

32 3.9 Tomcat Configuration Memory Configuration In order to get some optimal performances in Galigeo, you need to modify Tomcat's default memory parameters. Once this change is done, you need to restart Tomcat. We recommend to use a 64 bits Tomcat application server and Java machine. Tomcat is installed as a service o Open the Tomcat configuration console, o Go to the tab "Java", o In the area «Java Options» add the two following lines: -Xrs -XX:MaxPermSize=256M Set the parameter "Initial memory pool" at 128 Set the parameter "Maximum memory pool" according to recommendations given in chapter 1.5 Galigeo Server o 64 bits Tomcat+JVM example: 4096 (there is no limit for a 64 bits JVM) o 32 bits Tomcat+JVM 32 example: 1024 (32 bits JVM is limited to 1536) Tomcat starts as a script "startup.bat" Edit the file <GGO_TOMCAT_HOME>/bin/catalina.bat At the beginning of the script, add the line: 64 bits Tomcat+JVM example: set JAVA_OPTS=%JAVA_OPTS% -Xmx4096m -Xrs -XX:MaxPermSize=256m 32 bits Tomcat+JVM example: set JAVA_OPTS=%JAVA_OPTS% -Xmx1024m -Xrs -XX:MaxPermSize=256m Special characters To display and print correctly special characters, you need to apply the following settings. Once changes are done, you need to restart Tomcat. Add parameter -Dfile.encoding=UTF-8 Tomcat is installed as a service o Open the Tomcat configuration console, o Go to the tab "Java", o In the area «Java Options» add the two following lines: 32 / 43

33 -Dfile.encoding=UTF-8 Tomcat starts as a script "startup.bat" o Edit the file <GGO_TOMCAT_HOME>/bin/catalina.bat o At the beginning of the script, add the line: set JAVA_OPTS=%JAVA_OPTS% -Dfile.encoding=UTF-8 Add parameter URIEncoding="UTF-8" o Edit file <GGO_TOMCAT_HOME>/conf/server.xml, o Go to tag <Connector port="8080".. corresponding to Tomcat port (by default 8080), and modify or add the parameter URIEncoding="UTF-8" Example: <Connector port="8080" protocol="http/1.1" redirectport="8443" URIEncoding="UTF-8"/> 33 / 43 connectiontimeout="20000"

34 Chapter 4: Update an existing installation In this chapter: Update BI Connector Update Galigeo web applications 34 / 43

35 4.1 Update BI Connector The operation takes place on Cognos server. After operation, IBM Cognos Service needs to be restarted in order to take into account Galigeo Menu within Cognos Report Viewer. <COGNOS_HOME> is the installation path for Cognos Server components. Example of <COGNOS_HOME> : D:\products\cognos Deactivate old Cognos/Galigeo files by renaming them: o Cognos FP1: <COGNOS_HOME>/<c10>/webcontent/rv/CognosViewer.js >.../CognosViewer.js.ggo_old o Cognos to (FPx): <COGNOS_HOME>/<c10>/webcontent/rv/ viewer.standalone.core.js ->.../viewer.standalone.core.js.ggo_old o <COGNOS_HOME>/<c10>/webcontent/rv/cgo/cgolaunch.js ->.../ cgolaunch.js.ggo_old o <COGNOS_HOME>/<c10>/templates/ps/portal/viewer-toolbar.xml ->.../ viewer-toolbar.xml.ggo_old Perform a standard installation of the new Galigeo BI connector. See chapter BI connector installation. 4.2 Update Galigeo web applications The operation takes place on Galigeo server. Uninstall old Galigeo webapps. See section Uninstall web applications Go to <GALIGEO_HOME>/config (ex: D:\products\galigeo\config), and inactivate current config.json file by renaming it config.json.old, for example. The new config.json file is automatically generated on the first display of a G18.0 map. If the old file has been customized (ex: custom basemaps), the customization has to be transferred to the new file Perform a standard installation of the new Galigeo webapps. See chapter Installation of Galigeo web applications o Use the existing <GALIGEO_HOME> directory for webapps configuration (Specify the GALIGEO_HOME and the Galigeo repository folder) 35 / 43

36 If update is done on G17.0, cartographic viewer name ha changed from ggo_carto_viewer(-ssl) to Galigeo. In Administration console > Parameters, update the following informations: - Galigeo GIS module Client URL parameter - If Direct Shape feature is used (MapServices Type = Shape), update MapServices REST access URL parameter and each MapService (MapServices tab) using Direct Shape. If you plan to use Territory management tool, some advanced users (Administration > Users tab) have to be declared/updated with Designer role. 36 / 43

37 Chapter 5 : Uninstall Galigeo In this chapter: Uninstall BI Connector Uninstall web applications 37 / 43

38 5.1 Uninstall BI Connector The operation takes place on Cognos server. <COGNOS_HOME> is the installation path for Cognos Server components. Example of <COGNOS_HOME> : D:\products\cognos Reactivate the default file CCognosViewer.js: Go to directory <COGNOS_HOME>/<c10>/webcontent/rv : Rename the file: Cognos FP1: CCognosViewer.js (Galigeo) into CCognosViewer.js.ggo Cognos to (FPx): viewer.standalone.core.js (Galigeo) into viewer.standalone.core.js.ggo Rename the file: Cognos FP1: CCognosViewer.js.cognos into CCognosViewer.js Cognos to (FPx): viewer.standalone.core.js viewer.standalone.core.js.cognos into Deactivate Galigeo menu: Go to directory <COGNOS_HOME>/<c10>/templates/ps/portal: Rename the file toolbar.xml.ggo viewer-toolbar.xml (with Galigeo menu) into viewer- Rename the file viewer-toolbar.xml.cognos into viewer-toolbar.xml Stop and restart IBM Cognos Service in order to take into account the default Cognos viewer-toolbar.xml template. 5.2 Uninstall web applications The operation takes place on Galigeo server. <GGO_TOMCAT_HOME> is the root directory of Tomcat Server. Example of <GGO_TOMCAT_HOME> : D:\products\tomcat 38 / 43

39 Stop the GaligeoTomcat Service Backup <GALIGEO_HOME> directory and all its content Delete <GALIGEO_HOME> directory Go to directory <GGO_TOMCAT_HOME>/webapps (e.g.: D:\products\tomcat\webapps \) and delete following elements: o cgo, Galigeo folders o cgo.war, Galigeo.war files Empty Tomcat cache: go to directory <GGO_TOMCAT_HOME>/work/Catalina/ localhost/ and delete the directories cgo and Galigeo Restart Tomcat Service 39 / 43

40 Chapter 6 : Configure the components of Galigeo In this chapter: Access to administration console 6.1 Access to administration console Setting Galigeo components parameters is done in Galigeo web administration console. A full description of these steps is found in the Administration guide. Galigeo administration console URL is the following: / 43

41 Chapter 7 : Annexes In this chapter: Backup of Galigeo repository Restore Galigeo repository from a backup Knowing the version of Galigeo components 41 / 43

42 7.1 Backup of Galigeo repository The procedure takes place on Galigeo server. This operation back-ups application settings of Galigeo and may be useful when a new Galigeo version is installed. <GALIGEO_HOME> is the Galigeo installation directory. Example of <GALIGEO_HOME> : Windows: D:\products\galigeo Unix / Linux : /products/galigeo Tomcat service is stopped and restarted during backup procedure. Stop Galigeo Tomcat service Copy the following directories in a backup directory <GGO_BACKUP>, outside Tomcat: o <GALIGEO_HOME>/config o <GALIGEO_HOME>/contexts o <GALIGEO_HOME>/dataset (since G17.0) o <GALIGEO_HOME>/shp o <GALIGEO_HOME>/WEBIGEO_REPOSITORY/tables Restart Tomcat service 7.2 Restore Galigeo repository from a backup The procedure takes place on Galigeo server. <GGO_BACKUP> is the path to the backup directory from a previous version of Galigeo repository. <GALIGEO_HOME> is the Galigeo installation directory. Example of <GALIGEO_HOME> : Windows: D:\products\galigeo Unix / Linux : /products/galigeo 42 / 43

43 Tomcat service is stopped and restarted during restore procedure. Stop Galigeo Tomcat service Restart Tomcat service Copy the directories config, contexts, dataset (since G17.0), shp WEBIGEO_REPOSITORY/tables from <GGO_BACKUP> to <GALIGEO_HOME> 7.3 Knowing the version of Galigeo components <GGO_CD> is Galigeo CD root directory. Example of <GGO_CD>: \\fileserver\galigeo4cognos_g18.0_cd <GGO_TOMCAT_HOME> is the root directory of Galigeo Tomcat Server. Example of <GGO_TOMCAT_HOME>: D:\products\tomcat The below table give the path to version files. Version file location All components cgo webapp Galigeo webapp <GGO_CD>/ modules.versions.txt Example cgo_war.version=galigeo G18.0;BICONNECTOR/ADMIN - COGNOS10.1.0FP001/10.1.1/10.1.1FP1/10.2.0/10.2.1;b Galigeo_viewer_war.version=Galigeo G18.0;HTML5-VIEWER/ PRINT;b[gaia-viewer]11269;b[print] <GGO_TOMCAT_HOME> /webapps/cgo/ version.txt version=galigeo G18.0;BICONNECTOR/ADMIN - COGNOS10.1.0FP001/10.1.1/10.1.1FP1/10.2.0/10.2.1;b <GGO_TOMCAT_HOME> /webapps/galigeo/ version.txt version=galigeo G18.0;HTML5VIEWER/PRINT;b[gaia-viewer] 11269;b[print] / 43 and