Heiler Catalog Intelligence Installation Manual

Transcription

1 Installation Manual Heiler Catalog Intelligence Installation Manual Valid since version 1.2 ( ) Heiler Software AG R&D - Research & Development Last changed: April 23, 2015

2 Table of Contents 1 Objective System requirements Hardware Client Application Server Database server Software Client Application Server Database systems Preparing the setup Installation of the QlikView Server Installation steps Post installation Installation of the ticketing web service Configuration of the ticketing web service Configuration of the QlikView Server Installation of the HCI Document Initial registration of the service user Configuration of the database connection Configuration of the data source Configuration of the data base settings in Heiler Catalog Intelligence Configuration of the SAP connection Deployment of the HCI document on the QlikView Server Creation of Heiler Catalog Intelligence users Registration of Heiler Catalog Intelligence users in the data access file Configuration of the data refreshing Configuration of the server side refreshing (QlikView Publisher) Configuration of the designer functionality Configuration of the server side (QlikView Server) Configuration of the client side (HCI document) Configuration of the user role (dataaccess.xml)...30 Date: April 23, 2015 Page 2 of 33

3 9 Integration into Heiler Business Catalog Configuration of the tab within the HBC Configuration of the HCI bundle I18n of the HCI bundle Integration into Heiler Catalog Manager Administration of HCI document variables vsearchlogfilepath Optional Removing of restore button in QlikView menu Date: April 23, 2015 Page 3 of 33

4 1 Objective This document provides information on the installation of the Heiler Catalog Intelligence 1.1 and its components. 2 System requirements 2.1 Hardware Client X86 processor Main memory 512 MB Application Server Processor: X86: Intel Core Duo compatible or higher X64: Multi-core x64 compatible processors Main memory: >= 1 GB for X86 processors >= 4 GB for X64 processors The capacity of the server to perform analyses and the number of users that can simultaneously connect to the server depend hugely on the size of the available main memory. Hard disk >= 450 MB to install Database server X86 dual processor or dual core processor >= 3 GHz Main memory 4-6 GB Hard disk > 100 GB (Raid) 2.2 Software Client Windows XP SP2, Windows Vista, Windows 7 Internet Explorer 7, 8, 9 Mozilla Firefox 6 or later Pop-up blocker disabled Recommended screen resolution: 1280 x 1024 (min x 768) All browsers have to support and activate Java Script Application Server Windows Server 2008 R2 Required software features Microsoft.NET 4.0 Framework 64 bit must be available IIS features/extensions Date: April 23, 2015 Page 4 of 33

5 ASP.NET.NET Extensibility ISAPI Extensions ISAPI Filters Database systems Microsoft SQL Server 2008 R1/R2 Oracle Database 11g R1/R2 ODBC database drivers for one of the used database system Date: April 23, 2015 Page 5 of 33

6 3 Preparing the setup The installation of the Heiler Catalog Intelligence HCI depends on the following preconditions: You require a service account with local administrative rights on the machine where you install the QlikView server components. The Heiler Business Catalog HBC is installed The Heiler Catalog Manager HCM is installed The IIS Admin service is up and running on the machine Valid QlikView licenses for registering the QlikView components, if the machine you are installing the QllikView components on does not have a connection to the internet you have to create the LEF information in advance for being able of activating the QlikView components during the installation process. See also chapter 4.2. An installation of the QlikView Desktop (Developer) for initializing the document is not required on the customers server machine, the initialization of the document is performed by a special process described in chapter 7.1. The ticketing webservice has to be installed on the same machine where the QlikView server is installed on. Dependent on the HCI scenario you are installing (Classic/SAP) you need the packages defined in the table below. All packages are available from the product release share. Package Classic scenario SAP scenario QlikViewServer_x64Setup.exe X x HCI_ _Classic.zip HCI_ _SAPConnector.zip X x Date: April 23, 2015 Page 6 of 33

7 4 Installation of the QlikView Server The QlikView Server installation is performed with an installer. The installation requires an administrator account on the machine where you want to perform the installation. It is recommended to use this administrator account for the whole Heiler Catalog Intelligence installation. In this document this user will be named DOMAIN\USER Note: The IIS Admin service must be up and running on the machine. 4.1 Installation steps Start the installation by executing the installer QlikViewServer_x64Setup.exe. Select the region for the local location of the server. Click Next to continue. Read the license agreement, and continue by selecting I accept the terms in the license agreement. Click Next to continue. Enter the required information for QlikView server, the full name and the organization information. Click Next to continue. All files will be installed under a specified folder location. If you would like to change the root folder location of the installed files, e.g. E:\Heiler\QlikView\, click Change to specify the preferred location. Click Next to continue. Configure the profile with the following options selected and click Next to continue. In the logon information dialog you set the account that the QlikView server/publisher services will run under. This account has to be an account with administrative rights for being able of maintaining windows services. Click Next to continue. Date: April 23, 2015 Page 7 of 33

8 Note: This account will be automatically inserted into QlikView s administrators group. This account will also be used for the ticketing web service. Click Install to start the installation. Once the Installation is complete, click Finish. Note: You must reboot the machine in order to enable the functionality of the QlikView Server. Date: April 23, 2015 Page 8 of 33

9 4.2 Post installation To complete the installation you have register the QlikView components. To register your QlikView components perform the following steps: Start the QlikView Management console. Please note that QlikView 11 compaired with QlikView 10 integrates QlikView Enterprise Management Console into QlikView Management Console. QlikView Enterprise Management Console does not longer exist. All functionality will be managed by QlikView Management Console. Select System -> Licenses tab Choose QlikView Publisher in the navigation tree left side. Enter the serial number and the control number from your license file for the QlikView Publisher. Don t forget to also fill out the fields for name and organization Date: April 23, 2015 Page 9 of 33

10 Click Apply License. Note: If the machine you are installing the QlikView software on does not have a connection to the internet you have to request the so called LEF file for the license manually. You can use this link to view the LEF then copy and paste it into the space provided on the management console to register the server. Date: April 23, 2015 Page 10 of 33

11 Select System -> Licenses tab Choose QlikView OEM Server in the navigation tree left side. Choose tab QlikView OEM Server License Enter the serial number and the control number from your license file for the QlikView Publisher. Don t forget to also fill out the fields for name and organization Click Apply License. On the Status tab, check that the 5 services are running. Date: April 23, 2015 Page 11 of 33

12 5 Installation of the ticketing web service Note: Check the IIS configuration: the ASP.NET,.NET extensibility, ISAPI Extensions, ISAPI Filters have to be enabled. For the integration of HCI into HBC a so called ticketing web service has to be installed. This service provides the single sign on at the Heiler Business Catalog server. To install the ticketing web service, perform the following steps: The ticketing webservice has to be installed on the same machine/server where the QlikView server will be installed. Unzip the file HCI_1.1\ticketingService\ticketWebservice_Security.zip from the HCI package to a new location, e.g. E:\Heiler\ticketWebservice_Security Start IIS Manger to add a new application within the default website Chose ticketwebservicesecure as alias and point to the folder you just extracted in the step before, e.g. E:\Heiler\ticketWebservice_Security Date: April 23, 2015 Page 12 of 33

13 Click Ok to finish the process of adding a new application You should now see an additional entry in the tree on the left hand side containing the new application 5.1 Configuration of the ticketing web service The central element for configuring the ticketing web service is the configuration file web.config. This configuration file is located within the installation of the ticketing web service done in the last chapter. E.g. E:\Heiler\ticketWebservice_Security\web.config. In order to be able to retrieve a ticket from the QlikView Server, the requestor-process must run under the user credentials of a QlikView administrator group member. Therefore, you must configure the <identity> tag within the web.config file to run the web service with such user credentials. Some problems using special characters such as & in the password were observed while the installations. Please avoid such signs in the password of service user. <identity impersonate="true" username="domain\user" password="xxxxxx"/> Further on you have to set the following settings: <appsettings> <add key="qvserver" value=" " /> <add key="allowedusername" value="hbcuser" /> <add key="allowedpassword" value="heiler" /> </appsettings> QVServer : Hostname/IP of the QlikView Server AllowedUsername: a client username that is allowed to access the web service AllowedPassword: the corresponding password Note: The username and password must match the corresponding username and password in the HCI bundle property configuration in chapter 9.1 After installing and configuring the ticketing web service, you should be able to see the WSDL (Web Service Definition Language) file as shown in the figure below by typing this url into the browser on the machine where the QlikView server is installed: Date: April 23, 2015 Page 13 of 33

14 6 Configuration of the QlikView Server This chapter describes the basic configuration of the QlikView server components. This configuration is done with the QlikView Management Console. Open the QlikView Management Console. Can be found under Start -> All Programs -> QlikView in the Windows start menu Select System -> Setup -> QlikView Servers -> QlikView Server>. Open the Security tab and select the option Prohibit anonymous within the Clients section and the DMS authentication option within the Authorization section. Leave all other settings as they are. Click Apply to save the settings. Select System -> Setup -> QlikView Web Servers -> QlikView Web Server>. Open the AccessPoint tab and select Full Browser and Small Devices Version option within the Default Preferred Client section. Date: April 23, 2015 Page 14 of 33

15 Finally click Apply to save the settings. Date: April 23, 2015 Page 15 of 33

16 7 Installation of the HCI Document HCI has been realized in form of a QlikView document evaluating and formatting data from HCM and HBC. This document, further on referred as HCI document, has to be stored with its configuration files to a destination of your choice. The document and its configuration files can be found in the installation package located in the subdirectory HCI. Unpack HCI_ _Classic\HCI to your local disk e.g. to E:\Heiler\HCI\. This folder is called HCI_HOME later in this document. 7.1 Initial registration of the service user Before the document can be deployed and used on the QlikView server an initial reload of the document with QlikView developer has to be performed. This process of initializing the document with the corresponding windows service user at the customers machine will be done by the development. To speed up this process you have to provide the user name of the account with local administrative rights on the machine the installation of the QlikView server components is performed. With this information the HCI development will provide you an initialized HCI document which can be used on the customer s machine. 7.2 Configuration of the database connection The database is accessed via ODBC. An appropriate ODBC client for the Heiler Business Catalog/Heiler Catalog Manager database has to exist on the machine, where the HCI document has been stored to Configuration of the data source In the first step you have to create and configure an appropriate data source. This section describes how to create and configure a data source for Oracle and MS SQL. You can use the ODBC Data Source Administrator from Settings -> Control Panel -> Administrative Tools -> Data Sources (ODBC). As we are using an existing HBC HCM database the specific requirements regarding the database setup can be found in the corresponding installation manuals of HBC and HCM. Date: April 23, 2015 Page 16 of 33

17 MS SQL It is important to configure a System DSN to allow the automatic updates executed by the QlikView Publisher. Date: April 23, 2015 Page 17 of 33

18 Fill out a name, description for the ODBC connection, make sure to remember the name as the name will be required later on in the installation process. Choose your database server, and click next. For an instance the format is <SERVER_NAME>\<INSTANCE_NAME> Date: April 23, 2015 Page 18 of 33

19 Provide the login information for connecting to the database server. In our example we are using SQL server authentication. Click next to continue. On the next screen use the predefined settings and click next to continue. Date: April 23, 2015 Page 19 of 33

20 Oracle It is important to configure a System DSN to allow the automatic updates executed by the QlikView Publisher. Fill out the fields for name, description, TNS service name and user ID and click OK to save the settings. Note: The service name is defined in the tnsname.ora file found in the installation directory of the oracle clien/server. Date: April 23, 2015 Page 20 of 33

21 7.2.2 Configuration of the data base settings in Heiler Catalog Intelligence In a next step you have to customize the configuration file HCI_HOME/SOURCE/connectDB.txt which is used by the QlikView Server later on. You have to set the following properties within this configuration file: HBC_DBname: name of the HBC database used for data loading HCM_SUPPLIER_DBname: name of the HCM database used for data loading Note: Both properties must be enclosed by inverted commas and in capital letters. This is a QlikView scripting syntax. SET HBC_DBname='HBC_LIVE.dbo'; SET HCM_SUPPLIER_DBname='HCM_SUPPLIER_TEST.dbo'; ODBC CONNECT TO hci_oracle (UserId is hbc_access, Password is heiler); In the last line you have to adjust the settings for the ODBC data source name, user and password: ODBC CONNECT TO <data source name> (UserId is <userid>, Password is <pwd> where is: data source name: the name of the ODBC data source defined in the chapter user ID: database user name pwd: password Configuration of the SAP connection If you want to use data from SAP tables, you will have to install the QlikView SAPConnector. The package needed you ll find at: HCI_1.1\Additional\SystemRequirements\QlikViewSAPConnector Further information to the installation you will find in the document : HCI_1.1\Documentation\Common\QlikView SAP Connector Manual.pdf In the second step, you will have to create the connection String to your SAP system and save it as hci/source/connectsap.txt called by the QlikView Server. Open the hci_sap.qvw document in edit script mode. Go to the Main tab. Select your QvSAPConnector in the field Database. Click Connect. Fill out the SAP login form. Click Test Connection Click OK if the test was successful. Date: April 23, 2015 Page 21 of 33

22 Date: April 23, 2015 Page 22 of 33

23 Cut the newly created connect string and save it in the file connectsap.txt. Save the document. Reload the data. 7.3 Deployment of the HCI document on the QlikView Server The prepared document has to be deployed on the QlikView server to get access to it from inside the HBC. The deployment is done by using the QlikView Management Console. Start the QlikView Management Console (found in the Start menu, under Programs > QlikView.) Select System -> Setup -> QlikView Servers -> your QlikView Server. Open the Folders tab. In the Root Folder field, enter the folder where the HCI document has been stored to. Click Apply. 7.4 Creation of Heiler Catalog Intelligence users Accessing Heiler Catalog Intelligence presumes that the user has access to the HCI document on the QlikView Server. To authorize a user to access the HCI document on the QlikView Server, perform the following steps: In the QlikView Management Console, open the Documents tab. Click User Documents. In the navigation tree, select the HCI document. Open the Authorization tab. Click. In the combobox User Type change the user type to Named Users. Click to add users you want to give access. In the Dialog Manage Users type the names of the users separated by semicolon into the textbox Manual Input of User Names. Date: April 23, 2015 Page 23 of 33

24 Note: The usernames entered correspond to the usernames used for login into the HBC Click OK to return to register Authorization. Date: April 23, 2015 Page 24 of 33

25 Click Apply to save the changes. 7.5 Registration of Heiler Catalog Intelligence users in the data access file To grant access to the HCI document for an HBC user the corresponding HBC user has to be added to the data access file dataaccess.xml. This document is located within the HCI installation, e.g. E:\Heiler\HCI\SOURCE. Within this XML-file the access type regarding what a user is able to see is defined. This approach is called section access. Implementing section access to the HCI document is not subject of this manual. Please refer to the corresponding documentation which describes the section access approach in combination with the HCI. Note: The first <element> entry within the data access file should always be a user with admin ACCESS and mapping to the NTNAME of the service user which has been used for installation of the QlikView components on the server. e.g. <element ACCESS="ADMIN" NTNAME="DOMAIN\user" ROLE="5" /> <?xml version="1.0"?> <dataaccess> <element ACCESS="ADMIN" NTNAME="IHEILER\svchlr-hsis1170" ROLE="3" /> <element ACCESS="USER" NTNAME="hbc_user" ROLE="3" /> </dataaccess> Perform the following steps to provide view access for an HBC user to the HCI document: Add a new <element> entry to the data access file (dataaccess.xml) ACCESS NTNAME ROLE Defines the access mode to the underlying HCI document, possible values are: ADMIN USER The username to whom access should be granted Internal role definition, used for managing different rights regarding the Designer/Non- Designer functionality. Possible values are: 3 = Must be used for Non-Designer users 5 = Must be used for users with Designer functionality After modifying the data access file you have to reload the document to make the changes take effect. This will be done the next time the document is reloaded by the QlikView Publisher for example described in chapter Configuration of the data refreshing Data refreshing is the process defining the actualization of the data in the HCI document. This is realized by configuring the document itself and defining a reload task in the QlikView Publisher. Date: April 23, 2015 Page 25 of 33

26 7.6.1 Configuration of the server side refreshing (QlikView Publisher) Perform the following steps to configure the QlikView Publisher for enabling the data refresh: In the Management Console, open the System tab. Click Setup. In the left navigation tree, select the publisher under Distribution Services. Open the General tab. In the Source Folders area use and enter the path to the folder containing the HCI document. Click Apply Configuration of the reload task Perform the following steps to automate the data refreshing on the publisher side: In the Management Console, open the Documents tab. Click Source Documents. In the navigation tree, select the HCI document. Click in the right panel to begin configuration of the task. Date: April 23, 2015 Page 26 of 33

27 Open the General tab. Check the Enabled check box to activate the task. Set the name of the task Open the Reload tab. Check the Enable check box in the Perform Reload section. Open the Triggers tab. Click to create a trigger for the task. In the Start the task drop-down list, select On a schedule. Select an appropriate radio button for the task. Click OK. Click Apply to save the task. As shown in the figure below, the task can be started/stopped manually. Date: April 23, 2015 Page 27 of 33

28 Note: Log files are written to: C:\Documents and Settings\All Users\QlikTech\DistributionService\1\Log. Each time the publisher task runs, a folder is created in this log folder. The folder is named with the current date. Underneath this folder another folder is created. The folder is named with the task name specified at configuration time. In this folder you will find the logfile Tasklog.txt. Date: April 23, 2015 Page 28 of 33

29 8 Configuration of the designer functionality The designer functionality, new in version 1.1, enables the end user to create own charts in the HCI document and to place them in the additional tab My charts. This is realized by configuring the server setting, by configuring the document itself and defining a user role in the dataaccess.xml. This will be explained in the next chapters Configuration of the server side (QlikView Server) Perform the following steps to configure the designer functionality on the sever side: In the Management Console, open the System and Setup tabs. In the navigation tree, select the QlikView Server. Open the Documents tab. Activate the setting Allow server objects. Click Apply Configuration of the client side (HCI document) Perform the following steps to configure the HCI document for the designer functionality: In the QlikView Developer, select Settings > Document Properties from the menu. This opens the Document Properties dialog. In the Document Properties dialog, open the Server tab. Activate the setting Allow Server Objects to enable the button QuickChart-Wizard in the document menu bar. Date: April 23, 2015 Page 29 of 33

30 8.1.3 Configuration of the user role (dataaccess.xml) Perform the following steps to give the user permission to see the additional tab My charts : In the dataaccess.xml set the ROLE of the corresponding user to 5 : <element ACCESS="USER" NTNAME="designerUserName" ROLE="5" /> Start the QlikView Developer. Open the HCI document. Run the HCI document script. Date: April 23, 2015 Page 30 of 33

31 9 Integration into Heiler Business Catalog The integration of HCI into the HBC is done by using the Heiler Service Integration Layer (SIL). The required SIL bundle and the corresponding property file is already part of the HBC standard installation. To finish the integration an additional configuration step has to be performed wherein the properties for the corresponding HCI bundle are adapted. 9.1 Configuration of the tab within the HBC To make the HCI available within the HBC an additional tab has to be configured in the administration area. This can be done in the HBC settings in the category Application Layout by adding the value HCI to the NavigationTabs setting. Please keep in mind that all HBC settings can be configured on global, organization or user level. 9.2 Configuration of the HCI bundle The property file where the configuration has to be adapted is called bundle.properties and is located within your HBC-OSGi installation. E.g. E:\Heiler\HBC_OSGI\bundleconfig\com.heiler.hbc.sil.hbc.hci To change the configuration you have to open the property file with a text editor for editing. bundleconfiguration.hciqvshost = bundleconfiguration.hcidocument = HCI.qvw bundleconfiguration.availablelanguages=7,9 bundleconfiguration.hciqvsport = 80 bundleconfiguration.hciwebservicehost = bundleconfiguration.hciwebserviceuser = hbcuser bundleconfiguration.hciwebservicepwd = heiler bundleconfiguration.hciwebserviceurl = /ticketwebservicesecure/service.asmx?wsdl Property name hciqvshost hcidocument availablelanguages hciqvsport hciwebservicehost Description The base URL of the QlikView server in the form The name of the HCI document, no change required as long as you don t rename the original HCI document. Coma separated list of language identifiers for the HCI document; with HCI1.1 there are only German/7 and English/9 suported The port where the IIS providing the ticketing webservice is listening The base URL of the server on which the HCI webservice is running Date: April 23, 2015 Page 31 of 33

32 in the form hciwebserviceuser hciwebservicepwd hciwebserviceurl The user allowed to request a ticket (this user is defined in the web.config file of the web service installed on the IIS, see chapter 5.1). The URL path of the WSDL file for the ticketing service After the property file has been modified it is required to reset eclipse configuration settings. Move to the folder <HBC_OSGI>eclipse\configuration. Remove all files and folders except file config.ini and restart the HBC service to make the changes take effect. 9.3 I18n of the HCI bundle HCI uses the same language identifiers as the HBC, e.g. 7 for German and 9 for English. HCI 1.1 is provided in English and in German. For all other not supported languages HCI is displayed in the default language. The default language is the language defined by the first language identifier defined in the property availablelanguages. 9.4 HBC help Note: Only relevant in case of HCI_SAP document installation. Help provided for HBC generally includes help for the HCI. To provide HBC help which includes help for the HCI_SAP document some folders have to be renamed. Move to the folder <HBC_HOME>\web\help. For each existing language locale you will find these subfolders representing help of all 3 installation variants of an HBC installation. ERP ERP_SAP SRM SRM_SAP STANDALONE_SAP The folder names containing _SAP include help for the HCI_SAP document. The others have included help for the HCI_Classic document. Please rename all folders to switch help. folder ERP rename to ERP_CLASSIC folder ERP_SAP rename to ERP folder SRM rename to SRM_CLASSIC foldersrm_sap rename to SRM folder ERP rename to ERP_CLASSIC foldererp_sap rename to ERP Proceed the same steps for all existing language locals. Date: April 23, 2015 Page 32 of 33

33 10 Integration into Heiler Catalog Manager The Heiler Catalog Manager part consists of a JAR-file and a configuration file. Dependent on the used HCM version the HCI price export functionality is activated by copying the content of the HCI_ _Classic\HCM\3.x\import\bin must be copied to the HCM_HOME where the HCM is running on. Then restart Heiler Catalog Manager s import supervisor service, import a new catalog and check the export overview for the price export after the import has been successfully completed. Executing the actualizing task on the site of QlikView-Publisher implies that the newly inserted prices will be transported to Heiler Catalog Intelligence. 11 Administration of HCI document variables Parts of HCI functionality are controlled by internal document variables which can be set initially from outside. These variables are stored in the file HCI_Variables.txt which will be directly integrated in load script of the reload task. At the top of the file you ll find settings which are obligatory to set. This is actual only vsearchlogfilepath vsearchlogfilepath It is recommended to adapt this setting to the fullpath folder where HBC stores search logfiles to get data for tab search behavior in HCI. Syntax: Example: SET vsearchlogfilepath='<hbc-home>log\' SET vsearchlogfilepath='d:\heiler\hbc\log\'; 12 Optional Removing of restore button in QlikView menu Due to QlikView menu bar problems with the button close/restore development has modified this file <QlikViewHome>\Server\QlikViewClients\QlikViewAjax\opendoc.htm. The reason for this is that after pressing restore button an error will occur with content no connection because session has been destroyed. This can not be fixed. The modification made hides the restore button and makes it non-functional. The close button is still available with his original functionality saving and closing document. Development advises to perform this modification. Rename original opendoc.htm to opendoc_original.htm. Copy the content of <HCI_ _Classic\HCI\QlikView to the destination folder defined above. Date: April 23, 2015 Page 33 of 33