heiler business catalog 7 - informatica...installation manual . heiler business catalog 7. 1 -...

Installation Manual

Heiler Business Catalog 7.1 -

Installation Manual

Heiler Software AG R&D - Research & Development Last changed: March 19, 2013

Installation Manual – Heiler Business Catalog 7.1

Date: March 19, 2013 of 34

Table of Contents

1 Objective .......................................................................................... 4

2 System Requirements ..................................................................... 4

3 Installation check list ...................................................................... 5

4 To be considered for updates ......................................................... 6

4.1 DB schema clean-up with the 7.0 db update .............................................................. 6 4.2 SQL Server 2005 migration ........................................................................................ 6 4.3 SQL Server 2008 migration ........................................................................................ 6 4.4 Update from versions earlier than 5.5 ........................................................................ 6 4.5 ActiveMQ no longer part of HBC installation .............................................................. 6

5 Preparing the destination system(s) .............................................. 7

5.1 Decide on which infrastructure the installation has to be done ................................... 7 5.1.1 Java SDK ............................................................................................................ 7

5.2 Linux OS .................................................................................................................... 8 5.2.1 Java SDK ............................................................................................................ 8

5.3 MS SQL Server .......................................................................................................... 9 5.4 Oracle ........................................................................................................................ 9

6 Setup of the Heiler Catalog Manager (HBC Staging Area) .......... 11

7 Preparation of the HBC Live System including HSE ................... 12

7.1 Overview of the installation .......................................................................................12 7.2 Create a temporary installation directory ...................................................................12 7.3 Configure the setup properties for the HBC ...............................................................12

7.3.1 Setup Properties - General Settings ...................................................................13 7.3.2 Setup Properties - Database Settings for MS SQL Server ..................................13 7.3.3 Setup Properties - Database Settings for Oracle ................................................13 7.3.4 Setup Properties – Heiler Business Catalog OSGi runtime ................................14 7.3.5 Setup Properties - Heiler Search Engine Settings ..............................................14 7.3.6 Setup Properties - Operating system settings ....................................................15 7.3.7 Setup Properties - Heiler Business Catalog Container Settings ..........................15 7.3.8 Setup Properties - Heiler Business Catalog Mail Settings ..................................15 7.3.9 Setup Properties - Heiler Business Catalog JMS ................................................16 7.3.10 Setup Properties - Heiler Business Catalog Scheduler Tasks ..........................16

7.4 Configure the setup properties for the HSE ...............................................................16 7.4.1 Setup Properties - General Settings ...................................................................17 7.4.2 Setup Properties - Database Settings for MS SQL Server ..................................17 7.4.3 Setup Properties - Database Settings for Oracle ................................................18



7.4.4 Setup Properties - Heiler Search Engine host and ports .....................................18 7.4.5 Setup Properties - Heiler Search Engine components ........................................19 7.4.6 Setup Properties - Heiler Search Engine Container Settings ..............................19 7.4.7 Setup Properties – Language settings ................................................................19 7.4.8 Setup Properties – Deployment and deployment type settings ...........................19 7.4.9 Setup Properties - Operating system settings ....................................................20

8 Setup of the HBC Live System and the Search Engine .............. 21

8.1 Install Heiler Business Catalog ..................................................................................21 8.1.1 Install Heiler Business Catalog database ...........................................................21

8.2 Install Heiler Business Catalog application ................................................................22 8.3 Install Heiler Search Engine database ......................................................................22 8.4 Install Heiler Search Engine application ....................................................................23 8.5 Install Heiler Search Engine language pack ..............................................................23

9 Post Installation Steps .................................................................. 25

9.1 Apache Tomcat configuration of the catalog images context path .............................25 9.2 Start the applications initially .....................................................................................25 9.3 Change "Admin" password........................................................................................27 9.4 Installing HBC and its components as services on Windows .....................................27 9.5 HBC/SAP integration (optional installation steps) 3rd party libraries ...........................27

10 Web-Server integration .............................................................. 28

10.1 MS Internet Information Server 7 (IIS) .......................................................................28 10.1.1 Setup and Configuration of the ISAPI Redirector ..............................................28 10.1.2 Configuring in IIS 7 ...........................................................................................28

10.2 Integrating Apache web server ..................................................................................32 10.2.1 Preparation ......................................................................................................32 10.2.2 mod_jk.conf ......................................................................................................32 10.2.3 workers.properties ............................................................................................32

11 Appendix A: Ports used by HBC and its components ............ 33

12 List of database tables from an installation prior to HSE2.0 .. 34



1 Objective

This document provides information on the installation of the Heiler Business Catalog 7.1 and its components on the supported platforms.

2 System Requirements

The system requirements are described in the separate document which will be made available on request.



3 Installation check list

Decide on the operating system (Windows or Linux), the database platform (e.g. MS SQL Server or Oracle) for which the software should be installed. Refer to the system requirements.

Decide on the infrastructure variant to be installed: Refer to the system requirements.

SQL-Server check / installation: Ensure Microsoft SQL Server incl. Client Tools is installed. Ensure collation and sort order of the MS SQL Server (Latin1_general, CS (case sensitive), AS (accent sensitive)). Create a dedicated SQL Server login. Refer to chapter 5.4 MS SQL Server starting on page 9.

Oracle check / install: Ensure the right version of Oracle and character set (AL16UTF16) used. Refer to chapter 5.5 Oracle starting on page 9.

If it is an update installation of a previous version please refer to the chapter 4 To be considered for updates on page 6 and read the topics there.

Prepare the database and application server(s) with the necessary system pre-conditions depending on the OS and DB platform. Refer to chapter 5 Preparing the destination system(s) starting from page 7.

Install the Heiler Catalog Manager – the Business Catalog’s staging area Refer to the installation manual of the Heiler Catalog Manager (HCM_3.3_Installation_en.pdf).

Install the Heiler Business Catalog live system database: Refer to chapter 8.1 Install Heiler Business Catalog database starting on page 11.

Install Heiler Search Engine (HSE) database schema: Refer to chapter 8.2 Install Heiler Search Engine database starting on page 22.

Install the Heiler Business Catalog live system application Refer to chapter 8.3 Install Heiler Business Catalog application starting on page 22.

Install the HBC-OSGi runtime Refer to chapter 8.4 Install HBC-OSGi runtime starting on page Fehler! Textmarke nicht definiert..

Install the Heiler Search Engine (HSE) application Refer to chapter 8.5 Install Heiler Search Engine application starting on page 22.

Have a look on the Post Installation Steps which are suitable for your installation. Refer to chapter 9 Post Installation Steps starting on page 25. □ Apache Tomcat configuration of the catalog images context path (page 25) □ Start the applications initially (page 25) □ Change "Admin" password (page 27) □ Installing HBC and its components as services on Windows (page 27) □ If optional SAP connectivity for stock information is needed refer to the

chapter 9.6 HBC/SAP integration (optional installation steps) starting on page 27. Web-Server integration of the applications:

Refer to chapter 10 Web-Server integration on page 28.



4 To be considered for updates

4.1 DB schema clean-up with the 7.0 db update The Heiler Business Catalog database setup updates the existing db schema automatically.

The update to version 7.1 database schema includes a clean-up script which deletes several obsolete tables and other database objects which are no longer needed for the standard functionality of Heiler Business Catalog 7.1.

Attention: This deletion is performed automatically using the script HBC_Drop_Obsolete_ Objects.sql. If you expect loss of data needed for custom functionality through this script (usually this db object should not be used), you should check this in detail before performing the update.

4.2 SQL Server 2005 migration Heiler Business Catalog requires SQL Server 2005 since Heiler Business Catalog Version 5.5.

To update a version earlier than 5.5 (running on SQL Server 2000) the databases have to be moved to SQL Server 2005 or higher platform first then the automated update to Heiler Business Catalog 5.6 has to be done by the setup.

4.3 SQL Server 2008 migration The migration from SQL Server 2005 to SQL Server 2008 does not require special procedures.

4.4 Update from versions earlier than 5.5 The Update from version earlier than 5.5 adds new permissions, e.g. for the administration of search index rebuilds. These new permissions have to be explicitly assigned to those users responsible for that functionality.

Log in as administrator of the organization HBC (Heiler Business Catalog), see chapter 9.3 Change "Admin" password on page 27. Only this administrator will see the new permissions and will be able to assign them to other users.

4.5 ActiveMQ no longer part of HBC installation Please note that the ActiveMQ message broker is not any longer part of the HBC installation. The ActiveMQ message broker will be part of the HCM installation.

Attention: It is important to remove/deactivate any ActiveMQ installation which is left from previous HBC/HSE installations.



5 Preparing the destination system(s)

The components marked (1) are real system requirements. Accordingly, they are not included in the supplied package, and their setup is not described in this documentation.

The installation packages mentioned in this topic, marked with (2) are supplied as additional system requirements with the software (or with a correspondingly modified version number and production date in the case of later versions of the product).

As well as the components marked (1), those marked (3) are also assumed to be already present on the target systems. However, some brief notes on their setup are included in the following chapters.

5.1 Decide on which infrastructure the installation has to be done First clarify the system environment it is intended to perform the system setup for. The required steps of system preparation are basically dependent on this:

Decide on the operating system for which the software should be installed: Windows or Linux; only 64 bit OS is supported? Refer to the system requirements.

Decide on the database platform for which the software should be installed: MS SQL Server or Oracle? Refer to the system requirements.

Decide on the infrastructure variant to be installed: All applications on one machine; System with separate Staging Area/Import; Multi-Server system HBC? Refer to the system requirements.

5.1.1 Java SDK The Java SDK has to be installed on all servers where the Heiler Business Catalog application or parts of it (e.g. the HBC Executor Service), the Heiler Search Engine (HSE) or parts of it, the Heiler Catalog Manager (the Staging Area of the Business Catalog) or ActiveMQ will be installed and operated later. Due the setup is also Java based all machines on which any part of the setup has to be performed need the Java SDK to be installed.

Java SDK 1.7.0_x is installed by calling the jdk-7uX-windows-x64.exe (2) setup.

Recommendation: As for the subsequent setup of HBC – a target directory should be set up where all Java based system requirement software has to be installed. This directory will be referred in the rest of the manual as Java Root, we recommend:

x:/Heiler/Java (where "x" stands for any drive)

Following settings have to be considered:

Deselect demos/source Select installation directory: <Java Root>/jdk1.7.0_X Deselect browser registration

Hint: After installation it is recommended to reboot the system once even if the installation does not force this explicitly.



Recommendation: For the following setups it makes life easier to create a system environment variable named JAVA_HOME with the value <Java Root>/jdk1.7.0_X - the path pointing to your Java installation directory.

5.2 Linux OS

5.2.1 Java SDK The Java SDK has to be installed on all servers where the Heiler Business Catalog application or parts of it (e.g. the HBC Executor Service), the Heiler Search Engine (HSE) or parts of it or the Heiler Catalog Manager (the Staging Area of the Business Catalog) will be installed and operated later. Due the setup is also Java based all machines on which any part of the setup has to be performed need the Java SDK to be installed.

Java SDK 1.7.0_x is installed by calling the jdk-7uX-linux-x64.bin setup.

Follow the setup instructions.



5.3 MS SQL Server The following system requirements must be met in order to run the Heiler Business Catalog and its components with MS SQL Server (refer to system requirements). When installing Microsoft SQL Server, the following settings must be considered:

For Server Collation use Latin1_General additionally Case sensitive and Accent sensitive must be selected (Latin1_General_CS_AS).

To setup and access the SQL Server databases the applications should use an own SQL Server login (e. g. hbcaccess).

All applications (Heiler Business Catalog, Heiler Catalog Manager, the Heiler Search Engine and all their components) have to share the same SQL Server login.

Important: The login used for the installation of the databases will be used later for runtime access. During installation the login needs the server role dbcreator. This can be removed after installation but it might be needed again for future maintenance updates of the databases. At runtime of applications the server role public is sufficient for that login’s permissions.

Attention: It has to be ensured that the SQL Server Client Tools are installed on the application server(s) to access database.

Due to temporarily needed disk space for large growing TEMPDB (e.g. while importing data) we recommend moving the TEMPDB to a disk with enough space and separating it from other data files. How to move TEMPDB on MS SQL Server? See the following lines of SQL script. Change the sample path “E:\...” to your environment conditions. After running the script, restart SQL Server: USE master go

ALTER DATABASE tempdb MODIFY FILE (NAME = tempdev, FILENAME = 'E:\tempdb.mdf') go

ALTER DATABASE tempdb MODIFY FILE (NAME = templog, FILENAME = 'E:\templog.ldf') go

Under specific circumstances; e.g. using a VM where the SQL Server is already installed, copying the VM and changing the machine’s name the SQL Server keeps his old server name in the background.

This leads to malfunctions mostly found when trying to access an item list or another report in the Heiler Business Catalog’s staging area the first time. Check the server name and rename if needed. Use the following SQL statements using the SQL Server Management Studio. Restart the SQL Server after this operation. With the following statement the current server name (<old_name>) is shown:

print @@servername

The server name of the SQL Server (<new_name>) should be the same as the machines name.

With the following statements the server name can be changed:

sp_dropserver <old_name>

go

sp_addserver <new_name>, 'local'

go

5.4 Oracle The following system requirements must be met in order to run the Heiler Business Catalog and its components with Oracle (refer to system requirements).



An ORACLE Standard Edition is basically needed for the correct operation of the application. Even the application can also be run with the Enterprise Edition.

Important: For purposes of creating the actual database type General Purpose can be selected, and AL16UTF16 must be selected as the character set.

The ORACLE database is installed using the ORACLE Database Configuration Assistant or the ORACLE Universal Installer.

The application-specific contents of the database (table spaces, schemas, users, tables etc.) are generated later using appropriate scripts during the setup(s).

Oracle Client The Oracle Client Tools are needed for the application's runtime on the machine on which the import is running.

Important: The Client Tools have to match the database version installed.

In general it is advisable to install a full ORACLE client, but at least the following components are indispensable for setup, administration and operation:

sqlplus (setup and administration) sqlldr (import) JDBC (driver, generally needed). To ensure correct database access, the configuration file .\network\admin\tnsnames.ora and any other files (e. g. sqlnet.ora) must have been correctly configured in the Oracle setup directory.

The database setup uses Easy Connect Naming Method, so check the sqlnet.ora for setting EZCONNECT: NAMES.DIRECTORY_PATH = (TNSNAMES, EZCONNECT)

The following environment variables must be set to ensure that the init scripts are imported properly: NLS_LANG = AMERICAN_AMERICA.UTF8

Note: If this value is not set the application’s database setup can’t be performed. The value (AMERICAN_AMERICA.UTF8) is obligate. The second part specifies the format of the scripts that are to be imported, and must therefore be UTF8. If this setting is missing or incorrect (not *.UTF8), the database may not be initialized properly, particularly with regard to German umlauts or other special characters.

Please note that starting with Oracle 11g the auditing feature of the database is enabled by default. The content of the Table AUD$ will not be flushed automatically. This table is used for storing the auditing information and as this table is part of the SYSTEM tablespace this tablespace will start growing on. If the auditing feature will be kept activated the DBA has to ensure that this table will be flushed from time to time to prevent an overflow of the SYSTEM tablespace.

For further information, please refer to the Oracle documentation.



6 Setup of the Heiler Catalog Manager (HBC Staging Area)

The Staging Area of the Heiler Business Catalog is represented by an additional software product of Heiler the Heiler Catalog Manager.

More details on the installation of the Catalog Manager you can find in its own installation manual which is provided as a separate document.

This is currently named HCM_3.3_Installation_en.pdf but this might change with growing version numbers of the Catalog Manager. The matching version of the Catalog Manager for a specific version of Business Catalog will be provided with the release notes accompany the certain release.

Follow the instructions of chapter Setup of Heiler Catalog Manager in that documentation mainly but consider the chapters of introduction and preparation also carefully there.



7 Preparation of the HBC Live System including HSE

7.1 Overview of the installation The entire installation consists of five steps, which are described in the following chapters.

Create temporary installation directory and extract the installation packages there Configure the setup properties which are used for all following setup steps Install the Heiler Business Catalog database Install the Heiler Business Catalog application Install the Heiler Search Engine database (or add the schema to HBC database) Install the Heiler Search Engine

7.2 Create a temporary installation directory The installation directory contains the software that is to be installed.

Create a temporary installation directory (e.g. " /heiler/install") on the installation drive of the server system prepared according to the descriptions above.

Copy and extract the following installation packages to this directory:

Heiler Business Catalog installation package: HBC_X.X.xx.xx.zip Heiler Search Engine installation package: HSE_X.X.xx.xx.zip Plus additional language packs:

Dependent on the languages desired to install, e.g. HBC_X.X.xx.xx_en_US.zip

7.3 Configure the setup properties for the HBC A template of the setup properties file is located in the "\setup" sup-directory in each of the HBC installation packages.

The file is named hbc-setup.template.properties. If you want to use a text editor to edit the setup properties copy and rename it to hbc-setup.properties.

The setup properties are arranged in 5 sections which are described in the following chapters.

Hint: All path values have to use "/" as path separators independent on the OS the setup is performed. An exception on this rule is the path for the MS SQL Server database file location (db.mssql.home), where the "\\" has to be used necessarily. Trailing slashes at the end of a path are not needed generally!



7.3.1 Setup Properties - General Settings Dependent on this decision the settings for MS SQL Server (chap. 7.3.2 Setup Properties - Database Settings for MS SQL Server) or Oracle (chap. 7.3.3 Setup Properties - Database Settings for Oracle) have to be filled.

Parameter Value

hbc.home The home directory where the HBC will be installed to.

db.type The database system the application’s database will be installed on. Dependent on the type defined one of the two following database sections for MS SQL Server or Oracle have to be filled out. Values: SQLSERVER or ORACLE

db.hcm.check Check if the HCM databases that are configured really exist

7.3.2 Setup Properties - Database Settings for MS SQL Server This section has to be filled only if you intend to install a MS SQL Server based system and have set the db.type=SQLSERVER above.

Parameter Value

db.mssql.home The directory path where the database files should be stored. Value e.g.: D:\\Heiler\\HBC_DB Attention: This path is a local path on the database server. This path must use "\\" as path separator.

db.mssql.server The db server name

db.mssql.instance The db server instance name. Optionally, only if db instance is used otherwise keep this property empty.

db.mssql.user db.mssql.password

The db user and password used for installation and later for operation as well.

db.mssql.hbc.name The name of the Heiler Business Catalog database. Value e.g.: HBC

db.mssql.hcm.main.name The name of the Heiler Content Manager main database. Value e.g.: HCM_MAIN

db.mssql.hcm.supplier.name The name of the Heiler Content Manager supplier database. Value e.g.: HCM_SUPPLIER

db.mssql.hcm.um.name The name of the Heiler Content Manager user management database. Value e.g.: HCM_UM

7.3.3 Setup Properties - Database Settings for Oracle This section has to be filled only if you intend to install an Oracle based system and have set the db.type=ORACLE above.

Parameter Value

db.oracle.home The directory path pointing to the oracle directory: Value e.g.: D:/oracle/product/11.1.0/db_1 or the Oracle client directory: Value e.g.: C:/oracle/product/11.1.0/client_1



db.oracle.host The server name nosting the Oracle. Value e.g.: localhost

db.oracle.port The port used for communication with the Oracle. Default: 1521

db.oracle.sid The Oracle SID to be used. Value e.g.: HBC

db.oracle.service The service name

db.oracle.system.password The password of the user "system" which is used for installation. Value e.g.: heiler

db.oracle.hbc.dbfpath The path for the files for the HBC tablespaces. Attention: This is a local path on the database server in case of a remote setup. This path has to exist already! Value e.g.: D:/oracle/oradata/hbc

db.oracle.hbc.name db.oracle.hbc.password

The database user and password for the Heiler Business Catalog. Values e.g.: HBC, heiler

db.oracle.hcm.main.name db.oracle.hcm.main.password db.oracle.hcm.supplier.name db.oracle.hcm.supplier.password db.oracle.hcm.um.name db.oracle.hcm.um.password db.oracle.hcm.bmetemp.name db.oracle.hcm.bmetemp.password db.oracle.hcm.repstore.name db.oracle.hcm.repstore.password

HCM_MAIN heiler HCM_ SUPPLIER heiler HCM_ UM heiler BMECATTEMP heiler HCM_ REPSTORE heiler

The database users and passwords used by the Heiler Content Manager – the Staging Area of Heiler Business Catalog.

7.3.4 Setup Properties – Heiler Business Catalog OSGi runtime

Parameter Value

hbc.osgi.home The HBC OSGi runtime home directory. This is the path the OSGi runtime will be installed and performed later. Usally a local path on the machine the setup is performed. Value e.g.: D:/heiler/hbc-osgi

hbc.osgi.install.demobundles If set to 1 the SIL demo bundles will also be installed. The default value is 0.

7.3.5 Setup Properties - Heiler Search Engine Settings

Parameter Value

hse.admin.host The Heiler Search Engine’s host where the HSE admin component is deployed. Value e.g.: localhost (when running on the same machine as Heiler Business Catalog)

hse.admin.port Port to be used for http based communication between Heiler Business Catalog and the HSE admin component. Recommended default: 18081 *

hse.indexer.host The Heiler Search Engine’s host where the HSE indexer component is deployed. Value e.g.: localhost (when running on the same machine as Heiler Business Catalog)

hse.indexer.port Port to be used for http based communication between Heiler Business Catalog and the HSE indexer component. Recommended default: 18081 *



Parameter Value

hse. solr.host The Heiler Search Engine’s host where the HSE solr component is deployed. Value e.g.: localhost (when running on the same machine as Heiler Business Catalog)

hse. solr.port Port to be used for http based communication between Heiler Business Catalog and the HSE solr component. Recommended default: 18081 *

* Please ensure that there will be no overlapping with the Heiler Catalog Manager Staging Area, Heiler Business Catalog or other applications’ ports. The default ports of the staging area application are above 20000 (see 11 Appendix A: Ports used by HBC and its components).

7.3.6 Setup Properties - Operating system settings

Parameter Value

operating.system The operating system the HBC is running on. Dependent on the type different file operations will be performed. Values: windows-x64 or linux-x64

7.3.7 Setup Properties - Heiler Business Catalog Container Settings Normally no modifications are required in this section.

Parameter Value

container.version No modifications are required

container.name No modifications are required

container.home No modifications are required

container.service.name The name of the windows service if installed as service

container.service.displayname The display name of the service if installed as service

container.service.description No modifications are required

container.service.initmemory Defines the initially memory size in MB for the service, default value is 1024

container.service.maxmemory Defines the maximal memory size in MB for the service, default value is 1024

container.http.port container.ajp13connector.port container.shutdown.port container.redirect.port

Port to be used for http requests. Recommended default: 18080 * Port used for AJP 1.3 Connector. Recommende default: 18009 * Port to be used for container shutdown. Recommended default: 18015 * Port to be used for redirect. Recommended default: 18443 *

container.admin.user.name container.admin.user.password container.log.dir

tomcat - Default user for the server manager heiler- Default password for the server manager – IMPORTANT: change it! Direcotry used for logfiles

executor.service.name The name of the windows service of the executor if installed as service

hibernate.cache.use_second_ level_cache

Defines the use of the Hibernate second level cache Recommended default: true

* Please ensure that there will be no overlapping with the Heiler Catalog Manager Staging Area, Heiler Search Engine or other applications’ ports. The default ports of the staging area application all are above 20000 (see 11 Appendix A: Ports used by HBC and its components).

7.3.8 Setup Properties - Heiler Business Catalog Mail Settings

Parameter Value

server.url This setting holds the server url which is used for creating hyperlinks within



emails

mail.smtp.host The hostname of the smtp server

mail.smtp.authenticationNeeded Authentication for the above smtp server required? [false|true]

mail.smtp.user The usernam if authentication for the above smtp server is required

mail.smtp.password The password if authentication for the above smtp server is required

mail.order.activated Activate emails for orders [false|true]

userRegistrationMailFrom The email address of the sender which is used with the registration form

userResetPasswordMailFrom The email address of the sender which is used with the reset password form

infoUser.mail.from The email address of the sender which is used with the info user functionality

productInquiryMailFrom The email address of the sender which is used with the product inquiry functionality

7.3.9 Setup Properties - Heiler Business Catalog JMS

Parameter Value

activemq.host The hostname where the JMS message broker is running on

activemq.port The port on which the JMS message broker is listening on

activemq.user The username used for authentication with the JMS message broker

activemq.password The password used for authentication with the JMS message broker

7.3.10 Setup Properties - Heiler Business Catalog Scheduler Tasks

Parameter Value

scheduler.tasks.enabled Defines if the scheduler tasks required for the guest login, reset password token cleanup are acitve on this instance. [1|0] Note that only one instance should have activated the tasks if running in a multi server scenario.

7.4 Configure the setup properties for the HSE A template of the setup properties file is located in the "\setup" sup-directory in each of the HSE installation packages.

The file is named hse-setup.template.properties. If you want to use a text editor to edit the setup properties copy and rename it to hse-setup.properties.

The setup properties are arranged in 5 sections which are described in the following chapters.

Hint: All path values have to use "/" as path separators independent on the OS the setup is performed. An exception on this rule is the path for the MS SQL Server database file location (db.mssql.home), where the "\\" has to be used necessarily. Trailing slashes at the end of a path are not needed generally!



7.4.1 Setup Properties - General Settings

Parameter Value

hse.home The home directory where the HSE will be installed to.

db.type The database system the application’s database will be installed on. Dependent on the type defined one of the two following database sections for MS SQL Server or Oracle have to be filled out. Values: SQLSERVER or ORACLE

db.same.settings.for.hbc.datasource The value defines if the database settings entered for the HSE datasource should be used for the datasource to the HBC Values: 1 = same settings as for HSE 0 = separate settings for HBC (default setting)

7.4.2 Setup Properties - Database Settings for MS SQL Server This section has to be filled only if you intend to install a MS SQL Server based system and have set the db.type=SQLSERVER above.

Parameter Value

db.hse.mssql.home The directory path where the database files should be stored. Value e.g.: D:\\Heiler\\HBC_DB Attention: This path is a local path on the database server. This path must use "\\" as path separator.

db.hse.mssql.server The db server name

db.hse.mssql.port The db server port

db.hse.mssql.instance The db server instance name. Optionally, only if db instance is used otherwise keep this property empty.

db.hse.mssql.user db.hse.mssql.password

The db user and password used for installation and later for operation as well.

db.hse.mssql.name The name of the Heiler Search Engine database. Value e.g.: HSE

The following settings are only used if db.same.settings.for.hbc.datasource=0

db.hbc.mssql.server The db server name

db.hbc.mssql.port The db server port

db.hbc.mssql.instance The db server instance name. Optionally, only if db instance is used otherwise keep this property empty.

db.hbc.mssql.user db.hbc.mssql.password

The db user and password used for operation.

db.hbc.mssql.name The name of the Heiler Business Catalog database. Value e.g.: HBC



7.4.3 Setup Properties - Database Settings for Oracle This section has to be filled only if you intend to install an Oracle based system and have set the db.type=ORACLE above.

Parameter Value

db.hse.oracle.home The directory path pointing to the oracle directory: Value e.g.: D:/oracle/product/11.1.0/db_1 or the Oracle client directory: Value e.g.: C:/oracle/product/11.1.0/client_1

db.hse.oracle.dbfpath The path for the files for the HSE tablespaces. Attention: This is a local path on the database server in case of a remote setup. This path has to exist already! Value e.g.: D:/oracle/oradata/hbc

db.hse.oracle.server.host The server name nosting the Oracle. Value e.g.: localhost

db.hse.oracle.server.port The port used for communication with the Oracle. Default: 1521

db.hse.oracle.server.sid The oracle SID

db.hse.oracle.server.service The name of the service

db.hse.oracle.system.password The password of the user "system" which is used for installation. Value e.g.: heiler

db.hse.oracle.live.user db.hse.oracle.live.password

The database user and password for the Heiler Search Engine. Values e.g.: HSE, heilerhse, …

The following settings are only used if db.same.settings.for.hbc.datasource=0

db.hbc.oracle.server.host The server name nosting the Oracle. Value e.g.: localhost

db.hbc.oracle.server.port The port used for communication with the Oracle. Default: 1521

db.hbc.oracle.server.sid The oracle SID

db.hbc.oracle.server.service The name of the service

db.hbc.oracle.live.user db.hbc.oracle.live.password

The database user and password for the Heiler Business Catalog. Values e.g.: HBC, heiler

db.hbc.oracle.system.password The password of the user "system" which is used for installation. Value e.g.: heiler

7.4.4 Setup Properties - Heiler Search Engine host and ports

Parameter Value

hse.admin.host The Heiler Search Engine’s host where the HSE admin component is deployed. Value e.g.: localhost (when running on the same machine as Heiler Business Catalog)

hse.admin.port Port to be used for http based communication between Heiler Business Catalog and the HSE admin component. Recommended default: 18081 *

hse.admin.jmx.port The port of the jmx mbean server, used for debugging/management purposes

hse.indexer.host The Heiler Search Engine’s host where the HSE indexer component is deployed. Value e.g.: localhost (when running on the same machine as Heiler Business Catalog)



Parameter Value

hse.indexer.port Port to be used for http based communication between Heiler Business Catalog and the HSE indexer component. Recommended default: 18081 *

hse.solr.host The Heiler Search Engine’s host where the HSE solr component is deployed. Value e.g.: localhost (when running on the same machine as Heiler Business Catalog)

hse.solr.port Port to be used for http based communication between Heiler Business Catalog and the HSE solr component. Recommended default: 18081 *

7.4.5 Setup Properties - Heiler Search Engine components

Parameter Value

hse.install.admin Defines if the HSE admin component will be installed, defaults to 1

hse.install.indexer Defines if the HSE indexer component will be installed, defaults to 1

hse.install.solr Defines if the HSE solr component will be installed, defaults to 1

7.4.6 Setup Properties - Heiler Search Engine Container Settings

Parameter Value

container.name Doesn’t have to be changed

container.home Doesn’t have to be changed

container.http.port container.ajp13connector.port container.shutdown.port

Port to be used for http requests. Recommended default: 18081 * Port used for AJP 1.3 Connector. Recommende default: 18010 * Port to be used for container shutdown. Recommended default: 18005 *

container.admin.user.name container.admin.user.password container.log.dir

tomcat - Default user for the server manager heiler- Default password for the server manager – IMPORTANT: change it! Direcotory used for logfiles

* Please ensure that there will be no overlapping with the Heiler Catalog Manager Staging Area, Heiler Business Catalog or other applications’ ports. The default ports of the staging area application all are above 20000 (see 11 Appendix A: Ports used by HBC and its components).

7.4.7 Setup Properties – Language settings

Parameter Value

hse.languages The language configurations that will be installed by the main intsallation. Default: de_DE,en_US

7.4.8 Setup Properties – Deployment and deployment type settings

Parameter Value

solr.home solr.war.name

Doesn’t have to be changed at all.

solr.nodetype Defines the type of Solr instance installation. Default: singleserver Possible values: singleserver| masterserver| slaveserver For more information take a look at the Heiler Wiki, also for sharding installations.



solr.master.host solr.master.port

Host and port of the master Solr server, only used if installing a slave server

7.4.9 Setup Properties - Operating system settings

Parameter Value

operating.system The operating system the HSE is running on. Dependent on the type the corresponding preconfigured container is used. Values: windows-x64 or linux-x64



8 Setup of the HBC Live System and the Search Engine

8.1 Install Heiler Business Catalog Starting with the release 7.1 of the HBC the setup routine has been optimized. There is only one batch/shell script left which can be used for installing all (database/application/osgi) in one or installing the components in separate steps. The manual describes the approach of installing in single steps. For an overview of the possible parameters the new setup accepts you can go to the subfolder "\setup" and get an overview by opening a command window and entering setup. The result will be an overview of the possible parameters.

8.1.1 Install Heiler Business Catalog database Perform the following steps on Windows:

Go to the subfolder "\setup" Ensure that all necessary information for the setup is present in the hbc-setup.properties

file located in the directory "\setup" (see chapter 7.3 Configure the setup properties for the HBC starting on page 12).

Open a command window, type setup.cmd DB and press enter



Hint: If JAVA_HOME is set as a system environment variable setup.cmd can be started as described above. If it is not defined the path has to be passed as a parameter when calling the cmd-file (e.g. setup.cmd DB c:\Heiler\Java\jdk1.7.0_X).

Perform the following steps on Linux:

Go to the subfolder "/setup" Set the file permissions of the shell script "setup.sh" to user executable (chmod 744

setup.sh) Start the installation by executing the shell script; don’t forget to provide the path to your

java installation as paramter (sh setup.sh DB /path/to/java)

Hint: Log files on the database scripts performed during setup can be found in the subdirectory /setup/temp of the installation package. The log files of the update scripts are stored together with the update scripts itself in /data/jpbc/db/mssql/schema/update (for MS SQL Server) or /data/jpbc/db/oracle/schema/update (for Oracle).

8.2 Install Heiler Business Catalog application The installation of the application now also includes the installation of the OSGi SIL part.

Perform the following steps on Windows:

Go to the subfolder "\setup" Ensure that all necessary information for the setup is present in the hbc-setup.properties

file located in the directory "\setup" (see chapter 7.3 Configure the setup Properties starting on page 12).

Open a command window, type setup.cmd App OSGi and press

Hint: If JAVA_HOME is set as a system environment variable setup.cmd can be started as described above. If it is not defined the path has to be passed as a parameter when calling the cmd-file (e.g. setup.cmd App OSGi c:\Heiler\Java\jdk1.7.0_X).




java installation as parameter (sh setup.sh App OSGi /path/to/java)

Important: The installation should be performed with the same user that is uses later on for running the applications as service. Otherwise the linux startscripts have to be adjusted manually.

8.3 Install Heiler Search Engine database

Important: An upgrade of an existing system with a version earlier than HSE 2.0 is not supported. So if you are doing an upgrade you have two options, execute the database setup for the HSE to a different database than the old installation is pointing to, or remove the



HSE1.x tables from the existing database (see chapter 12) and perform the database setup to the existing database afterwards.

Perform the following steps on Windows:

Go to the subfolder "\setup" of the HSE package Ensure that all necessary information for the setup is present in the hse-setup.properties

file located in the directory "\setup" (see chapter 7.4 16Configure the setup properties for the HSE).

Open a command window, type "setup.cmd DB" and press enter

Hint: If JAVA_HOME is set as a system environment variable setup.cmd can be started as described above. If it is not defined the path has to be passed as a parameter when calling the cmd-file (e.g. setup.cmd DB c:\Heiler\Java\jdk1.7.0_X).




java installation as parameter (sh setup.sh DB /path/to/java)

Hint: Log files on the database scripts performed during setup can be found in the subdirectory /setup/temp of the installation package.

8.4 Install Heiler Search Engine application Perform the following steps on Windows:

Go to the subfolder "\setup" Ensure that all necessary information for the setup is present in the hse-

setup.properties file located in the directory "\setup" (see chapter 7.4 16Configure the setup properties for the HSE).

Open a command window, type setup.cmd App and press enter

Hint: If JAVA_HOME is set as a system environment variable setup.cmd can be started as described above. If it is not defined the path has to be passed as a parameter when calling the cmd-file (e.g. setup.cmd App c:\Heiler\Java\jdk1.7.0_X).


Go to the subfolder "/setup" Set the file permissions of the shell script "setup.sh" to executable (chmod 744


java installation as parameter (sh setup.sh App /path/to/java)

8.5 Install Heiler Search Engine language pack The installation of a HSE language pack can be performed with the following steps:



Ensure a properly installed HSE which regularly contains the de_DE and en_US languages already

The HSE servlet container has to be shut down during installation Unzip the content of the language pack to a temporary folder Copy the hse-setup.properties file from the original HSE installation to this

unzipped folder or create a hse-setup.properties file with appropriate configuration execute the setupHSELanguagePack.cmd (Windows) or the respective .sh (Linux)

batch file and check the output of the installer Restart the HSE The successful installation can be validated with the following steps: Import a catalog with an appropriate language, release it and rebuild the search index,

search through it using the HBC Open the solr management console available at http://hserservername:18081/solr with

the browser and check that the core for the installed language exists

It is possible to merge the data folder of the language pack into the basic HSE installation pack. (Not the setup folder!) The setup.cmd App will respect the languages included within the language packs, if they are included into the hse.languages property of the hse-setup.properties file.

(The language.properties file of the language packs does take an important role to specify which language is going to be installed. If this file is present it will override the hse.languages key within the default hse-setup.properties to the single one language of the language pack. For merging this file has to be excluded therefore, to allow specifying the language within the hse-setup.properties again)

http://hserservername:18081/solr



9 Post Installation Steps

9.1 Apache Tomcat configuration of the catalog images context path This additional configuration is needed if the item images should be displayed by accessing the Heiler Business Catalog through Apache Tomcat directly, not using a Web-Server (IIS, Apache).

The URL context path "/JPBC/image" which is placed before each image reference has to be mapped to the physical directory where the images are located.

The configuration file at <HBC_home>/apache-tomcat-7.0.XX/conf/server.xml contains a commented configuration at line 129.

Remove the comment and adapt the physical path at the attribute "docBase". <Context path="/JPBC/image" docBase="c:/Heiler/CatalogImages" debug="0" />

This configuration is optional. If Web-Server-Integration will be done (see chapter 10 Web-Server integration starting on page 28) the images are accessed through the Web-Server and this configuration is not needed.

For productive systems it is recommended to use a Web-Server for the access of static contents like images.

9.2 Start the applications initially Start Heiler Business Catalog Apache Tomcat by calling the <hbc_home>/apache-tomcat-7.0.XX/ start_HBC_tomcat.cmd (Windows) or <hbc_home>/apache-tomcat-7.0.XX/ start_HBC_tomcat.sh (Linux).

Start the HSE Tomcat by calling <hse_home>/server/apache-tomcat-7.0.XX/ start_HSE_tomcat.cmd (Windows) or <hse_home>/server/apache-tomcat-7.0.XX/ start_HSE_tomcat.sh (Linux).

Start the HBC Executor by calling <hbc_home>/hbc_executor/HBCExecutor.cmd (Windows) or <hbc_home>/hbc_executor/HBCExecutor.sh (Linux).

Watch the console windows carefully if any errors or exception occur while start-up of the applications.

To start the Heiler Catalog Manager – the staging area application and the data import initially please refer to the installation manual of Heiler Catalog Manager.

After all applications have successfully started open your browser. For a default installation the URL to access the Heiler Business Catalog’s login page

http://<your_server>:18080/JPBC/index.jsp.

Log in to the Heiler Business Catalog the first time using the standard admin user and password for the organization “hbc”:

User name Password Organization

admin pbc hbc

You can determine the proper work of the Heiler Search Engine installation by accessing the URL http://<your_server>:18081/manager/html/list with your browser. As this page is



protected you have to provide user and password data to access this page. The default username/password is [tomcat/heiler]. These defaults can be adapted within the apache tomcat configuration. For further information please see the configuration file tomcat-users.xml at the conf directory of your apache tomcat installation.

The result page lists all deployed web applications and their state. If all HSE components are listed and their state is running the HSE installation succeeded.



9.3 Change "Admin" password After having started the application and logged in as Admin the default password of the administrator user should be change immediately.

Important: Due this default password is well known by everybody have had contact with a Heiler Business Catalog in the past it is important to change the password.

Please ensure to remember the new password for future needs.

To change the password, perform the following steps:

Open "Administration > Users". Select the organization “Heiler Business Catalog”. Click on the user named “Admin” in the table of users shown on the right. Change the password by typing in new password twice. Save the changes by clicking on the "Save" button in the right upper corner.

9.4 Installing HBC and its components as services on Windows After initial tests of the application succeeded, Heiler Business Catalog application and the HBC executor as well as the Heiler Search Engine should run as Windows services instead of running as console applications.

The windows services can be installed by the following steps:

Install HBC Tomcat as a Windows service by running start_HBC_tomcat.cmd -i within the folder <hbc_home>/apache-tomcat-7.0.XX.

Install the HBC Executor as a Windows service by running InstallHBCExecutor-NT.bat within the folder <hbc_home>/wrapper/bin.

Install HSE Tomcat as a Windows service by running service.bat install HSE within the folder <hse_home>/server/apache-tomcat-7.0.XX/bin

After the installation of the services is done go to the Windows services administration. Start and configure the services there.

9.5 HBC/SAP integration (optional installation steps) 3rd party libraries Heiler Business Catalog can be configured for showing SAP stock information or using smart form items.

The SIL bundle “SIL Matinfo SAP RFC” provides access to a SAP backend for getting stock information on item level. The configuration of SAP connectivity for SAP stock information is described in the separate manual "Service Integration Layer (SIL) – Matinfo SAP RFC".

The SIL bundle “SIL SAP Server Functions Standard” registers a JCoServerFunctionHandler for editing Smartform items through a connected backend system. The configuration of smart form service is described in the separate manual "Service Integration Layer (SIL) – SAP Server Functions Standard".

Important: Due to license restrictions the 3rd party libraries required for integration with SAP JCo and SAP Portal SSO are not part of the installation package any longer. The required 3rd party libraries have to be downloaded at the corresponding vendor download site and installed into the HBC tomcat lib folder. The versions of the required 3rd party libraries can be found in the system requirements in the Heiler wiki.



10 Web-Server integration

This chapter describes the integration of the applications (Heiler Business Catalog Live System and Heiler Business Catalog Staging Area) into IIS (Windows) or Apache (Linux) web server.

10.1 MS Internet Information Server 7 (IIS) The IIS is integrated by installing a proxy plugin for the redirect of the dynamic contents.

Note: Some Windows server systems have very restrictive security settings. It is necessary that all JPBC-directories that will be accessed by the IIS have the access-permissions read “Everyone” in the file-system.

10.1.1 Setup and Configuration of the ISAPI Redirector With the additional system requirements a package named HBC_X.X.xx.xx_isapi-redirector_64bit.zip is provided. It contains all necessary files to setup and configure the IISAPI redirection. These are:

isapi_redirect-1.2.30_amd64.dll

isapi_redirect-1.2.30_amd64.properties

workers.properties

uriworkermap.properties

First these files have to be copied to their final location, it is recommended to use a path under the installation path <dest.root>\iis (e. g. D:\Heiler\iis). Perform the following step to prepare and configure the redirector:

Create a new directory under the applications installation root (e.g. D:\Heiler\iis). Copy all files of the iisapi redirector package to this directory Open the file isapi_redirect-1.2.30_amd64.properties and adapt the paths to the

application installation root. # Configuration file for the Jakarta ISAPI Redirector

# The path to the ISAPI Redirector Extension, relative to the website

# This must be in a virtual directory with execute privileges

extension_uri=/jakarta/isapi_redirect-1.2.30_amd64.dll

# Full path to the log file for the ISAPI Redirector

log_file=C:\heiler\iis\isapi_redirect.log

# Log level (debug, info, warn, error or trace)

log_level=info

# Full path to the workers.properties file

worker_file=C:\heiler\iis\workers.properties

# Full path to the uriworkermap.properties file

worker_mount_file=C:\heiler\iis\uriworkermap.properties

10.1.2 Configuring in IIS 7 Open "Start > Administrative Tools > Server Manager > Roles > Web Server (IIS)" and

add the roles ISAPI Extensions and ISAPI Filters.



In IIS, activate the Default Web Site by clicking on the "Play" button. Below the "Default Web Site" select "ISAPI Filters" and add the file isapi_redirect-

1.2.30_win32.dll resp. isapi-redirect-1.2.30_amd64.dll.

Below the "Default Web Site" select "Handler Mappings" and enabled the ISAPI-dll via

"Edit Feature Permissions". Rights must be given for Read, Script and Execute.



In the IIS top level select "ISAPI and CGI Restrictions" and add the file isapi_redirect-

1.2.30_win32.dll resp. isapi-redirect-1.2.30_amd64.dll and allow execution.

Create a virtual JPBC directory in Default Web Site and link it to the "<hbc_home>/web"

physical path. Create the jakarta virtual directory under the default Web site. This will point to the

"<dest.root>\iis" physical directory (where we copied the files above). Create a virtual directory "image" under JPBC and link it with the "<hbc_home>/

CatalogImages" physical path. Create a virtual directory "startpage" under JPBC and link it with the "<hbc_home>/

jpbc/conf/startpage" physical path. Create a virtual directory "themes" under JPBC and link it with the "<hbc_home>/conf/

themes" physical path.



This directory is only necessary when installing custom layout themes. (The folder "<hbc_home>/conf/themes" has to be created.

Note: After the installation, the IIS Admin Service and World Wide Web Publishing Service services should be restarted.



10.2 Integrating Apache web server

10.2.1 Preparation Download the latest "Apache Tomcat Connector" according to your Apache web server

(http://tomcat.apache.org/) Create the configuration files in the "conf" folder of the Apache installation: "mod_jk.conf"

and "workers.properties"

10.2.2 mod_jk.conf # Load mod_jk module

# Specify the filename of the mod_jk lib

LoadModule jk_module modules/mod_jk.so

# Where to find workers.properties

JkWorkersFile conf/workers.properties

# Where to put jk logs

JkLogFile logs/mod_jk.log

# Set the jk log level [debug/error/info]

JkLogLevel info

# Select the log format

JkLogStampFormat "[%a %b %d %H:%M:%S %Y]"

Additional information: http://tomcat.apache.org/connectors-doc/reference/apache.html

10.2.3 workers.properties # Define list of workers that will be used

# for mapping requests

# The configuration directives are valid

# for the mod_jk version 1.2.18 and later

#

worker.list= node1,node2

# Define node1 for the BusinessCatalog

worker.node1.port=18009

worker.node1.host=127.0.0.1

worker.node1.type=ajp13

worker.node1.mount=/JPBC /JPBC/*.jsp /JPBC/*.hbc /JPBC/*.servlet /JPBC/dwrbridge/*

# Define node2 for the Staging Area

worker.node2.port=28009

worker.node2.host=127.0.0.1

worker.node2.type=ajp13

worker.node2.mount=/PCM /PCM/*

Additional information: http://tomcat.apache.org/connectors-doc/reference/workers.html

Finally you have to include the "mod_jk.conf" at the end of the Apache "httpd.conf" per Include-order: …

Include conf/mod_jk.conf

http://tomcat.apache.org/

http://tomcat.apache.org/connectors-doc/reference/apache.html

http://tomcat.apache.org/connectors-doc/reference/workers.html



11 Appendix A: Ports used by HBC and its components

These ports are used by the following applications

- Heiler Business Catalog Live System

- Heiler Business Catalog Staging Area

- Heiler Search Engine

The default configuration shown here is prepared in the shipped Tomcat configurations and defined without overlapping each other and located in an area where also other applications / processes does not operate.

Port Configuration file HB

C (Live System

)

HC

M (Staging A

rea)

HSE (Search Engine)

HTTP Connector apache-tomcat-7.0.XX/conf/server.xml 18080 * 28080 ** 18081***

AJP 1.3 Connector apache-tomcat-7.0.XX/conf/server.xml 18009 * 28009** -

Tomcat shutdown port apache-tomcat-7.0.XX/conf/server.xml 18015* 28015** 18005***

Tomcat redirect port apache-tomcat-7.0.XX/conf/server.xml 18443* 28443** 18443***

ActiveMQ HTTP activemq.xml 18082

ActiveMQ TCP activemq.xml 61616

JGroupsCacheManager Clustered Hibernate Session

<hbc_home>/apache-tomcat-7.0.XX/webapps/heiler-hbc/WEB-INF/classes/ehcache.xml

45566

(*) The ports marked can be configured during the Heiler Business Catalog Live System setup. Please ensure not to overlap with the Heiler Catalog Manager (Staging Area application) or Heiler Search Engine (HSE) when changing the ports.

(**) The ports marked can be configured for the Heiler Business Catalog Staging Area setup (see the installation manual of the Heiler Catalog Manager). Please ensure not to overlap with the Heiler Business Catalog Live System application when changing the ports.

(***) The port marked can be configured for the Heiler Search Engine. Please ensure not to overlap with the Heiler Business Catalog Live System application and the Heiler Business Catalog staging area when changing the port.



12 List of database tables from an installation prior to HSE2.0

If you are doing an upgrade of an existing system and the existing HSE version is prior to HSE 2.0 you have to make sure that the HSE1.x database tables will be removed before executing the database setup for the new HSE version.

The following database tables have to be removed manually if you want to do the database setup for the new HSE in the existing schema.

Table name Description

HSE_IDXREBJOB Containing the index rebuild jobs

HSE_IDXREBJOB_DET Containing the details to an index rebuild job

HSE_IDXREBJOB_QUE Index rebuild job queue

HSE_QRTZ_* Quartz tables used for the scheduling mechanism of the HSE

heiler business catalog 7 - informatica...installation manual . heiler business catalog 7. 1 -...

Documents