Running Renew

The renew.jar file is located in the installDir\SBM\Common\Misc\renew directory.

The following procedure describes how to prepare for and run the renew utility. For a description of the commands and their usage and output, see Renew Commands.

Important: Renew must be run locally from the Orchestration Engine server. It uses libraries from the Orchestration Engine server Tomcat installation and uses the Windows registry to find that installation.

Renew is a command-line Java application, and requires the JRE in the Windows "Path" system variable. You can use the JRE and create a small batch file that surrounds your particular usage of renew. The following is an example of the file content, and shows the path to the JRE in the default SBM directory:

Setlocal
set JAVA_HOME=c:\Program Files\Serena\SBM\Common\jre1.8
path=%path%;%JAVA_HOME%\bin
java -Dfile.encoding=UTF-8 -jar renew.jar
endlocal

Modify and use the provided batch files located here:

installDir\SBM\Common\Misc\renew\renew_templates

To run renew:

Important: Back up your Orchestration Engine database before you run renew. For production systems and complex situations, it is a best practice to perform a trial run on a test system using a backup of your target system.

Obtain the following information about your SBM system:
- The number of environments you have
- The number of Orchestration Engine servers you have
- The environment that points to each Orchestration Engine server
- The database that is used for each Orchestration Engine server
- An SBM user name and password that can access the environments you need to renew
- A database user name and password that can be used to log into the Orchestration Engine database you need to renew, with privileges to list and deploy process apps.
Determine which Orchestration Engine server you are going to renew.
Determine which environments use the Orchestration Engine server you are going to renew. (There is typically only one, but it is a good idea to check.)
Make sure the endpoints in the environment that uses the Orchestration Engine server are correct. Changes are only picked up on deployment, and renew will use the latest.
If extended characters were used in the names of environments, process apps, orchestrations, or orchestration workflows, follow the procedures in Extended Character Handling.
Run renew -listenvs to list the environments in your system and make sure you are working with the correct environment. This command can warn you about certain problematic server configurations.
Run renew -report to view information specific to that environment, such as the process apps, target servers, endpoints, and orchestrations in the environment. This command can warn you about certain problematic server configurations.
Important: Check whether you have a problematic server configuration where SBM Application Engine or Orchestration Engine servers are shared across environments. Do not continue unless you are sure that this does not apply to your system or unless you understand the consequences. (For details, see Problematic Server Configurations.)
Optionally, perform a test run of renew -redeploy to confirm that the orchestration workflows you expected to be redeployed are redeployed correctly. Use the -useEnvEndpoints option with -redeploy if Application Engine endpoints were manually changed in Application Repository after the last deploy. This ensures that the correct Application Engine endpoint is used for orchestrations that call Application Engine Web services. Otherwise, the endpoints that were last deployed to Application Engine are used.
Note: As an extra precaution, use the information in Tables Affected By Renew to perform a deeper analysis.
Stop access to the SBM system. It is recommended that you then stop the SBM Tomcat service and back up your Orchestration Engine database.
Run renew -clear against the Orchestration Engine database associated with the Orchestration Engine server you are renewing.
Restart the SBM Tomcat service and wait for it to initialize.
Run renew -redeploy for each of the environments associated with the Orchestration Engine server you are renewing.
Allow access to the SBM system.