Turn Off Tabs
Serena Business Manager 10.1 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 2012-06-27.

Contents

About this Release

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

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

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

Helpful Links

Serena Service Manager documentation

System Administrator Deprecation List

Supported Configurations

Supported Platform Matrix

Build Numbers

Terminology Changes

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

Old Term New Term

SBM Application Administrator

 SBM Application Repository
Web Administrator SBM Application Administrator
Manage Data Auxiliary Data (in SBM Application Administrator)
Notification Server (in the SBM installer) SBM Mail Services
Terminology changes in earlier releases:
  • For changes made in SBM 2009 R4, refer to the readme.
  • For terminology changes made since TeamTrack 6.6.1, refer to the Moving to Serena® Business Manager guide.

Supported Configurations

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

Server Operating Systems

Now supported:

  • Windows Server 2003 SP2 Standard Edition, 32-bit
  • Windows Server 2008 R2 Enterprise Edition SP1, 64-bit
  • Windows Server 2008 R2 Server Edition SP1, 64-bit

No longer supported:

  • Windows Server 2003 Enterprise Edition
  • Windows Server 2008 R2 Enterprise Edition, 64-bit
  • Windows Server 2008 R2 Server Edition, 64-bit

Client Operating Systems

No longer supported for SBM Composer.

  • Windows XP Professional Service Pack 2
  • Windows Vista

Database Management Systems

Now supported:

  • Microsoft SQL Server 2005 SP4
  • Microsoft SQL Server 2008 SP 1
  • Oracle 11.2.0.x
  • Oracle 11.2.0.x RAC
No longer supported:
  • Microsoft SQL Server 2008

Oracle Database Client Connectors

Oracle ODBC connections that use the Oracle driver are no longer supported.

For Oracle systems, you must connect to the SBM Application Engine database using either the Mashup2009 DSN that is installed with SBM or a system DSN that uses the "Oracle for SBM" driver that is installed with SBM. The "Oracle for SBM" driver is now the only supported Oracle driver for SBM Application Engine database connections.

Web Browsers

Now supported:
  • Firefox 5.0 and later
  • Google Chrome 12 and later
  • Internet Explorer 9.0
No longer supported:
  • Microsoft Internet Explorer 6

Web Services

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

Build Numbers

The following component build numbers apply to this version:

  • SBM User Workspace: Build 435
  • SBM Composer : Build 286
  • SBM System Administrator and SBM Application Administrator: Build 435
  • Application Repository: Build 458
  • SBM Configurator: 10.01.00.439
  • Database version: 1000001611
Note: The Japanese documentation is versioned as 2009 R4.01 and the translated content applies to version 2009 R4.01.

Third-Party Tools

For third-party software information, refer to:

Third Party Copyrights

Third Party Client Licenses

Third Party Suite Licenses

What's New

The following features have been added for on-premise systems.

Web-based Administration

Most application configuration and administrative tasks have been moved from the SBM System Administrator to a Web interface. Users with appropriate privileges can open the new SBM Application Administrator by clicking the Administrator icon in the SBM User Workspace:

image

The SBM Application Administrator opens to the Administrator portal, which offers quick and easy access to commonly used features.

To use SBM Application Administrator, administrators need:

  • Adobe Flash Player

    If the Flash Player is not installed or enabled for your browser, you are prompted to install or enable it when you open SBM Application Administrator.

  • Remote Administration Privilege

    SBM Application Administrator does not use an ODBC connection, so administrators must be granted the Remote Administration privilege.

  • Managed Administration Privileges

    Users with Managed Administrator product access should be granted privileges to the features they manage, such as projects and groups. For details, refer to the "Managing Administrators" chapter of the SBM Application Administrator Guide.

The following features have been moved to SBM Application Administrator:

  • Projects
  • Selection management for user-type fields for primary items
  • Transition restrictions by group
  • Transition overrides
  • State overrides
  • Notifications
  • Users
  • Groups
  • Role assignments
  • Record locks (release only)
  • Business Calendars
  • Mailbox creation for e-mail submission
  • E-mail template editing (notifications and e-mail submission)
  • Manage data (now referred to as Auxiliary Data)
Along with the Web-based administration, many improvements have been made, including:
  • Improved Performance and Usability
    • The Administrator portal offers easy access to commonly used features, such as projects, users, and notifications.
    • From the Administrator portal, use a single control to search for projects, users, and groups. Select an item from the results list, and you are presented with options applicable to that item, such as editing a selected user.
    • Pagination and search features throughout the interface allow for greatly improved performance when you are working with projects, large sets of users, and more.
    • SBM Application Administrator uses optimistic locking. If multiple administrators make changes to features at the same time, the second administrator to save changes is given the option to overwrite the first administrator's changes, delete his or her own changes and get the changes made by the first administrator, or cancel the update.
  • Project Management
    • The project hierarchy is now represented as a list that you can expand and collapse to navigate, move, and reorder projects. This change will greatly improve administrative performance in systems with a large number of projects.
    • You can sort the default, transition, and state field lists in projects by field name, type, and various properties, such as required, read only, and mass update.
    • The following features are now implemented in for SBM Application Administrator for projects rather than workflows:
      • Adding, editing, and deleting user and group selections for User, Multi-User, and Multi-Group fields
      • Setting default values for User, Multi-User, and Multi-Group fields
      • Transition restrictions for groups

      Default values for user-type fields apply to a specific project. Transition restrictions for groups and selection management for user-type fields apply to all projects assigned to a workflow.

    • Application variables can now be overridden for projects. This enables you to override values specified for rules in SBM Composer. Rules and application variables are used together for dynamically routing items and restricting transitions.
    • Decisions are now visually differentiated from states.
  • User Management
    • You can now import new users and update existing user accounts from a spreadsheet. Spreadsheets can come from external tools, such as an Active Directory store or other Lightweight Directory Access Protocol (LDAP) providers, or you can manually create a spreadsheet.
    • You can now compare and modify settings for multiple user and group accounts. This includes user preferences, and notifications subscriptions and privileges for users and groups.
    • To improve performance in systems with a large number of users and groups, pagination has been added to the default value list for User, Multi-User, and Multi-Group fields. You can also search for valid users and groups to set as default values for these field types.
    • When assigning group membership to users, you can now search for users to add to the group or groups to assign to users. You can also sort user and group lists to show assignment status.
  • Notifications
    • You can now delay notifications based on the value of a Date/Time field. For example, when you send items to a "Review" state and specify a deadline of two weeks to complete the review, you can send a notification after one week to remind reviewers of their pending deadline.
    • Notifications can now be generated for rule conditions based on empty field values. The new comparisons "Changes From (None)," "Changes to (None)," "Is (None)," and "Is Not (None)" apply to most field types and can be used to generate notifications when values are added to empty fields or removed from a field.
    • You can now apply business calendars to repeat notifications and to the new delayed notifications.
    • Escalation settings have been merged with general notification settings. The process for creating escalations has not changed, however. For guidance, refer to the SBM Application Administrator Guide.
    • You can now search for notifications and rules. In addition, you can filter the list of rules to those not referenced in notifications, and you can filter the list of notifications to those that do not have subscribers.
    • You can now see which notifications and escalations are using specific rules. This information is available in the Related Notifications area when you select a rule in the SBM Application Administrator. You can also double-click the related notification to edit it.
    • You can now delete multiple notifications at one time.
    • You can now map internal parameters to Web service inputs for notifications that call Web services. Choices are Login ID, Unique ID (Table ID:Item ID), Item ID, Table ID, or User ID.
  • E-mail Templates

    Use a new WYSIWYG editor in SBM Application Administrator to create and modify templates used for e-mail notifications and e-mail submission confirmations and error messages. This enables you to add and modify e-mail templates without an ODBC connection to the database server. In addition, you can choose available template tags and fields from a drop-down list.

  • E-mail Template Tags

    The following tags have been added for notification templates:

    • $ATTACHMENT()

      Adds all files attached to an item to the e-mail notification as long as the total size of all files does not exceed the size specifed in the SBM Configurator.

    • $CHANGEACTION()

      Returns the action and user that caused the notification to be generated, along with the date and time the action occurred.

    • $CHANGES()

      Returns the change history for the item based on the action that caused the notification to be generated.

    • $MAILHEADERPARAM()

      Use to add custom information to the e-mail header. For example, you can return sender information in the header.

    • $NOTES()

      Includes notes added to an item by users or by e-mail messages. Individual notes that exceed the character limit specified in SBM Configurator are added to the item as attachments.

    • $TRIGGEREDDATETIME()

      Returns the date and time the notification rule became "true" for an item. Date and time are formatted for the locale set in each user's profile.

    The $SENTBY() e-mail template tag is now editable using the Sender that appears in e-mail subject or body field in SBM Configurator. The default value is "SBM Notification Service," which you can now change to indicate a different sender in the subject and body of e-mail messages.

  • Data Import

    You can use the Import Data feature in SBM Application Administrator to quickly import primary and auxiliary items from a spreadsheet. You can also update existing items using this feature.

    The Import Data feature is still available in SBM System Administrator for direct database imports, however.

For a more detailed overview of administrative changes, refer to SBM Application Administrator Reference.

Enhanced Notification Server and Mail Client

The Notification Server and Mail Client are now powered by Serena Common JBoss and installed as a separate component from the SBM Application Engine. Because the Notification Server and Mail Client now run under JBoss, the server settings have been removed from SBM System Administrator tool and added to the SBM Configurator.

The location of the Notification Server and Mail Client logs has changed. The logs have been combined into a single file, which is now located here: installationDirectory\Serena\SBM\Common\jboss405\server\default\work\jboss.web\localhost\notificationsrv\log\ns.log. You can also use the Collect Log Files feature in SBM Configurator to capture the latest version of the log.

New tables have been added to the database to store information about Notification Server and Mail Client instances and settings. As part of the Notification Server redesign and enhancement, the schema of the Notification Server events and messages tables have been modified as well. If you have developed any custom scripts or APIs that interact with these tables, Serena recommends that you review the Database Schema Reference and adjust your scripts and APIs accordingly. You can also contact Professional Services for assistance with upgrading your customizations.

The following list describes the enhancements that have been made to the Notification Server and Mail Client:

  • The Notification Server is now a multi-threaded application. This enables greater processing capability and load handling of change history records in the SBM database. In SBM 10.1, if the Notification Server cycle time is exceeded, then it will immediately begin the next cycle using a new thread (instead of waiting for the duration of the cycle time to elapse). In other words, if the cycle time is set to 1 minute, then it will begin processing the next batch of change history records after 1 minute has elapsed, even if the last cycle is not yet finished. If the cycle finishes in 30 seconds, then the next cycle will still start 30 seconds later.
  • You can now choose to install the Notification Server and Mail Client on one or more servers. This provides additional failover and increased performance because the processing load is distributed across multiple servers. The Notification Server and Mail Client are sub-components of the SBM Mail Services installer component. For details on upgrading your current installation, see Server Installation.
  • The SBM Configurator now enables you to configure performance handling for the Notification Server and Mail Client. For details, see the SBM Installation and Configuration Guide.
  • Attachments added to a primary item that create a notification are now sent with the e-mail message if the $ATTACHMENTS() tag has been added to the e-mail template in use. This means that users do not have to log in to the User Workspace to view the item's attachments. The Maximum attachment size setting limits the size of the attachments that are included with the message that is sent. You can also specify a size limit for inline notes that are sent with the notification. This setting is located on the Notification Server tab of the Mail Services page in SBM Configurator.
  • In SBM Configurator, you can now designate a list of administrator e-mail addresses that should be e-mailed when problems occur with sending messages to users. You can configure the time period that should lapse for checking for errors, as well as the number of errors that must occur before an e-mail is sent.
  • E-mail messages that are added to items now contain a Message Address Details section. The Message Address Details section contains the To and CC contents of the e-mail message that was processed. Replies that are added through E-mail Recorder also display these details in the notes that are created.
  • E-mail Recorder messages now only display the reply portion of an e-mail reply by default. If you want to view the previous e-mail text, you can toggle the view using show and hide options. This improves the overall readability of E-mail Recorder messages on items.
  • SBM Configurator now enables the Mail Client to attach "text/html" formatted e-mails as PDF attachments to SBM items using the Attach HTML e-mail as PDF option. This option is useful if you receive incoming e-mails with HTML and embedded images because it preserves the text and image sequence in the original e-mail.

Security Token Usage Regardless of Log in Method

Security tokens are now automatically requested by and granted to SBM applications in order to secure internal Web service communications. This change increases the overall security of your SBM installation and separates your log-in authentication method from the underlying security method of using secure tokens to pass user identities between SBM applications that was previously only available by enabling SSO.

In SBM 10.1, all internal communication is secured by a security token whether SSO is enabled or not. This means that you can choose any SBM authentication method and still take advantage of increased security for authentication between components and seamless identity flow without enabling SSO. However, SSO enablement is still required for seamless login between components and other features such as Smart Card authentication.

Additionally, all internal endpoints are now secured by a security token by default. This differs from previous releases in which you had to select SSO as the endpoint authentication method in SBM Composer and Application Repository. You can override the security token authentication if necessary; however, SBM automatically detects all internal service communication and assigns Security Token authentication for you by default.

This also impacts how you use orchestrations. For example, this means you can now remove the auth section from the SBM Application Engine Web service in an orchestration workflow. If you remove the auth, make sure that the user who runs the orchestration has sufficient item privileges in SBM. For SBM Application Engine Web services, the SBM Application Engine auth still overrides the security token auth if you provide credentials in the auth element. For additional information about how this change impacts orchestrations and external events, see Important Notes for Major and Minor Upgrades.

Logical Names for Projects, States, and Transitions

Projects, states, and transitions now have unique internal names that you can use to reference these elements in Web service, AppScript, or API calls.

For projects, internal names are automatically assigned and cannot be modified. For states and transitions, internal names are derived from the internal name of their defining workflows. You can modify these internal names in SBM Composer before an application is deployed for the first time.

Dynamic Forms

Custom form designers can now enable dynamic behavior that changes values and options available to users based on their interaction with the system. For example, if a user selects a certain value in one field, a related field is either added to or removed from the form.

In previous versions of SBM, JavaScript programming was required to create dynamic forms. Now, an intuitive dialog allows designers to define events, conditions, and actions; for example, "when the form is submitted, if the Server field is empty, hide the Server Version field."

Process App Compare and Merge

You can now visually compare two versions of a process app and manually merge items from one version into the other.

This is particularly useful for comparing and merging versions of applications in Serena-provided solutions, such as Serena Service Manager. This feature is also useful in situations where multiple designers are updating an application.

A Comparison Report that summarizes the changes is included.

Modify REST Service URLs before Promotion or Deployment

You can now modify the server portion of a REST service URL in SBM Composer before you deploy a process app and in SBM Application Administrator before you deploy or promote a process app. (Previously, REST service URLs were not listed as endpoints.)

The enables you to provide test data during the design phase and replace that test data with production server information at a later time.

Cross-application Orchestration Workflows

You can now call an asynchronous orchestration workflow from any application. The orchestration workflow can be defined as an interface to a particular application or to an external system. This is achieved by importing an orchestration event structure into an application as an orchestration link. (Previously, orchestration workflows were tied to the defining application by the data that was passed into the event that triggered them.)

Oracle for SBM DSN Changes and Support for Oracle Real Application Clusters (RAC)

The underlying functionality for the Oracle for SBM driver has changed. In 10.1, The Oracle for SBM DSN that is packaged with SBM no longer requires the Oracle client because the Oracle service name is now used. This means that you no longer need to install the Oracle client in order to connect to the Oracle server. Instead, you need only provide the host, port, and Oracle service name in SBM Configurator. For details, see the "Configuring Database Servers" section in the SBM Installation and Configuration Guide.

Using the Oracle service name enables support for clustering and high availability via Oracle Real Application Clusters (RAC). Consult your DBA for assistance with configuring Oracle RAC in your Oracle DBMS.

Important: The underlying driver used in the "Oracle for SBM" DSN that ships with SBM has changed in SBM 10.1. If you currently use the Mashup2009 DSN with SBM, you do not need to do anything. If you created your own custom DSN with the "Oracle for SBM" driver prior to upgrading to SBM 10.1, you must recreate the DSN and use the new "Oracle for SBM" driver that ships with SBM 10.1.

Avatars, Working Groups, and Experts

The SBM User Workspace has been enhanced to create a better user experience by allowing users to choose avatars, display working groups, and suggesting experts.
  • Users add avatars to the User Profile in the SBM User Workspace. The avatars appear in multiple places such as alongside notes, journal entries, and updates. The avatars are uploaded on the General Preferences tab of the user profile.
    Note: Notes and journal entries that were added by user before upgrading to this version of SBM will not contain the avatar that they choose. The avatar will only appear on new entries for items.
  • The Social Widget can be added to custom forms. This widget displays data in an easy to read format for all users who have interacted with this item. The user's avatar displays along with the contact information for the user. By expanding the user's entry, you can see additional details for the user such as the number of item updates, associated emails, and transitions performed.
  • The Social Widget contains the suggest expert functionality, which provides the user with a ranked list of other users who have worked on similar items.
Note: To disable avatars in your system, contact Serena Customer Support and reference S138461.

SBM Orchestration Engine Enhancements

The following stability and performance enhancements have been made to SBM Orchestration Engine.

  • Prior to 10.1, the event log did not create entries unless Application Repository was installed on the same server as the Event Manager. Event Logging is now local to each Event Manager installation. This means that Event Log messages are now logged even if the Event Manager is not installed on the Application Repository server, which ensures that Event logging for separate environments is now possible. However, the logging capability is still limited because Application Repository and Event Manager must be installed on the same JBoss server in order to actually see messages. If Event Manager is installed separately from Application Repository, an error appears when you try to view the Event Log.
  • The Event Manager Log in Application Repository now returns status messages for orchestrations. In the Event Summary dialog box, you can now view start, finish, success, and failure messages for orchestrations. You can now use the Event Summary to determine if an asynchronous orchestration workflow has started or finished and whether it succeeded or failed.
  • The logging level all has been replaced by user in the Common Log Settings dialog in Application Repository. The user level reduces the amount of data that is written to the database and does not impact performance as much as the all logging level, because only user-level messages are logged when this option is selected. For most practical purposes where diagnostic logging is required, the user level is the recommended level. Other levels between error and user should be used with caution since they can result in excessive log records that are not generally useful.
    Important: Production systems should normally be set to warn, but the user level can be set temporarily for diagnostic purposes. Other levels should be avoided in production.
    Additionally, SBM Composer has been modified to select the user logging level for its debug logging feature, making it more practical to use for production diagnostics.

Additional Changes

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

Installation and Configuration Changes

System Diagnostics in SBM Configurator

SBM Configurator now enables you to run diagnostic tests against your SBM installation. You can use these tests to help you troubleshoot problems with your SBM installation any time after you have completed wizard mode. The Diagnostic Tests tab enables you to run certain diagnostic tests from a list of predefined categories and view the exact area that is not configured properly, not accessible, or not functioning as intended. These tests can be used by Serena Customer Support to quickly and accurately solve problems in your SBM installation. Serena recommends that you run the diagnostics tests if you are not able to access certain components or features in SBM.

SSO Password Encryption

The SBM Configurator now enables you to manage encryption settings for SSO configuration file passwords throughout your installation. To encrypt SSO configuration file passwords for components such as the ALFSSOgatekeeper, ALFSSOLogin, and TokenService, use the encryption options on the General tab in the SBM Configurator's Security settings.

Exchange E-mail Server Type

The new Java Notification Server does not support the MAPI standard. For upgrading customers formerly using MAPI with the Notification Server, you can now connect to your Microsoft Exchange server using the Exchange e-mail server type in SBM Configurator. The Exchange option enables SBM to communicate with your Microsoft Exchange server using the MS Exchange Web services API.

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

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

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

Beyond Firewall Configuration Settings

SBM Configurator now enables you to designate hostname and port values for a server that is accessible outside your company firewall. This eases administration duties because you no longer need to manually set an external hostname and port values in various configuration files throughout your installation. For example, if a server is known as server.domain.com to your external users, but has a different name internally, you can designate the external hostname in SBM Configurator so that your users access the log in page using the public address, while still allowing Web service calls to use the internal name to avoid being routed via a firewall or load balancer.

HTTP and HTTPS Enforcement

SBM Configurator now exposes options to enforce HTTP or HTTPS protocol usage throughout your installation. For example, if you select the HTTPS option in the Component Servers dialog box of SBM Configurator, all SBM Configurator components on the server will be accessible only using HTTPS. If you select both HTTP and HTTPS, this preserves the current HTTP or HTTPS configuration of all the URLs in your installation and no changes are made to their current configuration (unless you have configured specific external ports after selecting Beyond Firewall). Select both check boxes if you have previously manually configured some URLs to use HTTP and some URLs to use HTTPS. By default, both options are selected if you are installing and configuring SBM for the first time.

Configuring SSL for SSO

You can now generate a new SSO signing key that is used to sign the STS security token. By generating a new key pair, you improve the overall security of your SBM installation. In a single server environment, you can generate a new key pair in the Security tab of SBM Configurator. For distributed installations, use SBM Configurator to generate the key pair on the server that hosts SSO and then export a configuration snapshot and import it into SBM Configurator on each of your distributed servers. For more information, see the SBM Installation and Configuration Guide.

SBM Mail Services Installer Component

The suite installer now contains the SBM Mail Services component. This component installs both the Notification Server and Mail Client. You can configure these components after installation using the SBM Configurator.

SBM System Administrator Removed from Client Installer

The client installer no longer installs or upgrades the SBM System Administrator component. If SBM System Administrator is currently installed on your machine, the installer will remove SBM System Administrator and install only SBM Composer. To perform the administrative duties that you previously performed using SBM System Administrator, log in to the SBM User Workspace and launch SBM Application Administrator. For details on the SBM Application Administrator, refer to Web-based Administration.

SBM User Workspace Changes

Miscellaneous Changes

The following enhancements and changes appear in the User Workspace. These include:
  • Error codes have been removed from error messages, and the error messages have been enhanced to be more user-friendly. For example: 
    One or more fields are invalid.
'Title' is a required field. Please supply a valid value to complete this transition.
    SBM error codes can still be accessed by viewing the html source of the page. The error codes will appear as a comment alongside the error messages. You can search for the word “ErrorMsg” to find them: 
    <div id="ErrorMsg" class='dberr'>One or more fields are invalid.<BR>
'Title' is a required field. Please supply a valid value to complete 
this transition.<!--TTwrnIDS_F1_MSG_FIELDS_FIELDREQUIRESVALUE--><BR></div>
  • Under the user's profile, the user can add or change an avatar on the General Preferences tab.
  • Attachments, notes, journal fields, and change history have been reformatted. Attachments and change history now appear in a more user-friendly format. They include new icons for attachment types. Notes have also been reformatted in a more attractive layout. In addition, both attachments and notes now include the user avatar of the user adding the attachment or note.
  • Separate popups are opened when you are adding attachments, notes, emails, and links to items. If you attempt to add a second attachment or note to an item when an existing dialog is open, then you will be alerted that an existing dialog is already opened and that dialog will be moved into focus.
  • The workflow image autosizes to the width or height of the browser window when displayed from an item. You can enlarge the workflow to the original size of the workflow image by clicking the icon in the upper right corner.
  • When sending emails from an item, you can now include recipients as carbon copies (CC) and blind carbon copies (BCC).
  • When you select a navigation icon while the navigation pane is collapsed, the navigation pane's hidden contents will be updated based on your selection. You will see the contents when you expand the navigation pane.
  • The Manage Data link now opens to the new Auxiliary Data feature in SBM Application Administrator.
  • The User Profile link has been moved to the SBM User Workspace toolbar instead of the application and tabs toolbar.
  • Significant performance improvements have been made to custom trend reports in the SBM User Workspace. The overall execution time and memory consumption for these reports have been improved.

Reporting and Deleted Users

A new Deleted Users option has been added to the search filter in Distribution, Duration, Listing, and Trend reports. This option enables you to find deleted users in user fields that you add to the report. For example, to see a list of issues that were submitted by deleted user Joe, perform the following steps:
  1. Create a new Listing report.
  2. In the Search Filter, select the Submitter field and enter Joe in the Find Values field.
  3. Select the Deleted Users check box and click Find.
  4. When the deleted user account for Joe appears, add his name to the saved selection list.
  5. Find and add any other users you want to search for (deleted or otherwise by toggling the Deleted Users check box).
  6. Click OK to save the current search filter.

Editable Grid Improvements

The following enhancements were made to the Editable Grid. These include:
  • The option to Show Field Legend for editable grid reports has been removed. The description for the editable grid icon's can be found in the online help.
  • The editable grid has been enhanced to use the native Flex focus helper. The Show Focus Helper has now replaced the Show Keyboard Helpers option under the User Profile.
  • Both the memo fields and the attachment column now allow scrolling within a cell in the editable grid. The cells have a maximum height of 100 pixels.
  • Editable grid now displays a warning if your report has more than 10 columns. Reports larger than 10 columns can cause performance degradation and are not recommended.

SBM Composer Changes

Application Design

  • Normally, all transitions on the Any system state appear on all state forms. You can now exclude such transitions from particular state forms. For example, there could be a Delay transition on the Any state. It would make sense for this transition to appear on all state forms except the Delayed and Closed states.
  • There is a new check box at the top of the Restrict by Role tab of the transition Property Editor. If this check box is selected, you can specify which roles should be restricted from executing the transition; any new roles will be restricted by default. If this check box is cleared, all roles, including new roles, will not be restricted.
  • The default for application icons is now "no image," not a red icon. If you want an icon to appear on the application tab in the SBM User Workspace, you can select one from a list or browse to one of your own. The list includes the red icon that used to be the default.
  • The source state for a transition is now displayed for transitions in the design element list in workflow, transition, and state Property Editors. This makes it easier to find a transition in a long list, and distinguishes transitions with identical or similar names.
  • You can now add a new SBM AppScript directly from the Action Wizard when you are creating or editing an action with the AppScript action type. Previously, you had to close the wizard, create the AppScript from App Explorer, and then start over again in the wizard.
  • Disabled transitions and deleted states are displayed in gray at the bottom of the design element list in the application workflow Property Editor.

Fields and Data Control

  • You can now specify up to 2,000 characters as a default value for Text/Memo fields.
  • There is a new Move to Section context menu item in the table editor that you can use to move a field to a different privilege section in the SBM User Workspace.
  • You can now edit field settings directly from the application variable editor.
  • When you map a Multi-Relational field to a Web service input, internal values can now be sent. (For backward compatibility, Web service outputs will continue to use the display value.)

Custom Forms

  • You can now create a custom form based on a table that is not in the current application. It can be a primary or auxiliary table in another application in the current process app, or in a table in a referenced application (except for system auxiliary tables in the Global Application). This is useful if you want to create a "forms" process app that only contains external forms related to a table in an existing application. The forms process app can be deployed without redeploying the process app that defines the workflow.
  • Visual cues are now displayed when there are empty autosized columns and rows on a form. The columns and rows have a red hatch pattern on them, and are displayed in red on the Columns and Rows tabs of the form Property Editor. In addition, a warning about empty columns or rows is generated when you validate the process app.
  • The Amazon Search widget is no longer supported and has been removed from the Form Palette. The Flickr widget and YouTube widgets are no longer supported.
  • A Social Widget detail control is now available in the Form Palette for state forms. In the SBM User Workspace, this widget contains the users ("experts") who have worked with an item.
  • An SLA Widget detail control is now available in the Form Palette for state forms. In the SBM User Workspace, this widget contains Service Level Agreement details. This widget is intended to support a feature of Serena Service Manager and is not applicable to general SBM use.
  • A new option on the JavaScripts tab of the form Property Editor loads the jQuery library plugin. This plugin is required if an SLA widget or a Social widget is added to the form, and can optionally be used for enhanced functionality and easier JavaScript programming.

Roles and Privileges

  • All privileges for auxiliary tables are now granted to the Administrator role by default.
  • When the incoming transition to a decision is the default Submit transition, the transition privileges that apply to that transition now also apply to all outgoing transitions from the decision. This allows the workflow to proceed to the target state even when the submitter has limited transition privileges.

Deployment and Repository Actions

  • By default, a deployment from SBM Composer times out after two minutes. You can now increase the timeout time to up to 99 minutes from the Repository tab of the Composer Options dialog box.
  • The timestamp in the Updated on column in the Open Process App dialog box now reflects the last check-in of the process app as a whole. Previously it reflected the last check-in of a design element.
  • The new Use Internal URL option on the Repository tab of the Composer Options dialog box ensures that SBM Composer can connect to the repository when it is being used on the same side of a firewall as the repository.

Usability Improvements

  • For workflows and forms, a Filter list appears at the top right of the Property Editor that lets you limit the items in the design element list according to component type. For example, if you need to find a particular state in a large workflow, you could select States from the filter, and only states appear in the design elements list.
  • You can now collapse the Ribbon to increase the amount of viewable space in the main Composer window.
  • If you press the Ctrl key while you select a component in the design element list in the Property Editor for an application workflow, form, or orchestration workflow, the respective editor will not scroll to the selected component. If you do not press the Ctrl key, then the editor will scroll if the workflow or form is larger than the displayed editor space.

Error Handling and Logging

  • Informational messages and exception details for non-fatal messages are now filtered out of the SBM Composer log file, by default. They can be included by selecting check boxes on the Resources tab of the Composer Options dialog box.
  • In the Message Filter dialog box accessed from the Log Viewer, only user messages are displayed. There is no longer an option to display technical messages.
  • You can clear a check box on the Workflow Options tab in SBM Composer Options if you do not want warnings about sub-workflows to be displayed when you change a parent workflow.

Administrator Changes

Create Associated Contact with Auto Add from LDAP

The Create Associated Contacts setting is now honored when you enable the Automatically Add New User Upon Successful Login option and use seat licenses. The designated mappings on the User Map tab are used for the newly created contact record.

Administrative Access

The following features have been added to support administrative access to the system:
  • The Create Database Wizard now requires you to specify a primary system administrator. The account created by the wizard is granted Regular User product access and the Remote Administration privilege. You can then log into the new SBM Application Administrator as this administrator and grant additional privileges to this account and create additional administrators as needed.
  • A Reset Administrative User Access wizard has been added to SBM System Administrator. Use this wizard to reset passwords for administrators, grant administrative access to users with External User, Occasional User, API/Script, or no product access, and grant the administrative privileges to users for whom they were mistakenly removed.

E-mail Template Storage

E-mail templates are now stored in the database and should only be modified through an interface, as follows:
  • Notifications and E-mail Submission

    Use SBM Application Administrator to modify templates.

  • SBM User Workspace

    Use SBM Configurator to modify the template used by e-mail messages sent from users in the SBM User Workspace.

  • Self-Registration Confirmations

    Use SBM System Administrator to modify self-registration success and failure messages and password change request messages.

Domain Specification Moved to SBM System Administrator

With the change to use security tokens for all communication with SBM components regardless of authentication method, IIS can no longer perform all the required authentication checks for systems that use NT Challenge Response. This means that you must now specify the domain for Web service calls in the Default domain for web services field in SBM System Administrator, otherwise the domain that the IIS server machine is installed on is used for user validation. For upgrading customers, see Important Notes for Major and Minor Upgrades for further information.

New "Common Services" Target Server

There is a new Common Services target server type in the New Target Server dialog box in SBM Application Repository. This target server is required for features such as Serena Service Manager (SSM) and Service Level Agreements (SLAs). The target server is added automatically, but can be overridden if necessary to fit a specific environment.

Orchestration Changes

  • Multi-Group, Multi-Relational, Multi-Selection, and Multi-User fields are now sent in asynchronous and synchronous orchestration events. The values in these fields can now include commas, because each value is stored in a separate array element, not in a comma-separated value string.
  • A new Group step in the orchestration workflow palette can be used to group steps logically. The existing Scope step should only be used to create a structure for handling faults that occur during Web service execution.
  • You can now use standard escape sequences when you specify default values for string type data elements in orchestration workflows and Service steps. The following escape sequences are available: \n (to create a new line), \r (to enter a carriage return), \t (to insert a tab), and \\ (to type a literal backslash). (When you open a process app from a previous release, any single backslashes are displayed as double backslashes.)

Web Services Changes

  • States, transitions, and projects now have unique internal names that make it possible to unambiguously refer to them in a Web service, AppScript, or API call. (This enables you to change the display name of the state or transition and not interfere with any of these references). The internal state and transition names are derived from the internal name of their defining workflows. The internal project names are created upon upgrade to SBM 10.1. The StateIdentifier, TransitionIdentifier, and ProjectIdentifier have each been updated with a new InternalName element to reflect this change. The CreateProject call automatically creates a new InternalName value upon successful creation of the project.

Miscellaneous Changes

Full-Text Searching Improvements for Oracle

Full-text keyword searching is no longer limited to just whole words for Oracle systems. It is now possible to search text fields for the prefix of a word once you select Enable Full-Text Searching on Keyword Searches and add the required indexes to your database (as described in solution S137570). Whole words and words that begin with matches are now returned. For example, a search for "deploy" now returns results with words such as "deployment" and "deploying."

Documentation Changes

  • The readme and release notes have been combined into a single document titled Serena Business Manager Readme.
  • The set of Oracle privileges required for creating SBM database schemas has been moved to the Knowledgebase at serena.com. Search for S133641.
  • The new SBM Orchestration Guide provides information about using SBM Composer to create orchestrations that use Web services to coordinate the interaction between an SBM application and one or more external systems. Advanced information, such as how to raise events through e-mail messages and JMS queues, is also provided. This information was previously part of the SBM Composer Guide and continues to be included in the SBM Composer online help.
  • The new SBM JavaScript Library Guide provides information about using the functions in the SBM JavaScript library to create dynamic custom forms. This information was previously part of the SBM Composer Guide and continues to be included in the SBM Composer online help.
  • The new "Orchestration Best Practices" section in the SBM Orchestration Guide and SBM Composer online help provides standards that help you successfully build orchestration workflows that are easy to maintain and scale. It includes guidelines for interaction with application workflows, naming, usage, event handling, and scalability.
  • The AddDelayCallback method was removed from the SBM JavaScript Library Guide, because it was determined that this method is only used internally.

Deprecated and Removed Features

  • In SBM Application Administrator, the interface used to set preferences on behalf of users is now organized by preference type, such as display or content. In addition, the following preferences can now only be set by users in the SBM User Workspace:
    • Quick form field sections (User, Manager, Advanced and System field section)
    • Subtasks
    • Attachments
    • Hidden fields
    The following preferences are available in SBM Application Administrator, but will be removed in a later release:
    • Auto Spell Check
    • State History Top View and Bottom View options
    • Single Frame View
  • The SBM Application Administrator does not provide a way to view individual workflow properties defined in SBM Composer. You can, however, view an image of the workflow by clicking the Show Workflow button on the project pages in SBM Application Administrator.
  • You can no longer view actions and scripts assigned to states and transitions when you are configuring applications. These elements can only be viewed in SBM Composer.
  • The Associate With Enabler option has been deprecated for group accounts.
  • The View Folders system privilege has been deprecated. Privileges to view and update items in folders are now controlled by privileges on the Folders privilege tab.
  • The Established By flag that indicated whether users were added to a group through an LDAP import, update, or auto-add is no longer available.
  • Due to the migration of the Notification Server and Mail Client migration from SBM System Administrator to SBM Configurator, the following administrative privileges have been deprecated: Stop/Start Mail Client, Edit Mail Client Properties, Start/Stop Notification Server, and Edit Notification Server Properties.
  • Because SBM Application Administrator now uses optimistic locking, the Clear My Admin Locks button has been removed.
  • The Amazon Search Widget has been deprecated. To create a similar query using the same information from Amazon, use the REST Grid Widget instead. By using the REST Grid Widget, if a service changes in the future, you can use SBM Composer to reimport the structure of the call, remap the elements, and then redeploy your process app.
  • New quick links cannot be created for auxiliary items opened from Manage Data.
  • The Attributes tab that was enabled with certain legacy integrations is no longer available for transitions. This tab listed scripts applied to a transition to enable it to perform an action in an applicable external product that is integrated with SBM.

Upgrades

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

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

Upgrades from the following products and versions are supported in this release. Upgrades are supported from specified major releases and minor releases on those base releases.
Tip: If you are using a version of SBM prior to 2009 R1, first upgrade to one of the versions of SBM listed below, and then upgrade to 10.1.
  • TeamTrack 6.6.1.x
  • Serena Business Mashups 2009 R1.0x
  • Serena Business Mashups 2009 R2.0x
  • Serena Business Mashups 2009 R3.0x
  • Serena Business Manager 2009 R4.0x

New Installations of Serena Business Manager

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

Upgrading From Tracker

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

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

Upgrading From TeamTrack 6.6.1.x

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

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

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

Upgrading From Earlier Versions of SBM

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

SBM 10.1 supports both major and minor upgrades:

Important Notes for Major and Minor Upgrades

The following notes apply to both major and minor upgrades:
  • For Oracle systems, the required roles and privileges for the SBM schema user have changed. Please visit S133641 for details.
  • You must ensure that all of the SBM components are installed on one or more servers prior to upgrading. This includes SSO and SBM Common Services. You can choose to enable or disable SSO once it is installed; however you still must install the SSO component for SBM to function properly.
  • You must disable the User Access Control (UAC) setting before you install SBM on Windows 2008 or 2008 R2. To disable this setting, perform the following steps:
    1. From the Windows Start menu, open the Control Panel and select User Accounts.
    2. Turn off UAC:
      • On Windows 2008, open the User Accounts window, click Turn User Account Control on or off and clear the Use User Account Control (UAC) to help protect your computer check box.
      • On Windows 2008 R2, click Change User Account Control settings, and move the slider to the Never notify position.
    3. Click OK.
    4. Reboot the server and perform the install.

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

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

    You can use the SBM System Administrator that is installed by the suite installer on a 64-bit Windows 2008 R2 server to upgrade the database. As part of the upgrade, review and upgrade any scripts and APIs that were originally created on a 32-bit operating system to ensure that they also run on a 64-bit system. For example, if you have any scripts that load .dll files, those dll files must be upgraded to run on a 64-bit machine.

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

    • Recommended Requirements – 2 GHz or higher multi-processors; 16 GB memory; 10 GB operational disk space.
    • Minimum Requirements – 800 MHz or higher single processor; 8 GB memory; 2.5 GB operational disk space.
  • For Oracle systems, you must perform the database upgrade using either the Mashup2009 DSN that is installed with SBM or a system DSN that uses the "Oracle for SBM" driver that is installed with SBM. As part of the upgrade, the existing Mashup2009 DSN is automatically converted to use the new "Oracle for SBM" driver. If you attempt to use a DSN other than the Mashup2009 DSN provided by SBM, the SBM System Administrator prompts you to either use the Mashup2009 DSN or to modify or create a DSN that uses the "Oracle for SBM" driver.
    Important: The underlying driver used in the "Oracle for SBM" DSN that ships with SBM has changed in SBM 10.1. If you currently use the Mashup2009 DSN with SBM, you do not need to do anything. If you created your own custom DSN with the "Oracle for SBM" driver prior to upgrading to SBM 10.1, you must recreate the DSN and use the new "Oracle for SBM" driver that ships with SBM 10.1.

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

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

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

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

  • States, transitions, and projects now have unique internal names that make it possible to unambiguously refer to them in a Web service, AppScript, or API call. (This enables you to change the display name of the state or transition and not interfere with any of these references). Note the following:
    • The internal state and transition names are derived from the internal name of their defining workflows. These internal values are set when you open a process app in SBM Composer for the first time in SBM 10.1.
    • You can change the new default internal names for states and transitions at any time before the process app is published for the first time in SBM 10.1. Once the process app is published in SBM 10.1 , the internal names cannot be changed.
    • The internal names for existing projects are automatically created upon upgrade to SBM 10.1. When you create new projects in the Application Administrator in 10.1, SBM automatically creates the internal project name for you.
      Note: During promotion, if the internal project name clashes with an existing internal project name, the internal name in the target database is affected in one of two ways:
      • For new projects that are added during promotion, when a conflict occurs, the project name in the target database will be a blank or empty string.
      • For existing projects that are updated during promotion, when a conflict occurs, the project name in the target database remains unchanged. If the internal name in the incoming XML does not conflict with the internal name in the target database, then the promoted project's internal name is used.
  • The new Java Notification Server does not support the MAPI standard. For upgrading customers formerly using MAPI with the Notification Server, you can now connect to your Microsoft Exchange server using the Exchange e-mail server type in SBM Configurator. The Exchange option enables SBM to communicate with your Microsoft Exchange server using the MS Exchange Web services API. For steps to change from MAPI to Exchange, see Installation and Configuration Changes.
  • In SBM 2009 R4, application icons were introduced. You could specify an icon in the application editor in SBM Composer, and the icon appeared on the application tabs in the SBM User Workspace. If you did not specify an icon, a default red icon was automatically used. In SBM 10.1, the red icon is no longer the default; instead no icon is used if you do not specify one.
    • If you are upgrading from a release earlier than SBM 2009 R4, you will see no change; no icon will appear on the application tab.
    • If you are upgrading from SBM 2009 R4 or later, and changed the default red icon to something else, you will see no change; your icon will still appear on the application tab.
    • If you are upgrading from SBM 2009 R4 or later, and kept the default red icon, you will no longer see the icon; the application tab will be blank. If you want to restore the red icon, you can select it from the list that opens when you select "New image..." from the drop-down list in the application editor in SBM Composer. Redeploy your process app after making this change.
  • Security Tokens are now generated for authenticated users regardless of the log in method you choose in SBM. For more information, see Security Token Usage Regardless of Log in Method. Note the following behavior for upgrades from previous releases:
    • If SSO was enabled in a prior release, after the upgrade to 10.1, deployed apps will use Security Tokens automatically without having to be redeployed.
    • If SSO was disabled in a prior release, after the upgrade to 10.1, deployed apps will not use Security Token authentication unless they are redeployed (even if SSO is enabled after the upgrade to 10.1).
  • The following information only applies to SBM systems in which external events were used with orchestration workflows and SSO was not used:
    • With the use of security tokens for all communication with SBM components regardless of authentication method, it is now necessary to provide credentials in the User element of external events that are processed by the Event Manager. Credentials must be supplied in order to receive a security token.
    • Previous SBM releases allowed anonymous events if SSO was disabled. In SBM 10.1, security tokens are used in all underlying communication. As part of the upgrade process, in order to still accept external events without credentials, the Event Manager is automatically configured to continue to accept external events without authentication credentials. If SSO was enabled prior to upgrade, then it is assumed that external events always included credentials and will continue to do so in your environment.
      Important: If you are currently using external events without SSO, it is strongly recommended that you adjust the source of those external events to now include credentials. Once you adjust the external source to include a credential, you can then manually override the Event Manager settings by setting the no_authentication parameter to “false” in the alf.properties file. For configuration instructions, see solution S138463.
    • After upgrading, the no_authentication setting is independent of the SSO setting. If you are performing a new installation, you can override the default behavior for the Event Manager and enable it to accept external events without credentials. For configuration instructions, see solution S138463.
    • For SBM Application Engine Web services, the SBM Application Engine auth still overrides the security token auth. In some cases, this is useful in day-to-day operations and may be useful as you upgrade to SBM 10.1. For example, orchestration workflows that contain coded auth for the SBM Application Engine service calls will continue to work if the external event is changed to send a credential; the coded auth will override the security token and continue work as it did prior to upgrade.
  • User credentials in SBM Application Engine Web service calls that use Basic authentication are now handled exclusively by SBM Application Engine itself, instead of IIS. This configuration is common if your SBM system is set up with NT Challenge Response for end-user authentication. After upgrade, this means that you must now specify the Windows domain for Web service calls in SBM System Administrator, otherwise the domain that the IIS server machine is installed on is used for user validation.
    As part of the upgrade, SBM Configurator should perform the following steps for you automatically to accommodate this new requirement. However, for systems that use NT Challenge Response authentication that have an authentication override set in SBM System Administrator, you must perform the following steps manually:
    1. In IIS, copy or take note of the current domain that you have set for Basic Authentication on the GSOAP directory.
    2. Clear Basic Authentication from the GSOAP directory and only specify Anonymous Access or Anonymous Authentication. (In previous versions of SBM, you had to specify Basic Authentication on the IIS GSOAP directory and provide the domain there).
    3. From the Options menu in the SBM System Administrator, select Settings or click the Settings icon on the toolbar. The Settings – Server tab opens.
    4. Paste or enter the correct Windows domain in the Default domain for web services field.
  • If your database does not contain at least one Regular User or Managed Administrator account with Remote Administration privilege, the Reset Administrative User Access Wizard appears immediately after the database upgrade is finished. You use this wizard 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). Once the wizard is finished, you should be able to log in to SBM Application Administrator using the user account that you specified in the wizard. For details, see the SBM System Administrator Guide.
  • Serena recommends that you generate a new SSO signing key to sign the STS security token. By generating a new key pair, you improve the overall security of your SBM installation. In a single server environment, you can generate a new key pair in the Security tab of SBM Configurator. For distributed installations, use SBM Configurator to generate the key pair on the server that hosts SSO and then export a configuration snapshot and import it into SBM Configurator on each of your distributed servers. For more information, see the SBM Installation and Configuration Guide.

Minor Upgrades

This section provides important notes and upgrade instructions for upgrades to SBM 10.1 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 2009 R3 or later is installed on your system by opening the "About" box in the Web interface or Mashup Administrator. 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 installation directory structure for Business Mashups on your Application Engine Web server machine.
  4. Download the release from support.serena.com.
  5. Stop the following services on the Application Engine Web server: Internet Information Services – IIS, Serena Common JBoss, and the Notification Server and Mail Client.
    Note: You can stop IIS and the Serena Common JBoss Service on the Manage Services tab of SBM Configurator.

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. Extract the server installation files.
  2. 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.
  3. The Upgrade Summary dialog box appears and summarizes the components that are currently installed on the server and ready for upgrade. The current installation directory that will be upgraded is noted as well.

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

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

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

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

    Note: For minor upgrades, if you want to uninstall existing components or install new components other than the SBM Mail Services, you must use the Windows Add/Remove Programs utility to completely uninstall SBM and then perform a Custom install using the suite installer again (which performs a clean install). This process does not upgrade the current installation. It is recommended that you back up your existing SBM installation directory before you uninstall and reinstall with different component selections. Once the desired components are installed, continue to the next step and reconfigure your installation using SBM Configurator.
  4. At the end of the installation process, click Configure to launch SBM Configurator. You must complete the SBM Configurator wizard before you can access SBM.
    Note: If you are prompted to restart your server, 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.
    When you launch SBM Configurator, it detects that you are upgrading your system and it upgrades the file system by merging existing configurations from your previous installation into the new installation files. After SBM Configurator is finished upgrading your file system, you can run it anytime thereafter to verify or modify your configuration settings as needed. Guidance is available by clicking the Help buttons throughout the wizard.
  5. Launch the SBM System Administrator and upgrade the SBM Application Engine database. If you use multiple environments, you must perform this step for each database in each environment.
  6. Review the database upgrade log file in the Log folder of the installationDirectory\Serena\SBM\Application Engine directory and correct any problems that occurred during the upgrade. If the log file is empty, no errors or warnings occurred during upgrade.
  7. Merge custom modifications to HTML templates, e-mail templates, and Web interface online help files made to your upgraded files. Backup templates are stored in a backup folder in the installationDirectory\Serena\SBM\Application Engine\Backup<version>-<date>-<time> directory.
    Note: Read solution S138494 for a list of configuration files, template files, 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.
    Important: If you installed the TT4ZMF integration prior to upgrading, you must follow the instructions in the TT4ZMF readme to reinstall the integration after the SBM upgrade is complete.
  8. If you performed the previous step, open SBM System Administrator, select File, and then select Put Files in Database. ALL templates and images in the database are replaced by files on your local machine.
  9. In SBM Configurator, verify that these services are started in the Manage Services tab: SBM Application Engine Web server (Internet Information Services - IIS), Serena Common JBoss, Notification Server, and Mail Client.
  10. Instruct all SBM Composer users to install the client tools using the instructions in the following section (Client Installation).
  11. 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.

Note: 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.

Known Issues

This section describes known issues and contains the following categories:

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

Installation and Configuration Issues

  • SBM Configurator requires you to restart IIS if you apply any configuration changes you have made to the SBM Mail Services. To work around this problem, avoid installing or running SBM Mail Services on the SBM Application Engine server or try to only change these settings during non-business hours.

Single Sign-On (SSO) Issues

  • If you upgrade to SBM 10.1 from a version prior to 09R2 in which SSO was enabled, users might not be able to access the SBM User Workspace and the following error appears: 
    SSO Gatekeeper error has occurred: Authentication processing error
Detail
Error redirecting to federation services: maximum allowable URL length exceeded
    In this scenario, a configuration change is required to the RemoteDataMaxURLLength setting in the following files on each server in your SBM installation: 
    Common\jboss405\server\default\alfssogatekeeper\conf\gatekeeper-core-config.xml
Application Engine\alfssojavabridge\alfssogatekeeper\conf\gatekeeper-core-config.xml
    If the RemoteDataMaxURLLength setting is less than 1024 in these files, change the value to 1024, restart IIS and JBoss, and then try to access the SBM User Workspace again.

SBM Composer Issues

  • The Social Widget includes a popup that opens at the left side of the widget if there is room on the form; otherwise it opens on the right side. To make sure that users can see the popup, do not place the widget in a single-column row, and place it in a column that has enough room on either side for the popup to open.
  • When you compare two process apps, and merge a Web service (for example, sbmappservices72) into the open process app, the entire Type Library is merged. This can cause validation errors caused by unmatched types in the Type Library.

    For example, suppose the Incident Number field display name was changed to Request ID, and that field is used in an event definition. The merge adds data from the old event definition to the Type Library. This data does not match the event definition in the open process app, which uses the other field name.

    To work around this problem, after merging the Web service:
    1. Reimport each of the other Web services by clicking Refresh on the General tab of the Web service Property Editor.
    2. For asynchronous orchestration workflows, reimport each event definition by clicking Regenerate on the General tab of the event definition Property Editor. The event definitions are under the Application Links heading in App Explorer.
    3. For synchronous orchestration workflows, click the event under the Orchestration Links heading in App Explorer, and make sure the new field is selected.
  • When you compare two process apps, and merge a form into the open process app, you could get an error that crashes SBM Composer if the form uses images or JavaScripts that do not exist in the open process app. To work around this problem, merge the images and JavaScripts before you merge the form.

Administrator Issues

  • Prior to SBM 2009 R4.02, promotion profiles in Application Repository contained default values that were set to None. After SBM 2009 R4.02, the default values are set to All. This means if you upgrade from a release prior to SBM 2009 R4.02 and then promote a promotion profile, the values that were previously saved as None are now set to All by default, which may promote data that you previously did not want to promote. To work around this problem, after you upgrade, edit the promotion profiles and change the values back to their prior values, and then promote.
  • In the Roles view of SBM Application Administrator, you can click User Assignment to enable or disable roles for certain users. However, this view does not enable you to sort by Status, which prevents you from easily determining which users are assigned to the selected role.
  • If you log in to Application Administrator as one user and leave the session open while you log in to the User Workspace as another user, the Application Administrator session is not terminated and appears to remain open, though you cannot perform administrative duties as the original user. To work around this problem, exit Application Administrator and log back in as the original user.
  • The Manage Data page may not display correctly when the browser window zoom is greater than 100 percent.
  • Some areas of SBM Application Administrator can still be modified when a database lock is applied in SBM System Administrator. For example, users and groups can be assigned to roles when a database is locked.
  • When you add or remove selections for User, Multi-User, or Multi-Group fields or set default values for these field types, changes are saved on the selection dialog that opens, rather than on the Attributes page for the field.
  • Results are not returned when you perform a search for users or groups to assign to roles and you are not on the first page of listed users or groups. To work around this problem, perform searches from the first page of users or groups.
  • The Add Notification icon that appears on the Administrator portal after you search for and select a project has no effect. To add a notification, click the Notifications icon, select a workflow, and then click Add.
  • SBM Application Administrator uses the same login session as the SBM User Workspace. This can cause problems when multiple users log in to these interfaces on the same machine. To work around this problem, users should always log out before another user logs in.
  • When you click Test Connection for a REST service endpoint URL in SBM Application Repository, you could get an error if parameters are missing from the URL. To work around this problem, test the complete URL instead, which you can copy from the REST Service Configuration dialog box in SBM Composer, and then paste into a separate browser window.
  • Default destination endpoints are not listed on the Promote or Deploy dialog boxes in SBM Application Repository for Chrome browser users. To work around this problem, use Internet Explorer or FireFox to promote or deploy process apps that include endpoints.

Miscellaneous Issues

  • Intermittent caching problems may prevent applications from being refreshed in the SBM Application Engine. For example, application elements, such as transitions that were added to an application, may not be immediately available after deployment. To work around this problem, restart Internet Information Services (IIS).
  • When embedding an Editable Grid report, the View Item action displays a blank page. To workaround this problem, click on the Item Id (or item link) to display the item in a new window.

Documentation Issues

  • Online help is not available for the Broker Service and internal Web server dialog boxes in SBM System Administrator.

Resolving InitExtension Failed Errors in the SBM User Workspace

On Windows 2003 servers, Internet Information Server (IIS) uses the IUSR_machinename (Internet Guest Account) account to access the SBM Application Engine database. If you are experiencing InitExtension Failed errors while trying to login to the SBM User Workspace, you may need to set correct privileges for the IUSR account. For SBM to function correctly, this IUSR_ account needs Full Control over the SBM directory. Also, the IUSR_ account needs to have Read and Execute permissions in the WINNT and WINNT\system32 directories.

If you upgrade to Windows 2008 in addition to upgrading SBM, the privileges above apply to the IIS Application Pool Identity instead of the IUSR account. The default Application Pool Identity is NetworkService on Windows 2008. For more information, see the SBM Installation and Configuration Guide.

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