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

Contents

About this Release

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

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

Note the following important information about this release:

  • SBM 10.1.5 requires Serena License Manager 2.2. You must upgrade to version 2.2 before you can upgrade to SBM 10.1.5.
  • 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 10.1.5 is available in U.S. English only.

Helpful Links

Serena Documentation Center

SBM 10.1.4 Readme

SBM 10.1.4.1 Readme

System Administrator Deprecation List

Terminology Changes

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

Old Term New Term

SBM Application Administrator

 SBM Application Repository

Web Administrator

 SBM Application Administrator

Manage Data

 Auxiliary Data (in SBM Application Administrator)

Notification Server (in the SBM installer)

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

Supported Configurations

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: Build 10.01.05.00.1958
  • SBM Composer : Build 404
  • SBM System Administrator and SBM Application Administrator: Build 10.01.05.00.1958
  • Application Repository: Build 10.01.05.00.1958
  • SBM Configurator: 10.01.05.00.641
  • Database version: 1015000054
Note: The 10.1.5 documentation is versioned as follows:
  • English – 10.1.5
  • Japanese – 2009 R4.01 (the translated content applies to version 2009 R4.01)

Third-Party Tools

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

What's New

The following features have been added in this release.

Serena Work Center Improvements

For additional changes and improvements, refer to Additional Serena Work Center Changes.

  • Improvements to the Submit Feature
    Several improvements have been made to the submit (+ New) feature.
    • The Recent and Favorites options are now on separate tabs, along with a new Browse tab.
    • Users can navigate the project tree to find projects to submit new items into.
    • Users can limit the scope of project searches and the project tree to their preferred projects or the selected application or application group.
  • Search Improvements

    See search in action

    • The global Search box has been replaced with an icon that opens to a search page. You can use this page to search for all items in the system or limit the search to the selected application or application group.
    • Search criteria is now highlighted in the results list.
    • Users can now search for Information in most file attachments that contain text (PDF and Microsoft Word, for example). Item link titles are also included in search results.
    • As you filter search results, you can now search for projects and applications if your results lists includes items from more than 10 projects or applications.
    • When more than 300 items are returned, filter lists are no longer numbered. As you select filters to limit the list, the filter lists are numbered once fewer than 300 items are returned.
    • The minimum number of characters required for a search has changed from three to two.
  • Report Improvements
    • Report Center

      See the Report Center in action

      Report categories are now shown at the top of the Report page for easier access. In addition, Recent Reports and System Reports have been added as categories. Recent reports are limited to the most recently run 200 reports. System reports are available to users with privileges to view these report types, but only in on-premise systems.

    • Users can now search for reports in each category. For example, they can use My Reports to search for a specific report they created.
    • The Create Report icon has been replaced with a button that is more easily accessed in the Report Center.
    • Report Favorites

      Users can now add their favorite reports to their navigation menus for each application and application group.

    • Report Quick Search

      A report search has been added to the main search feature located on the Work Center toolbar. Use this search to find and run reports. Use the Report Center search for access full reporting capabilities, such as creating, deleting, and scheduling reports.

  • Adding Favorite Reports and View to Menus

    See "Favorites" in action

    Users can now easily add and remove favorite views and reports on their navigation menus for pinned applications groups. They can also add and remove favorite views for the Home context.

    Users can drag and drop menu items to reorder views and reports in each category (dashboards, activities, calendars, reports, and backlogs).

    Remote administrators can create shared views (dashboard, activity, backlog, and calendar) and automatically pin the views to navigation menus for users who share the view.

    See it in action

  • Notifications View Improvements
    • Users can now use the Notifications view open a list of notifications based on a subscription. For example, they can choose to view only notifications generated for their subscription to "I become the owner of a work item."
    • You can now perform bulk updates to mark notifications as read or remove them from your list. The bulk updates apply to the items shown on the page you are viewing.
    • The number of notifications shown on each page is based on the Items Per Page user profile setting, with a limit of 40 items per page.
  • Feed and View Improvements

    See custom activity views in action

    • Custom Filters for Activity Views

      You can now customize the drill-down tabs based on fields. Field availability depends on the view's context (home, application group, or single application) and feeds included in the view. For activity views with multiple applications, you can organize tabs for each context.

    • Custom Item Data for Activity Views

      You can now choose which fields to show for each work item in the list. You can choose to show up to three fields when the work item list is collapsed and an additional three fields to show when an item is expanded.

      Field availability depends on the view's context (home, application group, or single application) and feeds included in the view. If your view spans multiple applications, you can choose to show different data for work items for each application.

    • Condensed Activity Widgets for Dashboards

      You can now add condensed activity widgets to dashboard views. Widgets are based on activity views, and you can choose to show the activity ring or the work item list.

    • Mass Updates for Activity and Backlog Views

      You can now perform "mass updates" from activity and backlog views.

    • Calendar Feeds and Auxiliary Tables

      You can now create calendar feeds based on auxiliary tables.

    • Completed Item Reports in Backlog Views

      You can now choose to calculate completion rates based on ownership throughout the item's backlog life cycle or on current values in selected User fields.

      Example for basing completion rates on ownership: Laura Engineer worked on an item in the backlog and then assigned it to Hans Tester for verification. The item is included in the completed tally for the My Work Items progress report for Hans and Laura once the item meets the completion criteria defined in the backlog feed.

      Example for basing completion rates on current values in selected User fields: Select a Technician field. When Laura Engineer is selected in that field for a work item and the item is completed, it is included in the completed tally for My Work Items for Laura, but not for other users who may have worked on the item, such as a user selected in the Tester field.

  • Load Time Improvements

    Performance improvements have been made to load times for Serena Work Center. To facilitate this improvement, many JavaScript files and cascading style sheets (.css) have been combined and minified. These changes do not impact similar files for the SBM User Workspace.

New SBM Application Repository User Interface

The SBM Application Repository user interface has been improved and updated. The updated interface uses new Web browser technologies to provide a clear and easy-to-use experience for administrators.

See the new Application Repository in action

Functionality in Application Repository remains largely the same, but the following differences are noted here:

  • In prior versions, in order to promote a process app you had to select a snapshot. Now, you can select the process app on the Process Apps tab, and then click the Promote icon to promote it from one environment to another. To promote using a saved snapshot, select the source on the Snapshots tab, and then click the Promote icon.
  • The option to use a Live or Saved snapshot no longer appears when you promote a snapshot or create a new promotion profile. To perform a "live" process app promotion in 10.1.5, you simply select a process app and promote it, or use a promotion profile as follows:
    • Promote a process app, save the settings as a new promotion profile, and then perform a "live" promotion using the new profile.
    • Select a process app, create a new promotion profile on the Profiles tab, and then perform a "live" promotion using the new profile.

    Promotion profiles that you create using snapshots are considered "saved"; they do not transfer live design and administrative data from a source environment.

  • The Orchestration Engine tab (which contained the Event Manager Log) has been removed. You can now access the Event Manager log details in a sub-tab under Environments.
  • The Common Log is has been moved to a sub-tab under Environments.
  • The Home tab has been removed. The Solutions tab is now the landing page for Application Repository.
  • Promotion Profiles are now accessible via a sub-tub under Process Apps.
  • The Application Repository help is now hosted on the Serena Documentation Center; not installed with Application Repository.

User Preferences for Groups

You can now apply user preferences to one or more groups. This includes application group pinning for Serena Work Center.

Administrative Control of Application Groups for Serena Work Center

You can now simplify the user start-up process by pinning applications and application groups to the Work Center toolbar. You can also choose to remove the Home icon.

See user on-boarding in action

You can:
  • Apply settings at a global level. These default settings are automatically applied to newly created users, but you can apply them manually to users and group members.
  • Apply settings to one or more users.
  • Apply settings to one or more groups.

Users can modify the applications you pin for them, unless you select the Locked check box for specific applications.

Multi-Language Support for Design Objects

You can now specify a default language (locale) for a process app in SBM Composer. This enables you to set a language (locale) that is different than the platform default language in the event that design object strings in your process app are not in the same language as the default platform language.

In addition, you can now easily create multiple translations for process app design objects that are created in SBM Composer. After a process app is deployed, administrators can create separate translations for the following design objects using SBM Application Administrator:

  • Name and Help Text for workflows, states, transitions, and fields
  • Field selections
  • Form strings (displayed on custom forms)
  • Labels associated with tables (displayed on quick forms)
  • Name, description, and tab name for applications
  • Name, description, and singular name for tables
  • Workflow annotation and swimlanes in the workflow diagram
  • Global design objects such as system state and transition names (whether on-premise or on-demand)

This means an administrator to create a process app in the en-US locale, but then translate the design object strings into other predefined locales after the app is deployed. For example, an administrator can define a set of locales in Application Administrator, deploy a process app, and then translate the process app's design object strings into each defined locale using the Localization page in Application Administrator. When translation is complete, users who select the locale for the translated version will see the translated strings.

For example, if users need a French version of your English process app, you can now easily translate the English design object strings into French, and users with the French language (locale) will see the app's states, transitions, fields, and more in French.

Refer to the SBM Application Administrator Guide for a list of areas in SBM that display translated strings for design objects.

Note: You may experience longer deploy times for process apps with several design object strings or if you have created several predefined locales.

Form Extensions

Form extensions are packages that contain custom form actions, custom widgets, and assets, such as JavaScripts, images, and css and html files. You can create form extensions, then add them to process apps in SBM Composer. For instructions, refer to S140957 in the Knowledgebase at serena.com.

View Status of Notifications

The Item Notifications section now contains My Notifications, which lists the item notifications a user has added to an item, and Notification History, which displays a list of notifications that have been processed for the item. The Notification History includes the date and time the notification was processed, the recipient, and the status of the notification.

By default, the Notification History only displays notifications for which the current user is the recipient. You can grant users the View Status of Notification item privilege to enable them to view the status of notifications for all recipients. A recipient search box appears for users who are granted this privilege.

Global Process App Roles

You can now add roles to the Global Process App, which enables you to manage role privileges for auxiliary tables exclusively in the Global Process App. The privileges are granted to users and groups that you assign to the roles on the base project in Application Administrator.

This means you can use roles in SBM Composer to associate users with user fields in Global Process App auxiliary tables, instead of using SBM System Administrator to associate users with these fields.

Additional Changes

The following sections describe additional features that have been changed or added to this release.

End-user Changes

Additional Serena Work Center Changes

  • Application Group Pinning

    Users can now click a star icon to pin and unpin applications and application groups to and from their toolbar. A "Show only favorites" option has also been added, enabling users to see only applications they have already pinned.

    In addition, application tab URLs now use a numbered hash tag. This ensures users are returned to the current tab if they refresh their browsers. Users can also save pinned applications as browser bookmarks.

  • Sharing Views by E-mail

    You can now choose to alert users by e-mail when they are added to or removed from the shared list for any view.

    Additionally, you can now send links to shared views by e-mail or another distribution method. Owners and co-owners can send links to users while they are editing a shared view. Any user who can run a view can copy a link to the view or send it through e-mail. These options are located on the Actions menu on the view.

  • Log On As Another User

    Users with the "Log on as Another User" system privilege can now use this feature in Work Center.

  • Restore Saved Form Data Option

    This option has been removed from the user profile settings because it does not apply to forms in Work Center.

Reporting Changes

  • Custom Colors for Graphical Reports

    You can now select custom colors for most graphical reports. Depending on the report type and style, you can specify values for rows, columns, or groups.

    Note: Systems where HTML5 features are disabled and end-users have disabled or have not installed Adobe Flash, colors can be selected, but they are ignored in report results.
  • Summed Values for Distribution Reports

    You can now use the Sum Totals by option to see the sum of certain field values for Distribution and Advanced Distribution reports. This enables you to see the total amount of time allocated for a set of items, for example. In past releases, each item returned was counted as one.

    Numeric, Date/Time fields set as Elapsed Time fields, and weights for Single Selection fields can be used to sum values.

    For Trend reports, the label for this option has been changed from Weight Totals by to Sum Totals by, and you can now also sum Date/Time fields set as Elapsed Time fields.

  • Scheduled Reports and PDFs

    Users can now choose to send listing-type reports as PDFs or as a zipped Excel file for Listing, Change History, Deleted Items, and Multi-Table reports, as well as reports with join conditions. PDF results are limited to 200 items by default, but you can change this setting in the SBM System Administrator.

  • JSON Output for Reports

    You can now output report data to JSON format. This enables you to create custom visualizations for reports, such as graph widgets or tables. JSON output is available for all report types, except Drill Through, Multi-View and External.

    You can modify report URL parameters as documented in the SBM Reporting Guide located on the Documentation Center. You can also use the new report template (jsonoutput.htm) for all reports created in the SBM User Workspace or for Listing reports created in Serena Work Center.

  • Expanded Support for Text Fields in Summary Reports

    You can now choose any fixed-length Text field for Summary report data grouping. In previous releases, only fixed-length Text fields with no more than 120 characters could be used.

  • Logarithmic Scale and Scheduled Reports

    The logarithmic scale option for graphical reports is now supported in scheduled report output.

  • Calendar Reports Renamed

    Calendar feed reports are now referred to as Calendar reports, Calendar reports are now referred to as Multi-Calendar reports. Multi-Calendar reports contain one or more Calendar report.

    This name change was made to avoid confusion with Calendar Feeds, which are added to Calendar views in Serena Work Center.

  • Query-at-Runtime and Drill-down Links

    When you use query-at-runtime fields in reports with drill-down capabilities, such as Distribution reports, drill-downs links are valid for up to 1 hour after the report is run or up to 20 minutes after the last drill-down link is clicked.

General Changes

  • Rich Text Editor Improvements
    Improvements have been made in how the Rich Text Editor handles images copied from other applications, such as Gmail™ and Microsoft® Word. Images may not paste correctly in these cases, however:
    • If the image HTML tags include suspicious tags, plain text is shown instead of the image.
    • When you copy images with surrounding text, the images are not included when you paste them into the Rich Text Editor.
    • Images copied from Web pages may not paste correctly if the image URL is inaccessible. For example, if you copy an image from a secured Web page, it may not display correctly in the Rich Text Editor.

    In addition, several issues have been resolved with incorrect spaces with pasted text.

  • Browser Title Bar Display
    The item ID and title are now shown on the browser title bar when users open certain items in a new tab:
    • Items opened from reports and search results in Serena Work Center and the SBM User Workspace
    • Items opened from activity and backlog views in Serena Work Center
    • Reports (title only)
  • Improved Application Help

    The application help that users can view on primary items has been improved. The new layout now includes a drop-down list with descriptions for all the states, transitions, and decision steps in the workflow. The selected item in the drop-down list is highlighted in the image. If users collapse the page to a narrower view, the drop-down list is removed, and the help categories are listed below the workflow image.

    Additionally, the application help now displays translated strings for design objects in the application such as state and transition names. Note that the workflow image only displays the translated strings if support for HTML5 is enabled in SBM.

Administrator Changes

SBM Application Administrator Changes

  • Global E-mail Template View

    You can now manage all e-mail templates from a global view. In addition, on-demand customers can now modify templates for e-mails sent by users from items from this view.

  • Sorting Auxiliary Items by Value Display Format

    The fields you use for the value display format for auxiliary tables are now automatically shown in the first column of search results for the Manage Auxiliary Data feature.

    This enables users to sort results by the value display format.

  • Field Value Sorting

    You can now sort selection lists for User, Multi-User, Multi-Group, Single Selection, and Multi-Selection values, and for field dependency values. This includes default value selection lists for User, Multi-User, and Multi-Group fields.

  • Importing Default Values

    You can now choose to import default values when you use the Import Data feature in Application Administrator. To do so, leave cells for mapped fields empty in your spreadsheet, then select the Set default values for empty cells option in the Field Mapping area.

  • New View Status of Notification Privilege

    This item privilege enables users to view the status of notifications for all recipients in the Notification History portion of the Item Notifications section. If this privilege is not granted, the Notification History only displays notifications for which the current user is the recipient. This privilege is not granted to any users by default.

  • Filtering Group Membership by Product Access Type

    You can now filter the lists of users and groups available for group membership by product access type.

  • Auxiliary Table Sorting

    Auxiliary tables are now sorted alphabetically when you are assigning table privileges to users and groups.

Miscellaneous Changes

  • Audit Trail for "Log On as Another User"

    Records are now added to the TS_TRACEWORKS database table for each "log on as another user" action made by users or by Web services.

  • Scheduled Report Max Item Settings

    The Max Items to Display setting for scheduled reports has been separated into two options: one for reports that are distributed as zipped Excel files and one for reports that are distributed as PDFs. The default setting for PDFs is 250 items, with 500 be the maximum allowed.

  • Avatar Size Setting Has Moved

    The setting for modifying the maximum file size allowed for user avatars has moved to the TS_SYSTEMSETTINGS table. In previous releases, this was modified using a registry setting as described in S138355 in the Knowledgebase at serena.com. If you modified the registry setting, your changes are automatically migrated to the TS_SYSTEMSETTINGS table.

SBM Composer Changes

  • Form Changes
    • Form Column and Label Options

      You can now specify the number of columns when you create a new form.

      You can also set label display options at form creation to either show labels to the left of or on top of controls. You can modify form labels for each container control or for individual controls.

      In addition, you can choose to bind one or more privilege sections to a container control. This enables you to use the privilege section labels as the control label. You can modify the label as needed.

    • REST Grid Sample Data Options

      You can now modify sample data on the REST Service Configuration dialog box. This feature is particularly useful for configuring the REST Grid if SBM Composer cannot connect to the REST data source.

    • Background Colors and Corner Radius Options

      You can now apply a second background color to tab and expander containers, detail controls, and print form sections. For expander containers, detail controls, and print form sections, the second color is used in the header. For tabs, use the second color to differentiate between selected and unselected tabs.

      In addition, you can now apply a corner radius to containers, detail controls, and print form sections.

      To use these options, HTML5 form features must be enabled.

    • Form Preview and Role Restrictions

      You can now preview forms without any role restrictions.

    • Form Inheritance Information

      Inheritance information for forms is now shown on the Forms tab for sub-workflows, states, and transitions.

    • YouTube and Flickr Widgets Removed

      These widgets can no longer be added to forms. YouTube and Flickr widgets that are on existing forms should function as before, however.

  • Form Action Changes
    • Current User

      Support has been added for using the Current User value with User and Multi-User fields. You can detect if the current user is selected as a value, and you can also set or clear the values for User and Multi-User fields to "current user."

      For example, you can create a transition form action such as:

      When this form is loaded

      If Approvers field not in Current User

      Then set Approvers field to the Current User

    • Clearing Field Values

      You can now clear the values of fields. This is useful if you want to clear data from a field and then repopulate it based on the form action.

    • Form Submit or Cancel

      You can now use a form action to submit or cancel an open transition form.

    • Changing Field and Control Labels

      You can now use a form action to change the label for a field or control. You can also choose to include a colon in the label.

    • Value Filtering for Action Statements

      You can now filter long lists of values for events, conditions, actions, and restrictions when you create form action statements.

  • Process App Changes
    • AppCentral™ Deprecated

      AppCentral™ is no longer available from within SBM Composer.

    • Import as New

      You can now choose to import a process app based on a different process app. When you choose the new Import as New option in SBM Composer, the process app is given a new identity, with a few exceptions. You must rename the process app and its primary tables, auxiliary tables, and workflows before you can publish and deploy the process app to the same environment from which it originated.

      Creating a process app based on another process app. In this case, you intend to use the process app as a starting point and plan to change its identity. For example, you may want to rename an "IT Help Desk" process app to "Service Desk."

    • Improved Template Support

      You can now easily add templates to your local library so they are readily available when you create new process apps.

    • Process App and Template Versioning

      Blueprints (.msd files), templates (.mst files), and form extensions (.cfx files) are now versioned based on the SBM Composer version they were developed in and exported from.

      You cannot import a blueprint that was developed in a later version of SBM Composer than the one you are using. You can add form extensions from newer versions of SBM Composer, but not all features may be available.

  • Miscellaneous Changes
    • Groups and Multi-User Fields

      You can now choose to provide users, groups, and members of each group as values for Multi-User and Secondary Owner fields. If you select this option for Multi-User fields and you have HTML5 features enabled, users can click group names on State forms and see a list of group members and user profile cards for each member.

    • Validation check for Mobile App

      You can now edit an application and enable a validation check that determines if elements in your process are compatible with the SRC Mobile app.

    • The Global role option has been changed to Shared in order to avoid confusion with roles that are now available in the Global Process App.

Orchestration Changes

  • Data that RESTcaller sends and receives from a REST service is now logged in the Common Log in the context of the calling orchestration.
  • RESTCaller PUT and POST operations now support sendAsText and sendParamsAsFormData options. The sendAsText option is similar to the sendAsJSON; however, it enables you to send a text string in the body of the REST request. The sendParamsAsFormData enables you to construct and send URL query parameters in the body of a POST. If you have an existing RESTCaller instance, you must re-import the service to see these new options. For details, refer to the SBM Orchestration Guide.
  • The RESTCaller WSDL is now a known Web service for new orchestrations. This means you no longer need to import the RESTCaller WSDL in SBM Composer to begin using it in an orchestration. For existing orchestrations, the RESTService must be added manually.
  • Security Token authentication is set by default for RESTCaller endpoints after successful deployment.

Installation and Configuration Changes

Installation Changes

  • SBM is now certified against Internet Protocol version 4 (IPv4) and Internet Protocol version 6 (IPv6). This means you can now specify IPv6 addresses for SBM servers in SBM Configurator and in SBM Composer. Note that SBM requires that both IPv4 and IPv6 stacks are present on each server, though IPv4 can be disabled.
  • Active Diagnostics is longer installed with SBM Common Services; it is now installed with the new SBM Logging Services server component. This enables you to install and run Active Diagnostics on a dedicated server, instead of installing it with other SBM components. This should improve performance in SBM.

    If you are upgrading from an earlier version of SBM and you decide to move Active Diagnostics from the SBM Common Services to another server (by installing SBM Logging Services on another server), consider performing a Collect Logs action in SBM Configurator before you upgrade.

    After the upgrade is finished, verify that each server has the correct host and port for the SBM Logging Services server that hosts Active Diagnostics. You can start Active Diagnostics logging by starting SBM Logging Services on the Manage Services tab in SBM Configurator on the server that hosts the SBM Logging Services component.

    In addition, you must provide the new host name for the SBM Logging Services component in SBM Configurator on your distributed servers. You can do this manually and then click Apply on each server, or you can use the new Update from Database feature, and then click Apply on each server.

  • Default settings for Active Diagnostics have changed. For new installations, the default logging level for all contexts is now INFO, and the Log Activity and Collect CPU and Memory Counters options are now selected by default. The default log size for 32-bit installations is 500 MB and 3 GB for 64-bit installations.

    If you are upgrading from an earlier version and you previously used the default settings for Active Diagnostics, the logging level will change to INFO and the Log Activity and Collect CPU and Memory Counters options will be selected after the upgrade. The log size is not changed if a specific restriction was entered.

Smart Search Changes

  • The default Database polling interval for Smart Search is now 30 seconds. For upgrades from earlier SBM releases, the default is automatically set to 30 seconds if you used the 3 minute default prior to the upgrade. If you used a non-default value prior to the upgrade, that value is preserved after the SBM upgrade.
  • SBM Common Services now returns attachments in searches performed by users in Work Center. If your SBM item attachments are stored in the database, Work Center will access the database to return file attachments in search results, and no additional configuration is necessary. However, if your SBM item attachments are stored on the file system, your must provide the attachments directory and access information to SBM Common Services on the Smart Search tab in SBM Configurator.

SBM Configurator Improvements

  • You can now store your SBM configuration in a centralized location using the new Configuration Settings database. The option to use the new database appears in SBM Configurator immediately after the installer is finished.

    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. For example, you can now quickly and easily update security information for all servers without having to export and import certificates on each server in a specific order.

  • The System Information tab has been renamed to System Settings, and now includes the Configuration Settings sub-tab. You can select the Use Configuration Settings database option on this tab any time after the upgrade to store your entire system configuration in the new Configuration Settings database.
  • Static diagnostic tests have been added to verify server hardware, installed software, IIS recycling options, and SSL certificate validation.

Web Services Changes

  • You can use the extendedData element in the UserInfo argument to retrieve and update user attributes such as the Title, Mobile Phone, and Preferred Contact Method.
  • The size of a file attachment is now returned in the ExtendedData element in the fileAttachment response type.
  • A new GetWorkflows call has been added. This call returns a description of the graphical workflow diagram.
  • A new GetFieldSelections call has been added. This call returns the full list of available selections for single and multi-selection fields.
  • DatePreference, TimePreference, and AccessType elements in the UserInfo and GroupInfo arguments now default to "LEAVE-UNCHANGED". Previously, the first option was used for each element by default (DATE-FORMAT-FROM-LOCALE, TIME-FORMAT-12HOUR, and ACCESS-NONE).

Documentation Changes

  • Manuals are no longer installed with SBM and SBM Composer. You can find documentation for current and past releases on the Documentation Center or in the download area of http://www.serena.com/support.
  • 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. These features are available to SBM User Workspace users when HTML5 is disabled, however.
    • Spell Check icon next to Text fields on submit, update, and transition forms.

      Instead, users can use the native browser spell check feature to verify spelling in most text-entry fields in Serena Work Center and the SBM User Workspace. Note that Internet Explorer 9 (IE9) users may need to first download and enable a spell-check plug-in.

    • 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.

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.

These features include:
  • 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)
  • Elapsed Time 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
If you have problems using these features, you can:
  • 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.

Note: Administrators who use Internet Explorer 8 and who need to disable HTML5 features should log directly into SBM Application Administrator using this URL: http://serverName/tmtrack/tmtrack.dll?StdPage&Template=newwebadmin/index.html.

Upgrades

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

Refer to the Serena Documentation Center for a list of prior readmes that contain features and changes that were added in earlier versions.

Refer to the Supported Platform Matrix for a list of upgrades that are supported in this release. Upgrades are supported from specified major releases and minor releases on those base releases.

Tip: If you are using a version of SBM prior to 2009 R1, first upgrade to 2009 R4.0x, and then upgrade to 10.1.5.

Upgrading From Tracker

For 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

For information on upgrading TeamTrack 6.6.1.x to SBM, 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 the upgrade, you must mimic your installation on a separate set of hardware. This test installation should include all of the environments used by your system. You will upgrade and test this installation before upgrading your production installation. To upgrade successfully, SBM 10.1.5 must be installed on each server and client machine.

This release supports both major and minor upgrades:

Important Notes for Major and Minor Upgrades

The following notes apply to both major and minor upgrades:
  • SBM 10.1.5 requires Serena License Manager 2.2. You must upgrade to version 2.2 before you can upgrade to SBM 10.1.5. .
  • 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.
  • 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.
  • 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 as part of the upgrade process.
  • Beginning with 10.1.4, custom forms should display and perform as they did before the upgrade. 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.
  • 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.

  • 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.
  • 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 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
  • For Oracle systems, the required roles and privileges for the SBM schema user have changed. Please visit S133641 for details.
  • 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.
  • 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.
  • 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.

  • 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.
  • 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.5, 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.
    In general, it is recommended that you review your promotion profiles and adjust the settings accordingly.
  • If you installed 10.1, which had the Transition Group Restrictions and User Field Selections check boxes selected by default in promotion profiles, and then upgrade to 10.1.2, the check boxes could become unchecked.
  • Prior to 10.1.2, renaming an orchestration in SBM Composer and then redeploying the process app would leave the originally deployed orchestration event map in place while also deploying a new event map with the new name. The original event map was still associated with its events, so events associated with the orchestration would cause both the original event map to run the orchestration workflows and the new event map to run the orchestration workflows. This problem could reoccur on each new deployment. Generally, the behavior was that an orchestration workflow would appear to run twice or more simultaneously, where it was only expected to run once (although other unexpected behavior was also possible).

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

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

Minor Upgrades

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

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

Pre-upgrade Steps

Follow these steps before beginning the upgrade:

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

Server Installation

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

    Note the following important information:

    • As of SBM 10.1.5, Active Diagnostics is now installed with the SBM Logging Services component (instead of SBM Common Services). This enables you to install and run Active Diagnostics on a dedicated server if necessary (for example, if you set the logging level to TRACE for debugging purposes).
      • If you still want to run Active Diagnostics on the same server that hosted the service before the upgrade, select the SBM Logging Services check box during the install on the server that currently hosts SBM Common Services.
      • If you decide to move Active Diagnostics to a new server, clear the SBM Logging Services check box, and then install SBM Logging Services on the desired server. When you have finished installing SBM, you must update SBM Configurator on each server with the new host name and TCP port for the server that will host SBM Logging Services.
    • 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).
    • For multi-environment installations that include separate SBM Application Engine installations for test, staging, and production environments, install SBM Mail Services and SBM Logging Services at least once in each environment.
    • If you want to uninstall existing components or install new components other than SBM Mail Services or SBM Logging 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.
    After you have reviewed the components that are currently installed, click Upgrade Now to proceed. At the end of the installation process, click Configure to launch SBM Configurator.
  5. Decide if you will use the Configuration Settings database or not. 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.

    If you plan to host the Configuration Settings on the same server as the other databases, drag it to the existing server and verify that the connection information is correct.

  6. 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.

  7. 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.
  8. 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 significant 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.
  9. 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.
  10. 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 S140954 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.
  11. 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.
  12. In SBM Configurator, verify that the services are started in the Manage Services tab.
  13. Instruct SBM User Workspace and SBM Application Repository users to clear the cache in their Web browsers.

Client Installation

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

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

To upgrade SBM Composer:

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

Fixed Issues

A list of defects fixed in this version can be found in the Knowledge Base. You must have a Serena.com user account to view items in the Knowledge Base. Register for a free account if you do not have already have one.

Beginning in SBM 10.1, user accounts are managed in SBM Application Administrator rather than in SBM System Administrator. SBM Application Administrator, which requires a connection to the SBM Web server, is not available if the number of users in your system exceeds the number of installed seat licenses.

If you receive a seat license error in a version earlier than SBM 10.1.1.4, contact Customer Support for assistance is resolving the issue. If you have SBM 10.1.1.4 or later installed, the Users tab in the SBM System Administrator is enabled automatically if you encounter this problem. Open SBM System Administrator and delete or modify user accounts so that they are in compliance with their seat licenses. (If you encounter this problem and the SBM System Administrator is already open, you need to close it and reopen it for the Users tab to appear.) Once you resolve user accounts, the Users tab is not visible the next time you open the SBM System Administrator.

Known Issues

This section describes known issues and contains the following categories:

For a complete list of known issues and potential workarounds, refer to the Knowledge Base. You must have a 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

Form Issues

  • Change history records may only show partial changed data for fields. To view full changes, hover over the field, and then click the plus sign.
  • Single Relational fields that are added as filters for activity views are not available for sorting data in the view.

Administrator Issues

SBM Application Repository Issues

  • Settings that enable you to configure the Application Repository log size, backup options, and verbosity for specific modules are not available in the new Application Repository interface.
  • The feature that enables you to clear history before a certain date in both the Audit Log and Event Manager Log in Application Repository is not available in 10.1.5.
  • Managed administrators with Remote Administration and Global Administration privileges can delete environments in Application Repository even if the Create, Edit and Delete Environments for this Host privilege is not granted on the Deployment tab in Application Administrator.
  • 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.
    In general, it is recommended that you review your promotion profiles and adjust the settings accordingly.

Performance Issues

  • Starting with SBM 10.1.4, there is a noticeable performance impact on Open and Completed Trend, State Activity Trend, and Average Time to State Duration reports. This problem only occurs on systems using the Oracle for SBM driver and is particularly noticeable with reports that return large data sets. If you experience significant performance issues with these report types, contact Serena Customer Support.
  • Performance degradation may noticed when a large number of users simultaneously perform wildcard searches in Serena Work Center. During testing, this degradation was noticed when 200 users performed wildcard searches at the same time.

Installation and Configuration Issues

  • An error message 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.

Copyright © 2007–2015 Serena Software, Inc. All rights reserved.