Polarion Windows Installation - Siemens · Polarion Windows Installation 17.2 POL003 • 17.2. ... S i ngd soP l v. ... computer.Themoretotalmemory,themoreyoucanallocatetotheJVMbeforetheoperatingsystem

SIEMENSSIEMENSSIEMENS

Polarion WindowsInstallation 17.2

POL003 • 17.2

Contents

About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Evaluation installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Large-scale installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

System requirements and recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Server software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1Server hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2Client software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2Client hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

Additional Recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Libraries required for building the demo projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Enable email notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Enable support for Javadoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Before installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Java runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Install java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Install Polarion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

The Windows Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1What the installer can install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Disable firewall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Choose an installation type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Standard (Production) Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Services and license key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9Polarion components installed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9

Installation on Windows 8.1 or 10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10

Starting and stopping the Polarion server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Polarion shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Starting the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

Steps for starting the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2The Express startup shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3

Starting the Polarion sever as a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3Notes about running as a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3

Starting Polarion as a console application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4

POL003 17.2 Polarion Windows Installation 3

Contents

Shutting down the Polarion server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4

After Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Securing the Polarion activation application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1Adjusting server memory allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Java Virtual Machine memory limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Configuring PostgreSQL database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Optimizing the PostgreSQL database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

Changes to the Postgresql.conf file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Allowing remote connections to the PostgreSQL server (optional) . . . . . . . . . . . . . . . . . . 7-4

Enter an error reporting email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Licensing and activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1Using different license types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1Assigning named and concurrent users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1License usage log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2

Changing default system passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Change the default System Administrator password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1Changing the password for the SVN ‘polarion’ user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

Configuring OLE Object support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1Configuring Polarion for OLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1Polarion Preview Generator - Teamcenter Visualization Convert and Print Shop . . . . . . . . . . 10-2

Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2

Multiple repository setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

Subversion optimization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1

Accessing the portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1

Configuring Single Sign-on (SSO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1SAML SSO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1

SAML authentication procedure flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1Basic configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2Optional configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-4Other notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6

Kerberos SS0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7Authentication procedure flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7Prerequisites - Configuring the domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7Polarion configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9Configuring client browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11Authentication fallback for external users using Kerberos . . . . . . . . . . . . . . . . . . . . . . 14-14

4 Polarion Windows Installation POL003 17.2

Contents

Contents

Teamcenter SSO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-15Authentication procedure flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-15Prerequisites - TcSS configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-16Polarion Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-16

Other SSO considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17Subversion access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17Direct access to subversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17Features requiring special configuration in an SSO setup . . . . . . . . . . . . . . . . . . . . . . 14-18Subversion repository access during Polarion update . . . . . . . . . . . . . . . . . . . . . . . . . 14-18Internal log-on pop-up behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19Enable logging of SAML response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19Enable international file encoding support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19Kerberos Hints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-21

LDAP authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1

Next steps after installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1

Manually updating third party software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1

Manually Update the bundled third party software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1Update Subversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-2Update Apache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-3Update Java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-4

Uninstall Polarion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1

Technical support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19-1

APPENDIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1

Enabling email notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1Default parameters and settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20-1

Supported Microsoft Office® versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21-1

POL003 17.2 Polarion Windows Installation 5

Contents

Chapter 1: About this guide

OverviewWelcome and thanks for using Polarion.

This guide covers installation information and procedures for creating a production installation forall Polarion products based on the Polarion Application Lifecycle Management Platform. The list ofproducts covered by this guide currently includes:

• Polarion ALM™

• Polarion REQUIREMENTS™

• Polarion QA™

In general, the information is applicable to all of the above products. Any product-specific differencesare explicitly noted. The information covers both new installations and, where applicable, theupdating of existing installations.

This guide applies to installation of the above Polarion products on supported Microsoft Windows®operating systems.

If you want to install a product on a Linux system, see the separate Linux Installation document.(Download the PDF version from Polarion's website.)

Evaluation installationsIf you are installing Polarion for evaluation purposes, we recommend the Polarion ALM™ Trial Guide(Download the PDF version from Polarion's website.). It focuses on getting you up and runningwith an evaluation installation as quickly as possible, using the Evaluation install option of theWindows installer.

This is recommended for the initial stage of any evaluation.

POL003 17.2 Polarion Windows Installation 1-1

https://polarion.plm.automation.siemens.com/resources/download/polarion_install_guide_linux

https://polarion.plm.automation.siemens.com/hubfs/Docs/Guides_and_Manuals/Polarion_Trial_Guide.pdf


Large-scale installationsIf you need a large-scale server environment with multiple clustered servers and failover capabilities,multiple repositories and so forth, see the Polarion ALM™ Enterprise Setup document. (Downloadthe PDF version from Polarion's website.)

Topics covered there include:

• Requirements

• Installation use cases

• Configuring shared data

• Security options

• Using Resource Traceability in a cluster

1-2 Polarion Windows Installation POL003 17.2


https://polarion.plm.automation.siemens.com/resources/download/polarion_enterprise_setup_guide

Chapter 2: System requirements and recommendations

Server softwareRequirement Description

Operating System Microsoft Windows Server 2012 or 2016 (or any update release).

For evaluation purposes, you can use Microsoft Windows 8.1 or 10.

See Installation on Windows 8.1 or 10.

Only 64-bit versions are supported.Java RuntimeEnvironment

Java Platform, Standard Edition Development Kit 8 - Oracle JDK 8.

http://www.oracle.com/technetwork/java/javase/downloads/index.html

(See the Install Java section for step by step instructions.)

Note that OpenJDK 8 is not the same as Oracle Java 8 and is not officiallysupported. JAVA_HOME/bin should exist in the system paths.

Polarion only supports 64 bit versions of Java.Version ControlSystem

Subversion version 1.6.x, 1.7.x, 1.8.x, or 1.9.x:

http://subversion.apache.org/

If you are compiling Subversion yourself, compile using the –with-apsx orthe –with-httpd option.

Web Server Apache HTTPD server with mod_proxy_ajp and Subversion extension(WebDAV+SVN apache modules): http://httpd.apache.org/

In general, the Polarion server should run with whatever Apache version ispresent on a Windows system provided it is at least the minimum requiredversion (2.2), and mod_proxy_ajp and Subversion extension modules arealso installed.

Database Minimum: PostgreSQL version 8.4

Recommended: PostgreSQL version 9.2 or higher


http://www.oracle.com/technetwork/java/javase/downloads/index.html

http://subversion.apache.org/

http://httpd.apache.org/


Server hardwareRequirement Description

RAM• Minimum: 4 GB (gigabytes) for production installation.

• Recommended: 8 GB or more

Disk Storage Space

• Minimum: 10 GB

• Recommended: 40 GB or more

There is no hard and fast rule for disk storage space. The actual amountyou require depends on the number and size of projects managed withPolarion. The more projects, and the larger they are, the more disk storageyou require.

Client softwareRequirement Description

Operating System Any operating system that can run the supported web browsers withsupport for the Flash plugin (see below).

If the client user will use a Polarion product supporting data interchange withMicrosoft Office®, the client user must run a Windows operating systemcompatible with a supported version of the Microsoft Office application(s)used. For details, see Appendix: Supported Microsoft Office Versions .

Web Browser All you need to use Polarion is a web browser. The most current listof supported browsers and versions is provided in the Release Notessection of the README.html file, delivered in all download distributions ofall Polarion products.

Adobe Flash The Polarion web portal displays charts and other graphical data aboutPolarion-managed projects using Adobe Flash.

To view these properly using a web browser, the client computermust have Adobe Flash Player installed. You can download it free athttp://www.adobe.com/products/flashplayer/.

Client hardwareRequirement Description

RAM Minimum: 2 GB (4 GB recommended)Display Resolution Minimum: 1280 x 800 pixelsServer Connection Not less than 1 Mbit/s



http://www.adobe.com/products/flashplayer/

Chapter 3: Additional Recommendations

Libraries required for building the demo projectsThe items described here are not critical for running and evaluating Polarion. However, thecomponents described are needed to be able to fully utilize Polarion's capabilities.

The distribution contains several demo projects. Each of them needs its particular set of 3rd partylibraries to be correctly built and have the project reports generated. Any missing libraries areautomatically downloaded from the internet during project processing, so you may need a connectionto the internet when you first try building the demo projects or run reports for them.

Enable email notificationsThe Polarion server can send email notifications in response to various events in the system such asbuild completions and new work items. It can also notify users about external changes.

To enable Polarion to send out email notifications, you need to:

• Configure the SMTP server to be used by the Polarion server for sending emails. You can do thisfrom the Windows installer during the regular installation process (That is not the EvaluationInstallation), or after installation, but before starting Polarion server (see Appendix). You maywish to create a special account on your SMTP host for use with Polarion notifications.

• Provide a valid email address for each user in their user account. (Administration → UserManagement → Users.) This can be automated through user self-creation of accounts, orintegration with LDAP. See Help, Administrator’s Guide: Managing Users and PermissionsinPolarion's Help.

When this configuration is correctly set up, the system sends notification emails about various eventsaccording to the notification targets configuration. For information on configuring email notifications,see Help, Administrator’s Guide: Configuring Notifications.

If a work item is modified outside of the Polarion portal, for example manually in the SVN,email notifications are sent as if the modification occurred in the portal.

See also, Appendix: Enabling email notifications



Enable support for JavadocThe demo and your own projects can be configured to provide Javadoc reports.

Javadoc must also be enabled for the descriptors.xml file. Access it in the Repositorybrowser: Repository/.polarion/reports/descriptors.xml. Refer to comments within the in thedescriptors.xml for details on how to enable Javadoc.



Chapter 4: Before installation

Java runtimeYou need to have a supported version of Java installed on the computer that will run Polarion ALM.The installer program asks for the location of Java. JAVA_HOME/bin should exist in the system paths.

Due to licensing issues, Java is no longer bundled with Polarion.

It must be installed before running the Polarion installation Wizard.

(OpenJDK 8 is not the same as Oracle Java 8 and is not officially supported.)

Polarion only supports 64 bit versions of Java.

Use only Java 8: Older versions are no longer supported and Java 9 has not beentested.

Install java1. Go to the Java SE Development Kit 8 download page on Oracle’s website.

2. Read the Oracle Binary Code License Agreement for Java SE.

3. Click on Accept License Agreement to enter into the agreement with Oracle.

(Required to download the Java SE Development Kit installer.)

4. Select the appropriate operating system.


http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html


5. Double-click the downloaded file to launch the Java Install Wizard.

6. On the welcome window, click Next .

7. Leave the optional feature selection as it is and click Next.

8. The installer asks to confirm the installation folder. Click Next.

9. Once the Java installation is complete, click Close.



Chapter 5: Install Polarion

The Windows Installer

Overview

The installer for Windows® systems is a 64-bit Windows executable (.exe) file. The distribution filename contains the product name, version number, service release ID (if applicable), the processorspecification and .exe. For example:

PolarionALM_NNNN_SRN_x64.exe

Windows 64-bit distribution for Polarion.

… where NNNN is a Polarion version number (typically the year of the release) and SRN is a ServiceRelease number (which does not appear if the distribution is not for a Service Release).

What the installer can install

The Windows installer can be used for a new (clean) installation only. Installing an update for anexisting installation requires a different distribution archive. The installer program will advise you ofthis if it detects an existing installation.

Disable firewall

The installer program for Windows leads you step-by-step through the installation process.

If the computer is running a firewall, disable it or allow the Polarion installation to accessports. (Polarion will need to check for the availability of required ports.)

Choose an installation type

• Evaluation: Only intended for evaluation installations. All Polarion components are installed anddefault and simple values are used for ports, paths, and other configuration settings.

See Polarion® ALM™ Trial, for step by step “Evaluation” installation instructions. (Download thePDF version from Polarion's website.)

• Standard: Intended for production installations. This installation type allows you to select whichcomponents to install and to modify default installation parameters.

Recommended for actual or simulated for example, POC production installation.




Standard (Production) Installation

1. If the computer that you are installing Polarion on is running a firewall, disable it for the duration ofthe installation. This enables the installer to check for the availability of needed ports.

2. Copy the installer program file and the evaluation license file to the folder Polarion will be installedin. (The default c:\polarion is recommended.)

Java should be installed before running the Polarion installer.

3. Right-click the file and run as an Administrator.

4. On the welcome screen, click Next .

5. Enter a User Name and Company Name and click Next.

6. Select the Standard installation and location:



Install Polarion

If you change the default C:\Polarion installation path by clicking Browse;

Pick a location other than the Program Files folder.

7. Click Next.

8. Clear any unwanted optional ( ) features and click Next.

The installer inserts the path from the JAVA HOME environment variable.

Make sure that it points to the Jdk folder, not the jre folder.

(C:\Program Files\Java\jdk1.8.0_version#) by default.

9. Click Browse, navigate to the Java SE Development Kit 8 folder.


Install Polarion


10. Click OK, and then Next.

11. Click Install to begin the installation with the selected settings, or Back to change them.

12. Click Next when the screen above appears.



Install Polarion

13. Enter a Domain, Host and E-Mail.

Clear Type to have the Apache and Polarion services run as console applications.

• As services they run hidden in the background.

• As console applications, they appear in the Windows taskbar.

14. Enter the Polarion Port settings and click Next.


Install Polarion


15. Enter the PostgreSQL Password twice and click Next.

16. Enter the SMTP server address.

(Optional) To use SMTP Authentication, select the box and enter thefollowing:

• Account name: The SMTP account

• - Password / Retype password: The password used for the selected SMTP account.



Install Polarion

17. Confirm the configuration parameters. Click Back as needed to change any of the configurationsettings listed above or Next to continue.

18. The Polarion Server starts automatically.

(Unless Start Polarion Server and open its portal page) on the previous screen was cleared.

19. The Polarion README.html will launch in a tab of the default web browser.

(Unless View Readme file on the previous screen was unchecked.


Install Polarion


20. The Polarion logon page will launch in another browser.



Install Polarion

Services and license key

Three services will be started once the installation is complete and the Polarion license key isrequired for the first browser login session. Clients access the Polarion server through a web browserusing a designated URL.

Have your license key handy to activate Polarion once the installation is complete. SeeSIEMENS Licensing to obtain a license key. A Webkey account is required.

Polarion components installedComponent Description

Polarion binaries Files needed for Polarion to run.Demo projects Repository folders containing sample projects and data. Installation of

this component is recommended if you are evaluating Polarion. You maychoose to omit it for production installations.

Apache HTTP ServerYou should shut down any other Apache server you may berunning on the computer where you are installing Polarion.

Subversion The latest supported version at time of the Polarion release.Java SE JRE The Java runtime environment is needed by Polarion for a number of

different functions, including running Polarion itself. If you already have aninstallation of the same JRE version, you may opt not to install it. Polarionwill prompt you to specify the location of your existing Java JRE installation.

For evaluation purposes, it will be simplest to go ahead and install the JRE.You can uninstall Polarion after your evaluation period and the JRE willbe removed as well.

PostgreSQL SQL database used to process complex queries that retrieve data forreports, dashboards and so on.

Polarion programgroup in the startmenu(Optional)

A program group for Polarion in the start menu.

Polarion group icon onthe desktop (Optional.)

Desktop shortcut that opens the installed polarion shortcuts folder whichcontains shortcuts for starting and stopping Apache service and Polarionserver.

See Manually updating third-party software for information on what versions of bundled softwareare distributed with Polarion.


Install Polarion

https://salesforce.industrysoftware.automation.siemens.com/WebkeyLogin/Authenticate14?url=https://solutions.industrysoftware.automation.siemens.com/view.php?sort=desc&p=1&q=yamaguchi+polarion&file_type=html&i=002-7008868&k=0&o=0


Installation on Windows 8.1 or 10For evaluation purposes you can install Polarion on computers running Microsoft Windows 8.1 orMicrosoft Windows 10 (64-bit only).

For production use, it is important that you use a supported server operating system.

RunningWindows 8.1 in the desktop mode is required. Polarion’s Flash-based features, for exampleLivePlan, will not work, and various dialogs as well as Clipboard access is blocked if the Windows 8Metro interface is used.

Installing Polarion in the C:\Program Files or C:\Program Files (x86) folder is notrecommended.

Some components would not have the necessary read/write permissions by default.

We recommend that evaluators view the Polarion ALM Trial documentation.

(Download the PDF version from Polarion's website.)




Chapter 6: Starting and stopping the Polarion server

Polarion shortcutsThe installer provides the option of starting the Polarion server for the first time after installation. Lateron, you will need to know how to stop and restart the Polarion server manually.

The Windows installer creates and automatically configures a set of shortcuts that enable you tostart and stop the Apache service, start and stop the Polarion server, start and stop the integratedPostgreSQL database, and launch the web portal in the default browser. These are located in thefolder [POLARION_HOME]\polarion shortcuts. The installer places an icon on the desktop thatopens this folder in Windows Explorer.



Starting the server

Steps for starting the server

When starting the server, run the startup in the following sequence:

1. Start up Apache Service by clicking on the Start Apache Service shortcut.

2. Start PostgreSQL by clicking on the Start PostgreSQL shortcut.

3. Start up Polarion Server by clicking on the ( Start Polarion Server shortcut.

It is not necessary to start Apache Service again if it is already running. You can check if it is runningusing the Apache Monitor program.

($POLARION_HOME$\bundled\apache\bin\ApacheMonitor.exe).

The first time you start the Polarion server, you will see the following message in the console:

This is not an error message. On startup and on re-index operations, Polarion estimates and reportsthe amount of time the operation will take. You will see this estimate in the console and log file onsubsequent startups, but the first time, no data exists on which to base the estimate.

The following startup phases are reported in the console and log file:

• Platform startup

• Context recognition

• Context initialization

• Revisions processing

• Build artifacts recognition

• BIR inspection

• Data indexing

• Polarion startup



Starting and stopping the Polarion server

The Express startup shortcut

Click the Start Apache, PostgreSQL and Polarion Server to initiate all startup operations inthe correct sequence.

This shortcut should only be used to start Polarion when none of these services are running.

If you are unsure whether a service or process is running, click all of the following shortcutsbefore clicking Start Apache, PostgreSQL and Polarion Server.

• Shutdown Apache Service

• Shutdown Polarion Server

• Shutdown PostgreSQL Service

Starting the Polarion sever as a service

Overview

By default, Polarion Server is installed as a Windows service. The service name is Polarion. Theservice description is Polarion Server.

When Polarion is installed as a service, the shortcuts previously described are configured to run thenecessary executables with the required parameters so that Polarion is started as a service. Theshortcuts are the recommended way to start the Polarion Server. If you want to start the server fromthe command line, you can invoke the following after making sure the Apache service is running:C:\WINDOWS\system32\net.exe start Polarion

Notes about running as a service

When the Polarion service is started, parameters from the polarion.ini file, memory settings andso on, are not taken into account. So if you need to change polarion.ini and you run Polarion as aservice, you must reinstall the Polarion service after changes in polarion.ini are completed.

To do this, use the command line to first run:

1. C:\Polarion\polarion\service.bat -uninstall

2. And then run:

C:\Polarion\polarion\service.bat –install


Starting and stopping the Polarion server


Starting Polarion as a console applicationPolarion can be run as a console application by running the following in a Windows console window:

C:\Polarion\polarion\polarion.exe.

This file is provided mainly for backward compatibility. If you installed Polarion as a service,you should run it as such, as previously described.

Shutting down the Polarion serverWhen shutting down the server, use the following sequence:

1. Click the Shutdown Polarion server shortcut.

2. Click the Shutdown PostgreSQL Service database shortcut.

3. Click the Shutdown Apache Service shortcut.

It is not normally necessary to shut down the Apache Service if you just want to restartthe Polarion Server.

The Appendix provides reference information on the default Polarion parameters used by thePolarion installer for Windows.



Chapter 7: After Installation

Securing the Polarion activation applicationBeginning with version 2015, Polarion includes an activation application that makes it possible toinstall or update a license while the Polarion server is running, without the need to copy the licensefile manually to the target machine.

Access to this application is not initially protected by user name and password

For production use it is highly recommended to secure access to this application directly inthe Apache configuration.

Beginning with version 2015, there is a template Apache configuration file in the Polarion installationfolder: \polarion\polarion\install\polarion.activation.conf.template

To ensure that a user name and password is requested when accessing the activation application(\polarion\activate\online and \polarion\activate\offline):

1. Copy this file to the Apache configuration folder, on Windows usuallyC:\Polarion\bundled\apache\conf\extra\.

2. Rename it to remove the .template extension.

3. Open the file in any text editor and modify it according to the instruction comments provided.

The template configuration is prepared for both user file authentication (like Polarion uses forSubversion by default, with user passwords data in a file) and for authentication against anLDAP server.

In a multi-instance setup with a coordinator plus one or more instances that can beclustered, it is necessary to use this configuration only on the coordinator server. Theactivation application runs only on the coordinator. For additional information about thistype of setup, see the Polarion ALM Enterprise Setupdocumentaton . (Download the PDFversion from Polarion's website.)




Adjusting server memory allocationThe default installation on Windows uses a maximum memory allocation setting inC:\Polarion\polarion\polarion.ini of -Xmx640m (640 megabytes ), which is suitable memoryallocation for evaluation purposes but not for most production setups. Before beginning productionuse of a new installation, the server administrator should adjust the setting to use the capacity ofthe server to its full extent. Use MEGABYTES as the measure. For example, for 2 GB, specify–Xmx2000m.

You must reinstall the Windows Service after modifying the polarion.ini file. Make sure thePolarion server is not running, then run the utility:

C:\Polarion\polarion\service.bat -install

Java Virtual Machine memory limitIf you allocate too much memory for the Java Virtual Machine (JVM), the operating system will notinitialize it. Diagnosing the issue can be difficult because the service does not start and no error log iswritten. An entry is written to the Windows Application log with the description “Could not initializethe Java Virtual Machine” but the reason is not specified.

The amount of memory you can allocate to the JVM depends on how much total memory exists on thecomputer. The more total memory, the more you can allocate to the JVM before the operating systemimposes a limit. In tests on a 4 GB system, allocating 1.1 GB to the JVM resulted in failure to initialize.

Configuring PostgreSQL databaseThis component must be installed and properly configured before you can start the Polarion server.The Windows installer attempts to install the software and configure it to run with Polarion, includingsome optimization for best performance. If for any reason the installer is unable to optimizePostgreSQL, you should do it manually.



After Installation

Optimizing the PostgreSQL database

Changes to the Postgresql.conf file

Beginning with version 2015 SR2, Polarion integrates the PostgreSQL database in all newinstallations. After a new Polarion installation containing this database, it is highly recommended thatthe administrator review, and if necessary, adjust some PostgreSQL settings to optimize performance.

After installation you should make the following changes in postgresql.conf.

Default path: C:\Polarion\data\postgres-data\postgresql.conf

max_connections = 80 # should be < 10 * number of CPUs

shared_buffers = 2GB # should be 10% - 15% of total system RAM

work_mem = 10MB # should be 10MB - 100MB

maintenance_work_mem = 200MB

fsync = off

synchronous_commit = off

full_page_writes = off

wal_buffers = 256kB # should be more than size of common

# transaction

checkpoint_segments = 32

effective_cache_size = 4GB # should be approx 2/3 of total

# system RAM

max_locks_per_transaction = 100 # specific for Polarion

# Optimal planner performance setting

# For HDD, keep default setting. Otherwise, uncomment the

# applicable setting below:

# For SSD:

# random_page_cost = 1.5

# For SAN:

# random_page_cost = 2.0


After Installation


Allowing remote connections to the PostgreSQL server (optional)

By default the PostgreSQL database is only available on localhost after a fresh install. If you need tohave access from outside the host machine, follow these steps to allow remote access:

1. Change the listener addresses in the postgresql.conf file (see path above). Change:#listen_addresses='localhost' to listen_addresses='*'

2. In the same folder, you will find the pg_hba.conf file. Open it in a text editor and add thefollowing line: host all all 0.0.0.0/0 md5

If you allow external connection to the database, the external user has blanket access tothe entire database content and effectively to all Polarion data - all projects, the HEADrevision as well as history. There is no further access control. All Polarion user names willalso be visible. (User passwords will not be visible as those are not stored in a database orSVN.) Access is read-only.

Administrators are advised to consider carefully before opening database access ina system in use for production.

Enter an error reporting emailThe email for the error.report.email property in the polarion.properties file is empty by default fornew installations. Add the email you want error reports sent to.



Chapter 8: Licensing and activation

OverviewIn order to use Polarion you must obtain a license. A license with the necessary key and file isnormally delivered by email to the address provided by the person who purchased the license. Ifyou need help obtaining a license, contact [email protected].

Polarion installs with a 30-day evaluation license. After obtaining a license for production use, youmust activate your Polarion installation. The login page provides action options leading to online andoffline activation instructions. You will need the information provided by Polarion to complete theactivation.

Using different license typesSeveral different license types are available - Evaluation, Site, User-limited, etc. If you begin usingPolarion with one type of license key (Evaluation, for example), and want to continue using it with adifferent license type, simply remove the current license key file from the license folder and copythe new license key file there. If the Polarion server is running, you will need to restart it for the newlicense to take effect. You can install multiple license keys for different license types and/or Polarionproducts on the same server.

Assigning named and concurrent usersIf your license allows for named and/or concurrent users, you will need to add assignments for eachtype of user in the appropriate section of the users file. By default this file is located in the licensefolder of your Polarion installation. If you change the location for license key files, be sure to movethe users file to the same folder that stores your license key file.

You can edit it in the License topic in the global Administration in the portal. The file containscomments with complete instructions on how to find the user IDs of your named/concurrent users,and make the relevant assignments.


mailto:[email protected]


License usage log fileAdministrators and managers can monitor license usage by checking the licenseusage log file log4j-licensing-TIMESTAMP.log. This file is located in the [POLARIONHOME]\data\workspace\.metadata folder.

When a concurrent user logs on/off, a license usage statistics report is written to the licensing log.Concurrent licensing is not supported for all products.

The following example shows one user currently using an enterprise concurrent license type, thegreatest number of users of this license during the current server session (peak), and the maximumnumber of users allowed by the license limit.

2008-05-14 11:12:29,609 [TP-Processor2] INFO PolarionLicensing -STATS:enterpriseConcurrentUsers,current:1,peak:2,limit:20



Chapter 9: Changing default system passwords

Change the default System Administrator passwordTo help ensure the security of your Polarion system, you should change the default password of thesystem administrator user account described below, and in the Changing the password for theSVN 'polarion'' user section.

The default account System Administrator has access to all administrative functions of Polarion,including read-write access to the subversion repository. After installing Polarion for actual productionuse, you should change the password on the default system administrator account.

Before you change the password on the default system administrator account, you may wish to createanother account with administrator rights for yourself and/or someone else.

To change the default administrator password:

1. Log in to the Polarion portal with the default login. (username: admin, password: admin)

2. Click My Polarion. The My Polarion page for the System Administrator account loads in thecontent area.

3. Click on on the top right and click My Account.

4. In the My Account page click Edit.

5. Enter the new password in the New Password field, and again in the Re-enter Password field.

6. If you want to continue using this account as the main system administrator account, you maywish to add your email address in the Email field, and add a description for the account in theDescription field.

7. When finished editing the System Administrator profile, click Save. The password is nowchanged and you will need to use it next time you log in.

Do not lose the new password.

If you lose the changed password, you will not be able to log in as system administrator.If no other accounts exist with administrator rights, it will not be possible to change theconfiguration, add projects, manage user accounts, etc.



Changing the password for the SVN ‘polarion’ userA subversion repository user named polarion is created by default when you install Polarion. Thisuser acts on behalf of Polarion and has extensive permissions including read permission for allprojects. Access to this user by unauthorized users would compromise the security of your Polarionsystem, so change this password before putting the system into production use.

The following steps assume you use passwd file authentication, which is the most common method.

1. Stop the Polarion server before changing this password.

2. Use the htpasswd.exe to change the password for the polarion user. The utility is located in the[POLARION HOME]/bundled/apache/bin folder.

Utility syntax: htpasswd path/passwdfilename username.

Example: htpasswd Polarion\data\svn\passwd polarion.

3. Change the value of the password property in the polarion.properties file to thepassword you set with the htpasswd utility. The yypical location of this file ispolarion/configuration/polarion.properties.

FOR LDAP USERS

The typical setup for most Polarion users is passwd file authentication for the polarion userwith failover to LDAP for company users. This is also the default Polarion setup.

For such setups, you do not need to enter the polarion user to your LDAP users.



Chapter 10: Configuring OLE Object support

OverviewIt is possible to import Microsoft Word documents that contain OLE objects. Polarion can displayOLE Object thumbnails during Word document import. However, some additional third-party imageconverter software must be installed and configured before you can import such Word documents.OLE Objects in documents must contain their thumbnails in the .emf or .wmf file formats and theimage converter used must support their conversion into the .JPEG format. OLE Objects themselvesare not imported, only their thumbnails.

The recommended image converter software is ImageMagick. Windows distributionsare preconfigured for ImageMagick. An empty folder is provided on path [POLARIONHOME]\polarion\imagemagick which contains a README file describing what to download, how tounpack it and what to do next.

Configuring Polarion for OLEThere are some system properties in the common.properties system configuration file that you willneed to review and set after installing the image converter. Refer to comments in the section for thecom.polarion.oleconverter.app property that explain the settings.

There is an additional system property in the polarion.properties file thatspecifies the target image format for the OLE thumbnail conversion. Set thecom.polarion.oleconverter.convertedImageFormat=png property to have thumbnails converted to.PNG, or com.polarion.oleconverter.convertedImageFormat=jpg to have thumbnails convertedto the .JPEG format.

The system properties are located on the following path:

[POLARION HOME]\polarion\configuration\ (Windows), or [POLARION_HOME]/etc/ (Linux).


www.imagemagick.org/script/binary-releases.php


Polarion Preview Generator - Teamcenter Visualization Convert andPrint Shop

Configuration

Visit TeamCenter Visualization 11 to learn more about it.

The following Teamcenter Visualization Convert & Print configuration settings found in the [Prepare]section of the vvcp.ini file should also be adjusted:

The default path is:

[Teamcenter Installation Dir]\Visualization\VVCP\vvcp.ini

Adjust the following settings:

MainWindowState=hide

SingleProcess=off

Then follow the instructions for Teamcenter Visualization Convert & Print in the polarion.propertiesfile.



https://www.plm.automation.siemens.com/en_us/docs/tcv/11.shtml

Chapter 11: Multiple repository setup

If you use Polarion in a large enterprise with many users and projects, the standard single-repositoryinstallation may not be adequate. There are two Polarion features that enable you to work withmultiple repositories, but they are fundamentally different. You need to understand the basics of eachfeature before deciding which approach to multiple repositories best meets your needs.

The External Repository feature gives you the ability to link Polarion artifacts stored in Polarion’sintegrated repository with changes (revisions) in source code stored on one or more external SVN orGit repositories. After installation, you can configure Polarion to use one or more external repositoriesin addition to the SVN repository bundled and installed with Polarion. For information on this feature,see the Administrator’s Guide: Configuring Repositories in Polarion's Help.

The Clustering feature enables you to run Polarion on multiple servers, either physical, virtual, or acombination. The topography can be set up to host multiple Polarion servers running on separatemachines each with its own Polarion repository, and/or multiple machines all accessing a singlePolarion repository. (Polarion servers on any node can optionally be configured to access externalrepositories, as described above.)

Special installation and configuration procedures beyond the scope of this guide are required to setup a clustered multi-server environment. These are covered fully in Polarion ALM™ Enterprise Setup.(Download the PDF version from Polarion's website.)



Chapter 12: Subversion optimization

Polarion uses a Subversion (SVN) repository as its main data storage. There are two topics in theAdministrator's Guide component of Polarion online Help that provide guidance for administratorsabout optimizing Subversion for best performance. It is recommended that you review them beforegoing into production with a new or updated installation.

• Administrator's Guide → Advanced Administration: Topics → Optimizing Subversion inPolarion's Help.

• Administrator's Guide → System Maintenance: Topics → Maintaining Subversion (SVN) inPolarin's Help.


Chapter 13: Accessing the portal

Use the Open Polarion Web Portal , accessible by clicking on the desktop, to open the portallogin window in your default web browser after all system components are running.

The first time you log on after installation, use the default system administrator credentials:

• User ID: admin

• Password: admin

If the installation is not yet licensed and activated, the login screen first asks you to choose betweenrunning with the built-in evaluation license, and activating the installation with a production license.

See Licensing and activation for additional information.


Chapter 14: Configuring Single Sign-on (SSO)

OverviewThis section describes SSO authentication methods and configurations for Polarion. Polarionsupports authentication using Security assertion markup language 2.0 (SAML), Kerberos tokens andTeamcenter security services in addition to the existing authentication methods.

SAML SSO

SAML authentication procedure flow

Polarion supports the standard Security Assertion Markup Language (SAML 2.0).

The authentication procedure flow is as follows:

1. The client machine connects to Polarion and if a user is not authenticated, Polarion redirectsthem to the Identity Provider (IdP).

2. The user then needs to be authenticated in the IdP to obtain a SAML response.

3. The IdP will then redirect them back to Polarion.

4. The browser provides this SAML response when negotiating the Polarion authentication window.

5. The Polarion server then validates the SAML response based on SAML assertions.

6. If Polarion successfully validates all the assertions, it authenticates the user and logs them in.

For more info and the glossary see the following links:

• SAML Technical Overview

• SAML Glossary

Prerequisites

The following prerequisites are required in order to configure Polarion to authenticate using SAML:

1. A standard IdP needs to be installed on the network and connected to the company'sdirectory service or another source. (This Guide will use the Microsoft ADFS as anexample). IdP needs to be installed and available to the client machines on, for example,https://saml-server.yourdomain.com/adfs/ls.

2. The Polarion and IdP machines need to be configured for the HTTPS protocol. SeeAdministrator's Guide→ Configuring SSL Suport in Polarion's Help for details.


https://www.oasis-open.org/committees/download.php/27819/sstc-saml-tech-overview-2.0-cd-02.pdf

https://docs.oasis-open.org/security/saml/v2.0/saml-glossary-2.0-os.pdf


Basic configuration

Polarion configuration

Before configuring Polarion to use SAML SSO you need to enable Auto-Create in Polarion.

1. Go to Global Administration in Polarion. First click on the top left.

(Then Administration→ Global Administration→ User Management.)

2. Click Auto-create and check Enable Auto-create.

3. Set the Global Rules given to newly created users.

When SAML SSO is turned ON, you will only be able to login via the IdP. Thereforeyou should either create a User with admin rights that has the same User ID that theIdP will use, or add the admin Role to the Global roles for auto-create, and then afterlogging in via SAML SSO for the first time change the Global roles.

Logon via SAML SSO changes the passwords for these users, so it is advisable toleave at least one user with admin rights that will not be used by SAML SSO.

(Just in case you turn SAML SSO off in the future.)

Add Properties to the poloarion.properties file:

1. Configuring Polarion to use SAML authentication requires setting the following property thatenables the SAML logon:

com.siemens.polarion.security.auth.method=saml located at:

Windows: C:/Polarion/polarion/configuration/polarion.properties

Linux: /opt/polarion/etc/polarion.properties

2. And then depending if you are using the metadata:

a. If you want to use IdP Metadata, set these properties:

com.siemens.polarion.security.saml.identityProviderMetadataUrl=<Url to the IdPMetadata, for example:

"file:///C:/Path/FederationMetadata.xml" or if youhave the metadata available on remote machine:"https://saml-server.yourdomain.com/FederationMetadata/2007-06/FederationMetadata.xml"> - the file protocol is recommended for metadata configuration.

(You don't need to worry about the certificate. It should be located within the Metadata.)

You can always overwrite the settings in Metadata by manually specifying otherproperties. (See the list of properties in the next step.)



Configuring Single Sign-on (SSO)

b. If you do not have access to the IdP Metadata, you can specify the SSO Service URL manuallyby using the following property: com.siemens.polarion.security.saml.ssoServiceUrl=<YourIdP Service URL, e.g "https://saml-server.yourdomain.com/adfs/ls">.

If you do, you must also provide the certificate file needed for SAML assertion validationthat needs to be exported from the IdP. By default, you should export the certificate to the%POLARION_HOME%\polarion\configuration folder. You can specify a different path to acertificate using the com.siemens.polarion.security.saml.certificatePath property.

The other properties have these default values and should work implicitly, but you can alsospecify them if you need to:

com.siemens.polarion.security.saml.relyingPartyIdentifier=<Polarion base.url>

com.siemens.polarion.security.saml.assertionConsumerServiceUrl=<Polarionbase.url>/polarion/>

com.siemens.polarion.security.saml.issuer=<IdentityProviderUrl base.url>

com.siemens.polarion.security.saml.forceAuthn=false

com.siemens.polarion.security.saml.certificatePath=<By default a certificate in theconfiguration folder is used>.

3. After setting the properties, restart the Polarion Service, and the SAML SSO should be working.

IdP configuration

Identity provider must be properly configured to communicate with Polarion correctly.

• To do this, you need to configure the Relying Party Identifier for Polarion in the IdP registry, soit points to Polarion's server base url (for example, https://polarion.yourdomain.com, without/polarion at the end).

• If the IdP configuration wizard supports auto-configuration using SAML metadata, anadministrator can point to the Polarion endpoint that exposes this metadata. They are availableat the following url:

https://polarion.yourdomain.com/polarion/saml2/sp/metadata

Metadata will be accessible only when Polarion is run with the following property in thepolarion.properties file.

com.siemens.polarion.security.auth.method=saml

• The IdP must be configured to send the ID in the "Name ID" attribute. This attribute is thenused by Polarion as the User ID.




ADFS Example:

1. In ADFS, go to the relying party trusts folder and add a new relying party trust.

2. A wizard opens and takes you through the configuration. You can use the Polarion metadatamentioned earlier, or a manual configuration, using the https://polarion.yourdomain.com as theRelying SAML 2.0 SSO service URL and the Relying party trust identifier.

3. After the set up is complete, you should be prompted to add a Claim rule. If not, you can alwaysright click on your Relying Party Trust and edit the claim rules from there.

4. When adding the Claim rule, choose "Send LDAP Attributes as Claims" and configurethe mapping to send an LDAP attribute as a "Name ID" attribute. For example,"SAM-Account-Name" → "Name ID"

This is the minimum that needs to be configured on the IdP side for SAML SSO to work with Polarion.For more options, see the Optional configuration section.

Optional configuration

The properties configured in the Basic configuration are sufficient for Polarion to work with SAMLSSO, but there are additional optional features that Polarion Supports.

Single Logout

To enable Single logout via the IdP, you need to configure the following properties:

1. com.siemens.polarion.security.saml.sloServiceUrl=<a link to your IdP logout service,

for example, "https://saml-server.yourdomain.com/adfs/ls/?wa=wsignout1.0">

2. com.siemens.polarion.security.ssoHomePageUrl=<a link to your IdP Home Page,

for example, "https://saml-server.yourdomain.com/adfs/ls/IdpInitiatedSignOn.aspx">

The sloServiceUrl property is the URL to that Polarion sends the logout response to.

The HomePageUrl is just a link that appears when you log out from Polarion, so that you can continueto your IdP where you can logout from SSO. (Polarion only supports IdP Initiated Single Log-out.)

You also need to configure your IdP accordingly. The link you need to provide to your IdP is:

https://polarion.yourdomain.com/polarion/login/logout

ADFS Example- To set up Single Logout in ADFS:

1. Open ADFS.

2. Open your Relying Party Trust.

3. Select the Endpoints tab and click Add SAML...

4. Select the SAML Logout type, and;

a. Set the Trusted URL to https://polarion.yourdomain.com/polarion/login/logout

b. Set the Response URL to https://saml-server.yourdomain.com/adfs/ls/?wa=wsignout1.0




5. Set the following properties in Polarion's polarion.properties file:

com.siemens.polarion.security.saml.sloServiceUrl=https://saml-server.yourdomain.com/adfs/ls/?wa=wsignout1.0

com.siemens.polarion.security.ssoHomePageUrl=https://saml-server.yourdomain.com/adfs/ls/IdpInitiatedSignOn.aspx

Synchronization of attributes

You can configure SAML to send more attributes than just the Name ID. In Polarion, the userattributes that can be automatically updated from the SAML response are Name, Email andDescription. You can configure the names of the SAML attributes used to fill these user attributes byusing these three properties:

• com.siemens.polarion.security.saml.userMapping.name=<name of the SAML attribute,default is "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name">

• com.siemens.polarion.security.saml.userMapping.email=<name of the SAML attribute,default is"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress">

• com.siemens.polarion.security.saml.userMapping.description=<name of SAML attribute,

by default it is empty (nothing will be filled in description if this property is not set up)>

By default the Name and Email attributes are set to the names used by ADFS. However "description"is not set to any SAML attribute by default and you need to specify the attribute to be used there.

The attributes will be updated with every Log on to Polarion, but if the received SAMLdata is empty, there will be no change in the User attributes. (If a user does not have, forexample, the e-mail filled in in the IdP, you can fill it in manually in Polarion and it will not besaved as empty upon logon). You can check the main log to see the SAML response ifyou have trouble with the exact name of the SAML attribute. (See the Enable logging ofSAML response section for details. )

ADFS example- In ADFS

1. Open Relying Party Trusts, right click on your application and select Edit claim rules.

2. Here you can either edit an existing rule, or add a new one.

3. You will need to add mapping for attributes you want to be sent, for example: "E-Mail Addresses"→ "E-Mail Address"; "Display-Name"→ "Name"; "Department"→ "Role", and then save therule.

4. Since the UserMapping properties for Name and Email in Polarion are set for ADFS by default,you don't need to configure them. You need to configure the Description property however, so inour example you will need to add this property into the polarion.properties file:

com.siemens.polarion.security.saml.userMapping.description=http://schemas.microsoft.com/ws/2008/06/identity/claims/role




5. After restarting Polarion and logging in as a User, the Name, E-mail and Description will befilled with the "Display-Name", "E-mail Addresses" and "Department" attributes from AD.

You can choose different attributes while setting up the claim rules, and then change the Polarionproperties accordingly.

Alternative log on

If you want to use a different User ID in Polarion than the one that is sent via SAML (for example youhave existing Users in Polarion with different IDs than their Account Names in AD), you can configuresending different IDs in your IdP, if it supports it. You can also use the alternative ID Polarion property.You can map a SAML attribute to this property, and Polarion will use this SAML attribute as the UserID, but only if it is not empty, otherwise it will still use the "Name ID" SAML attribute.

com.siemens.polarion.security.saml.userMapping.alternativeId=<name of the SAML attributethat will be used as the User ID if it is not empty>

The attribute you will use as the alternative Login ID needs to be unique for your users,otherwise users with different IdP Account names, but with the same content in theAlternative ID attribute, will be logged on as the same Polarion User. Additionally, if youwant to use E-Signatures in Polarion, it is not recommended to use the Alternative IDfunction. If there is no other way, you need to configure LDAP correctly with the alternativeID. See the E-signature section for details.

Other notes

Permissions to log on

Polarion will always auto-create a user with configured roles when it recieves a valid SAML responsewith a new User ID. If you need to deny some of your SSO users access to Polarion, set thepermissions in your IdP. If Polarion receives a invalid or denial response it will not create the new User.

E-Signatures with SAML

Since IdPs do not support logging on in an IFrame, it is not possible to use E-Signatures in Polarionwith only SAML authentification configured. To use E-Signatures with SAML SSO you need toconfigure LDAP E-Signatures. See User Guide → 15. Working with Documents → SigningDocuments → In an SSO Environment in Polarion's Help for details.

Since E-Signatures validate the signature based on the Polarion User ID and the specifiedID used by LDAP, you need to make sure that they match. If you use a different attributethan the Account ID in the SAML set up, you will need to configure LDAP to the sameattribute. It is therefore not recommended to use the alternative ID when you want touse E-Signatures.




Kerberos SS0

Authentication procedure flow

Polarion supports standard Kerberos v5 authentication using the GSS-SPNEGO mechanism.

The authentication procedure flow is as follows:

1. The client machine logs into the domain and obtains a Kerberos token.

2. If the browser is configured to use the Kerberos token for authentication, the browser sends thistoken when negotiating authentication with a site that is a member of the same domain.

3. The Polarion server gets the token from the client and validates it against the domain controller.

4. If the domain controller successfully validates the token, Polarion authenticates the user andlogs them in.

Prerequisites - Configuring the domain

A set of prerequisites is required in order to configure Polarion to authenticate using Kerberos tokens:

1. All involved machines need to be members of the same domain for example, yourdomain.com

a. Domain server (kdc.yourdomain.com) that hosts KDC (Key Distribution Center) and DNSservices.

b. Domain users (for example, user1) that log into client machines.

c. Polarion service provider (for example, polarion-server.yourdomain.com) that represents theserver running Polarion.




2. Client and Polarion machines need to have corresponding domain accounts (principals):

Domain user: [email protected]

Polarion service: HTTP/[email protected]

3. Client browsers are configured for Kerberos authentication.

4. A keytab file with the password key for the Polarion service principal needs to be generatedon the domain server.

a. On Windows run the following command as an administrator on your domain server.

ktpass -out polarion.keytab -princ HTTP/[email protected]

-mapuser polarion-server -kvno 0 -crypto AES128-SHA1 -pass password.123 -ptype

KRB5_NT_PRINCIPAL

b. On Linux run the following command as a root user on your Domain server replacingyourdomain with your own.

ktadd -norandkey -k /tmp/polarion-server.keytab

HTTP/[email protected]

See the example to follow and refer to the correct values for each ktpass command attribute.

Notes:

• The HTTP service component in the principal name is required, otherwise a Kerberosauthentication with the polarion-server will not work.




• The Polarion service provider principal must contain the fully qualified domain name of themachine's (FQDN).

• Polarion's Kerberos SSO authentication requires that principals use AES 128 bit encryption.

1. In the Windows domain, all user accounts must have the following configuration checked:

Properties→ Account→ Account options→ This account supports Kerberos AES128 bit encryption.

2. In the Linux realm, the encryption needs to be set properly when adding the followingprincipal:

For example:

addprinc -e aes128-cts -randkeyHTTP/[email protected]

3. The DES encryption type is not considered secure, so it is not allowed in the defaultconfiguration of many operating systems.

• The generated keytab needs to respect this configuration as well, so make sure to set the -cryptooption below so that it’s in line with the principal configuration.

• Kerberos always passes the sAMAccountName attribute as the user's principal name, so thisfield also represents the userId in Polarion. If you need to synchronize additional user attributesfrom LDAP, please refer to the Administrator's Guide → Managing Users & Permissions →Configuring Polarion for LDAP User Synchronization section in Polarion's Help.

Polarion configuration

Polarion configuration consists of a few simple steps:

1. Copy the generated polarion.keytab file to the Polarion server under Polarion's configurationdirectory.

2. On the Polarion server, create a login.conf file in Polarion's configuration directory with thefollowing data:

Polarion {

com.sun.security.auth.module.Krb5LoginModule required

doNotPrompt=true

principal="HTTP/[email protected]"

useKeyTab=true

keyTab="C:/Polarion/polarion/configuration/polarion-server.keytab"

};

3. Configure Polarion to use SPNEGO authentication and set the following properties in:

C:/Polarion/polarion/configuration/polarion.properties

com.siemens.polarion.security.auth.method=spnego




java.security.krb5.realm=YOURDOMAIN.COM

java.security.krb5.kdc=kdc.yourdomain.com

java.security.auth.login.config=C:/Polarion/polarion/configuration/login.conf

Once you have successfully configured the domain, the domain server, the domain client and thePolarion server, users will not see the Polarion login page, but will be immediately authenticated usingthe provided Kerberos token and logged into Polarion as the same user with same login ID.




Configuring client browsers

All currently supported browsers (found in the Release Notes section of the README.html file),can be configured to use Kerberos authentication with Polarion.

Internet Explorer 11, Chrome and Edge on Windows

All currently supported browsers (found in the Release Notes section of the README.html file), canbe configured to use Kerberos authentication with Polarion.

The above browsers are configured via Internet Options.

(Accessible from either the Windows Control Panel, or via Internet Explorer settings.)

1. Enable Integrated Windows Authentication in Internet Options → Advanced → Security.

2. Ensure that your Polarion server is a member of the Local intranet sites in

Internet Options → Security→ Local intranet→ Sites.

a. Check Include all local (intranet) sites not listed in other zones.

b. Add it explicitly among the site on the Advanced tab.



https://ping.force.com/Support/PingFederate/Integrations/How-to-configure-supported-browsers-for-Kerberos-NTLM#ie





Chrome on Linux

1. Create a directory /etc/opt/chrome/policies/managed/ and within it drop a JSON file such asyourdomain.com.json with the following contents:

{ "AuthServerWhitelist": "*.yourdomain.com",

"AuthNegotiateDelegateWhitelist": "*.yourdomain.com" }

2. Run Google Chrome.

3. Open your Polarion URL http://polarion-server.yourdomain.com/polarion and the user is loggedinto Polarion automatically.

Firefox

1. Open Firefox settings by typing about:config in the address bar.

2. Locate the following preferences:

network.negotiate-auth.trusted-uris

network.automatic-ntlm-auth.trusted-uris

3. Set them by double-clicking (or right clicking and selecting Modify) to the name of your domain,or the Polarion server’s hostname (e.g. polarion.yourdomain.com).




Authentication fallback for external users using Kerberos

A typical setup for enterprise customers has two user types with different authentication methods:

• Internal Users: Operate from within the network and are authenticated in the domain.

• External Users: Customers or contractors who are not authenticated in the domain, but accessthe internal network via a VPN connection.

Polarion supports both user types while still leveraging the benefits of SSO.

Administrators can set up an authentication fallback in a Kerberos SSO environment.

When the authentication fallback is configured, users are presented with the standard Polarion loginscreen when they do not provide a Kerberos authentication token.

Configure the Authentication fallback:

1. Setup Polarion for Kerberos.

2. Configure the connection to the same LDAP server used to authenticate users in the Kerberosvia LDAP Configuration administration.

3. Set the following property to true in the polarion.properties file.

com.siemens.polarion.security.auth.fallback=true

When using Internet Explorer, Edge or Chrome, users may be prompted for credentials ifthe Use Integrated Windows Authentication option is enabled in Internet Options andPolarion is configured for Kerberos SSO. If a user cannot be authenticated in the domain toget the correct Kerberos ticket, then they can simply discard the prompt for credentialsthree times and will then be redirected to the Polarion login screen.




Teamcenter SSO

Authentication procedure flow

Polarion supports Teamcenter Security Services (TcSS) authentication.

The authentication procedure flow is the following:

1. The client machine connects to Polarion and if a user is not authenticated, Polarion redirectsthem to the TcSS login service.

2. A user needs to be authenticated in TcSS to obtain an SSO token and then the TcSS loginservice redirects them back to Polarion.

3. The browser provides this SSO token when negotiating the authentication with Polarion.

4. The Polarion server validates the token with the TcSS identity service.

5. If the identity service successfully validates the token, Polarion authenticates the user and logsthem in.




Prerequisites - TcSS configuration

A set of prerequisites is required in order to configure Polarion to authenticate using TcSS tokens:

1. Teamcenter Security Services needs to be installed on the network and connected to thecompany's directory service. See the Security Services Installation/Customization documentation.

2. The following services need to be installed and accessible by the Polarion server and clientmachines:

-SSO Login Service on e.g. http://tcss.yourdomain.com/ssoLogin

-SSO Service on e.g. http://tcss.yourdomain.com/ssoService

3. Configure an application ID, for example PolarionProd, for Polarion in the Identity Service registry,that points to the Polarion server’s hostname.

(http://polarion.yourdomain.com/)

Do not append /polarion - just point to the root.

4. Check that these services work correctly as described in the installation documentation aboveand that a user is able to login at http://tcss.yourdomain.com/loginservice.

Polarion Configuration

Configuring Polarion to use TcSS authentication only requires that the following system properties areset in the system configuration file:

/opt/polarion/etc/polarion.properties

com.siemens.polarion.security.auth.method=tcss

com.siemens.polarion.security.tcsso.serviceUrl=http://tcss.yourdomain.com/ssoService

com.siemens.polarion.security.tcsso.loginUrl=http://tcss.yourdomain.com/ssoLogin

com.siemens.polarion.security.appId=Polarion (The default value is “Polarion”.)

Once you have successfully configured the TcSS services and the Polarion server, users will not seePolarion's login page, but will be immediately redirected to the TcSS login page where they can entertheir credentials. After authenticating in TcSS, an SSO session will be created and users will beredirected back to Polarion and logged in as the same user with the same login ID.



https://support.industrysoftware.automation.siemens.com/docs/teamcenter/10.1/PDF/en_US/tdocExt/pdf/security_services_install_customization.pdf


Other SSO considerations

Subversion access

All primary Polarion data is stored in the Subversion repository. In order to ensure the traceabilityof commits to their authors, the ability to write to the Subversion still needs to be subject toauthentication, even when SSO authentication is used with Polarion.

Because subversion does not support standard SSO mechanisms, Polarion manages the credentialsin the subversion passwd file for SSO authenticated users.

The following requirements on subversion access need to be met for SSO authentication setup:

1. Polarion is configured to access the Subversion repository on behalf of users via thehttp protocol by default. This configuration is controlled by the following system property:repo=http://polarion-server.yourdomain.com/repo

2. Apache needs to use file authentication, like the passwd file, for the repository location as theprimary authentication source. This is configured in thepolarionSVN.conf file of the Apacheconfiguration.

<Location /repo>

…

AuthBasicProvider file

</Location /repo>

3. The Polarion configuration needs to point to Apache's passwd file via the following systemproperty: svn.passwd.file=$[com.polarion.data]/svn/passwd

A Polarion update sometimes requires direct access to the Subversion repository in orderto adjust or add new configuration files. For this purpose, you will need at least one userwith direct access to the repository using known credentials in the password file.

Direct access to subversion

For direct access to the subversion repository via the existing /repo location, configure this location toonly authenticate via LDAP by removing the file authentication directive from:

[Apache configuration]/conf/extra/polarionSVN.conf.

<Location /repo>

...

AuthBasicProvider file ldap

...

</Location /repo>

Then configure a second access location for internal Polarion access that will use the authenticationvia the password file that is being managed by Polarion.

<Location /repo-internal>




# Enable Web DAV HTTP access methods

DAV svn

# Repository location

#SVNPath "C:/Polarion/data/svn/repo"

# Write requests from WebDAV clients result in automatic commits

SVNAutoversioning on

# Our access control policy

#AuthzSVNAccessFile "C:/Polarion/data/svn/access"

# No anonymous access, always require authenticated users

Require valid-user

# How to authenticate a user. (NOTE: Polarion does not currently support HTTP Digest #

access authentication.)

AuthType Basic

AuthName "Subversion repository"

#AuthUserFile "C:/Polarion/data/svn/passwd"

AuthBasicProvider file

</Location>

Features requiring special configuration in an SSO setup

In a typical SSO setup, access to the server needs to be authenticated by a secure token. If thereare also clients that are not able to obtain this token, Polarion provides a fallback authentication viacredentials that need to be explicitly allowed for the following features. As a prerequisite, Polarionneeds to be connected to the LDAP server to validate the user credentials.

1. Access to webservices from external client in SSO environment.

2. e-signatures in Kerberos SSO environment.

Subversion repository access during Polarion update

In some cases the Polarion update script does changes to the subversion repository if there arenew required configuration files, or a modification of the existing configuration is required. Theadministrator executing the update needs to provide the credentials of a user that is capable ofcommitting these changes to the subversion repository.

At least one service account registered in the subversion's password file with a known password andwith write access to all projects in the repository is required. A new user account can be added to thesubversion password file using the htpasswd tool provided with Apache.

Use this account to commit the changes to the subversion repository during the update.




Internal log-on pop-up behavior

In case of SAML SSO and TeamCenter SSO the logging process is redirected to the IdP login or theTeam Center Login. Since it may be a security issue to embed the login page in the internal loginpopup IFrame, by default, TC and SAML SSO have internal login in IFrame disabled. This means,that the popup will prompt you to log in in a new tab, which will then close and you can continueworking in the original tab.

However, if for any reason you want to enable the login form in the internal login popup, you canset this property in the polarion.properties file:

com.siemens.polarion.security.disableIFrameLogin=false

Before setting this property, make sure you IdP support the login form in an IFrame. Forexample, ADFS does not support this, and so it will be not possible to log in via internalpopup if the IFrame is disabled.

Troubleshooting

SSL

To connect to the Polarion server using an HTTPS connection, make sure that Java trusts thecertificate used to encrypt the communication. This especially applies to the Teamcenter SecurityServices Setup, Where the TcSS web application is deployed to Tomcat that runs on Java.

(See the Importing a Certificate to the Java Keystore section in Polarion's Help for details.)

Enable logging of SAML response

It may prove useful during the configuration of SAML SSO to be able to see the response send topolarion from IdP. To enable logging of this response, add this line to log4j.properties file located in<Polarion_installation_folder>\polarion\plugins\org.apache.log4j_1.2.17.2015-05-04

log4j.logger.com.polarion.platform.internal.security.auth.saml.SamlLoginClient=DEBUG,A1

After restarting Polarion, the SAML response will be visible in the main logs.

Enable international file encoding support

Support for national characters in usernames may require additional configuration. By default,Polarion encodes the Apache passwd and access files using the default Java file encoding, thatmatches the default OS system encoding. This default encoding may not be compatible with thecharacter set used in LDAP. To discover what this default is set to, check for the file.encodingproperty, for example file.encoding=Cp1252 for Windows, in the Polarion logs.

To start using national characters in usernames with SSO, first configure Polarion to use right charset.

• On Windows: Cp1252 or similar for non-Latin languages is recommended.

• On Linux: This is typically UTF-8.




1. Stop Polarion.

2. Configure the following Polarion properties:

com.polarion.platform.repository.passwdFileEncoding=CHARSET

com.polarion.platform.repository.accessFileEncoding=CHARSET

svnkit.http.encoding=CHARSET

3. Manually convert the existing access and passwd files to the target character set if the originaland target character sets are not compatible. Without these steps, your existing files will becorrupted the next time they are modified by Polarion.

4. Start Polarion.




Kerberos Hints

While implementing SSO in Polarion, we ran into several pitfalls. In the majority of cases they werecaused by a misconfigured Kerberos environment. (Be it principals, DNS, keytab, or the encryptiontype.) We provide details on a failed login page to aid in possible troubleshooting.

As Polarion leverages standard Java JGSS implementation, Oracle’s JGSS Troubleshooting Tutorialis a good source for general troubleshooting information.

Client-side troubleshooting

In some cases the browser may be sending an NTLM token instead of a Kerberos token. Polarion willreport this failure with the following exception:

Message Example:

Unexpected failure during authentication

javax.security.sasl.SaslException: Unsupported authentication mechanism NTLM

There are a few common cases that cause this behavior:

1. The Client has an old Kerberos token.

If you configure Polarion Kerberos authentication, it is essential that the the client machine sendsthe correct Kerberos token. To fix this problem, make sure to logout the client from the domainand login again to get a new Kerberos token after the reconfiguration.

2. Host name of the Polarion server does not match the principal name.

We recommend that the Polarion service principal uses the FQDN of the machine as its name.Make sure to access the Polarion server via FQDN to make the client send the Kerberos token.Also check that the Polarion service principal is using the HTTP prefix.

3. Polarion server is not considered a member of the domain.

Integrated Windows Authentication is used only within the domain. If your Polarion server is notconsidered to be a member of the same domain by the client, the client will not send the Kerberostoken. Check if your browser is configured correctly for Kerberos authentication. Add the Polarionserver to the Local Intranet zone as outlined in the Client Configuration section of this guide.

4. Wrong encryption set for the client principal.

The principals need to use AES 128 bit encryption. If another encryption type is set for theprincipals, then the client may not obtain the Kerberos token and will try to send the NTLM tokeninstead. Make sure to configure your principals to use AES 128 bit encryption.



http://docs.oracle.com/javase/8/docs/technotes/guides/security/jgss/tutorials/Troubleshooting.html


Server-side troubleshooting

Typical problems in a Kerberos setup are cases when the keytab with a password for the Polarionservice principal is not exported properly or not understood by Java. Unfortunately, the Java Kerberosimplementation does not report these issues in a very clear way. A problem with the keytab results inPolarion being unable to login into the KDC in order to validate the token obtained from the client. Insuch cases, a variety of messages may appear including:

Message Example:

Unexpected failure during authentication

javax.security.sasl.SaslException: Could not initiate login

There are a few common cases that cause this behavior, and the majority of them can be troubleshotusing Oracle's JGSS Troubleshooting Tutorial. The most typical cases are listed below:

1. Keytab was not exported correctly.

Check that the principal, their password, the mapped user, and the encryption type are setcorrectly when exporting the keytab. See the example below and refer to the correct valuesfor each ktpass command attribute.

Use the Kinit tool provided with the standard Java installation to check whether the Kerberoslogin and keytab are correct.

Example:

kinit -k -t C:\Polarion\polarion\configuration\polarion.keytab <HTTP/principal>

2. Incorrect configuration of the Polarion service principal.

Check that the encryption type configured for the Polarion service principal is AES 128 bit.

In Windows environments, the event log on the KDC may provide more details about potentialproblems when exporting the keytab, because they are not logged by the ktpass tool.

3. Java cannot load the exported keytab file.

In specific cases, the keytab may not be understood by Java when exported directly from theKDC. If that is the case, use the ktab tool that is part of the standard Java installation.



http://docs.oracle.com/javase/8/docs/technotes/guides/security/jgss/tutorials/Troubleshooting.html

Chapter 15: LDAP authorization

In a new installation, users are authorized using the Subversion integrated policy access functions(directives AuthzSVNAccessFile and AuthUserFile in polarionSVN.conf file). If you have an LDAPinfrastructure, you can make Polarion authorize users against the LDAP database.

Information on performing this configuration, together with some examples, isprovided in the polarionSVN.conf configuration file. The file is located at:[POLARION_HOME]\bundled\apache\conf\extra\polarionSVN.conf

The file is located on e of the following paths, depending on your Linux distribution:

• /etc/apache2/conf.d

• /etc/httpd/conf.d

After modifying the configuration file, the Apache server must be restarted to reflect the changes.

For more information about the Apache LDAP modules and their capabilities, visit these web pages:

• https://httpd.apache.org/docs/2.4/mod/mod_authnz_ldap.html

• https://httpd.apache.org/docs/2.4/mod/mod_ldap.html .

You can find information on configuring Polarion to work with LDAP in the Polarion Help topicAdministrator’s Guide → User Management → Integrating Polarion Server with LDAP/ActiveDirectory.


https://httpd.apache.org/docs/2.4/mod/mod_authnz_ldap.html

https://httpd.apache.org/docs/2.4/mod/mod_ldap.html

Chapter 16: Next steps after installation

Once you have installed Polarion and logged in to the Portal, consider taking a look at the demoprojects (assuming you installed demo data). Click on the drop-down control in the Navigation panelon the left, select Open Project or Project Group, and open any project in the Demo Projectsgroup. See the User Guide → Getting Started with Projects section in Polarion's Help for tips.

You may want to do some initial global customizations such as customWork Item types,Workflows,Reports, SSL Support and more. You will find topics on these configurations in the Administrator'sGuide section of Polarion's Help.

Once you have your Polarion system running, and any global customizations done, you are readyto begin setting up your own projects and user accounts. Look up the following topics in theAdministrator's Guide: Creating and Managing Projects and Managing Users and Permissionssection in Polarion's Help.


Chapter 17: Manually updating third party software

Manually Update the bundled third party softwarePolarion bundles the following versions of third party components:

• Apache 2.4.25 (Updated automatically when using binaries compiled by Polarion.)

• Subversion 1.9.5 (Updated automatically when using binaries compiled by Polarion.)

• PostgreSQL 9.4.1

Apache and Subversion Binaries

The Apache and Subversion Binaries are now compiled in-house.

The Apache Haus compiled binaries are still compatible if required by any additional3rd-party customizations.

Due to licensing issues, Java is no longer bundled with Polarion.

It must be installed before running the Polarion installation Wizard.

See the Install Java or Update Java sections for details.

All are 64-bit versions. If you are running the bundled version and you would like to update to a newerservice release of Subversion and Apache, see the Update Subversion and Update Apache sections.


https://www.apachehaus.com/


Update SubversionAfter you update Subversion you must also update Apache (see the next section). Be sure youplan enough time to do both updates.

1. Visit http://www.apachehaus.com/cgi-bin/download.plx and download

Mod Subversion 1.9.3 for Apache 2.4.x x64.

2. Unpack the ZIP archive to some temporary folder.

3. Stop the Polarion and Apache servers.

4. Stop the existing Svnserve windows service if it is running.(Ctrl +Alt +Delete → Task Manager → Services tab → Right click on Svnserve and clickStop Service.)

5. Back up folders $POLARION_HOME$\bundled\apache and $POLARION_HOME$\bundled\svn

6. Delete the following files:

a. All files within the $POLARION_HOME$\bundled\svn folder.

(But do not delete the folder itself.)

b. From folder $POLARION_HOME$\bundled\apache\bin\ …intl3_svn.dlllibdb48.dlllibsvn_*.dll

c. From folder $POLARION_HOME$\bundled\apache\modules\ …mod_authz_svn.somod_dav_svn.so

7. Copy content of the folder within the unpacked temp folder from step two to

$POLARION_HOME$\bundled\svn, so that there is a folder$POLARION_HOME$\bundled\svn\bin.

8. Copy the following files in the $POLARION_HOME$\bundled\svn\bin\ … folder...

mod_authz_svn.somod_dav_svn.so…to the $POLARION_HOME$\bundled\apache\modules\ folder.

9. Copy the following files…

$POLARION_HOME$\bundled\svn\bin\libsvn_*.dll…to the $POLARION_HOME$\bundled\apache\bin folder.

10. (Optional). Update Apache.



http://www.apachehaus.com/cgi-bin/download.plx

Manually updating third party software

Update ApacheYou should update Apache after updating Subversion. The Polarion server, PostgreSQL and Apacheshould already be stopped for that update.

1. You can download the appropriate Apache binaries at:

http://www.apachehaus.com/cgi-bin/download.plx.

Installation Help for Apache HTTP server is available from Apache at:

http://httpd.apache.org/docs/2.4/install.html.

2. Install the downloaded Apache on any machine to get the content of the installation folder.

3. Back up the folder $POLARION_HOME$\bundled\apache

4. If you use Apache installed as a service, then uninstall Apache service by running:

$POLARION_HOME$\bundled\apache\bin\httpd.exe -k uninstall -n

Apache2Polarion

5. Delete content of $POLARION_HOME$\bundled\apache except the following:

a. Folder $POLARION_HOME$\bundled\apache\conf

b. Files in folder $POLARION_HOME$\bundled\apache\bin:

msvcr*.dll

stopApache.js

libsvn_*.dll

c. Files in folder $POLARION_HOME$\bundled\apache\modules:

mod_authz_svn.so

mod_dav_svn.so

You may have trouble deleting rotatelogs.exe. If so, you can kill the rotatelogs.exe processusing Windows Task Manager.

6. Copy the content of the Apache installation folder from Step 2, except for the conf folder,

to $POLARION_HOME$\bundled\apache.

7. Remove or disable the following lines in the httpd.conf file.

(To disable, insert the # character at the start of the lines, as shown below.)

# LoadModule authn_default_module modules/mod_authn_default.so

# LoadModule authz_default_module modules/mod_authz_default.so

# DefaultType text/plain

8. Add the following lines to the httpd.conf file:

LoadModule access_compat_module modules/mod_access_compat.so


Manually updating third party software

http://www.apachehaus.com/cgi-bin/download.plx

http://httpd.apache.org/docs/2.4/install.html


LoadModule authz_core_module modules/mod_authz_core.so

LoadModule authn_core_module modules/mod_authn_core.so

9. Not mandatory, but recommended: in

$POLARION_HOME$\bundled\apache\conf\extra\httpd-default.conf

Increase the value of MaxKeepAliveRequests to 10000.

10. If you use Apache installed as a service, install Apache service. Use the following commandin a single line:

$POLARION_HOME$\bundled\apache\bin\httpd.exe -k install -n Apache2Polarion

11. Start Apache, PostgreSQL and the Polarion server.

Update JavaIt's good to update Java regularly for security reasons, but check the README.html file section tomake sure that major Java version updates are officially supported by Polarion before updating tothem.

(Polarion currently supports JDK 1.8.0 64 bit. 32 bit Java is no longer supported.)



Chapter 18: Uninstall Polarion

Polarion comes with its own uninstaller that can either be launched via the Uninstall shortcut inthe Polarion shortcuts folder or through Programs and Features in Windows Control Panel.

Polarion’s subversion repository is stored in the [POLARION]\polarion folder. Be surethis repository does not contain production data that must be preserved. If it does, make abackup before uninstalling Polarion.

1. Click on the Polarion icon.

2. Click on the Uninstall in the Polarion shortcuts folder.

OR



1. Go to the Windows Control Panel.

2. Select Programs and Features.

3. Select Polarion from the list of Programs and click Uninstall.

4. Click Yes to confirm the uninstallation when the warning screen appears.

5. The uninstall process begins.

6. Select what files, if any, to keep and click Next.

7. Click Finish.

8. Polarion is successfully removed from your system.

Java will not be uninstalled along with Polarion



Chapter 19: Technical support

Polarion is problem-free for most people... at least that's been our experience. However, it'simpossible to anticipate all the conditions and environments where Polarion may be used. If anarises, Polarion’s Technical Support team maintains the Customer Self-service Portal which includesan extensive knowledge base of common problems and solutions and troubleshooting information, aswell as the possibility to submit, manage, and review your own specific support cases.

For information about the portal and technical support options, please visit:https://polarion.plm.automation.siemens.com/techsupport/resources


https://polarion.plm.automation.siemens.com/techsupport/resources

Chapter 20: APPENDIX

Enabling email notificationsIf you did not configure email notification settings in the installation program, you can do this afterinstallation by setting the host name in the announcer.smtp.host property in the polarion.propertiesfile located in [POLARION_HOME]\polarion\configuration. There you should also set theannouncer.smtp.user and announcer.smtp.password properties to a valid email account on theSMTP host specified in announcer.smtp.host. You may want to create a dedicated email addresson your SMTP host for use by the Polarion notifications system.

When this configuration is correctly set up, the system will send notification emails about variousevents according to the notification targets configuration. For information on configuring emailnotifications, see the Administrator’s Guide: Configuring Notifications in Polarion's Help.

Default parameters and settingsThis section contains reference information about default Polarion parameters used by the Polarioninstaller for Windows.

1. Polarion installation root folder: C:\Polarion.

2. Polarion components (default folder is: C:\Polarion\bundled):

a. Apache2 HTTPD-server (C:\Polarion\bundled\apache)

b. Java Runtime Environment (C:\Polarion\bundled\java)

c. Subversion (C:\Polarion\bundled\svn)

d. PostgreSQL (C:\Polarion\bundled\PostgreSQL)

3. Default settings for Apache:

a. Install type: for anEvaluation installation as a service, otherwise user-specified (service orconsole application, default: Service)

b. HTTP port: 81 for an Evaluation installation, otherwise port user-specified (default: 80)

c. Shutdown port: 8887

d. SMTP host: localhost for an Evaluation installation, otherwise the value is generated byadding mail. to the domain name taken from the registry. Remember that this is just thedocumentation of default values. You would specify the actual value for your system duringthe installation.

4. Default settings for Polarion:



a. Install type: for an Evaluation installation, as a console application, otherwise user specified

(default: as Windows service).

5. Default system property setting for PostgreSQL database connection:

com.polarion.platform.internalPG=polarion:polarion@localhost:5433

Parameters: <connecting user name>:<password>@<hostname>:<port>



Chapter 21: Supported Microsoft Office® versions

Users of a Polarion ALM™ product supporting current or legacy Microsoft Office data interchangefeatures for Microsoft Word™ and/or Excel®, please note the following table which outlinescompatible versions of Microsoft Office applications.

NOTES:

1. Beginning with Polarion version 2014-SR1, Microsoft Office 2003 is no longer supported inPolarion LiveDocs.

2. Prior to Polarion version 2011, Live Documents referred to Microsoft Office Word and Exceldocuments based on special document templates developed by Polarion, which could defineand store PolarionWork Items. Beginning with version 2011, Polarion refactored the technologycompletely but maintained backward compatibility. Beginning with Polarion version 2014-SR1support for this legacy format is dropped completely.


Siemens Industry Software

HeadquartersGranite Park One5800 Granite ParkwaySuite 600Plano, TX 75024USA+1 972 987 3000

AmericasGranite Park One5800 Granite ParkwaySuite 600Plano, TX 75024USA+1 314 264 8499

EuropeStephenson HouseSir William Siemens SquareFrimley, CamberleySurrey, GU16 8QD+44 (0) 1276 413200

Asia-PacificSuites 4301-4302, 43/FAIA Kowloon Tower, Landmark East100 How Ming StreetKwun Tong, KowloonHong Kong+852 2230 3308

About Siemens PLM Software

Siemens PLM Software, a business unit of the SiemensIndustry Automation Division, is a leading global providerof product lifecycle management (PLM) software andservices with 7 million licensed seats and 71,000 customersworldwide. Headquartered in Plano, Texas, SiemensPLM Software works collaboratively with companiesto deliver open solutions that help them turn moreideas into successful products. For more informationon Siemens PLM Software products and services, visitwww.siemens.com/plm.

© 2017 Siemens Product Lifecycle ManagementSoftware Inc. Siemens and the Siemens logo areregistered trademarks of Siemens AG. D-Cubed,Femap, Geolus, GO PLM, I-deas, Insight, JT, NX,Parasolid, Solid Edge, Teamcenter, Tecnomatix andVelocity Series are trademarks or registered trademarksof Siemens Product Lifecycle Management SoftwareInc. or its subsidiaries in the United States and in othercountries. All other trademarks, registered trademarksor service marks belong to their respective holders.