Contents
About this Release
SBM 11.2 is the version that immediately follows SBM 11.1. All of the features, changes, and fixes that were made in SBM 11.1 can be found in SBM 11.2. SBM 11.2 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 11.2 from http://www.serena.com/support and then follow the instructions in the SBM Installation and Configuration Guide.
Important Notes
Note the following important information about this release:
- SBM 11.2 requires Serena License Manager 2.2. You must upgrade to version 2.2 before you can upgrade to SBM 11.2.
-
Solution releases prior to and including Serena Service Manager
/ Serena Request Center 5.2 and Serena Release Control 6.0 will not run
properly on
SBM
11.2 and these versions are not supported.
You will need to upgrade each solution to newer, compatible versions before you can use them.
- 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 11.2 is available in U.S. English only.
Supported Upgrade Paths
Upgrades to SBM 11.2 are only supported from SBM 10.1.X or higher. Refer to the following list for guidance on upgrading from your current version.
- Upgrading from 11.X or later
If you are upgrading from 11.X or later, refer to Upgrades from 11.X.
- Upgrading from 10.1.X
If you are upgrading from any version in the 10.1.X line, refer to Upgrades from 10.1.X.
- Upgrading from versions of
SBM
prior to 10.1.X
If you are upgrading from 2009 R4, you can upgrade to any version between 10.1.X and 11.0.1.1 before you upgrade to 11.2. Use the upgrade instructions in the corresponding readme for the first upgrade, and then upgrade to 11.2 using the instructions in either Upgrades from 10.1.X or Upgrades from 11.X, depending on the version you have after the last upgrade.
If you are upgrading from a version prior to 2009 R4, follow the upgrade instructions in solution S138037 to upgrade to 10.1.5.4 first, and then upgrade your 10.1.5.4 installation to SBM 11.2 using the instructions in Upgrades from 10.1.X.
- Upgrading from TeamTrack 6.6.1.X
If you are upgrading from TeamTrack 6.6.1.X, follow the instructions in the Moving to Serena Business Manager guide (available at http://www.serena.com/support) to upgrade to SBM 10.1.5.4 first. In addition refer to solution S137372 to learn about the upgrade preparation utility. After you have upgraded TeamTrack to SBM 10.1.5.4, follow the instructions in Upgrades from 10.1.X to upgrade to SBM 11.2.
- Upgrading from Tracker
For information on migrating your Tracker data to SBM, refer to the "Migrating Tracker Data to SBM" solution (S138468).
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: 11.02.00.00.311 (Build 223)
- SBM Composer : 11.2 (Build 0127)
- SBM System Administrator and SBM Application Administrator: 11.02.00.00.311 (Build 223)
- Application Repository: 11.02.00.00.185 (Build 185)
- SBM Configurator: 11.02.00.00.88
- Database version: 1120000027
- English – 11.2
- 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.
What's New
The following features have been added in this release.
- New File and URL Field Types
- Work Center Side Menu Configuration
- Automatic Refresh for Dashboard Widgets in Work Center
- Configure Service Level Agreements (SLAs) for SBM
- Mail Client Improvements
- E-mail Response Improvements
- Importing and Updating Groups from LDAP
- Orchestration Usage Report
New File and URL Field Types
Designers can now add File and URL field types to process apps. These field types provide greater functionality than simple file and URL attachments, such as adherence to field privilege sets instead of attachment privileges and the ability to require a file or URL to be added on a transition. File and URL field types are supported just like any other field type; however, they are not supported in the following areas:
- Orchestrations
- C++ API
- AppScript
- GSOAP Web services
- Limited API support in public JSON
- Import from spreadsheet (SBM Application Administrator)
- Import from database (SBM System Administrator)
- External post transition
For JSON API calls, files and URLs in these fields are limited to read-only access. For example, a URL for the file is returned, not the actual file. Full support may be added in a future release.
Work Center Side Menu Configuration
Using SBM Application Administrator, administrators can now pin shared views and non-private reports to the Work Center side menu for groups, teams, and individual users. Administrators can also define the default view or report that is displayed for each application and application group in Work Center. For details, refer to "Work Center Side Menu Settings" in the SBM Application Administrator Guide or help.
Automatic Refresh for Dashboard Widgets in Work Center
Users can now set a refresh interval for dashboard widgets in Work Center. This means that users can set a time period (from 2 to 60 minutes) for individual widgets on a dashboard to automatically refresh and display updated data. Widgets that have a refresh interval applied display an orange refresh icon at the top of the widget.
Configure Service Level Agreements (SLAs) for SBM
You can now configure SLAs directly in SBM without installing Serena Service Manager. This means you can configure SLAs on SBM projects and use the built-in SLA reports and the SLA widget with SBM projects. For details on configuring SLAs in SBM, refer to the SBM Application Administrator Guide or help.
Note the following for new installations and upgrades:
- The new SLA engine that is provided with SBM is installed on the same server or servers that host the SBM Notification Service.
- You can stop and start the SLA engine on the Manage Services tab in SBM Configurator on each notification server machine that you have. This provides failover in the event one of the machines is not accessible.
- If you have SSM 5.2.2 or earlier installed, the existing SLA engine from SSM is used instead of the new engine that is installed with SBM. The engine that is provided with SSM will be deprecated in an upcoming SSM release.
- If you have SSM 5.2.2 or earlier installed, you manage the SLA load level on the Service Manager tab in SBM Configurator. The SLA load level is absolute in the SBM SLA engine; therefore this tab does not appear if SSM is not installed. It will be removed from SBM Configurator after SSM 5.2.2.
Mail Client Improvements
The following improvements have been made to the mail client:
- You can now define additional mail servers in SBM Application Administrator to use with the SBM Mail Client. This enables you to create multiple mailboxes that are connected to different mail servers. For example, you might configure a new mailbox for e-mail submission that is hosted in the cloud to supplement your on-premise Exchange server mailbox.
- You can now route e-mail submission messages to different mailboxes based on rules that you define in SBM Application Administrator. For details, refer to "Mailbox Submit Routing" in the SBM Application Administrator Guide or help
- Images that are sent with a reply to the e-mail recorder mailbox are now properly rendered in a work item's notes. Similarly, images included in an e-mail submission are now displayed in rich-text fields when the message body is mapped to a rich-text enabled field.
- Users can now include the [TableId:ItemId] item identifier tag in the e-mail body rather than only in the subject line.
- Users can now specify fields and values in the body of an e-mail submission and SBM will use the values to create the new item. For a list of supported field types that users can send, refer to "Specifying Fields and Values in the Message Body" in the SBM Application Administrator Guide or help.
E-mail Response Improvements
The following improvements have been made to the e-mail response feature:
- You can now specify either the subject or the body as the source field for e-mail response aliases. This means you can now have SBM search for an alias like "Yes" in the subject line of the reply instead of the message body.
- You can now map e-mail fields to SBM fields when you define e-mail response transitions.
- Users can now specify fields and field values in the body of an e-mail response message. For a list of supported field types that users can send, refer to "E-mail Responses" in the SBM Application Administrator Guide or help.
Importing and Updating Groups from LDAP
In SBM Application Administrator, you can now select the Import groups from LDAP option on the Import Users page. In prior releases, you could only import groups from LDAP as part of a user import from LDAP. This meant that if LDAP users did not contain references to specific groups, there was no easy way to import those groups. You can now import groups explicitly and perform the following actions:
- Schedule group imports and updates from LDAP
- Import groups from LDAP and map their attributes to SBM groups
- Update groups from LDAP
- Update groups from LDAP and add any new users that were added in LDAP
- Update group membership in SBM based on LDAP groups
- Update group membership and update users in those groups based on mapped attributes
- Update group membership, update users in those groups, and add any users to SBM that are not in SBM already
Orchestration Usage Report
Administrators can now use the Application Usage report in Work Center to view the number of times an orchestration was called, the duration of orchestrations, or the number of users that called orchestrations during a specified period of time. Note that after upgrade, only asynchronous orchestration data is logged automatically; to run reports for synchronous orchestration usage, you must redeploy the associated process app first. For details on migrating existing asynchronous orchestration data collected prior to the upgrade in the Event Manager tables, refer to solution S141958.
Additional Changes
The following sections describe additional features that have been changed or added to this release.
End-user Changes
Serena Work Center Changes
- Required Notes and Attachments in Kanban Boards
When a user moves a card to a different column and selects a transition that requires a new note or attachment, the Item Details pane now prompts the user for the required note or attachment. In the prior release, the user had to use the full item view to transition the item and provide the required note or attachment.
- Automatically Pin View to Menus Option Removed
The Automatically pin view to menus check box has been removed from the view sharing tab. Administrators can now pin views and reports for users, groups, and teams using Application Administrator. Views that were pinned via this option prior to upgrade will still be pinned after the upgrade to 11.2 and Application Administrator will reflect this in the group, team, or user preferences.
- Miscellaneous Changes
- In the Create New Feed wizard, you can now click Preview to view a list of items returned by a feed.
- Users can now resize column widths on the backlog list and backlog history pages. To revert changes, users can select Reset Backlog List Layout from the Actions menu.
Reporting Changes
Report Improvements
- Specify Multiple Values for Query-At-Runtime Text Fields
Users can now specify multiple text values when providing query-at-runtime values in a text field. For example, a user can enter a query-at-runtime value for the Title field and then click Add to specify any additional values in the field. This creates a search string like: Title contains 'a' OR Title contains 'b' OR Title contains 'c'.
- Schedule Built-In and System Reports
Administrators can now schedule built-in reports and system reports. Note that this does not include reports that require query-at-runtime parameters.
- More Graphical Reports for Schedule Reports
Graphical report styles that were added in SBM 11.1 (Doughnut Chart, Heatmap Chart, and Radar Chart) can now be delivered via a scheduled report.
- Use Notification Server From Address for Scheduled Reports
You can now change the From address by editing the scheduled report template or you can clear the value in the template and use the default From Address that is specified in the Notification Server settings in SBM Configurator. If an address is not specified there, the e-mail address of the author of the scheduled report is used instead.
- Manually Specify Plus and Minus Values for Start and End
Dates
Users can now type custom plus and minus values for start and end dates in a report. For example, in prior releases, users could only select predefined values (like Plus 7 or Minus 7) from the date/time keyword list. Users can now type Plus 10 or Minus 10 to specify a start or end date that is 10 days after or 10 days prior.
- Advanced Conditions in Join Reports
The Advanced link now appears when users add or modify a join. This enables users to use logical operators and parentheses when defining join conditions.
- Use Sub-Relational Fields for Rows and Columns in Distribution
Reports
Users can now specify sub-relational fields for both row and column definitions in a distribution report. Users can now also specify sub-relational fields that point to auxiliary table fields, other primary table fields, or sub-relational fields in the current primary table for both the row and column definition. However, note that sub-relational fields cannot be used with join conditions.
Administrator Changes
SBM Application Administrator Changes
- Locked Record ID
In SBM Application Administrator, you can now view the item ID of a locked record on the Record Locks page. This makes it easier to find locked records in the end-user interfaces.
- Generate Temporary Passwords for Imported Users
You can now have temporary passwords generated for users that are added or updated via the Import Users option. For new users, this option ensures that users are not created with blank passwords. For existing users, this option is useful in the event the initial e-mail that contains the temporary password is lost or sent to the wrong e-mail address.
SBM Application Repository Changes
- Acquire OAuth 2 Tokens Directly in
Application
Repository
You can now acquire the OAuth2 access token and refresh token for an OAuth 2 endpoint directly in Application Repository instead of using a command-line utility.
- Promote Reports with Joins
You can now promote reports that contain joins. During promotion, Application Repository assesses the target environment and tries to resolve references before the promote finishes. If a reference cannot be resolved, any report that contains such a reference is dropped from the promotion payload.
- Updated Color and Styling
Application Repository colors and styles have been updated to match those used in Work Center.
Installation and Configuration Changes
SBM Configurator Changes
- You can use
SBM Configurator
to implement predefined or custom authenticators and identity transformers when
SBM is
configured to use
SSO.
This means you can now set up and configure
Smart Card
authentication using
SBM Configurator
as well. For details, refer to the "Custom Authentication Settings" topic in
the
SBM Installation and Configuration
Guide
or
SBM Configurator
help.
Important: If you have defined custom authenticators and identity transformers for SBM in the configuration.xml file, each entry is preserved after upgrade and should appear in SBM Configurator as long as they are defined in the correct section of the configuration.xml file (comments in this file describe where each entry should go). If you have mistakenly placed authenticators outside of the correct sections in this file, your custom authentication settings will not be preserved. Therefore as a precaution, if you have defined custom authenticators, Serena recommends that you back up your current configuration.xml file before you perform the upgrade. You can refer to this file to rebuild your custom authenticators in SBM Configurator after the upgrade is finished if necessary.
- You can now manage the Web services invocation timeout option on the Performance tab in SBM Configurator. This setting controls the amount of time SBM should wait for a Web service to return calls and the time to wait for a synchronous orchestration reply from ODE. This setting was previously only accessible via SBM System Administrator.
- You can now select Use HTTPS for endpoints when configuring SAML2 service provider settings for SBM on the External Identity Provider tab in SBM Configurator. If Tomcat is configured to use HTTPS, this is selected by default. You can clear this check box if HTTPS is not used or not desired.
SBM Composer Changes
- Find Field Overrides and Privilege Overrides
You can now locate where fields are overridden throughout an application. Right-click a field, and then select Overrides or Privileges to view the workflows, states (privileges overrides only), and transitions that contain an override for the selected field.
- Support for External Reports in Relational Grid Widget
You can now access external reports when you use the Relational Grid widget. Just as with the Embedded Reports widget, you create the report in Serena Work Center or the SBM User Workspace, and then configure the widget by specifying the report's reference link.
- Show/Hide Item ID in Relational Field's Value Display Format
By default, the Item ID is now hidden in the value display format of Single-Relational and Multi-Relational fields. This applies to primary tables and any auxiliary tables that include the Item ID.
To show the Item ID of Single-Relational and Multi-Relational fields, in the table Property Editor, select the Include 'Item Id' checkbox or add the Item ID to the value display format.
-
Multiple Search Filters on a Single Field
For application reports, you can now define search filters that include the same field multiple times. For example, you can create a search filter to enable users to filter results where the submit date is greater than one query-at-runtime value, and less than a second query-at-runtime value.
Orchestration Changes
- New renew options: -clearEventLog and -clearCommonLog
You can now use these renew utility commands to purge the common log and event log in the event they have grown large enough in size that timeouts occur during the purge operation in Application Repository or SBM Composer.
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)
- 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
- Standard logout behavior when a user closes the browser or tab that hosts SBM, or when a user navigates away from SBM to another page. This means the behavior is the same whether a user formally logs out or if he or she ends the session by closing the browser or navigating to a different page. Note that the sixty-minute idle timeout remains in place if the session is left open and the user does not log out through one of these means.
- 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 from 11.X
Review this section for upgrades to SBM 11.2 from earlier versions in the 11.x line. If you are upgrading from 10.1.X, refer to Upgrades from 10.1.X.
To test the upgrade, Serena recommends that you mimic your current installation on a separate set of servers. This test installation should include all of the environments used by your system. Upgrade and test this installation before upgrading your production installation. To upgrade successfully, you must upgrade each server and client machine to SBM 11.2.
- Requirements and Changes
- Planning for the Upgrade
- Pre-Upgrade Steps
- Upgrading the Installation
- Post-Upgrade Tasks
- Upgrading Customizations and Integrations
Requirements and Changes
Before you upgrade to SBM 11.2, read the following important information:
- If you have defined custom authenticators and identity transformers for SBM in the configuration.xml file, each entry is preserved after upgrade and should appear in SBM Configurator as long as they are defined in the correct section of the configuration.xml file. If you have mistakenly placed authenticators outside of the correct sections in this file, your custom authentication settings will not be preserved. Therefore as a precaution, if you have defined custom authenticators, Serena recommends that you back up your current configuration.xml file before you perform the upgrade. You can refer to this file to rebuild your custom authenticators in SBM Configurator after the upgrade is finished if necessary.
- If you used
HTTP Basic Authentication to manage user sessions prior to the
upgrade,
SBM Configurator
automatically converts this to
SSO
once the upgrade is finished. The
HTTP Basic Authentication option has been deprecated and is no
longer available in
SBM Configurator
because there are more secure options for managing user sessions.
Electronic signatures are now authenticated according to what is selected for Web services authentication in SBM Configurator if you are using Windows Authentication or Third-Party Authentication System for Browser authentication. Prior to 11.1, electronic signatures were always authenticated against the internal SBM database.
If you need assistance with re-enabling legacy behavior for either setting, please contact Serena Support.
- 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.
- Work Center
search operates on pre-built indices that may change for each
SBM
release. The
Work Center
search index is rebuilt when Tomcat is started for the first time after the
upgrade. The complete indexing operation can take ample time to finish for very
large databases; however, some search results in
Work Center
begin to appear immediately and the number of results continues to grow while
the initial indexing operation works toward completion.
You can view the overall progress of the indexing operation in the ssf.log file located on the server that hosts SBM Common Services. The log file is located here:
installDir\Serena\SBM\Common\Tomcat 7.0\server\default\logs
- For Oracle systems, note the following:
- You must ensure that the required roles and privileges for the SBM schema user are up-to-date. Refer to solution S133641 for details.
- You must perform the database upgrade using either the SBM DSN or a system DSN that uses the "Oracle for SBM" driver. If your system used the Mashup2009 DSN prior to the upgrade, that DSN is automatically converted to use the new "Oracle for SBM" driver.
Planning for the Upgrade
The upgrade process you will follow depends on the type of installation you currently have:
- Single Server Installation – All of the SBM components are
installed on a single server.
For single server installations, you will run the suite installer on your server and then upgrade the databases using SBM Configurator.
- Distributed Installation – The SBM components are installed
on multiple servers that comprise a single production environment.
For distributed installations, you will run the suite installer on each server, and then use SBM Configurator to upgrade the databases.
- Multi-environment installation – The SBM components are
installed on single or multiple servers that are separated into multiple SBM
environments (such as development, test, and production).
The process for upgrading multiple environments (used in a path to production model) depends on which environment hosts SBM Application Repository and which environment you plan to upgrade first (Test/Staging first or Production first).
- If
SBM Application
Repository
is part of the Test environment and you plan to upgrade Test first
In this setup, each environment uses a single instance of Application Repository that is installed in the Test environment. You will upgrade the Application Engine and Orchestration Engine databases in the Test environment first. After the upgrade in Test is finished, you will not be able to deploy to Production from Application Repository until you upgrade the Production servers and databases.
- If
SBM Application
Repository
is part of the Production environment and you plan to upgrade Test first
In this setup, each environment uses a single instance of Application Repository that is installed in the Production environment. You will upgrade the Application Engine and Orchestration Engine databases in the Test environment first. After the upgrade in Test is finished, you will not be able to deploy to Test from Application Repository until you upgrade the Production servers and databases.
- If
SBM Application
Repository
is part of either Production OR Test and you plan to upgrade all environments
at the same time
If you plan to upgrade all environments at the same time (one immediately after the other), upgrade the instance that hosts Application Repository first (likely Production). This will allow you to upgrade the other environments that do not have SBM Application Repository without installing a temporary instance.
- If
SBM Application
Repository
is part of the Test environment and you plan to upgrade Test first
Pre-Upgrade Steps
Follow these steps before you perform the upgrade.
- Verify that SBM 11.X or later is installed on the System Information tab in SBM Configurator.
- Back up your existing databases.
- 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 need to revert the upgrade for any reason, you will restore the index from this backup (because the index is rebuilt as part of the upgrade).
- Consider consulting with your DBA to assess the current table indexes in the SBM databases. Because significant database schema changes do not necessarily coincide with each database upgrade, table indexes are not automatically rebuilt as part of the upgrade process. Over time, indexes can report excessive fragmentation, which could negatively impact performance if they are not rebuilt periodically.
- Create a new database space in your DBMS to host the Configuration Settings database if you did not create it in a prior release. As of SBM 10.1.5, you can use this database to store configuration settings across your entire SBM installation in one centralized location.
- Download the new suite and client installers from support.serena.com.
Upgrading the Installation
- Extract the server installation files, and then launch the suite installer. An installer message prompts you to confirm that you are upgrading your system. Click Next to continue.
- The
Ready to Upgrade dialog box appears. Click
Upgrade Now to being upgrading the server installation. At the
end of the installation upgrade, click
Configure to launch
SBM Configurator.
Note: If you are prompted to restart your server, SBM Configurator launches automatically once the server has restarted. (On Windows 2008 systems, you must manually launch SBM Configurator after the restart). If you decline, you will not be able to run SBM Configurator until the server has been restarted.
- Decide if you will use the
Configuration Settings database if you have not done so
already. 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.
On the Database Servers tab, enter database connection information for the Configuration Settings database that you created as part of the pre-upgrade process.
- Verify your configuration settings, and then click
Apply.
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 before you upgrade the database. Once the file system is upgraded, you can run SBM Configurator again anytime thereafter to verify or modify your configuration settings as needed.
- Open the
Database Servers tab in
SBM Configurator,
and then click
Upgrade Database.
Tip: If any errors occur during the Application Engine database upgrade, review the upgrade log here:
installDirectory\Serena\SBM\Application Engine\log
If an ORA-00904 message appears in the Application Engine upgrade log after you finish upgrading the Application Engine database, refer to solution S141358 for a description of the problem and a resolution.
After the database is upgraded successfully, verify that the services are started in the Manage Services tab. Instruct Application Repository users to clear the cache in their Web browsers before they attempt to access SBM Application Repository.
- On each client machine, run the client installer. The client executable contains SBM Composer and is intended to be run only on client machines. Previous versions of SBM Composer are upgraded automatically and do not need to be uninstalled prior to upgrading. The new version is installed in the same location.
Post-Upgrade Tasks
Review the following information and make any necessary changes after you have upgraded your servers and databases:
- 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, 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.
- For systems that are configured to use client certificate authentication, you must perform additional configuration steps after the upgrade or disable the feature entirely. For details, refer to the entry about client certificate authentication in Installation and Configuration Issues.
- HTML rendering and Rich Text editing is enabled by default for all notes in your system after the upgrade. 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.
- 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.
-
The Require appended text option, available for Journal fields on the Attributes tab (field Property Editor) and the Field Overrides tab (workflow Property Editor) now works as intended. When the Required and Require appended text options are selected, users must append text to the field during a transition. When only Required is selected, users do not need to append text if there is an existing entry.
In past releases, selecting only the Required option would require users to append text to an existing entry. Now, the Require appended text option must also be selected to require users to append text.
Upgrading Customizations and Integrations
Review the following information for help with upgrading custom changes and integrations.
-
If you made custom modifications to any HTML templates, e-mail templates, or online help files, you must merge your changes into the newly-upgraded files, and then use SBM System Administrator to Put Files in Database. All templates and images in the database are replaced by files on your local machine as part of this operation. Backup templates are stored on the installationDirectory\Serena\SBM\Application Engine server here:
installDir\Serena\SBM\Application Engine\Backup<version>-<date>-<time>
Note: For a list of configuration Files, Web Interface templates, JavaScript files, and strings that have changed in this release, refer to solution S141969. You must manually merge some of your existing SSO customizations into the newly installed files after you upgrade your software and database. - 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 configured your system to use anonymous events prior to the upgrade, you must either add credentials to your events (preferred) or you must select the Allow Anonymous Events check box in SBM Configurator and enter an SBM user name and password to use anonymous events after the upgrade.
Upgrades from 10.1.X
Review this section for upgrades to SBM 11.2 from versions in the 10.1.X line. If you are upgrading from 11.0 or higher, refer to Upgrades from 11.X.
To test the upgrade, Serena recommends that you mimic your current installation on a separate set of servers. This test installation should include all of the environments used by your system. Upgrade and test this installation before upgrading your production installation. To upgrade successfully, you must upgrade each server and client machine to SBM 11.2.
- Requirements and Changes
- Planning for the Upgrade
- Pre-Upgrade Steps
- Upgrading the Installation
- Upgrading the Databases
- Post-Upgrade Tasks
- Upgrading Customizations and Integrations
Requirements and Changes
Before you upgrade to SBM 11.2, read the following important information:
- SBM 11.2 requires Serena License Manager 2.2. You must upgrade to version 2.2 before you can upgrade to SBM 11.2.
- SBM 11.2 requires 64-bit Windows servers. If you are using 32-bit servers prior to the upgrade, you must install SBM 11.2 on one or more 64-bit machines, and then upgrade the databases using the 64-bit installation. As part of the upgrade, review and upgrade any scripts and APIs that were originally created on a 32-bit operating system to ensure that they also run on a 64-bit system. For example, if you have any scripts that load .dll files, those .dll files must be upgraded to run on a 64-bit machine.
- If you have defined custom authenticators and identity transformers for SBM in the configuration.xml file, each entry is preserved after upgrade and should appear in SBM Configurator as long as they are defined in the correct section of the configuration.xml file. If you have mistakenly placed authenticators outside of the correct sections in this file, your custom authentication settings will not be preserved. Therefore as a precaution, if you have defined custom authenticators, Serena recommends that you back up your current configuration.xml file before you perform the upgrade. You can refer to this file to rebuild your custom authenticators in SBM Configurator after the upgrade is finished if necessary.
- If you used
HTTP Basic Authentication to manage user sessions prior to the
upgrade,
SBM Configurator
automatically converts this to
SSO
once the upgrade is finished. The
HTTP Basic Authentication option has been deprecated and is no
longer available in
SBM Configurator
because there are more secure options for managing user sessions.
Electronic signatures are now authenticated according to what is selected for Web services authentication in SBM Configurator if you are using Windows Authentication or Third-Party Authentication System for Browser authentication. Prior to 11.1, electronic signatures were always authenticated against the internal SBM database.
If you need assistance with re-enabling legacy behavior for either setting, please contact Serena Support.
- 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.
- Work Center
search operates on pre-built indices that may change for each
SBM
release. The
Work Center
search index is rebuilt when Tomcat is started for the first time after the
upgrade. The complete indexing operation can take ample time to finish for very
large databases; however, some search results in
Work Center
begin to appear immediately and the number of results continues to grow while
the initial indexing operation works toward completion.
You can view the overall progress of the indexing operation in the ssf.log file located on the server that hosts SBM Common Services. The log file is located here:
installDir\Serena\SBM\Common\Tomcat 7.0\server\default\logs
- For upgrades from 10.1.X, as part of the database
upgrade and migration to the new ODE BPEL engine, data in the CL_CONTEXT_VALUE
and CL_LOG tables is deleted. New indexes are added to the CL_CONTEXT_VALUE and
CL_LOG tables on upgrade to prevent time outs from occurring when you try to
view Common Log data in
SBM Composer
or
SBM Application
Repository.
In order to add the new indexes, these tables will be emptied during the
upgrade process.
Important: If you need to view Common Log data that was present prior to the upgrade, ensure that you have backed up these tables.
- For Oracle systems, note the following:
- You must ensure that the required roles and privileges for the SBM schema user are up-to-date. Refer to solution S133641 for details.
- You must perform the database upgrade using either the
SBM DSN or a system DSN that uses the "Oracle for SBM" driver. If your system used the Mashup2009
DSN prior to the upgrade, that DSN is automatically converted to use the new
"Oracle for SBM" driver.
Important: The underlying driver in the DSN that ships with SBM was changed in SBM in 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.
Planning for the Upgrade
The upgrade process you will follow depends on the type of installation you currently have:
- Single Server Installation — All of the SBM components are
installed on a single server.
For single server installations, you will run the suite installer on your server and then upgrade the databases using SBM Configurator. The databases are upgraded in two phases—in phase one, the Application Engine database is upgraded; once it completes successfully, phase two begins. In phase two, you are prompted to enter the SBM user name and password of your primary system administrator or an SBM user that has the Remote Administration privilege to upgrade the Orchestration Engine database.
- Distributed Installation — The SBM components are installed
on multiple servers that comprise a single production environment.
For distributed installations, you will run the suite installer on each server, and then use SBM Configurator to upgrade the databases. When you begin the Orchestration Engine database upgrade on the server that hosts SBM Orchestration Engine, you are prompted to enter the SBM user name and password of your primary system administrator or an SBM user that has the Remote Administration privilege. This scenario requires that you start the SBM services and that you perform the database upgrades in a certain order. This is explained in more detail below in Upgrading the Databases.
- Multi-environment installation — The SBM components are
installed on single or multiple servers that are separated into multiple SBM
environments (such as development, test, and production).
The process for upgrading multiple environments (used in a path to production model) depends on which environment hosts SBM Application Repository and which environment you plan to upgrade first (Test/Staging first or Production first).
- If
SBM Application
Repository
is part of the Test environment and you plan to upgrade Test first
In this setup, each environment uses a single instance of Application Repository that is installed in the Test environment. You will upgrade the Application Engine and Orchestration Engine databases in the Test environment first. After the upgrade in Test is finished, you will not be able to deploy to Production from Application Repository until you upgrade the Production servers and databases.
- If
SBM Application
Repository
is part of the Production environment and you plan to upgrade Test first
In this setup, each environment uses a single instance of Application Repository that is installed in the Production environment. You will upgrade the Application Engine and Orchestration Engine databases in the Test environment first. After the upgrade in Test is finished, you will not be able to deploy to Test from Application Repository until you upgrade the Production servers and databases.
- If
SBM Application
Repository
is part of either Production OR Test and you plan to upgrade all environments
at the same time
If you plan to upgrade all environments at the same time (one immediately after the other), upgrade the instance that hosts Application Repository first (likely Production). This will allow you to upgrade the other environments that do not have SBM Application Repository without installing a temporary instance.
For information about warnings that may appear during a multi-environment upgrade, see "Handling Warnings with Multiple Environments in S141802.
- If
SBM Application
Repository
is part of the Test environment and you plan to upgrade Test first
If you are upgrading from a release prior to 10.1.2, use SBM Configurator to designate which server will host the SBM Logging Services component. By default, SBM Logging Services appears on an undefined server until you drag and drop it to the desired server. If you are upgrading from a release after 10.1.2, SBM Logging Services is enabled on the same machine as SBM Common Services by default. You can use SBM Configurator to move it to a dedicated server, if necessary (for example, if you set the logging level to TRACE for debugging purposes).
Pre-Upgrade Steps
Follow these steps before you perform the upgrade.
- Verify that SBM 10.1.X or later is installed on the System Information tab in SBM Configurator.
- Back up your existing databases.
- 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 need to revert the upgrade for any reason, you will restore the index from this backup (because the index is rebuilt as part of the upgrade).
- Consider consulting with your DBA to assess the current table indexes in the SBM databases. Because significant database schema changes do not necessarily coincide with each database upgrade, table indexes are not automatically rebuilt as part of the upgrade process. Over time, indexes can report excessive fragmentation, which could negatively impact performance if they are not rebuilt periodically.
- 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.
- Create a new database space in your DBMS to host the Configuration Settings database if you did not create it in a prior release. As of SBM 10.1.5, you can use this database to store configuration settings across your entire SBM installation in one centralized location.
- Download the new suite and client installers from support.serena.com.
Upgrading the Installation
- Extract the server installation files, and then launch the suite installer. An installer message prompts you to confirm that you are upgrading your system. Click Next to continue.
- The
Ready to Upgrade dialog box appears. Click
Upgrade Now to being upgrading the server installation. At the
end of the installation upgrade, click
Configure to launch
SBM Configurator.
Note: If you are prompted to restart your server, SBM Configurator launches automatically once the server has restarted. (On Windows 2008 systems, you must manually launch SBM Configurator after the restart). If you decline, you will not be able to run SBM Configurator until the server has been restarted.
- Decide if you will use the
Configuration Settings database if you have not done so
already. 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.
On the Database Servers tab, enter database connection information for the Configuration Settings database that you created as part of the pre-upgrade process.
- 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.
- Verify your configuration settings, and then click
Apply.
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 before you upgrade the Application Engine and Orchestration Engine databases. Once the file system is upgraded, you can run SBM Configurator again anytime thereafter to verify or modify your configuration settings as needed.
- On each client machine, run the client installer. The client executable contains SBM Composer and is intended to be run only on client machines. Previous versions of SBM Composer are upgraded automatically and do not need to be uninstalled prior to upgrading. The new version is installed in the same location.
Upgrading the Databases
The database upgrade process occurs in two phases when upgrading from 10.1.X to any version in the 11.X line. Review the following important information before you begin.
- The Orchestration Engine database upgrade is no longer automatically performed after you start the SBM services; instead, you must manually invoke the upgrade process by clicking the Upgrade Database link in SBM Configurator. This ensures that the Orchestration Engine database is not upgraded prematurely.
- If SBM Application Engine and SBM Orchestration Engine are installed on the same server, the Orchestration Engine database upgrade is performed immediately after the Application Engine database upgrade.
- If
SBM Application Engine
and
SBM Orchestration Engine
are installed on separate servers:
- You must ensure that IIS is started on the SBM Application Engine server and SBM Tomcat is started on each of the other SBM servers. Both IIS and SBM Tomcat must be running and all components must be accessible from the SBM Orchestration Engine server before the Orchestration Engine database upgrade begins.
- You must upgrade the Application Engine database on the SBM Application Engine server first, and then upgrade the Orchestration Engine database on the SBM Orchestration Engine server.
- The Orchestration Engine database upgrade is performed by the renew utility using the user account that you specify when prompted. For details on this process and more information related to the Orchestration Engine database upgrade, refer to S141802.
When you are ready, open the Database Servers tab in SBM Configurator, and then click Upgrade Database.
installDirectory\Serena\SBM\Application Engine\log
If an ORA-00904 message appears in the Application Engine upgrade log after you finish upgrading the Application Engine database, refer to solution S141358 for a description of the problem and a resolution.
After the databases are upgraded successfully, verify that the services are started in the Manage Services tab. Instruct Application Repository users to clear the cache in their Web browsers before they attempt to access SBM Application Repository.
Post-Upgrade Tasks
Review the following information and make any necessary changes after you have upgraded your servers and databases:
- 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.
- For systems that are configured to use client certificate authentication, you must perform additional configuration steps after the upgrade or disable the feature entirely. For details, refer to the entry about client certificate authentication in Installation and Configuration Issues.
- HTML rendering and Rich Text editing is enabled by default for all notes in your system after the upgrade. 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 upgrade,
SBM
reviews the existing JBoss configuration and allocates the same amount of
memory to Tomcat that was previously allocated to JBoss. After the upgrade, if
you need to adjust the amount of memory that is allocated to Tomcat, perform
the following steps:
- Stop the SBM Tomcat service.
- Navigate to installDirectory\Serena\SBM\Common\Tomcat 7.0\bin, and edit the common_config.bat file.
- Change the JVM_X_MAXMEMSIZE value as necessary.
- In the same \bin directory, execute the update_tomcat_config.bat file.
- Start the SBM Tomcat service.
- After the database upgrades are finished, use the Reset Administrative User Access wizard in SBM System Administrator if your database does not contain at least one Regular User or Managed Administrator account with Remote Administration privilege. 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.
- 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.
-
The Require appended text option, available for Journal fields on the Attributes tab (field Property Editor) and the Field Overrides tab (workflow Property Editor) now works as intended. When the Required and Require appended text options are selected, users must append text to the field during a transition. When only Required is selected, users do not need to append text if there is an existing entry.
In past releases, selecting only the Required option would require users to append text to an existing entry. Now, the Require appended text option must also be selected to require users to append text.
Upgrading Customizations and Integrations
Review the following information for help with upgrading custom changes and integrations.
-
If you made custom modifications to any HTML templates, e-mail templates, or online help files, you must merge your changes into the newly-upgraded files, and then use SBM System Administrator to Put Files in Database. All templates and images in the database are replaced by files on your local machine as part of this operation. Backup templates are stored on the installationDirectory\Serena\SBM\Application Engine server here:
installDir\Serena\SBM\Application Engine\Backup<version>-<date>-<time>
Note: For a list of configuration Files, Web Interface templates, JavaScript files, and strings that have changed in this release, refer to solution S141969. You must manually merge some of your existing SSO customizations into the newly installed files after you upgrade your software and database.If you used custom HTML templates in your reports, the reports might not display properly after upgrade. Consider using the default template or modifying it as needed instead. 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 chanes into the default template to create a new custom template.
- 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.
- In
SBM
10.1.2, the
SSO
Login Application (Federation Server) was 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 were been merged
and replaced with a new
idp directory on the
SSO
server.
If you are upgrading from a release prior to 10.1.2 and you have created custom SSO integrations, you must review all URLs and calls to ensure that they use the latest directory names. For example, if your existing integrations call the Security Token Service (STS), you must ensure that the new idp directory is used.
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.
- If you configured your system to use anonymous events prior to the upgrade, you must either add credentials to your events (preferred) or you must select the Allow Anonymous Events check box in SBM Configurator and enter an SBM user name and password to use anonymous events after the upgrade.
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 have 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.
Installation and Configuration Issues
- The
SBM
Tomcat components in 11.1 run on Java 8. Due to known issues in this version,
if client certificate authentication is enabled between components in
SBM,
all communication from Tomcat to IIS fails. Also, if SSO is used, users cannot
log in to
SBM
when client certificate authentication is enabled. This means that you if have
client certificate authentication enabled prior to the upgrade, you must
disable it after the upgrade is finished. Alternatively, you can leave client
certificate authentication enabled, and perform the steps described in
D22099 to work around this problem.
Once these defects (described here and here) are addressed, Serena will update the jdk that is included with SBM.
Administrator Issues
SBM Application Repository Issues
-
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.