Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation...

58
Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager 3.3 (3.3.00) Heiler Software AG R&D - Research & Development Last changed: April 18, 2013

Transcript of Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation...

Page 1: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual

Heiler Catalog Manager 3.3

-

Installation Manual

Valid from Heiler Catalog Manager 3.3

(3.3.00)

Heiler Software AG

R&D - Research & Development

Last changed: April 18, 2013

Page 2: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 2 of 58

Table of Contents

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

2 Supported platforms ....................................................................... 5

2.1 Runtime (App. Server) ............................................................................................... 5

2.2 Operating systems (App. server) ................................................................................ 5

2.3 Database platforms .................................................................................................... 5

2.4 Browser compatibility (client side) .............................................................................. 5

2.5 Running on VMware .................................................................................................. 5

3 Notes, additional information, limitations ...................................... 6

4 Installation check list ...................................................................... 7

5 To be considered for updates ....................................................... 10

6 Preparing the target system(s) ..................................................... 11

6.1 Java SDK ..................................................................................................................11

6.2 MS SQL Server .........................................................................................................11

6.2.1 Summary ............................................................................................................11

6.2.2 Microsoft SQL Server .........................................................................................11

6.3 Oracle .......................................................................................................................13

6.3.1 Oracle ................................................................................................................13

6.3.2 Oracle Client version ..........................................................................................13

6.4 Linux OS ...................................................................................................................14

6.4.1 Java SDK ...........................................................................................................14

7 Setup of Heiler Catalog Manager .................................................. 15

7.1 Modules ....................................................................................................................15

7.1.1 ActiveMQ 5.7.0...................................................................................................16

7.1.2 Tomcat 7.0.35 ....................................................................................................17

7.2 The hcm-setup.properties file ....................................................................................17

7.3 Basic settings to be adapted .....................................................................................17

7.3.1 General settings .................................................................................................17

7.3.2 Database settings ..............................................................................................20

7.4 Starting setup for the first time ..................................................................................23

7.5 Updating an existing installation ................................................................................23

7.6 Later or a new configuration ......................................................................................24

7.7 Post setup/Initial operation ........................................................................................24

7.7.1 Import and CatalogImages shares or mount points ............................................24

7.7.2 Standard classification systems .........................................................................25

Page 3: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 3 of 58

7.7.3 Validation Reports ..............................................................................................25

7.8 Initial start of Heiler Catalog Manager .......................................................................25

7.8.1 Overview ............................................................................................................25

7.8.2 Running as service (Windows) ...........................................................................27

7.8.3 Linux start scripts ...............................................................................................28

8 Web server integration .................................................................. 30

8.1 MS Internet Information Server 7 (IIS) .......................................................................30

8.1.1 Setup and Configuration of the ISAPI Redirector for 64 bit .................................30

8.1.2 Configuring in IIS 7 .............................................................................................31

9 Heiler Business Catalog integration............................................. 34

10 Appendix A: Ports used by Heiler Catalog Manager and Heiler Business Catalog ................................................................................ 35

11 Appendix B: hcm-setup.properties in detail ............................ 36

11.1 General settings ........................................................................................................36

11.2 Application settings ...................................................................................................43

11.3 Database settings .....................................................................................................43

12 Appendix C: Trouble shooting .................................................. 58

Page 4: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 4 of 58

1 Objective

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

Page 5: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 5 of 58

2 Supported platforms

2.1 Runtime (App. Server)

Java 1.7.0_13 64 bit

Tomcat 7.0.35 64 bit

ActiveMQ 5.7.0 64 bit

2.2 Operating systems (App. server)

Windows Server 2008 R2 64 bit

Windows Server 2012 64 bit

Linux versions on request

2.3 Database platforms

Microsoft SQL Server 2008 R2 or 2012, Collation: Latin1_general, CS (case sensitive) and AS (accent sensitive)

Oracle 11g R2 (at least patch level: 11.2.0.3)

Character set: AL16UTF16

Note that up to version 11.2.0.2.0 the patch 9205565 is required for fixing an Oracle performance issue regarding materialized views. For detailed information take a look at the Oracle patch “BUG:9205565 - CREATE OR DROP MATERIALIZED VIEW TAKES TOO MUCH”. See metalink_note_1073606.1.

2.4 Browser compatibility (client side)

Microsoft Internet Explorer IE 8, 9 and 10 (on Windows 8)

Mozilla Firefox starting with version 10

Google Chrome starting with version 16

Javascript must be enabled on all browsers.

2.5 Running on VMware

The usage of virtual machine systems is generally supported.

The sizing information and recommendations are equally valid for VM based systems.

Please consider – dependent on the VM technology used – the sometimes limited I/O perfor-mance and the different strategies of CPU distribution between concurrently performed vir-tual machines.

We recommend the setup of a VM environment based on the technology and infrastructure planned for a later productive use and to test the system performance based on the expec-tations given.

Refer to our technical consultants for advice.

Page 6: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 6 of 58

3 Notes, additional information, limitations

Only 64 bit systems and Java runtimes are support for Heiler Catalog Manager 3.3

For the integration of Heiler Business Catalog 7.1 a separate instance of Tomcat is needed. Running both applications in the same instance of Tomcat is not approved yet.

For the database servers or the application server, on which the database is running, we strongly recommend the usage of local disks with a high performance I/O or other high performance storage devices (e.g. SAN).

The data and log files of the databases should be separated and stored on physically different disk volumes.

The temporary needed disk space for backups and large growing temp db (e.g. while importing data) has to be considered when sizing the disk space for the database. Importing large catalogs can lead to a very big temp db of several GB, sometimes even 50-100GB depending of size of catalog.

In general, all browsers have to support and activate Java Script to be used with Heiler Business Catalog and Heiler Catalog Manager.

Page 7: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 7 of 58

4 Installation check list

Decide on the operating system (Windows / Linux) as well as the database plat-form (MS SQL Server / Oracle) under which the software should be installed. Refer to chapter 2 Supported platforms on page 5.

SQL-Server check/install: Ensure collation and sort order (Latin1_general, CS (case sensitive), AS (accent sensitive)). Ensure that the CLR Integration is enabled. Refer to chapter 6.2.2 Microsoft SQL Server on page 11.

Oracle check/install: Ensure the right version and character set used. Refer to chapter 6.3.1 and 6.3.2, the installation of Oracle and its client tools starting on page 13.

Prepare the application server(s) with the necessary system pre-conditions depending on the OS and DB platform. Refer to chapter 6 (and subsequent) Preparing the target system(s) starting from page 11.

□ Java 1.7.0_13

Copy the hcm-setup.properties to the user's home directory and adapt the settings.

Refer to chapter 7.1 Modules

Heiler Catalog Manager setup has been separated in components. Following components have been provided and can be installed separately:

Database Setup

Web Application including ActiveMQ and Tomcat

Import

Each of the modules uses the same configuration file named hcm-setup.properties, so you only need to configure one file for all modules. Following steps are needed to install one or more components:

Unzip the installation package HCM_3.3.00-Rnnnn-yyyy-mm-dd_Full.zip into a temporary folder ( e.g.: HCM-33-setup) and open that folder.

From the subfolder named “setup” make a copy of the template file hcm-setup.properties.MSSQL2012.template for MS SQL Server or hcm-setup.properties.ORA11GR2.template for Oracle based setups and rename the copied template to hcm-setup.properties. Configure hcm-setup.properties using the instructions in the next chapter.

Install Database using Install-Database.cmd. Setup is done using quiet mode and hcm-setup.properties in current folder.

Install Web application using Install-WebApp.cmd. Setup is done using hcm-setup.properties in current folder.

Install Import application using Install-Import.cmd. Setup is done using hcm-setup.properties in current folder.

If you need more control for the setup, you should open a command window and use the setup.cmd file to run the setup of HCM 3.3. You can show instructions about setup using commandline parameter /h (setup /h):

Page 8: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 8 of 58

4.1.1 ActiveMQ 5.7.0

A JMS message broker is essentially needed for the communication between the following components:

HCM to HBC for resetting the session factory

HCM Import to HCM Web for import state.

HCM Web for managing the workflow

The Apache Active MQ version 5.7.0 has to be used, which is shipped and installed as part of the web application.

There are some username/password combinations configured for the different parts of the message broker.

Default user Default password Note

Admin web console

Admin jmsWebAdmin Can be changed in configuration file 'conf/jetty-realm.properties’ within the installation directory

TCP communication

system 13aBaeWF2R

After the service has started try to access the following URL: http://127.0.0.1:8161/admin/ and if the service started successfully the Active MQ welcome page will appear.

Page 9: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 9 of 58

4.1.2 Tomcat 7.0.35

The Apache Tomcat Servlet Engine is used for the HCM web application. Tomcat version 7.0.35 must be used, which is shipped and installed as part of the web application.

The hcm-setup.properties file on page 15.

Perform the setup. Refer to chapter 7.4 Starting setup for the first time on page 23.

Ensure that the import directory is shared appropriate or a local path is used (only for single server scenario). Refer to chapter 7.7.1 Import and CatalogImages shares or mount points starting on page 24

Web server integration of both applications. Refer to chapter 8 Web server integration starting on page 30.

Page 10: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 10 of 58

5 To be considered for updates

Important:

In case of an update of Heiler Catalog Manager 3.1 or earlier, you need to make sure that you update the current installed version to Heiler Catalog Manager 3.2 SP3. After that update the database needs to be transferred to the SQL Server 2008 R2 or SQL Server 2012 platform. Then the automated update to Heiler Catalog Manager 3.3 will be done by the setup described in this document.

Please make sure that you follow the installation manual of Heiler Catalog Manager 3.2 for the temporary upgrade especially for the state of all existing catalogs.

SQL Sever 2005 migration:

Heiler Catalog Manager 3.3 requires at least SQL Server 2008.R2

Java:

You must install a 64 bit Java 7 JDK for Heiler Catalog Manager 3.3. Due to securtity issues at least version 13 of Java 7 must be used.

JBoss 4.2.3:

JBoss is no longer needed for Heiler Catalog Manager 3.3 and should be deleted after the installation.

Tomcat 7.0.35:

Tomcat is used as a replacement of the JBoss application server. Please use the version supplied with the HCM 3.3 installation package.

ActiveMQ 5.7.0:

Apache ActiveMQ is provided with the HCM 3.3 installation package. Please use this version and do not install the version provide for HBC 7.0 or earlier.

Page 11: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 11 of 58

6 Preparing the target system(s)

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

6.1 Java SDK

A 64 Bit Java SDK 1.7.0_13 is installed by calling the jdk-7u13-windows-x64.exe setup

program.

A target directory should be set up where all Java based system requirement software has to be installed. This directory will be referred to 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_13

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_13 - the

path pointing to your Java installation directory.

6.2 MS SQL Server

6.2.1 Summary

Components and software to be considered:

SQLXML4 SP1 needs to be installed on the server, where the import will be running

Attention:

Ensure that the SQL Server Client Tools are installed on an application server where the import will be running but no database is available (separated database infrastructure).

6.2.2 Microsoft SQL Server

When installing Microsoft SQL Server, the following settings must be considered:

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

After the installation of SQL Server has finished you need to enable the CLR Integration.

Start Microsoft SQL Server Management Studio. Right click on the top node and select “Facets”. In the Facets dialog, select the facet named “Surface Area Configuration” and set

Page 12: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 12 of 58

"ClrIntegrationEnabled" to "true". See screenshot below. In addition, SQLXML4 SP1 needs to be installed on the server where the process "ImportSupervisor" is running.

Due to temporary 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 its 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 Catalog Manager the first time. An exception occurs in this case (for more details see 12 Appendix C: Trouble shooting).

Check the server name and rename it if needed. Use the following SQL statements using the SQL Server Management Studio.

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:

Page 13: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 13 of 58

sp_dropserver <old_name>

go

sp_addserver <new_name>, 'local'

go

Restart the SQL Server after this operation.

6.3 Oracle

6.3.1 Oracle

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

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

When creating a new database the type “General Purpose” should be selected and AL16UTF16 must be selected as the character set.

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

For further information please refer to the Oracle documentation.

6.3.2 Oracle Client version

The Oracle Client Tools are needed for the application's runtime on the machine on which the import is running – usually the application server if it is separated physically from the database server.

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)

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

For further information, please refer to the Oracle documentation.

Page 14: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 14 of 58

6.4 Linux OS

6.4.1 Java SDK

A 64 Bit Java SDK 1.7.0_13 is installed by calling the jdk-7u13-linux-x64.bin setup.

Follow the setup instructions.

Page 15: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 15 of 58

7 Setup of Heiler Catalog Manager

7.1 Modules

Heiler Catalog Manager setup has been separated in components. Following components have been provided and can be installed separately:

Database Setup

Web Application including ActiveMQ and Tomcat

Import

Each of the modules uses the same configuration file named hcm-setup.properties, so you only need to configure one file for all modules. Following steps are needed to install one or more components:

Unzip the installation package HCM_3.3.00-Rnnnn-yyyy-mm-dd_Full.zip into a temporary folder ( e.g.: HCM-33-setup) and open that folder.

From the subfolder named “setup” make a copy of the template file hcm-setup.properties.MSSQL2012.template for MS SQL Server or hcm-setup.properties.ORA11GR2.template for Oracle based setups and rename the copied template to hcm-setup.properties. Configure hcm-setup.properties using the instructions in the next chapter.

Install Database using Install-Database.cmd. Setup is done using quiet mode and hcm-setup.properties in current folder.

Install Web application using Install-WebApp.cmd. Setup is done using hcm-setup.properties in current folder.

Install Import application using Install-Import.cmd. Setup is done using hcm-setup.properties in current folder.

If you need more control for the setup, you should open a command window and use the setup.cmd file to run the setup of HCM 3.3. You can show instructions about setup using commandline parameter /h (setup /h):

Page 16: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 16 of 58

7.1.1 ActiveMQ 5.7.0

A JMS message broker is essentially needed for the communication between the following components:

HCM to HBC for resetting the session factory

HCM Import to HCM Web for import state.

HCM Web for managing the workflow

The Apache Active MQ version 5.7.0 has to be used, which is shipped and installed as part of the web application.

There are some username/password combinations configured for the different parts of the message broker.

Default user Default password Note

Admin web console

Admin jmsWebAdmin Can be changed in configuration file 'conf/jetty-realm.properties’ within the installation directory

TCP communication

system 13aBaeWF2R

After the service has started try to access the following URL: http://127.0.0.1:8161/admin/ and if the service started successfully the Active MQ welcome page will appear.

Page 17: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 17 of 58

7.1.2 Tomcat 7.0.35

The Apache Tomcat Servlet Engine is used for the HCM web application. Tomcat version 7.0.35 must be used, which is shipped and installed as part of the web application.

7.2 The hcm-setup.properties file

The application components are installed and configured using the configuration file

hcm-setup.properties. The location of hcm-setup.properties file can be specified using

a commandline parameter. This file specifies all configuration settings with regard to the runtime environment and infrastructure of the destination system.

When the installation package for the Heiler Catalog Manager application has been extracted, templates for this file are located in the setup subdirectory.

Use the template corresponding to the database platform intend to be installed:

hcm-setup.properties.MSSQL2012.template for MS SQL Server

hcm-setup.properties.ORA11G.template for Oracle

If you are using an existing file, make sure that the version is updated to version of the template file and that it contains all the properties included in the template file – otherwise the configuration of the system may be incomplete, which may cause errors at runtime or the setup will abort, if the version is wrong.

Note: The settings in this file are only evaluated during setup and configuration. This file is not needed for the runtime of the system.

A lot of properties are pre-configured with sensible default values. For a standard installation only a few properties have to be adapted to the installation environment.

For a complete list of all setup properties described see 11 Appendix B: hcm-setup.properties in detail starting on page 36.

7.3 Basic settings to be adapted

These few settings need usually be adapted to the environment where installation is intended to.

7.3.1 General settings

7.3.1.1 setup.version

= Version for this file. It is checked by the setup procedure to ensure, that all necessary properties are present.

Example:

setup.version = 33

7.3.1.2 dest.host

= IP address or server name of the server on which the component will be installed. This set-ting is not used to address the server via the browser (http), but only for application-internal addressing for various file accesses, which means that the local IP is also possible (127.0.0.1).

Provide your application servers name/IP.

Page 18: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 18 of 58

Example: dest.host = 127.0.0.1

dest.host = localhost

dest.host = hcmsvr01

7.3.1.3 hcm.home (previously known as dest.root)

= Root directory, into which the application will be installed. Many of the following files system paths refer to this directory.

Specify the path where the component will be installed. A convention is to use “Heiler” as a root directory for all software components of Heiler Software AG and to use a subdirectory named "hcm” for the Heiler Catalog Manager application.

It is strongly recommended to not use any whitespaces within the path.

Example:

hcm.home = C:/Heiler/hcm (Windows)

hcm.home = /opt/heiler/hcm (Linux)

7.3.1.4 java.root

= Directory into which the Java SDK has been installed (see chapter 6 Preparing the target system(s) starting on page 11).

Specify the path to the directory where the java system components have been installed. Recommended is a directory named "java” below the "Heiler" root directory.

Example:

java.root = C:/Heiler/java (Windows)

java.root = /opt/heiler/java (Linux)

The following property is based on the java.root above and has to be adapted to the system accordingly.

jdk.home = ${java.root}/jdk1.7.0_13

7.3.1.5 import.host

= IP address or server name of the server on which the import component will be installed.

The value specified by dest.host is used as a default, which means that this setting does

not need to be changed for a single-server setup.

Since this setting is also not used for addressing the server via the browser (http), but only for application-internal addressing for various file accesses, the local IP (127.0.0.1) is nor-mally possible here as well.

Example: import.host = ${dest.host}

7.3.1.6 import.root.remote

= Absolute file path enabling remote file access to the import directory structure (even in multi-server setup situations!).

In the case of a single-server setup, this can be a local directory within the installed directory structure, in the case of a multi-server setup under Windows it may be a server name plus Share, or for Linux systems an "NFS Mount Point".

Page 19: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 19 of 58

Example:

import.root.remote = ${hcm.home}/import (local path, single-server only)

import.root.remote = //${import.host}/HeilerImport (single-/multi-server)

7.3.1.7 import.root.local

= Absolute file path used for local file access to the import directory structure. This local path must point to the same physical location as the definition of the import file share (see 7.3.1.6 import.root.remote).

It is used by ImportSupervisor during validating and importing of catalogs.

Example:

import.root.local = ${hcm.home}/import (local path)

7.3.1.8 mime.host

= IP address or server name of the Media Asset Server (MAS). The destination machine

specified by dest.host is used by default, which means that this setting does not need to be

changed for a single-server setup.

Since this setting is also not used for addressing the server via the browser (http), but only for application-internal addressing for various file accesses, the local IP (127.0.0.1) is also possible here.

Example: mime.host = ${dest.host}

7.3.1.9 mime.root.remote

= Absolute file path enabling remote file access to all multimedia data in the system (even in a multi-server setup!).

In the case of a single-server setup, this can be a local directory within the installed directory structure, in the case of a multi-server setup under Windows it may be a server name plus Share, or for Linux systems an "NFS Mount Point".

The default setting (= CatalogImages directory in the import-share) does not usually need to

be changed.

Example:

mime.share = ${hcm.home}/CatalogImages (local path, single-server only)

mime.share = //${mime.host}/CatalogImages (single- / multi-server)

7.3.1.10 mime.root.local

= Absolute file path enabling local file access to all multimedia data in the system (even in a multi-server setup!). This local path must point to the same physical location as the definition of the mime file share (see 11.1.1.43 mime.root.remote)

Example:

mime.root.local = ${hcm.home}/CatalogImages (local path)

7.3.1.11 hbc.activemq.host

= IP address or server name of the HCM ActiveMQ server used for communicate with HBC. This settings is very important for proper functionality of HBC. It is used to inform HBC about a released or revoked catalog, so HBC will be able to adjust the hibernate database cache.

Page 20: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 20 of 58

Example:

hbc.activemq.host = ${dest.host} (ActiveMQ installed on the same server)

hbc.activemq.host = HBCSERVER (ActiveMQ installed on the server named HBCSERVER)

7.3.1.12 hcm.activemq.host

= IP address or server name of the HCM ActiveMQ server used for communicate within HCM. This setting is very important for proper functionality of HCM workflows.

7.3.2 Database settings

If you choose the right database specific template of the properties file it is already preconfigured so that not too much settings have to be adapted.

Check the following settings of the db.default.xxx section these properties are used for all databases/schemas of Heiler Catalog Manager.

At the end check and adapt the following properties – these have to be adapted if the standard database/schema names shall not be used. All other database settings are used from the db.default.xxx properties above:

db.main.schema = HCM_MAIN

db.supplier.schema = HCM_SUPPLIER

db.um.schema = HCM_UM

db.bulkload.schema = HCM_BULKLOAD

db.ls.schema = HBC

db.repstore.schema = HCM_REPSTORE (only used for Oracle)

More information on the other database properties can be found in Appendix B: hcm-setup.properties in detail starting on page 36. These have to be adapted on special installa-tion circumstances e.g. like different locations for the database files.

7.3.2.1 db.default.type

= Type of the database being used. MSSQL2005 and ORA92 are supported.

Example:

db.default.type = MSSQL2005 (MS SQL server 2008 R2 and 2012)

db.default.type = ORA92 (Oracle 11gR2)

Note: Don’t be confused by that constant ORA92. It is due to historical reasons and stands for Oracle. With the current version of Heiler Catalog Manager 3.3 Oracle only 11g R2 is supported.

7.3.2.2 db.default.database (Oracle)

= SID of the Oracle database.

Example: db.default.database = PXX.IHEILER.COM

7.3.2.3 db.default.database.TNS (Oracle)

= TNS name of the Oracle database. This is often the same as the SID, which means that it

is also mapped to db.default.database by default, but it is also possible that it is different.

Page 21: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 21 of 58

Example: db.default.database.TNS = ${db.default.database}

7.3.2.4 db.default.server (SQL Server and Oracle)

= IP address or server name of the standard database server. For single-server setups, the

default setting (dest.host) is sufficient.

In the case of a remote database, this must also be modified accordingly.

This setting applies to both database types, MS SQL Server and Oracle.

Example: db.default.server = ${dest.host}

7.3.2.5 db.default.instance (SQL Server)

= Name of a SQL Server instance to be used. Ensure that the instance separator is config-ured properly too when setting the instance name. For the default instance provide an empty string.

Example: db.default.instance = HCM

7.3.2.6 db.default.instance.separator (SQL Server)

= Character to separate the server name from the instance name in the connection string. Ensure that the instance separator is an empty string for the default (unnamed) SQL Server instance or a double backslash character for a named instance.

Example: db.default.instance.separator = \\

7.3.2.7 db.default.port (SQL Server and Oracle)

= Port to which the database server "responds". This setting applies to both database types, MS SQL Server and Oracle.

Example:

db.default.port = 1433 (MS SQL-Server)

db.default.port = 1521 (Oracle)

7.3.2.8 db.default.user

= Default user name to be used for accessing the databases. Since Oracle employs an en-tirely different user concept, this setting is relevant only for MS SQL Server.

Example: db.default.user = hcmaccess or hbcaccess

7.3.2.9 db.default.password

= Default user password to be used for accessing the databases. Since Oracle employs an entirely different user concept, this setting is relevant only for MS SQL Server.

Example: db.default.password = heiler

Page 22: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 22 of 58

7.3.2.10 db.default.dir.data (SQL Server and Oracle)

= Directory in which the physical databases (MS SQL Server) and tablespaces for data and indexes (Oracle) are to be created. When used in conjunction with a remote database, this directory is interpreted from the perspective of the database server, i.e. in this case the set-ting must be changed to a directory on the database server.

Example: db.default.dir.data = ${hcm.home}/db/data

7.3.2.11 db.default.dir.log (SQL Server)

= Directory in which the log files are to be created. When used in conjunction with a remote database, this directory is interpreted from the perspective of the database server, i.e. in this case the setting must be changed to a directory on the database server.

Example: db.default.dir.log = ${db.default.dir.data}

7.3.2.12 db.default.dir.index (Oracle)

= Directory in which the tablespaces for index files are to be created. When used in conjunc-tion with a remote database, this directory is interpreted from the perspective of the database server, i.e. in this case the setting must be changed to a directory on the database server.

Example: db.default.dir.index = ${db.default.dir.data}

7.3.2.13 db.default.dir.temp (Oracle)

= Directory in which the tablespaces for temporary tables are to be created. When used in conjunction with a remote database, this directory is interpreted from the perspective of the database server, i.e. in this case the setting must be changed to a directory on the database server.

Example: db.default.dir.temp = ${db.default.dir.data}

7.3.2.14 db.poolsize

= Number of maximum database connections used by the JBoss application. Each single

data source configured below uses db.poolsize number of database connections.

Example: db.poolsize = 50

7.3.2.15 db.default.bulkloader

= Path to the "bulkloader" of the database that is used by the BMEcat Import. In the case of a setup under MS SQL Server the associated bulkloader is included in the supplied package, but for Oracle the standard SQL Loader of the Oracle client must be referenced.

Example for MS SQL Server: db.default.bulkloader =

${hcm.home}/import/Bulkload/bin/Release/Bulkload.exe

Example for Oracle / Windows: db.default.bulkloader = [path]/sqlldr.exe

Page 23: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 23 of 58

Example for Oracle / Linux: db.default.bulkloader = [path]/sqlldr

[path] specifies the corresponding path to the setup directory on the Oracle client.

7.4 Starting setup for the first time

When the installation package for the Heiler Catalog Manager application has been extracted

the files setup.cmd (Windows) und setup.sh (Linux) are located in the setup directory.

After hcm-setup.properties has been configured according to the system configuration as

described above setup can be started.

Proceed as follows:

Open a console window

Change the working directory to the setup folder.

Ensure that hcm-setup.properties is copied to the setup folder

Use setup /h for help of the setup

Execute setup.cmd/setup.sh and specify the parameters needed for your system.

During setup following steps performed:

Extracting the activeMQ package to folder <hcm.home>/apache-activemq-<version>

Extracting the tomcat package to folder <hcm.home>/apache-tomcat-<version>

Extracting the HCM web application package to folder

<hcm.home>/apache-tomcat-<version>/webapps/PCM

Extracting the HCM import application package to folder <hcm.home>/import

Extracting language files and other configurations required for the runtime in folder <hcm.home>/home

Extracting database scripts to folder <hcm.home>/db

Configuring all extracted files and replace all placeholder values with the values

configured in hcm-setup.properties

The setup can be monitored in the console window. Please watch for error messages and

after the database setup has been finished, you should inspect the file update.log for any

errors which could have been occurred during update of the database.

7.5 Updating an existing installation

In case of an update, all Heiler Catalog Manager services must be shut down and the

complete installation directory <dest.root> should be backed up, e.g. as a ZIP or TAR file

and moved to a different location. After shutting down the Heiler Catalog Manager services the services should be uninstalled, because new Heiler Catalog Manager startup scripts will be installed during update and are used to register the services newly. If the previous services were not deleted there could be problems with registering the new Heiler Catalog Manager startup scripts, or the services cannot be started any more.

Please make a backup of the validation reports in folder <hcm.home>/home/ValidationReports to avoid loss of the reports.

Page 24: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 24 of 58

Note: To avoid version conflicts of Java archives when updating an existing system, you

should delete or rename all directories below <hcm.home>, which contain jar files, before

starting the setup. Please ensure that you do not forget to rename or delete the import/bin/lib directory.

Note: The contents of the following Tomcat directories must also be deleted entirely (Linux

command rm –rf):

<hcm.home>\apache-tomcat-<version>\work (Windows) or

<hcm.home>/apache-tomcat-<version>/work (Linux)

7.6 Later or a new configuration

If for any reason the settings must be modified again in hcm-setup.properties, the setup

does not have to be run again.

The configure.cmd (Windows) and configure.sh (Linux) scripts are provided for this pur-

pose. They are called from the <hcm.home>/setup directory and evaluate the setup

properties again before executing the corresponding patches for the runtime and configura-tion files and the database scripts. Hereby attention has to be paid to the parameter

<java_home> which is needed here also as described with the setup.cmd.

Note: The complete application can be configured on the basis of your directory information,

drives, server IPs and names etc. using the hcm-setup.properties file.

Please do not attempt to "manually" reconfigure directories, servers and the like in the configuration files of the application itself. Instead, work only with this central configuration

file using the following call for configure.cmd or configure.sh.

7.7 Post setup/Initial operation

The steps described in this section must be carried out at the end of the setup for the actual initial operation of the system. All the steps described previously must have been success-fully completed.

7.7.1 Import and CatalogImages shares or mount points

In a multi-server setup so-called Shares (Windows) or NFS Mount Points (Linux) must be set up to allow access across servers for importing and exporting.

The names used for this must match the import.root.remote and mime.root.remote

properties stored in the hcm-setup.properties configuration file (see 7.3 Basic settings to

be adapted starting on page 17).

Typical configurations are:

7.7.1.1 Import

c:\heiler\import, shared name “HeilerImport”

import.host = ${dest.host}

import.root.remote = ${hcm.home}/import (single-server only)

import.root.remote = //${import.host}/HeilerImport (single- / multi-server)

Page 25: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 25 of 58

7.7.1.2 Images

c:\heiler\CatalogImages, shared name “CatalogImages”

mime.host = ${dest.host}

mime.root.remote = ${hcm.home}/CatalogImages (single-server only)

mime.root.remote = //${mime.host}/CatalogImages (single- / multi-server)

Note: In the case of a single server setup, the associated properties in the hcm-

setup.properties file can also very well reference local directories, so that it is not neces-

sary to create shares or mount points.

7.7.2 Standard classification systems

Standard classification scripts are provided in folder

ProductRelease\ClassificationSystems. These scripts are used for all Heiler products.

Please consult the installation guide, which is provided in this folder.

7.7.3 Validation Reports

Please assure that the validation reports have been restored to folder <hcm.home>/home/ValidationReports in case you have deleted or renamed the <hcm.home>/home directory before running setup.

7.8 Initial start of Heiler Catalog Manager

7.8.1 Overview

For starting and stopping the application (Windows and Linux), as well as for registration and un-registration as system service (Windows), a variety of start scripts are provided in the

<hcm.home>/bin directory.

7.8.1.1 start-activemq.cmd (Windows)

= Start and stop the ActiveMQ message broker, as well as register and un-register as system service.

Call: start-activemq.cmd [options]

Possible options are:

-start Start activemq as a console application, which is also the default behaviour

when being called without any command line arguments

-stop Shut down activemq having been started in standard mode.

-i Register activemq as system service (see 7.8.2 Running as service starting on page

27)

-u Unregister activemq as system service

-? Display all possible command line arguments.

7.8.1.2 start-activemq.sh (Linux)

= Start and stop the ActiveMQ message broker

Call: start-activemq.sh [options]

Page 26: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 26 of 58

A call without any command line arguments causes activemq to be started as a console application.

Additional options are:

-d Start activemq as daemon (see Fehler! Verweisquelle konnte nicht gefunden

werden. Fehler! Verweisquelle konnte nicht gefunden werden. on page Fehler! Textmarke nicht definiert.)

-stop Shut down activemq

-kill kill activemq process

-? Display all possible command line arguments.

7.8.1.3 start-tomcat.cmd (Windows)

= Start and stop the Tomcat WEB-Server and Servlet Container, as well as register and un-register as system service.

Call: start-tomcat.cmd [options]

Possible options are:

-start Start tomcat as a console application, which is also the default behaviour

when being called without any command line arguments

-stop Shut down tomcat having been started in standard mode.

-i Register tomcat as system service (see 7.8.2 Running as service starting on page 27)

-u Unregister tomcat as system service

-? Display all possible command line arguments.

7.8.1.4 start-tomcat.sh (Linux)

= Start and stop the Tomcat WEB-Server and Servlet Container.

Call: start-tomcat.sh [options]

A call without any command line arguments causes tomcat to be started as a console application.

Additional options are:

-d Start tomcat as daemon (see Fehler! Verweisquelle konnte nicht gefunden

werden. Fehler! Verweisquelle konnte nicht gefunden werden. on page Fehler! Textmarke nicht definiert.)

-stop Shut down tomcat.

-kill kill tomcat process

-? Display all possible command line arguments.

7.8.1.5 start-importsv.cmd (Windows)

= Start and stop the Import Supervisor, as well as register and un-register as system service.

Call: start-importsv.cmd [options]

Possible options are:

Page 27: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 27 of 58

-start Start Import Supervisor as a console application, which is also the default

behavior when being called without any command line arguments.

-stop Shut down Import Supervisor having been started in standard mode.

-i Register Import Supervisor as system service (see 7.8.2 Running as service on page

27)

-u Unregister Import Supervisor as system service

-? Display all possible command line arguments.

7.8.1.6 start-importsv.sh (Linux)

= Start and stop the Import Supervisor.

Call: start-importsv.sh [options]

A call without any command line arguments causes Import Supervisor to be started as a console application.

Additional options are:

-d Start Import Supervisor as daemon (see Fehler! Verweisquelle konnte nicht

gefunden werden. Fehler! Verweisquelle konnte nicht gefunden werden. on page Fehler! Textmarke nicht definiert.)

-stop Shut down Import Supervisor

-kill Kill Import Supervisor process

-? Display all possible command line arguments.

7.8.2 Running as service (Windows)

On production and test systems at the customer site all HCM application must be installed as a service. To do this, perform the following steps:

Registration

Configuration and start

7.8.2.1 Registration

To register the HCM Java processes as services, you need to execute the following

commands in a console window in the <hcm.home>/bin directory:

start-activemq.cmd –i

start-tomcat.cmd –i

start-importsv.cmd –i

Note: Deregistration as a service is done in the same way, but by entering the parameter –u.

Note: It is recommended that you register the services again even for an update of the Heiler Catalog Manager application. For this, however, they should have been previously deregis-

tered with the –u entry – any error messages during deregistration can be ignored. The ser-

vice names have been changed in SP3 to start with “HCM” instead of “PCM”.

Page 28: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 28 of 58

7.8.2.2 De-Registration

To unregister the HCM Java processes as services, you need to stop the services and then

execute the following commands in a console window in the <hcm.home>/bin directory:

start-activemq.cmd –u

start-tomcat.cmd –u

start-importsv.cmd –u

7.8.2.3 Configuration and start

Following the registration of the services, the following system services are available in the management console under "Services":

HCM-ActiveMQ

HCM-Tomcat

HCM-Import

By default, these services run under the Local System Account, and are configured for Automatic start.

It is highly recommended that you run these services with a normal windows service account, e.g. hcm-svc-user and not as Local System Account. The windows service account needs to have the necessary access privileges for the appropriate directories and shares.

7.8.3 Linux start scripts

During installation the start scripts for Linux are copied to <hcm.home>/bin folder. The start scripts are named

activemq

hcm

hcm-isv

To install the start scripts, log in as root, copy the scripts to /etc/init.d and install them with insserv(8).

Page 29: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 29 of 58

(Linux background service). This can be done by calling them with command line argument

–d. For shutting down the option –stop and –kill (not recommented anymore) are provided.

start-activemq.sh -d

start-jboss.sh –d

start-importsv.sh -d

The scripts should always be called only from the Heiler Catalog Manager Administration User, because they have been created with consideration for the execution privileges. It must also be ensured that the shell environment has been initialized correctly and completely; this

is not always certain in the event of a change of context from other user accounts (using 'su

-') (e.g. HOME variable).

If you wish to have the processes launched automatically when the system is started via a context change from the "root" user, it is recommended to encapsulate the start scripts in a custom script which explicitly sets the entire environment.

Page 30: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 30 of 58

8 Web server integration

Note: If HBC and Staging area are installed on the same machine the web server integration has to be done only on this machine once, please refer to the HBC installation manual.

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

8.1.1 Setup and Configuration of the ISAPI Redirector for 64 bit

Note: The documentation describes the installation and configuration of the 64 bit variant of the ISAPI redirector plugin.

Please use the ISAPI redirector files provided with HBC for the installation of the redirector. It contains all necessary files to setup and configure the ISAPI 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 for example D:\Heiler\iis. Perform

the following step to prepare and configure the redirector:

Create a new directory where the ISAPI files will reside (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

match the path where you extracted the package to.

# 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

Page 31: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 31 of 58

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

Page 32: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 32 of 58

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.

Page 33: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 33 of 58

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

Page 34: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 34 of 58

9 Heiler Business Catalog integration

Please consult the Heiler Business Catalog 7.1 documentation, which describes the integra-tion of the Heiler Catalog Manager into the Heiler Business Catalog. The Heiler Catalog Manager is named Staging Area in that documentation (HBC_7.1_Installation_en.pdf).

Page 35: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 35 of 58

10 Appendix A: Ports used by Heiler Catalog Manager and Heiler Business Catalog

Please consult the Heiler Business Catalog 7.1 documentation (HBC_7.1_Installation_en.pdf) Appendix A for a list of default port settings used by HBC, HCM and HSE.

Page 36: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 36 of 58

11 Appendix B: hcm-setup.properties in detail

This file is divided into three categories, General Settings, Application Settings, and Database Settings. In the General Settings area described here, basic directory settings are made, while – as the name indicates – all settings relating to the application and database are specified in Application Settings and Database Settings.

11.1 General settings

11.1.1.1 dest.host

= IP address or server name of the server on which the application will be installed. This set-ting is not used to address the server via the browser (http), but only for application-internal addressing for various file accesses, which means that the local IP is also possible (127.0.0.1).

Example: dest.host = 127.0.0.1

dest.host = localhost

dest.host = hcmsvr01

11.1.1.2 hcm.home (dest.root)

= Root directory, in which the application is to be installed. Many of the following path ad-dresses refer to this directory.

Example:

hcm.home = C:/Heiler/hcm (Windows)

hcm.home = /hcmadm/hcm (Linux)

11.1.1.3 java.root

= Directory in which the Java SDK and/or JBoss have been installed (see chapter 6 Preparing the target system(s) on page 11).

Example:

java.root = C:/Heiler/java (Windows)

java.root = /hcmadm/java (Linux)

11.1.1.4 jdk.home

= Directory in which the Java JDK has been installed. The default setting refers to the Java root directory (see above), so this setting only needs to be changed in the most exceptional circumstances.

Example: jdk.home = ${java.root}/jdk1.7.0_13

11.1.1.5 container.name

= Name of the container used for the web application

Example: container.name = apache-tomcat

11.1.1.6 container.version

= Version of the container used for the web application

Page 37: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 37 of 58

Example: container.version = 7.0.35

11.1.1.7 container.home

= Root directory of the container used for the web application

Example: container.home = ${hcm.home}/${container.name}-${container.version}

11.1.1.8 jms.server.name

= Name of the java messaging service, currently only Apache ActiveMQ ™ is supported

Example: jms.server.name = apache-activemq

11.1.1.9 jms.server.version

= Version of Apache ActiveMQ ™

Example: jms.server.version = 5.7.0

11.1.1.10 jms.server.home

= Root directory of the Apache ActiveMQ ™ installation directory

Example: jms.server.home = ${hcm.home}/${jms.server.name}-${jms.server.version}

11.1.1.11 container.*.port

= Several container port settings with default values. Please do not change these default settings for a production system.

The settings are provided for testsystems where more than one Heiler Catalog Manager should be installed. You need to have completely different ports for each installation.

For the list of default port settings refer to the installation manual

11.1.1.12 container.admin.user.name

= Username to access the administration website for the container

Example: container.admin.user.name = tomcat

11.1.1.13 container.admin.user.password

= Password to access the administration website for the container

Example: container.admin.user.password = heiler

11.1.1.14 container.log.dir

= Directory where the container should write its application log files.

Example: container.log.dir = ${hcm.home}/log

Page 38: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 38 of 58

11.1.1.15 app.type

= Type of the installed application.

The only possible setting is currently PCM (= operation as Heiler Catalog Manager resp. HBC Staging Area application).

Example: app.type = PCM

11.1.1.16 app.name

= Logical name of the application. This setting is used to specify the relative name with which

the application can called in the browser (e.g. http://localhost/PCM), and also the name

of the JBoss Configuration (see Fehler! Verweisquelle konnte nicht gefunden werden. Fehler! Verweisquelle konnte nicht gefunden werden. on page Fehler! Textmarke nicht definiert.).

With this setting, it is possible to run several logical applications in parallel on the same server by giving them different names.

The application type (e.g. PCM) is used by default.

Example: app.name = ${app.type}

11.1.1.17 container.service.name

= Windows service identifier. This parameter is used as an identifier for the Windows service.

Example: container.service.name = HCM-Tomcat

11.1.1.18 container.service.displayname

= Windows service name. This parameter is used as a display name for the Windows service in the management console.

Example: container.service.displayname = HCM Tomcat Service

11.1.1.19 container.service.description

= Windows service description. This parameter is used as a description for the Windows service in the management console.

Example: container.service. description = Apache Tomcat 7.0.35 Server of Heiler Catalog Manager

11.1.1.20 container.console.title

= Window title of the console window, if started as a console application (not recommended)

Example: container.console.title = HCM Tomcat

11.1.1.21 container.service.initmemory

= Initial memory used by Tomcat, specified in Megabytes.

Page 39: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 39 of 58

Example: container.service.initmemory = 512

11.1.1.22 container.service.maxmemory

= Maximum memory used by Tomcat, specified in Megabytes.

You should increase this memory setting if there are many users working with HCM at the same time. (Concurrent users). The default setting is usually enough for 5 concurrent users

Example: container.service.maxmemory = 1024

11.1.1.23 import.service.name

= Windows service name. This parameter is used as a name for the Windows service.

Example: import.service.name = HCM-Import

11.1.1.24 import.service.displayname

= Windows service display name. This parameter is used as the display name for the Windows service.

Example: import.service.displayname = HCM ImportSupervisor service

11.1.1.25 import.service.description

= Windows service description. This parameter is used as the description for the Windows service.

Example: import.service.description = ImportSupervisor service of Heiler Catalog

Manager

11.1.1.26 import.console.title

= Windows console title. This parameter is used as the title of the Windows console window.

Example: import.console.title = HCM ImportSupervisor

11.1.1.27 import.service.initmemory

= Initial memory used by ImportSupervisor, specified in Megabytes. It is usually not needed to change this memory setting.

Example: import.service.initmemory = 384

11.1.1.28 import.service.maxmemory

= Maximum memory used by ImportSupervisor, specified in Megabytes. It is usually not needed to change this memory setting.

Example: import.service.maxmemory = 384

Page 40: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 40 of 58

11.1.1.29 jms.server.service.name

= Windows service name. This parameter is used as a name for the Windows service.

Example: jms.service.name = HCM-ActiveMQ

11.1.1.30 jms.server.service.displayname

= Windows service display name. This parameter is used as the display name for the Windows service.

Example: jms.service.displayname = HCM ActiveMQ Service

11.1.1.31 jms.server.service.description

= Windows service description. This parameter is used as the description for the Windows service.

Example: jms.service.description = Apache ActiveMQ 5.7.0 JMS Messaging Server of

Heiler Catalog Manager

11.1.1.32 jms.server.console.title

= Windows console title. This parameter is used as the title of the Windows console window.

Example: jms.console.title = HCM ActiveMQ

11.1.1.33 jms.server.service.initmemory

= Initial memory used by ActiveMQ, specified in Megabytes.

Example: jms.server.service.initmemory = 256

11.1.1.34 jms.server.service.maxmemory

= Maximum memory used by ActiveMQ, specified in Megabytes.

Example: jms.server.service.maxmemory = 256

11.1.1.35 import.host

= IP address or server name of the server on which the import will be installed. The destina-

tion machine specified by dest.host is used by default, which means that this setting does

not need to be changed for a single-server setup.

Since this setting is also not used for addressing the server via the browser (http), but only for application-internal addressing for various file accesses, the local IP (127.0.0.1) is nor-mally possible here as well.

Example: import.host = ${dest.host}

Page 41: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 41 of 58

11.1.1.36 import.root.remote

= Absolute file path enabling remote file access to the import directory structure (even in multi-server setup situations!).

In the case of a single-server setup, this can be a local directory within the installed directory structure, in the case of a multi-server setup under Windows it may be a server name plus Share, or for Linux systems an "NFS Mount Point".

Example: import.root.remote = ${hcm.home}/import (local path, single-server only)

import.root.remote = //${import.host}/HeilerImport (single-/multi-server)

11.1.1.37 import.root.local

= Absolute file path used for local file access to the import directory structure. This local path must point to the same physical location as the definition of the import file share (see 11.1.1.36 import.root.remote).

It is used by ImportSupervisor during validating and importing of catalogs.

Example: import.root.local = ${hcm.home}/import (local path)

11.1.1.38 import.jmx.port

Example: import.jmx.port = 55550

11.1.1.39 export.host

= IP address or server name of the server on which the export will be installed. The destina-

tion machine specified by dest.host is used by default, which means that this setting does

not need to be changed for a single-server setup.

Since this setting is also not used for addressing the server via the browser (http), but only for application-internal addressing for various file accesses, the local IP (127.0.0.1) is also possible here.

Example: export.host = ${dest.host}

11.1.1.40 export.root.remote

= Absolute file path enabling remote file access to the export directory structure (even in multi-server setup situations!).

In the case of a single-server setup, this can be a local directory within the installed directory structure, in the case of a multi-server setup under Windows it may be a server name plus Share, or for Linux systems an "NFS Mount Point".

Example: export.root.remote = ${hcm.home}/export (local path, single-server only) export.root.remote = //${export.host}/HeilerExport (single- / multi-server)

11.1.1.41 export.root.local

= Absolute file path used for local file access to the export directory structure. This local path must point to the same physical location as the definition of the export file share (see 11.1.1.40 export.root.remote).

Page 42: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 42 of 58

Example: export.root.local = ${hcm.home}/export (local path)

11.1.1.42 mime.host

= IP address or server name of the Media Asset Server (MAS). The destination machine

specified by dest.host is used by default, which means that this setting does not need to be

changed for a single-server setup.

Since this setting is also not used for addressing the server via the browser (http), but only for application-internal addressing for various file accesses, the local IP (127.0.0.1) is also possible here.

Example: mime.host = ${dest.host}

11.1.1.43 mime.root.remote

= Absolute file path enabling remote file access to all multimedia data in the system (even in a multi-server setup!).

In the case of a single-server setup, this can be a local directory within the installed directory structure, in the case of a multi-server setup under Windows it may be a server name plus Share, or for Linux systems an "NFS Mount Point".

The default setting (= CatalogImages directory in the import-share) does not usually need to

be changed.

Example: mime.share = ${hcm.home}/CatalogImages (local path, single-server only)

mime.share = //${mime.host}/CatalogImages (single- / multi-server)

11.1.1.44 mime.root.local

= Absolute file path enabling local file access to all multimedia data in the system (even in a multi-server setup!). This local path must point to the same physical location as the definition of the mime file share (see 11.1.1.43 mime.root.remote)

Example: mime.root.local = ${hcm.home}/CatalogImages (local path)

11.1.1.45 hbc.activemq.host

= IP address or server name of the HCM ActiveMQ server used to communicate with Heiler Business Catalog (HBC). This settings is very important for proper functionality of HBC. It is used to inform HBC about a released or revoked catalog, so HBC will be able to adjust the database cache.

Example: hbc.activemq.host = ${dest.host} (ActiveMQ installed on the same server)

hbc.activemq.host = HBCSERVER (ActiveMQ installed on the server named

HBCSERVER)

11.1.1.46 hbc.activemq.port

= Port number of the HCM ActiveMQ server used to communicate with Heiler Business Catalog (HBC).

Page 43: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 43 of 58

Example: hbc.activemq.port = 61616

11.1.1.47 hcm.activemq.host

= IP address or server name of the HCM ActiveMQ server used to communicate within Heiler Catalog Manager (HCM). This settings is very important for proper functionality of HCM workflow management and import state.

Example: hcm.activemq.host = ${dest.host} (ActiveMQ installed on the same server)

11.1.1.48 hcm.activemq.port

= Port number of the HCM ActiveMQ server used to communicate within Heiler Catalog Manager (HCM).

Example: hcm.activemq.port = 61616

11.2 Application settings

11.2.1.1 mail.host

= IP address or server name of the mail server for automatic sending of e-mails on the sys-

tem side. The destination machine specified by dest.host is used by default, which means

that this setting does not need to be changed for a single-server setup.

Since this setting is also not used for addressing the server via the browser (http), but only for application-internal addressing for various file accesses, the local IP (127.0.0.1) is also possible here.

Example: mail.host = ${dest.host}

11.2.1.2 mail.from

= E-mail address that is to be used as the sender for e-mails that are sent automatically. The default setting is determined by the logical application name, so that different senders can be used for different applications where several systems are installed parallel.

Example: mail.from = ${app.name}[email protected]

11.3 Database settings

11.3.1.1 db.default.type

= Type of the database being used. MSSQL2005 and ORA92 are supported.

Example:

db.default.type = MSSQL2005 (MS SQL server)

db.default.type = ORA92 (Oracle)

11.3.1.2 db.default.database

= SID of the Oracle database.

Page 44: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 44 of 58

Since exactly one database is in use only in conjunction with Oracle, whereas multiple data-bases are used for MS SQL Server, this setting applies only for Oracle.

Example: db.default.database = PXX.IHEILER.COM

11.3.1.3 db.default.database.TNS

= TNS name of the Oracle database for OCI access. This is often the same as the SID,

which means that it is also mapped to db.default.database by default, but it is also entirely

possible that it is different.

Since exactly one database is in use only in conjunction with Oracle, whereas multiple data-bases are used for MS SQL Server, this setting applies only for Oracle.

Example: db.default.database.TNS = ${db.default.database}

11.3.1.4 db.default.server

= IP address or server name of the standard database server. For single-server setups, the

default setting (dest.host) is sufficient.

In the case of a remote database, this must also be modified accordingly.

This setting applies to both database types, MS SQL Server and Oracle.

Example: db.default.server = ${dest.host}

11.3.1.5 db.default.port

= Port to which the database server "responds". This setting applies to both database types, MS SQL Server and Oracle.

Example:

db.default.port = 1433 (MS SQL-Server)

db.default.port = 1521 (Oracle)

11.3.1.6 db.default.user

= Default user name to be used for accessing the databases. Since Oracle employs an en-tirely different user concept, this setting is relevant only for MS SQL Server.

Note: Since Service Pack 2 the “sa” user is not needed anymore to run Catalog Manager. If you are using the Catalog Manager together with the Business Catalog, you have to make sure that both applications have to use the same user.

Example: db.default.user = hcmaccess or hbcaccess

11.3.1.7 db.default.password

= Default user password to be used for accessing the databases. Since Oracle employs an entirely different user concept, this setting is relevant only for MS SQL Server.

Example: db.default.password = heiler

Page 45: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 45 of 58

11.3.1.8 db.default.dir.data

= Directory in which the physical databases (MS SQL Server) and tablespaces for data and indexes (Oracle) are to be created. When used in conjunction with a remote database, this directory is interpreted from the perspective of the database server, i.e. in this case the set-ting must be changed to a directory on the database server.

Example: db.default.dir.data = ${hcm.home}/db/data

11.3.1.9 db.default.dir.log (SQL Server)

= Directory in which the log files are to be created. When used in conjunction with a remote database, this directory is interpreted from the perspective of the database server, i.e. in this case the setting must be changed to a directory on the database server.

Example: db.default.dir.log = ${db.default.dir.data}

11.3.1.10 db.default.dir.index (Oracle)

= Directory in which the tablespaces for index files are to be created. When used in conjunc-tion with a remote database, this directory is interpreted from the perspective of the database server, i.e. in this case the setting must be changed to a directory on the database server.

Example: db.default.dir.index = ${db.default.dir.data}

11.3.1.11 db.default.dir.temp (Oracle)

= Directory in which the tablespaces for temporary tables are to be created. When used in conjunction with a remote database, this directory is interpreted from the perspective of the database server, i.e. in this case the setting must be changed to a directory on the database server.

Example: db.default.dir.temp = ${db.default.dir.data}

11.3.1.12 db.poolsize

= Number of maximum database connections used by the web container. Each single data

source configured below uses db.poolsize number of database connections.

Example: db.poolsize = 50

11.3.1.13 db.default.size (SQL Server)

= initial size of data files specified in Megabytes. Each database configured below uses this setting as a default.

Example: db.default.size = 128 Default database filesize = 128 MB

11.3.1.14 db.default.size.growth (SQL Server)

= Specifies the amount in Megabytes if the database file needs to grow. Each database configured below uses this setting as a default.

Page 46: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 46 of 58

Example: db.default.size.growth = 64 Default database growth = 64 MB

11.3.1.15 db.default.log.size (SQL Server)

= initial size of log files specified in Megabytes. Each database configured below uses this setting as a default.

Example: db.default.log.size = 128 Default database log filesize = 128 MB

11.3.1.16 db.default.log.size.growth (SQL Server)

= Specifies the amount in Megabytes if the database log file needs to grow. Each database configured below uses this setting as a default.

Example: db.default.log.size.growth = 64 Default database log growth = 64 MB

11.3.1.17 db.default.data.size (Oracle)

= initial size in tablespace for data files specified in Megabytes. Each schema configured below uses this setting as a default.

Example: db.default.data.size = 64 Default database filesize = 64 MB

11.3.1.18 db.default.data.size.extend (Oracle)

= Specifies the amount in Megabytes if the data file needs to grow. Each schema configured below uses this setting as a default.

Example: db.default.data.size.extend = 64 Default database growth = 64 MB

11.3.1.19 db.default.index.size (Oracle)

= initial size in tablespace for index files specified in Megabytes. Each schema configured below uses this setting as a default.

Example: db.default.index.size = 64 Default database log filesize = 64 MB

11.3.1.20 db.default.index.size.extend (Oracle)

= Specifies the amount in Megabytes if the index file needs to grow. Each schema configured below uses this setting as a default.

Example: db.default.index.size.extend = 64 Default database log growth = 64 MB

11.3.1.21 db.default.temp.size (Oracle)

= initial size in tablespace for temp files specified in Megabytes. Each schema configured below uses this setting as a default.

Example: db.default.temp.size = 64 Default database log filesize = 64 MB

Page 47: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 47 of 58

11.3.1.22 db.default.temp.size.extend (Oracle)

= Specifies the amount in Megabytes if the temp file needs to grow. Each schema configured below uses this setting as a default.

Example: db.default.temp.size.extend = 64 Default database log growth = 64 MB

11.3.1.23 db.default.bulkloader

= Path to the "bulkloader" of the database that is used by the BMEcat Import. In the case of an setup under MS SQL Server the associated bulkloader is included in the supplied pack-age, but for Oracle the standard SQL Loader of the Oracle client must be referenced.

Example for MS SQL Server: db.default.bulkloader =

${hcm.home}/import/Bulkload/bin/Release/Bulkload.exe

Example for Oracle / Windows: db.default.bulkloader = [path]/sqlldr.exe or [path]/sqlldr (for Linux)

[path] specifies the corresponding path to the setup directory on the Oracle client.

11.3.1.24 db.main.schema

= Logical name of the MAIN schema. For MS SQL Server, this logical schema is reflected in the form of a physical database with this name; for Oracle it is reflected as a corresponding user with that name.

Example: db.main.schema = HCM_MAIN

11.3.1.25 db.main.database

= Name of the database in which the logical MAIN schema is stored. Since the logical sche-mas for MS SQL Server are stored in separate physical databases, the names of the logical schemas match the name of the database exactly. On the other hand, for Oracle the various logical schemas are created as separate users within exactly one physical database, so that

in this case the database usually references the default setting db.default.database listed

above.

Example:

db.main.database = ${db.main.schema} (MS SQL Server)

db.main.database = ${db.default.database} (Oracle)

11.3.1.26 db.main.server

= IP address or server name of the database server for access to the logical MAIN schema (MS SQL Server = physical database, Oracle = corresponding user). The setting described

above, db.default.server is referenced here for both database types (MSSQL and

ORA92) by default.

Example: db.main.server = ${db.default.server}

11.3.1.27 db.main.port

= Port of the database server for access to the logical MAIN schema (MS SQL Server = physical database, Oracle = corresponding user). The setting described above,

Page 48: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 48 of 58

db.default.port is referenced here for both database types (MSSQL and ORA92) by de-

fault.

Example: db.main.port = ${db.default.port}

11.3.1.28 db.main.user

= Name of the user for access to the logical MAIN schema. In the case of MS SQL Server

this is the default user defined earlier db.default.user. With Oracle however, for which the

logical schemas are mapped as separate users, the MAIN user name exactly matches the

name of the logical MAIN schema that is db.main.schema.

Example:

db.main.user = ${db.default.user} (MS SQL Server)

db.main.user = ${db.main.schema} (Oracle)

11.3.1.29 db.main.password

= Password of the user for access to the logical MAIN schema. Here, the default password

db.default.password defined earlier is referenced by default for both database types

(MSQL2005 and ORA92).

Example: db.main.password = ${db.default.password}

11.3.1.30 db.main.dir.data

= Directory in which the data file of the physical MAIN database (MS SQL Server) or the tablespaces for data and indexes of the MAIN user (Oracle) are to be created.

The default directory defined earlier db.default.dir.data is referenced by default for both

database types.

Example: db.main.dir.data = ${db.default.dir.data}

11.3.1.31 db.main.dir.log (SQL Server)

= Directory in which the log file of the physical MAIN database is to be created.

The default directory defined earlier db.default.dir.log is referenced by default.

Example: db.main.dir.log = ${db.default.dir.log}

11.3.1.32 db.main.dir.temp (Oracle)

= Directory in which the tablespace for temporary tables of the MAIN user is to be created.

The default directory defined earlier db.default.dir.temp is referenced by default.

Example: db.main.dir.temp = ${db.default.dir.temp}

11.3.1.33 db.main.size (SQL Server)

= initial size of data files specified in Megabytes.The default size db.default.size is refer-

enced by default.

Page 49: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 49 of 58

Example: db.main.size = ${db.default.size}

11.3.1.34 db.main.size.growth (SQL Server)

= specifies the amount in Megabytes if the data file needs to grow. The default growth

db.default.size.growth is referenced by default.

Example: db.main.size.growth = ${db.default.size.growth}

11.3.1.35 db.main.log.size (SQL Server)

= initial size of log files specified in Megabytes.The default size db.default.log.size is

referenced by default.

Example: db.main.log.size = ${db.default.log.size}

11.3.1.36 db.main.log.size.growth (SQL Server)

= specifies the amount in Megabytes if the log file needs to grow. The default growth

db.default.log.size.growth is referenced by default.

Example: db.main.log.size.growth = ${db.default.log.size.growth}

11.3.1.37 db.main.data.size (Oracle)

= initial size in tablespace for data files specified in Megabytes. The default size

db.default.data.size is referenced by default.

Example: db.main.data.size = ${db.default.data.size}

11.3.1.38 db.main.data.size.extend (Oracle)

= Specifies the amount in Megabytes if the data file needs to grow. The default growth

db.default.data.size.growth is referenced by default

Example: db.main.data.size.extend = ${db.default.data.size.extend}

11.3.1.39 db.main.index.size (Oracle)

= initial size in tablespace for index files specified in Megabytes. The default size

db.default.index.size is referenced by default.

Example: db.main.index.size = ${db.default.index.size}

11.3.1.40 db.main.index.size.extend (Oracle)

= Specifies the amount in Megabytes if the index file needs to grow. The default growth

db.default.index.size.growth is referenced by default

Example: db.main.index.size.extend = ${db.default.index.size.extend}

Page 50: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 50 of 58

11.3.1.41 db.main.temp.size (Oracle)

= initial size in tablespace for temp files specified in Megabytes. The default size

db.default.temp.size is referenced by default.

Example: db.main.temp.size = ${db.default.temp.size}

11.3.1.42 db.main.temp.size.extend (Oracle)

= Specifies the amount in Megabytes if the temp file needs to grow. The default growth

db.default.temp.size.growth is referenced by default

Example: db.main.temp.size.extend = ${db.default.temp.size.extend}

11.3.1.43 db.supplier.schema

= Logical name of the SUPPLIER schema for storing supplier catalogs. For MS SQL Server, this logical schema is reflected in the form of a physical database with this name; for Oracle it is reflected as a corresponding user with that name.

Example: db.supplier.schema = HCM_SUPPLIER

11.3.1.44 db.supplier.database

= Name of the database in which the logical SUPPLIER schema is stored. Since the logical schemas for MS SQL Server are stored in separate physical databases, the names of the logical schemas match the name of the database exactly. On the other hand, for Oracle the various logical schemas are created as separate users within exactly one physical database, so that in this case the database usually references the default setting

db.default.database listed above.

Example:

db.supplier.database = ${db.supplier.schema} (MS SQL Server)

db.supplier.database = ${db.default.database} (Oracle)

11.3.1.45 db.supplier.server

= IP address or server name of the database server for access to the logical SUPPLIER schema (MS SQL Server = physical database, Oracle = corresponding user). The setting

described above, db.default.server is referenced here for both database types (MSSQL

and ORA92) by default.

Example: db.supplier.server = ${db.default.server}

11.3.1.46 db.supplier.port

= Port of the database server for access to the logical SUPPLIER schema (MS SQL Server = physical database, Oracle = corresponding user). The setting described above,

db.default.port is referenced here for both database types (MSSQL and ORA92) by de-

fault.

Example: db.supplier.port = ${db.default.port}

Page 51: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 51 of 58

11.3.1.47 db.supplier.user

= Name of the user for access to the logical SUPPLIER schema. In the case of MS SQL

Server this is the default user defined earlier db.default.user. With Oracle however, for

which the logical schemas are mapped as separate users, the SUPPLIER user name exactly

matches the name of the logical SUPPLIER schema that is db.supplier.schema.

Example:

db.supplier.user = ${db.default.user} (MS SQL-Server)

db.supplier.user = ${db.supplier.schema} (Oracle)

11.3.1.48 db.supplier.password

= Name of the user for access to the logical SUPPLIER schema. Here, the default password

db.default.password defined earlier is referenced by default for both database types

(MSQL2005 and ORA92).

Example: db.supplier.password = ${db.default.password}

11.3.1.49 db.supplier.dir.data

= Directory in which the data file of the physical SUPPLIER database (MS SQL Server) or the tablespaces for data and indexes of the SUPPLIER user (Oracle) are to be created.

The default directory defined earlier db.default.dir.data is referenced by default for both

database types.

Example: db.supplier.dir.data = ${db.default.dir.data}

11.3.1.50 db.supplier.dir.log (SQL Server)

= Directory in which the log file of the physical SUPPLIER database is to be created.

The default directory defined earlier db.default.dir.log is referenced by default.

Example: db. supplier.dir.log = ${db.default.dir.log}

11.3.1.51 db.supplier.dir.temp (Oracle)

= Directory in which the tablespace for temporary tables of the SUPPLIER user is to be cre-ated.

The default directory defined earlier db.default.dir.temp is referenced by default.

Example: db.supplier.dir.temp = ${db.default.dir.temp}

db.supplier.size and other sizing settings see 11.3.1.33 db.main.size (SQL Server) ff

11.3.1.52 db.um.schema

= Logical name of the UM schema (= User Management). For MS SQL Server, this logical schema is reflected in the form of a physical database with this name; for Oracle it is re-flected as a corresponding user with that name.

Example: db.um.schema = HCM_UM

Page 52: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 52 of 58

11.3.1.53 db.um.database

= Name of the database in which the logical UM schema is stored. Since the logical schemas for MS SQL Server are stored in separate physical databases, the names of the logical sche-mas match the name of the database exactly. On the other hand, for Oracle the various logi-cal schemas are created as separate users within exactly one physical database, so that in

this case the database usually references the default setting db.default.database listed

above.

Example:

db.um.database = ${db.um.schema} (MS SQL Server)

db.um.database = ${db.default.database} (Oracle)

11.3.1.54 db.um.server

= IP address or server name of the database server for access to the logical UM schema (MS SQL Server = physical database, Oracle = corresponding user). The setting described

above, db.default.server is referenced here for both database types (MSSQL and

ORA92) by default.

Example: db.um.server = ${db.default.server}

11.3.1.55 db.um.port

= Port of the database server for access to the logical UM schema (MS SQL Server = physi-

cal database, Oracle = corresponding user). The setting described above, db.default.port

is referenced here for both database types (MSSQL and ORA92) by default.

Example: db.um.port = ${db.default.port}

11.3.1.56 db.um.user

= Name of the user for access to the logical UM schema. In the case of MS SQL Server this

is the default user defined earlier db.default.user. With Oracle however, for which the

logical schemas are mapped as separate users, the UM user name exactly matches the

name of the logical UM schema, that is db.um.schema.

Example:

db.um.user = ${db.default.user} (MS SQL-Server)

db.um.user = ${db.um.schema} (Oracle)

11.3.1.57 db.um.password

= Name of the user for access to the logical UM schema. Here, the default password

db.default.password defined earlier is referenced by default for both database types

(MSQL2005 and ORA92).

Example: db.um.password = ${db.default.password}

11.3.1.58 db.um.dir.data

= Directory in which the data file of the physical UM database (MS SQL Server) or the table-spaces for data and indexes of the UM user (Oracle) are to be created.

Page 53: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 53 of 58

The default directory defined earlier db.default.dir.data is referenced by default for both

database types.

Example: db.um.dir.data = ${db.default.dir.data}

11.3.1.59 db.um.dir.log (SQL Server)

= Directory in which the log file of the physical UM database is to be created.

The default directory defined earlier db.default.dir.log is referenced by default.

Example: db.um.dir.log = ${db.default.dir.log}

11.3.1.60 db.um.dir.temp (Oracle)

= Directory in which the tablespace for temporary tables of the UM user is to be created.

The default directory defined earlier db.default.dir.temp is referenced by default.

Example: db.um.dir.temp = ${db.default.dir.temp}

db.um.size and other sizing settings see 11.3.1.33 db.main.size (SQL Server) ff

11.3.1.61 db.bulkload.schema

= Logical name of the BULKLOAD schema. For MS SQL Server, this logical schema is re-flected in the form of a physical database with this name; for Oracle it is reflected as a corre-sponding user with that name.

It should be remembered that for historical reasons MSSQL and ORA92 have different upper and lower case default settings.

Example: db.bulkload.schema = HCM_BULKLOAD

11.3.1.62 db.bulkload.database

= Name of the database in which the logical BULKLOAD schema is stored. Since the logical schemas for MS SQL Server are stored in separate physical databases, the names of the logical schemas match the name of the database exactly. On the other hand, for Oracle the various logical schemas are created as separate users within exactly one physical database, so that in this case the database usually references the default setting

db.default.database listed above.

Example:

db.bulkload.database = ${db.bulkload.schema} (MS SQL Server)

db.bulkload.database = ${db.default.database} (Oracle)

11.3.1.63 db.bulkload.server

= IP address or server name of the database server for access to the logical BULKLOAD schema (MS SQL Server = physical database, Oracle = corresponding user). The setting

described above, db.default.server is referenced here for both database types (MSSQL

and ORA92) by default.

Example: db.bulkload.server = ${db.default.server}

Page 54: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 54 of 58

11.3.1.64 db.bulkload.port

= Port of the database server for access to the logical BULKLOAD schema (MS SQL Server = physical database, Oracle = corresponding user). The setting described above,

db.default.port is referenced here for both database types (MSSQL and ORA92) by de-

fault.

Example: db.bulkload.port = ${db.default.port}

11.3.1.65 db.bulkload.user

= Name of the user for access to the logical BULKLOAD schema. In the case of MS SQL

Server this is the default user defined earlier db.default.user. With Oracle however, for

which the logical schemas are mapped as separate users, the BULKLOAD user name ex-

actly matches the name of the logical BULKLOAD schema that is db.bulkload.schema.

Example:

db.bulkload.user = ${db.default.user} (MS SQL Server)

db.bulkload.user = ${db.bulkload.schema} (Oracle)

11.3.1.66 db.bulkload.password

= Password of the user for access to the logical BULKLOAD schema. Here, the default pass-

word db.default.password defined earlier is referenced by default for both database types

(MSQL2005 and ORA92).

Example: db.bulkload.password = ${db.default.password}

11.3.1.67 db.bulkload.dir.data

= Directory in which the data file of the physical BULKLOAD database (MS SQL Server) or the tablespaces for data and indexes of the BULKLOAD user (Oracle) are to be created.

The default directory defined earlier db.default.dir.data is referenced by default for both

database types.

Example: db.bulkload.dir.data = ${db.default.dir.data}

11.3.1.68 db.bulkload.dir.log (SQL Server)

= Directory in which the log file of the physical UM database is to be created.

The default directory defined earlier db.default.dir.log is referenced by default.

Example: db.bulkload.dir.log = ${db.default.dir.log}

11.3.1.69 db.bulkload.dir.temp (Oracle)

= Directory in which the tablespace for temporary tables of the UM user is to be created.

The default directory defined earlier db.default.dir.temp is referenced by default.

Example: db.bulkload.dir.temp = ${db.default.dir.temp}

db.bulkload.size and other sizing settings see 11.3.1.33 db.main.size (SQL Server) ff

Page 55: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 55 of 58

11.3.1.70 db.ls.schema

= Logical name of the PBC schema for storing supplier catalogs. For MS SQL Server, this logical schema is reflected in the form of a physical database with this name; for Oracle it is reflected as a corresponding user with that name.

Example: db.supplier.schema = HBC

11.3.1.71 db ls.database

= Name of the database in which the logical PBC schema is stored. Since the logical sche-mas for MS SQL Server are stored in separate physical databases, the names of the logical schemas match the name of the database exactly. On the other hand, for Oracle the various logical schemas are created as separate users within exactly one physical database, so that

in this case the database usually references the default setting db.default.database listed

above.

Example:

db.ls.database = ${db.ls.schema} (MS SQL Server)

db.ls.database = ${db.default.database} (Oracle)

11.3.1.72 db.ls.server

= IP address or server name of the database server for access to the logical PBC schema (MS SQL Server = physical database, Oracle = corresponding user). The setting described

above, db.default.server is referenced here for both database types (MSSQL and

ORA92) by default.

Example: db.ls.server = ${db.default.server}

11.3.1.73 db.ls.port

= Port of the database server for access to the logical PBC schema (MS SQL Server = physi-

cal database, Oracle = corresponding user). The setting described above, db.default.port

is referenced here for both database types (MSSQL and ORA92) by default.

Example: db.ls.port = ${db.default.port}

11.3.1.74 db.ls.user

= Name of the user for access to the logical PBC schema. In the case of MS SQL Server this

is the default user defined earlier db.default.user. With Oracle however, for which the

logical schemas are mapped as separate users, the PBC user name exactly matches the

name of the logical SUPPLIER schema that is db.supplier.schema.

Example:

db.ls.user = ${db.default.user} (MS SQL-Server)

db.ls.user = ${db.ls.schema} (Oracle)

11.3.1.75 db.ls.password

= Name of the user for access to the logical PBC schema. Here, the default password

db.default.password defined earlier is referenced by default for both database types

(MSQL2005 and ORA92).

Page 56: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 56 of 58

Example: db.ls.password = ${db.default.password}

11.3.1.76 db.ls.dir.data

= Directory in which the data file of the physical PBC database (MS SQL Server) or the table-spaces for data and indexes of the PBC user (Oracle) are to be created.

The default directory defined earlier db.default.dir.data is referenced by default for both

database types.

Example: db.ls.dir.data = ${db.default.dir.data}

11.3.1.77 db.ls.dir.log (SQL Server)

= Directory in which the log file of the physical SUPPLIER database is to be created.

The default directory defined earlier db.default.dir.log is referenced by default.

Example: db.ls.dir.log = ${db.default.dir.log}

11.3.1.78 db.ls.dir.temp (Oracle)

= Directory in which the tablespace for temporary tables of the SUPPLIER user is to be cre-ated.

The default directory defined earlier db.default.dir.temp is referenced by default.

Example: db.ls.dir.temp = ${db.default.dir.temp}

db.ls.size and other sizing settings see 11.3.1.33 db.main.size (SQL Server) ff

11.3.1.79 db.repstore.schema

= Logical name of the REPSTORE schema for storing all report results, such as those gener-ated for example when navigating through the catalog tree, validations, product ranges etc. This schema applies only for Oracle, because report persistence for MS SQL Server is per-formed in file form.

Example: db.repstore.schema = HCM_REPSTORE

11.3.1.80 db.repstore.database

= Name of the database in which the logical REPSTORE schema is stored. Since the REP-STORE schema only applies for Oracle (see above), and for Oracle the various logical sche-mas are created as separate users within exactly one physical database, the default setting

db.default.database listed above is referenced by default.

Example:

db.repstore.database = ${db.default.database} (Oracle)

11.3.1.81 db.repstore.server

= IP address or server name of the database server for access to the logical REPSTORE

schema. The setting made earlier, db.default.server, is referenced by default.

Page 57: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 57 of 58

Example: db.repstore.server = ${db.default.server}

11.3.1.82 db.repstore.port

= Port of the database server for access to the logical REPSTORE schema. The setting

made earlier, db.default.server, is referenced by default.

Example: db.repstore.port = ${db.default.port}

11.3.1.83 db.repstore.user

= Name of the user for access to the logical REPSTORE schema. Since the REPSTORE schema only applies for Oracle (see above), and for Oracle the various logical schemas are created as separate users within exactly one physical database, the user name matches the

name of the logical schema exactly, that is db.repstore.schema.

Example:

db.repstore.user = ${db.repstore.schema} (Oracle)

11.3.1.84 db.repstore.password

= Password of the user for access to the logical REPSTORE schema. Here, the default

password db.default.password defined earlier is referenced by default.

Example: db.repstore.password = ${db.default.password}

11.3.1.85 db.repstore.dir.data

= Directory in which the tablespaces for data and indexes of the REPSTORE user are to be

created. The default directory db.default.dir.data defined earlier is referenced by de-

fault.

Example: db.repstore.dir.data = ${db.default.dir.data}

11.3.1.86 db.repstore.dir.temp

= Directory in which the tablespaces for temporary tables of the REPSTORE user are to be

created. The default directory db.default.dir.temp defined earlier is referenced by de-

fault.

Example: db.repstore.dir.temp = ${db.default.dir.temp}

db.repstore.size and other sizing settings see 11.3.1.13 db.default.size (SQL Server) ff

Page 58: Heiler Catalog Manager 3.2 Installation Manual Documentation... · 2016-07-24 · Installation Manual Heiler Catalog Manager 3.3 - Installation Manual Valid from Heiler Catalog Manager

Installation Manual – Heiler Catalog Manager 3.3

Date: April 18, 2013 Page 58 of 58

12 Appendix C: Trouble shooting

Getting exceptions at the front-end when trying to access an item list or any other report in the Heiler Business Catalog staging area the first time. Two potential errors:

Having a VM copied and renamed the server name – wrong internal server name of the SQL Server might cause the problem (see chapter 6.2.2 Microsoft SQL Server starting on page 11)

No images are displayed in the staging area even the images are at the place where thy have to be:

The JBoss Server Configuration is not correct (refer to page Fehler! Textmarke nicht definiert.) see the images path configuration in the chapter Fehler! Verweisquelle konnte nicht gefunden werden. Fehler! Verweisquelle konnte nicht gefunden werden..

Import says all items imported without errors, but you do not see any items:

Ensure that SQLXML4 is installed on the server where import is running.