Solutions Business Manager - Serena Documentation Center

Solutions Business ManagerIntegration Guide for SharePoint

Copyright © 2018 Serena Software, Inc., a Micro Focus company. All rights reserved.

This document, as well as the software described in it, is furnished under license and may be used or copied onlyin accordance with the terms of such license. Except as permitted by such license, no part of this publicationmay be reproduced, photocopied, stored in a retrieval system, or transmitted, in any form or by any means,electronic, mechanical, recording, or otherwise, without the prior written permission of Serena. Any reproductionof such software product user documentation, regardless of whether the documentation is reproduced in wholeor in part, must be accompanied by this copyright statement in its entirety, without modification. This documentcontains proprietary and confidential information, and no reproduction or dissemination of any informationcontained herein is allowed without the express permission of Serena Software.

The content of this document is furnished for informational use only, is subject to change without notice, andshould not be construed as a commitment by Serena. Serena assumes no responsibility or liability for any errorsor inaccuracies that may appear in this document.

License and copyright information for 3rd party software included in this release can be found on the ServiceManager product news page at http://support.serena.com/ProductNews/default.aspx and may also be found aspart of the software download available at http://support.serena.com.

Trademarks

Serena, Dimensions, ChangeMan, Comparex, and StarTool are registered trademarks of Serena Software, Inc.The Serena logo, PVCS, TeamTrack, License Manager and Composer are trademarks of Serena Software, Inc. Allother products or company names are used for identification purposes only, and may be trademarks of theirrespective owners.

Sharepoint, Microsoft, and Windows are either registered trademarks or trademarks of Microsoft Corporation inthe United States and/or other countries. All other products or company names are used for identificationpurposes only, and may be trademarks of their respective owners.

U.S. Government Rights

Any Software product acquired by Licensee under this Agreement for or on behalf of the U.S. Government, itsagencies and instrumentalities is "commercial software" as defined by the FAR. Use, duplication, and disclosureby the U.S. Government is subject to the restrictions set forth in the license under which the Software wasacquired. The manufacturer is Serena Software, Inc., 2345 NW Amberbrook Drive, Suite 200, Hillsboro, OR97006.

Part number: MA-SHPT-006 Product version: 11.5

Publication date: 2018-11-15

2 Solutions Business Manager (SBM)

Table of ContentsChapter 1: Welcome to SBM Connect for SharePoint® .............................................5

Chapter 2: Installation ..........................................................................................7

About SBM Connect for SharePoint®.....................................................................7

Installing SBM Connect for SharePoint® ...............................................................8

Configuring the SbmDocument Content Type .........................................................9

Allowing Access for SBM Server ........................................................................ 10

Enabling the SBM Web Parts ........................................................................... 10

Uninstalling SBM Connect for SharePoint® ......................................................... 11

Installing SBM Connect for SharePoint® on a Server Farm.................................... 11

Setting Up SBM Connect for SharePoint® to Use SSL .......................................... 12

Chapter 3: Working with Process Apps ............................................................... 13

Choosing Solution to Deploy ........................................................................... 13

About the Project OnBoarding Solution ............................................................ 13

About the Configuration Process App ............................................................... 14

Deploying and Configuring the Process App......................................................... 15

Deploying the Process Apps ........................................................................... 15

Configuring the Orchestrations........................................................................ 16

Using aespwebservices71 .............................................................................. 17

CreateSiteDocumentLibrary ........................................................................ 18

CreateSPSiteFromTemplate ........................................................................ 20

ExtendExistingDocumentLibrary .................................................................. 22

GetAllSiteDocumentLibaries ........................................................................ 23

GetSPTemplates.......................................................................................... 25

GetVersion ................................................................................................ 27

SPDocumentLibraryInfo .............................................................................. 27

SPTemplateInfo .......................................................................................... 28

AssociateSPAttachment .............................................................................. 30

UnAssociateSPAttachment ........................................................................... 30

Integration Guide for SharePoint 3

About Custom JavaScripts .............................................................................. 31

Setting Endpoint Authorization........................................................................ 32

Assigning User Roles .................................................................................... 33

Populating SharePoint Servers Table ............................................................... 33

Using the Project OnBoarding Solution ............................................................... 34

Creating a SharePoint Site.............................................................................. 35

Associating with an Existing SharePoint Site ................................................... 37

Creating a New Project ................................................................................. 38

Associating with an Existing Project ............................................................... 39

Using the Configuration Process App .................................................................. 39

Tracking Relationships Between Sites and Projects ............................................. 39

Chapter 4: Storing SBM Attachments in SharePoint................................................ 41

Setting Authentication Mode ........................................................................... 41

Limitations with Attachments ........................................................................... 42

Uploading Attachments .................................................................................... 43

Working with Attachments .............................................................................. 45

Editing Attachments ....................................................................................... 46

Modifying SBM Connect for SharePoint® Strings ................................................ 46

Chapter 5: Raising Events in SharePoint ............................................................... 49

Tracking Document Changes ........................................................................... 49

Importing Event Definition .............................................................................. 51

Chapter 6: Working with the SBM Web Parts ......................................................... 53

Creating a Collaborative Web Site ..................................................................... 53

Using Default SharePoint Web Parts .................................................................. 54

About the SBM Web Parts ................................................................................. 55

Using SBM Reports ....................................................................................... 55

Using SBM Applications ................................................................................. 58

Using SBM Selected Applications ..................................................................... 59


Chapter 1: Welcome to SBM Connect forSharePoint®

SBM Connect for SharePoint® contains the necessary pieces to enable your MicrosoftOffice SharePoint Server® installation to integrate with your Solutions Business Managerinstallation. This integration enables you to leverage the business process managementcapabilities of SBM with the documentation management of your SharePoint Server.

Note: This version of SBM Connect for SharePoint® requires SBM version 11.5or later. This version does not contain any new features, but it is the firstrelease to use HTML5 for the file upload and file attachment controls instead ofFlash.

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

SBM Connect for SharePoint® contains three main pieces:

• SBM Web parts to Create a SharePoint Portal – Using the SBM Web parts andthe default SharePoint Web part, you can modify your SharePoint site into a portal toyour SBM Server. This enables you to create a place where end users can get thecomplete view of your project status without having to leave the SharePoint site. SeeChapter 6: Working with the SBM Web Parts [page 53] for more information on usingthe SBM Web Parts.

• SbmDocument Content Type to Allow for Documentation Management –SbmDocument Content Type enhances the communication between your SBM Serverand your Microsoft Office SharePoint Server. This enables users to create, view, andupdate documents on SharePoint Sites from SBM business process applications. Afterdocuments are uploaded to SharePoint, users can interact with documents withinSharePoint or from SBM business process applications, thus facilitating easycollaboration among various stakeholders. The documents are versioned usingSharePoint, giving you access to previous document revisions. See Chapter 4:Storing SBM Attachments in SharePoint [page 41] for more information.

• Project OnBoarding Solution for Managing SharePoint Site Creation – ProjectOnBoarding Solution enables end users to review, approve, and create SharePointsites. Additionally, it associates these created SharePoint sites to SBM projects. Aftera project and site are associated, the SBM project can leverage the documentationmanagement features of SharePoint. See Chapter 3: Working with Process Apps[page 13] for more information.


Chapter 1: Welcome to SBM Connect for SharePoint®


Chapter 2: Installation

Depending on your version of Microsoft Office SharePoint Server, the installation processis different. This section provides a high-level overview of the steps you follow to installSBM Connect for SharePoint®.

There are five steps for installing SBM Connect for SharePoint®:

1. Install SBM Connect for SharePoint® on your SharePoint server. See Installing SBMConnect for SharePoint® [page 8].

2. Configure the SbmDocument Content Type, which you installed in step 1 [page7]. See Configuring the SbmDocument Content Type [page 9] for details.

3. Configure your SharePoint Web server to allow access from your SBM Server. SeeAllowing Access for SBM Server [page 10] for details.

4. Populate your Web part gallery with Web Parts. See Enabling the SBM Web Parts[page 10] for details.

5. Deploy either the Project OnBoarding or Configuration Process App to allow you tolink SharePoint sites with SBM projects. See Deploying and Configuring the ProcessApp [page 15] for details.

About SBM Connect for SharePoint®

SBM Connect for SharePoint® refers to the pieces of SBM Connect for SharePoint® thatmust be installed on your SharePoint server. These pieces are required for handlingevents, using SBM Web parts, and selecting templates when using the Project OnBoardingSolution.

The main components of SBM Connect for SharePoint® include:

• The SBM Web Services for SharePoint® are custom Web services that are createdfor SharePoint. These Web services emit events to SBM, which allow you to monitorwhen items are checked in or altered in SharePoint.

• The SBM templates are custom SharePoint templates that can be used when youcreate a new SharePoint site using the Project OnBoarding Solution. These templatescreate a SharePoint site that is tailored for relating with an SBM project.

• The SBM Web Parts are custom Web parts that are available to you when youconstruct a site using the SBM templates.


Installing SBM Connect for SharePoint®

Prerequisites:

To perform this procedure, you must have the permissions to copy files to yourSharePoint server and the permissions within SharePoint to deploy the solutions, Webparts and templates. You must also ensure that the user account you are using theinstall the integration has permissions in the SQL database to run execute STSADMcommands.

To install SBM Connect for SharePoint®, perform the following steps:

1. Extract the contents of the .zip file onto your SharePoint server.

The files include the necessary pieces to deploy and install SBM Web Services forSharePoint®, templates, and Web Parts.

Note: If you have a previous version of SBM Connect for SharePoint®

installed, you must uninstall it before you can install the new version. Touninstall, run Uninstall<version>.bat.

2. In the files that you extracted, run the Setup<version>.bat install script.

This script deploys the SBM Web Services for SharePoint® and templates. Thescript deploys the solution using the stsadm.exe utility. The .bat file attempts toactivate the SbmDocument Content Type feature on the site collection athttp://localhost. A different site collection URL can be provided for activation. SeeInstall<version> –help for details. You can only activate one Site Collection thisway. If you have multiple Site Collections, the SbmDocument Content Type featuremust be activated on the Site Collection using the SharePoint Site CollectionAdministration pages.

Important: The SharePoint <version> Administration service must berunning when you run the .bat file and stsadm must be in your path. If itis not, you must edit the .bat file to point to the correct installation pathfor stsadm.exe. You must also ensure that the port number specified inthe .bat file is the same port number that is used for your SharePointCentral Administrator.

The script runs the deploy commands for the solution and copies the necessary filesto your IIS server. The script also deploys the SBM Web parts using the stsadm.exeutility. The deployment forces an update if you have deployed a previous version ofthe SBM Connect for SharePoint® (that is, it sets the force flag for the deploycommand).

The files that are copied during installation are placed in the virtual folders of IIS. Ifthese files already exist, the installer tries to replace the existing files with newversions. Because the existing files are in virtual directories of IIS, these files can belocked by IIS. If this is the case, the install script does not copy the new versions ofthe files. You must manually stop IIS, replace the existing files with the new ones,and then restart IIS.

3. After the installation completes, configure the Web services to point to your SBMServer as described in Configuring the SbmDocument Content Type [page 9] fordetails.



4. Configure your SharePoint Web server to allow access from your SBM Server. SeeAllowing Access for SBM Server [page 10] for details.

5. Populate your Web part gallery with the Web Parts. See Enabling the SBM WebParts [page 10] for details.

6. Deploy either the Project OnBoarding or Configuration Process App to allow you tolink SharePoint sites with SBM projects. See Deploying and Configuring the ProcessApp [page 15] for details.

Configuring the SbmDocument Content TypeThe SbmDocument Content Type can raise events and must be configured. Theseevents can be used by SBM to trigger actions in the workflow.

Note: You must activate the SbmDocument Content Type for each of your sitecollections; however, the same configuration information will pertain to all ofthem.

To activate the SbmDocument Content Type:

1. Activate the SbmDocument Content Type for your site collection:

a. Under Application Management, go to Manage Web Applications.

b. Select your Web application and click Manage Features.

c. Click Activate next to SbmDocumentConfiguration.

Tip: You must activate SbmDocument on each site collection where youplan to use the SbmDocument Content Type.

2. If you want to enable SbmDocument events, add the connection information to pointto your SBM Event Manager.

Important: The SbmDocument Configuration page requires that you entera password. The password field always displays as blank even if there is apassword currently set. You must supply the password to change theconfiguration. To use an account without a password, select the check toallow blank passwords check box.

a. In SharePoint, go to Application Management under Central Administration.

b. Click the SbmDocument Content Type Configuration link under SBMConnect.

c. On the SbmDocument Configuration page, enter the requested eventmanagement information, enter the connection information for your SBMOrchestration Engine, and then click OK.

The SBM user account that you entered must have access to the projects wherethe orchestrations will be running. If you have installed the SBM OrchestrationEngine on a separate Web server from your SBM Application Engine, rememberto enter the host name for your SBM Orchestration Engine and not your SBMApplication Engine.


The default port is 8085. (For more information, refer to Setting Up SBM Connectfor SharePoint® to Use SSL [page 12].)

Tip: If you are upgrading from a previous version of SBM Connect forSharePoint®, there are two new fields (SBM Item Title and SBM ItemSubmitter) that you must manually add to any existing view from theSite column list. For details, refer to the SBM Connect for SharePoint®

readme.

3. Configure your orchestrations to make use of these events, such as performingtransitions on the SBM item that the document is attached to. See Chapter 5:Raising Events in SharePoint [page 49] for examples of ways to configure yourorchestration.

Allowing Access for SBM ServerYou must configure your SharePoint Web server to allow access for requests from yourSBM Server. This configuration is performed by modifying the crossdomain.xml file onyour SharePoint Web server.

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

Add the following lines to the file, changing server.domainname.com to the servername of your SBM 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 SBM Connect for SharePoint®,which demonstrates a completed crossdomain.xml file.

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

Enabling the SBM Web Parts

Prerequisites:

To perform this procedure, you must have the permissions within SharePoint topopulate a Web gallery.

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

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

To enable the SBM Web parts for use in SharePoint sites by populating them tothe Web part gallery:

1. Log in to SharePoint.



http://www.adobe.com/devnet/articles/crossdomain_policy_file_spec.html

http://www.adobe.com/devnet/articles/crossdomain_policy_file_spec.html

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 Web parts to enable.

• Choose SBM Reports to enable the reporting Web part.

• Choose SBM Applications to enable the solutions Web part.

• Choose SBM Selected Applications to enable the selected solutions Web part.

5. Click Populate Gallery to make the Web parts available for user sites.

Uninstalling SBM Connect for SharePoint®

Uninstalling SBM Connect for SharePoint® requires that you run the SharePoint uninstallprogram and then manually remove the Web parts from the gallery.

To uninstall SBM Connect for SharePoint®:

1. Run the uninstall program: Uninstall<version>.bat.

2. If desired, manually remove the Web parts from the Web part gallery:

a. Log in to SharePoint.

b. Edit the Site Settings for the SharePoint sites that will use the Web parts.

c. Select Web Parts under Galleries.

d. Click Edit for the Web part to delete.

• SBM Reports

• SBM Applications

• SBM Selected Applications

e. Click Delete Item.

Note: If the Web parts were previously added to a page, they willremain in the page; however they will not be available for selectionfrom the Web part gallery.

Installing SBM Connect for SharePoint® on a ServerFarm

The setup program installs to the local SharePoint server. When installing on a serverfarm, you must run the installer on each server. Similarly, run the uninstall program oneach server when removing the integration from a server farm.


Setting Up SBM Connect for SharePoint® to Use SSLYou can configure Secure Sockets Layer (SSL) to work with SharePoint events byperforming the following steps:

1. Configure SSL for SBM as described in the SBM Installation and Configuration Guide.

2. Install the certificate that you create for Tomcat as a Trusted Root CertificationAuthority on the server or servers that host SharePoint, as described in the section"Managing Trusted Certificates" in the SBM Installation and Configuration Guide.

3. Configure the SbmDocument content type for SSL by setting the SBM EventManager Scheme field to https on the SbmDocument Configuration page(available from Application Management under Central Administration).



Chapter 3: Working with Process Apps

The following topics describe the use of the Project OnBoarding and Configuration ProcessApp:

• Choosing Solution to Deploy [page 13]

• Deploying and Configuring the Process App [page 15]

• Using the Project OnBoarding Solution [page 34]

• Using the Configuration Process App [page 39]

• Tracking Relationships Between Sites and Projects [page 39]

Choosing Solution to DeploySBM Connect for SharePoint® includes two process apps Project OnBoarding andConfiguration Process App, one of which must be deployed to fully use SBM Connect forSharePoint®. These process apps contain orchestrations that enable you to link your SBMprojects to SharePoint sites.

Note: SBM Connect for SharePoint® also contains the Contract Approval ProcessApp,which is not required for the solution. This process app contains a sampledocument approval workflow that makes use of events raised from SharePoint.The process app automatically moves items to the Re-Review state if itsattachment was changed in SharePoint. See Tracking Document Changes [page49] for more information about this process app and how you could use it.

The following topics describe the workflows found in the two process apps. In general, thedifference is:

• Project OnBoarding is a full-fledged solution for managing the creation of SharePointsites and SBM projects, where as

• Configuration Process App is a stripped-down version including only the necessaryfunctionality of linking an existing SharePoint site with an existing SBM project.

About the Project OnBoarding SolutionTip: Choose to deploy the Project OnBoarding Solution for managing thecreation of SBM projects and SharePoint sites. If you do not want the additionalfunctionality of managing project and site creation, do not deploy ProjectOnBoarding Solution, instead deploy the Configuration Process App.

With Project OnBoarding, administrators can manage and track the creation of SharePointsites and SBM projects. Each SharePoint site and SBM project goes through an approvalprocess before the site is created. The Project OnBoarding process helps preventuncontrolled SharePoint growth, which can lead to compliance and performance issues.

Furthermore, Project OnBoarding links SharePoint sites to SBM projects, which allows youto take advantage of the documentation management features of SharePoint.


The Project OnBoarding Solution comprises one application workflow, ProjectOnBoarding. New items are submitted into the Approval Pending state, where theProject Manager determines whether to approve or deny the request.

If approved, the request moves to the Site Creation Pending state, where theSharePoint Administrator determines whether to create a new SharePoint site or select anexisting site.

After the SharePoint site is selected, the request moves to the Project Creation Pendingstate, where the SBM Administrator chooses whether to create a new SBM project or touse an existing project.

This project is then associated with the SharePoint site selected earlier, and theinformation is written to the SharePoint Project Servers auxiliary table.

You can now add attachments to items in this project, and the attachments will be storedin the SharePoint. The request moves to the Complete Site & Project state and ismarked as inactive.

The Project OnBoarding workflow calls the orchestrations, which creates or selects theSharePoint sites or SBM projects. See Configuring the Orchestrations [page 16] for moreinformation about working with the orchestrations.

About the Configuration Process AppTip: Choose to deploy the Project OnBoarding Solution for managing thecreation of SBM projects and SharePoint sites. If you do not want the additionalfunctionality of managing project and site creation, do not deploy ProjectOnBoarding Solution, instead deploy the Configuration Process App.

The Configuration Process App allows SBM administrators to link an existing SharePointsite with an existing SBM project.

Unlike Project OnBoarding, the Configuration Process App has no ability to createSharePoint sites and SBM projects.

The Configuration Process App comprises one application workflow, Configuration. Newitems are submitted into the Assign state, where the SharePoint Administrator selects anexisting SharePoint site.

After the SharePoint site is selected, the request moves to the Project AssociationPending state, where the SBM Administrator selects an existing SBM project.

This project is then associated with the SharePoint site selected earlier, and theinformation is written to the SharePoint Project Servers auxiliary table. The requestmoves to the Complete Site & Project state and is marked as inactive.

The Configuration Process App writes the association information between the SharePointsite and SBM project to the SharePoint Project Servers auxiliary table.

You can now add attachments to items in this project, and the attachments will be storedin the SharePoint.

The Configuration Process App workflow calls the orchestrations, which associates theSharePoint sites with SBM projects. See Configuring the Orchestrations [page 16] formore information about working with the orchestrations.



Deploying and Configuring the Process AppTo use the Project OnBoarding Solution, you must deploy and configure the process appas described in the following topics:

• Deploying the Process Apps [page 15]

• Configuring the Orchestrations [page 16]

• Using aespwebservices71 [page 17]

• About Custom JavaScripts [page 31]

• Setting Endpoint Authorization [page 32]

• Assigning User Roles [page 33]

• Populating SharePoint Servers Table [page 33]

Deploying the Process AppsTo deploy either Project OnBoarding or Configuration Process App:

1. Import the file into SBM Composer:

a. In SBM Composer, open the main menu and select Import from File. TheImport Process App Blueprint dialog box opens.

b. Browse to the .msd file and click Open.

2. If desired, you can make modifications to the orchestrations or other parts of theprocess app.

Tip: Deploy the process app without modification before attempting tochange the orchestrations. This enables you to test the basic configurationand to setup required user accounts with the proper permissions. Then,when you attempt to modify the orchestrations you can ensure that yourbasic setup is configured correctly. See Configuring the Orchestrations[page 16] and About Custom JavaScripts [page 31] for more information.

3. Validate and Publish the process app from SBM Composer. This publishes theprocess app to the repository.

4. In Application Repository, deploy the process app to your environment, setting theendpoints for the aespwebservices71 and aewebservices71.

5. Set the authentication for the endpoints as described in Setting EndpointAuthorization [page 32] and then redeploy the process app.

Important: If you do not redeploy the process app after setting theauthentication, you will see the following error when the orchestration isgoing to run:

Error occurred during Web service invocation: SOAP Fault Code:ns1:SOAP Fault String: The error occurred during the executionof the orchestration workflow.


Validation ErrorsIf you receive the following validation errors when attempting to deploy either ProjectOnBoarding or Configuration Process App:

• A sub-field could not be found. Select a valid or different sub-field.

• A related table could not be found. Select a valid or different related table

The problem could be an out-of-date Global Application or Global Process App. This canoccur when you performed an upgrade to SBM 2009 R3 or later and you have not updatedthe Global Application in your repository.

The solution is to use Application Repository to export the Global Application or GlobalProcess App to the repository again. The export does not remove any of the changes thatyou have made to the Global Process App, but it will get the two extra tables into therepository. This will fix the reference errors and you should no longer see the validationerrors.

Configuring the OrchestrationsThe Project OnBoarding Solution and Configuration Process App contain the followingorchestrations:

• CreateSite

• CreateProject

• ExistingProject

• ExistingSites

Important: When using NTLM, you must enter credentials for the orchestrationto run under. The credentials are entered under auth in the Data Mappingsection of the orchestration. The credentials must be for an SBM account whichhas Managed Administrator privileges and access to the pertinent tables in SBM.If you are using single sign-on (SSO), you do not have to add log in credentials,leave the auth values blank.

The following sections contain specific information about each orchestration.

CreateSiteThe CreateSite orchestration is invoked by the Create SharePoint Site transition to createa SharePoint site.

Note: The SharePoint Site Created transition is invoked automatically whenusers perform the Create SharePoint Site transition. The transition takes you tothe Project Site Pending or Complete Site Only state, depending on whetheryou chose to create a project as well as a SharePoint site.

The CreateSite orchestration requires the passing of the SharePoint User Name andPassword that are used to perform the creation of the site in SharePoint. The usernameand password are stored briefly in the primary item while the orchestration runs. Theorchestration pulls other information directly from the database as you can see in the datamapping section of the aespwebservice71_CreateNConfigSPSite step. TheSPUserColName and SPPassColName are mapped to SHAREPOINT_ADMINISTRATOR_Uand SHAREPOINT_ADMINISTRATOR_P, respectively. If you change the columns of the



primary table for the workflow, you may have to change the value for these inputs in theorchestration.

Since these fields contain confidential information, the orchestration eliminates theSharePoint password from the primary table field after the site has been created. Thepassword is replaced in the End step with xxxx. This prevents others from being able tosee the confidential log in information.

CreateProjectThe CreateProject orchestration is invoked by the Create SBM Project transition to createan project in SBM.

The orchestration first creates the project in SBM and then updates the SharePointProject Servers auxiliary table with the information to link the project with a SharePointsite.

ExistingProjectThe ExistingProject orchestration is invoked by the Select Existing Project transition toassociate an existing project in SBM with the selected SharePoint site.

The orchestration checks to see if an entry exists for the project in the SharePointProject Servers auxiliary table. If the entry already exists, the existing entry isoverwritten. If not, a new entry is created with the information to link the project with aSharePoint site.

Important: If you are not using single sign-on (SSO), you must add log incredentials to each of the orchestrations. The log in credentials are enteredunder auth in the Data Mapping section of the orchestration.

ExistingSitesThe ExistingSites orchestration is invoked by the Select Existing Site transition to choosean existing SharePoint site, and if desired, create an SBMContentType document library inthe existing site.

The ExistingSite orchestration requires the passing of the SharePoint User Name andPassword that are used to gather information on available SharePoint sites and to performthe creation of the document library in SharePoint. The username and password arestored briefly in the primary item while the orchestration runs. The orchestration pullsother information directly from the database as you can see in the data mapping sectionof the aespwebservice71_CreateSiteDocumentLib step. The SPUserColName andSPPassColName are mapped to USER and PASSWORD, respectively. If you change thecolumns of the primary table for the workflow, you may have to change the value forthese inputs in the orchestration.

Using aespwebservices71aespwebservices71 is included with the SBM Connect for SharePoint®. This Web serviceincludes the following operations:

• CreateSiteDocumentLibrary [page 18]

• CreateSPSiteFromTemplate [page 20]

• ExtendExistingDocumentLibrary [page 22]

• GetAllSiteDocumentLibaries [page 23]


• GetSPTemplates [page 25]

• GetVersion [page 27]

• SPDocumentLibraryInfo [page 27]

• SPTemplateInfo [page 28]

• AssociateSPAttachment [page 30]

• UnAssociateSPAttachment [page 30]

CreateSiteDocumentLibraryDescriptionThis service creates a document library and associates it with the SbmDocument contenttype for an existing SharePoint site.

ParametersTip: For detailed information on parameter types, refer to the SBM WebServices Developer's Guide.

Parameter Type Description

auth Auth The Auth type supplies credentials and, optionally, ahost name for licensing. The user ID and passwordcan be specified with HTTP BASIC or WS-SECURITYinstead.

Title (required) string The display title of the document library in SharePoint.

Description(required)

string A description of the content library.

ContentTypeIDStrings(required)

string If empty, the code will associate the site with theSbmDocument content type. In SharePoint, contenttypes are hierarchical, allowing you to extend contenttypes from existing content types.

SPSiteURL string The URL of the SharePoint site where the documentlibrary will be created.

ItemID (required) string The ItemId_TableRecId of the item which containsinformation regarding the SharePoint server.

SPUserColName(required)

string The column name in the primary table where the username for the SharePoint user credential used toconfigure the site in SharePoint is stored.




SPPassColName(required)

string The column name for the password for associatedwith the user in SPUserColName.

ResponseA positive response returns the information for the successfully created document library.A failed call returns a null response.

See SPDocumentLibraryInfo [page 27] for more information on the document library inforesponse.

Here is a sample of a positive response:

<ae:CreateSiteDocumentLibraryResponse><ae:return>

<ae:ID>35</ae:ID><ae:title>Legal Document Library</ae:title><ae:description> </ae:description><ae:ContainsSBMContentType>true</ae:ContainsSBMContentType>

</ae:return></ae:CreateSiteDocumentLibraryResponse>

Usage

The CreateSiteDocumentLibrary call provides a method to create a document library foran existing site in SharePoint.

Faults• The SharePoint user lacks sufficient permission to the SharePoint site.

• The SharePoint Server URL is invalid.

• Database failure.

XMLThe following XML is a snippet of the payload being sent with CreateSiteDocumentLibrary.

<urn:CreateSiteDocumentLibrary><urn:auth>

<urn:userId>admin</urn:userId><urn:password/><urn:hostname>localhost</urn:hostname>

</urn:auth><urn:Title>SBM Document Library</urn:Title><urn:Description></urn:Description><urn:ContentTypeIDStrings>0x010100d31a5999bba047c48c13afae64ca08f8

→</urn:ContentTypeIDStrings><urn:SPSiteUrl>http://sharepointsite:81/site/subsite</urn:SPSiteUrl><urn:itemID>146:1</urn:itemID><urn:SPUserColName>SHAREPOINT_ADMINISTRATOR_U</urn:SPUserColName><urn:SPPassColName>SHAREPOINT_ADMINISTRATOR_P</urn:SPPassColName>

</urn:CreateSiteDocumentLibrary>


CreateSPSiteFromTemplateDescriptionThis service creates a new SharePoint site based on an existing SharePoint template.



auth Auth The Auth type supplies credentials and, optionally,a host name for licensing. The user ID andpassword can be specified with HTTP BASIC or WS-SECURITY instead.

siteName (required) string The name of the site to create in SharePoint.

siteDescription string A description of the site.

templateName(required)

string The name of the site template in SharePoint.

useUniquePermissions(required)

boolean If passed as False, then the site is created usingthe permission model of the parent site or sitecollections locale. If passes as True, the only userwho will be given permissions to the site is the usermaking the Web service call, which is the useraccount found in the auxiliary table.

LCID (required) integer Standard Microsoft locale identifier. For example,English is 1033. If you pass 0, then it will use theparent site or site collections locale identifier.

SPServerID(required)

string The auxiliary table ID of the information regardingthe SharePoint server. In SBM Connect forSharePoint® , this information is stored in theSharePoint Servers auxiliary table.

ItemID (required) string The ItemId_TableRecId of the item which containsinformation regarding the SharePoint server.


string The column name in the primary table where theuser name for the SharePoint user credential usedto configure the site in SharePoint is stored.


string The column name for the password for associatedwith the user in SPUserColName.



ResponseA positive response returns the SharePoint site name, the Site URL, the Parent site, theAdd Users URL, LCID, and the document library info list. A failed call returns a nullresponse.



<ae:CreateSPSiteFromTemplateResponse><ae:return>

<ae:sSPSiteName>samp</ae:sSPSiteName><ae:sSPSiteUrl>http://server/samp</ae:sSPSiteUrl><ae:sSPDocLibName>Shared Documents</ae:sSPDocLibName><ae:sSPParentSiteName>Home</ae:sSPParentSiteName><ae:sSPAddUsersUrl>http://server/samp/_layouts/aclinv.aspx</ae:sSPAddUsersUrl><ae:sLCID>1033</ae:sLCID>

</ae:return><ae:return>

<ae:ID>35</ae:ID><ae:title>Legal Document Library</ae:title><ae:description> </ae:description><ae:ContainsSBMContentType>true</ae:ContainsSBMContentType>

</ae:return></ae:CreateSPSiteFromTemplateResponse>

UsageThe CreateSPSiteFromTemplate call provides a method to create a Web site in SharePointusing a predefined site template.

Faults• The SharePoint user lacks sufficient permission to create the SharePoint site.

• The SharePoint site template is invalid.

• The SharePoint Web site name is invalid.

• The SharePoint Server ID is invalid.


XMLThe following XML is a snippet of the payload being sent with CreateSPSiteFromTemplate.

<urn:CreateSPSiteFromTemplate><urn:auth>


</urn:auth><urn:siteName>sample</urn:siteName><urn:siteDescription></urn:siteDescription>


<urn:templateName>SbmDocumentSite</urn:templateName><urn:useUniquePermissions>false</urn:useUniquePermissions><urn:LCID>1033</urn:LCID><urn:SPServerID>146:1</urn:SPServerID><urn:itemID>146:1</urn:itemID><urn:SPUserColName>SHAREPOINT_ADMINISTRATOR_U</urn:SPUserColName><urn:SPPassColName>SHAREPOINT_ADMINISTRATOR_P</urn:SPPassColName>

</urn:CreateSPSiteFromTemplate>

ExtendExistingDocumentLibraryDescriptionThis service extends an existing document library to associate the SbmDocument contenttype.



auth Auth The Auth type supplies credentials and,optionally, a host name for licensing. Theuser ID and password can be specified withHTTP BASIC or WS-SECURITY instead.

DocumentLibraryID(required) string The ID of the existing document library.

ContentTypeIDStrings string If empty, the code will associate the sitewith the SbmDocument content type. InSharePoint content types are hierarchical,allowing you to extend content types fromexisting content types.

SPSiteURL boolean This the URL of the SharePoint site.

ItemID (required) string The ItemId_TableRecId of the item whichcontains information regarding theSharePoint server.

SPUserColName (required) string The column name in the primary tablewhere the user name for the SharePointuser credential used to configure the site inSharePoint is stored.

SPPassColName (required) string The column name for the password forassociated with the user in SPUserColName.



ResponseA positive response means that the call was successful. A negative response means thatthe document library was not extended. A failed call returns a null response.


<ae:ExtendExistingDocumentLibraryResponse><ae:return>

true</ae:return>

</ae:ExtendExistingDocumentLibraryResponse>

UsageThe ExtendExistingDocumentLibrary call provides a method to extend an existingdocument library in a SharePoint site to associate the SbmDocument content type.

Faults• The SharePoint user lacks sufficient permission.

• The SharePoint Document Library ID is invalid.

• The SharePoint Site URL is invalid.


XMLThe following XML is a snippet of the payload being sent withExtendExistingDocumentLibrary.

<urn:ExtendExistingDocumentLibrary><urn:auth>


</urn:auth><urn:DocumentLibraryID>1</urn:DocumentLibraryID><urn:ContentTypeIDStrings>0x010100d31a5999bba047c48c1

→3afae64ca08f8</urn:ContentTypeIDStrings><urn:SPSiteUrl>http://sharepointsite:81/site/subsite</urn:SPSiteUrl><urn:itemID>146:1</urn:itemID><urn:SPUserColName>SHAREPOINT_ADMINISTRATOR_U</urn:SPUserColName><urn:SPPassColName>SHAREPOINT_ADMINISTRATOR_P</urn:SPPassColName>

</urn:ExtendExistingDocumentLibrary>

GetAllSiteDocumentLibariesDescriptionThis service returns the list of document libraries that exist in a SharePoint site.




auth Auth The Auth type supplies credentials and, optionally, a hostname for licensing. The user ID and password can bespecified with HTTP BASIC or WS-SECURITY instead.

SPSiteURL(required)

string The URL of the SharePoint site.

ItemID(required)

string The ItemId_TableRecId of the item that containsinformation regarding the SharePoint server.


string The column name in the primary table where the user namefor the SharePoint user credential used to configure the sitein SharePoint is stored.


string The column name for the password for associated with theuser in SPUserColName.

ResponseA positive response returns a list of document libraries associated with the SharePointsite. A failed call returns a null response.



<ae:GetAllSiteDocumentLibariesResponse><ae:return>

<ae:ID>a46f530d-20ee-4aa9-ad6a-9c93877f30ed</ae:ID><ae:title>Legal Document Library</ae:title><ae:description> </ae:description><ae:ContainsSBMContentType>true</ae:ContainsSBMContentType>

</ae:return><ae:return>

<ae:ID>b46f530d-20ee-4aa9-ad6a-9c93877f30ed</ae:ID><ae:title>Marketing Document Library</ae:title><ae:description> </ae:description><ae:ContainsSBMContentType>true</ae:ContainsSBMContentType>

</ae:return></ae:GetAllSiteDocumentLibariesResponse>

Usage

The GetAllSiteDocumentLibaries call provides a method to retrieve information all of thedocument libraries associated with a SharePoint site.




• The SharePoint Server URL is invalid.


XMLThe following XML is a snippet of the payload being sent with GetAllSiteDocumentLibaries.

<urn:GetAllSiteDocumentLibaries><urn:auth>


</urn:auth><urn:SPSiteUrl>http://sharepointsite:81/site/subsite</urn:SPSiteUrl><urn:itemID>146:1</urn:itemID><urn:SPUserColName>SHAREPOINT_ADMINISTRATOR_U</urn:SPUserColName><urn:SPPassColName>SHAREPOINT_ADMINISTRATOR_P</urn:SPPassColName>

</urn:GetAllSiteDocumentLibaries>

GetSPTemplatesDescriptionThis service returns the list of SharePoint templates available.


Name Type Description


LCID integer Standard Microsoft locale identifier. For example, English is1033. If you pass 0, then it will use the local identifier ofthe parent site or site collection.

SPServerID(required)

string The auxiliary table ID of the information regarding theSharePoint server. In SBM Connect for SharePoint® , thisinformation is stored in the SharePoint Servers auxiliarytable.

ItemID(required)

string The ItemId_TableRecId of the item that containsinformation regarding the SharePoint server.




string The column name in the primary table where the username for the SharePoint user credential used to configurethe site in SharePoint is stored.


string The column name for the password for associated with theuser in SPUserColName.

ResponseA positive response returns a SPTemplateInfo list, which contains a list of the SharePointtemplates available and the data associated with each template. A failed call returns a nullresponse.

See SPTemplateInfo [page 28] for information contained is an SPTemplateInfo response.


<ae:GetSPTemplatesResponse><ae:return>

<ae:sID>a46f530d-20ee-4aa9-ad6a-9c93877f30ed</ae:sID><ae:sName>WIKI0</ae:sName><ae:sDisplayName>Wiki Template</ae:sSPDocLibName><ae:sDisplayCategory>Description</ae:sDisplayCategory><ae:sDescription>Description of template</ae:sSPAddUsersUrl><ae:sLCID>1033</ae:sLCID><ae:sCustom>false</ae:sCustom><ae:sRootWebOnly>false</ae:sRootWebOnly><ae:sSubWebOnly>false</ae:sSubWebOnly>

</ae:return></ae:GetSPTemplatesResponse>

UsageThe GetSPTemplates call provides a method to gather the template information fromSharePoint.The response shows the available templates and indicates whether thetemplate is designated as Root Website or Sub Website Only.


• The SharePoint Server ID is invalid.


XMLThe following XML is a snippet of the payload being sent with GetSPTemplates.

<urn:GetSPTemplates><urn:auth>

<urn:userId>admin</urn:userId><urn:password/>



<urn:hostname>localhost</urn:hostname></urn:auth><urn:LCID>1033</urn:LCID><urn:SPServerID>146:1</urn:SPServerID><urn:itemID>146:1</urn:itemID><urn:SPUserColName>SHAREPOINT_ADMINISTRATOR_U</urn:SPUserColName><urn:SPPassColName>SHAREPOINT_ADMINISTRATOR_P</urn:SPPassColName>

</urn:GetSPTemplates>

GetVersionDescriptionThis service returns the SBM version number.

ArgumentsNone.

ResponseA string is returned, showing the version number. For example:

<ae:GetVersionResponse><ae:return>Version 2010 R1.200</ae:return>

</ae:GetVersionResponse>

UsageNone.

FaultsNone.

XMLThe following XML shows the payload that is sent with GetVersion.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"xmlns:urn="urn:sbmappservices72">

<soap:Header/><soap:Body>

<urn:GetVersion/></soap:Body>

</soap:Envelope>

SPDocumentLibraryInfoDescriptionThe SPDocumentLibraryInfo holds the name and other information about the documentlibrary in SharePoint. The SPDocumentLibraryInfo type parameters are listed below.


Parameters


ID string This is the unique identifier for the SharePointdocument library.

Title string The title of the document library shown inSharePoint.

Description string The description of the document library.

ContainsSBMContentType boolean A true response means that the documentlibrary contains the SbmDocument content type.false means that that the document library doesnot contain the SbmDocument content type.

UsageThe SPDocumentLibraryInfo type holds the ID, title, description, and whether theSbmDocument content type exists in the document library. You can useGetAllSiteDocumentLibaries [page 23] to retrieve the document library data for alldocument libraries.

XMLThe following XML snippet shows the SPDocumentLibraryInfo type in the return element ofthe CreateSiteDocumentLibrary response.

<ae:CreateSiteDocumentLibraryResponse><ae:return>

<ae:ID>a46f530d-20ee-4aa9-ad6a-9c93877f30ed</ae:ID><ae:title>Legal Document Library</ae:title><ae:description> </ae:description><ae:ContainsSBMContentType>true</ae:ContainsSBMContentType>

</ae:return></ae:CreateSiteDocumentLibraryResponse>

SPTemplateInfoDescriptionThe SPTemplateInfo holds the name and other information about the templates availablefor site in SharePoint. The SPTemplateInfo type parameters are listed below.

Parameters


ID string The ID for the Web template that is unique within the sitedefinition.




Name string The name of the Web template.

DisplayName string The name of the template shown in SharePoint.

DisplayCategory string The category in which the Web template will appear inthe UI of SharePoint Foundation, for example,Collaboration, Meetings, or some custom name.

Description string The description of the template.

LCID string Microsoft Locale Identifier.

Custom boolean TRUE means that the Web template was created by anend user. FALSE means the template is a configuration inSharePoint.

RootWebOnly boolean TRUE specifies that the site created from theconfiguration exists only as the root Web site in a sitecollection.

SubWebOnly boolean TRUE to specify that the site created from theconfiguration exists only as a subsite within a sitecollection.

UsageThe SPTemplateInfo type hold data associated with a SharePoint template. You can useGetSPTemplates [page 25] to retrieve the template data for all templates.

XMLThe following XML snippet shows the SPTemplateInfo type in the return element of theGetSPTemplate response.

<ae:GetSPTemplateResponse><ae:return>

<ae:sID>a46f530d-20ee-4aa9-ad6a-9c93877f30ed</ae:sID><ae:sName>WIKI0</ae:sName><ae:sDisplayName>Wiki Template</ae:sSPDocLibName><ae:sDisplayCategory>Description</ae:sDisplayCategory><ae:sDescription>Description of template</ae:sSPAddUsersUrl><ae:sLCID>1033</ae:sLCID><ae:sCustom>false</ae:sCustom><ae:sRootWebOnly>false</ae:sRootWebOnly><ae:sSubWebOnly>false</ae:sSubWebOnly>

</ae:return></ae:GetSPTemplateResponse>


AssociateSPAttachmentDescriptionAttaches an existing SharePoint document to an existing SBM item.

This Web service returns success or failure.



auth Auth The Auth type supplies credentials and, optionally, ahost name for licensing. The user ID and passwordcan be specified with HTTP BASIC or WS-SECURITYinstead.

item(required)

ItemIdentifier The SBM item with which you want to associate aSharePoint document as an attachment.

fileAttachment FileAttachment The details pertaining to the file attachment.

Note: This Web service does not workwith the actual attachment content. Thecontent is already stored in SharePoint.AssociateSPAttachment simply "registers"(identifies as a file attachment) adocument that is stored in SharePoint.

options Options Holds name/value pairs for future arguments.

fileSize integer File size of attachment in bytes.

version string SharePoint version

UnAssociateSPAttachmentDescriptionDetaches an existing SharePoint document from an existing SBM item.

This Web service returns success or failure.






AttachmentID(required)

string This is the internal TS_ID of the attachment from theTS_ATTACHMENTS table.

options Options Holds name/value pairs for future arguments.

About Custom JavaScriptsThe Project OnBoarding Solution uses a widget designed in JavaScript.

The following JavaScripts are used throughout the Project OnBoarding Solution:

• Page Formatting - Sets the styles of various elements on the forms. ThisJavaScript is called by all of the custom forms.

• Transitions - Hide Buttons - Hides the OK and Cancel button an a transitionform. This JavaScript is included in the custom transition forms.

• State - Button Clicks - Invokes the Update or Delete transitions when the links areclicked in the form. This JavaScript is used in all of the state forms.

• State - HideShow SBM Admin - Hides the SBM Administrator field when theitem does not require the creation of a project. This JavaScript is used in all of thestate forms.

• State - Hide Show Comments -Hides the Status Log in the item. This JavaScript isused in all of the state forms.

In addition to the common JavaScripts listed above, the following custom forms haveadditional JavaScript cotained in an HTML/JavaScript region placed on the form:

New SiteThe JavaScript on the New Site form validates that the entered information for theSharePoint site is valid.

The script makes sure that the site does not already exist and displays the message onthe form.This script makes use of the Flex widget available with SBM Connect forSharePoint®.

Existing SiteThe JavaScript on the Existing Site form gathers a list of existing sites in SharePoint anddisplays the items in drop-down list on the form.

The script uses the Flex widget available with SBM Connect for SharePoint® .


New ProjectThe JavaScript on the New Project form gathers a list of projects in SBM, and it allowsyou to select from the available projects, under which the new project will be created.

The script also validates the name of the project entered to ensure that it meets thenaming requirements found in SBM.

Setting Endpoint AuthorizationThe endpoint for aespwebservices71 is created automatically when you deploy eitherProject OnBoarding or Configuration Process App. You must change the Authenticationmode for the endpoint to Basic to work with NT Windows Challenge response. See SettingAuthentication Mode [page 41] for information on the different authorizationconfigurations.

Note: Basic authentication is required when using NT Windows ChallengeResponse (NTLM). SBM Connect for SharePoint® is designed to be used withNTLM.

To change the endpoint authentication to Basic for aespwebservices71:

1. In Application Repository select Environments.

2. On the Environments tab, click the environment you want to change.

3. Select the Endpoints tab.

4. Edit the aespwebservices71 endpoint.

5. Set the following values:

Field Description

Authentication Select Basic authentication.

Important: The HTTP Basic credentials set inApplication Repository for an endpoint override Basiccredentials that are set in orchestration workflows. Forexample, if username joe and password pwd arespecified in the orchestration, but ApplicationRepository specifies HTTP Basic with differentcredentials, the Application Repository credentials areused instead. If you do not want to override thecredentials specified in the orchestration workflow,select None in Application Repository.

User nameand Password

Enter an SBM user that has Managed Administrator privileges.

6. Click Save.



7. Redeploy your process app, either Project OnBoarding or Configuration Process App.

Important: If you do not redeploy the process app after setting theauthentication, you will see the following error when the orchestration isgoing to run:


For more information on setting endpoints, refer to the SBM Application Repository Guide.

Assigning User RolesThe following roles are available with the Project OnBoarding Solution. Assign users toroles using the SBM Application Administrator.

• POB Project Manager – This role is for users who will oversee the requestssubmitted into the workflow. This user is the owner the request in the ApprovalPending state and chooses whether to approve or reject the request. This user alsohas the ability to submit and view all items.

• POB SBM Administrator – This role is for users who will be responsible in choosingto create an SBM project. They are owners of the request in the Project CreationPending state. This user also has the ability to submit and view all items.

Important: The users in the POB SBM Administrator and the POBSharePoint Administrator roles need the privileges to view, update, andsubmit items in both the SharePoint Servers and SharePoint ProjectServers auxiliary tables. Remember to give the users these permissions. Ifnot, the users will receive an error when trying to create a SharePoint siteor an SBM project.

• POB SharePoint Administrator – This role is for users who will be responsible forapproving the creation of sites in SharePoint. This user must enter his or herSharePoint log in credentials on the Create SharePoint Site or New Site withProject transitions in order for the SharePoint sites to be created. This user also hasthe ability to submit and view all items.

• POB Submitter – This role is for users who submit requests for the creation ofprojects and SharePoint sites.

Populating SharePoint Servers TableThe SBM Connect for SharePoint® uses two auxiliary tables, SharePoint Servers andSharePoint Project Servers.

Important: The SharePoint Servers table must be populated before usingeither Project OnBoarding or Configuration Process App.

SharePoint Servers Auxiliary TableThe SharePoint Servers auxiliary table contains entries for the SharePoint servers wheresites will be created for relating with SBM projects. Administrators must populate theSharePoint Servers auxiliary table before you using the Project OnBoarding process app.


To populate the table, click the Search link on the navigation pane, , and then clickManage Data. Select the SharePoint Servers table and create a new item. Populate theitem with the data as described.

Note: Your administrator must have assigned the correct privileges to you inorder to access and write to this table. See Assigning User Roles [page 33] formore information.

Each SharePoint Servers item defines the Title, Site URL, User Name, and Password fora particular SharePoint URL:

• The Title is used to clarify to other administrators what this SharePoint server isused for, such as Sales or Human Resources.

• The Site Url is the Site Collection root or high level SharePoint folder under whichSharePoint sites will be created. For example:

http://SharePointservername:port/sites/ImageBuilder

• The User Name and Password are for a SharePoint account which will be used tocreate the folders in SharePoint. This user is called the SharePoint ProxyAdministrator in this document. The SharePoint Proxy Administrator needs thepermissions in SharePoint to add folders and add/edit/delete documents. Since thepassword for the user is stored in the database, the password should be non-expiringto prevent problems if the user's password expires. Note that this user will also beused when attachment actions are performed in SBM by an anonymous user.

Note: The creation of the SharePoint site is performed underneath the username and password entered during the workflow.

SharePoint Project Servers Auxiliary TableThe SharePoint Project Servers auxiliary table contains the relationship informationbetween a SharePoint site and an SBM project. The table is populated automatically afterthe selection a project during the Project OnBoarding or Configuration Process Appworkflows.

Important: The SharePoint Project Servers table should not be populatedmanually.

Using the Project OnBoarding SolutionThe Project OnBoarding Solution does the following actions. See the topics for moreinformation:

• Creating a SharePoint Site [page 35]

• Associating with an Existing SharePoint Site [page 37]

• Creating a New Project [page 38]

• Associating with an Existing Project [page 39]



Creating a SharePoint SiteA site is created in SharePoint when the Create SharePoint Site transition is invokedduring the Project OnBoarding workflow.

You will have to select the SharePoint URL where the site will be created. The list ofURLs are the items that you have submitted in the SharePoint Servers auxiliary table.

You can select a SharePoint Template Name from the list of available templatesretrieved from the SharePoint server. The SharePoint site will be created based on theselected template. Refer to the Microsoft SharePoint documentation for more informationon SharePoint Site Templates.

Restriction:Not all SharePoint template types are supported.

• The Collaboration templates are supported. These include Team Site,Blank Site, Document Workspace, Wiki site, Blog, and all custom templatesthat created from these templates.

• Meeting Workspace templates are not support.

• Enterprise and Publishing templates are supported when you enable thePublishing feature for your site. All custom templates created from thesebase templates are supported.

The SharePoint Administrator ID and password is used to create the site in SharePoint.This user needs the appropriate permissions in SharePoint to create the site.

Selecting Yes for Inherit All Users from Parent Site will automatically add the userpermissions from the parent site to the subsite that you are creating. If you select No,only the administrator ID used to create the site will be given access permissions to thesite. The administrator will need to assign permissions to users to access the site.

Create New Document Library allows you to decide whether to create a documentlibrary in the new Web site. A document library is required for storing attachments fromSBM items. You must select Yes if the SharePoint Template that you selected does notcontain a document library. This will create a document library called SBM Documents inthe new site. If your selected template contains a document library, you can choose oneof these document libraries to store your SBM attachments.

Note: The SBM Documents library will be associated with the SbmDocumentContentType. This will be the default content type for the attachments that areadded to the library.

Site Name LimitationsNote the following limitations on site names, which reflect restrictions imposed both bySharePoint and by the Web services used by the integration:

• You cannot create site names using the following characters: \ / : * . ? " < > |# { } % & <TAB>" ~ +

• Site names, subsite names, and site group names cannot begin with an underscore(_) character.


Troubleshooting Creating a SiteSharePoint Template List Does Not PopulateThe SharePoint Template list populates after choosing your SharePoint URL. TheSharePoint URL must be a valid, including:

• The SharePoint cannot be a root site.

• The user name and password associated with the site must have valid values.

See Populating SharePoint Servers Table [page 33] for details.

Orchestration Fails to Run

Unable to execute transition SharePoint Site Created (auto) on Project Request000207. One or more fields are invalid.(TTwrnIDS_F3_MSG_TRANSITION_INVALIDFIELDS

This message can be the result of the orchestration not completing. Possible causesinclude:

• The SharePoint user account that you entered on the form does not have thepermissions to create a SharePoint site.

• The endpoints have not been bound correctly. After you have set the basicauthentication information for the endpoints, the Project OnBoarding must beredeployed.

• The SbmDocument Content Type has not been enabled.

Tip: You can troubleshoot orchestration issues by increasing the debug loggingin Application Repository, and then looking at the results in SBM Composer. Thisallows you to see where the failure is occurring in the orchestration, which willhelp you to debug the problem. For example, if the orchestration fails as shownin the following picture, then the problem would not be with the permissionsthat the Web service since the first call ran correctly:


Possible causes for the preceding error message include:

• The SbmDocument Content Type has not been enabled. See Configuring theSbmDocument Content Type [page 9] for details.

• User account specified under SharePoint Server table does not have the necessarypermissions in SharePoint to create a site or document library. See PopulatingSharePoint Servers Table [page 33] for details.



• Incorrect user account specified for your orchestrations. Verify that the user accountthat the Web Service is being authenticated under is a valid SBM user and has thenecessary permissions. Depending on your authentication method, either check thataccount specified for the aespwebservice71 or auth user account specified for theorchestration as described in Configuring the Orchestrations [page 16].

Associating with an Existing SharePoint SiteAn existing SharePoint site is used to associate with a project when the Select ExistingSite transition is invoked during the Project OnBoarding or Configuration Process Appworkflow.

On the Existing Site form, you will select the SharePoint URL, SharePoint Site Name,and SharePoint DocLibrary Name of the SharePoint site to relate to the SBM project.

The SharePoint site must have a document library associated with it. If you are selecting asite without a document library, select Yes for Create New Document Library. Forexample, if your existing SharePoint site was created with the Wiki site template, it willnot have a document library associated with it when it is created. You must select tocreate a new document library which will create a document library with theSbmDocument Content Type set as the default.

The settings for the document library determine the functionality available from SBM. Forexample, if you require that a file is checked out for editing, you cannot edit a file fromSBM unless you checkout the file first. Similarly, if versioning is not enabled for theSharePoint document library, only one version will display for the file when you select toview the versions of the file from SBM.

Restriction:Not all SharePoint site templates are supported. Only sites that are createdusing supported site templates:

• The Collaboration templates are supported. These include Team Site,Blank Site, Document Workspace, Wiki site, Blog, and all custom templatesthat created from these templates.

• Meeting Workspace templates are not support.

• Enterprise and Publishing templates are supported when you enable thePublishing feature for your site. All custom templates created from thesebase templates are supported.

Troubleshooting Creating a SiteSharePoint Site Name List Does Not PopulateThe SharePoint Template list populates after choosing your SharePoint URL. TheSharePoint URL must be a valid, including:

• The SharePoint cannot be a root site.

• The user name and password associated with the site must have valid values.

See Populating SharePoint Servers Table [page 33] for details.


Orchestration Fails to Run


Possible causes for the preceding error message include:

• The SBMDocument ContentType has not been enabled. See Configuring theSbmDocument Content Type [page 9] for details.

• User account specified under SharePoint Server table does not have the necessarypermissions in SharePoint to create a site or document library. See PopulatingSharePoint Servers Table [page 33] for details.

• Incorrect user account specified for your orchestrations. Verify that the user accountthat the Web Service is being authenticated under is a valid SBM user and has thenecessary permissions. Depending on your authentication method, check either theaccount specified for the aespwebservice71 or the auth user account specified for theorchestration as described in Configuring the Orchestrations [page 16].

Creating a New ProjectA SharePoint site is associated with a new SBM project when the Create SBM Projecttransition is invoked during the Project OnBoarding workflow.

When creating a new project, you will be prompted for the new project information suchas solution name, base project, and the name of the new project.

Note: When created for use with this process app, project names must be nolonger than 32 characters and cannot contain any of the following characters: ~` ! @ # $ % ^ & * ( ) . _ + - =Tip: The form contains a script to check whether the entered project name isavailable. Tab out of the Project Name field to activate the script.

Note: After the project is created, you can change user privileges for theproject using the SBM Application Administrator.

The project will be created either using the credentials of the user performing thetransition (Single Sign-On) or using the credentials entered in the orchestration. An entryfor the new project will be added to the SharePoint Project Servers auxiliary table,associating the project with the SharePoint site created earlier.



Associating with an Existing ProjectA SharePoint site is associated with an existing SBM project when the Select ExistingProject transition is invoked during the Project OnBoarding or Configuration Process Appworkflow.

Important: You can only associate an SBM project with one SharePoint site.Multiple relationships are not allowed. Do not select to associate an existingproject that has already been associated to another SharePoint site.

Important: If you move a project from one SharePoint site to another afteruploading file attachments, you can no longer work with those attachments.Therefore, it is recommended that you avoid moving projects that have alreadybeen associated SharePoint sites. If you have moved a project and can nolonger access the attachments, the workaround is to upload the attachmentsagain; however, there might then be duplicate entries in the SBM item.

When selecting an existing project to a SharePoint site, existing attachments for items inthe project will not be moved to the document library in the SharePoint site. Theassociation will only affect future attachments.

Using the Configuration Process AppThe Configuration Process App does a subset of the actions that you can perform in usingthe Project OnBoarding Solution.

See these topics for more information for the actions available in Configuration ProcessApp:

• Associating with an Existing SharePoint Site [page 37]

• Associating with an Existing Project [page 39]

Tracking Relationships Between Sites and ProjectsThe Project OnBoarding Solution contains the SharePoint Sites report, which enables youto track which SBM project is related to which SharePoint site. This report lists therelationships between SharePoint sites and SBM projects, as well as who approved thecreation of each project.

To run the report, perform the following steps:

1. In the Work Center, select the Project OnBoarding application.

2. Select Reports.

3. Find and run the SharePoint Site Audit Listing report.


Chapter 4: Storing SBM Attachments inSharePoint

Once an SBM project and a SharePoint Project site are correlated using ProjectOnBoarding, users can create, view, and update documents on SharePoint sites from itsbusiness process applications as well as from Microsoft SharePoint directly. Thesedocuments are tied to a business process, thus providing necessary context.

Note: You can only store attachments for primary items in SharePoint. Thestoring of attachments for auxiliary items is not supported.

You can see data about the attachment from either interface. For example, from withinSBM, the file version information is displayed. From within SharePoint, you have ahyperlink to the item that the file is attached to.

The following topics describe how to store Solutions Business Manager attachments inSharePoint.

• Setting Authentication Mode [page 41]

• Limitations with Attachments [page 42]

• Uploading Attachments [page 43]

• Working with Attachments [page 45]

• Editing Attachments [page 46]

• Modifying SBM Connect for SharePoint® Strings [page 46]

Setting Authentication ModeMost Microsoft SharePoint Servers are configured to use NT Windows Challenge Response(NTLM) to authenticate their users. SBM Connect for SharePoint® has been designed touse NTLM as well. NT Challenge Response relies on the Windows network security systemfor SBM authentication. Using NTLM eliminates many of the log in screens that users willexperience when they are attaching items that will be stored in SharePoint.

Both SBM and SharePoint Use NTLMThe optimal configuration is to have both SharePoint and SBM configured to use NTChallenge Response.

In addition, you must configure the endpoints for aespwebservices71 to use Basicauthentication as described in Setting Endpoint Authorization [page 32].

See the SBM System Administrator Guide for information for setting up SBM to use NTLM.


SBM Uses SSO and SharePoint Uses NTLMThough not optimal, you can use SBM with Single Sign-On enabled. This approach willrequire that end users enter their User ID and Password when they attempt to add oraccess attachments to SBM items.

In addition, you must configure the endpoints for aespwebservices71 to use Single Sign-On authentication. See Setting Endpoint Authorization [page 32] for information on howto set Authorization mode.

Note: If the user has enabled their browser cache, a user's will not be promptedto log in consecutive interaction with SharePoint. Otherwise, they will beprompted for every interaction.

Other ConfigurationsYour SBM installation could also be configured to use LDAP or internal SBM authentication.Similar to using SSO, these approaches will require that end users enter their User ID andPassword when they attempt to add or access attachments to SBM items.

In addition, you must configure the endpoints for aespwebservices71 to use Basicauthentication as described in Setting Endpoint Authorization [page 32].

See the SBM System Administrator Guide for information for setting up SBM to use NTLM.

Limitations with AttachmentsWhen storing attachments in Microsoft SharePoint, there are additional limitations whenattaching files and the SBM items which the files are attached to.

Restriction:

Note the following prerequisites for storing SBM attachments in SharePoint:

• Your SharePoint installation must use NTLM for authentication, which mustalready be configured.

• SharePoint must be available on the same network as SBM (though it canbe on a different machine).

• WSS (Windows SharePoint Services) must be accessible from the SBMinstallation.

• All SBM attachments will be stored in SharePoint for projects that arelinked to SharePoint site.

• A proxy SharePoint administrator will be granted privileges to performcertain tasks in SharePoint on behalf of SBM.

• For the ability to version files, versioning must be enabled for thedocument library where the attachments are stored.

Limitations on SBM FunctionalityThe following functionality in SBM is reduced or limited when you store attachments inSharePoint:

Chapter 4: Storing SBM Attachments in SharePoint


• When you perform a copy transition of a SBM item between two projects that areassociated with two distinct SharePoint servers, the attachments will not be copied.

• When you move an item with attachments between the two projects that areassociated with two distinct SharePoint servers, the attachments will not be copiedautomatically to the other SharePoint server. You must add the attachmentsmanually.

• If your network performance is slow, the size of the file that you can upload will belimited. Larger files will time out before they can be attached.

Limitations on File NameMicrosoft SharePoint has a limitation for names of files that are stored in SharePoint.These limitations must be followed when you attach files to items in SBM.

The limitations include:

• Names cannot contain the following characters: " # % & * : < > ? \ / { | } ~

• Names cannot be longer than 128 characters.

• Names cannot contain consecutive periods.

• Names cannot end or start with a period.

Limitations on Microsoft SharePoint FunctionalityThe actions that you can perform on the attachments are similar to the actions that canbe performed directly from SharePoint. There are a few changes to the functionality:

• When performing a checkin from SBM, the checkin flag will be removed inSharePoint; however your file will not automatically be uploaded.

Uploading AttachmentsUploading a document into SharePoint places the new version of the document into theSharePoint document library.

Important: You can only upload attachments to an item using Work Center. Ifyou upload a file into document library within SharePoint, the file will not beattached to the item in SBM.

To upload new versions of documents:

1. In Work Center, display the item.

2. Click Actions | Add Files link which will allow you to select the attachment toupload.

The File Attachment dialog displays where you select upload information, such as:

• Display name

• Whether to show file as an image (applies to SBM )

• Mark the file as Unrestricted (applies to SBM )

• Mark the file as a new version of existing file (applies to SharePoint)


• Add a version comment (applies to SharePoint)

• Check out after upload sets the Check Out flag in SharePoint so that other userscannot upload a new file until after you have checked in the file (applies toSharePoint)

There are naming restrictions when uploading files into SharePoint. See Limitationswith Attachments [page 42] for details.

Note: If using a Web browser other than Microsoft Internet Explorer®, youmay be prompted to log in. This depends on your browser and networksecurity configurations. Refer to your browser's documentation forconfiguring it to pass the necessary credentials to SharePoint to preventhaving to log in everytime.

3. The uploaded file is added to the SharePoint Document Library. The file is stored inthe Document Library of the SharePoint site which is associated with the SBMproject. The file is placed in a subfolder, which corresponds to the particular item towhich you have attached the file.

Note: If you are accessing SBM as an anonymous user, the proxy userthat is entered in the SharePoint Servers auxiliary table will be used toupload the content. This user is required because SharePoint requires avalid user to upload content.

4. After the file is attached to an item, additional icons appear next to the attachmentin SBM. These icons allow you access to the versioning functionality from SharePointsuch as check in and check out.

See Limitations with Attachments [page 42] for information on limitations when workingfrom SharePoint.

Troubleshooting - UploadThe following are some error messages that can occur when uploading a document inSharePoint:

• Lock Info Not Found - This error message can occur because the user accountentered in the SharePoint Servers auxiliary table does not have the necessarypermissions to SharePoint document library, such as the permission to create afolder. To fix the error, either change the permissions for this user in SharePoint orchange the user account entered in the auxiliary table. See Populating SharePointServers Table [page 33] for details.



Working with AttachmentsAfter you have linked your SBM project with a SharePoint site, the files that you attach toitems in SBM will be stored in SharePoint. These documents are versioned usingSharePoints documentation repository functionality. You can check out and check in thedocuments using either SharePoint or Work Center.

Important: If you move a project from one SharePoint site to another afteruploading file attachments, you can no longer work with those attachments.Therefore, it is recommended that you avoid moving projects that have alreadybeen associated SharePoint sites. If you have moved a project and can nolonger access the attachments, the workaround is to upload the attachmentsagain; however, there might then be duplicate entries in the SBM item.

When working with the documents from Work Center, attached documents will haveadditional icons to perform SharePoint actions such as check in and check out. Thefollowing table describes the icons and which actions they perform:

Table 1.

Icon Action

Edit this attachment. If you have required that files must be checked outbefore editing in SharePoint, you are prompted to check out the file. SeeEditing Attachments [page 46] for details on editing attachments.

Deletes this version of the attachment.

Send an email about this attachment to another SBM user.

[number] If you have enabled attachment numbering in SBM, the number of theattachment will appear. This number is given from SBM and notSharePoint. It has no relation to versioning.

View the versions of the attachment stored in SharePoint. Versioning mustbe enabled for the Document Library to allow for multiple versions of thefile.

Important: The version information of an attached file refresheswhen you open the page. If your page was opened before anupdate was made to the file in SharePoint or from SBM, theversion history will not display the change. You must click theRefresh button to update the data.

Check out the attachment for editing.

Check in an edited attachment. On check in, you can enter a comment andchoose to check in either Major Versions or Minor Version of the file. Seethe SharePoint documentation for information on Major and Minorversions.

Undo the check out of the attachment.


Icon Action

Refreshes version history data from SharePoint.

See Limitations with Attachments [page 42] for additional information on limitations whenworking from SharePoint.

Editing AttachmentsWhen you edit attachments in Work Center, the Modify File Attachment dialog boxappears and presents you with different options for editing the file.

The following options are available:

Options Result

[Filename]textbox

Change the display name for the file in SBM.

Show file asimage

Display the file as an image in SBM.

Unrestricted Determines who can view the attachment in SBM.

Choose File Click this button to choose a new file to upload into SharePoint. The filewill be uploaded with the name as the existing file in SharePoint. Toupload the file with a new name, use Add File.

Check outfile afterupload

Sets the Check Out flag in SharePoint.

VersionCommenttextbox

The comment to add to this version of the checked file for SharePoint.

Note: If Require Check Out is set in the Versioning Settings of your documentlibrary and you use the Edit button to upload a new revision without firstchecking out the file, a confirmation that the file has been uploaded appears;however, the new revision will not be uploaded. To work around this problem,use check in/check out or remove the checkout requirement from the documentlibrary.

Modifying SBM Connect for SharePoint® StringsYou can change the wording that appears in the Add File dialog box by editing the Flexwidget properties file. To change the wording, you must edit the strings that are containedin the SPFlex.properties file. The file is found in the following directory:installDir\SBM\Application Engine\bin\flex\locale\en_US



Before the changes will display in the dialog, you must also add the .properties MIMEtype to your IIS Web Server. Note that this procedure is performed once, and then allsubsequent changes to the SPFlex.properties file are incorporated automatically.

To add the .properties MIME type:

1. Launch your IIS administrator on your SBM Server.

2. Select to edit the MIME Types for your SBM Web site.

3. Add .properties as text/plain.

4. Restart your IIS server.


Chapter 5: Raising Events in SharePoint

The SBM Web Services for SharePoint® are custom Web services that raise events foractions that occur in SharePoint. You can use these events to trigger actions in SBM.

To use the SBM Web Services for SharePoint®, you must have them installed on theSharePoint server as described in Chapter 2: Installation [page 7].

The following topics describe use cases for events and how to use the event:

• Tracking Document Changes [page 49]

• Importing Event Definition [page 51]

Tracking Document ChangesUsing the ItemUpdated event, you can be notified when items are updated inSharePoint. This allows you to track changes to documents that are stored in SharePoint.

The following use case describes how this can be implemented with a business process toapprove the documents stored in SharePoint.

Tip: This use case is demonstrated in the Contract Approval Process App, whichis available in SBM Connect for SharePoint®. Deploy the process app to a testserver where you can use the process app to see how the eventing can be usedin a simple workflow.

Requiring Approval on Changed DocumentsNote: This use case assumes that you have configured your SBM project tostore attachments in SharePoint and that the SbmDocument Content Typehas been configured appropriately.

In this use case, you use SBM to track the approval process of your contracts and you useSharePoint as a place to store the contracts.

New contacts are submitted for approval by attaching them to a request in SBM. Thedocuments are reviewed and then the associated request is either approved or rejected.The requests move to the Bid Accepted or Bid Rejected state, which tells the state ofthe attached document.

If a contract is updated when its request is one of these states, the request isautomatically progressed to the re-review state. Approvers are notified that the documentis changed and requires review. This automatic process ensures that all contracts arereviewed before being considered approved moved to the Bid Accepted state.

Note: In the Contract Approval Process App, the form displays the user thatmade the change to the document in SharePoint. For example, the top of theform will say: You need to re-review the item as Joe Manager hasupdated document in SharePoint. .

The Contract Approval Process App demonstrates this process. The Contract ApprovalProcess App workflow is shown as follows:


• Bid Review - Where new requests for contract approval are waiting to be approvedor rejected.

• Bid Accepted - Approved requests move to this state.

• Bid Rejected - Denied requests move to this state.

• Re-Review - Where requests for contracts that have been changed are waiting forre-approval or rejection.

The DocEventingWorkflow orchestration in the Contract Approval Process App is triggeredwhen an ItemUpdate event is received from SharePoint. The orchestration checks to see ifthe updated item's attached request is in the Bid Accepted state. If it is, then the ReOpentransition is preformed, moving the request back to the Re-Review state.

Tip:

Currently, you cannot use the ItemUpdated event to add the document to anitem as an attachment. A SBM Web service does not exist which would allowyou to perform the action.

Since the event returns information about the item, you could add informationabout the new document as a note or link to the existing request, but not as anattachment.

Deploying and Configuring Contract Approval ProcessAppTo deploy and configure the Contract Approval Process App:

1. Import the Contract Approval Process App into SBM Composer.

2. Deploy the Contract Approval Process App.

3. The DocEventingWorkflow orchestration calls aewebservice71. The user accountthat Web service runs under needs read and write access to the Contract ApprovalProcess App project. You can specify this user account underneath

Note: You can set also select a specific user account specific to theContract Approval Process App by specifying the account username andpassword in the auth values for the DocEventingWorkflow orchestration.Set the values to a SBM user with Managed Administrator privileges andread/write access to the project.

4. Using either Project OnBoarding or Configuration Process App, create or link aContract Approval Process App project to a SharePoint site.

5. Test the configuration:



a. Submit an item into your Contract Approval Process App project. Include anattachment on the item.

b. Approve the item. It will move to the Bid Accepted state.

c. Edit the attachment by clicking and choose a new version of the file. The itemshould automatically transition to the Re-Review state.

Note: You could also edit the file directly in SharePoint. When the item isedited, the item will move to the Re-Review state.

6. Troubleshooting. If the item did not transition to the Re-Review state, view theerror log for the orchestration in SBM Composer. This will tell you where the problemresides. For example, if the orchestration failed at the first Web service step, youmay have entered an invalid user account for the auth parameters or your endpointis configured incorrectly.

Importing Event DefinitionWhen you are creating an orchestration to work with the events raised from SharePoint,you use the SharePoint event definition included with SBM Connect for SharePoint®.

The files included with SBM Connect for SharePoint® areSbmDocumentAlfServiceFlow.wsdl, SbmDocumentAlfEventBase_1.xsd, andSbmDocumentEventExtensions.xsd.

When creating an orchestration workflow, you should choose to import theSbmDocumentAlfServiceFlow.wsdl. The other xsd files must be located in the same folderfor the import to succeed. After importing the wsdl, you can map the UpdatedItem eventto your orchestration.

Refer to the Contract Approval Process App included with SBM Connect for SharePoint®

for an example of how the event elements must be mapped.

Tip: For information on importing a event definition and mapping anorchestration workflow to an event definition, refer to the SBM Composer Guide.


Chapter 6: Working with the SBM WebParts

The following topics describe how to use Web parts to create a portal into your SBMServer. This section describes how to use both basic SharePoint Web parts and the SBMWeb parts.

• Creating a Collaborative Web Site [page 53]

• Using Default SharePoint Web Parts [page 54]

• About the SBM Web Parts [page 55]

Creating a Collaborative Web SiteUsing the SBM Web parts and the default Web parts available with SharePoint, you cancreate a SharePoint site where your users have access to all of the latest projectinformation. The Web site can allow all users easy access to important projectinformation, facilitating collaboration among project members.

The following is one example of how you could create a Web site to facilitate collaborationusing the SBM Web parts.

1. If documents need to edited, they can be edited from either location, SBM or theother. Any document that is uploaded immediately triggers the "Estimation


Workflow", where pertinent parties read the document and then decide on the scopeof the change, updating the issues with the appropriate estimates for work.

2. Give the project manager a view of the items at the high level, and enable users toeasily assign new incoming defects to the appropriate developer.

3. Links to different applications within SBM.

4. You can use to show the various states of the different items in the project.

5. Use the gadget to look at important items and see who is assigned what on theteam.

Using Default SharePoint Web PartsSharePoint contains two default Web parts that can be used to display reports and pagesfrom SBM.

Note: For users to access SBM through the Web parts, they must have a useraccount and the appropriate permissions to view the report.

• Page Viewer Web Part – Use the Page Viewer Web Part to display a report withinyour SharePoint page. The Page Viewer Web Part isolates the linked report fromother content on the Web Part Page through the use of the HTML <IFRAME>element. This element ensures that any HTML elements displayed as content in thePage Viewer Web Part will not conflict with other HTML elements on the Web PartPage.

To add a report using the Page Viewer Web Part, you need the report URL. Log in toSBM and run the report. In the report results, click Copy to Clipboard and copythe URL. In SharePoint, add the Page Viewer Web Part and then paste the copiedURL into the URL field of the Page Viewer Web Part Link properties. Append&embedded to the end of the URL, which will allow the report to act correctly whenembedded in the page.

Tip: To use the editable grid, remember to select the editablegrid.htmHTML template under Additional Options. Also, remember to manuallysize the Page Viewer Web Part to be large enough for the reports thatusers will be running.

• Site Aggregator – Like the SBM Reports Web part, the Site Aggregator Web partallows you to create a multi-tabbed view, where you can display different pages fromother Web sites. The Site Aggregator can display all objects (like documents) thathave been added to any SharePoint site belonging to the same site collection as theone that the Web part is deployed on.

You can use the Site Aggregator to show the collections of documents that have beenstored in SharePoint Document Libraries associated with a particular project,simplifying the steps for user collaboration.

Chapter 6: Working with the SBM Web Parts


To configure the Web part, enter the URL for the site and the name of the tab.

Note:

You may also use the Site Aggregator to display different pages or reportsfrom SBM by entering the SBM Server URL. The Site Aggregator Web partappends additional information to the URL that you have entered, this mayor may not cause a problem with URL in SBM.

For example, if you are creating a personal site in SharePoint and attemptto use the Site Aggregator to display a page from SBM, you will receive anerror because the appended string causes a problem. For other sites thatwere tested, the appended string was ignored by SBM, and it didn't causea problem. The problem will be obvious because you will receive an errormessage on the tab, such as:

Invalid Query String:

ReportPage&ReportId=26758&Template=reports%2Frichgraphical&forceshell/%20?ShowTasks=0&AccountName=COMPANY%5Cusername

(contains illegal '?' character)

To add a report from SBM to the Site Aggregator, follow the previousinstructions for the Page Viewer Web part which describes how to insert thereport URL.

About the SBM Web PartsIn addition to the default SharePoint Web parts, the following SBM Web parts are availablefor Microsoft SharePoint:

• SBM Reports allows users to view reports from within their SharePoint Web page.

• SBM Applications allows users to view all of their applications from within aSharePoint Web page.

• SBM Selected Applications allows users to view a selected subset of applicationsfrom within a SharePoint Web page.

Important: You must select the Allow login page to be embedded inanother Web site check box on the Base Project settings in SBM ApplicationAdministrator to see SBM Reports.

Using SBM ReportsThe SBM Reports Web part allows you to display multiple reports on different tabs in asingle Web part.


To implement and use SBM Reports:

1. Add the SBM Reports Web part to your SharePoint page.

Note: You must install and enable the Web parts before it is available tobe added to your Web site.

2. Edit the Web Part by selecting Edit | Modify Shared Web Part

3. Enter your SBM Server information to connect to your and retrieve available reports:

Field Description

Server Name Your SBM Server, omitting http:// or https:// and tmtrack/tmtrack.dll?. For example, enter SBMServerName,

Port Number Your SBM Server port number. The default is 80.

Use https Select for secure servers.

User Nameand Password

The SBM user which will be used to log in to SBM and retrievethe reports.

4. Click Get Reports to retrieve the reports. The response time for populating thereports depends on the number of reports on your SBM Server. It may take a fewminutes to populate the list.

5. In the Reports Section, choose the report to display on each tab. You do this byselecting the report on the left side and then moving the report to the box on the

right by clicking the right arrow .



Important:

When using SBM 2009 R3 and 2009 R3.x, only Listing type reports aresupported in the SBM Reports Web Part.

This means that if you have created a non-listing type report, such asGraphical Distribution report or a Trend report, the report will notappear in the Report list results and you cannot select it to display.

The workaround for is to use either the SharePoint Page Viewer or theSite Aggregator Web parts. Copy the URL to the report and paste it intothe SharePoint Web part.

The following table describes how the fields work in the Reports Section:

Field Description

TabCaption

Display name for the tab. Note that you can change the tab nameafter adding it to the list on the right by clicking on the button.

ApplicationList

Select from the available applications on your SBM Server.

ReportCategory

Select the category that the report is in. Remember that if you arecreating a page for other users to view, not to select reportsmarked as Private as these reports are only available to the userentered above.

Report List Select from the available reports in the dropdown list and then click

the right arrow to select it for display.


Field Description

Search You can search for available reports. Select the application that thereport is in, and then enter the search words and click Search. TheReport List will be filtered to display only the reports with titlesthat include the search words.

Up andDownArrows

Use the up and down arrows to modify the order of the tabs.

6. You can change additional settings under the Appearance, Layout and Advanced.This allows you to change the size of the display or the title of the Web part.

7. Click OK to implement the changes to your Web part.

Note:

• For users to access SBM through the Web parts, they must have a useraccount. In addition, the user needs the appropriate permissions to viewthe selected report.

• Depending on your security settings, end users may be prompted to entertheir SBM User Name and Password when they access the SharePointpage.

• Depending on the permissions that the end users have, they may be ableto edit the Web Part's configuration settings. The end user will be able tochoose a different SBM server or report type. If the end user changes theSBM Reports Web Part, they will not have access to the User Name andPassword entered by the administrator.

Tip:

• Choosing a report with the editablegrid.htm template allows you to displaya report with the editable grids in your SharePoint site.

• Depending on the type of report, the user may have the ability to drill-down into the report.

Using SBM ApplicationsThe SBM Applications Web part displays all of the applications that an end user has accessto on a SBM Server. When an end user clicks on an SBM application, Work Center opensto that application.

Note: For users to access SBM through the Web parts, they must have a useraccount.

Tip: To only display selected applications from SBM, use the SBM SelectedApplications Web part.



To implement and use SBM Applications:

1. Add the SBM Applications Web part to your SharePoint page.


2. Edit the Web part by selecting Edit | Modify Shared Web Part

3. Enter your SBM Server information to connect to your and retrieve availableapplications:

Field Description

ServerName

Your SBM Server, omitting http:// or https:// and tmtrack/tmtrack.dll?.For example, enter SBMServerName,

PortNumber

Your SBM Server port number. The default is 80.

Usehttps

Select for secure servers.

Note: End users will only see applications that they have permissions toaccess in SBM.



Note:

• For users to access SBM through the Web parts, they must have a useraccount. In addition, the user needs the appropriate permissions to viewthe applications.


• Depending on the permissions that the end users have, they may be ableto edit the Web Part's configuration settings. The end user will be able tochoose a different SBM server.

Using SBM Selected ApplicationsSBM Selected Applications Web parts gives SharePoint users easy access to SBMapplications. When an end user clicks on an SBM application, Work Center opens to thatapplication.


The SBM Selected Applications Web part is similar to the SBM Applications Web part. Thedifference is that SBM Selected Applications Web part displays only selected applicationswhereas SBM Applications displays all of the applications available in SBM.

Note: For users to access SBM through the Web parts, they must have a useraccount.



To implement and use SBM Selected Applications:

1. Add the SBM Selected Applications Web part to your SharePoint page.


2. Edit the Web part by selecting Edit | Modify Shared Web Part

3. Enter your SBM Server Information to connect to your and retrieve availableapplications:

Field Description

Server Name Your SBM Server, omitting http:// or https:// and tmtrack/tmtrack.dll?. For example, enter SBMServerName,

Port Number Your SBM Server port number. The default is 80.

Use https Select for secure servers.

User Nameand Password

The SBM user which will be used to log in to SBM and retrievethe applications.

4. Click Get Applications to populate the Select Applications to Display list.

5. Select the applications to display. Use the CTRL key when clicking to select multipleapplications.

Note: End users will only see applications that they have permissions toaccess in SBM.



Note:

• For users to access SBM through the Web parts, they must have a useraccount. In addition, the user needs the appropriate permissions to viewthe selected applications.


• Depending on the permissions that the end users have, they may be ableto edit the Web Part's configuration settings. The end user will be able tochoose a different SBM server or selected applications. If the end userchanges the SBM Selected Applications Web Part, they will not have accessto the User Name and Password entered by the administrator.


Solutions Business Manager - Serena Documentation Center

Documents

Transcript of Solutions Business Manager - Serena Documentation Center