Turn Off Tabs
SBM for SharePoint 2009 R3.02 Online Readme
This readme file contains known issues and other important information for SBM® for SharePoint. This file also contains information that might not be available in other SBM® for SharePoint documentation. Last updated on 2010-12-02.

Contents

Welcome

SBM for SharePoint® contains the necessary pieces to enable your Microsoft Office SharePoint Server® installation to integrate with your Serena® Business Mashups installation. This integration enables you to leverage the business process management capabilities of Business Mashups with the documentation management of your SharePoint Server.

With SBM for SharePoint®, your SharePoint sites become more than merely document repositories; they become places where team members can truly collaborate: tracking the progress of a project, managing the documentation approval process, and managing change requests. The site becomes both a portal to your business processes and a repository for your project documentation.

SBM for SharePoint® contains three main pieces:
  • Serena Web Parts to Create a SharePoint Portal – Using the Serena Web parts and the default SharePoint Web part, you can modify your SharePoint site into a portal to your Mashup Server. This enables you to create a place where end users can get the complete view of your project status without having to leave the SharePoint site.
  • SBM Web Services for SharePoint to Allow for Documentation Management – SBM Web Services for SharePoint enhance the communication between your Mashup Server and your Microsoft Office SharePoint Server. This enables users to create, view, and update documents on SharePoint Sites from Serena business process applications. After documents are uploaded to SharePoint, users can interact with documents within SharePoint or from Business Mashups business process applications, thus facilitating easy collaboration among various stakeholders. The documents are versioned using SharePoint, giving you acces to previous document revisions.
  • Project OnBoarding Solution for Managing SharePoint Site Creation – Project OnBoarding Solution enables end users to review, approve, and create SharePoint sites. Additionally, it associates these created SharePoint sites to Business Mashups projects. After a project and site are associated, the Business Mashups project can leverage the documentation management features of SharePoint.

Installation

Depending on your version of Microsoft Office SharePoint Server, the installation process is different.

Note: If you are upgrading from a previous version of SBM for SharePoint®, the installer will prompt you to overwrite the old version.

There are four steps for installing :

  1. Install the SBM Enablement Pack for SharePoint on your SharePoint server. The instructions depend your version of Microsoft Office SharePoint Server:
  2. Configure the SBM Web Services for SharePoint that you installed in step 1. See Configuring SBM Web Services for SharePoint for details.
  3. Configure your SharePoint Web server to allow access from your Mashup Server. See Allowing Access for Mashup Server for details.
  4. Populate your Web part gallery with the Serena Web Parts. See Enabling the Serena Web Parts for details.
  5. Deploy either the Project OnBoarding and Configuration Mashup to allow you to link SharePoint sites with Business Mashups projects.

About the SBM Enablement Pack for SharePoint

The SBM Enablement Pack for SharePoint refers to the pieces of that must be installed on your SharePoint server. These pieces are required for handling events, using Serena Web Parts, and selecting templates when using the Project OnBoarding Solution.

The main components of the SBM Enablement Pack for SharePoint include:

  • The SBM Web Services for SharePoint are custom Web services that are created for SharePoint. These web services emit events to Business Mashups, which allow you to monitor when items are checked in or altered in SharePoint.

  • The Serena templates are custom SharePoint templates that can be used when you create a new SharePoint site using the Project OnBoarding Solution. These templates create a SharePoint site that is tailored for relating with a Business Mashups project.

  • The Serena Web Parts are custom Web parts that are available to you when you construct a site in template.

Installing SBM Enablement Pack for SharePoint on MOSS 2007

Prerequisites:

To perform this procedure, you must have the permissions to copy files to your Sharepoint server, the permissions to run the SBM Enablement Pack for SharePoint on that machine, the permissions within Sharepoint to configure Web parts and templates, and SharePoint Administrator.

The SBM Enablement Pack for SharePoint requires Windows .NET Framework 3.5. MOSS 2007 only requires .NET 3.0, which means that you may have to install 3.5 before being able to run the installer.

To install SBM Enablement Pack for SharePoint on MOSS 2007, perform the following steps:

  1. Copy SP9R301.exe to your SharePoint server.
  2. Run SP9R301.exe on your server using under an administrator account or usnig Run as Administrator.
    Important:

    The Windows SharePoint Services Administration service must be running. in order to run the install process. You will receive a message that tells you to start the process before running the installer. You can start this service under Administration Tools | Services.

    Note you will also receive the warning message if the user account under which the installer is running does not have the permissions to run the installer on the server.

    1. Accept the End User License Agreement.
    2. The installation directoy is detected automatically based on your SharePoint installation.
    3. Click Install to complete the installation.
    The installed files include SBM Web Services for SharePoint, Serena templates, Serena Web parts, and the Integration Guide for SharePoint.
  3. After the install completes, configure the Web Services to point to your Mashup Server as described in Configuring SBM Web Services for SharePoint for details.
  4. Configure your SharePoint Web server to allow access from your Mashup Server. See Allowing Access for Mashup Server for details.
  5. Populate your Web part gallery with the Serena Web Parts. See Enabling the Serena Web Parts for details.
  6. Deploy either the Project OnBoarding and Configuration Mashup to allow you to link SharePoint sites with Business Mashups projects.

Installing SBM for SharePoint® on MOSS 2010

Prerequisites:

To perform this procedure, you must have the permissions to copy files to your Sharepoint server and the permissions within Sharepoint to deploy the solutions, Web parts and templates.

To install SBM for SharePoint® on MOSS 2010, perform the following steps:

  1. Extract the contents of BMSP2010.zip on to your Sharepoint server. The files include the necessary pieces to deploy and install SBM Web Services for SharePoint, Serena templates, and Serena Web parts. It also contains install.bat and setup.bat which will install the files for you.
  2. In the files that you extracted, run Install2010.bat.
    Important: The Windows SharePoint Services Administration service must be running. in order to run the bat file. Stsadm must be in your path. If not, you must edit the bat file to point to the correct install path for stsadm.exe.

    The bat file will run the deploy commands for the solution and copy necessary files to your IIS server. The bat file will deploy the Serena Web parts.

    The bat file deploys the Web parts solution using the stsadm.exe utility. The deploy will force an update if you have deployed a previous version of the SBM for SharePoint® (that is, it sets the force flag for the deploy command).

    The files that are copied during installation are placed in the virtual folders of IIS. If these files already exist, the installer will try to replace the existing files with new versions. Because the existing files are in virtual directories of IIS, these files can be locked by IIS. If this is the case, Install.bat will not copy the new versions of the files. You will have to manually stop IIS, replace the existing files with the new ones, and then restart IIS.

  3. Populate your Web part gallery with the Serena Web Parts. See Enabling the Serena Web Parts for details.
  4. In the files that you extracted, run setup2010.bat. This batch file will deploy the SBM Web Services for SharePoint and Serena templates. The bat file deploys the solution using the stsadm.exe utility. Unlike the MOSS 2007 installer, setup2010.bat attempts to activate the SBMDocumentContentType feature on the site collection at http://localhost. A different site collection URL can be provided for activation. See setup2010 –help for details. You can only activate one Site Collection this way. If you have multiple Site Collections the SBMDocumentContentType feature must be activated on the Site Collection using the Sharepoint Site Collection Administration pages.
  5. After the install completes, configure the Web Services to point to your Mashup Server as described in Configuring SBM Web Services for SharePoint for details.
  6. Configure your SharePoint Web server to allow access from your Mashup Server. See Allowing Access for Mashup Server for details.
  7. Deploy either the Project OnBoarding and Configuration Mashup to allow you to link SharePoint sites with Business Mashups projects.

Configuring SBM Web Services for SharePoint

The SBM Web Services for SharePoint raise events that occur in SharePoint such as updating a document. These events can be used by Business Mashups to trigger action the workflow.

Note: You must activate the Web services for each of your site collections, however the same configuration information will pertain to all of them.

To activate the SBM Web Services for SharePoint:

  1. Activate the SBM Web Services for SharePoint for your site collection:

    1. In Microsoft SharePoint, open the Site Settings panel ( Site Settings | Modify Site Settings).
    2. Click Site Collection Features under Site Collection Administration.
    3. Click Activate next to SbmDocument.
    Tip: You must activate SbmDocument on each site collection that you plan to use SBM Web Services for SharePoint.
  2. Add the connection information to point to your Business Mashups Event Manager.
    Important:
    • You must set the connection information at the root level for the Site Collection. Once you set SBMDocumentContentType settings at the root level it will apply to all subsites. The settings will not work when set at a subsite level and setting at the subsite level will corrupt the main site settings.
    • If you have plan to use eventing in multiple SharePoint Web applications, you can use the SBMDocumentContentType to configure the first Web application, but you must manually configure the other Web application as described in Manually Configuring SBMDocumentContentType Settings .
    • The SBMDocumentContentType page requires that you enter a password. To use an account without a password, add the user account as described below and enter a placeholder password. After saving the changes, manually edit the web.config file as described below and delete the placeholder password.
    For MOSS 2007:

    1. In Microsoft SharePoint, open the Site Settings panel ( Site Settings | Modify Site Settings on MOSS 2007).

    2. Click Sbm Document Settings under Site Collection Administration.

      image

    3. On the SbmDocument ContentType screen, enter the connection information to your Orchestration Engine and click OK.

      The Business Mashups user account that you entered must have Managed Administration privilege and have access to the projects where the orchestrations will be running. If you have installed the Orchestration Engine on a separate Web server from your Application Engine, remember to enter the host name for your Orchestration Engine and not your Application Engine. The default port is 8085.

      image

    For MOSS 2010, you must manually add the connection information described above to the web.config file for each root Web application. See Manually Configuring SBMDocumentContentType Settings for information.

  3. Configure your orchestrations to make use of these events, such as performing transitions on the Business Mashups item that the document is attached to.

Manually Configuring SBMDocumentContentType Settings

To manually configure the SBMDocumentContentType settings for your root Site Collections:

  1. Find the web.config for the Web application that you have activated. The web.config file is located in the following location where root is the port of your Web application.

     C:\Inetpub\wwwroot\wss\VirtualDirectories\root\web.config
  2. Backup the web.config file before performing the following edits.

  3. Find the appSettings section of web.config. The section should look something like this:

    <configuration>
  ...
   <appSettings> 
    ... 
   </appSettings>
 ...
</configuration>
    Note: There may be additional sections before or after the appSettings section.

  4. Define the connection information for your event manager by adding the following keys entries:

    <configuration>
  ...
   <appSettings> 
    ... 
    <add key="SbmEMServicePassword" value="password" />
    <add key="SbmEMServiceUrl" value="http://localhost:8085
           →/eventmanager/services/ALFEventManagerDocLit/" />
    <add key="SbmEMServiceUser" value="username" />
  </appSettings>
 ...
 </configuration>

    Change the values below to the SbmEMServicePassword, SbmEMServiceUrl and SbmEMServiceUser for the user account that will raise the events for the event manager.

    Note: If you have used the SBMDocumentContentType settings page to configure the settings, the SBMDocumentContentType elements will have already been added to the section as shown above. Modify the values as appropriate. For example, you can change the value="" to signify a blank password.
  5. Save the updated web.config file.
  6. If you have multiple Web applications, repeat this process for each application.

Allowing Access for Mashup Server

You must configure your SharePoint Web server to allow access for requests from your Mashup Server. This configuration is performed by modifying your crossdomain.xml file on your SharePoint Web server.

The file usually resides in the following directory on your SharePoint server: C:\Inetpub\wwwroot\wss\VirtualDirectories\80.

Add lines like the following to the file, changing server.domainname.com to the server name of your Mashup Server.

<allow-access-from domain="server.domainname.com" />   
    <allow-http-request-headers-from domain="server.domainname.com" headers="*" />
Tip: A sample crossdomain.xml is included in the SBM Enablement Pack for SharePoint, which demonstrates a completed crossdomain.xml file.

For more information, refer to the following page: http://www.adobe.com/devnet/articles/crossdomain_policy_file_spec.html.

Enabling the Serena Web Parts

Prerequisites:

To perform this procedure, you must have the permissions within Sharepoint to populate a Web gallery.

Note: The Serena Web parts are included with SBM for SharePoint®. Installing SBM for SharePoint® will install the Web parts.

After running the SBM for SharePoint® installer, you must populate the Web parts into your Web part gallery before they available when creating a page in SharePoint.

To enable the Web parts for use in Sharepoint sites by populating them to the Web part gallery:

  1. Log in to Sharepoint.
  2. Edit the Site Settings for the Sharepoint sites that will use the Web Parts.
  3. Select Web Parts under Galleries.
  4. Click New and select which Serena Web parts to enable.
    • Choose SBM Reports to enable the reporting Web part.
    • Choose SBM Applications to enable the solutions Web part. Note that this Web part requires Serena Business Mashups 2009 R3 or newer.
    • Choose SBM Selected Applications to enable the selected solutions Web part. Note that this Web part requires Serena Business Mashups 2009 R3 or newer.
  5. Click Populate Gallery to make the Web parts available for user sites.

Uninstalling

Uninstalling requires that you run the uninstall program for your version Microsoft Office SharePoint Server (MOSS) and then you manually remove the Web parts from the gallery.

To uninstall:

  1. Run the uninstall program:
    • For MOSS 2007, select to uninstall under Windows Add or Remove Programs.
    • For MOSS 2010:
      1. Locate and run the Uninstall2010.bat that was included with the SBM Enablement Pack for SharePoint.
      2. Run Setup2010.bat with the uninstall paramater: Setup2010.bat -uninstall. It is located in the same folder as Uninstall2010.bat.
    Note: The uninstall does not delete information that was added to the web.config file when it was configured as described in Configuring SBM Web Services for SharePoint.
  2. To cleanly uninstall you should remove any Document Libraries that use the SBMDocumentContentType and deactivate it on any Site Collections where it has been used.
    Note: Setup2010 –uninstall attempts to deactivate the feature on the site collection at http://localhost. If desired a different site collection URL can be provided for deactivation. Run Setup2010 –help for details. Note that you can only deactivate one Site Collection this way. If you have multiple Site Collections the SBMDocumentContentType feature must be deactivated on the Site Collection using the Sharepoint Site Collection Administration pages.
  3. (MOSS 2007) If desired, manually remove the Web parts from the Web part gallery:
    1. Log in to Sharepoint.
    2. Edit the Site Settings for the Sharepoint sites that will use the Web Parts.
    3. Select Web Parts under Galleries.
    4. Click Edit for the Serena Web part to delete.
      • SBM Reports
      • SBM Applications
      • SBM Selected Applications
    5. Click Delete Item.
      Note: If the Web parts were previously added to a page, they will remain in the page; however they will not be available for selection from the Web part gallery.

Known Issues

This section describes known issues in SBM for SharePoint®.

Tip: For help troubleshooting problems not described here, refer to solution S137970.

Working with Mashups

This section describes known issues when working with mashups.

  • If you modify the Global Mashup and then upgrade SBM, you must re-import the Global Mashup into Mashup Composer before working with the Project Onboarding (POB) mashup; otherwise, you will get validation errors pertaining to the POB mashup.

    After the upgrade, use Mashup Manager to get the Global Mashup using the Get Mashup From Application Engine command, and then open the Global Mashup from the repository in Mashup Composer.

Working with Attachments

This section describes known issues when working with attachments.

  • When an attachment is deleted in SBM as a result of the item itself being deleted, the attachment and the associated folder in SharePoint still exist.

    The workaround is to manually clean up documents and folders in SharePoint when items are deleted in SBM.

  • The Edit file button should be used separately from the Check Out button. If a user checks out a file and then uses the Edit button to check in a new revision without providing a comment, the file will be added and the previous version of the file will be overwritten, which means that data could be lost.

    This problem occurs only when a user checks out a file first when using the Edit button. The workaround is to use the Edit button to upload file content without doing a checkout first.

  • When using Mozilla Firefox, you cannot check in an attachment when transitioning an item. If you perform a check-in on a file in Firefox during a Submit or other transition, the OK and Cancel buttons on the form cease to function. The workaround is to perform the transition first and then check in the item.

  • If you click an image that is not part of a transition form, the image covers the transition form, making it impossible to complete the form. (This problem does not occur on the Submit transition because the link is disabled.)

    The workaround is to use the browser's back button and then re-perform the transition without displaying the image.

General Issues

This section describes general known issues with this release of SBM for SharePoint®.

  • Currently, upper-ASCII characters such as the German 'ü' character, as well as double-byte characters, generate errors when passed to the SBM for SharePoint® Web services. Examples of areas where this can be a problem are project names, SharePoint document library names, and SharePoint document library descriptions.

Copyright © 2010 Serena Software, Inc. All rights reserved.