Galigeo for Cognos HTML5 Installation Guide - G18 · Galigeo for Cognos HTML5 Installation Guide -...

Copyright © 2018 by Galigeo. All Rights Reserved.

Galigeo for CognosHTML5 Installation Guide

- G18.0

Galigeo for Cognos HTML5 Installation Guide - G18.0

2 / 43

Table des matières

Introduction ....................................................................................................... 3About this document ....................................................................................... 4

Chapter 1: Prerequisites ....................................................................................... 51.1 Architecture Schemas ................................................................................. 61.2 Cognos Server .......................................................................................... 61.3 ArcGIS Server ........................................................................................... 81.4 ArcGIS Online ......................................................................................... 101.5 Galigeo Server ......................................................................................... 101.6 Network ................................................................................................. 121.7 Client ..................................................................................................... 14

Chapter 2: BI connector installation ..................................................................... 152.1 Where the installation takes place? ............................................................. 162.2 Installation Steps ..................................................................................... 17

Chapter 3: Installation of Galigeo web applications ............................................... 203.1 Global Overview ...................................................................................... 213.2 Where the installation takes place? ............................................................. 213.3 Deploy GALIGEO_HOME .......................................................................... 223.4 Deploy web applications ........................................................................... 223.5 Configure web applications ....................................................................... 23

Specify the GALIGEO_HOME directory ......................................................... 24Edit the setting of the RMI port ................................................................... 24Specify the Galigeo repository folder ........................................................... 25Set Cognos main dispatcher URL ................................................................. 25Multi-Dispatchers configuration ................................................................... 27Configure logs files .................................................................................... 28

3.6 Case of multiple Cognos Portals (optional) ................................................. 303.7 Admin Console - local installation of ESRI JS API ........................................ 313.8 Font installation ....................................................................................... 313.9 Tomcat Configuration .............................................................................. 32

Memory Configuration ............................................................................... 32Special characters ...................................................................................... 32

Chapter 4: Update an existing installation ............................................................ 344.1 Update BI Connector ................................................................................ 354.2 Update Galigeo web applications ............................................................... 35

Chapter 5 : Uninstall Galigeo ............................................................................. 375.1 Uninstall BI Connector .............................................................................. 385.2 Uninstall web applications ......................................................................... 38

Chapter 6 : Configure the components of Galigeo ................................................. 406.1 Access to administration console ............................................................... 40

Chapter 7 : Annexes .......................................................................................... 417.1 Backup of Galigeo repository ..................................................................... 427.2 Restore Galigeo repository from a backup .................................................. 427.3 Knowing the version of Galigeo components ............................................... 43


3 / 43

Introduction

In this chapter:

Audience for this guide

Document goal

Reading conventions


4 / 43

About this document

AUDIENCE FOR THIS GUIDEThis document is aimed at technical staff in charge of the preparation and execution of theGaligeo platform installation as well as operators of the platform.

DOCUMENT GOALThis document presents the technical architecture of the Galigeo Solution. It describes thetechnical prerequisites and the installation steps.

READING CONVENTIONS

Steps to follow

Notice

Advice

Warning

Example


5 / 43

Chapter 1: Prerequisites

In this chapter:

Architecture Schemas

Cognos Server

ArcGIS Server

ArcGIS Online

Galigeo Server

Network

Client Machine


6 / 43

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 userinterface 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, theArcGIS server and the Galigeo server. This tier controls the data exchange andconnections between the presentation tier and the data tier (described below). Note thatthe Cognos server also controls the authentication/access through the Cognos securitymodel.

· The last layer is the “data tier” with database servers where information is stored andretrieved 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 wellas 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 andanalyzed 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.


7 / 43

Item Prerequisite NoticesCheck tests

IBMServerProducts:

10.1.0FP1,10.1.1,10.1.1FP1, 10.2.0,10.2.1,10.2.1FP3,10.2.1FP4,10.2.1FP5,10.2.1FP6,10.2.1FP12,10.2.2,10.2.2FP3,10.2.2FP4,10.2.2FP5

Cognos 10.1.0FP1,10.1.1, 10.1.1FP1,10.2.0, 10.2.1,10.2.2

Server components:

· CognosConnectionPortal:

Cognos Viewer,Report Studio,CognosAdministration

· CognosConfiguration Tool

This server isindependentfrom the onethat runsGaligeo webapp

1st test – Cognos Portalpresent - launch Cognos PortalURL:

Ex :

C10: http://cog-srv/ibmcognos

The Cognos login screen shouldappear.

2nd test – Access to CognosViewer – connect to CognosPortal, open and refresh aCognos report.

3rd test – Access to ReportStudio – Cognos Portal >Launch Menu > Report Studio.

4th test – Access to CognosAdministration – Cognos Portal> Launch Menu > CognosAdministration.

5th test – Access to CognosDispatcher - Launch CognosDispatcher URL:

Ex :

http://cog-srv:9300/p2pd/servlet/dispatch

The Cognos login screen shouldappear without any appliedstyle.

CognosUserAccount

A Cognos useraccount with the adhoc permissions isnecessary to run thetests.

This account is usedas Galigeo advanceduser.

Permissions onreports:

· Read

· Write

· Execute

Permissions onpackages :

· Read

· Write

· Access tocapability "SpecificationExecution"

See the second test above:Open and refresh a Cognosreport.


8 / 43

1.3 ArcGIS Server

The ArcGIS server can be used as a map service and feature service for the Cognos / Galigeoreports.

Galigeo does not require the installation of additional components on the ArcGIS server.

Item Prerequisite Notices Check tests

ESRIProductsArcGISServer

ArcGIS Server10.1x, 10.2x, 10.3x,10.4x, 10.5x, 10.6x

With the followingtools:

· ArcMap/ArcGISfor Desktop: forcreating mapprojects

· ArcGIS Managerto publish andmanage mapservices

· ArcGIS REST APIAdmin to managethe REST mapservices (inparticular to clearthe cache)

The ArcSDEversion isindependentwith Galigeo.

1st test – Check ArcGIS Manager -launch its url:

Ex ArcGIS 10 java:

http://esri-srv:8099/arcgismanager/main/login.jsf

- The login screen should display.

- Connect with an arcgismanageraccount and access the mapservices page

2nd test – ArcGIS REST API adminavailable - same thing:

Ex ArcGIS 10 :

http://esri-srv:8399/arcgis/rest/admin

MapService

ArcGIS Server Mapservice publishedfrom a MXD or a MSD with in particular theoptions"Export Map" and"Query" (to setduring the publishing)

The ArcGISMapServices used byGaligeo must beavailable via RESTfrom the clientmachines and alsofrom Galigeo Servermachine

The use ofMSD format isrecommended.

1st test – Open the REST url:

Ex ArcGIS 10:

http://esri-srv:8399/arcgis/rest/services

The list of available mapservices shouldbe displayed.

2nd test – Mapservice access viaREST - click on a mapservice:

Ex of mapservice REST URL:

http://esri-gis:8399/arcgis/rest/services/ggoMapService/MapServer

The mapservice properties and layersdisplays.

GISDatabase

Not important forGaligeo

Galigeo neitheraccesses directly tothe GIS database

All ArcGISsupportedformats

NA


9 / 43

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


10 / 43

1.4 ArcGIS OnlineGaligeo offers the possibility to connect automatically to ArcGIS Online (AGOL). The credentials areactivated 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 thathosts 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 Prerequisite Notices Check tests

OS

Windows Server 2008,2012 all editions

RedHat Enterprise Linux 5,6

NA NA

JavaEnvironme

nt

Java Development Kit(JDK)

1.7.0_xx

1.8.0_xx

NA

1st test (basic): type in a shellcommand prompt : java –version

Example of expected result:java version "1.7.0_17" …

2nd test: in the applicationserver configuration console,check what Java version isused.

Ex Tomcat - Check the parameter« Java Virtual Machine » in the tab« Java » of the configurationconsole:

C:\jdk1.7.0_17\jre\bin\server\jvm.dll

Application Server

Tomcat 7.0.x (jdk 1.7)



NA

Go to the application serverURL. The version number usuallydisplays:

Ex Tomcat: http://ggo-srv:8080

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):


11 / 43

Component MinimumRecommended for 5

concurrent users

(concurrent sessions)

Processor

#core

Type Intel Xeon

2 cores

Type Intel Xeon

4 cores multithread

Tomcat Memory 4 Go RAM 8 Go RAM

Disk space (Tomcat +Galigeo) 2 Go

10 Go

SAS 15k rpm ou SSD

For proper operation of HTML5 Print module, image or PDF, it is importantthat the Galigeo Server has access to base maps, either on internet orintranet.


12 / 43

1.6 Network

This table lists the ports used for all the modules involved with Galigeo. The ports must beavailable from the calling application, which may require some adjustment to the appropriatefirewall rules.

The actual values assigned to ports may be different from the default ones. Thisis determined during installation of components.

Port Protocol Opened on

Used by DefaultValue

Firewall rule

Cognos ServerGateway Port HTTP(S) Cognos

ServerGaligeo server toquery Cognos Server 80

Open in bothdirections Galigeo <->Cognos

Cognos ServerDispatcher

Port

HTTP/SOAP

CognosServer

Galigeo server toquery Cognos Server 9300

Open in bothdirections Galigeo <->Cognos

RMI Port(RemoteMethod

Invocation :J2EE

Standard )

TCP/IP GaligeoServer Galigeo (local) 1099 NA

GaligeoTomcat Port

HTTP(S) GaligeoServer

- Galigeo server(local)

- BI Connector(from Cognosserver to Galigeoserver)

- Web Client (fromweb client toGaligeo server)

8080

Open in the directionCognos à Galigeo

Open in the directionClient à Galigeo

HTTP Portused by theArcGIS REST

services

HTTP(S)GISServer

- Galigeo Server toquery ArcGIS servermapservice ; andbasemaps (html5print)

(from Galigeoserver to ArcGISserver)

- Galigeo client: toquery ArcGIS serverbasemaps if any

8399

Open in the directionClient à GIS

The Galigeo servermust have access tothe REST services

Access to

ArcGISOnline

HTTPS arcgis.com

to query ArcGISOnline

(from Galigeoserver to ArcGISOnline)

443Open in the directionGaligeo Server àAGOL


13 / 43


14 / 43

1.7 Client

The web browser on the client machine is used to access Cognos Connection Portal and theCognos/Galigeo cartographic reports within Cognos Report Viewer.

Item Recommended Notices Check tests

OS Windows Seven, 8.1, 10desktop NA NA

HTML5Client

Webbrowser

Internet Explorer: Notsupported

FireFox: 52 ESR, 62, 63

Chrome: 69, 70

Javascript activated

The IE compatibility modeneeded by Cognos Vieweris not supported

Go to web browser Menu> About to know itsversion

For proper operation of Galigeo Application, it is important that the clientbrowser 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


15 / 43

Chapter 2: BI connector installation

In this chapter:

Where the installation takes place?

Installation Steps


16 / 43

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 already installed, see chapter Update an existinginstallation.

After installation, IBM Cognos Service needs to be restarted in order to takeinto 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


17 / 43

2.2 Installation Steps

Galigeo files installed hereafter are available at <GGO_CD>/Installation/1-WebiGeoBI.

· 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 10.1.0FP1: CCognosViewer.<cognos_version>ggo.js or

· Or Cognos 10.1.1 to 10.2.2(FPx):viewer.standalone.core.<cognos_version>ggo.js

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 10.1.0FP1: CCognosViewer.js (Cognos) intoCCognosViewer.js.cognos

· Cognos 10.1.1 to 10.2.2(FPx): viewer.standalone.core.js (Cognos) intoviewer.standalone.core.js.cognos

Rename:

· Cognos 10.1.0FP1: CCognosViewer.<cognos_version>ggo.js (Galigeo) intoCCognosViewer.js

· Cognos 10.1.1 to 10.2.2(FPx):viewer.standalone.core.<cognos_version>ggo.js (Galigeo) intoviewer.standalone.core.js

· Update CCognosViewer.js or viewer.standalone.core.js Galigeo file:


18 / 43

If Cognos Portal URL is not the default one:

C10: http://<cognos_server>/ibmcognos

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 pathto cgolaunch.js

Example :

If Cognos Portal URL is http://<cognos_server>/mycognos

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 - cgo webapp -located at Galigeo server.

It is of the form:

http(s)://<TOMCAT_SERVER_NAME_OR_IP>:<TOMCAT_SERVER_PORT>/cgo/entry.jsp.

var cgoCallUrl = "http://ggo-srv:8080/cgo/entry.jsp"

· 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 <COGNOS_HOME>/<c10>/templates/ps/portal/viewer-toolbar.xml :

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


19 / 43

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 thecontent that is between comments tags and 

Edit original viewer-toolbar.xml and paste previous copied lines at the end ofthe 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.


20 / 43

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


21 / 43

3.1 Global Overview

Below find a description of the Galigeo web applications.

Web Application Description Notices

cgo.war Contains both Galigeo Administration tooland Server Side BI Connector. Installation and

deployment process takesplace on the Galigeoserver.Galigeo.war

Galigeo HTML5 cartographic viewer +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 already installed, see chapter Update an existinginstallation.


Example of <GGO_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


22 / 43

3.3 Deploy GALIGEO_HOME

· Unzip <GGO_CD>/Installation/3-GaligeoHome.zip into a directory outside of theapplication 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_REPOSITORY

Local repository

In most cases, the location of GALIGEO_HOME is specified within the web applications (seechapter 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.


23 / 43

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 restartof Tomcat service.


24 / 43

Specify the GALIGEO_HOME directory

The GALIGEO_HOME variable specifies the directory where <GGO_CD>/Installation/3-GaligeoHome.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.xmlUncomment the following section and set the correct location:



· For print module: <GGO_TOMCAT_DIR>\webapps\Galigeo\WEB-INF\mapfish-print-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 J2EEsetting). This port is used for information exchange between Galigeo modules and to accessto Galigeo repository.

This port might be used by another application at the Galigeo server; in this case the defaultsetting has to be altered.

To verify which ports that are already in use, open a DOS console and use thecommand 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>


25 / 43

· 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


· Edit the web.xml server file at the folder

<GGO_TOMCAT_HOME>/webapps/cgo/WEB-INF

· delete the comments tags before, , the context-param 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>


<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.


· Edit the file <GGO_TOMCAT_HOME>/webapps/cgo/WEB-INF/classes/common.properties and update COGNOS_DISPATCHER_URL parameter



26 / 43

COGNOS_DISPATCHER_URL = http://cog-srv:9300/p2pd/servlet/dispatch

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 DispatcherURI for external applications parameter.


27 / 43

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 andEXTRA_DISPATCHERS_URLS, will be used alternatively to communicate with cognos server


· Edit the file <GGO_TOMCAT_HOME>/webapps/cgo/WEB-INF/classes/common.properties, uncomment and update EXTRA_DISPATCHERS_URLSparameter as a comma separated list of extra dispatchers URLs

· Eventually update the value of DISPATCHERS_CHECK_RATE parameter(default is 30000 ms) that is the check period of each dispatcher(COGNOS_DISPATCHER_URL and EXTRA_DISPATCHERS_URLS), status, up ordown. A down dispatcher is not used anymore until is up again. We recommendthat this value should not be below 5000 ms.


Ex: one extra dispatcher:

EXTRA_DISPATCHERS_URLS = http://dispatch-1:9300/p2pd/servlet/dispatch

Ex: many extra dispatchers:

EXTRA_DISPATCHERS_URLS = http://dispatch-1:9300/p2pd/servlet/dispatch,http://dispatch-2:9300/p2pd/servlet/dispatch

All dispatchers, COGNOS_DISPATCHER_URL et EXTRA_DISPATCHERS_URLS, musthave access, in Cognos repository, to cartographic Cognos reportsproperties and associated packages properties.


28 / 43

Configure logs files

"CGO" WEB MODULE


· Open the file <GGO_TOMCAT_HOME>/webapps/cgo/WEB-INF/classes/log4j.xml

· Logs files configuration is given in the following table:

Parameter

(Changepath to logsfiles)

value in tags :

<appender name="filedebug"...

<param name="file" value="C:/logs/galigeo_cognos_bi.log" />

...

</appender>

Value C:/logs/galigeo_cognos_bi.log

Notice Log files location

Parameter

(Inactivatetraces)

ref in tags :

<logger …>

<appender-ref ref="filedebug" />

</logger>

Value console or filedebug

Notices console : traces – INFO and FATAL levels – redirected tostandard output

filedebug: traces – all levels – redirected to the file C:/logs/galigeo_cognos_bi.log

Inactivatetraces

Comment the tag <appender-ref ref="filedebug" />

Example :

<logger …>

< !-- appender-ref ref="filedebug" /-->

</logger>


"GALIGEO" WEB MODULELog 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:


29 / 43


· To change path to log directory use -Dggo_log_path=/path_to_log_dir in TomcatJava 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 <GGO_TOMCAT_HOME>/webapps/Galigeo/WEB-INF/classes/log4j.xml

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 increasingverbosity are: ERROR, INFO, DEBUG

Ex:<logger name="org.mapfish" level="DEBUG" /><logger name="com.galigeo" level="DEBUG" />



30 / 43

3.6 Case of multiple Cognos Portals (optional)

In order to do some load balancing, multiple Cognos portals can be deployed on differentapplications servers. Each instance connects to the same Cognos repository and are usuallyaccessed through a single HTTP proxy.

Similarly, BI Connector server side - web application cgo - by deploying it on 2 distinctGaligeo 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 locatedon a "remote" Tomcat on GALIGEO_2: that feature needs to be activated byfollowing 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 arestart of Tomcat service.) :

File Parameter Value Example

<GGO_1_TOMCAT_HOME>/webapps/cgo/WEB-INF/web.xml

RMI_PORT

GGO_REPO_PORT_1

· Used by the Galigeo repository.

· Also used by the data provideron GALIGEO_1 and thecartographic viewer.

1099

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 arestart of Tomcat service.):

File Parameter Value Example

<GGO_2_TOMCAT_HOME>/webapps/cgo/WEB-INF/web.xml

RMI_PORT

GGO_REPO_PORT_2

Only used by the shared dataregistry between the Galigeoconnector on SERVER_2 and thecartographic viewer.

10099

<GGO_2_TOMCAT_HOME>/webapps/cgo/WEB-INF/classes/common.properties

DISTANT_FILESTORE_HOST

(à décommenter)

GALIGEO_1 GALIGEO_1

DISTANT_FILESTORE_PORT

(à décommenter)

GGO_REPO_PORT_1 1099


31 / 43

For both Cognos Portals we have the following configuration:

File Parameter Value

<COGNOS_HOME>/<c10>/webcontent/rv/cgo/cgolaunch.js

cgoCallUrl

.http(s)://<PROXY_SERVER>:<PROXY_PORT>/cgo/entry.jsp

The HTTP Proxy server load balances between GALIGEO_1and GALIGEO_2

Once the steps are done, the users connecting to any Cognos Portal will see a single Galigeorepository.

It is the same for Galigeo Administration Console.

3.7 Admin Console - local installation of ESRI JS APIIf Galigeo Administrator client web browser has no Internet access, the ESRI javascript API needs to bedeployed 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 / Linuxserver. They need to be installed. This action can be easily accomplished via the nativepackage installer for each Unix / Linux distribution.

For example, for a Debian Linux distribution type (like Ubuntu), the following command needsto be issued:sudo apt-get install ttf-mscorefonts-installer


32 / 43

3.9 Tomcat Configuration

Memory Configuration

In order to get some optimal performances in Galigeo, you need to modify Tomcat's defaultmemory 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 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 inchapter 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 In the area « Java Options » add the two following lines:


33 / 43

-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 default8080), and modify or add the parameter URIEncoding="UTF-8"

Example:

<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000"redirectPort="8443" URIEncoding="UTF-8"/>


34 / 43

Chapter 4: Update an existing installation

In this chapter:

Update BI Connector

Update Galigeo web applications


35 / 43

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 intoaccount Galigeo Menu within Cognos Report Viewer.



· Deactivate old Cognos/Galigeo files by renaming them:

o Cognos 10.1.0FP1: <COGNOS_HOME>/<c10>/webcontent/rv/CognosViewer.js -> .../CognosViewer.js.ggo_old

o Cognos 10.1.1 to 10.2.2(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 BIconnector 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 inactivatecurrent config.json file by renaming it config.json.old, for example. The newconfig.json file is automatically generated on the first display of a G18.0 map. If the oldfile has been customized (ex: custom basemaps), the customization has to be transferredto the new file

· Perform a standard installation of the new Galigeo webapps. See chapter Installation ofGaligeo web applications

o Use the existing <GALIGEO_HOME> directory for webapps configuration (Specify the GALIGEO_HOME and the Galigeo repository folder)


36 / 43

If update is done on G17.0, cartographic viewer name ha changed fromggo_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), updateMapServices REST access URL parameter and each MapService (MapServicestab) 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.


37 / 43

Chapter 5 : Uninstall Galigeo

In this chapter:

Uninstall BI Connector

Uninstall web applications


38 / 43

5.1 Uninstall BI Connector

The operation takes place on Cognos server.



· Reactivate the default file CCognosViewer.js:

Go to directory <COGNOS_HOME>/<c10>/webcontent/rv :

Rename the file:

· Cognos 10.1.0FP1: CCognosViewer.js (Galigeo) into CCognosViewer.js.ggo

· Cognos 10.1.1 to 10.2.2(FPx): viewer.standalone.core.js (Galigeo) intoviewer.standalone.core.js.ggo

Rename the file:

· Cognos 10.1.0FP1: CCognosViewer.js.cognos into CCognosViewer.js

· Cognos 10.1.1 to 10.2.2(FPx): viewer.standalone.core.js.cognos intoviewer.standalone.core.js

· Deactivate Galigeo menu:

Go to directory <COGNOS_HOME>/<c10>/templates/ps/portal:

Rename the file viewer-toolbar.xml (with Galigeo menu) into viewer-toolbar.xml.ggo

Rename the file viewer-toolbar.xml.cognos into viewer-toolbar.xml

Stop and restart IBM Cognos Service in order to take into account the defaultCognos 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


39 / 43

· 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


40 / 43

Chapter 6 : Configure the components of Galigeo

In this chapter:

Access to administration console6.1 Access to administration console

Setting Galigeo components parameters is done in Galigeo web administration console. A fulldescription of these steps is found in the Administration guide.

Galigeo administration console URL is the following:

http://<GGO_TOMCAT_SERVER>:<GGO_TOMCAT_PORT>/cgo/admin

http://ggo-srv:8080/cgo/admin


41 / 43

Chapter 7 : Annexes

In this chapter:

Backup of Galigeo repository

Restore Galigeo repository from a backup

Knowing the version of Galigeo components


42 / 43

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 newGaligeo version is installed.

<GALIGEO_HOME> is the Galigeo installation directory.


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>, outsideTomcat:

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 Galigeorepository.

<GALIGEO_HOME> is the Galigeo installation directory.


Windows: D:\products\galigeo

Unix / Linux : /products/galigeo


43 / 43

Tomcat service is stopped and restarted during restore procedure.

· Stop Galigeo Tomcat service

· Copy the directories config, contexts, dataset (since G17.0), shp andWEBIGEO_REPOSITORY/tables from <GGO_BACKUP> to <GALIGEO_HOME>

· Restart Tomcat service

7.3 Knowing the version of Galigeo components


Example of <GGO_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 Example

All components <GGO_CD>/modules.versions.txt

cgo_war.version=Galigeo G18.0;BI-CONNECTOR/ADMIN - COGNOS-10.1.0FP001/10.1.1/10.1.1FP1/10.2.0/10.2.1;b610123

Galigeo_viewer_war.version=GaligeoG18.0;HTML5-VIEWER/PRINT;b[gaia-viewer]11269;b[print]11245

cgo

webapp

<GGO_TOMCAT_HOME>/webapps/cgo/version.txt

version=Galigeo G18.0;BI-CONNECTOR/ADMIN - COGNOS-10.1.0FP001/10.1.1/10.1.1FP1/10.2.0/10.2.1;b610123

Galigeo

webapp

<GGO_TOMCAT_HOME>/webapps/Galigeo/version.txt

version=Galigeo G18.0;HTML5-VIEWER/PRINT;b[gaia-viewer]11269;b[print]11245

Date post:	23-Mar-2020
Category:	Documents
Upload:	others
View:	11 times
Download:	0 times

Galigeo for Cognos HTML5 Installation Guide - G18 · Galigeo for Cognos HTML5 Installation Guide -...

Documents