Contents
About this Release
SBM 10.1.5.4 is the version that immediately follows SBM 10.1.5.3. All of the features, changes, and fixes that were made in SBM 10.1.5.3 can be found in SBM 10.1.5.4.
SBM 10.1.5.4 supports new installations—you do not need to install a previous version of SBM before installing this version. If this is a new installation, download version 10.1.5.4 from http://www.serena.com/support and then follow the instructions in the SBM Installation and Configuration Guide.
Note the following important information about this release:
-
***Are you using the right version of SLM?***
SBM 10.1.5.4 requires Serena License Manager 2.2. You must upgrade to version 2.2 before you can upgrade to SBM 10.1.5.4. - SBM is now certified against Internet Protocol version 4 (IPv4) and Internet Protocol version 6 (IPv6). Note that SBM requires that both IPv4 and IPv6 stacks are present on each server, though IPv4 can be disabled.
- SBM 10.1.5.4 is available in U.S. English only.
Terminology Changes
The following terminology and component name changes have been made since the release of SBM 2009 R4.
| Old Term | New Term |
|---|---|
|
SBM Application Administrator |
SBM Application Repository |
|
Web Administrator |
SBM Application Administrator |
|
Manage Data |
Auxiliary Data (in SBM Application Administrator) |
|
Notification Server (in the SBM installer) |
SBM Mail Services |
- For changes made in SBM 2009 R4, refer to the readme.
- For terminology changes made since TeamTrack 6.6.1, refer to the Moving to Serena® Business Manager guide.
Supported Configurations
Detailed information about supported platforms and software configuration is available in the Supported Platform Matrix. (Click View to see the complete platform matrix for this release).
Build Numbers
The following component build numbers apply to this version:
- SBM User Workspace and Serena Work Center: 10.01.05.04.1238 (Build 144)
- SBM Composer : 10.1.5.4 (Build 0068)
- SBM System Administrator and SBM Application Administrator: 10.01.05.0X.1238 (Build 144)
- Application Repository: 10.01.05.04.1238 (Build 143)
- SBM Configurator: 10.01.05.04.31
- SBM Notification Server and Mail Client: 10.01.05.04.87
- Database version: 1015040001
- English – 10.1.5.1
- Japanese – 2009 R4.01 (the translated content applies to version 2009 R4.01)
Third-Party Tools
For more information regarding third-party software copyrights and license information, refer to the files under "Downloads" or "News" at http://www.serena.com/support.
Modern Browser Support
Many SBM features require Web browsers that support HTML5. Some of these features are not available in older browsers, such as Internet Explorer (IE) 8.
- Serena Work Center
- Rich Text Editor for applying formatting to e-mail messages, notes, and certain Text fields.
- Updated form styling and modern themes
- Drill-down display options for Distribution, Advanced Distribution, Summary, Time to State, Elapsed Time, Trend, Backlog Trend, Entering a State, Open and Completed, and State Activity reports (if Flash components are also disabled)
- Elapsed Time reports (if Flash components are also disabled)
- User profile card
- Group member lists for Multi-User fields on State forms
- Translated strings in the workflow diagram
- Second background colors and corner radius settings on custom forms
- Upgrade your browser, or
- Contact your administrator and ask for HTML5 features to be disabled.
In addition, Compatibility Mode should be disabled in all versions of Internet Explorer.
Upgrades
This section provides general upgrade information and important notes for all upgrades to SBM 10.1.5.4.
To test the upgrade, mimic your installation on a separate set of servers. This test installation should include all of the environments used by your system. You will upgrade and test this installation before upgrading your production installation. To upgrade successfully, SBM 10.1.5.4 must be installed on each server and client machine.
- Refer to the Supported Platform Matrix for a list of supported upgrade paths. If you are using a version of SBM prior to 2009 R1, first upgrade to 2009 R4.0x, and then upgrade to 10.1.5.4.
- Refer to the Serena Documentation Center for a list of prior readmes that contain features and changes that were added in earlier versions.
- For information on upgrading TeamTrack 6.6.1.x to SBM, follow the instructions in Moving to Serena® Business Manager. This guide only covers upgrades from TeamTrack. Refer to solution S137372 to learn about the upgrade preparation utility.
- For information on migrating your Tracker data to SBM, refer to the "Migrating Tracker Data to SBM" solution (S138468).
Important Notes for Major and Minor Upgrades
- Major upgrades are upgrades from any version prior to 2009 R3. If you are upgrading from a version prior to 2009 R3, review the Important Notes for Major and Minor Upgrades below and then follow the steps in solution S138037 to upgrade to 10.1.5.4.
- Minor upgrades are upgrades from version 2009 R3 and later. If you are upgrading from version 2009 R3 or later, review the Important Notes for Major and Minor Upgrades below and then follow the steps in Minor Upgrades to upgrade to 10.1.5.4.
The following notes apply to both major and minor upgrades:
- SBM 10.1.5.4 requires Serena License Manager 2.2. You must upgrade to version 2.2 before you can upgrade to SBM 10.1.5.4.
- In order to prevent notifications from being sent for changes that have not happened recently, SBM now deletes notification events that are older than 90 days that contain a THREADID during the database upgrade. To check if you have events that will be deleted, refer to the SQL queries in solution S140945.
- SBM Configurator
warns you if your installation currently uses default certificates (which
should be replaced) or if your current certificates will expire soon.
Important: To properly secure your installation, you must generate new key pairs even if you do not plan to use SSO. If you do not generate new key pairs, then the default certificates that the STS inherently trusts are used. To increase security, launch SBM Configurator and generate new unique certificate for all components. For details, see "Securing SBM" in the SBM Installation and Configuration Guide.
- If you are upgrading to any release after SBM 10.1.4 (when backlogs were first introduced) and you have configured a JBoss cluster, duplicate Backlog entries might appear when you manage views in Serena Work Center. To work around this problem, after the upgrade is finished, start JBoss on only one node, launch Work Center, and then start JBoss on the remaining nodes.
- The use of logical field names in the $FIELDVALUE base item template tag is deprecated and will not be supported in future releases. Serena recommends that you review your current e-mail templates and replace field display names with the database field name as part of the upgrade process.
- Beginning with 10.1.4, custom forms should display and perform as they did before the upgrade. The first time you redeploy process apps after the upgrade, you must redeploy from SBM Composer instead of SBM Application Repository. If you redeploy from SBM Application Repository, you may encounter problems with custom forms. To solve these problems, redeploy process apps that contain these forms from SBM Composer.
- HTML Rendering for Notes
HTML rendering and Rich Text editing is now enabled by default for all notes in your system. To disable these features for notes, clear the Render HTML in Notes check box located on the HTML tab of the Settings dialog box in SBM System Administrator.
- As part of the database upgrade, new indexes are
added to the CL_CONTEXT_VALUE and CL_LOG tables to prevent time outs from
occurring when you try to view Common Log data in
SBM Composer
or
SBM Application
Repository.
Important: In order to add the new indexes, these tables will be emptied during the upgrade process. If you need to view Common Log data that was present prior to the upgrade, ensure that you have backed up these tables.
- As of 10.1.2, the
SSO
Login Application (Federation Server) has been merged with the
SSO
Security Token Service (STS) into a single
SSO
Security Server (also known as the Identity Provider (IDP)). This means that
the
ALFSSOLogin.war and
TokenService.war directories have been merged
and replaced with a new
idp.war directory on the
SSO
server.
Important: If you have created custom SSO integrations, you must review all URLs and calls to ensure that they use the new directory names. For example, if your existing integrations call the Security Token Service (STS), you must ensure that the new idp.war directory is used (instead of ALFSSOLogin.war or TokenService.war).The endpoints of the SSO services must be changed accordingly. The relative URIs will stay the same, but since the application is new, the login application entry point will be:
http(s)://host[:port]/idp/login
For the STS, it will be:http(s)://host[:port]/idp/services/Trust
- For Oracle systems, the required roles and privileges for the SBM schema user have changed. Please visit S133641 for details.
- For Oracle systems, you must perform the database upgrade using
either the
SBM DSN that is installed with
SBM
or a system DSN that uses the "Oracle for SBM" driver
that is installed with
SBM. If your
system used the Mashup2009 DSN prior to the upgrade, that DSN is automatically
converted to use the new "Oracle for SBM" driver, if it
was not using this driver already.
Important: The underlying driver in the DSN that ships with SBM was changed in SBM as of version 10.1. If you currently use the Mashup2009 DSN with SBM, you do not need to do anything—the DSN will be updated automatically. If you created your own custom DSN with the "Oracle for SBM" driver prior to upgrading to SBM 10.1 or later, then you must recreate the DSN and use the new "Oracle for SBM" driver that ships with SBM after the upgrade is finished.
If you previously designated a SID for Oracle, then that SID is automatically used in the Service name field in SBM Configurator. Verify with your DBA that the correct service name is now used in the Database Servers tab of SBM Configurator.
- User credentials in SBM Application Engine Web service calls that use Basic authentication are now handled exclusively by SBM Application Engine itself, instead of IIS. This configuration is common if your SBM system is set up with NT Challenge Response for end-user authentication. After upgrade, this means that you must now specify the Windows domain for Web service calls in SBM Configurator, otherwise the domain that the IIS server machine is installed on is used for user validation.
- If your database does not contain at least one Regular User or Managed Administrator account with Remote Administration privilege, use the Reset Administrative User Access wizard in SBM System Administrator after the database upgrade is finished. This wizard enables you to define at least one user as your primary system administrator (an account that has Regular User or Managed Administrator product access with Remote Administration privilege) who can log in to SBM Application Administrator. For details, see the SBM System Administrator Guide.
- If you have applications in SBM that use Tomcat (such as DVM), you must clear out the Tomcat work subdirectory (typically %TOMCAT_HOME%/work). Clearing the browser cache alone is insufficient. This applies to both Firefox and Internet Explorer browsers.
Minor Upgrades
This section provides important notes and upgrade instructions for upgrades to SBM 10.1.5.4 from version 2009 R3 and later.
Pre-upgrade Steps
Follow these steps before you perform the upgrade.
- Verify that SBM 2009 R3 or later is installed on the System Information tab in SBM Configurator.
- Back up your existing database.
- Back up the SBM installation directory structure on the Application Engine server.
- Back up the Smart Search index directory on the SBM Common Services server.
- If you store SBM item attachments on the file system, open SBM System Administrator and note the location of the attachments directory. You will enter the location in SBM Configurator later as part of the upgrade.
- If you are using Windows 2003 server, restart your servers prior to the upgrade and ensure that no java.exe processes are running.
- Download the release from support.serena.com.
Server Installation
- Extract the server installation files, and then launch the suite executable on each server. An installer message prompts you to confirm that you are upgrading your system. Click Next to continue.
- The
Upgrade Summary dialog box appears and
summarizes the components that are currently installed and ready for upgrade.
Note the following important information:
- As of
SBM 10.1.5,
Active Diagnostics is now installed with the
SBM Logging Services
component (instead of
SBM Common Services).
This enables you to install and run Active Diagnostics on a dedicated server,
if necessary (for example, if you set the logging level to TRACE for debugging
purposes).
- If you still want to run Active Diagnostics on the same server that hosted the service before the upgrade, select the SBM Logging Services check box on the server that currently hosts SBM Common Services.
- If you decide to move Active Diagnostics to a new server, clear the SBM Logging Services check box, and then install SBM Logging Services on the desired server. When the install is finished, you must update SBM Configurator on each server with the new host name and TCP port for the server that will host SBM Logging Services.
- As of SBM 10.1, the Notification Server and Mail Client are powered by Serena Common JBoss and installed independently from SBM Application Engine as "SBM Mail Services". For upgrades from versions prior to 10.1, the option to install SBM Mail Services is selected by default (except on servers that host only the SBM Application Engine and no other components; in that scenario, you must manually select the SBM Mail Services check box because the installation now includes the Serena Common JBoss service, which consumes additional resources on the server).
- For multi-environment installations that include separate SBM Application Engine installations for test, staging, and production environments, install SBM Mail Services and SBM Logging Services at least once in each environment.
- If you want to uninstall existing components or install new components other than SBM Mail Services or SBM Logging Services, you must use the Windows Add/Remove Programs utility to completely uninstall SBM and then perform a Custom install. This process does not upgrade the current installation. It is recommended that you back up your existing SBM installation directory before you uninstall and reinstall with different component selections.
Note: If you are prompted to restart your server after the installer is finished, SBM Configurator launches automatically once the server has restarted. (On Windows 2008 systems, you must launch SBM Configurator manually once the server has restarted). If you decline to restart the server at this time, you will not be able to run SBM Configurator until the server has restarted. - As of
SBM 10.1.5,
Active Diagnostics is now installed with the
SBM Logging Services
component (instead of
SBM Common Services).
This enables you to install and run Active Diagnostics on a dedicated server,
if necessary (for example, if you set the logging level to TRACE for debugging
purposes).
- If you are upgrading from a release prior to 10.1.5, decide if you will use the Configuration Settings database or not. If you have a distributed installation, it is highly recommended that you use the Configuration Settings database, because it enables you to easily synchronize configuration settings between each SBM server without requiring you to export and import configuration snapshot files.
- If you store SBM item attachments on the file system, enter the location of the attachments directory on the Common Services tab. This enables SBM Common Services to return attachments in Work Center search results. If you store attachments in the database, skip this step.
-
SBM Configurator
detects the current upgrade process, and upgrades the file system by merging
existing configurations from your previous installation into the new
installation files.
Important: You must click Apply to save these changes. You can do this before or after you perform the database upgrade in the next step. Once the file system is upgraded, you can run SBM Configurator again anytime thereafter to verify or modify your configuration settings as needed.
- Click
Upgrade Database on the
Database Servers tab to upgrade the
Application Engine
database. Note the following important information:
- If you want to verify your configuration and save the installation upgrade changes that have occurred before you upgrade the database, click Apply, and then perform the database upgrade later at an appropriate time. Note that you must complete the Application Engine database upgrade before users can access SBM.
- Plan significant time for the database upgrade to complete. When the upgrade finishes successfully, a message appears that directs you to the upgrade log.
- For distributed installations, you perform the database upgrade in SBM Configurator on the server that hosts SBM Application Engine.
- For multi-environment installations, you must upgrade each Application Engine database in each environment.
- Review the database upgrade log file in the Log folder of the installationDirectory\Serena\SBM\Application Engine directory and correct any problems that occurred during the upgrade. If the log file is empty, no errors or warnings occurred during upgrade.
- Merge custom modifications to HTML templates, e-mail templates,
and Web interface online help files made to your upgraded files. Backup
templates are stored in a backup folder in the
installationDirectory\Serena\SBM\Application
Engine\Backup<version>-<date>-<time>
directory.
Note: See solution S141851 for a list of configuration Files, Web Interface templates, JavaScript files, and strings that have changed in this release. You must manually merge some of your existing SSO customizations into the newly installed files after you upgrade your software and database.
If you previously used a custom HTML template for your reports, the reports might not display properly after upgrade. Therefore, consider using the default template or modifying it as needed. For example, as of SBM 10.1.2, several changes were made to Summary Reports that might not display properly using a custom template from a prior release. Instead, either use the new default template or merge your customizations into the default template to create a new custom template.
Important: If you installed the TT4ZMF integration prior to upgrading, you must follow the instructions in the TT4ZMF readme to reinstall the integration after the SBM upgrade is complete. - If you performed the previous step, open SBM System Administrator, select File, and then select Put Files in Database. ALL templates and images in the database are replaced by files on your local machine.
- In SBM Configurator, verify that the services are started in the Manage Services tab.
- Instruct users to clear the cache in their Web browsers.
Client Installation
The client executable contains SBM Composer and is intended to be run only on client machines.
Previous versions of SBM System Administrator are automatically uninstalled as part of the upgrade (administrative duties are now performed using SBM Application Administrator). Previous versions of SBM Composer are upgraded automatically and do not need to be uninstalled prior to upgrading. The new versions are installed in the same location as the old versions.
To upgrade SBM Composer:
- Download the client installer from support.serena.com.
- Launch the installer by double-clicking the file.
- Click Next on the Welcome dialog box.
- Click Install to upgrade the current client installation.
Fixed Issues
A list of defects fixed in this version can be found in the Knowledge Base. You must have a Serena.com user account to view items in the Knowledge Base. Register for a free account if you do not already have one.
Beginning in SBM 10.1, user accounts are managed in SBM Application Administrator rather than in SBM System Administrator. SBM Application Administrator, which requires a connection to the SBM Web server, is not available if the number of users in your system exceeds the number of installed seat licenses.
If you receive a seat license error in a version earlier than SBM 10.1.1.4, contact Customer Support for assistance is resolving the issue. If you have SBM 10.1.1.4 or later installed, the Users tab in the SBM System Administrator is enabled automatically if you encounter this problem. Open SBM System Administrator and delete or modify user accounts so that they are in compliance with their seat licenses. (If you encounter this problem and the SBM System Administrator is already open, you need to close it and reopen it for the Users tab to appear.) Once you resolve user accounts, the Users tab is not visible the next time you open the SBM System Administrator.
Known Issues
This section describes known issues and contains the following categories:
For a complete list of known issues and potential workarounds, refer to the Knowledge Base. You must have a Serena.com user account to view items in the Knowledge Base. Register for a free account if you do not have already have one.
Administrator Issues
- Serena Common JBoss will not start in some cases after the upgrade is finished on Windows 2003 servers. If you are using Windows 2003, you must restart your servers prior to the upgrade and ensure that no java.exe processes are running before you run the installer. For details, refer to D21263.
- The Anonymous Submit feature does not work with in combination Windows Domain authentication, nor against an external virtual directory configured to use anonymous access.
-
The
following issue is only applicable if you had previously upgraded to 10.1 or
10.1.1.1. If you did not use either version prior to upgrading, then you can
ignore this information.
Values in promotion profiles that were created in 10.1 or 10.1.1.1 were set to All by default. Starting with 10.1.1.2, entities for new items (items added to a process app since the profile was created) will be set to None by default.
In addition:- Profiles created prior to 10.1 that had entities set to None may have been incorrectly using All. These entities will be set back to None.
- Profiles created in 10.1 or 10.1.1.1 that had entities set to the default All may also be set to None. These entities must be manually corrected.