Stages Documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
261:upgrade_from_712 [2026/04/15 13:24] – Weinlein, Thomas261:upgrade_from_712 [2026/04/22 12:35] (current) – [How to upgrade to version 26.1] Weinlein, Thomas
Line 4: Line 4:
  
 Please [[stages-support@ul.com|contact our customer care team]] to request an upgrade of your Stages Managed Service instance. Please [[stages-support@ul.com|contact our customer care team]] to request an upgrade of your Stages Managed Service instance.
 +
 +If you use a customized metamodel on your Stages Managed Service instance, it needs to be adapted to v26 by your Stages product consultant first.
  
 //Note: all process release automations have to be finished before an upgrade can be performed.// //Note: all process release automations have to be finished before an upgrade can be performed.//
 +(see Report [[reports:start#running-process-release-automations|Running Process Release Automations]])
 +
 +//Note: An existing SAML connection needs to be reestablished, by registering new URLs at the IDP server.//
  
 ===== Upgrade your system to at least Stages 7.12.5.0 ===== ===== Upgrade your system to at least Stages 7.12.5.0 =====
Line 14: Line 19:
  
 To minimize the chance for issues during the upgrade it is recommended to execute ''ensureDatabaseIntegrity.bat|sh'' before upgrading to Stages 26.1. To minimize the chance for issues during the upgrade it is recommended to execute ''ensureDatabaseIntegrity.bat|sh'' before upgrading to Stages 26.1.
 +
 +To minimize the runtime of ''ensureDatabaseIntegrity'' add the following config properties to config.xml to skip those steps:
 +
 +<code xml config.xml>
 +<property name="database.cleanup.targets" value="false"/>
 +<property name="database.cleanup.associationAttributes" value="false"/>
 +</code>
 +
 +Note: Stages should be stopped while ensureDatabaseIntegrity is running.
  
 ===== Create Backups Before Upgrading ===== ===== Create Backups Before Upgrading =====
  
 To be safe in case of any problems during the update, **back up your database and the stages folder **before the upgrade.\\ If the backup is running automated - please check whether the backup was created successfully. To be safe in case of any problems during the update, **back up your database and the stages folder **before the upgrade.\\ If the backup is running automated - please check whether the backup was created successfully.
 +
 +===== Install Java 25 =====
 +
 +===== Install Stages 26.1 =====
 +
 +===== Execute Manual Actions =====
 +
 +=== server.xml migration ===
 +
 +Remove the following lines from ''$STAGES_CONF/server.xml''
 +
 +<code xml>
 +<Realm className="org.apache.catalina.realm.CombinedRealm" > 
 +    <Realm className="de.methodpark.stages.containerauth.SSLAuthenticatorRealm" roles="pki_user"/> 
 +    <Realm className="de.methodpark.stages.containerauth.SimpleAuthenticationRealm" roles="StagesUser" /> 
 +</Realm> 
 +</code>
 +
 +and
 +
 +<code xml>
 +<Valve className="org.apache.catalina.authenticator.SingleSignOn" />
 +</code>
 +
 +remove the Context elements with path="/stages" and path="/reporting":
 +
 +<code xml>
 +<Context path="/stages" docBase="stages" cookies="true">
 +[...]
 +</Context>
 +<Context path="/reporting" docBase="reporting" cookies="true" >
 +[...]
 +</Context>
 +</code>
 +
 +In case one of the Connectors are configured to use protocol "org.apache.coyote.http11.Http11Nio**2**Protocol" replace that by "org.apache.coyote.http11.Http11NioProtocol"
 +
 +<code xml>
 +<Connector port="[...]"
 +protocol="org.apache.coyote.http11.Http11NioProtocol"
 +[...]
 +/>
 +</code>
 +
 +=== Authentication method configuration migration ===
 +
 +>//In case SAML SSO is enabled please ensure the idp-metadata.xml file is available in ''$CONF_STAGES''.//
 +
 +The ACS URLs changed and because of that the information about Stages in the IDP must be updated. Best case is to take the sp-metadata.xml file and import it on the IDP. Certificates should stay the same.
 +
 +The authentication section in the ''config.xml ''file needs to be migrated to a new format. The basic conversion can be done by the following script call. Please review the results in detail and add missing information as the ''idp-metadata.xml'' file from the SAML IDP.
 +
 +The original ''config.xml'' will be backed up as ''config.before-26.1.xml''.
 +
 +<code bash>
 +$STAGES_ROOT/bin/upgradeConfigXml.sh|bat
 +</code>
 +
 +=== Database access configuration migration ===
 +
 +The ''conf/database.properties'' file used in Stages 7.12 and earlier is no longer in use. Database connection settings are now configured in ''conf/config.properties'' and ''conf/secret.properties'' with the following property keys:
 +
 +<code properties config.properties>
 +database.driver.class.name=
 +database.jdbc.url=
 +</code>
 +They are similar to these properties from conf/database.properties: torque.database.default.driver, torque.database.default.url
 +
 +<code properties secret.properties>
 +database.username=
 +database.password=
 +</code>
 +and those are the like torque.database.default.username, and torque.database.default.password.
 +
 +>Add rewriteBatchedStatements=true as parameter to database.jdbc.url if you are using MySQL.