- About this Release
- What's New
- Additional Changes
- Modern Browser Support
- About the Orchestration Engine Database Upgrade
- Fixed Issues
- Known Issues
SBM 11.0 is the version that immediately follows SBM 10.1.5.2. All of the features, changes, and fixes that were made in SBM 10.1.5.2 can be found in SBM 11.0.
SBM 11.0 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.0 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:
- SBM 11.0 requires Serena License Manager 2.2. You must upgrade to version 2.2 before you can upgrade to SBM 11.0.
- 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.0 and these versions are not supported. You will need to upgrade each solution to newer versions once they become available. Compatible versions of Serena Service Manager, Serena Request Center, and Serena Release Control will be available soon after the release of SBM 11.0.
- 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.0 is available in U.S. English only.
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|
|SBM Application Administrator|
|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.
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).
The following component build numbers apply to this version:
- SBM User Workspace and Serena Work Center: Build 11.00.00.00.620 (Build 451)
- SBM Composer : 11.0 (Build 0196)
- SBM System Administrator and SBM Application Administrator: 11.00.00.00.620 (Build 451)
- Application Repository: Build 11.00.00.00.620 (Build 439)
- SBM Configurator: 11.00.00.00.307
- Database version: 1100000041
- English – 11.0
- Japanese – 2009 R4.01 (the translated content applies to version 2009 R4.01)
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.
The following features have been added in this release.
- Advanced Reports
- Report Filters
- Editable Grid in Work Center
- Include Images in Notifications
- Custom Forms with Auto-Sections
- REST Grid Widget Client Side Paging
- REST Grid Widget Column Visibility
- Custom Process App Endpoints
- Support for OAuth 2
- SBM Tomcat
- Apache Orchestration Director Engine (ODE)
- Web Application Firewall
Administrators with advanced knowledge of SQL can now write queries that are bound as read-only auxiliary tables (views) in the SBM database, which users can access to create advanced reports. These virtual tables can potentially include data from any table in the SBM database, and you can write SQL queries that join data from tables outside the SBM database as well.
The SQL that is used to generate the views is defined in XML files that are hosted on the Application Engine server. When view generation is invoked by SBM, the query is executed, and the data is made visible in a way that allows SBM to treat it like any other auxiliary data in the system. For more information, refer to "Creating Query Views for Advanced Reports" in the SBM Application Administrator Guide.
Users can now take advantage of report filters to limit report results according to a set of pre-defined conditions. With report filters, you can define report search criteria once in Work Center, and then reuse the same criteria across several different reports via a single filter. This means when you create a report, you can select an existing report filter on the Search Filter tab instead of having to define the same report conditions multiple times in multiple reports.
Most business rules that designers create in SBM Composer can be reused as report filters as well. Applicable rules that were deployed prior to the upgrade will automatically appear in the Report filters list in Work Center and in the Fields drop-down list on the Create Report | Search Filter tab.
For more detail, refer to the Serena Work Center Guide or the SBM Reporting Guide. For details on using rules as report filters, refer to the SBM Composer Guide.
The Editable Grid feature is now available for Listing reports in Work Center, enabling you to update and transition multiple items at once from a grid view. Previously available only in SBM User Workspace, the Editable Grid has been redesigned in Work Center using HTML5, resulting in a clean, modern user interface. Some of the benefits the Editable Grid offers include:
- Multiple levels of committing and undoing changes, from all items in an editing session to individual items and fields in those items
- A Rich Text Editor for fields that have rich text enabled
- The ability to view and edit all fields for an item, not just those in the report
- The ability to resize rows and columns within the grid, as well as sort columns
A new Enable inline images option has been added for notifications. This feature enables the Notification Server to include images from Rich Text fields in notification messages and e-mails that are sent from the browser. On-premise customers can use SBM Configurator to toggle this option on or off globally (for all notifications), or toggle it on or off for specific notifications using Application Administrator. On-demand customers can toggle it on or off for specific notifications using Application Administrator. Note that this option is enabled in SBM Configurator and on every notification by default after the upgrade to SBM 11.0.
Custom forms now include a feature called auto-sections. With this feature, the sections in the form will be automatically populated at runtime based on field privileges. This enables you to leverage the automatic layout of fields while still customizing the form as needed. For example, you can add logos, widgets, form actions, and other customizations without worrying about field placement. You can also manually place some fields within any section, while letting the rest of the fields be automatically placed at runtime.
When you add new fields to the primary table or to an auxiliary table, they will be automatically added to their respective privilege sections in all custom forms with auto-sections.
You can read more about this enhancement and other form improvements at Serena Central.
Client-side pagination of records returned from REST services lets end users page through records already in the browser. This is appropriate for smaller sets of data, whereas server-side pagination is best for very large sets of data. Benefits include the following:
- Easy configuration: simply set client-side paging on and enter the number of records per page; no need for further configuration of the REST widget to support the paging
- Supports sorting: End users can sort data in ascending and descending order by clicking the column headers
You can now create custom process app endpoints in SBM Composer and SBM Application Repository. Benefits include the following:
- You can name them whatever best describes their purpose.
- Using a shared list of custom endpoints allows complete flexibility in how they are used. For example, you could use one of them for five different REST Grid widgets, and a second one for an otherwise identical REST Grid widget.
You can read more about this enhancement at Serena Central and in the SBM Composer Guide. For a detailed use case that describes how to use custom endpoints in the REST Grid Widget, see this article at Serena Central.
You can now configure and use OAuth 2 security for external RESTful endpoints that you configure in SBM. For example, you can now select OAuth 2 for endpoint security in a RESTGrid widget, deploy your process app, and then configure the OAuth 2 token information when you edit the environment in SBM Application Repository. For details on obtaining and specifying OAuth 2 tokens, refer to the SBM Application Repository Guide.
The SBM Java components are now powered by Apache Tomcat instead of JBoss. This enables SBM to run on an updated platform that provides greater flexibility for future SBM development. As part of the upgrade, the Serena Common JBoss service is replaced by the SBM Tomcat service. You can control the SBM Tomcat service from the Manage Services tab in SBM Configurator or in Windows Service Manager.
- Serena Service Manager 5.2.1 – Q4CY15
- Serena Release Control 6.X – Q2CY16
Coinciding with the change from JBoss to Tomcat, the SBM Orchestration Engine now uses Apache ODE instead of JBPM (which only supports BPEL 1.1 and is no longer maintained). Apache ODE provides improved performance and greater flexibility for future extensions and features. For details on ODE, visit http://ode.apache.org/.
The default BPEL target server endpoint is automatically updated in Application Repository as part of the upgrade.
You can now implement tighter security screening in SBM by enabling the ModSecurity web application firewall on the Security tab in SBM Configurator. You can choose to enable threat detection logging (via the Log option), or threat detection logging and request filtering (via the Block option) depending on your needs. This option is disabled by default for new installations and upgrades. For details refer to the SBM Installation and Configuration Guide.
The following sections describe additional features that have been changed or added to this release.
SBM now releases the current license when a user closes the browser or tab that hosts SBM, or when he or she navigates away from SBM to another page. This means the licensing 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. To recover from accidental exits, the same license will be available to the user if he or she returns to SBM within five to ten minutes of exiting the session. 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.
Note that this licensing behavior is only enabled when HTML5 features are enabled in SBM.
You can now grant the following privileges to External and Occasional users:
- View All Items
External and Occasional users can now view all items in the system. In prior releases, External and Occasional users could only view items if they were the submitter, contact, or contact associated with the company on an item, which limited the items they could view.
- View Advanced |
System Fields and
Modify User Profile Settings
External users can now view fields in the Advanced, Manager, and System field sections. If used in combination with View All Items, External users can now view all fields on all items in the system. You can also now grant External users the Modify User Profile Settings privilege after the upgrade.Note: Because View All Items is now available, the Add Attachments | Notes to Any Item privileges have been revoked in order to prevent External and Occasional users from being able to add attachments and notes to any item in the system. (The view item privileges discussed above automatically limited the scope of these privileges in prior releases. Now that users can potentially view all items, the Add Attachments | Notes to Any Item privileges must be removed).
- Add Attachments |
Notes to Item if Contact's Company
These privileges have been added to ensure that the user's capabilities after the upgrade mirror what the user had before the upgrade. Any External or Occasional user who had the Add Attachments | Notes to Any Item privileges will now have Add Attachments | Notes if Submitter | Contact | Contact's Company privileges selected automatically after the upgrade.
In addition, if the Add Attachments | Notes to Any Item privileges were previously granted via a role, the Add Attachments | Notes if Submitter | Contact | Contact's Company privileges are now also granted.Note: If a Regular User, Managed Administrator, or API user was part of an External or Occasional group that granted the Add Attachments | Notes to Any Item privilege, those privileges are removed as part of the upgrade. The database upgrade log notifies you if this condition is true so that you can grant the privileges by another means, if necessary.
- Built-in Reports Added to
Users can now access built-in reports for an application or application group in the Report Center. For an application group, the built-in reports return results for all of the applications in the group.
- Report Center and Favorites Available from Home in
Reports and the Report Center are now available from the Home context in Work Center. In addition, users can now add reports as favorites in the Home context.
- Refine Report List by Favorites
You can now filter the list of reports in the Report Center by the Favorite facet. This filters the list to show only reports that have been marked as favorites (pinned to the menu).
- Resize the Navigation Pane
You can now resize the navigation pane horizontally while it is un-pinned. Hover your mouse over the navigation pane border, left-click, and then drag the border to the desired width. The adjusted size is saved as a browser cookie.
- Sub-Relational Fields Available in Trend Reports
You can now use sub-relational fields in trend reports. This means you can select a sub-relational field with Historical Value Counts, and the report will display the number of items that have different sub-relational field values over time. For example, if your Incidents are linked to the Contacts table (which contains a Department field), you can now create a trend report that shows "incident trends by department".
- Export to Excel as XLSX
All reports that are exported to Excel are now exported in XLSX instead of XLS.
- Display Improvements for Graphical Reports
You can now use the Show All Labels option to show all labels when a large number of values is returned on the horizontal axis for graphical report results. If the labels are difficult to read, you can choose to show fewer labels.
You can now use the Show Chart Values option to show the number of items returned for each row on the graphical report. In past releases, users had to hover their mouse over report bars or segments to see the number of items returned for a specific report row.
The Show Chart Anchors option enables you to easily show or hide the data points for tape, line, and area charts. This option is always enabled for scatter charts.
- Improvements for Scheduled Reports
The following improvements have been made:
- Users can now select and view different e-mail templates that administrators create for scheduled report e-mails.
- Users can now choose to view the results in either SBM User Workspace or Serena Work Center by selecting which link type to use for a scheduled report.
- Users can now suppress scheduled reports e-mails for listing reports if no records are returned by the report.
- You can now CC scheduled reports to users with Occasional User product-access.
- Requery QAR Parameters
This action menu item has been added to the results page for query-at-runtime reports. Use this option to specify new query-at-runtime parameters without having to close and re-execute the report.
- Printable View for System Reports
Users can now view system reports using the Printable View. To print the report, right-click on the printable view results page, and then select the Print option. Users can also copy and share the report URL from the printable view.
- E-mail Recipients for Multi-User Fields
When users click the E-mail icon next to any Multi-User field, the users and groups selected in the field are added as e-mail recipients, up to a total of 10 users or groups. If users choose to use their preferred e-mail client, groups must first be removed from the recipient list.
- Time Selection Options Added to Date/Time Fields in
Serena Work Center
Date/Time fields in Serena Work Center now provide drop-down lists to select the hour and minute for the time portion of a Date/Time field.
- Collapsed or Expanded Facets Saved
Faceted search areas of Serena Work Center (including Search, Report Center, Manage Views, Settings | Feeds) now preserve their collapsed or expanded state via the local browser storage.
- Form Changes
- Application Variables on Forms
You can read more about this enhancement, including a detailed use case at Serena Central.
- Improved Browsing for Form Controls
You can now switch the form palette to a Structure view. This enables you to see a hierarchical tree structure with all form controls. You can select a control in the tree to highlight it on the form or select a control on a form to highlight the control in the tree.
- Themes for Form Styles
You can now use the SBM user workspace theme for design elements such as colors, fonts, and corner radius. Default and custom styles initially use theme values, which you can change as needed. In the styles editor, theme values are indicated by "(Theme)" preceding the value or a picture frame around a theme color.
- Tool Tips for Buttons, Images, and Hyperlinks
You can now configure text to display when users hover over buttons, images, and hyperlinks.
- Form Validation Event
You can now create a "this form fails validation" form event for transition forms. This enables you to create an action based on a form failing, such as required fields not being populated when the form is submitted.
- Form Actions Now Use Time Zone Setting in User Profile
The UTC "Now" time that is used in form actions now uses the time zone setting in the user profile instead of the local machine's time zone. This means a form action that sets a Date/Time field "On Load" to "Now" will respect the time zone that is specified in the user profile.
- Form Actions If Conditions Are False
- Application Variables on Forms
- Miscellaneous Changes
- Rich Text Support for the PDF Widget
Administrators can now enable the PDF Widget to create PDFs that display application data using rich text. Note that not all rich text formatting is available, and this feature is currently available on an experimental basis. For more information, refer to the SBM Composer Guide.
- Improved Access to Repository Actions
You can now perform get latest, check out, check in, undo check out, and refresh status options for all design elements of a specific type. For example, to check out all forms in a process app, right-click Forms in the App Explorer, and then select Check Out.
- Improved Access to About Dialog Box
You can now open the About SBM Composer dialog box from the Help icon in the upper right corner of the Quick Access Tool Bar.
- Relational Grid Widget
The Relational Grid has been added to the list of widgets in the Form Palette. Designers can now add the Relational Grid directly to forms instead of using the Embedded Report widget. As part of the process app upgrade, SBM Composer automatically converts existing Embedded Report widgets to the new Relational Grid widget if Relational Grid was selected as the report type. In addition, Relational Grid is no longer an available report type in the Embedded Report widget.
- Improved Security
The security of all authentication types now delegate responsibility for specifying the authentication information away from the browser and into the SBM Proxy. For example, before making the call to an external REST service, the SBM Proxy now uses the endpoint ID received from the browser to identify the mapped environment endpoint to be used, and looks up the authentication information on the server.
A new SecureRESTServiceWrapper object designed to work with custom endpoints is now available. Instead of specifying authentication information as in the RESTServiceWrapper object, with the SecureRESTServiceWrapper object, you provide the EndpointID to the call, and there is no option for circumventing the SBM Proxy (because the SBM Proxy is responsible for obtaining authentication information using the EndpointID and passing it on to the REST service.)
You can read more about this enhancement, including a detailed use case at Serena Central.
- System Logging Level
You can now set the level of system logging in the Resources Options dialog box.
- Referencing Custom Endpoint Information Using String
REST Data Interception and Manipulation
You can intercept data retrieved through the REST Grid widget and manipulate it before it is displayed on the form. This is done using the new AddResultCallback object. Example uses:
- When the REST calls do not return data in a format that the REST Grid is capable of processing and you need to manipulate the data to be in a usable format
- When the REST calls run different reports that return different columns, and you need to map specific columns to data on the form before you display the form
You can read more about this enhancement, including a detailed use case at Serena Central.
- Rich Text Support for the PDF Widget
- Show All Overrides
Administrators can now select the Show All Overrides check box on the workflow, project, or transition field lists in Application Administrator to quickly view the source of any overrides that are currently applied to the field. For example, instead of manually checking each possible source where an override could be applied, you can now select the check box, and then view the SBM component and source (workflow, project, transition) where the override has been explicitly applied.
- Improved Method for Importing Multiple Values into
You can now easily import multiple selections into Multi-Selection, Multi-User, Multi-Group, and Multi-Relational fields without having to create separate rows in your spreadsheet for each selection value. You can now use the Parse multiple values in a cell option and designate a value separator to distinguish multiple values in a column. For details, refer to the SBM Application Administrator Guide or help.
- Import Data into More Field Types
You can now use the data import utility in SBM Application Administrator to import data into Multi-User fields and Single/Multi-Relational fields that reference a primary table.
- User Import/Update from Spreadsheet - Map to Memo Field
You can now map data to a user's Memo field when you import or update users from a spreadsheet.
- Limit Display of Journal Field Entries in a Notification
The $FIELDVALUE() template tag now enables you to specify how many entries to include from the end of a Journal field. For example, $FIELDVALUE(STATUS_LOG, 3) displays only the last three entries.
- Allow Login Page to be Embedded in Another Web Site
This option has been added to the Base Project settings in Application Administrator, and is selected by default. If you are using SBM Connect for SharePoint® or you want to embed the SBM login page in another Web site's frame, you must select this option. However, you can clear this option for tighter security. Doing so prevents attacks that can potentially intercept clicks and send data to the enclosing Web site.
- Sanitize HTML Values in Memo Fields, Journal Fields, and
- Updated Manage Auxiliary Data Page
The Manage Auxiliary Data page in SBM Application Administrator has been updated. The new interface uses a single iframe to display both the search and results panes. Functionality remains largely the same, though the buttons have been renamed. In addition, rich text content should display properly using the new interface.
- User Search on Privileges Tab
A search field has been added that enables you to quickly find specific users that have been added to Application Repository.
- New Options for Working with Multiple Process Apps
On the Process Apps | Versions tab, you can now select multiple process apps versions and perform actions including: changing the scope, removing selected versions, or removing all eligible versions (which includes all process app versions except the latest version).
- Cancel Scheduled Clear History for Common Log in All
You can now use the Cancel scheduled activities for all environments option to cancel scheduled clear history operations for the Common Log in all of your environments.
- User Avatar
The user avatar that you create in Serena Work Center | SBM User Workspace is now displayed in SBM Application Repository.
- Simplified Target Server URLs for System Event Manager and BPEL
The servlet portion of the URLs for the System Event Manager and BPEL engine is no longer required (only the host and port are required now). This change only applies to new target server URLs that you define in SBM Application Repository; existing target server URLs are not changed as part of the upgrade to 11.0.
- Find New Items in Search Results Sooner
Administrators can now lower the Work Center search engine's Database polling interval to 5 or 10 seconds, which will return new items in Work Center searches just seconds after they are submitted. Administrators can change the Database polling interval on the Common Services tab in SBM Configurator on the server that hosts SBM Common Services.
- URL Attachments and Restricted Attachments Removed from Search
URL attachments (such as links to an external Web site or to a page within SBM) and attachments marked as "restricted" are no longer indexed and returned in Work Center search results by default. To add them to search results, follow the steps in solution S141365.
- Template User Product Access Used for Auto Add From LDAP
SBM now uses the product-access of the template user that is specified on the User Import tab to assign an access-type if it is not already determined by the user's group membership. If the template account has Regular, Managed Administrator, External, or Occasional product access, then that access type is granted; otherwise, the new user is granted Regular user product access if a license is available for that access-type. If a license is not available, the new user is not created and an error is returned instead.
Custom install option that enabled you to choose which
server components to install has been removed from the
suite installer. Instead, the installer now installs all of the
components on each of your servers when you run the
installer. This simplifies the installation process for distributed systems and
ensures that all of the required
components are installed and configured.
To set up a new distributed installation, you use the Component Servers tab in SBM Configurator to define which SBM components are enabled on each of your servers. If you are upgrading from a prior version, your existing configuration and component distribution is preserved, but you can now easily enable or disable components on each server using SBM Configurator instead of uninstalling and reinstalling SBM.
- The Orchestration Engine database upgrade is now performed immediately after the Application Engine database upgrade when you click Upgrade Database in SBM Configurator. For details, see About the Orchestration Engine Database Upgrade.
- Users no longer have to clear their browser cache after an upgrade before they can use Serena Work Center or SBM User Workspace.
- You can now force all SBM traffic through IIS on port 443 by selecting the Use IIS to proxy all server requests check box on the Components tab in SBM Configurator. This option disables all Tomcat HTTP connectors (8085, 8243, 8343, 8443). For additional details, refer to the SBM Installation and Configuration Guide or SBM Configurator help.
- You can now configure Tomcat Server Advanced Settings in the event that you need to override the maximum HTTP header size for SBM Tomcat requests and responses. For systems that are configured to use Windows Domain authentication with SSO, SBM Configurator automatically doubles the default maximum HTTP header size from 8192 bytes to 16384 bytes.
- New static diagnostic tests have been added that check version compatibility between SBM servers to ensure that all servers are on the same version and that the orchestration engine database has been upgraded.
- The JMS QueueAdapter has been deprecated and is no longer included with SBM Orchestration Engine.
- The purge utility has been deprecated because Orchestration Engine runtime data is now deleted automatically under ODE.
- The separator character that is used in orchestration expressions has changed from a dot "." to a slash "\". This enables you to use element names that contain “.” dots in your expressions. For ease of use, if you enter a dot, it is automatically converted into a slash. When SBM Composer upgrades a process app, each dot is automatically converted to a slash as well.
- When you edit a target or an expression on the Options tab of a Calculate step, you can now select functions from the expression editor. As you type a letter in the Target or Expression section, the expression editor displays all of the matching functions and fields. The functions are still available from the Function menu.
- You can now add missing system Web services (RESTCaller, sbmadminservices72, sbmappservices72) to an orchestration by right-clicking the Web Services node in the context menu and selecting Add instead of manually importing the services by entering the WSDL location.
- New GetGroupMembers Call
You can now use the GetGroupMembers call to return a list of UserIdentifiers for one or more specified groups in sbmappservices72 and sbmadminservices72.
SBM Proxy and SOAP-based Calls
- Classification Banners and Alerts
Administrators can now create classification or alert banners to display information about the environment users are working in across the top or bottom of the SBM User Workspace, Serena Work Center, and SBM Application Administrator interfaces. The banners also appear when viewing single items and in embedded or standalone reports. For details, refer to the SBM Application Administrator Guide.
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
- 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.
This section provides upgrade information and important notes for all upgrades to SBM 11.0. To test the upgrade, mimic your current installation on a separate set of servers. This test installation should include all of the environments used by your system. Serena recommends that you upgrade and test this installation before upgrading your production installation. To upgrade successfully, you must upgrade each server and client machine to SBM 11.0.
- Supported Upgrade Paths
- Requirements and Changes
- Planning for the Upgrade
- Pre-Upgrade Steps
- Upgrading the Installation
- Upgrading the Databases
- Post-Upgrade Tasks
- Upgrading Customizations and Integrations
- Upgrading from 2009 R4 or later
If you are upgrading from 2009 R4 or any version thereafter, refer to the important notes and instructions below to upgrade to SBM 11.0.
- Upgrading from versions prior to 2009 R4
If you are upgrading from a version of SBM prior to 2009 R4, follow the upgrade instructions in solution S138037 to upgrade to 10.1.5.X first, and then upgrade your 10.1.5.X installation to SBM 11.0 using the instructions below.
- 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.X first. In addition refer to solution S137372 to learn about the upgrade preparation utility. After you have upgraded TeamTrack to SBM 10.1.5.X, follow the instructions below to upgrade to SBM 11.0.
- Upgrading from Tracker
For information on migrating your Tracker data to SBM, refer to the "Migrating Tracker Data to SBM" solution (S138468).
Before you upgrade to SBM 11.0, read the following important information:
- SBM 11.0 requires Serena License Manager 2.2. You must upgrade to version 2.2 before you can upgrade to SBM 11.0. .
- SBM 11.0 requires 64-bit Windows servers. If you are using 32-bit servers prior to the upgrade, you must install SBM 11.0 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.
- 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
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
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:
- 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
In order to add the new indexes, these tables will be emptied during the
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.
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).
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.
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.Important: If you are upgrading from 2009R4X, in order to upgrade the Test environment first, you must install and configure a temporary 11.0 instance of SBM Application Repository that is connected to a backup copy of the production Application Repository database. Once the upgrade in the Test environment is finished, you can uninstall the temporary 11.0 SBM Application Repository instance and delete the backup copy of the database that was used for the upgrade.
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.
- If SBM Application Repository is part of the Test environment and you plan to upgrade Test first
If you are upgrading from the following versions, plan for hosting new server components as follows:
- If you are upgrading from 09R4, you will use SBM Configurator to designate which server or servers will host the SBM Mail Services component. By default, SBM Mail Services appears on an undefined server until you drag and drop it to the desired server or servers.
- 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).
Follow these steps before you perform the upgrade.
- Verify that SBM 2009 R4 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.
- 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.
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
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
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
detects the current upgrade process and upgrades the file system by merging
existing configurations from your previous installation into the new
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.
The database upgrade process has changed in SBM 11.0. 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.
SBM Application Engine
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 About the Orchestration Engine Database Upgrade.
When you are ready, open the Database Servers tab in SBM Configurator, and then click Upgrade Database.
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.
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.
- If you encrypted SSO passwords prior to the upgrade, you must re-encrypt the passwords using the Security tab in SBM Configurator after the upgrade is finished on the SSO server. This ensures that the SSO passwords in the gatekeeper-core-config.xml file remain encrypted.
- 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,
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 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 after the upgrade.
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:
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.
Login Application (Federation Server) was merged with the
Security Token Service (STS) into a single
Security Server (also known as the Identity Provider (IDP)). This means that
TokenService.war directories were been merged
and replaced with a new
idp directory on the
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.
As of SBM 11.0, the Orchestration Engine database upgrade process has changed. This section describes changes in the process, how it affects the schema, and how to resolve failures and validation errors that might appear during the upgrade.
The Orchestration Engine database upgrade is now performed by the renew utility that is installed with SBM. (For detailed information about the renew utility, refer to the SBM Orchestration Guide.) The renew utility is responsible for restoring existing data in the JBPM tables into the new BPEL tables that are used by the Apache ODE BEPL engine. Existing data in the event manager tables is preserved to ensure that orchestrations continue to run as they did prior to the upgrade.
The JBPM and JMS tables in the database are not dropped as part of the upgrade, but they are no longer used and do not conflict the new BPEL tables that are added. If you want to remove the old JBPM tables after the orchestration database has been successfully upgraded, on the server that hosts SBM Orchestration Engine, run the clear_jbpm.bat file located here:
Retrying Orchestration Engine Upgrades and Clearing Warnings
When the renew utility is launched, all process apps that contain orchestrations are redeployed. If any failures are encountered, a message appears and presents the following options:
- View Warnings
This opens the fail_out.xml file located here:
installDirectory\Serena\SBM\Misc\renew\fail_out.xmlThis file contains a list of process apps that failed to upgrade successfully and target environments that are invalid.
- View Log
This opens the upgrade.log file located here:
installDirectory\Serena\SBM\Common\Tomcat 7.0\server\default\logsThis file contains details about the upgrade, including detailed error messages for any failures that were encountered.
Use the list in fail_out.xml in combination with the detail from the upgrade.log to investigate any failures. Depending on the failures, you have the following options:
- You can address the failures, and then click Upgrade Database again. In the prompt that appears, click Retry Upgrade. This launches the renew utility again and attempts to deploy your process apps now that the failures should be fixed.
- If the failures are expected and you do not want to change anything, click Upgrade Database again in SBM Configurator, and then click Clear Warnings in the prompt that appears. This prevents the warnings from appearing again and completes the database upgrade.
For example, if the schema version in a process app needs to be upgraded, NOT_SUPPORTED_VERSION appears as the cause in the fail_out.xml file. This means the process app schema version needs to be upgraded by redeploying from SBM Composer. You can either redeploy from SBM Composer and run the database upgrade again, or if you do not want to redeploy at this time, but you want to finish the database upgrade now, click Upgrade Database again, and then click Clear Warnings.
The database upgrade will report failures if the target server information in your environments is missing or cannot be verified. For example, if you are testing the production database upgrade by moving the database to a different environment, the upgrade process will report failures related to your environment definition in Application Repository. You can either update the endpoint and target server information and click Retry Upgrade or click Clear Warnings to proceed without making the changes to finish the upgrade.
This option redeploys the process apps that are listed in fail_out.xml.
This option recreates the fail_out.xml if it is deleted or missing.
For more examples on these options, refer to the renew command "-redeploy" in the SBM Orchestration Guide.
In multi-environment installations, the renew utility attempts to redeploy process apps that contain orchestrations to every SBM environment in Application Repository. If you have three environments defined, when you upgrade the first environment (Test, in this example), messages appear in the upgrade.log about skipping the other environments that have not been upgraded:
Redeployment will be skipped for ‘Staging Environment’ environment since it is not upgraded. AE version 10.01.05.02.115 Redeployment will be skipped for ‘Production Environment’ environment since it is not upgraded. AE version 10.01.05.02.115
You can safely ignore these messages because you will upgrade these environments in turn.
When you prepare to upgrade each subsequent environment, consider stopping the SBM Tomcat service first in your upgraded environments to prevent redundant redeploy operations from occurring. Stopping SBM Tomcat in each upgraded environment also speeds up the overall upgrade process. However, note that failures will be recorded in the fail_out.xml for these environments because the upgrade will still attempt to redeploy to them. If the only failures that appear are related to the environments that have already been upgraded, use the Clear Warnings button to discard these warnings and finish the upgrade. In this scenario, this enables SBM Configurator to consider the Test database upgrade as “complete” because the warnings do not apply to the current environment and the Test database was successfully upgraded.
Resolving WSDL Validation Errors
Validation errors appear during the SBM 11.0 Orchestration Engine database upgrade if the process apps that are redeployed by the renew utility contain WSDLs that fail WS-I validation. The same validation failures appear when you attempt to deploy process apps with invalid WSDLs in 11.0. This is due to the change from the JBPM to Apache ODE engine in 11.0, which follows new rules to ensure that SBM does not allow execution of invalid WSDLs.
If a WSDL validation failure is encountered, you can view the WSDL in either SOAP UI or Eclipse to find the invalid portion and fix it accordingly. After you have modified the WSDL and ensured that it passes WS-I validation in either tool, modify the process app .msd file, replace the invalid WSDL file with the fixed version, and then redeploy the process app.
For more information and troubleshooting tips on resolving WSDL validation errors, refer to solution S141405.
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.
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.
- The SBM Tomcat components in 11.0 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.
SBM Application Repository Issues
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.