Turn Off Tabs
Serena Business Manager 10.1.3 Readme
This readme file contains known issues and other important information for Serena® Business Manager. This file also contains information that might not be available in other SBM documentation. Last updated on 2014-04-09.


About this Release

SBM 10.1.3 is the version that immediately follows SBM All of the features, changes, and fixes that were made in SBM can be found in SBM 10.1.3.

SBM 10.1.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 version 10.1.3 from http://www.serena.com/support and then follow the instructions in the SBM Installation and Configuration Guide.

SBM supports upgrades from any release after 2009 R1. SBM 10.1.3 supports the following two different upgrade paths:
  • If you have already installed SBM 2009 R3 or later, follow the steps in Minor Upgrades to upgrade to SBM 10.1.3.
  • If you have not yet upgraded to at least 2009 R3, follow the steps in solution S138037 to perform the upgrade to SBM 10.1.3.

SBM 10.1.3 is available in U.S. English only.

Terminology Changes

The following terminology and component name changes have been made since the release of SBM 2009 R4.

Old Term New Term

SBM Application Administrator

SBM Application Repository

Web Administrator

SBM Application Administrator

Manage Data

Auxiliary Data (in SBM Application Administrator)

Notification Server (in the SBM installer)

SBM Mail Services
Terminology changes in earlier releases:
  • For changes made in SBM 2009 R4, refer to the readme.
  • For terminology changes made since TeamTrack 6.6.1, refer to the Moving to Serena® Business Manager guide.

Supported Configurations

The sections below discuss changes in supported software configurations. Detailed information about supported platforms and software configuration is available in the Supported Platform Matrix.

  • Server Operating Systems

    Now supported:

    • Microsoft Windows 2008 R2 Data Center Edition
  • .Net Runtime

    Now supported:

    • .Net Framework 4.0

    • .Net Framework 4.5

  • Database Management Systems

    Now supported:

    • Microsoft SQL Server 2008 R2 SP2 and SP3
    • Microsoft SQL Server 2012 SP1
  • Web Browsers

    Internet Explorer 8 is not supported for Serena Work Center. Internet Explorer 8 is supported for all other SBM Web interfaces.

Web Services

The latest application Web service calls can be found in the sbmappservices72 WSDL. The latest administrative Web service calls can be found in the sbmadminservices72 WSDL. All TeamTrack Web services and earlier SBM Web services (including ttwebservices, aewebservices70, and aewebservices71) are still compatible with this release. However, these WSDLs have been deprecated and will not contain any of the new calls or parameters found in SBM Web services version 7.2. For new Web service implementations, use SBM Web services version 7.2.

Note: For 64-bit SBM installations, you can install and run Serena License Manager 2.1.5, which is supported natively for 64-bit systems.

Build Numbers

The following component build numbers apply to this version:

  • SBM: Build 564
  • SBM Composer : Build 154
  • SBM System Administrator and SBM Application Administrator: Build 564
  • Application Repository: Build 356
  • SBM Configurator:
  • Database version: 1013000042
Note: The 10.1.3 documentation is versioned as follows:
  • English – 10.1.3
  • Japanese – 2009 R4.01 (the translated content applies to version 2009 R4.01)

Third-Party Tools

For more information regarding third-party software copyrights and license information, refer to the files under "My Downloads" or "Product News" at http://www.serena.com/support.

What's New

The following features have been added in this release.

New End-user Interface

Serena Work Center provides a modern, intuitive interface that streamlines how users work with items, especially for those who work in multiple applications.

Work Center can be opened using this URL: http://serverName/workcenter.

Highlights include:
  • Global Search

    Work Center provides a single search feature that enables users to find items in any application they can access. Users can search by Item IDs, single words, or phrases. Values in most field types can be searched as well. For example, include a user name in a search to find items the user submitted, owned, updated, or is referenced in any field.

    Result lists or sorted by relevance based on the search criteria. Users can then filter the list by active/inactive, items they submitted or that were submitted by others, and by application and project.

    See global search in action

  • Global Submit

    There is now a single entry point for submitting new items. The + New option allows users to search for any project or service they have access to. If they are unsure of the project they need, they can search for the application first, and then search for projects within that application.

    Once users submit an item into a project, the project is included in a list of recent projects for easy access. Users can set recent projects as "favorites" so they are always available.

    See global submits in action

  • Views

    Views are containers for the various types of information shown in the main content window. Three types of views are available:

    • Dashboard

      Shows reports and external Web pages in "widget" containers. Users can add multiple widgets and arrange them to best suit their information needs.

      Note: For users in upgraded systems, the Home page for existing applications are automatically set as a default Dashboard widget for those applications.

      See dashboards in action

    • Activity

      Shows work items from one or more Activity feeds, enabling users to easily navigate information pertinent to their daily work.

      See Activity views in action

    • Calendar

      Shows Calendar feeds, giving users a date-based view of information in a calendar format.

    Each users can have multiple views for each view type and for their Home page (global), each application, and each application group.

  • Feeds

    Feeds provide a way for users to quickly access information related to their day-to-day work.

    Two types of feeds are available:

    • Activity

      Shows work items based on a set of feed criteria.

    • Calendar

      Shows work items in a calendar format.

    Feeds have two access levels:

    • Private

      Visible only to the user who created the feed.

    • Public

      Visible to users who have privileges to view guest-level reports. Only the author and administrators can modify public feeds.

    Feeds are added to views, which can be opened from the navigation pane.

  • System To-do Lists

    My Activity views are provided for each user's Home page, application, and application group. Two system feeds are added to each view by default: All Items I Own (Primary) and All Items I Own (Primary and Secondary). You can remove these feeds from the system views as needed, as well as add other feeds.

  • Solution and Application Bundling

    Applications can now be bundled so that users can create views related to work items in these applications. Each user can pin application groups to their taskbar.

    For some Serena-provided solutions, such as Release Manager, applications are already bundled, and users can pin them to their taskbar.

  • Improved Form Styles

    Styling has been improved on all forms rendered in Work Center.

  • Improved Report Navigation
    Report navigation has been simplified. Reports are now organized by application or application group, which are pinned to the Work Center toolbar. Three categories of reports are available:
    • My Reports - Lists reports the user authored.
    • All Reports - Lists all reports the user has privileges to run.
    • Scheduled Reports - Lists reports that are scheduled to run at a particular time.

    Once users select a category, they can search for specific reports or filter the list by table, project, author, etc.

  • Scheduled Reports

    Users can now schedule their reports from the Report view rather than their user profile.

  • Notifications View
  • Users can now view their notifications without leaving Work Center. The Notifications page lists notifications users have received based on their subscriptions. Notifications from all applications are listed and sorted by the date they were received.

    Users can search the list by notification name or filter the list by read/unread, application, project, or subscription. They can click the work item link for each notification to view and act on the item, mark one or all notifications as read, or remove one or all notifications from the list.

    Users can specify in their profile how often the Notifications page should be refreshed.

    See real-time notifications in action

  • Notification URLs

    You can choose to open Work Center when users click item links in e-mail notifications. To do so, select the Serena Work Center item link type on the general tab for each notification.

  • Deleting Notifications

    You can configure the number of days for which notifications should appear in Serena Work Center in the Notification Server sub-tab in SBM Configurator. The default value is thirty days. Notifications that are older than this value are purged from Work Center.

Note: The classic end-user interface, referred to as the SBM User Workspace, is still available.

Scheduled LDAP Imports and Updates

You can now schedule LDAP imports and updates in Application Administrator. For example, if you want to ensure that SBM user data is synchronized with your LDAP user data, you can create a schedule that will automatically update your SBM users from LDAP on a recurring basis.

E-mail Responses

You can now add responses to notification messages. Responses can appear as links or buttons in a notification message, which enable the recipient to transition an item without requiring him or her to log in. For example, you can create a notification that contains customizable "Approve" or "Reject" links that a manager can use to quickly approve or reject a request directly from the notification by clicking one of the response options.

RESTCaller for Orchestrations

You can now call RESTful Web services from orchestration workflows using the new RESTCaller utility service. Once you import the RESTCaller.wsdl file into your orchestration, you can use the orchestration workflow service step to access and configure the RESTCaller service to call a RESTful Web service. For more details, refer to the SBM Orchestration Guide.

Updated Theme in SBM Composer

SBM Composer now uses the Office 2013 theme by default. You can also now change themes, choose to show pane borders, and modify theme colors. You can use the Theme options revert to the Office 2007 Blue (Classic) theme.

Notification Server Performance Improvements

Notification Server processing performance for tables with more than 1,000 fields has improved.

String Modifications for Work Center, Request Center

The Localization feature in Application Administrator enables you to translate or modify text for specific end-user interfaces, such as Work Center and Request Center (version 5.0 and later). Default strings are provided for the English (United States), or en-us, locale.

Authentication Settings in SBM Configurator

SBM authentication and password settings are now configured using SBM Configurator. You now select the authentication source and choose a session management option in the new Authentication tab. Improved labels and inline help text have been added to ease administration of SBM authentication settings. You can also configure other important authentication settings such as password restrictions, re-authentication from outside URLs, and external access using SBM Configurator.

Note: The Authentication tab has replaced the Single Sign-On (SSO) tab in SBM Configurator. You previously used the Single Sign-On (SSO) tab to enable or disable Single Sign-On (SSO) for SBM. That option has been replaced with the Single Sign-On (SSO) selection in the user session management drop-down list on the Authentication tab. To enable Single Sign-On (SSO) in 10.1.3, select Single Sign-On (SSO) as the session management option in the Authentication tab. If Single Sign-On (SSO) was enabled prior to upgrade, Single Sign-On (SSO) is selected by default as the user session management option for SBM.

Application Engine DSN Changes

There are two data sources that are used to connect to the Application Engine database: the SBM Application Engine Web Server (IIS) DSN and the SBM System Administrator DSN. You can now manage the Web server DSN in the Database Servers tab in SBM Configurator. Note the following:

  • For new installations, the default DSN is SBM for both connections. (Prior to SBM 10.1.3, it was Mashup2009.)
  • If you change the Web server DSN in SBM Configurator, and you want the SBM System Administrator DSN to match, you must manually update the DSN in SBM System Administrator.
  • If you are upgrading to 10.1.3 from an earlier version of SBM, SBM Configurator will continue to use Mashup2009 for the Web server DSN. You can continue to use this DSN, or rename it at any time, if necessary.
  • If you renamed the Mashup2009 DSN in SBM System Administrator prior to upgrading, SBM Configurator will use Mashup2009 for the Web server, and SBM System Administrator will continue to use your renamed DSN. If you want the same DSN to be used for both connections, you must select the renamed DSN in SBM Configurator.
  • If you are upgrading from TeamTrack, the DSN that was selected in TeamTrack is set in both SBM Configurator and SBM System Administrator.

Database Upgrade From SBM Configurator

For all upgrades from earlier versions of SBM, the Application Engine database upgrade is now performed using SBM Configurator. For more information, refer to Upgrading From Earlier Versions of SBM. Upgrades from TeamTrack are still performed using SBM System Administrator as described in the Moving to Serena® Business Manager guide.

New Active Diagnostics Logging Contexts

New logging contexts have been added for the Notification Server and Mail Client in SBM Configurator. This means that SBM Active Diagnostics now captures the end-to-end processing activities of the Notification Server and Mail Client, including calls made to the Application Engine and the Orchestration Engine. You can adjust the logging level for these components at runtime without having to stop and start the Mail Services.

A new User Interface logging context has been added as well. This context captures messages from SBM User Workspace and Serena Work Center browser sessions and logs activities related to page render requests.

Additional Changes

The following sections describe additional features that have been changed or added to SBM 10.1.3.

End-user Changes

Multiple File Attachments

Users can now select multiple files when they add attachments to primary or auxiliary items.

Report Changes

Report Title Displayed When Editing a Report

  • The Report Item Type option has been moved to the Content section for most report types.
  • The report title is now displayed when you are modifying a report in SBM User Workspace.

Miscellaneous Changes

Time capture entries can now be in quarter-hour increments.

SBM Composer Changes

  • Work Center Support

    Support for the new end-user interface, SBM User Workspace, has been added to SBM Composer:

    • You can choose to preview custom form in the Work Center or SBM User Workspace.
    • Users are now presented with the correct interface (Serena Work Center or Serena Request Center, for example) when they click item links in embedded reports.
  • Custom Form Maintenance Improvements

    You can now copy forms, images, styles, and form actions across applications.

    See form copies in action

    See form updates in action

  • HTML Editor for End-user Help Text

    You can now easily add, edit, and format end-user help text using an HTML editor. The end-user help editor uses standard formatting controls, including those for text, tables, links, attachments.

  • Improved Process App Recovery

    Backup copies of process apps are now automatically stored on your local machine each time you publish or deploy from SBM Composer. By default, up to 5 backups are stored. You can change this number as needed. You can also disable automatic backups.

  • Expanded Custom Tool Bar Options

    You can now show or hide the Item ID and title and Details/Social toggle on custom forms. You can also choose to hide the entire tool bar on custom forms.

  • Import Values for Single Selection, Multi-selection Fields

    You can now easily manage selection lists by importing them from a .csv file. To ease this process, you can first export selection values to a file, modify the information, and then import the file.

  • Custom Form Indicators

    You can now easily distinguish which states and transitions use custom forms and print forms. Colored icons represent custom forms, including print forms. In addition, a square icon at the upper left corner of an icon indicates that the form is inherited.

  • Removing Publish Restrictions

    You can now unpublish process apps that have been published, enabling you to modify locked elements, such as database and internal names. If you want to deploy a process app that was unpublished into an environment where it was previously deployed, you must first undeploy it.

  • Improved Field Mapping for Transitions

    You can now automatically map all matching fields in Post, Copy, Subtask, and Publish transitions instead of having to manually map fields one at a time. This is convenient when you have a large number of fields to map. On the Post Options tab of the transition Property Editor, select Map Matching Fields to automatically maps field values in the current item to the fields with the same name and type in the new item created by the transition. You can then manually change individual field mappings as needed, or Clear Mappings to start over.

  • Binding Parameters to REST URLs

    You can now add parameters, such as resource IDs, to URLs generated by the REST widget. Endpoints are not generated for modified URLs during deployment; instead, the URL is generated at runtime.

  • Previewing REST Widgets

    You can now preview REST widget results for REST calls that require an SSO token. When you select the SSO option on the REST widget property pane, the SSO token associated with your Application Repository login credentials is passed to the REST call. SSO must be configured for SBM.
  • Template Selection for Embedded Report Widget

    You can now specify a template for all report types added to the Embedded Report widget.

  • Limit Selections for Form Action Lists

    You can now enter text to limit the list of fields, controls, rules, and images that can be selected for form actions. You can also now preview images before adding them to form actions.

  • Business Solution Information

    You can now see information about Serena-provided solutions, such as Serena Release Manager, the process app editor.

  • Guid Column in Lists

    A Guid column can now be enabled for control lists, such as tables, forms, and application variables. This enables you to see the unique identifier for each item in the list and can be used for troubleshooting purposes. To enable the Guid column, right-click a column header to modify the list of columns shown.

  • Demand Widget Deprecated

    The Demand Widget is no longer available.

Administrator Changes

SBM Application Administrator Improvements

Custom Help Improvements
  • Description labels for workflows, states, transitions, decisions, and fields have been changed to reflect that provided information is shown to end users.
  • Long help entries are no longer truncated. Use the scroll bar to view long descriptions. To hide the text, collapse the General section.

Improvements for Notifications

  • You can now configure the From: field in notifications to show either the user name and e-mail address or just the e-mail address itself. The option to display the name and e-mail address is selected by default in the Notification Server settings in SBM Configurator.
Miscellaneous Improvements
  • You can now include parameters in the $NOTES() notification template tag to control the number of notes that are included with a notification message. For example, you can use $NOTES(3) to return only the last three notes. For more information, refer to the SBM Application Administrator Guide.
  • The Resources feature in Application Administrator is now available from a single icon on the Administrator portal.

SBM System Administrator Changes

  • Authentication settings and password settings have moved to SBM Configurator. You now select the authentication source and choose a session management option in the Authentication tab in SBM Configurator. Additional sub-tabs appear depending on the authentication method that you select. Note that LDAP authentication requires that you configure LDAP server connection settings in SBM Configurator. After you successfully connect to your LDAP server and apply the changes in SBM Configurator, the connection settings appear in the LDAP Setup & Tools dialog box in SBM System Administrator for informational purposes.

Expanded Occasional User Privileges for Auxiliary Tables

The Occasional User product-access type now includes the following auxiliary table privileges:

  • View
  • View Advanced Fields
  • View Manager Fields
  • View System Fields
  • View Change History
  • Run Guest-Level Reports
Note: These privileges are not automatically granted after the upgrade to 10.1.3—you must grant the privileges to occasional users or groups directly.

Web Services Changes

  • GetRoleUsers and GetRoleGroups calls have been added to sbmadminservices72. These calls enable you to returns lists of users and groups given a particular role and the associated project.

Miscellaneous Changes

  • SBM AppScript Changes

    In the URL context, you can now use the script UUID to uniquely identify the script, or you can pass the ScriptSolutionID or ScriptAppInternalName parameters with the ScriptName to unambiguously refer to a script name. Additionally, the $SCRIPT() template tag now attempts to determine which script to run by using the parameters that are passed in to identify a contextual solution, and then it searches for the script name in that solution. This means that if the template is an item view, the solution that is associated with that item is searched for a matching script name.
  • As of SBM 10.1.3, the upgrade process drops the current Common Log database tables and then recreates them. This means your existing Common Log data is deleted as part of the upgrade. Common Log data is typically only used to troubleshoot issues with orchestrations.
    Important: If you need to preserve the data in your Common Log database tables, ensure that you back up the Common Log database before you upgrade to 10.1.3.


This section provides general upgrade information and important notes for all upgrades to SBM 10.1.3. Before you upgrade, review the following sections and proceed with the upgrade according to the version that you currently have installed.

Please refer to prior readmes for a list of features and changes that were added in another version before this release.

Upgrades from the following products and versions are supported in this release. Upgrades are supported from specified major releases and minor releases on those base releases.
  • TeamTrack 6.6.1.x
  • Serena Business Mashups 2009 R1.0x
  • Serena Business Mashups 2009 R2.0x
  • Serena Business Mashups 2009 R3.0x
  • Serena Business Manager 2009 R4.0x
  • Serena Business Manager 10.1
  • Serena Business Manager 10.1.1.X
  • Serena Business Manager 10.1.2
  • Serena Business Manager
  • Serena Business Manager
Important: Oracle Only – Upgrades directly to 10.1.3 from TeamTrack are not supported. In order to upgrade to 10.1.3 from TeamTrack, you must upgrade to one of the pre-10.1.3 releases that are listed above first, and then perform the upgrade to 10.1.3.
Tip: If you are using a version of SBM prior to 2009 R1, first upgrade to 2009 R4.0x, and then upgrade to 10.1.3

New Installations of Serena Business Manager

If this is a new installation, download version 10.1.3 from http://www.serena.com/support and then follow the instructions in the SBM Installation and Configuration Guide to install Serena Business Manager.

Upgrading From Tracker

There are two methods for migrating from Tracker to SBM. For more information on migrating your Tracker data to SBM, refer to the "Migrating Tracker Data to SBM" solution (S138468).

Note: Serena Business Manager is now supported on the 64-bit version of Windows Server 2008; however, the Tracker migration utility is not available in the 64-bit version of the SBM System Administrator. Therefore, if you plan to run SBM on a 64-bit version of Windows 2008, you must first use the 32-bit version of SBM System Administrator on Windows 2003 or 2008 SP2 to migrate your Tracker data and then install SBM on your 64-bit server and connect it to your SBM database.

Upgrading From TeamTrack 6.6.1.x

If you have TeamTrack 6.6.1.x installed, download version 10.1.3 from http://www.serena.com/support, and then follow the instructions in Moving to Serena® Business Manager. This guide only covers upgrades from TeamTrack.

Note: This version requires a database upgrade. Back up your existing database before installing this version.

You should also refer to solution S137372 to learn about the upgrade preparation utility.

Upgrading From Earlier Versions of SBM

To test this release, you must mimic your installation on a separate set of hardware. This test installation should include all environments used by your system. You can then upgrade and test this installation before upgrading your production installation. To upgrade successfully, SBM 10.1.3 must be installed on each server and client machine.

This release supports both major and minor upgrades:

Important Notes for Major and Minor Upgrades

The following notes apply to both major and minor upgrades:
  • If you are using IIS 7, you must ensure that the Handler Mappings delegation setting is set to Read/Write in order for users to access Serena Work Center using the http://serverName/workcenter URL. To verify this setting on the Application Engine server:
    1. Open IIS Manager, expand the Roles node, and select Internet Information Services (IIS) Manager.
    2. Click the server host name in the Connections pane. The Home page appears.
    3. In the Management section, double-click Feature Delegation.
    4. Find the Handler Mapping feature, and ensure the delegation is set to Read/Write.
  • If you are using NT Challenge Response prior to the upgrade, you must ensure that the new workcenter virtual directory in IIS uses the same authentication settings that are currently set on the tmtrack virtual directory. (The virtual directory authentication settings must match.) This means that you must change the workcenter virtual directory to use Integrated Windows Authentication and disable Anonymous Access (and select Basic authentication as well if you have selected it on the tmtrack virtual directory). You can perform this change any time after the installer is finished.
  • 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.
  • Smart Search is now enabled by default as part of the upgrade for SBM 10.1.3. Smart Search provides sophisticated search capabilities by automatically indexing the content of items and notes that have been added to items. The default Smart Search polling interval is 3 minutes; this means that by default, Work Center searches will return related items three minutes after the items have been created.

    Smart Search operates on pre-built indices. For SBM upgrades, the index building begins once JBoss is started for the first time after you upgrade your installation. 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:

  • As of SBM 10.1.3, the upgrade process drops the current Common Log database tables and then recreates them. This means your existing Common Log data is deleted as part of the upgrade. Common Log data is typically only used to troubleshoot issues with orchestrations.
    Important: If you need to preserve the data in your Common Log database tables, ensure that you back up the Common Log database before you upgrade to 10.1.3.
  • As 10.1.2, the SSO Login Application (Federation Server) has been merged with the SSO Security Token Service (STS) into a single SSO Security Server (also known as the Identity Provider (IDP)). This means that the ALFSSOLogin.war and TokenService.war directories have been merged and replaced with a new idp.war directory on the SSO server.
    Important: If you have created custom SSO integrations, you must review all URLs and calls to ensure that they use the new directory names. For example, if your existing integrations call the Security Token Service (STS), you must ensure that the new idp.war directory is used (instead of ALFSSOLogin.war or TokenService.war).
    The endpoints of the SSO services must be changed accordingly. The relative URIs will stay the same, but since the application is new, the login application entry point will be:
    For the STS, it will be:
  • You must have one instance of SSO installed in order to have a functional instance of SBM, regardless if you plan to enable SSO or not. The SBM upgrade does not install missing components; therefore, if SSO is not currently installed, you must run the installer, perform an uninstall, and then reinstall SBM with SSO included. In a distributed installation, choose a server to host SSO, and then perform the uninstall and reinstall on that machine.
  • For Oracle systems, the required roles and privileges for the SBM schema user have changed. Please visit S133641 for details.
  • You must ensure that all of the SBM components are installed on one or more servers prior to upgrading. This includes SSO and SBM Common Services. You can choose to enable or disable SSO once it is installed; however, you still must install the SSO component for SBM to function properly.
  • You must disable the User Access Control (UAC) setting before you install SBM on Windows 2008 or 2008 R2. To disable this setting, perform the following steps:
    1. From the Windows Start menu, open the Control Panel and select User Accounts.
    2. Turn off UAC:
      • On Windows 2008, open the User Accounts window, click Turn User Account Control on or off and clear the Use User Account Control (UAC) to help protect your computer check box.
      • On Windows 2008 R2, click Change User Account Control settings, and move the slider to the Never notify position.
    3. Click OK.
    4. Reboot the server and perform the install.

    After the installation is finished, you can enable UAC; however, you must disable it again if you attempt to uninstall SBM.

  • Microsoft .NET Framework 4.0 or higher must be installed on all Windows machines. If it is not detected, the .Net Framework is installed by SBM. To save download and installation time, you may want to install version 4.0 or higher prior to running the SBM installer. Also, if you will not have Internet access during the installation, you should download and install version 4.0 or higher beforehand.
  • On Windows 2003 systems, the SBM installer requires Windows Installer 4.5 in order to install SQL Express without a system restart. (This is not a requirement if you are not installing SQL Express). If you do not pre-install Windows Installer 4.5, the SBM installer performs the install for you and prompts you to restart the system after you select the option to install SQL Express. When the system restart is finished, you must begin the installation again starting from the Welcome dialog. Therefore, to avoid an unscheduled system restart, download and install Windows Installer 4.5 from Microsoft, restart your server, and then install SBM. To determine if version 4.5 is already installed, open the command line and enter the following:
    msiexec -?
  • If you are connecting to a Microsoft SQL Server 2008 database, you must select the 2008 SQL Server Native Client driver. The SQL Server ODBC driver is not compatible with Microsoft SQL Server 2008.
  • If you upgrade to Windows 2008 in addition to upgrading SBM, you must enable the Web Server (IIS) role before you install SBM Application Engine. If the Web Server (IIS) role is not already configured on your Windows 2008 server, see the "Enabling the Web Server (IIS) Role in Windows 2008 Server" section in the SBM Installation and Configuration Guide for steps to enable the role.
    Note: SBM requires Internet Protocol Version 4 (IPv4) on Windows 2008 systems (IPv6 alone will not work). Both IPv4 and IPv6 protocols can be enabled simultaneously on Windows 2008; however, SBM requires at least IPv4 on each Windows 2008 server in your SBM environment.
  • Upgrade support for migrating to a 64-bit version of SBM is handled through a new suite installation on one or more 64-bit Windows 2008 R2 servers. You can either perform a Custom install that installs one or more SBM components on multiple 64-bit operating systems or you can perform a Complete install, which installs every component on a single 64-bit server. You can still perform Remote Administration tasks or connect directly to the database via ODBC using 32-bit clients.

    You can use SBM Configurator on a 64-bit Windows 2008 R2 server to upgrade the database. 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.

    The hardware requirements for SBM running on a Windows 2008 R2 64-bit operating system are as follows. The memory requirements are greater than those for a 32-bit operating system.

    • Recommended Requirements – 2 GHz or higher multi-processors; 16 GB memory; 10 GB operational disk space.
    • Minimum Requirements – 800 MHz or higher single processor; 8 GB memory; 2.5 GB operational disk space.
  • For Oracle systems, you must perform the database upgrade using either the SBM DSN that is installed with SBM or a system DSN that uses the "Oracle for SBM" driver that is installed with SBM. If your system used the Mashup2009 DSN prior to the upgrade, that DSN is automatically converted to use the new "Oracle for SBM" driver, if it was not using this driver already.
    Important: The underlying driver in the DSN that ships with SBM was changed in SBM as of version 10.1. If you currently use the Mashup2009 DSN with SBM, you do not need to do anything—the DSN will be updated automatically. If you created your own custom DSN with the "Oracle for SBM" driver prior to upgrading to SBM 10.1 or later, then you must recreate the DSN and use the new "Oracle for SBM" driver that ships with SBM after the upgrade is finished.

    If you previously designated a SID for Oracle, then that SID is automatically used in the Service name field in SBM Configurator. Verify with your DBA that the correct service name is now used in the Database Servers tab of SBM Configurator.

  • For existing multi-environment installations (the development, test, and productions servers that you plan to upgrade), you can create new databases to host Common Log data for each environment.

    For example, you can back up your current Common Log database on your production server and restore it to a new space on your development database server. Once the data has been restored in the development database, purge the existing Common Log database space on the production database server and create a new database space for your test server (this results in two blank databases—one for test and one for production). Run SBM Configurator on the test and development SBM servers and update the Database Servers tab with the database connection information for the two new unique Common Log databases.

    This ensures that you have unique databases for the Common Log in each environment, and it also moves your existing Common Log data from the previous production space into the new development space.

  • States, transitions, and projects now have unique internal names that make it possible to unambiguously refer to them in a Web service, AppScript, or API call. (This enables you to change the display name of the state or transition and not interfere with any of these references). Note the following:
    • The internal state and transition names are derived from the internal name of their defining workflows. These internal values are set when you open a process app in SBM Composer for the first time after upgrading to SBM 10.1 or later versions.
    • You can change the new default internal names for states and transitions at any time before the process app is published for the first time in SBM 10.1 or later versions. Once the process app is published, the internal names cannot be changed.
    • The internal names for existing projects are automatically created upon upgrade to SBM 10.1 or later versions. When you create new projects in the Application Administrator in versions after 10.1, SBM automatically creates the internal project name for you.
      Note: During promotion, if the internal project name clashes with an existing internal project name, the internal name in the target database is affected in one of two ways:
      • For new projects that are added during promotion, when a conflict occurs, the project name in the target database will be a blank or empty string.
      • For existing projects that are updated during promotion, when a conflict occurs, the project name in the target database remains unchanged. If the internal name in the incoming XML does not conflict with the internal name in the target database, then the promoted project's internal name is used.
  • The Java Notification Server does not support the MAPI standard. For upgrading customers formerly using MAPI with the Notification Server, you can now connect to your Microsoft Exchange server using the Exchange e-mail server type in SBM Configurator. The Exchange option enables SBM to communicate with your Microsoft Exchange server using the MS Exchange Web services API.

    For customers currently using MAPI, perform the following steps to configure the Notification Server to connect using MS Exchange:

    1. Run the SBM Configurator on each server where the Notification Server is installed.
    2. In the Mail Services tab, select the Notification Server tab.
    3. In the E-Mail Server Type drop-down list, select Exchange.
    4. Enter your current Exchange server version, connection URL, and system user credentials.

    You might use the Exchange option if your company does not allow connection through SMTP. The Exchange protocol is also available for use with the Mail Client in the event your company does not allow connection through POP3 or IMAP. If no such restrictions exists, consider choosing SMTP for the Notification Server and POP3 for the Mail Client because they enable faster connection speeds than MS Exchange.

  • In SBM 2009 R4, application icons were introduced. You could specify an icon in the application editor in SBM Composer, and the icon appeared on the application tabs in the SBM User Workspace. If you did not specify an icon, a default red icon was automatically used. As of SBM 10.1, the red icon is no longer the default; instead no icon is used if you do not specify one.
    • If you are upgrading from a release earlier than SBM 2009 R4, you will see no change; no icon will appear on the application tab.
    • If you are upgrading from SBM 2009 R4 or later, and changed the default red icon to something else, you will see no change; your icon will still appear on the application tab.
    • If you are upgrading from SBM 2009 R4 or later, and kept the default red icon, you will no longer see the icon; the application tab will be blank. If you want to restore the red icon, you can select it from the list that opens when you select "New image..." from the drop-down list in the application editor in SBM Composer. Redeploy your process app after making this change.
  • Security Tokens are now generated for authenticated users regardless of the log in method you choose in SBM. Note the following behavior for upgrades from releases prior to 10.1:
    • If SSO was enabled in a prior release, after the upgrade to 10.1.3, deployed apps will use Security Tokens automatically without having to be redeployed.
    • If SSO was disabled in a prior release, after the upgrade to 10.1.3, deployed apps will not use Security Token authentication unless they are redeployed (even if SSO is enabled after the upgrade).
  • The following information only applies to SBM systems in which external events were used with orchestration workflows and SSO was not used:
    • With the use of security tokens for all communication with SBM components regardless of authentication method, it is now necessary to provide credentials in the User element of external events that are processed by the Event Manager. Credentials must be supplied in order to receive a security token.
    • Previous SBM releases allowed anonymous events if SSO was disabled. As of SBM 10.1, security tokens are used in all underlying communication. As part of the upgrade process, in order to still accept external events without credentials, the Event Manager is automatically configured to continue to accept external events without authentication credentials. If SSO was enabled prior to upgrade, then it is assumed that external events always included credentials and will continue to do so in your environment.
      Important: If you are currently using external events without SSO, it is strongly recommended that you adjust the source of those external events to now include credentials. Once you adjust the external source to include a credential, you can then manually override the Event Manager settings by setting the no_authentication parameter to “false” in the alf.properties file. For configuration instructions, see solution S138463.
    • After upgrading, the no_authentication setting is independent of the SSO setting. If you are performing a new installation, you can override the default behavior for the Event Manager and enable it to accept external events without credentials. For configuration instructions, see solution S138463.
    • For SBM Application Engine Web services, the SBM Application Engine auth still overrides the security token auth. In some cases, this is useful in day-to-day operations and may be useful if you are upgrading from versions prior to 10.1. For example, orchestration workflows that contain coded auth for the SBM Application Engine service calls will continue to work if the external event is changed to send a credential; the coded auth will override the security token and continue work as it did prior to upgrade.
  • 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 System Administrator, otherwise the domain that the IIS server machine is installed on is used for user validation.
    As part of the upgrade, SBM Configurator should perform the following steps for you automatically to accommodate this new requirement. However, for systems that use NT Challenge Response authentication that have an authentication override set in SBM System Administrator, you must perform the following steps manually:
    1. In IIS, copy or take note of the current domain that you have set for Basic Authentication on the GSOAP directory.
    2. Clear Basic Authentication from the GSOAP directory and only specify Anonymous Access or Anonymous Authentication. (In previous versions of SBM, you had to specify Basic Authentication on the IIS GSOAP directory and provide the domain there).
    3. From the Options menu in the SBM System Administrator, select Settings or click the Settings icon on the toolbar. The Settings – Server tab opens.
    4. Paste or enter the correct Windows domain in the Default domain for web services field.
  • If your database does not contain at least one Regular User or Managed Administrator account with Remote Administration privilege, use the Reset Administrative User Access wizard in SBM System Administrator after the database upgrade is finished. This wizard enables you to define at least one user as your primary system administrator (an account that has Regular User or Managed Administrator product access with Remote Administration privilege) who can log in to SBM Application Administrator. For details, see the SBM System Administrator Guide.
  • Note: The following information is only applicable if you had previously upgraded to 10.1 or If you did not upgrade to either version prior to upgrading to 10.1.3, then you can ignore the following information.
    Values in promotion profiles that were created in 10.1 or were set to All by default. As of, 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 that had entities set to the default All may also be set to None. These entities must be manually corrected.
    In general, it is recommended that you review your promotion profiles and adjust the settings accordingly.
  • If you installed 10.1, which had the Transition Group Restrictions and User Field Selections check boxes selected by default in promotion profiles, and then upgrade to 10.1.2, the check boxes could become unchecked.
  • Prior to 10.1.2, renaming an orchestration in SBM Composer and then redeploying the process app would leave the originally deployed orchestration event map in place while also deploying a new event map with the new name. The original event map was still associated with its events, so events associated with the orchestration would cause both the original event map to run the orchestration workflows and the new event map to run the orchestration workflows. This problem could reoccur on each new deployment. Generally, the behavior was that an orchestration workflow would appear to run twice or more simultaneously, where it was only expected to run once (although other unexpected behavior was also possible).

    This problem is fixed as of 10.1.2 for deployments of new process apps, and an upgrade is provided that as far as is possible, fixes existing deployments by removing any duplicates. For systems installed prior to SBM 10.1, certain cases of existing deployments cannot be automatically upgraded and will still be prone to this renaming issue. Mostly, these cases can be addressed by redeploying the currently deployed process apps.

    Note: If you suspect duplicated event dispatches after upgrade, contact Serena Customer Support for assistance.
  • If you have applications in SBM that use Tomcat (such as DVM), you must clear out the Tomcat work subdirectory (typically %TOMCAT_HOME%/work). Clearing the browser cache alone is insufficient. This applies to both Firefox and Internet Explorer browsers.

Minor Upgrades

This section provides important notes and upgrade instructions for upgrades to SBM 10.1.3 from version 2009 R3 and later.

Before you upgrade, review the information above in addition to the following topics:

Pre-upgrade Steps

Follow these steps before beginning the upgrade:

  1. Verify that SBM 2009 R3 or later is installed on your system by opening the "About" box in the Web interface. You can also view the current version of each component in the System Information tab of the SBM Configurator.
  2. Back up your existing database before installing this version.
  3. Back up the SBM installation directory structure on your Application Engine Web server machine.
  4. Download the release from support.serena.com.

Server Installation

Note that you must replace all client and server components for all environments. To upgrade to this release on all server machines:
  1. Close SBM Configurator on all servers if it is open.
  2. Extract the server installation files.
  3. On the server machine for each server component, launch the suite executable. An installer message prompts you to confirm that you are upgrading your system. Click Next to continue.
  4. The Upgrade Summary dialog box appears and summarizes the components that are currently installed on the server and ready for upgrade. The current installation directory that will be upgraded is noted as well.

    As of SBM 10.1, the Notification Server and Mail Client are powered by Serena Common JBoss and installed independently from the SBM Application Engine component. For upgrades from versions prior to 10.1, the option to install the new SBM Mail Services (which contains the Notification Server and Mail Client) is selected by default (except on servers that host only the SBM Application Engine and no other components; in that scenario, you must manually select the SBM Mail Services check box to install the Notification Server and Mail Client because the installation of these components now includes the Serena Common JBoss service, which consumes additional resources on the server).

    Before you install the SBM Mail Services, review the following installation considerations:

    • For your production environment, if you have a high volume of Notification Server and Mail Client activity, you can now add additional instances of the SBM Mail Services. Installing multiple instances not only provides failover in case one of the servers shuts down; it also improves the overall performance of notification handling because the processing load is distributed across multiple servers.
    • For installations with over 1000 users or heavy orchestration usage, consider installing the SBM Mail Services on a dedicated server without any other SBM components. If you install the SBM Mail Services separately, you must enter the SBM Application Engine host name and port in SBM Configurator after the installation. This enables the Notification Server and Mail Client to communicate with SBM Application Engine.
    • For multi-environment installations that include separate SBM Application Engine installations for test, staging, and production environments, install the SBM Mail Services at least once in each environment.

    After you have reviewed the components that are currently installed and decided whether or not to install the SBM Mail Services, click Upgrade Now to proceed.

    Note: For minor upgrades, if you want to uninstall existing components or install new components other than the SBM Mail Services, you must use the Windows Add/Remove Programs utility to completely uninstall SBM and then perform a Custom install using the suite installer again (which performs a clean install). This process does not upgrade the current installation. It is recommended that you back up your existing SBM installation directory before you uninstall and reinstall with different component selections. Once the desired components are installed, continue to the next step and reconfigure your installation using SBM Configurator.
  5. At the end of the installation process, click Configure to launch SBM Configurator.

    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. You must click Apply to save these changes. Once the file system is upgraded, you can run SBM Configurator again anytime thereafter to verify or modify your configuration settings as needed.

    Note: If you are prompted to restart your server after the installer is finished, SBM Configurator launches automatically once the server has restarted. (On Windows 2008 systems, you must launch SBM Configurator manually once the server has restarted). If you decline to restart the server at this time, you will not be able to run SBM Configurator until the server has restarted.
    To complete the upgrade process, you must use SBM Configurator to upgrade the Application Engine database. Note the following important information:
    • Click Upgrade Database on the Database Servers tab (before or after you click Apply) to begin the database upgrade. In the event that you want to verify your configuration and save the installation upgrade changes that have occurred before you upgrade the database, you can click Apply and perform the database upgrade later at an appropriate time; however, you must complete the Application Engine database upgrade before users can access SBM.
    • Plan ample time for the database upgrade to complete. When the upgrade finishes successfully, a message appears that directs you to the upgrade log.
    • For distributed installations, you perform the database upgrade in SBM Configurator on the server that hosts SBM Application Engine.
    • For multi-environment installations, you must upgrade each Application Engine database in each environment.
  6. Review the database upgrade log file in the Log folder of the installationDirectory\Serena\SBM\Application Engine directory and correct any problems that occurred during the upgrade. If the log file is empty, no errors or warnings occurred during upgrade.
  7. Merge custom modifications to HTML templates, e-mail templates, and Web interface online help files made to your upgraded files. Backup templates are stored in a backup folder in the installationDirectory\Serena\SBM\Application Engine\Backup<version>-<date>-<time> directory.
    Note: See solution S140142 for a list of configuration Files, Web Interface templates, JavaScript files, and strings that have changed in this release. You must manually merge some of your existing SSO customizations into the newly installed files after you upgrade your software and database.

    If you previously used a custom HTML template for your reports, the reports might not display properly after upgrade. Therefore, consider using the default template or modifying it as needed. For example, as of SBM 10.1.2, several changes were made to Summary Reports that might not display properly using a custom template from a prior release. Instead, either use the new default template or merge your customizations into the default template to create a new custom template.

    Important: If you installed the TT4ZMF integration prior to upgrading, you must follow the instructions in the TT4ZMF readme to reinstall the integration after the SBM upgrade is complete.
  8. If you performed the previous step, open SBM System Administrator, select File, and then select Put Files in Database. ALL templates and images in the database are replaced by files on your local machine.
  9. If you are using Windows Domain (NTCR) authentication for SBM, edit the workcenter virtual directory authentication settings in IIS, select Integrated Windows Authentication, disable Anonymous Access, and select Basic authentication if you have selected it on the tmtrack virtual directory. The workcenter virtual directory settings must match the tmtrack virtual directory settings.
  10. In SBM Configurator, verify that these services are started in the Manage Services tab: SBM Application Engine Web server (Internet Information Services - IIS), Serena Common JBoss, Notification Server, and Mail Client.
  11. Instruct all SBM Composer users to install the client tools using the instructions in the following section (Client Installation).
  12. Instruct SBM User Workspace and SBM Application Repository users to clear the cache in their Web browsers.

Client Installation

The client executable contains SBM Composer and is intended to be run only on client machines.

Previous versions of SBM System Administrator are automatically uninstalled as part of the upgrade (administrative duties are now performed using SBM Application Administrator). Previous versions of SBM Composer are upgraded automatically and do not need to be uninstalled prior to upgrading. The new versions are installed in the same location as the old versions.

To upgrade SBM Composer:

  1. Download the client installer from support.serena.com.
  2. Launch the installer by double-clicking the file.
  3. Click Next on the Welcome dialog box.
  4. Click Install to upgrade the current client installation.

Fixed Issues

A list of defects fixed in this version can be found in the Knowledge Base. You must have a Serena.com user account to view items in the Knowledge Base. Register for a free account if you do not 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, contact Customer Support for assistance is resolving the issue. If you have SBM 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

For a complete list of known issues and potential workarounds, refer to the Knowledge Base.

Administrator Issues

  • If you installed 10.1, which had the Transition Group Restrictions and User Field Selections check boxes selected by default in promotion profiles, and then upgrade to 10.1.3, the check boxes could become unchecked.
  • When you promote snapshots from SBM Application Repository with the Merge conflicts check box selected on the Entities screen in the Promote dialog box, the user who is doing the promotion should be automatically assigned to all of the roles in the application. However, if you upgrade to SBM 10.1.3 and then promote solution snapshots for the first time, this user is not assigned to the roles. To work around this problem, use SBM Application Administrator to manually assign the user to the roles.
  • Strings may not be available for modification or translation in upgraded systems is users log in to the system before JBoss has fully started. To work around this problem, restart Internet Information Services (IIS).
  • Note: The following issue is only applicable if you had previously upgraded to 10.1 or If you did not use either version prior to upgrading to 10.1.2, then you can ignore the following information.
    Values in promotion profiles that were created in 10.1 or were set to All by default. Starting with, 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 that had entities set to the default All may also be set to None. These entities must be manually corrected.
    In general, it is recommended that you review your promotion profiles and adjust the settings accordingly.

Installation and Configuration Issues

  • Service Manager does not currently support separate Oracle schemas for each SBM component within the same Oracle instance. This also applies to multi-environment or "path to production" installations—the same Oracle instance cannot be used for multiple SBM environments (such as development, test, and production).
    Important: If you currently use multiple schemas with SBM in the same Oracle instance and you plan to use Service Manager, please contact Support for assistance.

    However, SBM can be configured with separate schemas as long as the Orchestration Engine and Common Log tables share the same schema. This means Orchestration Engine and Common Log will share one schema, while Application Engine and Application Repository have their own schemas or are shared in a separate schema. If you plan to use additional environments, you must create them in separate Oracle instances in this scenario.

Issues for End Users

General Issues

  • Time capture entries can now be captured in 15-minute increments. However, when time captured is distributed across several days, time is distributed in 30-minute increments. Fifteen-minute intervals may be lost. Users can manually adjust the time distribution to add or remove the 15 minutes as needed.

Work Center Issues

  • Users may see an "Error initializing branding" warning when they log in to Work Center. This problem is caused by the Adblock browser plugin. To solve the problem, disable the plugin.

Documentation Issues

  • The JBoss clustering topic in the SBM Installation and Configuration Guide does not include the following note about setting up the cluster: Consult with your network administrator, and ensure that UDP multi-casting is available between all nodes in the cluster. In other words, ensure that all nodes in the cluster exist in a common subnet that supports UDP multi-casting.