Contents
About this Release
SBM 11.3 is the version that immediately follows SBM 11.2. All of the features, changes, and fixes that were made in SBM 11.2 can be found in SBM 11.3. SBM 11.3 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 SBM from the Support website, and then follow the instructions in the SBM Installation and Configuration Guide, which is available on the Documentation Center.
Important Notes
Note the following important information about this release:
- SBM has been rebranded—Serena Business Manager (SBM) is now Solutions Business Manager (SBM). Serena Work Center is now SBM Work Center. A new logo appears in both SBM Work Center and SBM User Workspace.
- SBM 11.3 requires 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 Service Manager /
Request Center 5.2 and Release Control 6.0 will not run properly on
SBM
11.3 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.3 is available in U.S. English only.
Supported Upgrade Paths
Upgrades to SBM 11.3 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.3. Use the upgrade instructions in the corresponding readme for the first upgrade, and then upgrade to 11.3 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.3 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 SBM guide (available in the SBM Documentation Set.zip on the Documentation Center) 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.3.
- Upgrading from Tracker
For information on migrating your Tracker data to SBM, refer to the "Migrating Tracker Data to SBM" solution (S138468).
Build Numbers
The following component build numbers apply to this version:
- SBM User Workspace and SBM Work Center: 11.03.00.00.405 (Build 280)
- SBM Composer : 11.3 (Build 0164)
- SBM System Administrator and SBM Application Administrator: 11.03.00.00.405 (Build 280)
- SBM Application Repository: 11.03.00.00.405 (Build 228)
- SBM Configurator: 11.03.00.00.129
- Database version: 1130000021
- Documentation: English – 11.3 | Japanese – 2009 R4.01 (translated content applies to SBM 2009 R4.01)
Helpful Links
Contact Us
For specific product issues, contact Support at https://www.microfocus.com/support-and-services/#SBM.
Additional technical information or advice is available from several sources:
- Product documentation, Knowledge Base articles, and videos: https://www.microfocus.com/support-and-services/#SBM
- The Community pages: https://www.microfocus.com/communities/
What's New
The following features have been added in this release.
- Folders and Quick Links in Work Center
- New Scripting Engine
- External Communication Improvements
- Kanban Board View Improvements
- Calendar View Improvements
- Track Report Changes and Report Deletion
- SBM System Analytics
- Reusable Subroutine Workflows for Orchestrations
- Secure Response Headers
Folders and Quick Links in Work Center
Folders and quick links are now supported in Work Center. Previously supported only in User Workspace, folders and quick links enable users to organize and quickly retrieve items, forms, views, reports, and Web pages.
In addition, folders can be kept private or shared with other users. The user who creates a folder is the owner, and can designate other users as co-owners, collaborators, contributors, or viewers. These roles replace folder privileges in previous releases.
For upgrades, you must assign a single owner to existing public folders and the Knowledge Base using SBM System Administrator. The owner can then manage the folders in Work Center.
New Scripting Engine
Programmers can now use SBM ModScript to implement custom features in on-premise SBM installations and in SBM on-demand. SBM ModScript is modeled after ChaiScript and contains extensions to support SBM. For details on programming with SBM ModScript, refer to the SBM ModScript Reference Guide or the SBM Composer help. For an overview of SBM ModScript, including how it differs from SBM AppScript, refer to the SBM ModScript Transition Guide, which is available on the Documentation Center.
External Communication Improvements
Several enhancements have been added to improve communication with users who have not been added to SBM:
- Anonymous E-mail Submit
External (non-SBM) users can now submit items via e-mail. Administrators can enable anonymous e-mail submit for specific mailboxes and allow or block attachments on new items that are created. Administrators can also set spam limits and define rules to ensure that e-mails from external users are routed to the correct projects. For details on configuring anonymous e-mail submit, refer to the SBM Application Administrator Guide or help.
- Manage External Users
Form designers can add the Manage External Users option to the Actions menu on an SBM item. This enables an SBM user to enter a name for an external user who submits an item by anonymous e-mail submit. Users can also add additional external users to an item using this feature.
Note: Only SBM users with the new External Communication privilege can manage external users on an item. - E-mail Recorder and Communications
An SBM user can send an e-mail to an external user and the E-mail Recorder will process that user's reply. Administrators can configure communication rules that execute transitions based on external user replies.
- External E-mail Templates
New e-mail templates have been added for sending e-mail messages to non-SBM users. When a user sends an e-mail from an SBM item and selects the external template, any external users who have been added to the item are automatically selected in the To field. An SBM user can still edit the message's content before the email is sent.
Administrators can select which e-mail templates are available to users in the E-mail Recorder section of the project's Settings tab in Application Administrator.
Kanban Board View Improvements
The following improvements have been made to Kanban boards in Work Center:
- Users can now populate a Kanban board with accepted items from a backlog view. A user can create a backlog view, move items into the Accepted list, prioritize the items as needed, and then work with those same items in a Kanban board. For details on adding backlog items to a Kanban board, refer to the SBM Work Center Guide or help.
- Users can now map Single Relational fields that point auxiliary tables to columns on a Kanban board. This enables users to use auxiliary table records (like scrum teams or Agile sprints) as separate columns. Users can now use the same Single Relational fields to define separate swimlanes on a Kanban board as well.
- When a user moves a card on a Kanban board, any applicable decision points that are built into the workflow are now honored. If a user moves a card, but a decision point overrides the move, a message is displayed to the user that explains the card was redirected based on a decision point set by the administrator.
- When a user moves a card on a Kanban board, the user can now select Item Details to view the predefined list of fields that appear when the body of a Kanban card is clicked.
- Users can now sort cards by one of the system fields or by a card attribute such as Card ID, Card Title, or Card Status. If a Backlog view is used as a data feed for the Kanban board, you can sort by backlog priority as well.
Calendar View Improvements
The following improvements have been made to calendar views and reports in Work Center:
- Work Center users can now create calendar views that display items from external sources. This means users can now create a calendar view that displays items from a third-party tool that exposes JSON/REST services. This enables users to create a powerful calendar view that can display calendar items from several sources in addition to items from SBM. For details on creating calendar views using external data feeds, refer to the SBM Work Center Guide or help.
- In a calendar view or calendar report, users can now select Export to ICS from the Actions drop-down list to export the events on the calendar to an ICS file, which they can import into an external calendar application. This enables users to view SBM calendar data in external e-mail and calendar applications.
Track Report Changes and Report Deletion
Users with Global Administration privilege can now use the Deleted Items and Change History reports to view a list of deleted reports and report changes that were made in a given time period.
SBM System Analytics
Users with Remote Administration privilege can now access System Analytics from the Work Center settings menu. The SBM System Analytics page provides access to Real-Time Monitoring and Run-Time Statistics for SBM.
With Real-Time Monitoring, you can:
- View the status of runtime resources via one or more graphs in a dashboard view
- View a summary of monitored properties in a tabular view, enable or disable monitoring for a property, and configure validation rules
- View a history of failures for properties that exceed a configured threshold
For details on enabling Real-Time Monitoring and adding notification recipients, refer to the SBM Configurator help. For details on working with Real-Time Monitoring, refer to the SBM Application Administrator Guide or help.
With Run-Time Statistics, you can:
- Run reports to track usage for applications and orchestrations (as you could with the Application Usage reports in previous releases).
- View and analyze statistics on report execution and usage by end users. A series of new reports are available to help you identify which reports are most popular, which reports are not executed often, which reports take the most time to complete, and more.
For details on working with Run-Time Statistics, refer to the SBM Application Administrator Guide or help.
Reusable Subroutine Workflows for Orchestrations
You can now define subroutines, which are workflows that you can call from multiple orchestration workflows. Subroutines can contain any orchestration elements, such as the Calculate step, and are useful when your orchestrations contain common actions. Once you have created a subroutine, you can use it by dragging it from the Step Palette into an orchestration workflow.
Secure Response Headers
You can now enable Secure Response Headers in SBM Configurator Adding security headers to responses from IIS and Tomcat tightens security and can prevent malicious attacks against your SBM system. For details, refer to "Securing Response Headers" in the SBM Configurator help or the SBM Installation and Configuration Guide.
Additional Changes
The following sections describe additional features that have been changed or added to this release.
End-user Changes
SBM Work Center Changes
- Copy and Save As Options for Views
From any list of views, users can now click the copy icon to create a new view based on an existing view. This creates a copy of the view, including all the view settings with the exception of any sharing options. The copy creates new instances of each feed in the view as well. After the copy is complete, users can change the copied view or the new feeds as needed.
Users can also use the Save As option to save a new copy of a view. This enables users to save a copy of a view and preserve any sharing options. Using the Save As option does not create new copies of any feeds in the view.
- Backlog Enhancements
- In the backlog list, you can now sort the Accepted and Candidates lists independently. When you select this option, sortable column headers appear under both lists.
- In backlog history, the Changes column now displays the user and timestamp for an item that has been added or removed since the backlog was started. Previously, you had to hover over the plus and minus icons to view that information.
- New System Reports
The following system reports are now available for on-premise customers:
-
SLA Items Panel: Enables you to view details about items currently associated with a Service Level Agreement (SLA). From this report, you can remove SLAs from items if you have the appropriate privileges.
-
Requests Monitor: Enables you to view details about currently running reports. From this report, you can cancel any reports you executed. If you have the appropriate privileges, you can also cancel reports executed by other users. This feature can help prevent multiple instances of the same report from running, which in turn can prevent over-consumption of server threads and eventual system hangs.
-
- Query At Runtime Enhancements for Text Fields
When entering multiple query-at-runtime parameters for text fields, you can now specify "AND" or "OR" for "contains" and "like" operators, and only "AND" for "not contains" and "not like" operators. This enhanced search logic makes sense for most common use cases.
Administrator Changes
SBM Application Administrator Changes
- Support for File and URL Field Types in
SLA
Conditions
In Application Administrator, you can now use File and URL field types as conditions for SLA clauses and actions.
- Separate Source Field for E-mail Response Aliases
For notifications, you can now specify a different source (e-mail subject or body) for each e-mail response's aliases. For example, one e-mail response may accept the aliases "yes" and "approve" from the e-mail body, while another e-mail response may accept the aliases "reject" and "no" from the e-mail subject.
In previous releases, only one source could be specified for all e-mail response aliases.
- Reply with E-mail Recorder Address
You can now select this option on an SBM mailbox to have the E-mail Recorder email address automatically inserted in the To field when a user replies to an e-mail submit confirmation or error message.
- Enable Available Browser E-mail Templates per Project
In the Project | Settings page, you can now enable or disable the templates that are used for sending e-mails from items for a project. This enables you to select which template (.htm or .txt) to use for sending e-mails to SBM users and non-SBM users when the external communication feature is configured.
SBM Application Repository Changes
-
When you promote a process app or snapshot, you can now select which projects to include by selecting one or more parent projects from the list. This simplifies the task of selecting projects because you can select a single parent project and automatically include all of its child projects. In prior versions, if you did not want to promote all projects, you had to select or clear each project individually.
-
When you promote using a promotion profile and click Verify, the Summary tab now appears first. You can click Previous to change settings in the profile before you promote.
SBM System Administrator Changes
- Database Import Enhancements (On-Premise Only)
This release includes these enhancements to importing data from generic ODBC databases:
- Ability to import as a specified user
- Support for pre- and post-import scripts (AppScript and ModScript)
- Option to update items only if changes are detected
This release also introduces the ttadmin.exe command-line interface. You can use this interface to run and schedule data import from generic ODBC databases and SBM databases.
Installation and Configuration Changes
SBM Configurator Changes
- Support for SQL Server Data Encryption
Administrators can now enable SSL data encryption for connections to SQL Server. This encrypts the connection and data that is transmitted between the SBM components and SQL Server. For details, refer to "Configuring SQL Server Data Encryption Options" in the SBM Installation and Configuration Guide or SBM Configurator help.
- In addition to storing configuration data from
each
SBM
server, the
Configuration Settings database is now used to store data that
is collected if you enable
Real-Time Monitoring in
SBM.
As part of this change, the
Configuration Settings database now always appears on the
Database Servers tab regardless if you decide
to save your configuration in the database or in configuration snapshot files
on the file system. In addition:
- The Configuration Settings sub-tab under Settings has been renamed to Configuration Synchronization.
- The Use Configuration Settings Database option has been renamed to Enable configuration synchronization.
- The Update From Database button has been renamed to Synchronize Configuration.
- The JDK that was shipped with
SBM
in prior releases has been replaced with the JRE 1.8. In addition, Tomcat 7.0
has been upgraded to Tomcat 8.5. As part of this change, the install path for
the Tomcat files has changed from:
<installDir>\Serena\SBM\Common\Tomcat 7.0
To:
<installDir>\Serena\SBM\Common\tomcat
A junction point was added for \Tomcat 7.0 that points to the new \tomcat directory to facilitate upgrades and solution installs as well. Note that if you have any custom applications that refer to this directory, you must update them to point to the new \tomcat file system location.
SBM Composer Changes
- Default Forms for Primary Tables
You can now specify default forms for primary tables on the Forms tab of the table Property Editor. You can choose to inherit these forms at the application workflow level, or you can override them at the workflow, state, and transition level.
- Translatable Strings for Form Actions, Controls, and Widgets
You can now define translatable strings in a custom form. Once they are defined, you can use the strings in the following places:
- Form actions
- String Builder tool in form controls and widgets
- Application Administrator on the Localization | Values page
- Open Custom Popup Now a Modal Dialog Box
The Open Custom Popup action (available on the Behavior tab of the control Property Editor) causes a custom popup window to appear when a user clicks a button, hyperlink, or image. When HTML5 is enabled, the popup is a dialog box instead of a separate browser window. This enables you to leverage the form's custom JavaScript and CSS in the dialog box, as well as initiate transitions from the dialog box, such as submitting an item. In addition, you can specify a wider set of options for the dialog box. For the list of options, refer to solution S142150.
Orchestration Changes
- Mapping of Identical Structures
You can now pass on the mappings and default values of a complex data structure or array to an identical structure or array in a different location. To accomplish this, use the Select a Source popup to map a structure or array to the root of the structure or array.
- Standard and Advanced Mapping in the Expression Editor
For the Calculate, ForEach, While, and Decision/Branch steps, the expression editor now displays a list of standard choices that make sense for typical data flow. In more advanced use cases, you might want the expression editor to display a list of all available choices.
To display a complete list, select the Advanced mapping check box on the Options tab of any of these steps.
- Array Record Usability Improvements
You can now duplicate an array record that can include mapping and defaults by right-clicking the record and selecting Duplicate. Additionally, you can easily rearrange array records by right-clicking a record and selecting Move Up or Move Down.
Miscellaneous Changes
-
New GetItemsByInternalID JSON API Call
The GetItemsByInternalID function has been added to the JSON API. This enables you to request multiple items from the JSON API using TS_IDs.
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.
- SBM 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
- Additional options for custom popups initiated from custom forms, as well as support for custom JavaScript and CSS in popups
- How licenses are released when a user ends an SBM session. When HTML5 features are enabled in SBM, licenses are released when users close the current browser or tab that hosts SBM, or navigate away to another page in the current tab. 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.3 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, 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.3.
- Requirements and Changes
- Planning for the Upgrade
- Pre-Upgrade Steps
- Upgrading the Installation and Databases
- Post-Upgrade Tasks
- Upgrading Customizations and Integrations
Requirements and Changes
Before you upgrade to SBM 11.3, 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, 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 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\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.
- Stop the IIS and SBM Tomcat services on each SBM server.
- Download the new suite and client installers from the Support website.
Upgrading the Installation and Databases
- 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 begin 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. 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 S142169. 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.3 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, 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.3.
- 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.3, read the following important information:
- SBM 11.3 requires License Manager 2.2. You must upgrade to version 2.2 before you can upgrade to SBM 11.3.
- SBM 11.3 requires 64-bit Windows servers. If you are using 32-bit servers prior to the upgrade, you must install SBM 11.3 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, 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 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\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.
- Stop the IIS and SBM Tomcat services on each SBM server.
- Download the new suite and client installers from the Support website.
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 begin 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. 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 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.
- 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.
- 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\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 S142169. 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 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 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
- Promoting a snapshot can fail if the default the install directory (C:\Program Files\Micro Focus) is used for SBM. To work around this problem, you can install SBM to C:\Program Files\Serena or to C:\Program Files\MF.
- 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, the JRE that is included with SBM will be updated.
- The ODBC connection to Oracle fails and the
following error appears when you attempt to connect to an Oracle 12c Release 2
database:
[SBM][ODBC Oracle Wire Protocol driver][Oracle]ORA-28040: No matching authentication protocol
When you attempt a test connection on the Database Servers tab in SBM Configurator, it fails as well.
This error appears as a result of an Oracle defect (refer to Bug 14575666 described here). To work around this problem, on the Oracle server, edit the sqlnet.ora file and set the SQLNET.ALLOWED_LOGON_VERSION value to 8.
Documentation Issues
- The file paths throughout the documentation use the following installation path: installationDirectory\Serena\SBM. This is only accurate for upgrades from earlier versions. If you are installing SBM for the first time, installationDirectory\Micro Focus\SBM is now the default installation directory.
- The SBM Application Administrator documentation provides an example of an external communication rule involving an approval process. Approvals are not possible via external communication with non-SBM users; instead, only a single transition can be executed in response to an e-mail reply. The documentation will be corrected in the next release to reflect a more accurate use case in which a non-SBM user replies to an SBM e-mail and the item is transitioned back to the SBM technician who has been waiting for a the reply.
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.
Legal Notice
Trademarks
Serena, Dimensions, ChangeMan, Comparex, and StarTool are registered trademarks of Serena Software, Inc. The Serena logo, PVCS, TeamTrack, License Manager and Composer are trademarks of Serena Software, Inc. All other products or company names are used for identification purposes only, and may be trademarks of their respective owners.