About this Release
SBM 10.1.4 is the version that immediately follows SBM 10.1.3.1. All of the features, changes, and fixes that were made in SBM 10.1.3.1 can be found in SBM 10.1.4.
SBM 10.1.4 supports new installations—you do not need to install a previous version of SBM before installing this version. If this is a new installation, download version 10.1.4 from http://www.serena.com/support and then follow the instructions in the SBM Installation and Configuration Guide.
- If you have already installed SBM 2009 R3 or later, follow the steps in Minor Upgrades to upgrade to SBM 10.1.4.
- 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.4.
SBM 10.1.4 is available in U.S. English only.
Helpful Links
Terminology Changes
The following terminology and component name changes have been made since the release of SBM 2009 R4.
Old Term | New Term |
---|---|
SBM Application Administrator |
SBM Application Repository |
Web Administrator |
SBM Application Administrator |
Manage Data |
Auxiliary Data (in SBM Application Administrator) |
Notification Server (in the SBM installer) |
SBM Mail Services |
- For changes made in SBM 2009 R4, refer to the readme.
- For terminology changes made since TeamTrack 6.6.1, refer to the Moving to Serena® Business Manager guide.
Supported Configurations
Detailed information about supported platforms and software configuration is available in the Supported Platform Matrix. (Click View to see the complete platform matrix for this release).
Web ServicesThe 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.
Build Numbers
The following component build numbers apply to this version:
- SBM: Build 10.01.04.00.1492
- SBM Composer : Build 264
- SBM System Administrator and SBM Application Administrator: Build 861
- Application Repository: Build 483
- SBM Configurator: 10.01.04.00.505
- Database version: 1014000039
- English – 10.1.4
- Japanese – 2009 R4.01 (the translated content applies to version 2009 R4.01)
Security Bulletin
To read the security bulletin for SBM 10.1.4, visit http://www.serena.com/support, click "My Downloads", and then open the Windows product page for SBM 10.1.4.
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.
- Modern Browser Support
- Internet Explorer Use
- Rich Text Support
- Backlog Support
- View Sharing
- Application Usage Report
- New User Profile Card and Extended User Attributes
- Submit on Behalf of Another User
- Authentication Improvements
- Security Configuration Improvements
- Client Certificate Authentication
- Remove Successful Event Manager Log Entries on Completion
Modern Browser Support
Many new SBM features require Web browsers that support HTML5.
- Updated form styling and "modern" themes
- Rich Text Editor
- User profile card
- Serena Work Center
To support this change, "modern" themes have been added for use with the SBM User Workspace. For new systems, HTML5 features are enabled and the Modern Sand theme is used by default.
The <!DOCTYPE html> tag has also been added to most templates. For details, refer to DOCTYPE Changes.
For upgraded systems, the theme used by your system will change based on the theme selected before the upgrade to SBM 10.1.4:
Legacy Theme | Modern Theme |
---|---|
Sand | Modern Sand |
Blue | Modern Blue |
Internet Explorer Use
HTML5 features and modern themes are not supported in older Web browsers, such as Internet Explorer (IE) 8. If users must use Internet Explorer 8, you must disable HTML5 features. The option to disable HTML5 features is located on the General tab for the Base Project in SBM Application Administrator.
- Compatibility Mode should be disabled in all versions of Internet Explorer.
- Adobe Flash Player 13 and later are required when Internet Explorer 11 is used to access SBM Application Administrator.
Rich Text Support
Users can now use the Rich Text Editor to apply basic formatting to Text fields (Memo and Journal), notes, and e-mail messages sent from items on item forms and in the Social view.
Along with standard formatting (bold, italics, bulleted lists, text color, and more), users can:
- Add attachments, images, and hyperlinks.
- Paste formatted text from Rich Text- or HTML-formatted documents, such as a Web page.
- Edit the source for the text and directly add or modify HTML tags. If you choose to manually enter HTML, be aware that obviously "suspicious" ("dangerous") HTML is not rendered at runtime.
To see the full list of changes made to support Rich Text, refer to Changes for Rich Text Support.
Backlog Support
Serena Work Center users can now create backlog views, which provide a way to prioritize and monitor work items for a specified time period, such as an Agile sprint.
Backlogs are populated with work items based on one or more backlog feeds. Users can assign estimates and actual time spent for each work item, then use progress reports to monitor completion rates based on estimates.
To support backlogs, Agile services have been added to SBM Common Services.
Application Usage Report
Administrators can now run the Application Usage report in Work Center. This report enables administrators to view the number of distinct times an application or application group was accessed in a given date range, in addition to the peak usage period in a given day. Note that usage data is analyzed and collected after you install or upgrade to 10.1.4 when users begin to use the system; usage that occurred prior to the upgrade is not analyzed or collected.
See the Report in Action:
New User Profile Card and Extended User Attributes
Users can now view complete information about other users in the system by clicking a user's name and viewing the user's profile card. This improves the overall visibility, collaboration, and interaction between users in SBM.
When a user clicks on another user's name in one of the end-user interfaces, the profile card appears and displays user attributes such as the user's title, contact information, and location. Administrators can customize the user profile card to display additional user attributes as necessary. The attributes are collected from the SBM user record, the associated contact record, and associated resource attributes. This unified view provides a more complete picture of each user in SBM.
See the Profile Card in Action:
Video: Configuring User Profile Cards
In addition:
- The first character of the user's first name is now displayed throughout the interface if the user has not selected an avatar.
- The following user attributes have been added to every SBM user account: Mobile Phone, Title, and Preferred Contact Method. The current mobile phone number (if present) is copied from the user's contact record on upgrade, and then synced with the mobile phone on the user account (just like the user's name, e-mail, and telephone number).
- The following resource attributes have been added: Business Unit, Department, Title Group, and Type. New Employee ID, Start Date, and End Date attributes have also been added to the Resources - General page.
- Job Functions and Skills are now managed under Resource Attributes.
- You can now map data to resource attributes when you import or update users from a spreadsheet or from LDAP.
Submit on Behalf of Another User
Users can now submit new items on behalf of other users. This means that service desk technicians can now quickly and easily submit tickets on behalf of business users, and the item's change history will reflect that the item was submitted by the technician on behalf of the business user. For details, refer to the "Enabling Submit on Behalf of Another User" topic in the SBM Composer Guide.
See It in Action:
Authentication Improvements
Several improvements have been made to SBM authentication, including the following:
- SSO
LDAP
You can now have SSO authenticate your users against LDAP. The SSO LDAP authentication option in SBM Configurator provides improved performance and more security options than the traditional Application Engine-based LDAP authentication options. You can switch from LDAP to SSO LDAP on the Authentication tab in SBM Configurator, and all of your current LDAP server connections settings will be preserved.
- Windows Domain (NTCR) authentication with
SSO
SBM Configurator now enables you to configure Windows Domain (NTCR) authentication with SSO. When you select Windows Domain (NTCR) and Windows Authentication (SSO), SBM Configurator now performs all the configuration in the SSO configuration files and IIS automatically.
- Automatic Windows Authentication (IIS)
Configuration
SBM Configurator now automatically configures IIS with the required virtual directory settings for Windows Domain authentication. You no longer need to manually configure IIS.
- External Identity Provider with
SSO
You can now configure External Identity Provider authentication and use SSO to manage user sessions. This enables your system to authenticate users against an external source, and also take advantage of the benefits of SSO.
Important: In this scenario, SBM Web service calls are authenticated against the Windows domain instead of the external identity provider. This means if you have orchestrations or Web service calls that need to authenticate internal user accounts (that are not part of the Windows domain), you must update the calls to use Windows domain user accounts or add the accounts to your Windows domain.
Security Configuration Improvements
The following security configuration improvements have been made in this release:
- Manage Trusted Certificates
A new dialog box has been added to the IIS and JBoss tabs that allows you to manage certificates in the truststore for external calls that require SSL. For example, you can now import, export, and view trusted certificates in the Java truststore from within SBM Configurator without having to use keytool commands.
- Secure Integrations
You can now enable and manage SSO trusted certificates for integrations with other Serena products such as Dimensions CM, Dimensions RM, and PVCS VM. You can import, export, and view certificates for these integrations on the Security | Secure Integrations tab in SBM Configurator.
Client Certificate Authentication
You can now enable bi-directional (or two-way SSL authentication) between the components in SBM. Client certificate authentication provides tighter security for your entire SBM installation because once trust is established, each machine can reliably identify itself and provide assurance of its identity to the server. This prevents sniffing and relaying types of attacks against your SBM system. For setup details, refer to 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
Work Center Changes
- Search Improvements
- Improved Search Performance
Search response times are improved for most scenarios.
- Expanded Search Evaluation
Search criteria can now contain quotation marks, parentheses, and operators (AND, OR, NOT). This enables you to create search expressions to help refine your search results.
- Maximum Results and Search Relevance
A maximum of 300 work items are now returned for any search. Results are ordered by relevance to the search criteria, and the relevance percentage is shown for each work item.
- Project Shown in Search Results
The project is now shown for each item in the results list.
- Items Per Page Setting and Search Results
In past releases, the number of items per page was determined by a user profile setting. Now, that setting is ignored for search results and 40 work items are always shown per page.
- Improved Search Performance
- Navigation Improvements
- View management has been improved. Users can manage all views from each application context by click the Manage Views icon located in the upper right corner of the navigation menu. From this page, they can find and run views, add views to their personal menus, edit views, or delete views they own.
- Filter lists in the navigation pane are now alphabetized. For example, when you search for work items, the list of projects you can filter results by is now alphabetical.
- Create Report Icon
The icon used to open the Create Report page is now more visible. The Create Report icon is located in the upper right corner of the My Reports, All Reports, and Scheduled Reports pages..
- SLA
Reports
Service Level Agreement reports are now available in Work Center. SLA reports are organized on two tabs under the Reports menu in the Navigation pane for each application or application group:
- SLA Current Risk
- SLA Past Performance
SLA are only available for Serena Service Manager customers who have installed Version 5.1 and later.
General Changes
- Sending Messages to External E-mail Addresses
Users can now add external e-mail addresses to messages sent from primary and auxiliary items and reports. Users can continue to search for SBM users by name when addressing e-mail messages, however.
- Improved Options for Saving Form Changes
Users who are updating a form and navigate away from the page are now given the option to leave the page or stay on the page so they can save their data. This only applies to users who have the Show Confirmation Alerts when exiting forms option selected in their user profile in the SBM User Workspace.
Reporting Changes
- Reporting Against Resource Teams
You can now create SBM reports that return data based on resource teams. For example, you may want to report on items owned by resource "Team A." To do this, create search criteria that contains the condition "Owner contains Members of Team A." This returns items that are owned by any member of Team A.
- Add New Calculation
Users can now add multiple columns of calculations to a report by using the new Add New Calculation button in the Add Columns of Calculations section.
- Current User Option in Change History Reports
Users can now select (Current User) for the User Making Change field specification.
Administrator Changes
DOCTYPE Changes
The <!DOCTYPE html> tag has been added to most end-user browser templates to support HTML5 capabilities. For this release, HTML5 capabilities are used for the Rich Text Editor and form styling and layout improvements.
If you have customized HTML templates or JavaScripts in past releases, you should review your customizations to ensure they are compatible with HTML5. This includes JavaScripts you may have added to custom forms.
Changes for Rich Text Support
- Rich Text Support for Journal Fields
The Render HTML Tags option for Text fields has been renamed to Enable Rich Text in SBM Composer and is now available for Journal fields as well as Memo fields. In addition, this option is now selected by default for new Memo and Text fields added to a table.
If HTML5 features are disabled for your system, HTML tags manually entered into a Text field are rendered if the Enable Rich Text check box is selected, but the editor is not available.
- HTML Rendering for Notes
HTML rendering and Rich Text editing is now enabled by default for all notes in your system. To disable these features for notes, clear the Render HTML in Notes check box located on the HTML tab of the Settings dialog box in SBM System Administrator.
- Formatting Default Values
In SBM Composer, the Enable HTML5 Features setting has been added to the SBM Composer options page. When enabled, this setting allows you to apply formatting to default values for Text fields (Memo and Journal).
In SBM Application Administrator, you can apply formatting when you override default values for Text fields for projects and transitions as long as the Enable Rich Text option was enabled for the field in SBM Composer.
- Changes to Attachments
Images and file attachments added to Text fields and notes using the Rich Text Editor are added to the item's Attachments section. Attachment privileges control whether users can add, view, modify, or delete these attachments.
- Images in Report Results
By default, images added to Text fields used as report display columns are shown in results. Users can collapse each row to hide images.
- Default E-mail Notification Template
The default e-mail template for newly deployed process apps is now an HTML template. This ensures that formatted data in Text fields included in the notification is properly rendered.
If you use .txt templates for existing notifications, you should migrate to HTML templates if users will apply formatting to Text fields.
- Default Browser E-mail Template
The default browser e-mail template used to format messages users send from primary or auxiliary items has changed from default.txt to default.htm. If you have customized the default.txt file, you should migrate those changes to the new default.htm file in the SBM Configurator after you upgrade to SBM 10.1.4.
If you had changed the browser e-mail template to an .htm file before the upgrade to SBM 10.1.4, you do not need to make any changes.
- Changes to "Suspicious" Tags
The Rich Text support feature enables users to add formatted content more easily to various areas of the system. They can also choose to add their own HTML tags. In this case, if suspicious tags are detected, they are not rendered and are shown as plain text.
In previous releases, the list of suspicious HTML tags included image tags <image>, </image> and hyperlink tags <a>, </a>. Now, these tags are rendered if URLs and images are added directly from the Rich Text Editor and they contain no suspicious attributes, such as onclick. Suspicious tags are shown as plain text.
Promotion Changes
Work Center Views
Shared views (activity, backlog, calendar, and dashboard) and public feeds added to those shared views are now promoted with the applications they reference.
- Private views and feeds
- User menu customizations
- Shared views for the global context
Notification Improvements
-
“From” and “Send-to” Options Available for Projects
You can now override system-level options for e-mail replies to messages that are sent from the Notification Server. System settings are defined in SBM Configurator. Overrides are set for projects in SBM Application Administrator. Settings are inherited, enabling you to override them at a parent project, then set additional overrides for child projects.
- Notification Rules and Notes
You can now create rules that generate notifications when notes are added to items, removed from items, or are updated.
- Notifications for Backlogs
You can now create notifications that execute when work items are added to or removed from a backlog in Serena Work Center. You can also generate notifications when the priority changes for an item in a backlog. Rule conditions must be created for each backlog.
- Removing Item Link from User E-mails
You can now choose to include or remove item links from messages that are sent by users from their preferred e-mail client. Set this for your system in SBM Configurator. You can override the setting for projects in SBM Application Administrator.
- Notification Template Editor
The editor used to format HTML e-mail templates has been improved.
SBM Composer Changes
- Custom Form Improvements
- Using Transitions with Form Actions
You can now use a condition in a form action that compares against the current transition. This enables you to use conditions in a form action to create different behaviors for different transitions. You can then use a form with the same visual design for multiple transitions rather than create a different transition form for each unique form action.
- Calling Other Form Actions
You can now create a form action that calls another form action on the same form. This enables you to use a form action in different circumstances, without having to repeatedly create the action expression.
- Reordering Form Action Expressions
You can now reorder events, conditions, and actions that are part of an action statement.
- Improved JavaScript Management for Form Actions
You can now view JavaScript functions that are included with form actions when the form is checked in. You cannot modify the JavaScript, but you can copy the content and paste it into another form or into another application to assist with troubleshooting.
- Extended Mapping for Custom Transition Controls
You can now choose to map custom transition controls (buttons, hyperlinks, or images) to transitions that are not applicable to a custom state form. This enables you to assign the form to a state or project in SBM Application Administrator rather than to a state or workflow in SBM Composer. If you map a transition that is not applicable for a particular state form, the control is hidden from users.
- Text/Memo Field Heights on State Forms
The default height for Text/Memo fields added to custom State forms is now "AutoSize." This enables users to see all content in the field without scrolling. You can adjust the state to a specific height as needed.
- Form Actions for Field and Control
Height
You can now use form actions to control the height of a field or control to a specific pixel size or to fill its parent cell. These form actions are available for all controls and field types, except for Text fields that are set as Memo and Journal fields. For these fields, you can only set the height to a specific value for Memo and Journal fields that do not have Rich Text enabled.
- Previewing Modern Forms
The Enable HTML5 Features setting has been added to the SBM Composer options page. When this option is enabled, form preview uses a modern theme. When this option is cleared, form preview uses a legacy theme.
- Using Transitions with Form Actions
- Duplicating Transitions
You can now duplicate transitions in any workflow or sub-workflow. This enables you to quickly copy transition attributes, such as form selection, form actions, and field overrides. For actions that execute asynchronous orchestrations, new mapping definitions are automatically created for the duplicated transition.
- Renaming Published Process Apps
You can now use the Remove publish restrictions feature to rename process apps that have been published. You can also use this feature to change a the category of a published process app.
- "Find" Enhancements
- The Find Where Used and Find Items dialogs have been improved. The list of element types is now hierarchical and can be collapsed and expanded, and icons and form actions have been added.
- The Find Where Used feature now finds SBM AppScripts included in other SBM AppScripts using the $INCLUDE() tag.
- You can now search for annotations by pressing CTRL + F from within the workflow editor.
- Deleting States
When you delete states, transitions that originate and end in the states are also deleted.
- Element Selections During Repository Actions
SBM Composer now remembers the selected element when you perform repository actions, such as check-in, check out, undo check out, and get latest. For example, if you have a state selected, and then check out the state's workflow, the state remains selected.
- Improved Validation and Error Handling
- A validation error is now generated when you disable a transition that is fired as part of an action on another transition.
- Users who attempt to import a WSDL that contains recursive type definitions are now shown the name of the recursive type in the error message that appears. (Web services with recursive type definitions are not supported for applications.)
Orchestration Changes
- The Web Service Invocation Timeout setting on the Database tab in SBM System Administrator is now used to control the timeout for synchronous orchestrations. The timeout value that you specify controls the amount of time that the system will wait for an synchronous orchestration to complete. In prior releases, the Orchestration Engine would timeout the response from a synchronous orchestration at sixty seconds.
- The RESTCaller service utility now supports NTLM authentication to call REST services using Windows credentials.
Installation and Configuration Changes
Documentation Changes
- The new SBM Reporting Guide consolidates information about using SBM reports into a single PDF. Guidance is also provided for using reports in Serena Work Center and the SBM User Workspace.
- Information on recommended database drivers and clients for SQL Server and Oracle has moved to the Knowledgebase at serena.com. For details, refer to solution S140514.
Deprecated and Removed Features
- Modern Form Deprecation List
The following features are not available on item forms when HTML5 features are enabled for your system:
- Spell Check
- The Value Find button that enables users to search for field values has been replaced by an icon.
- Action icons have been removed. You can now perform actions, such as printing forms and exporting reports, from the Actions list on item forms and on search and report results.
- The Rich Text Editor replaces the legacy eWebEditPro integration. The option to enable this integration is no longer available in SBM System Administrator.
Upgrades
Please refer to prior readmes for a list of features and changes that were added in another version before this release.
- 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 10.1.2.X
- Serena Business Manager 10.1.3
- Serena Business Manager 10.1.3.1
New Installations of Serena Business Manager
If this is a new installation, download version 10.1.4 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).
Upgrading From TeamTrack 6.6.1.x
If you have TeamTrack 6.6.1.x installed, download version 10.1.4 from http://www.serena.com/support, and then follow the instructions in Moving to Serena® Business Manager. This guide only covers upgrades from TeamTrack.
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.4 must be installed on each server and client machine.
- Major upgrades are upgrades from any version prior to 2009 R3. If you are upgrading from a version prior to 2009 R3, review the Important Notes for Major and Minor Upgrades below and then follow the steps in solution S138037 to upgrade to 10.1.4.
- Minor upgrades are upgrades from version 2009 R3 and later. If you are upgrading from version 2009 R3 or later, review the Important Notes for Major and Minor Upgrades below and then follow the steps in Minor Upgrades to upgrade to 10.1.4.
Important Notes for Major and Minor Upgrades
- 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.
- Custom forms should display and perform as they did before the upgrade to SBM 10.1.4. The first time you redeploy process apps after the upgrade, you must you must redeploy from SBM Composer instead of SBM Application Repository. If you redeploy from SBM Application Repository, you may encounter problems with custom forms. To solve these problems, redeploy process apps that contain these forms from SBM Composer.
- HTML Rendering for Notes
HTML rendering and Rich Text editing is now enabled by default for all notes in your system. To disable these features for notes, clear the Render HTML in Notes check box located on the HTML tab of the Settings dialog box in SBM System Administrator.
- Smart Search is now enabled by default. 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 3 minutes after the items have been created.
Smart Search operates on pre-built indices that may change for each SBM release. The index begins building 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:
installationDirectory\Serena\SBM\Common\jboss405\server\default\log
- As part of the database upgrade, new indexes are
added to the CL_CONTEXT_VALUE and CL_LOG tables to prevent time outs from
occurring when you try to view Common Log data in
SBM Composer
or
SBM Application
Repository.
Important: In order to add the new indexes, these tables will be emptied during the upgrade process. If you need to view Common Log data that was present prior to the upgrade, ensure that you have backed up these tables.
-
You can now configure External Identity Provider authentication and use SSO to manage user sessions. This enables your system to authenticate users against an external source, and also take advantage of the benefits of SSO.
Important: In this scenario, SBM Web service calls are authenticated against the Windows domain instead of the external identity provider. This means if you have orchestrations or Web service calls that need to authenticate internal user accounts (that not part of the Windows domain), you must update the calls to use Windows domain user accounts or add the accounts to your Windows domain. - SBM
10.1.3 introduced improved support for multi-relational, multi-user,
multi-group, and multi-select fields. These changes may cause validation errors
in some orchestrations that use multi-type fields when you open the process app
in
SBM Composer.
Prior to 10.1.3, multi-relational fields were passed as an array of strings in the EventNotice definition. In 10.1.3 and higher, the EventDefinition passes a new Complex Type—Multi_Type—which consists of an array of "Items", where "Item" is a string.
For example, the statement:
STRINGLENGTH(EventNotice.Extension.MyRelationalField[1])>0
Should be expressed as follows after 10.1.3:
STRINGLENGTH(EventNotice.Extension.MyRelationalField.Item[1])>0
If you receive validation errors, review the EventNotice and add .Item manually if it has not been automatically upgraded by SBM Composer.
- 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.
- As of 10.1.2, the
SSO
Login Application (Federation Server) has been merged with the
SSO
Security Token Service (STS) into a single
SSO
Security Server (also known as the Identity Provider (IDP)). This means that
the
ALFSSOLogin.war and
TokenService.war directories have been merged
and replaced with a new
idp.war directory on the
SSO
server.
Important: If you have created custom SSO integrations, you must review all URLs and calls to ensure that they use the new directory names. For example, if your existing integrations call the Security Token Service (STS), you must ensure that the new idp.war directory is used (instead of ALFSSOLogin.war or TokenService.war).The endpoints of the SSO services must be changed accordingly. The relative URIs will stay the same, but since the application is new, the login application entry point will be:
http(s)://host[:port]/idp/login
For the STS, it will be:http(s)://host[:port]/idp/services/Trust
- 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:
- From the Windows Start menu, open the Control Panel and select User Accounts.
- 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.
- Click OK.
- 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:
- Run the SBM Configurator on each server where the Notification Server is installed.
- In the Mail Services tab, select the Notification Server tab.
- In the E-Mail Server Type drop-down list, select Exchange.
- 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.4, 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.4, 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:
- In IIS, copy or take note of the current domain that you have set for Basic Authentication on the GSOAP directory.
- 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).
- From the Options menu in the SBM System Administrator, select Settings or click the Settings icon on the toolbar. The Settings – Server tab opens.
- 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 10.1.1.1. If you did not upgrade to either version prior to upgrading to 10.1.4, then you can ignore the following information.Values in promotion profiles that were created in 10.1 or 10.1.1.1 were set to All by default. As of 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.
- 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.4 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:
- 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.
- Back up your existing database before installing this version.
- Back up the SBM installation directory structure on your Application Engine Web server machine.
- Download the release from support.serena.com.
Server Installation
- Close SBM Configurator on all servers if it is open.
- Extract the server installation files.
- 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.
- 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. - 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.
- Review the database upgrade log file in the Log folder of the installationDirectory\Serena\SBM\Application Engine directory and correct any problems that occurred during the upgrade. If the log file is empty, no errors or warnings occurred during upgrade.
- Merge custom modifications to HTML templates, e-mail templates,
and Web interface online help files made to your upgraded files. Backup
templates are stored in a backup folder in the
installationDirectory\Serena\SBM\Application
Engine\Backup<version>-<date>-<time>
directory.
Note: See solution S140541 for a list of configuration Files, Web Interface templates, JavaScript files, and strings that have changed in this release. You must manually merge some of your existing SSO customizations into the newly installed files after you upgrade your software and database.
If you previously used a custom HTML template for your reports, the reports might not display properly after upgrade. Therefore, consider using the default template or modifying it as needed. For example, as of SBM 10.1.2, several changes were made to Summary Reports that might not display properly using a custom template from a prior release. Instead, either use the new default template or merge your customizations into the default template to create a new custom template.
Important: If you installed the TT4ZMF integration prior to upgrading, you must follow the instructions in the TT4ZMF readme to reinstall the integration after the SBM upgrade is complete. - If you performed the previous step, open SBM System Administrator, select File, and then select Put Files in Database. ALL templates and images in the database are replaced by files on your local machine.
- 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.
- 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.
- Instruct all SBM Composer users to install the client tools using the instructions in the following section (Client Installation).
- 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:
- Download the client installer from support.serena.com.
- Launch the installer by double-clicking the file.
- Click Next on the Welcome dialog box.
- Click Install to upgrade the current client installation.
Fixed Issues
A list of defects fixed in this version can be found in the Knowledge Base. You must have a Serena.com user account to view items in the Knowledge Base. Register for a free account if you do not 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
For a complete list of known issues and potential workarounds, refer to the Knowledge Base. You must have a Serena.com user account to view items in the Knowledge Base. Register for a free account if you do not have already have one.
Issues for End Users
Work Center Issues
- Images that are copied and pasted into the Rich Text Editor are not properly added to items. To work around this problem, use the editor's file attachment option to add images.
- Attachments added using the Rich Text Editor may be added to the item's attachment section, even if the attachment is deleted or users cancel the "add" action.
SBM Composer Issues
- In past releases, custom heights were ignored for
Text/Memo fields on custom State forms. That problem was
resolved, but existing fields that relied on this incorrect behavior will
display with the specified heights after you upgrade to
SBM
10.1.4 and redeploy process apps from
SBM Composer.
To restore the original behavior, open the process app containing the fields in SBM Composer, changed the row height for each affected field to AutoSize, and then deploy the process app.
- In past releases, refresh options for Edit Box ,
HyperLink , Image , and Text controls were generated when custom forms were
opened when the
On page load option was cleared. This problem was resolved and
forms will now correctly refresh based on settings defined in
SBM Composer.
To restore pre-upgrade behavior, modify form settings in SBM Composer and redeploy.
Administrator Issues
- Custom forms should display and perform as they did before the upgrade to SBM 10.1.4. The first time you redeploy process apps after the upgrade, you must redeploy from SBM Composer instead of SBM Application Repository. If you redeploy from SBM Application Repository, you may encounter problems with custom forms. To solve these problems, redeploy process apps that contain these forms from SBM Composer.
-
Note: 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 the following 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.
Installation and Configuration Issues
- An error messages related to SSL Client Certificate Authentication appears when you launch SBM Configurator during an upgrade from TeamTrack 6.6.1. The message appears because SBM Configurator is unable to update a column in the database. After you upgrade the database using SBM System Administrator and then click Apply in SBM Configurator, the update occurs and the message does not appear.