How to upgrade systems with Account Retention or File Retention Add-on?

In case account data import from SecureTransport 5.4 or 5.3.6 to a new SecureTransport 5.5 installation, File Retention and Account Retention properties will be recognized automatically. No additional actions are needed.

In case of in-place upgrade from SecureTransport 5.4 or 5.3.6 to SecureTransport 5.5, the File Retention and/or Account Retention add-ons must be uninstalled completely BEFORE the upgrade is performed, following the steps below. After the upgrade the existing File Retention and Account Retention properties will be recognized automatically. No additional actions are needed.

Remove File Retention Add-on files

Before starting the upgrade to SecureTransport 5.5, perform the following:

1. Stop ALL SecureTransport services

2. Delete the following files under SecureTransport's home folder (<FILEDRIVEHOME>):

<FILEDRIVEHOME>/brules/local/agents/inprocess/jars/fileretention-agents.jar
<FILEDRIVEHOME>/brules/local/wptdocuments/FileRetentionApp.xml
<FILEDRIVEHOME>/conf/mailer-templates/FileRetentionNotification.xhtml
<FILEDRIVEHOME>/lib/jars/fileretention-plugin.jar
<FILEDRIVEHOME>/lib/jars/fileretention-shared.jar
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/classes/fileretention_account_errors.properties
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/classes/fileretention_errors.properties
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/classes/firetention_bu_errors.properties
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/plugin/applicationtypes/fileRetentionApp.jspx
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/plugin/pagecustomizations/fileRetentionAccount.jspx
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/plugin/pagecustomizations/fileRetentionAccountReadOnly.jspx
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/plugin/pagecustomizations/fileRetentionBusinessUnit.jspx

3. Open <FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/plugin/pagecustomizations/plugin.xml file and delete the following:

<include jspFile="fileRetentionAccount.jspx" value="account"/>
<include jspFile="fileRetentionBusinessUnit.jspx" value="businessUnitEdit"/>
<include jspFile="fileRetentionAccount.jspx" value="accountTemplate"/>
<include jspFile="fileRetentionAccountReadOnly.jspx" value="accountReadOnly"/>

4. Open the <FILEDRIVEHOME>/brules/local/agentlist.addin file and delete the following:

com.axway.st.server.fileretentionapp.agents.FileRetentionAgent

5. Open the <FILEDRIVEHOME>/brules/local/wptdocuments/wptdocument.conf file and delete the following:

FileRetentionApp=enabled

6. Open the <FILEDRIVEHOME>/conf/tm-log4j.xml file and delete the following blocks:

appender with name FileRetentionLog

<appender class="com.tumbleweed.st.server.logging.DailyRollingFileAppender" name="FileRetentionLog">
    <param name="File" value="<FILEDRIVEHOME>/var/logs/fileretention-tm.log"/>
    <param name="DatePattern" value="'.'yyyy-MM-dd"/>
    <param name="Append" value="true"/>
    <param name="RotateDirectory" value="<FILEDRIVEHOME>/var/db/hist/logs/"/>
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%d %-5p [%t] %-16c{1} - %m%n"/>
    </layout>
</appender>

logger with name com.axway.st.server.fileretentionapp.agents

<logger additivity="false" name="com.axway.st.server.fileretentionapp.agents">
    <level value="info"/>
    <appender-ref ref="FileRetentionLog"/>
    <appender-ref ref="ServerLog"/>
</logger>

logger with name com.axway.st.server.fileretentionapp.shared

<logger additivity="false" name="com.axway.st.server.fileretentionapp.shared">
    <level value="info"/>
    <appender-ref ref="FileRetentionLog"/>
    <appender-ref ref="ServerLog"/>
</logger>

7. Open the <FILEDRIVEHOME>/conf/admin-log4j.xml file and delete the following blocks:

appender with name FileRetentionAdminLog

<appender class="com.tumbleweed.st.server.logging.DailyRollingFileAppender" name="FileRetentionAdminLog">
    <param name="File" value="<FILEDRIVEHOME>/var/logs/admin/fileretention-admin.log"/>
    <param name="DatePattern" value="'.'yyyy-MM-dd"/>
    <param name="Append" value="true"/>
    <param name="RotateDirectory" value="<FILEDRIVEHOME>/var/db/hist/logs/admin"/>
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%d %-5p [%t] %-16c{1} - %m%n"/>
    </layout>
</appender>

logger with name com.axway.st.server.fileretentionapp.admin

<logger additivity="false" name="com.axway.st.server.fileretentionapp.admin">
    <level value="info"/>
    <appender-ref ref="FileRetentionAdminLog"/>
    <appender-ref ref="ServerLog"/>
</logger>

8. Open the <FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/plugin/applicationtypes/plugin.xml file and delete the following:

<include displayName="Account File Purge" jspFile="fileRetentionApp.jspx" value="AccountFilePurge">
    <param name="supportsSubscriptions" value="false"/>
    <param name="template" value="false"/>
</include>

Remove Account Retention Add-on files

Before starting the upgrade to SecureTransport 5.5, perform the following:

1. Stop ALL SecureTransport services

2. Delete the following files under SecureTransport's home folder (<FILEDRIVEHOME>):

<FILEDRIVEHOME>/lib/jars/Axway-AccountRetentionPolicy-psolicensemenu.jar
<FILEDRIVEHOME>/brules/local/agents/inprocess/jars/Axway-AccountRetentionPolicy-agents.jar
<FILEDRIVEHOME>/brules/local/wptdocuments/AccountTTLApp.xml
<FILEDRIVEHOME>/conf/mailer-templates/AccountTTLNotification.xhtml
<FILEDRIVEHOME>/conf/mailer-templates/AccountTTLNotificationAdmin.xhtml
<FILEDRIVEHOME>/lib/jars/Axway-AccountRetentionPolicy-admin.jar
<FILEDRIVEHOME>/lib/jars/Axway-AccountRetentionPolicy-license-tag.jar
<FILEDRIVEHOME>/lib/jars/Axway-AccountRetentionPolicy-license-tool.jar
<FILEDRIVEHOME>/lib/jars/Axway-AccountRetentionPolicy-utils.jar
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/classes/cdg_errortext_accountretention.properties
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/classes/cdg_errortext_accountretention_bu.properties
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/plugin/applicationtypes/AccountTTL.jspx
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/plugin/pagecustomizations/accountRetentionAccount.jspx
<FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/plugin/pagecustomizations/accountRetentionBusinessUnit.jspx

3. Open the <FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/plugin/pagecustomizations/plugin.xml file and delete the following:

<include jspFile="accountRetentionBusinessUnit.jspx" value="businessUnitEdit"/>
<include jspFile="accountRetentionAccount.jspx" value="accountReadOnly"/>
<include jspFile="accountRetentionAccount.jspx" value="account"/>

4. Open the <FILEDRIVEHOME>/brules/local/agentlist.addin file and delete the following:

com.axway.cdg.st.server.enhancedmaintenance.agents.AccountTTLAgent

5. Open the <FILEDRIVEHOME>/brules/local/wptdocuments/wptdocument.conf and delete the following:

AccountTTLApp=enabled

6. Open the <FILEDRIVEHOME>/conf/tm-log4j.xml file and delete the following blocks:

appender with name pso-rpa-accountTTL

<appender class="com.tumbleweed.st.server.logging.DailyRollingFileAppender" name="pso-rpa-accountTTL">
    <param name="File" value="<FILEDRIVEHOME>/var/logs/pso-rpa-accountTTL.log"/>
    <param name="DatePattern" value="'.'yyyy-MM-dd"/>
    <param name="Append" value="true"/>
    <param name="RotateDirectory" value="<FILEDRIVEHOME>/var/logs"/>
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%d %-5p [%t] %-16c{1} - %m%n"/>
    </layout>
</appender>

logger with name com.axway.cdg.st.server.enhancedmaintenance.agents.AccountTTLAgent

<logger additivity="false" name="com.axway.cdg.st.server.enhancedmaintenance.agents.AccountTTLAgent">
    <level value="info"/>
    <appender-ref ref="pso-rpa-accountTTL"/>
    <appender-ref ref="ServerLog"/>
</logger>

7. Open the <FILEDRIVEHOME>/conf/admin-log4j.xml file and delete the following:

appender with name RetentionPolicyAdministrationAdmin

<appender class="com.tumbleweed.st.server.logging.DailyRollingFileAppender" name="RetentionPolicyAdministrationAdmin">
    <param name="File" value="<FILEDRIVEHOME>/logs/admin/pso-rpa-admin.log"/>
    <param name="DatePattern" value="'.'yyyy-MM-dd"/>
    <param name="Append" value="true"/>
    <param name="RotateDirectory" value="<FILEDRIVEHOME>/var/db/hist/logs/admin"/>
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%d %-5p [%t] %-16c{1} - %m%n"/>
    </layout>
</appender>

logger with name com.axway.cdg.st.server.enhancedmaintenance.admin

<logger additivity="false" name="com.axway.cdg.st.server.enhancedmaintenance.admin">
    <level value="info"/>
    <appender-ref ref="RetentionPolicyAdministrationAdmin"/>
    <appender-ref ref="ServerLog"/>
</logger>

8. Open the <FILEDRIVEHOME>/tomcat/admin/webapps/coreadmin/WEB-INF/plugin/applicationtypes/plugin.xml file and delete the following:

<include displayName="Account Time to Live" jspFile="AccountTTL.jspx" value="AccountTTL">
    <param name="supportsSubscriptions" value="false"/>
    <param name="template" value="false"/>
</include>

Remove the Add-on Licenses menu from the Admin UI after the upgrade

The "Add-on Licenses" menu in the SecureTransport 5.5 Admin UI will still be available after in-place upgrade. The Account Maintenance application no-longer requires additional licensing and will be fully operational. The Add-on Licenses menu will not have functional impact. You can leave it there, or you can remove it manually.

To remove the menu, download the appropriate package for your OS from the two attached to this KB article, extract it in a dedicated folder on the server and follow the instructions in the included Readme.md file.