=============
Configuration
=============
This file contains important information that you should be aware of before
updating to a new release. It describes changes that may impact your current
system, and may include additional recommended actions to take before or after
updating Polarion. If you have not yet read README.txt (in the same folder
as this file), please review it before proceeding.
Information below is grouped according to the Polarion version in which it was
introduced. Please process any actions down to the version from which you update.
Some actions may be noted as specific only for some Polarion products.
=======
General
=======
This section contains general points that you should check during the update:
* The Resource Traceability feature is enabled by default and the RT server starts automatically with Polarion.
Add the following property with a "false" value to disable the Resource Traceability feature:
"com.siemens.polarion.rt.startRtServer=false"
If you decide to use Resource Traceability, a certificate must be imported into your Polarion Java TrustStore.
To point Polarion to your TrustStore, use the following property:
"-Djavax.net.ssl.trustStore"
If your organization does not have a TrustStore, importing the certificate to the Java Key store will also work.
See the "Importing a Certificate to the Java Keystore" section in Help for details.
* If you use a customized log4j.properties file, alongside the polarion.properties file,
please consider merging it with the new default log4j.properties version the org.apache.log4j plugin.
* If you have installed the Polarion VARIANTS Server Add-on, it must be updated to the
current version AFTER updating your Polarion installation. Please follow
the instructions included in the HOW_TO_INSTALL_THIS_UPDATE.txt, bundled in the update distribution.
============
Version 19.2
============
* The Zookeeper's transaction logs are now automatically purged from the Coordinator's data folder.
By default, the logs are purged once every 24 hours and only the three last snapshots and their corresponding logs are retained in the data folder after a purge.
This functionality can be disabled or configured with the following two properties in the polarion.properties file:
com.polarion.zookeeper.logsPurgePeriodMins=1440
The time interval, in minutes, to purge the Zookeeper's transaction logs from the data folder.
(Set to 0 to disable.)
com.polarion.zookeeper.retainedSnapshotsNum=3
The number of snapshots and their corresponding logs retained in the data folder after a purge. All others will be deleted.
(Must not be lower than 3.)
============
Version 19.1
============
IMPORTANT!
Polarion UI data in a cluster deployment is now in a new location.
You must migrate existing UI data so that it works with the latest version of Polarion.
To migrate the UI data:
1. Create the following directory: "[POLARION_DATA]/workspace/cluster-data/[CLUSTER_ID]/" on the Coordinator, where [CLUSTER_ID] is the value for the com.polarion.clusterId property in the polarion.properties file.
2. Move the entire "ui-data" folder and all its sub-folders and files from the shared storage at: "[POLARION_DATA]/workspace/" to the new directory in the Coordinator.
============
Version 19
============
* Polarion now only supports OpenJDK 11. (Oracle's Java SE Development Kit 8 is no longer supported.)
IMPORTANT!
When installing or upgrading to OpenJDK 11 make sure the default file encoding matches the same encoding used by the previous version of Java.
To make sure that the file encoding is correct:
1. Search for the file.encoding property in the main log file (C:\Polarion\data\logs\main\).
2. If the default file encoding for the new Open JDK 11 differs, then define it explicitly as a Java Runtime property by adding the following property,
with the file encoding you deploy, to the polarion.ini file. (C:\Polarion\polarion\polarion.ini by default).
Dfile.encoding=file_encoding
(Replace "file_encoding" with the one you use.)
3. Reinstall the Polarion service (run service.bat) for the Java Runtime property to take effect.
* The Rhino Engine https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino will also be completely removed in future versions of Polarion.
* Important notice regarding the Workflow Signatures:
Refinements and improvements have been made to the Workflow Signatures feature introduced in 18.2 that require some configuration adjustments if it has already been implemented.
1) Required adjustment:
Remove the "$user" variable from the following property:
secure.approvals.comment=
(The current user is now automatically inserted and if you don't remove $user, then it will appear as "$user" in the approval comment.)
2) Additional variables were added to the following property:
secure.approvals.comment.onBehalfOf=put your custom comment text here
In addition to custom comment text, this property also supports a verdict variable ($verdict) and a verdict image ($img).
3) New property:
secure.approvals.comment.text=put your custom comment text here
You can now add custom approval verdict text.
See the following section in Polarion's help for more information:
Administrator's Guide > Configure Work Items > Configure Work Item Workflow > Workflow for Approvals > Enable Electronic Signatures Support
============
Version 18.3
============
* The Eclipse platform plug-ins (sometimes referred to as bundles) that are part of Polarion were updated from version 3.1
to 4.8 (aka Photon). Although this should not impact most custom extensions,
some might need to be migrated to ensure that they're still usable after the update.
This should only affect extensions that take the form of a plug-in. (Located in the polarion/extensions folder in the Polarion installation directory).
There are two potential causes for incompatibility:
1) Plug-ins without an OSGi bundle manifest (META-INF/MANIFEST.MF) are no longer supported.
In the old Eclipse platform, the runtime dependencies of a plug-in could be specified in the plugin.xml file.
This approach was already deprecated in the 3.1 version that was part of Polarion prior to this update,
so it should not affect existing custom extensions.
NOTE: The plugin.xml file is still used to contribute to plug-in extensions, but it can no longer be used to specify dependencies between pug-ins, runtime libraries etc.
2) Parts of the Eclipse platform API have been removed since version 3.1.
Plug-ins that make use of the Eclipse platform API (e.g. contain a plug-in activator class or provide extension
points), might require changes. Please follow the instructions in the JavaDoc for the Eclipse platform classes that are used.
For additional information, please see the "Platform Plug-in Developer Guide" for Eclipse Photon at: https://help.eclipse.org/photon/nav/2
If you need help with the migration itself, please contact Polarion's technical support at: http://www.siemens.com/gtac
* Support for Oracle's Java SE Development Kit 8 is being phased out in favor of the open source alternative (OpenJDK 11).
Polarion 18.3 supports both Oracle's Java SE Development Kit 8 and OpenJDK 11 but it will be the last Polarion release that supports both.
Polarion 19 (scheduled for release in the spring of 2019), will only support OpenJDK 11, so administrators should plan accordingly.
NOTE: If you've added extra GC-related runtime parameters for Java, you will need to update them accordingly for Java 11.
(The JVM may fail to start with Java 8 style GC options.) See the "Update Java" section in the Windows Installation guide for details.
a) The PDF version can be found in your Polarion installation folder.
b) HTML and PDF versions can be found at: https://docs.plm.automation.siemens.com/tdoc/polarion/18.3/help#uid:index
* Installing a new extension now requires an additional step, described in the [INSTALL]/polarion/extensions/README.txt file. This file is updated automatically when installing the update.
============
Version 18.2
============
* New and existing Polarion installations:
If Workflow Signatures were set as mandatory in the workflow configuration of your existing installation, after the Polarion update
your old Workflow signature comments will be preserved and still visible in the "Comment" section.
All new signed workflow transitions will appear in the new "Workflow Signatures" section on the Work Item form. For both new and existing Polarion installations
you need to add the new "Workflow Signatures" section to the "Form Layout" configuration so that it appears in the Work Item form.
Note: There are templates and instantiated projects in Polarion where Workflow Signatures are already set as mandatory in the workflow configuration.
The Work Item form of those templates and projects already includes the "Workflow Signatures" section and no further "Form Layout" configuration is required.
To add the new "Workflow Signatures" section to the "Form Layout" configuration so that it appears in the Work Item form:
1. Project Administration > Work Items > Form Configuration.(On either the Project or Global levels.)
2. Click "Edit" beside "Default" in the "Form Layouts" section to add it to all Work Items. (Or "Edit" beside each Work Item type you'd to like to add it to.)
3. Paste