Contents
About this Release
SBM 11.1 is the version that immediately follows SBM 11.0.1.1. All of the features, changes, and fixes that were made in SBM 11.0.1.1 can be found in SBM 11.1. SBM 11.1 supports new installations—you do not need to install a previous version of SBM before installing this version. If this is a new installation, download version 11.1 from http://www.serena.com/support and then follow the instructions in the SBM Installation and Configuration Guide.
Important Notes
Note the following important information about this release:
- SBM 11.1 requires Serena License Manager 2.2. You must upgrade to version 2.2 before you can upgrade to SBM 11.1.
-
Solution releases prior to and including Serena Service Manager
/ Serena Request Center 5.2 and Serena Release Control 6.0 will not run
properly on
SBM
11.1 and these versions are not supported.
You will need to upgrade each solution to newer, compatible versions before you can use them.
- SBM is now certified against Internet Protocol version 4 (IPv4) and Internet Protocol version 6 (IPv6). Note that SBM requires that both IPv4 and IPv6 stacks are present on each server, though IPv4 can be disabled.
- SBM 11.1 is available in U.S. English only.
Supported Upgrade Paths
Upgrades to SBM 11.1 are only supported from SBM 10.1.X or higher. Refer to the following list for guidance on upgrading from your current version.
- Upgrading from 11.X or later
If you are upgrading from 11.X or later, refer to Upgrades from 11.X.
- Upgrading from 10.1.X
If you are upgrading from any version in the 10.1.X line, refer to Upgrades from 10.1.X.
- Upgrading from versions of
SBM
prior to 10.1.X
If you are upgrading from 2009 R4, you can upgrade to any version between 10.1.X and 11.0.1.1 before you upgrade to 11.1. Use the upgrade instructions in the corresponding readme for the first upgrade, and then upgrade to 11.1 using the instructions in either Upgrades from 10.1.X or Upgrades from 11.X, depending on the version you have after the last upgrade.
If you are upgrading from a version prior to 2009 R4, follow the upgrade instructions in solution S138037 to upgrade to 10.1.5.3 first, and then upgrade your 10.1.5.3 installation to SBM 11.1 using the instructions in Upgrades from 10.1.X.
- Upgrading from TeamTrack 6.6.1.X
If you are upgrading from TeamTrack 6.6.1.X, follow the instructions in the Moving to Serena Business Manager guide (available at http://www.serena.com/support) to upgrade to SBM 10.1.5.3 first. In addition refer to solution S137372 to learn about the upgrade preparation utility. After you have upgraded TeamTrack to SBM 10.1.5.3, follow the instructions in Upgrades from 10.1.X to upgrade to SBM 11.1.
- Upgrading from Tracker
For information on migrating your Tracker data to SBM, refer to the "Migrating Tracker Data to SBM" solution (S138468).
Supported Configurations
Detailed information about supported platforms and software configuration is available in the Supported Platform Matrix. (Click View to see the complete platform matrix for this release).
Build Numbers
The following component build numbers apply to this version:
- SBM User Workspace and Serena Work Center: 11.01.00.00.672 (Build 367)
- SBM Composer : 11.1 (Build 0283)
- SBM System Administrator and SBM Application Administrator: 11.01.00.00.672 (Build 367)
- Application Repository: 11.01.00.00.672 (Build 357)
- SBM Configurator: 11.01.00.00.203
- Database version: 1110000038
- English – 11.1
- Japanese – 2009 R4.01 (the translated content applies to version 2009 R4.01)
Third-Party Tools
For more information regarding third-party software copyrights and license information, refer to the files under "Downloads" or "News" at http://www.serena.com/support.
What's New
The following features have been added in this release.
- Kanban Boards
- Work Center Usability Improvements
- Work Center Search Improvements
- Backlog Improvements
- Copy Notifications and Rules
- Transition Items via E-mail Reply
- SBM JSON API
Kanban Boards
Work Center users can now create Kanban boards to track work items from SBM and external applications. You can use Kanban boards in Work Center to view your team's velocity, track work items, and avoid bottlenecks throughout the stages of a project. For details on creating Kanban boards, refer to the Serena Work Center Guide or help.
Work Center Usability Improvements
Several enhancements have been made to Work Center including:
- Side Menu Improvements
- The Manage Views icon and page have been removed. Instead, users can now manage views and reports by accessing them directly from the side menu. For example, to search for and edit activity views, click Activities. To search and edit calendars, click Calendars.
- The Reports Center menu option has been removed. Users can now simply click Reports to access all the same functionality for searching, creating, and managing reports.
- Drag and drop improvements:
- Reorder items in the side menu by dragging and dropping entries directly in the menu.
- Drag and drop a view or report from a list into the side menu.
- Remove favorites from the side menu by dragging and dropping them outside of the menu.
- The current selection in the Work Center side menu is now preserved after switching application contexts or after closing the browser. This means a user will see the same side menu selection (under Dashboards, Activities, Calendars, etc.) the next time he or she opens the same application/application group context in Work Center.
- When the side menu is collapsed, the names of each category appear vertically which allows users to access views and reports while the menu is still collapsed.
- Application Toolbar Improvements
- The Home icon has been updated and the name has been changed to All. This provides a better description of the global context that is available to users.
- Users can now easily remove applications from the toolbar by clicking the star icon that appears when you hover over an item in the toolbar.
- Drag and drop improvements:
- Drag and drop applications and application groups to reorder the toolbar.
- Drag and drop an item outside the toolbar to remove it as a favorite.
- Add applications and application groups by dragging and dropping items from the My Applications dialog box.
- In My Applications, application groups now use a different icon to distinguish them from single applications. Users can expand the application group in the My Applications dialog box to see a list of applications in the group.
- Users can now click an application or application group in My Applications to start working in that context without automatically making it a favorite.
- Users can now scroll and resize the My Applications and +New dialog boxes. The size adjustment is preserved in the user's local browser storage.
- A user's preferred application tab ordering from User Workspace is now displayed in Work Center after the initial log in to Work Center.
- Adding and Editing Feeds
- In a list of feeds, you can now click the preview icon to view a read-only listing report of all the work items that are returned by the feed.
- The No Filter option now appears at the top of the filter list.
- Better placement of the Include secondary owners and Include sub-projects filters in the owner and project filter pages.
- Users can now add/remove a view or a report as a favorite by clicking the star icon on the view or report results page instead of using Add/Remove options in the drop-down list.
Work Center Search Improvements
The following enhancements have been made to Work Center searches:
- Users can now choose to search by either
Issue ID or
Keyword. Searching by
Issue ID enables users to find work items
using wildcards anywhere in the search string (beginning, middle, or end). An
issue ID search also supports characters such as
- and
_, which cannot be used in keyword searches.
Users do not have to select Issue ID to search by ID. But doing so enables users to search by ID using the functionality described above.
- Users can now sort search results by a set of system fields instead of just the relevance score.
- Single and multi-selection fields that have Appears on searches for this table selected in SBM Composer will now appear as additional facets on the Work Center search page when a search is performed against a single application. If a search is performed in the global context (All), against an application group, or within an application that has multiple primary tables, and results span multiple tables, the selection field facets do not appear unless an application or project facet is selected first.
- Users can now select multiple filters in facets for custom single select fields, projects, and applications. For example, a user can now limit search results by more than one project.
- When refining results in
Work Center,
the facet name is now prefixed to each
Refine By selection. This clarifies which
refinements have been applied. For example, when a user refines the results to
display only listing reports that were authored by Bill, the
Refined By now shows:
- TYPE: Listing
- AUTHOR: Administrator
Backlog Improvements
Several enhancements for working with backlogs have been made in Work Center:
- You can now customize columns for a backlog view. You can add fields from one or more applications (according to the view's context and feeds) as custom columns on the view. You can also remove the system columns that appear by default.
- In addition to adding columns, you can now rename columns in the backlog view.
- You can combine columns from different applications for similar field types. For example, if you have two Priority fields from two separate feeds, you can combine them into one column for the entire backlog view. You can provide a custom name for the combined column as well.
- You can now filter items in the backlog view by
feed.
You can also use the In Feed option to filter the list of items in the Accepted and Candidates sections by whether or not the items are still present in the backlog feeds that supply the view with data.
- Backlog filters are now locally saved per user. This means you can apply a filter to a backlog view and see the same filter applied to the list of Accepted/Candidate items the next time you view the backlog.
- You can now track changes that have been made to a backlog. For example, you can click the History button on the backlog view to see what was originally planned for an Agile sprint and determine what content was added or removed over time since the backlog start date.
Copy Notifications and Rules
Administrators can now copy notifications and rules in Application Administrator. This provides an easy method for creating several notifications that may only differ slightly. For details, refer to the SBM Application Administrator Guide or help.
Transition Items via E-mail Reply
You can now create an e-mail response in Application Administrator that will automatically transition an item when the recipient replies to an e-mail. For example, when the recipient replies to a notification with a word like "OK", "Yes", or "Approved", the item is automatically transitioned without opening a browser window. Or, a user can click a link in the notification that pre-fills an e-mail reply with the Mail Client e-mail address and transition to execute. For details on configuring e-mail responses using replies, refer to the SBM Application Administrator Guide or help.
SBM JSON API
SBM now accepts inbound REST calls via the new SBM JSON API. The SBM JSON API provides a set of RESTful services that enable you to perform CRUD (create, read, update, and delete) operations against SBM items via GET and POST calls. For details, refer to the SBM JSON API Guide or the SBM Composer help.
Additional Changes
The following sections describe additional features that have been changed or added to this release.
End-user Changes
Serena Work Center Changes
- Activity Feeds Renamed to Work Item Feeds
Activity feeds are now known as work item feeds. Because you can use this type of feed in both activity views and Kanban boards, the name was changed to describe its general purpose (returns a set of work items).
- Restore Saved Form Data Option Added to
Work Center
Users can now set their preferred option for restoring saved form data in the Settings page.
- Feeds that Use This Filter
A list of feeds that use the current report filter is now displayed when you edit or delete a report filter.
- Miscellaneous Changes
- The Global/Local search toggle now appears in a drop-down list next to the search field.
- Users can now add more than 20 reports as favorites to the side menu.
- The last modified date now appears in the Report Filters list.
SBM User Workspace Changes
- E-mail Template Name Change for Scheduled Reports
The default e-mail templates that are provided for scheduled reports now use the same name (sr_scheduled_reports.htm/.txt) in SBM User Workspace, Work Center, and Application Administrator.
Miscellaneous Changes
- New Form Control for Required Fields
With the use of modern transition forms, a control next to the Actions menu appears that helps users easily identify and satisfy all the required fields on a form. This control displays the total number of required fields on the form and maintains a running count of empty required fields that remain as users begin to enter data. Note that this feature is only available with modern forms. To take advantage of this feature, form designers must either create new modern forms or convert legacy forms to modern forms and redeploy them. For details on converting legacy forms, refer to the SBM Composer Guide.
- Improved E-mail Recorder Message Parsing
The method that is used to parse e-mail replies that are added to items via the E-mail Recorder feature has been changed. This improves the display and readability of e-mail conversations that are logged in the notes section of an item. Note that this only applies to messages that are logged after the upgrade to 11.1.
- Improved Subtasks Display
The item that you are viewing now always appears as [Current Item] in the Subtasks section of an item. This helps illustrate the parent/child relationships in the hierarchy.
Reporting Changes
Report Improvements
- New Graphical Report Types
New report styles for graphical reports have been added including Doughnut Chart, Heatmap Chart, and Radar Chart display options.
- New Built-In Reports
- Users can now run the Built-In: All Items I Follow report to see a list of items they are following (via the Social View of an item). The Built-In: All Tables: All Items I Follow report lists all followed items in every table.
- Users can view a list of their current item notifications by executing the Built-In: My Notifications report. The Built-In: All Tables: My Notifications report lists all a user's item notifications in every table.
- Improved Time Period Options
Users now have more granular control over the time period that is used for reports that use start and end dates. Users can either specify a date range or a time period based on a number of days, weeks, or months that have passed prior to report execution. If users select a date range, Query at Runtime and Date/Time Keywords options are now available for all report types.
- Sub-Relational Fields in Distribution Reports
Users can now specify a sub-relational field for either the row or column field in a distribution report.
- Joins in Distribution Reports
Users can now add join conditions to distribution reports. Users can specify a Single Relational field to join a separate table, which is used as the column definition for the report.
- Users can now sort on joined columns in a listing report.
- User Avatars in Distribution Reports
Avatars are now displayed above the user name when you specify a User field as a row in a distribution report.
- Additional Date/Time Keywords
Plus 90 and Minus 90 date/time keywords are now available for start and end dates in a report definition.
Administrator Changes
SBM Application Administrator Changes
- Default Root Locale for Design Objects
Design object strings that are created Composer are now given a default Root locale after deployment that represents the "true" default value of the string, which is only editable in Composer.
This means you can define locales to use in Application Administrator, create design objects in Composer, and then translate the strings for the design objects into each locale after you deploy the process app without having to set a default language/locale for the entire process app in Composer (which could conflict with the system locale that is set in SBM System Administrator and potentially display the wrong translation). When translation is complete, users who select the locale for the translated version will see the translated strings.
- Enable/Disable Translation for Design Objects and MLS Runtime
Objects
You can now globally enable or disable translation for design objects and MLS objects via the Settings page in SBM Application Administrator. This means if you do not need to translate strings, you can disable localization services entirely, which should improve SBM performance because the system will not check for localization before sending data to the browser or when process apps are deployed. Translation is enabled globally by default; therefore, you must disable this feature in order bypass localization checks.
- Translation for MLS Runtime Objects
Administrators can now provide translated strings for the following MLS runtime objects:
- Fixed-length text field values (when used in the value display format for Single Relational/Multi-Relational fields)
- Project names
- Non-private report names
- Group names (when displayed in Multi-User and Multi-Group fields)
This means users can view translated versions for these runtime objects once you import translated strings in Application Administrator. Administrators can provide translation for runtime objects by exporting and importing XML with translated values.
- Search Localization Values by Override
You can now search the Localization | Values page in Application Administrator by values in the Override column.
- Enable/Disable E-mail Recorder at the Project Level
You can now disable the E-mail Recorder feature at the project level in Application Administrator. This means that you can turn off this feature for projects in which replies to e-mails and notifications do not need to be logged on the originating item.
- Customize Out-of-Office E-mail Notification
Users can now customize out-of-office messages in the Delegation Settings page (which is accessible via the Out of Office user profile option in Work Center and User Workspace). The customized e-mail message is automatically sent to a designated user whenever a task has been delegated to him or her during the out-of-office time period.
- Use Regular Transitions with E-mail Responses
Administrators can now use regular transitions and map fields when creating an e-mail response. In prior releases, only quick transitions were allowed.
- Retry Failed Scheduled Reports
You can now configure the how often the notification server should retry failed notifications for scheduled reports. You can also configure the total number of attempts that should be made.
- Change the Sender of a User E-mail
You can now use the $MAILHEADERPARAM() template tag in a user e-mail template. This enables you to change the sender address of an e-mail that is sent from an item.
- New $MOBILELINK() Template Tag
You can now use the $MOBILELINK() base item template tag to insert an item link that opens the item in either the SBM or SRC mobile app.
SBM Application Repository Changes
- Clone Privileges
Administrators can now copy a user's repository privileges to one or more users via the Clone Privileges button in SBM Application Repository.
- Search for Process Apps
A search feature has been added to the Process Apps tab and the Privileges | Component Privileges sub-tab.
- Verify Promotion Profiles
When you promote using a profile, you can now click Verify to view the current promotion profile settings before you perform the promote activity.
- Destination Environment Visibility in Activity Log
The destination environment now appears at the top of the activity log entry that is created when you promote a snapshot.
Installation and Configuration Changes
SBM Configurator Improvements
- If you use the Configuration Settings database, you can now view and manage prior configurations that have been applied by clicking Revision History under the Settings tab. Each entry provides a complete summary of your installation because the data is pulled from the Configuration Settings database (not just the settings from your local machine). You can search for, compare, and revert to previous revisions as well. For details, refer to the SBM Configurator help.
- You can now configure a dedicated data source for
the Application Engine to connect to the Common Log database on the
Database Servers tab in
SBM Configurator.
This means you can configure a defined ODBC connection to the Common Log
database without having to manually enter connection parameters and security
information in the
LoggerConf.xml file (which is overwritten by
SBM Configurator
on
Apply).
When you upgrade to 11.1, the Common Log ODBC data source appears on the Database Server tab with the default name SBM_CL. You can rename this data source or use an existing data source if necessary. To avoid naming conflicts, the default Application Engine Web Server DSN has been changed from SBM to SBM_AE.
- The Component Servers tab has been improved with a new layout and editor. The new editor enables you to drag and drop server components to define additional SBM servers for distributed installations. When you select a server, you can configure additional settings in the tabs that appear in the property editor below the servers.
- You can now configure a cluster for SBM Application Engine the same way that you do for the Tomcat server components. This means you can install SBM Application Engine on multiple servers that will serve as nodes in the cluster and you can enter load balancer settings in SBM Configurator on each node. When used in combination with the Configuration Settings database, this ensures each Tomcat server accesses Application Engine via the load balanced URL instead of using an individual node's address.
- The Manage Services tab has been simplified and improved. You can now easily see all available services, including the current status, startup type, and logon identity.
- When you generate a certificate in SBM Configurator, you can now configure various certificate properties including the common name, public key size, validity dates, and algorithm. You can also configure alternative host names for SSL certificates.
-
You can now configure how browser user
credentials are collected apart from how users are authenticated. This means
you can use a login form to gather credentials and authenticate users against
LDAP or the Windows Domain. In addition, session management options have been
simplified: instead of choices between Single Sign-On, Session Cookies, and
HTTP Basic, you simply choose to use SSO to manage sessions or not. For details
and an overview of new combinations, refer to solution
S141643.
Note: If you used the HTTP Basic option for session management, after the upgrade, user sessions are managed using session cookies (non-SSO). The new Browser authentication selection is based on whether or not users were previously validated against the Windows Domain or not before the upgrade (if not, the SBM Login Form option is selected).
- Single Sign-On (SSO) is now the default option for managing user sessions in new SBM installations.
SBM Composer Changes
- Form Changes
- Modern Forms
This release introduces modern forms, which use technologies such as HTML5 and .css properties to achieve greater stability in layout and less reliance on scripting overall. Modern forms make it possible to offer advanced features, including responsive layout, headers/footers/sidebars with scrollable form content, and a runtime option that shows only required fields. Also, some of the historic defects present in legacy forms have been fixed with modern forms.
Legacy forms will continue to be supported; however, you will not be able to use the advanced features mentioned above.
To convert your forms to modern forms, do the following:- Make sure the Enable HTML5 features check box is selected in the Form Options tab of the SBM Composer Options dialog box.
- Create a new form based on your existing form, and make sure the Legacy mode check box is cleared.
- Validate the process app and check for form errors.
Note: If your forms contain custom JavaScript, .css, or tweaks to currently-deployed page layout, they will need to be reworked in order to convert them to modern forms (some new features such as headers/footers/sidebars may replace existing script). If your forms contain simple customizations such as form actions, or custom JavaScript use is limited to supported JSAPI functions, you can convert them as described above.If you use solutions provided by Serena, or you have created forms based on solution forms, we recommend that you continue to use legacy forms. A future release of the solutions will include modern forms.
- Responsive Forms
Responsive forms, available with modern forms, enable the layout to adjust to the screen size by wrapping rows to new lines as needed. For smaller screen sizes like tablets and mobile phones, responsive forms eliminate the need to scroll horizontally to view the contents of the form. All scrolling is vertical.
When you preview a responsive form, you can resize the form to test how it will appear in different screen sizes.
- Headers, Footers, and Sidebars
Headers, footers, and sidebars are available with modern forms. Using this feature, you can ensure that important elements remain visible on the screen at all times. For example, you may want to keep certain buttons or controls visible while users scroll or change tabs in the main form area.
- Automatically Hidden Containers
For modern forms, containers are automatically hidden at runtime in the following cases:
- The user does not have permissions for any of the controls in the container.
- The container does not contain any controls (Preview Tools will warn you if an empty container have been hidden).
- Automatic Scroll Bars Support Overflow in Containers
For modern forms, if you specify a fixed width, fixed height, or vertical autofill for containers, a scroll bar will automatically appear if the content does not fit in the allotted space.
This feature was already supported for widgets (via the Scroll bars option on the Property Editor), Journal fields, and Memo fields, and has been stabilized.
- Default Forms for Primary Tables
You can now specify default forms for primary tables on the Forms tab of the table Property Editor. You can choose to inherit these forms at the application workflow level, or you can override them at the workflow, state, and transition level.
- Mobile Forms
If you enable an application for mobile access, you can now modify which individual fields and controls are displayed in mobile forms. You can also choose to show or hide transitions on mobile state forms.
- Relational Grid Widget Enhancements
- If a relational grid uses a Composer Report Definition, and a field is used as both a grid column and a query-at-runtime parameter in the report, you can enable a search box on that column for users to filter grid results.
- There is now an option to show only the items currently selected by the user in the relational grid. You can also make a checkbox available that enables the user to show only the selected items.
- Additional options enable you to show or hide the various details and links that appear in the relational grid header and footer.
- REST Grid Widget Enhancements
- If you have a REST grid widget on your form, you can use the new Autoselect first row option to automatically select the first row of the grid on refresh.
- If you configure the paging for a REST grid widget to be off or done client-side, users will now be able to filter the grid results. When users select the Filter check box in the grid's drop-down menu, the filters options will appear.
- PDF Widget Enhancements
- The PDF widget now fully supports rich
text, which is enabled by default in the
config.properties file. To disable rich
text, set the
RichTextEnabled option to
false in this file, which is located
in the following directory:
installationDirectory\Serena\SBM\Common\Tomcat x.x\server\default\webapps\DocGenerator\WEB-INF\classes
- You can customize the formatting of
plain text output by the PDF widget by editing the
html_formatter.properties file, which is
located in the following directory:
installationDirectory\Serena\SBM\Common\Tomcat x.x\server\default\webapps\DocGenerator\WEB-INF\classes
- The PDF widget supports fields with the Password option turned on. The characters in these fields are displayed as asterisks (*) in the PDF.
- The PDF widget now fully supports rich
text, which is enabled by default in the
config.properties file. To disable rich
text, set the
RichTextEnabled option to
false in this file, which is located
in the following directory:
- Silverlight, Flash, and Google Gadget Widgets Removed
The Silverlight, Flash, and Google Gadget widgets are no longer available on the Form Palette. You can use the HTML/Javascript widget instead.
If your existing forms contain these widgets, they are automatically converted to the HTML/Javascript widget.
- New and Updated Form Actions
The following new or updated form actions are available:
- New "a journal field has or does not have previous entries" condition
- New "the current form is or is not a mobile form" condition
- Updated "a field or control changes value" event (now supported for relational grid and REST grid widgets)
In addition, form actions for fields and controls have been consolidated for ease of use. If your existing process apps include these form actions, they are upgraded automatically.
- Display Images as Buttons
You can now apply button styling to images. For example, you can use this feature to add a refresh button to your custom forms.
- Refresh Image URL and Display Text
For image controls, you can now refresh both the image URL and the display text. Each of these can be refreshed independently of one another.
- String Builder Support in Form Actions
You can now use the string builder tool when specifying a value for a text field or a JavaScript in form actions and conditions.
- String Substitution in JavaScript
The STRING_ESC() macro enables you to use string substitution to initialize a JavaScript string constant in HTML/JavaScript widgets, custom widgets, form extensions, and form actions. This ensures that special characters are correctly encoded for use in this context.
- Modern Forms
- Miscellaneous Changes
- Multiple Instances of
SBM Composer
Can Run Simultaneously
You can now open multiple instances of SBM Composer. If a process app is opened multiple times (from the local cache or remote repository, or from import from an .msd file), the second and all subsequent instances of the process app are read-only.
- REST Data Source
Under Extensions in App Explorer, you can now define REST Data Sources for use with external data feeds in Kanban boards. You can configure the REST service URL and parameters when you create the data source, deploy your process app, and then users can select the data source when creating external data feeds for Kanban boards in Work Center.
- Reset Submitter Field to Current User
You can now select this check box on the Options tab of a copy transition to have the user who performs the copy transition appear as the Submitter value on the new item.
- Single Relational Fields and Transition Actions
You can now use Single Relational fields in transition actions that affect the current item or items that select the current item. Also, actions that affect "items that reference this item" can now be executed unconditionally.
- Verify Endpoints Before Deployment
The Verify endpoints option that is available in SBM Application Repository is now also available in SBM Composer. Use this option to confirm that each endpoint can be accessed before starting a deployment.
- Limit Number of Transition Buttons on State Form
You can now limit the number of transition buttons that appear on a state form. Any transitions that exceed this limit appear in a drop-down list.
- "Where Used" Supports Selection Values
The "Where Used" feature now enables you to locate where single and multi-selection values are in use in the process app. Selection values can be used in application variables, reports, rules, fields, field overrides (transitions and workflows), and dependencies (workflows).
Additionally, SBM Composer will now prevent deletion of selection values that are in use unless you choose to override this default behavior.
- Multiple Instances of
SBM Composer
Can Run Simultaneously
Orchestration Changes
- Event Priorities
Administrators can now apply certain event types to help prioritize events that are received. This enables administrators to customize the order in which certain event are processed from the single queue that is now used for all synchronous and asynchronous ALF events. For details, refer to "Applying Event Priorities" in the SBM Composer help or the SBM Orchestration Guide.
-
Support Multi-Part E-mails for ALF Events
The Event Manager now supports using a POP3 mail server that can convert single part HTML messages into multi-part messages that also contain plain text equivalent HTML. This means you can now use additional types of POP3 mailboxes for the Event Manager including a Gmail mailbox.
- Secure POP3 Connection
You can now configure the Event Manager POP3 connection to use SSL in SBM Configurator for secure connections.
- Multiple Assignments in a Calculate Step
When creating an orchestration workflow, you can now combine multiple assignments (target-expression pairs) in a single Calculate step. You can also split assignments into multiple Calculate steps, as well as copy, rename, delete, and reorder assignments within a step.
- Data Element Type Submenu
When adding new data elements or child data elements to an orchestration workflow, you can now choose a type directly from a submenu. In previous releases, you had to create the data element and then change the type.
- Orchestration Event Types for Transitions
When defining an orchestration action for a transition, you can now specify the event type as "transition" or "alternative". Transition event types use the application workflow name, name of the transition start state, and name of the transition to construct the event type string. Alternative event types also add the orchestration workflow name to the event type string. This allows for specific binding between the event type and orchestration workflow in the Orchestration event map.
Web Services Changes
- Expanded Options for GetItem and GetItems
You can now send either the uuid, displayName, or issueId with the tableId to return items using the GetItem or GetItems calls.
Miscellaneous Changes
-
NTLM Support for REST Services and RESTCaller
You can now configure REST Grid service endpoints defined in Composer and custom endpoints used by RESTCaller to use NTLM authentication. For example, you can now select NTLM for endpoint security in a REST Grid widget, deploy your process app, and then configure the Windows domain authentication information when you edit the environment in SBM Application Repository.
Modern Browser Support
Many SBM features require Web browsers that support HTML5. Some of these features are not available in older browsers, such as Internet Explorer (IE) 8.
- Serena Work Center
- Rich Text Editor for applying formatting to e-mail messages, notes, and certain Text fields.
- Updated form styling and modern themes
- Drill-down display options for Distribution, Advanced Distribution, Summary, Time to State, Elapsed Time, Trend, Backlog Trend, Entering a State, Open and Completed, and State Activity reports (if Flash components are also disabled)
- User profile card
- Group member lists for Multi-User fields on State forms
- Translated strings in the workflow diagram
- Second background colors and corner radius settings on custom forms
- Standard logout behavior when a user closes the browser or tab that hosts SBM, or when a user navigates away from SBM to another page. This means the behavior is the same whether a user formally logs out or if he or she ends the session by closing the browser or navigating to a different page. Note that the sixty-minute idle timeout remains in place if the session is left open and the user does not log out through one of these means.
- Upgrade your browser, or
- Contact your administrator and ask for HTML5 features to be disabled.
In addition, Compatibility Mode should be disabled in all versions of Internet Explorer.
Upgrades from 11.X
Review this section for upgrades to SBM 11.1 from earlier versions in the 11.x line. If you are upgrading from 10.1.X, refer to Upgrades from 10.1.X.
To test the upgrade, Serena recommends that you mimic your current installation on a separate set of servers. This test installation should include all of the environments used by your system. Upgrade and test this installation before upgrading your production installation. To upgrade successfully, you must upgrade each server and client machine to SBM 11.1.
- Requirements and Changes
- Planning for the Upgrade
- Pre-Upgrade Steps
- Upgrading the Installation
- Post-Upgrade Tasks
- Upgrading Customizations and Integrations
Requirements and Changes
Before you upgrade to SBM 11.1, read the following important information:
- If you used
HTTP Basic Authentication to manage user sessions prior to the
upgrade,
SBM Configurator
automatically converts this to
SSO
once the upgrade is finished. The
HTTP Basic Authentication option has been deprecated and is no
longer available in
SBM Configurator
because there are more secure options for managing user sessions.
Electronic signatures are now authenticated according to what is selected for Web services authentication in SBM Configurator if you are using Windows Authentication or Third-Party Authentication System for Browser authentication. Prior to 11.1, electronic signatures were always authenticated against the internal SBM database.
If you need assistance with re-enabling legacy behavior for either setting, please contact Serena Support.
- In order to prevent notifications from being sent for changes that have not happened recently, SBM now deletes notification events that are older than 90 days that contain a THREADID during the database upgrade. To check if you have events that will be deleted, refer to the SQL queries in solution S140945.
- Work Center
search operates on pre-built indices that may change for each
SBM
release. The
Work Center
search index is rebuilt when Tomcat is started for the first time after the
upgrade. The complete indexing operation can take ample time to finish for very
large databases; however, some search results in
Work Center
begin to appear immediately and the number of results continues to grow while
the initial indexing operation works toward completion.
You can view the overall progress of the indexing operation in the ssf.log file located on the server that hosts SBM Common Services. The log file is located here:
installDir\Serena\SBM\Common\Tomcat 7.0\server\default\logs
- For Oracle systems, note the following:
- You must ensure that the required roles and privileges for the SBM schema user are up-to-date. Refer to solution S133641 for details.
- You must perform the database upgrade using either the
SBM DSN or a system DSN that uses the "Oracle for SBM" driver. If your system used the Mashup2009
DSN prior to the upgrade, that DSN is automatically converted to use the new
"Oracle for SBM" driver.
Important: The underlying driver in the DSN that ships with SBM was changed in SBM in 10.1. If you currently use the Mashup2009 DSN with SBM, you do not need to do anything—the DSN will be updated automatically. If you created your own custom DSN with the "Oracle for SBM" driver prior to upgrading to SBM 10.1 or later, you must recreate the DSN and use the new "Oracle for SBM" driver that ships with SBM after the upgrade is finished.
Planning for the Upgrade
The upgrade process you will follow depends on the type of installation you currently have:
- Single Server Installation – All of the SBM components are
installed on a single server.
For single server installations, you will run the suite installer on your server and then upgrade the databases using SBM Configurator.
- Distributed Installation – The SBM components are installed
on multiple servers that comprise a single production environment.
For distributed installations, you will run the suite installer on each server, and then use SBM Configurator to upgrade the databases.
- Multi-environment installation – The SBM components are
installed on single or multiple servers that are separated into multiple SBM
environments (such as development, test, and production).
The process for upgrading multiple environments (used in a path to production model) depends on which environment hosts SBM Application Repository and which environment you plan to upgrade first (Test/Staging first or Production first).
- If
SBM Application
Repository
is part of the Test environment and you plan to upgrade Test first
In this setup, each environment uses a single instance of Application Repository that is installed in the Test environment. You will upgrade the Application Engine and Orchestration Engine databases in the Test environment first. After the upgrade in Test is finished, you will not be able to deploy to Production from Application Repository until you upgrade the Production servers and databases.
- If
SBM Application
Repository
is part of the Production environment and you plan to upgrade Test first
In this setup, each environment uses a single instance of Application Repository that is installed in the Production environment. You will upgrade the Application Engine and Orchestration Engine databases in the Test environment first. After the upgrade in Test is finished, you will not be able to deploy to Test from Application Repository until you upgrade the Production servers and databases.
- If
SBM Application
Repository
is part of either Production OR Test and you plan to upgrade all environments
at the same time
If you plan to upgrade all environments at the same time (one immediately after the other), upgrade the instance that hosts Application Repository first (likely Production). This will allow you to upgrade the other environments that do not have SBM Application Repository without installing a temporary instance.
- If
SBM Application
Repository
is part of the Test environment and you plan to upgrade Test first
Pre-Upgrade Steps
Follow these steps before you perform the upgrade.
- Verify that SBM 11.X or later is installed on the System Information tab in SBM Configurator.
- Back up your existing databases.
- Back up the SBM installation directory structure on the Application Engine server.
- Back up the Smart Search index directory on the SBM Common Services server. If you need to revert the upgrade for any reason, you will restore the index from this backup (because the index is rebuilt as part of the upgrade).
- Consider consulting with your DBA to assess the current table indexes in the SBM databases. Because significant database schema changes do not necessarily coincide with each database upgrade, table indexes are not automatically rebuilt as part of the upgrade process. Over time, indexes can report excessive fragmentation, which could negatively impact performance if they are not rebuilt periodically.
- Create a new database space in your DBMS to host the Configuration Settings database if you did not create it in a prior release. As of SBM 10.1.5, you can use this database to store configuration settings across your entire SBM installation in one centralized location.
- Download the new suite and client installers from support.serena.com.
Upgrading the Installation
- Extract the server installation files, and then launch the suite installer. An installer message prompts you to confirm that you are upgrading your system. Click Next to continue.
- The
Ready to Upgrade dialog box appears. Click
Upgrade Now to being upgrading the server installation. At the
end of the installation upgrade, click
Configure to launch
SBM Configurator.
Note: If you are prompted to restart your server, SBM Configurator launches automatically once the server has restarted. (On Windows 2008 systems, you must manually launch SBM Configurator after the restart). If you decline, you will not be able to run SBM Configurator until the server has been restarted.
- Decide if you will use the
Configuration Settings database if you have not done so
already. If you have a distributed installation, it is highly recommended that
you use the
Configuration Settings database, because it enables you to
easily synchronize configuration settings between each
SBM
server without requiring you to export and import configuration snapshot files.
On the Database Servers tab, enter database connection information for the Configuration Settings database that you created as part of the pre-upgrade process.
- Verify your configuration settings, and then click
Apply.
SBM Configurator
detects the current upgrade process and upgrades the file system by merging
existing configurations from your previous installation into the new
installation files.
Important: You must click Apply to save these changes before you upgrade the database. Once the file system is upgraded, you can run SBM Configurator again anytime thereafter to verify or modify your configuration settings as needed.
- Open the
Database Servers tab in
SBM Configurator,
and then click
Upgrade Database.
Tip: If any errors occur during the Application Engine database upgrade, review the upgrade log here:
installDirectory\Serena\SBM\Application Engine\log
If an ORA-00904 message appears in the Application Engine upgrade log after you finish upgrading the Application Engine database, refer to solution S141358 for a description of the problem and a resolution.
After the database is upgraded successfully, verify that the services are started in the Manage Services tab. Instruct Application Repository users to clear the cache in their Web browsers before they attempt to access SBM Application Repository.
- On each client machine, run the client installer. The client executable contains SBM Composer and is intended to be run only on client machines. Previous versions of SBM Composer are upgraded automatically and do not need to be uninstalled prior to upgrading. The new version is installed in the same location.
Post-Upgrade Tasks
Review the following information and make any necessary changes after you have upgraded your servers and databases:
- SBM Configurator
warns you if your installation currently uses default certificates (which
should be replaced) or if your current certificates will expire soon.
Important: To properly secure your installation, you must generate new key pairs even if you do not plan to use SSO. If you do not generate new key pairs, the default certificates that the STS inherently trusts are used. To increase security, launch SBM Configurator and generate new unique certificate for all components. For details, see "Securing SBM" in the SBM Installation and Configuration Guide.
- For systems that are configured to use client certificate authentication, you must perform additional configuration steps after the upgrade or disable the feature entirely. For details, refer to the entry about client certificate authentication in Installation and Configuration Issues.
- HTML rendering and Rich Text editing is enabled by default for all notes in your system after the upgrade. To disable these features for notes, clear the Render HTML in Notes check box located on the HTML tab of the Settings dialog box in SBM System Administrator.
- User credentials in SBM Application Engine Web service calls that use Basic authentication are now handled exclusively by SBM Application Engine itself, instead of IIS. This configuration is common if your SBM system is set up with NT Challenge Response for end-user authentication. After upgrade, this means that you must now specify the Windows domain for Web service calls in SBM Configurator, otherwise the domain that the IIS server machine is installed on is used for user validation.
- The use of logical field names in the $FIELDVALUE base item template tag has been deprecated. Serena recommends that you review your current e-mail templates and replace field display names with the database field name after the upgrade.
-
The Require appended text option, available for Journal fields on the Attributes tab (field Property Editor) and the Field Overrides tab (workflow Property Editor) now works as intended. When the Required and Require appended text options are selected, users must append text to the field during a transition. When only Required is selected, users do not need to append text if there is an existing entry.
In past releases, selecting only the Required option would require users to append text to an existing entry. Now, the Require appended text option must also be selected to require users to append text.
Upgrading Customizations and Integrations
Review the following information for help with upgrading custom changes and integrations.
-
If you made custom modifications to any HTML templates, e-mail templates, or online help files, you must merge your changes into the newly-upgraded files, and then use SBM System Administrator to Put Files in Database. All templates and images in the database are replaced by files on your local machine as part of this operation. Backup templates are stored on the installationDirectory\Serena\SBM\Application Engine server here:
installDir\Serena\SBM\Application Engine\Backup<version>-<date>-<time>
Note: For a list of configuration Files, Web Interface templates, JavaScript files, and strings that have changed in this release, refer to solution S141830. You must manually merge some of your existing SSO customizations into the newly installed files after you upgrade your software and database. - If you installed the TT4ZMF integration prior to upgrading, you must follow the instructions in the TT4ZMF readme to reinstall the integration after the SBM upgrade is complete.
- If you configured your system to use anonymous events prior to the upgrade, you must either add credentials to your events (preferred) or you must select the Allow Anonymous Events check box in SBM Configurator and enter an SBM user name and password to use anonymous events after the upgrade.
Upgrades from 10.1.X
Review this section for upgrades to SBM 11.1 from versions in the 10.1.X line. If you are upgrading from 11.0 or higher, refer to Upgrades from 11.X.
To test the upgrade, Serena recommends that you mimic your current installation on a separate set of servers. This test installation should include all of the environments used by your system. Upgrade and test this installation before upgrading your production installation. To upgrade successfully, you must upgrade each server and client machine to SBM 11.1.
- Requirements and Changes
- Planning for the Upgrade
- Pre-Upgrade Steps
- Upgrading the Installation
- Upgrading the Databases
- Post-Upgrade Tasks
- Upgrading Customizations and Integrations
Requirements and Changes
Before you upgrade to SBM 11.1, read the following important information:
- SBM 11.1 requires Serena License Manager 2.2. You must upgrade to version 2.2 before you can upgrade to SBM 11.1.
- SBM 11.1 requires 64-bit Windows servers. If you are using 32-bit servers prior to the upgrade, you must install SBM 11.1 on one or more 64-bit machines, and then upgrade the databases using the 64-bit installation. As part of the upgrade, review and upgrade any scripts and APIs that were originally created on a 32-bit operating system to ensure that they also run on a 64-bit system. For example, if you have any scripts that load .dll files, those .dll files must be upgraded to run on a 64-bit machine.
- If you used
HTTP Basic Authentication to manage user sessions prior to the
upgrade,
SBM Configurator
automatically converts this to
SSO
once the upgrade is finished. The
HTTP Basic Authentication option has been deprecated and is no
longer available in
SBM Configurator
because there are more secure options for managing user sessions.
Electronic signatures are now authenticated according to what is selected for Web services authentication in SBM Configurator if you are using Windows Authentication or Third-Party Authentication System for Browser authentication. Prior to 11.1, electronic signatures were always authenticated against the internal SBM database.
If you need assistance with re-enabling legacy behavior for either setting, please contact Serena Support.
- In order to prevent notifications from being sent for changes that have not happened recently, SBM now deletes notification events that are older than 90 days that contain a THREADID during the database upgrade. To check if you have events that will be deleted, refer to the SQL queries in solution S140945.
- Work Center
search operates on pre-built indices that may change for each
SBM
release. The
Work Center
search index is rebuilt when Tomcat is started for the first time after the
upgrade. The complete indexing operation can take ample time to finish for very
large databases; however, some search results in
Work Center
begin to appear immediately and the number of results continues to grow while
the initial indexing operation works toward completion.
You can view the overall progress of the indexing operation in the ssf.log file located on the server that hosts SBM Common Services. The log file is located here:
installDir\Serena\SBM\Common\Tomcat 7.0\server\default\logs
- For upgrades from 10.1.X, as part of the database
upgrade and migration to the new ODE BPEL engine, data in the CL_CONTEXT_VALUE
and CL_LOG tables is deleted. New indexes are added to the CL_CONTEXT_VALUE and
CL_LOG tables on upgrade to prevent time outs from occurring when you try to
view Common Log data in
SBM Composer
or
SBM Application
Repository.
In order to add the new indexes, these tables will be emptied during the
upgrade process.
Important: If you need to view Common Log data that was present prior to the upgrade, ensure that you have backed up these tables.
- For Oracle systems, note the following:
- You must ensure that the required roles and privileges for the SBM schema user are up-to-date. Refer to solution S133641 for details.
- You must perform the database upgrade using either the
SBM DSN or a system DSN that uses the "Oracle for SBM" driver. If your system used the Mashup2009
DSN prior to the upgrade, that DSN is automatically converted to use the new
"Oracle for SBM" driver.
Important: The underlying driver in the DSN that ships with SBM was changed in SBM in 10.1. If you currently use the Mashup2009 DSN with SBM, you do not need to do anything—the DSN will be updated automatically. If you created your own custom DSN with the "Oracle for SBM" driver prior to upgrading to SBM 10.1 or later, then you must recreate the DSN and use the new "Oracle for SBM" driver that ships with SBM after the upgrade is finished.
Planning for the Upgrade
The upgrade process you will follow depends on the type of installation you currently have:
- Single Server Installation — All of the SBM components are
installed on a single server.
For single server installations, you will run the suite installer on your server and then upgrade the databases using SBM Configurator. The databases are upgraded in two phases—in phase one, the Application Engine database is upgraded; once it completes successfully, phase two begins. In phase two, you are prompted to enter the SBM user name and password of your primary system administrator or an SBM user that has the Remote Administration privilege to upgrade the Orchestration Engine database.
- Distributed Installation — The SBM components are installed
on multiple servers that comprise a single production environment.
For distributed installations, you will run the suite installer on each server, and then use SBM Configurator to upgrade the databases. When you begin the Orchestration Engine database upgrade on the server that hosts SBM Orchestration Engine, you are prompted to enter the SBM user name and password of your primary system administrator or an SBM user that has the Remote Administration privilege. This scenario requires that you start the SBM services and that you perform the database upgrades in a certain order. This is explained in more detail below in Upgrading the Databases.
- Multi-environment installation — The SBM components are
installed on single or multiple servers that are separated into multiple SBM
environments (such as development, test, and production).
The process for upgrading multiple environments (used in a path to production model) depends on which environment hosts SBM Application Repository and which environment you plan to upgrade first (Test/Staging first or Production first).
- If
SBM Application
Repository
is part of the Test environment and you plan to upgrade Test first
In this setup, each environment uses a single instance of Application Repository that is installed in the Test environment. You will upgrade the Application Engine and Orchestration Engine databases in the Test environment first. After the upgrade in Test is finished, you will not be able to deploy to Production from Application Repository until you upgrade the Production servers and databases.
- If
SBM Application
Repository
is part of the Production environment and you plan to upgrade Test first
In this setup, each environment uses a single instance of Application Repository that is installed in the Production environment. You will upgrade the Application Engine and Orchestration Engine databases in the Test environment first. After the upgrade in Test is finished, you will not be able to deploy to Test from Application Repository until you upgrade the Production servers and databases.
- If
SBM Application
Repository
is part of either Production OR Test and you plan to upgrade all environments
at the same time
If you plan to upgrade all environments at the same time (one immediately after the other), upgrade the instance that hosts Application Repository first (likely Production). This will allow you to upgrade the other environments that do not have SBM Application Repository without installing a temporary instance.
For information about warnings that may appear during a multi-environment upgrade, see "Handling Warnings with Multiple Environments in S141802.
- If
SBM Application
Repository
is part of the Test environment and you plan to upgrade Test first
If you are upgrading from a release prior to 10.1.2, use SBM Configurator to designate which server will host the SBM Logging Services component. By default, SBM Logging Services appears on an undefined server until you drag and drop it to the desired server. If you are upgrading from a release after 10.1.2, SBM Logging Services is enabled on the same machine as SBM Common Services by default. You can use SBM Configurator to move it to a dedicated server, if necessary (for example, if you set the logging level to TRACE for debugging purposes).
Pre-Upgrade Steps
Follow these steps before you perform the upgrade.
- Verify that SBM 10.1.X or later is installed on the System Information tab in SBM Configurator.
- Back up your existing databases.
- Back up the SBM installation directory structure on the Application Engine server.
- Back up the Smart Search index directory on the SBM Common Services server. If you need to revert the upgrade for any reason, you will restore the index from this backup (because the index is rebuilt as part of the upgrade).
- Consider consulting with your DBA to assess the current table indexes in the SBM databases. Because significant database schema changes do not necessarily coincide with each database upgrade, table indexes are not automatically rebuilt as part of the upgrade process. Over time, indexes can report excessive fragmentation, which could negatively impact performance if they are not rebuilt periodically.
- If you store SBM item attachments on the file system, open SBM System Administrator and note the location of the attachments directory. You will enter the location in SBM Configurator later as part of the upgrade.
- Create a new database space in your DBMS to host the Configuration Settings database if you did not create it in a prior release. As of SBM 10.1.5, you can use this database to store configuration settings across your entire SBM installation in one centralized location.
- Download the new suite and client installers from support.serena.com.
Upgrading the Installation
- Extract the server installation files, and then launch the suite installer. An installer message prompts you to confirm that you are upgrading your system. Click Next to continue.
- The
Ready to Upgrade dialog box appears. Click
Upgrade Now to being upgrading the server installation. At the
end of the installation upgrade, click
Configure to launch
SBM Configurator.
Note: If you are prompted to restart your server, SBM Configurator launches automatically once the server has restarted. (On Windows 2008 systems, you must manually launch SBM Configurator after the restart). If you decline, you will not be able to run SBM Configurator until the server has been restarted.
- Decide if you will use the
Configuration Settings database if you have not done so
already. If you have a distributed installation, it is highly recommended that
you use the
Configuration Settings database, because it enables you to
easily synchronize configuration settings between each
SBM
server without requiring you to export and import configuration snapshot files.
On the Database Servers tab, enter database connection information for the Configuration Settings database that you created as part of the pre-upgrade process.
- If you store SBM item attachments on the file system, enter the location of the attachments directory on the Common Services tab. This enables SBM Common Services to return attachments in Work Center search results. If you store attachments in the database, skip this step.
- Verify your configuration settings, and then click
Apply.
SBM Configurator
detects the current upgrade process and upgrades the file system by merging
existing configurations from your previous installation into the new
installation files.
Important: You must click Apply to save these changes before you upgrade the Application Engine and Orchestration Engine databases. Once the file system is upgraded, you can run SBM Configurator again anytime thereafter to verify or modify your configuration settings as needed.
- On each client machine, run the client installer. The client executable contains SBM Composer and is intended to be run only on client machines. Previous versions of SBM Composer are upgraded automatically and do not need to be uninstalled prior to upgrading. The new version is installed in the same location.
Upgrading the Databases
The database upgrade process occurs in two phases when upgrading from 10.1.X to 11.X. Review the following important information before you begin.
- The Orchestration Engine database upgrade is no longer automatically performed after you start the SBM services; instead, you must manually invoke the upgrade process by clicking the Upgrade Database link in SBM Configurator. This ensures that the Orchestration Engine database is not upgraded prematurely.
- If SBM Application Engine and SBM Orchestration Engine are installed on the same server, the Orchestration Engine database upgrade is performed immediately after the Application Engine database upgrade.
- If
SBM Application Engine
and
SBM Orchestration Engine
are installed on separate servers:
- You must ensure that IIS is started on the SBM Application Engine server and SBM Tomcat is started on each of the other SBM servers. Both IIS and SBM Tomcat must be running and all components must be accessible from the SBM Orchestration Engine server before the Orchestration Engine database upgrade begins.
- You must upgrade the Application Engine database on the SBM Application Engine server first, and then upgrade the Orchestration Engine database on the SBM Orchestration Engine server.
- The Orchestration Engine database upgrade is performed by the renew utility using the user account that you specify when prompted. For details on this process and more information related to the Orchestration Engine database upgrade, refer to S141802.
When you are ready, open the Database Servers tab in SBM Configurator, and then click Upgrade Database.
installDirectory\Serena\SBM\Application Engine\log
If an ORA-00904 message appears in the Application Engine upgrade log after you finish upgrading the Application Engine database, refer to solution S141358 for a description of the problem and a resolution.
After the databases are upgraded successfully, verify that the services are started in the Manage Services tab. Instruct Application Repository users to clear the cache in their Web browsers before they attempt to access SBM Application Repository.
Post-Upgrade Tasks
Review the following information and make any necessary changes after you have upgraded your servers and databases:
- SBM Configurator
warns you if your installation currently uses default certificates (which
should be replaced) or if your current certificates will expire soon.
Important: To properly secure your installation, you must generate new key pairs even if you do not plan to use SSO. If you do not generate new key pairs, then the default certificates that the STS inherently trusts are used. To increase security, launch SBM Configurator and generate new unique certificate for all components. For details, see "Securing SBM" in the SBM Installation and Configuration Guide.
- For systems that are configured to use client certificate authentication, you must perform additional configuration steps after the upgrade or disable the feature entirely. For details, refer to the entry about client certificate authentication in Installation and Configuration Issues.
- HTML rendering and Rich Text editing is enabled by default for all notes in your system after the upgrade. To disable these features for notes, clear the Render HTML in Notes check box located on the HTML tab of the Settings dialog box in SBM System Administrator.
- As part of the upgrade,
SBM
reviews the existing JBoss configuration and allocates the same amount of
memory to Tomcat that was previously allocated to JBoss. After the upgrade, if
you need to adjust the amount of memory that is allocated to Tomcat, perform
the following steps:
- Stop the SBM Tomcat service.
- Navigate to installDirectory\Serena\SBM\Common\Tomcat 7.0\bin, and edit the common_config.bat file.
- Change the JVM_X_MAXMEMSIZE value as necessary.
- In the same \bin directory, execute the update_tomcat_config.bat file.
- Start the SBM Tomcat service.
- After the database upgrades are finished, use the Reset Administrative User Access wizard in SBM System Administrator if your database does not contain at least one Regular User or Managed Administrator account with Remote Administration privilege. This wizard enables you to define at least one user as your primary system administrator (an account that has Regular User or Managed Administrator product access with Remote Administration privilege) who can log in to SBM Application Administrator. For details, see the SBM System Administrator Guide.
- User credentials in SBM Application Engine Web service calls that use Basic authentication are now handled exclusively by SBM Application Engine itself, instead of IIS. This configuration is common if your SBM system is set up with NT Challenge Response for end-user authentication. After upgrade, this means that you must now specify the Windows domain for Web service calls in SBM Configurator, otherwise the domain that the IIS server machine is installed on is used for user validation.
- The use of logical field names in the $FIELDVALUE base item template tag is deprecated and will not be supported in future releases. Serena recommends that you review your current e-mail templates and replace field display names with the database field name after the upgrade.
-
The Require appended text option, available for Journal fields on the Attributes tab (field Property Editor) and the Field Overrides tab (workflow Property Editor) now works as intended. When the Required and Require appended text options are selected, users must append text to the field during a transition. When only Required is selected, users do not need to append text if there is an existing entry.
In past releases, selecting only the Required option would require users to append text to an existing entry. Now, the Require appended text option must also be selected to require users to append text.
Upgrading Customizations and Integrations
Review the following information for help with upgrading custom changes and integrations.
-
If you made custom modifications to any HTML templates, e-mail templates, or online help files, you must merge your changes into the newly-upgraded files, and then use SBM System Administrator to Put Files in Database. All templates and images in the database are replaced by files on your local machine as part of this operation. Backup templates are stored on the installationDirectory\Serena\SBM\Application Engine server here:
installDir\Serena\SBM\Application Engine\Backup<version>-<date>-<time>
Note: For a list of configuration Files, Web Interface templates, JavaScript files, and strings that have changed in this release, refer to solution S141830. You must manually merge some of your existing SSO customizations into the newly installed files after you upgrade your software and database.If you used custom HTML templates in your reports, the reports might not display properly after upgrade. Consider using the default template or modifying it as needed instead. For example, as of SBM 10.1.2, several changes were made to Summary Reports that might not display properly using a custom template from a prior release. Instead, either use the new default template or merge your chanes into the default template to create a new custom template.
- If you installed the TT4ZMF integration prior to upgrading, you must follow the instructions in the TT4ZMF readme to reinstall the integration after the SBM upgrade is complete.
- In
SBM
10.1.2, the
SSO
Login Application (Federation Server) was merged with the
SSO
Security Token Service (STS) into a single
SSO
Security Server (also known as the Identity Provider (IDP)). This means that
the
ALFSSOLogin.war and
TokenService.war directories were been merged
and replaced with a new
idp directory on the
SSO
server.
If you are upgrading from a release prior to 10.1.2 and you have created custom SSO integrations, you must review all URLs and calls to ensure that they use the latest directory names. For example, if your existing integrations call the Security Token Service (STS), you must ensure that the new idp directory is used.
The endpoints of the SSO services must be changed accordingly. The relative URIs will stay the same, but since the application is new, the login application entry point will be http(s)://host[:port]/idp/login. For the STS, it will be: http(s)://host[:port]/idp/services/Trust.
- If you configured your system to use anonymous events prior to the upgrade, you must either add credentials to your events (preferred) or you must select the Allow Anonymous Events check box in SBM Configurator and enter an SBM user name and password to use anonymous events after the upgrade.
Fixed Issues
A list of defects fixed in this version can be found in the Knowledge Base. You must have a Serena.com user account to view items in the Knowledge Base. Register for a free account if you do not have already have one.
Beginning in SBM 10.1, user accounts are managed in SBM Application Administrator rather than in SBM System Administrator. SBM Application Administrator, which requires a connection to the SBM Web server, is not available if the number of users in your system exceeds the number of installed seat licenses.
If you receive a seat license error in a version earlier than SBM 10.1.1.4, contact Customer Support for assistance is resolving the issue. If you have SBM 10.1.1.4 or later installed, the Users tab in the SBM System Administrator is enabled automatically if you encounter this problem. Open SBM System Administrator and delete or modify user accounts so that they are in compliance with their seat licenses. (If you encounter this problem and the SBM System Administrator is already open, you need to close it and reopen it for the Users tab to appear.) Once you resolve user accounts, the Users tab is not visible the next time you open the SBM System Administrator.
Known Issues
This section describes known issues and contains the following categories:
- Installation and Configuration Issues
- Administrator Issues
- SBM Composer Issues
- Single Sign-On (SSO) 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.
Installation and Configuration Issues
- The
SBM
Tomcat components in 11.1 run on Java 8. Due to known issues in this version,
if client certificate authentication is enabled between components in
SBM,
all communication from Tomcat to IIS fails. Also, if SSO is used, users cannot
log in to
SBM
when client certificate authentication is enabled. This means that you if have
client certificate authentication enabled prior to the upgrade, you must
disable it after the upgrade is finished. Alternatively, you can leave client
certificate authentication enabled, and perform the steps described in
D22099 to work around this problem.
Once these defects (described here and here) are addressed, Serena will update the jdk that is included with SBM.
Administrator Issues
SBM Application Repository Issues
-
The
following issue is only applicable if you had previously upgraded to 10.1 or
10.1.1.1. If you did not use either version prior to upgrading, then you can
ignore this information.
Values in promotion profiles that were created in 10.1 or 10.1.1.1 were set to All by default. Starting with 10.1.1.2, entities for new items (items added to a process app since the profile was created) will be set to None by default.
In addition:- Profiles created prior to 10.1 that had entities set to None may have been incorrectly using All. These entities will be set back to None.
- Profiles created in 10.1 or 10.1.1.1 that had entities set to the default All may also be set to None. These entities must be manually corrected.
SBM Composer Issues
- Newly-created relational grid widgets and embedded reports that point to auxiliary tables return an error in the browser after a process app is deployed. Note that this does not apply to widgets created before the upgrade to 11.1. To work around this problem, refer to solution D23340.
Single Sign-On (SSO) Issues
- If you are using SSO to manage user's browser sessions, a couple of SSO-related log files will quickly accumulate several entries as users access the system after upgrade. To work around this problem, follow the steps in D23336.