Workflow Conductor for SharePoint 2007 › kb › attachments... · Workflow Conductor for...
Transcript of Workflow Conductor for SharePoint 2007 › kb › attachments... · Workflow Conductor for...
� Overview
� System Requirements
� Installing Workflow Conductor
� Configuring Workflow Conductor
� Using Workflow Conductor Studio
� Managing Workflows
� Licensing and Activation
� Workflow Conductor Widgets
� Frequently Asked Questions
This section describes how to install and configure Workflow Conductor.
� Installing Workflow Conductor
� Configuring Workflow Conductor
This section describes how to install, upgrade, uninstall, activate the features, or troubleshoot installation issues for Workflow Conductor.
� About the Setup Program
� Recommendations for a Successful Installation
� Installing Workflow Conductor
� Upgrading from Previous Versions of Workflow Conductor
� Manually Activating the Product Features
� Troubleshooting Installation
� Locating the Error Log File(s)
� Uninstalling Workflow Conductor
� Manually Installing or Uninstalling Workflow Conductor
Before installing the product, read the Installing the Product section of the Online Documentation and review KB.12464: Best Practices for
Installing Bamboo Products.
To access the Setup program:
1. Download the self-extracting product EXE from the storefront and save it to a local folder on the SharePoint server.
2. Double-click the product EXE file to extract the contents of the product download.
3. The Setup program will automatically start. To start the Setup program manually, double-click the Setup.bat file in the root of the folder
where the product files were extracted.
The Setup program may look different for different product versions. See examples below of the two Setup programs that are currently in use. Both
versions of the Setup program work the same way.
Workflow Conductor for SharePoint 2007
Release 1.6 (SA08)
Workflow Conductor System Requirements
Operating System Microsoft Windows Server 2003 or 2008
Server Microsoft Windows SharePoint Service 3.0 or Microsoft Office SharePoint Server 2007 with
Service Pack 2
Microsoft .NET Framework 3.0 or 3.5
Microsoft SQL Server 2005 or higher
Microsoft AJAX Extensions 1.0 or higher
Browser Microsoft Internet Explorer 7 or higher
Administration
Installation
About the Setup Program
Note: The minimum screen resolution to view the Setup program is 1024x768.
The Setup program contains links to each product component under the Components header on the left. Click on any of these links to view a
description of the component on the right. The component description contains important information about where to install the component and the
required permissions for the installation account. Read this information carefully before proceeding.
Each product may have several components, which fall into the following categories:
� Prerequisites: Some products include prequisite components that must be installed before the Bamboo product core components. Not all
products will have prerequisites. Examples of prerequisites include the Shared Assemblies Library, Microsoft AJAX Extensions, and Bamboo AJAX
Config.
� Core Components: The product will include one or more core components that are required for the Bamboo product to work.
� Optional Items: Optional items provide additional features or functionality but are not required to use the Bamboo product. Not all products
will have optional items. Examples of optional items include the MashPoint Runtime Components and sample ASP.NET applications.
� Licensing: All products will include the Bamboo Web License Manager or Bamboo License Manager. Licensing is required to activate a product
license. It is not required during 30-day product trials.
� Help: The Setup program also contains links to the Online Documentation and the Installation and Licensing Quick Start Guide. Links to other
product-related resources, like the Bamboo Knowledge Base, may also be included.
After reviewing the installation location and required installation permissions for a component, click the Install button at the bottom of the Setup
screen to install it. If the product includes multiple components, click the Install button for each component.
Click the Home icon to return to the Setup main page.
About the extracted product files:
The extracted product files include the file Setup.bat, which launches the Setup program, and may also include the following folders:
� \[Product].wsp: Contains the solution deployment file for this product. There may be more than one product WSP folder,
depending on the product.
� \docs: Contains the Installation and Licensing Quick Start Guide.
� \msi : Contains installation executables for this product.
� \res: Contains files required by the Setup program.
� There may be other folders, depending on the requirements for the product.
The Workflow Conductor installation process has been streamlined as much as possible, but there are still areas of the installation that might present
issues. This section is intended to highlight some important aspects of the installation process that are sometimes overlooked.
� Before Installing
� During Installation
� After Installing
� Back up your system.
� Review KB.12464: Best Practices for Installing Bamboo Products.
� Verify that your system meets all the requirements listed in the System Requirements section.
� If you are installing Workflow Conductor on Windows Server 2008, disable Admin Approval Mode in the UAC policy or turn off UAC on any
SharePoint server where Conductor will be installed. For more information, read KB.12430: Workflow Conductor Studio displays a blank diagram
Recommendations for a Successful Installation
Before Installing
when UAC is enabled on Windows Server 2008.
� Stop the World Wide Web Publishing Service during installation.
� Confirm the Installation Location and Required Installation Permissions in the Setup program for each product component before
installing it. Required SQL Sever permissions for the Workflow Conductor Configuration Database component are shown in the screenshot below.
TOP
� The Workflow Conductor component installation takes an average of 10 minutes to complete. This may take longer in your environment. Be sure
to give this part of the installation extra time. We recommend that you bring your SharePoint environment to an inactive state before starting
the installation. You can also shut down the World Wide Web Publishing Service to ensure that no one can access the system.
� The only optional component of the installation is the MashPoint REST Extensions. The MashPoint REST Extensions component is only required
on SharePoint Web applications that will be accessed using the REST data connectivity pieces available within Workflow Conductor.
� The Microsoft AJAX Extensions and Bamboo AJAX Config are not optional components and must be installed and configured for Workflow
Conductor to work correctly. Make sure to read the Setup screen instructions carefully for these components. For more information about the
Microsoft AJAX Extensions, read KB.12637: Configuring and Troubleshooting Microsoft AJAX Extensions for Bamboo Products.
� Take notes during the installation process so you can successfully repeat it if you need to move the application or install it on another server.
These notes can also be used to assist the Bamboo support team if you need assistance getting Workflow Conductor installed in your
environment.
� The Workflow Conductor Setup program will not abort the installation if one feature in a component package fails; it will continue to install the
next feature in the list. The installation summary screen at the end of the installation for that component will tell you what went wrong. Fix the
issue, and then reinstall any failed features individually by running Setup again for that component and selecting the Install New Only option.
TOP
Go to the Workflow Conductor Control Panel in Central Administration and configure Workflow Conductor settings. At a minimum, you must
configure the following:
� System Settings: Enter the SQL Server name and instance where Workflow Conductor is installed and the e-mail server to use for e-mail sent
by Workflow Conductor widgets. Conductor will not work if you do not configure the SQL Server setting.
� Account Settings: Configure the access accounts for Workflow Conductor. Conductor will not work if you do not configure these
accounts.
� Licensing: If you have purchased a license for Workflow Conductor, go to the Licensing page to activate your license. This page can also be
accessed in Central Administration > Operations > Bamboo Web License Manager.
� All other settings are optional, and can be configured as needed to customize Workflow Conductor for your environment.
TOP
During Installation
After Installing
Installing Workflow Conductor
Before installing any Workflow Conductor
If you are using other Bamboo products in a multiple Web front-end environment, we recommend installing the Shared Assemblies Library on all
Web front-end servers before installing Workflow Conductor. Installing the Shared Assemblies Library will ensure that other Bamboo products are
not affected if Workflow Conductor is later upgraded or removed.
Where to run the installer for this component:
The Shared Assemblies Library installer must be run on all Web front-end servers in the SharePoint farm where the Windows SharePoint
Services Web Application service is running. Check Central Administration > Operations > Topology and Services > Servers in Farm for a
list of servers running this service.
Required permissions for the installation user account:
� Must be a member of the local server Administrators group.
Installation instructions:
1. If the Setup program is not already running, double-click the Setup.bat file in the root of the product folder to launch it.
2. In the Components list, click Shared Assemblies Library. Verify the installation location and required installation permissions and then click
the Install button to start the Bamboo Core installer.
3. Follow the on-screen installation instructions.
4. When the installation is complete, confirm that Bamboo Core installed successfully and then click Close.
5. Repeat the steps above on all Web front-end servers in the SharePoint farm.
TOP
components, read the Recommendations for a
Successful Installation section.
In order to successfully install the product, you need
to install each component listed in the Setup program.
The Setup program contains links to each product
component under the Components header on the
left. Click on any of these links to view a description of
the component on the right. The component
description contains important information about
where to install the component and the required
permissions for the installation account. Read this
information carefully before proceeding.
After reviewing the installation location and required
installation permissions for a component, click the
Install button at the bottom of the Setup screen to
install it.
View detailed installation instructions for each
Workflow Conductor component by clicking its link in
the table below.
When you finish installing all Workflow Conductor
components, make sure to review the After
Installing section of Recommendations for a
Successful Installation for required post-installation
configuration steps.
Component Description
Shared Assemblies
Library
Installs the Shared Assemblies Library, which contains common assemblies for many Bamboo products. If you have other Bamboo products in your farm,
we recommend installing this component on all Web front-end servers before installing Workflow Conductor. This will ensure that your other products are
not affected if you later upgrade or remove Workflow Conductor.
Microsoft AJAX
Extensions 1.0
Installs the Microsoft AJAX Extensions 1.0, which are required for the Conductor Studio and Workflow Conductor Control Panel components. The AJAX
Extensions must be installed on all Web front-end servers that host the Central Administration Web application and any Web application where Workflow
Conductor is installed.
Bamboo AJAX Config Configures the Microsoft AJAX Extensions 1.0 to complete the AJAX installation. The Bamboo AJAX Extensions Config is required for the Central
Administration Web application and any Web application where Workflow Conductor is installed.
Workflow Conductor Installs the core Workflow Conductor components, including Conductor Studio, widgets, and reporting Web Parts.
Workflow Conductor
Control Panel
Adds a page in Central Administration that provides global settings for Conductor and a view of all workflows running across the installed Web
applications.
Workflow Conductor
Configuration Database
Installs the Workflow Conductor Configuration Database wizard, which installs and configures the Workflow Conductor database.
MashPoint REST
Extensions
(Optional) Installs the REST extensions for Bamboo MashPoint. The MashPoint REST extensions must be installed on any SharePoint Web application that
will be accessed using the REST data connectivity pieces available within Workflow Conductor.
Bamboo Web License
Manager
The Bamboo Web License Manager controls the licensing for this product. This installation is only required to unlock and activate a purchased copy of the
product. It is not needed for product trials.
Install the Shared Assemblies Library
Install Microsoft AJAX Extensions 1.0
Where to run the installer for this component:
The Microsoft AJAX Extensions 1.0 must be installed on all Web front-end servers in the SharePoint farm where the Windows SharePoint
Services Web Application or Central Administration services are running. Check Central Administration > Operations > Topology and
Services > Servers in Farm for a list of servers running these services.
Required permissions for the installation user account:
� Must be a member of the local server Administrators group.
Installation instructions:
1. If the Setup program is not already running, double-click the Setup.bat file in the root of the product folder to launch it.
2. In the Components list, click Microsoft AJAX Extensions 1.0. Verify the installation location and required installation permissions and then
click the Install button.
3. Follow the on-screen installation instructions.
4. When the installation is complete, confirm that the Microsoft AJAX Extensions installed successfully and then click Close.
5. Repeat the steps above on all Web front-end servers in the SharePoint farm.
TOP
Where to run the installer for this component:
The Bamboo AJAX Extensions Config installer must be run on all Web front-end servers in the SharePoint farm where the Windows SharePoint
Services Web Application or Central Administration services are running. Check Central Administration > Operations > Topology and
Services > Servers in Farm for a list of servers running these services.
Required permissions for the installation user account:
� Must be a member of the local server Administrators group.
� Must be a member of the SharePoint Farm Administrators group.
� Must be a SharePoint site collection administrator (for automatic feature activation).
Installation instructions:
1. If the Setup program is not already running, double-click the Setup.bat file in the root of the product folder to launch it.
2. In the Components list, click Bamboo AJAX Config. Verify the installation location and required installation permissions and then click the
Install button.
3. Click Next to begin the installation. Verify that the system checks pass successfully, then read and accept the End-User License Agreement.
4. In the Deployment Targets screen, the Central Administration Web application is selected by default. Select any Web applications where
Workflow Conductor is installed, and then click Next.
Note: The Automatically activate features option is checked by default. If you want to manually activate the Bamboo AJAX Config feature
later, uncheck this box. The installation account must be a site collection administrator for automatic activation to work.
5. The Bamboo AJAX Config feature is installed. When installation is finished, click Next.
6. Review the summary screen to confirm that the component installed successfully, and then click Close.
TOP
Where to run the installer for this component:
The Workflow Conductor installer must be run on one Web front-end server in the SharePoint farm where the Windows SharePoint Services Web
Application service is running. Check Central Administration > Operations > Topology and Services > Servers in Farm for a list of servers
running this service.
Required permissions for the installation user account:
� Must be a member of the local server Administrators group.
� Must be a member of the SharePoint Farm Administrators group.
� Must be a SharePoint site collection administrator (for automatic feature activation).
Installation instructions:
1. If the Setup program is not already running, double-click the Setup.bat file in the root of the product folder to launch it.
2. In the Components list, click Workflow Conductor. Verify the installation location and required installation permissions and then click the
Install button.
3. Click Next to begin the installation. Verify that the system checks pass successfully, then read and accept the End-User License Agreement.
Install Bamboo AJAX Config
Install Workflow Conductor
4. In the Deployment Targets screen, select the Web applications where you want to deploy Workflow Conductor and click Next. You do not have
to deploy Workflow Conductor to your Central Administration Web application unless you also want to deploy workflows to it.
Note: The Automatically activate features option is checked by default. If you want to manually activate Conductor features later, uncheck
this box. The installation account must be a site collection administrator for automatic activation to work.
5. The Workflow Conductor features are installed. When all components are installed, click Next.
6. Review the summary screen to confirm that all components installed successfully, and then click Close.
TOP
Where to run the installer for this component:
The Workflow Conductor Control Panel installer must be run on one Web front-end server in the SharePoint farm where the Central Administration
service is running. Check Central Administration > Operations > Topology and Services > Servers in Farm for a list of servers running this
service.
Required permissions for the installation user account:
� Must be a member of the local server Administrators group.
� Must be a member of the SharePoint Farm Administrators group.
� Must be a SharePoint site collection administrator (for automatic feature activation).
Installation instructions:
1. If the Setup program is not already running, double-click the Setup.bat file in the root of the product folder to launch it.
2. In the Components list, click Workflow Conductor Control Panel. Verify the installation location and required installation permissions and
then click the Install button.
3. Click Next to begin the installation. Verify that the system checks pass successfully, then read and accept the End-User License Agreement.
4. In the Deployment Targets screen, the Central Administration Web application is selected by default. Click Next.
Note: The Automatically activate features option is checked by default. If you want to manually activate the Conductor Control Panel feature
later, uncheck this box. The installation account must be a site collection administrator for automatic activation to work.
5. The Workflow Conductor Control Panel feature is installed. When installation is finished, click Next.
6. Review the summary screen to confirm that the component installed successfully, and then click Close.
TOP
Important Note for Windows Server 2008 with UAC: If you attempt to install the Conductor Configuration Database component on Windows
Server 2008 with UAC enabled, the database installation may fail with the error message "Database creation failed." If you encounter this issue,
close the Workflow Conductor Configuration Database wizard and launch it again from Start > All Programs > Bamboo Conductor Database
Configuration. UAC must also be turned off on any Windows Server 2008 Web front-end server where Workflow Conductor is installed, or
Conductor Studio will not work properly.
Where to run the installer for this component:
The Workflow Conductor Configuration Database installer must be run on a server in the SharePoint farm with access to the SQL Server where the
SharePoint configuration and content databases are located.
Required permissions for the installation user account:
� Must be a member of the local server Administrators group.
� Must have the dbcreator and securityadmin SQL Server roles on the SQL Server where the Workflow Conductor database will be installed.
� Must have the db_owner permission for the SharePoint configuration and content databases.
Installation instructions:
1. If the Setup program is not already running, double-click the Setup.bat file in the root of the product folder to launch it.
2. In the Components list, click Workflow Conductor Configuration Database. Verify the installation location and required installation
permissions and then click the Install button.
3. In the first installation screen, click Next.
4. Select an installation folder location and click Next, and then click Next in the Confirm Install screen to begin installation.
5. In the Workflow Conductor Configuration screen:
� Enter the name of your database server and SQL Server instance. For example:
� DBSERVER - Will install and configure the Conductor database in the default SQL Server instance on the server DBSERVER.
� DBSERVER\OFFICESERVERS - Will install and configure the Conductor database in the OFFICESERVERS instance on DBSERVER. This
is common for SharePoint installations that use SQL Server Express.
Install Workflow Conductor Control Panel
Install Workflow Conductor Configuration Database
� DBSERVER\SQLINSTANCE - Will install and configure the Conductor database in the SQLINSTANCE instance on DBSERVER. If you
want to install the Conductor database on something other than the default instance on the SQL Server, you must specify the
instance name.
� Select Windows authentication. You can optionally use a SQL authentication account, but this option will not work if your database is on
a different server.
� Click the Test button. The installation will test the connection to your database server using the selected authentication method. If the
test fails, make sure that the installation account has the dbcreator and securityadmin roles in the database. See Recommendations for
a Successful Installation for more information.
� Click Finish. The Workflow Conductor database is created and populated.
6. When the installation is complete, confirm that the Workflow Conductor Configuration Database installed successfully and then click Close.
TOP
Where to run the installer for this component:
Install the MashPoint REST Extensions on SharePoint Web applications where Workflow Conductor is not installed to enable connectivity to
SharePoint lists and libraries using the Workflow Conductor REST Widgets. For more information, read the Bamboo Knowledge Base article Installing
the Bamboo MashPoint REST Extensions.
The MashPoint REST Extensions installer must be run on one Web front-end server in the SharePoint farm where the Windows SharePoint
Services Web Application service is running. Check Central Administration > Operations > Topology and Services > Servers in Farm for a
list of servers running this service.
Required permissions for the installation user account:
� Must be a member of the local server Administrators group.
� Must be a member of the SharePoint Farm Administrators group.
Installation instructions:
Click Bamboo MashPoint REST Extensions 1.0 Setup in the Setup Components list, and then click Install. Follow the installation instructions.
1. If the Setup program is not already running, double-click the Setup.bat file in the root of the product folder to launch it.
2. In the Components list, click MashPoint REST Extensions 1.0. Verify the installation location and required installation permissions and then
click the Install button.
3. Click Next to begin the installation. Verify that the system checks pass successfully, then read and accept the End-User License Agreement.
4. In the Deployment Targets screen, select the Web applications where you want to deploy the MashPoint REST Extensions and click Next.
Note: The Automatically activate features option is checked by default. If you want to manually activate Conductor features later, uncheck
this box. The installation account must be a site collection administrator for automatic activation to work.
5. The MashPoint REST Extensions are installed. When installation is finished, click Next.
6. Review the summary screen to confirm that the component installed successfully, and then click Close.
TOP
Install Bamboo MashPoint REST Extensions (Optional)
Install Bamboo Web License Manager
The Bamboo Web License Manager manages licenses for Bamboo products. Bamboo Web License Manager is required to activate a purchased license
for Workflow Conductor. It is not needed during the Workflow Conductor trial period.
Where to run the installer for this component:
The Bamboo Web License Manager installer must be run on one Web front-end server in the SharePoint farm where the Central Administration
service is running. Check Central Administration > Operations > Topology and Services > Servers in Farm for a list of servers running this
service.
Required permissions for the installation user account:
� Must be a member of the local server Administrators group.
� Must be a member of the SharePoint Farm Administrators group.
� Must be a SharePoint site collection administrator (for automatic feature activation).
Installation instructions:
1. If the Setup program is not already running, double-click the Setup.bat file in the root of the product folder to launch it.
2. In the Components list, click Bamboo Web License Manager. Verify the installation location and required installation permissions and then
click the Install button.
3. Click Next to begin the installation. Verify that the system checks pass successfully, then read and accept the End-User License Agreement.
4. In the Deployment Targets screen, the Central Administration Web application is selected by default. Click Next.
Note: The Automatically activate features option is checked by default. If you want to manually activate the Bamboo Web License Manager
feature later, uncheck this box. The installation account must be a site collection administrator for automatic activation to work.
5. The Bamboo Web License Manager feature is installed. When installation is finished, click Next.
6. Review the summary screen to confirm that the component installed successfully, and then click Close.
For instructions to activate your Workflow Conductor license, read the Product Licensing and Activation section of KB.12464: Best Practices for
Installing Bamboo Products.
TOP
After you have finished installing all required components, perform the steps in the After Installing section of the Recommendations for a
Successful Installation guide.
TOP
To upgrade Workflow Conductor from a previous version, follow all the steps listed below:
1. Install Product Prerequisites
2. Upgrade Workflow Conductor and the Workflow Conductor Control Panel
3. Upgrade the Workflow Conductor Configuration Database
4. Additional Information
Shared Assemblies Library
If you have other Bamboo products in your multiple Web front-end server farm, install the Shared Assemblies Library to ensure that your
other Bamboo products are not affected after you upgrade Workflow Conductor.
You can skip this step if you do not have other Bamboo products, if you have only one Web front-end server, or if you have previously installed the
Shared Assemblies Library included with any Bamboo product. To check if you have already installed the Shared Assemblies Library, check the
Programs and Features list in the Control Panel on all of your SharePoint servers for an installed application named Bamboo Core.
1. Start the Setup program by double-clicking the product EXE that you downloaded from the Bamboo Website.
2. In the Components list, click Shared Assemblies Library. Verify the installation location and required installation permissions and then click
the Install button to start the Bamboo Core installer.
3. Follow the on-screen installation instructions.
4. When the installation is complete, confirm that Bamboo Core installed successfully and then click Close.
5. Repeat the steps above on all Web front-end servers in the SharePoint farm.
Bamboo AJAX Config
If you are upgrading from Workflow Conductor 1.1 or earlier, you must remove and reinstall the Bamboo AJAX Config component.
After Installing
Upgrading from Previous Versions of Workflow Conductor
Step 1: Install Product Prerequisites
1. Start the Setup program by double-clicking the product EXE that you downloaded from the Bamboo Website.
2. In the Components list, click Bamboo AJAX Config. Verify the installation location and required installation permissions and then click the
Install button.
3. In the Repair, Remove or Install screen, select the Remove option, and then click Next. Follow the Setup program instructions to remove this
component.
4. When the component has been removed, return to the Setup program and click the Install button for the Bamboo AJAX Config component
again. Follow the Setup program instructions to deploy this component to the Central Administration Web application and any Web application
where Workflow Conductor is installed.
5. When the installation is complete, review the summary screen to confirm that Bamboo AJAX Config installed successfully, and then click Close.
TOP
To upgrade the Workflow Conductor and Workflow Conductor Control Panel components:
1. Start the Setup program by double-clicking the product EXE that you downloaded from the Bamboo Website.
2. In the Components list, click Workflow Conductor. Verify the installation location and required installation permissions and then click the
Install button.
3. Click Next to begin the installation. Verify that the system checks pass successfully.
4. In the Repair, Remove or Install screen, select the option Upgrade/Repair Existing and Install New, and then click Next.
5. When the installation is complete, review the summary screen to confirm that the component upgraded successfully, and then click Close.
6. Repeat the steps above to upgrade the Workflow Conductor Control Panel component.
TOP
To upgrade the Workflow Conductor Configuration Database:
1. On the server where the Workflow Conductor Configuration Database tool was installed for the previous version of Workflow Conductor, go to
the Control Panel and view installed Programs and Features.
2. Select the Workflow Conductor Configuration Database program and click Uninstall.
3. Start the Workflow Conductor Setup program by double-clicking the product EXE that you downloaded from the Bamboo Website.
4. In the Components list, click Workflow Conductor Configuration Database. Verify the installation location and required installation
permissions and then click the Install button.
5. Follow the instructions to Install Workflow Conductor Configuration Database in Installing the Product.
TOP
� You do not have to reinstall the Bamboo MashPoint REST Extensions if you have installed them already.
� You do not have to reinstall the Bamboo Web License Manager if you have installed it already.
� You do not have to reinstall the Microsoft AJAX REST Extensions 1.0 if they were previously configured for Workflow Conductor. (You DO,
however, have to reinstall the Bamboo AJAX Config if you are upgrading from Workflow Conductor 1.1 or earlier.)
� If you encounter an error during the Workflow Conductor Configuration Database component upgrade, read Bamboo Knowledge Base article
KB.12586 - ERRMSG: Workflow Conductor database upgrade fails with error "System.Data.SqlClient.SqlException: The statement conflicted with
the REFERENCE constraint".
� For more information about upgrading and migrating your existing workflows, read KB.12589: How to upgrade workflows and workflow
templates after upgrading Workflow Conductor.
TOP
Product feature activations can be done automatically at the site collection level when Workflow Conductor is installed. There are several reasons
why you may need to manually activate (or deactivate) Workflow Conductor product features:
� You opted out of automatic feature activation during installation.
� You add a new site collection and want to add Workflow Conductor features to it.
� You want to remove Workflow Conductor features from an existing site collection.
� You want to activate a Workflow Conductor workflow in a site collection other than the one it was originally deployed to.
� You want to deactivate a Workflow Conductor workflow for a site collection.
To manually activate (or deactivate) Workflow Conductor product features or Workflow Conductor workflows in a site collection, follow the
instructions below.
Note: You must be a SharePoint site collection administrator to activate or deactivate features. Site collection administrators are assigned in
SharePoint Central Administration.
Step 2: Upgrade Workflow Conductor and the Workflow Conductor Control Panel
Step 3: Upgrade the Workflow Conductor Configuration Database
Additional Information:
Manually Activating the Product Feature for a Site Collection
1. From the top-level site in the site collection, go to Site Actions > Site Settings > Site Collection Administration > Site Collection
Features.
2. Locate the Workflow Conductor product feature or workflow. Click Activate to activate it for the entire site collection, or Deactivate to
deactivate it.
If you encounter any errors in the process of using this product, please refer to the error logs located in
<drive>:\WINDOWS\Temp\BambooSolutions\Conductor\bsc_DataInstaller_%processid.log on the SharePoint server.
The error log will contain details of any failures that may have occurred during the product installation. It can also contain helpful information that
will allow you to selectively correct problems in order to later re-run the installation successfully.
The most common reasons for installation failure are:
� The installation account did not have the required permissions to access the server and database. Read the Installation Location and
Required Installation Permissions information included in the Setup program for each component. Each Workflow Conductor component may
have different requirements, so be sure to read all information carefully before installing a component.
� The Windows SharePoint Services Administration or the Windows SharePoint Services Timer service was not running on all front-
end Web servers. Check to make sure that these services are started.
� You are running Windows Server 2008 and UAC was enabled during installation. If you are installing Workflow Conductor on Windows Server
2008, you must disable Admin Approval Mode in the UAC policy or turn off UAC on any SharePoint server where Conductor will be installed. For
more information, read KB.12430: Workflow Conductor Studio displays a blank diagram when UAC is enabled on Windows Server 2008.
Common issues after installation include:
Issue: Conductor Studio does not work properly. For example: you are not able to drag and drop widgets to the Studio diagram, or you get
Javascript errors when you attempt to use the features in Conductor Studio.
Resolution: Make sure you have the Microsoft AJAX Extensions installed and configured. There are two AJAX Extensions components in the Setup
program. The Microsoft AJAX Extensions 1.0 component installs the AJAX Extensions, if you do not already have them. It is safe to install the
AJAX Extensions 1.0 even if you have other AJAX versions installed. The Bamboo AJAX Config component inserts required lines into the Web.config
of each Web application where Workflow Conductor components are installed. You must have the AJAX extensions installed and configured for all
Web applications where you installed Workflow Conductor, and for the Central Administration Web application. Read KB.12637: Configuring and
Troubleshooting Microsoft AJAX Extensions for Bamboo Products for more information, including instructions for updating your Web.config to use the
AJAX Extensions included with .NET 3.5.
Issue: If you are running Windows Server 2008 and you attempt to launch Workflow Conductor Studio from the Settings menu in a list or
Troubleshooting Installation
library, the Conductor Studio displays a blank diagram or you get an error page with the message "Unknown Error".
Resolution: You must disable the UAC Admin Approval Mode or turn off UAC on your front-end Web servers in order to run Conductor Studio. See
KB.12430: Workflow Conductor Studio displays a blank diagram when UAC is enabled on Windows Server 2008 for step-by-step instructions for
adjusting your UAC settings.
Issue: The Conductor Studio diagram displays the error message "Connect to database failed" in the left pane where the list of widgets should be.
Resolution: Go to Central Administration > Workflow Conductor Control Panel and click on the System Settings page. Check that the SQL
Server setting contains the name of your database server. Then go to the Account Settings page and verify that you have entered the two
required access accounts for Workflow Conductor, and that the accounts have the permissions specified in the Account Settings page.
Issue: The Workflow Conductor database upgrade failed.
Resolution: This problem can occur when upgrading to Workflow Conductor if you customized the widget categories from the default in a previous
version of Workflow Conductor. Click here for a resolution for this issue.
Should you encounter any errors with Workflow Conductor, please refer to the error logs in the following locations:
� For errors during installation or configuration:
� <drive>:\WINDOWS\Temp\BambooSolutions\Conductor\bsc_DataInstaller_%processid%.log
� <drive>:\WINDOWS\Temp\BambooSolutions\Conductor\Studio\bsc_AdminMgr_%processid%.log
� For errors while using Workflow Conductor or running workflows:
� To view workflow runtime logs or Conductor Studio design logs from the Conductor_Content database, add the Conductor Log Viewer Web
Part to a SharePoint page.
� <drive>:\WINDOWS\Temp\BambooSolutions\Conductor\bsc_deploy_%processid%.log
� <drive>:\WINDOWS\Temp\BambooSolutions\Conductor\WorkflowFeature_%processid%.log
� Other log files may be located in the <drive>:\WINDOWS\Temp\BambooSolutions\Conductor and
<drive>:\WINDOWS\Temp\BambooSolutions\Conductor\Studio directories.
To uninstall Workflow Conductor, the Workflow Conductor Control Panel, and the Workflow Conductor Configuration Database:
1. Double-click the Setup.bat program included in the product download ZIP file.
2. From the Setup program screen, click each product component name under the Components section, and then click Install.
3. The program first performs system checks. Once they have successfully completed, the program prompts you to Repair/Upgrade or Remove
the solution. Select Remove, and then click Next to uninstall the component.
Repeat the above steps for the Workflow Conductor, Workflow Conductor Control Panel, and Workflow Conductor Configuration Database
components.
Additional Information:
� Uninstalling the Workflow Conductor Configuration Database component only removes the application files from your server. The
Conductor_Content database and its contents are not removed.
� Workflows that were deployed with Workflow Conductor are not retracted or removed from your SharePoint farm, but they will no longer work
after the product has been uninstalled. Workflow solutions can be manually removed in the Solution Management page of Central
Administration.
� The Bamboo MashPoint REST Extensions may be used for other applications, and is a free component from Bamboo. You do not have to remove
it.
� The Bamboo Web License Manager may be used by other Bamboo products. Do not remove it unless you have no other Bamboo products.
� The Microsoft AJAX Extensions may be used by other Bamboo products and SharePoint features. Do not remove them unless you are certain
they are no longer in use.
� We recommend that you leave the Shared Assemblies Library installed if you have other Bamboo products in your farm.
� Manual Product Installation
� Manual Product Uninstallation
WARNING: Bamboo recommends using the Setup program to install product components whenever possible. The Setup program is designed to
ensure a successful product installation. Manual installation may lead to unexpected behavior during product configuration, licensing, or use,
especially if your SharePoint environment contains issues normally detected and resolved when running the Setup program.
The exact steps for manual installation will vary depending on the version of SharePoint the product is for, your SharePoint environment, and the
individual product features. The information provided here includes general instructions for most product installation scenarios you may encounter.
Locating the Error Log File(s)
Uninstalling the Product
Manual Product Installation and Uninstallation
Manual Product Installation
Read all sections carefully before manually installing a product.
� About the Installation Files
� Important Notes About Manual Installation
� Manually Starting a Component Setup Application
� Manually Installing and Deploying a Product Solution (WSP)
� Manually Installing a Product MSI
TOP
When you extract the product EXE, several folders are created that contain installation files and Setup program configuration files. For manual
installation, you will be accessing the following folders that contain installation files:
� \[Component].wsp - There may be several folders ending in .wsp, depending on your product. Each WSP folder contains the installation files
for a SharePoint solution.
� \msi - The MSI folder may contain multiple files ending in .msi. Each .msi file is a single Windows installer package.
TOP
� Bamboo Web License Manager: If a product includes Bamboo Web License Manager (\Bamboo.Web.Licensing.wsp), add the solution to
the solution store on the server running the Central Administration service, and deploy the solution to the Central Administration Web
application.
� Shared Assemblies Library (SharePoint 2007): If a product includes the Shared Assemblies Library (\msi\Bamboo.Core.V1.2.msi), you
must install the MSI on all Web front-end servers in the farm.
� Microsoft AJAX Extensions (SharePoint 2007): If a product includes the Microsoft AJAX Extensions (\msi\ASPAJAXExtSetup.msi), you
must install the MSI on all Web front-end servers in the farm.
� Bamboo AJAX Config (SharePoint 2007): If a product includes the Microsoft AJAX Extensions, the Bamboo AJAX Config
(\Bamboo.AJAX.Config.wsp) solution must also be deployed. Deploy the solution to all Web applications in the farm where the product will be
installed. You may also need to deploy this solution to the Central Administration Web application. Consult the Online Documentation for your
product for more information.
� \msi\*.x64.msi: Some MSI installers in the \msi installation folder have a 32-bit version and a 64-bit version. The 64-bit version will
include .x64 in the file name. Run the version of the MSI that is appropriate for your operating system. Do not install both.
� PackInstallation.wsp: Some products include an installation folder called PackInstallation.wsp. This folder is not needed during the manual
installation process and can be ignored.
TOP
For your convenience, each component Setup application can be started directly from the Bamboo Setup program. The Bamboo Setup program can
be started by double-clicking the file Setup.bat in the root of the extracted product folder.
If you prefer to start an individual product component Setup from the product installation folder instead of from the Bamboo Setup program,
navigate to its installation folder and double-click the \[Component].wsp\Setup.exe or \msi\[Component].msi file. The installation wizard for
that component will start. Follow the installation instructions provided in the Online Documentation for your product.
For example: To install and deploy just the Bamboo AJAX Config component from the product installation folders, navigate to the
\Bamboo.AJAX.Config.wsp folder and double-click the file Setup.exe.
If you start a component Setup application this way, you do not need to follow instructions for Manually Installing and Deploying a Product Solution.
TOP
Before installing, stop the World Wide Web Publishing Service (W3SVC). This will ensure that no system files that need to be updated are
locked, which may cause the installation to fail.
Your product may include several SharePoint solutions in multiple \[Component].wsp installation folders. Follow all steps in this section for each
solution.
The instructions in this section use the stsadm.exe command, which can be found in the following location:
� SharePoint 2007: %PROGRAMFILES%\Common Files\Microsoft Shared\Web Server Extensions\12\BIN
� SharePoint 2010: %PROGRAMFILES%\Common Files\Microsoft Shared\Web Server Extensions\14\BIN
Step 1: Add the solution to the SharePoint solution store
About the Installation Files
Important Notes About Manual Installation
Manually Starting a Component Setup Application
Manually Installing and Deploying a Product Solution (WSP)
Perform this step on one server in your SharePoint farm running the SharePoint 2007 Windows SharePoint Services Web Application service or
the SharePoint 2010 Microsoft SharePoint Foundation Web Application service. Use an account that is a member of the local server
Administrators group.
Note: For the Bamboo Web License Manager solution (\Bamboo.Web.Licensing.wsp), perform these steps on a server running the Central
Administration service.
� Run the following command to add each SharePoint solution to the solution store:
stsadm.exe -o addsolution -filename [path]\[Component].wsp\cab\[Component].wsp
[path] - the path to the extracted installation folders
[Component] - the name of the component you are installing, as shown in the installation folder. The name of the component in the cab sub-
folder may be different than the installation folder name.
Step 2: Deploy the SharePoint solution
After installing a SharePoint solution, it must be deployed to one or more Web applications. This section provides instructions for deploying from the
command line or from SharePoint Central Administration. Pick the method that best fits your requirements.
Option 1: Command-line Deployment
Perform these steps on one server in your SharePoint farm running the SharePoint 2007 Windows SharePoint Services Web Application service
or the SharePoint 2010 Microsoft SharePoint Foundation Web Application service. Use an account that is a member of the local server
Administrators group.
Note: For the Bamboo Web License Manager solution (Bamboo.UI.Licensing.wsp), perform these steps on a server running the Central
Administration service.
1. Schedule the solution for deployment to the SharePoint solution store using one of the options below.
� Deploy a solution to a specific Web application (repeat for multiple Web applications):
stsadm.exe -o deploysolution -name [Component].wsp -immediate -url [http://WebApplicationUri:portNumber]
-allowGacDeployment -allowCasPolicies
[Component] - the name of the component you installed, as shown in the cab installation sub-folder
[http://WebApplicationUri:portNumber] - the URL and Port for the target Web application
� Deploy a solution to all Web applications EXCEPT the Central Administration Web application:
stsadm.exe -o deploysolution -name [Component].wsp -immediate -allcontenturls
-allowGacDeployment -allowCasPolicies
[Component] - the name of the component you installed, as shown in the cab installation sub-folder
2. Execute the deployment job on each Web front-end server in the farm:
stsadm.exe -o execadmsvcjobs
Option 2: Deployment from SharePoint Central Administration
Perform these steps using an account that is a member of the SharePoint Farm Administrators group.
1. SharePoint 2007: In SharePoint Central Administration, click the Operations link. In the Global Configuration section, click the Solution
Management link.
SharePoint 2010: In SharePoint Central Administration, click the System Settings link. In the Farm Management section, click the Manage
farm solutions link.
2. Click on the name of the solution you just installed.
3. Click the Deploy Solution link.
4. Select the Web application to deploy to and a deployment schedule, and then click OK.
Step 3: Manually Activate the Product Feature
After the Bamboo product solution is deployed, it must be activated in each site collection before it can be used.
Perform these steps using an account that is a SharePoint site collection administrator.
1. From the top-level site in the site collection, go to Site Actions > Site Settings > Site Collection Administration > Site Collection
Features.
2. Locate the Bamboo product feature and click Activate to activate it for the entire site collection. Some products have more than one feature.
Refer to the Online Documentation for your product for more information about manual feature activation.
TOP
Your product may include several components in the \msi installation folder, in addition to or instead of SharePoint solutions. Double-click on each
MSI file to install it.
MSI files must be installed on each server where the product is installed. Read the Important Notes About Manual Installation section for information
about specific MSI files included with Bamboo products.
Note: Some MSI installers in the \msi installation folder have a 32-bit and 64-bit version. The 64-bit version will include .x64 in the file name. Run
the version of the MSI that is appropriate for your operating system. Do not install both.
If you prefer to run the MSI installer from the command line, refer to the Microsoft TechNet article Msiexec (command-line options) for installation
options.
TOP
Products may include a combination of SharePoint solutions (WSPs) and components installed using an MSI installer. Refer to the original installation
files for information about the components that may have been installed. To manually uninstall a product component, read the following sections:
� Manually Uninstalling a SharePoint Solution
� Manually Uninstalling a Product MSI
� After Uninstalling a Product
Your product may include several SharePoint solutions. Follow all steps in this section for each solution that you want to uninstall.
For command-line uninstallation, you will need the name of the SharePoint solution that was deployed. This can be found in the cab installation sub-
folder for a component.
The instructions in this section use the stsadm.exe command, which can be found in the following location:
� SharePoint 2007: %PROGRAMFILES%\Common Files\Microsoft Shared\Web Server Extensions\12\BIN
� SharePoint 2010: %PROGRAMFILES%\Common Files\Microsoft Shared\Web Server Extensions\14\BIN
To uninstall a SharePoint solution from the command line:
1. Schedule the solution to be retracted from the Web application (Example 1) or from all Web applications EXCEPT Central Administration
(Example 2):
Example 1: stsadm.exe -o retractsolution -name [Component].wsp -immediate -url [http://WebApplicationUri:Port]
Example 2: stsadm.exe -o retractsolution -name [Component].wsp -immediate -allcontenturls
[Component] - the name of the installed component, as shown in the cab installation sub-folder
[http://WebApplicationUri:portNumber] - the URL and Port for the Web application where the solution is installed
2. Execute the retraction job on each Web front-end server in the farm:
stsadm.exe -o execadmsvcjobs
3. Delete the solution from the SharePoint solution store only AFTER the retraction job is complete:
stsadm.exe -o deletesolution -name [Component].wsp
[Component] - the name of the installed component, as shown in the cab installation sub-folder
Additional Information:
� The Bamboo AJAX Config and Bamboo Core solutions may be used by multiple Bamboo products. Do not uninstall them unless you are certain
they are no longer in use.
TOP
If a product was installed using an MSI installer, it will be listed in the installed Programs and Features list in the Control Panel. To uninstall it,
click on the name of the program and click Uninstall.
If you prefer to uninstall the MSI from the command line, refer to the Microsoft TechNet article Msiexec (command-line options) for installation
Manually Installing a Product MSI
Manual Product Uninstallation
Manually Uninstalling a SharePoint Solution
Uninstalling a Product MSI
options.
Additional Information:
� The Bamboo Core and Microsoft AJAX Extensions may be used by multiple Bamboo products. Do not uninstall these unless you are certain they
are no longer used.
� Some product MSIs, like Bamboo Core and Microsoft AJAX Extensions, are installed on all Web front-end servers in the farm. To completely
uninstall these components, you must uninstall them from each Web front-end server where they were installed.
TOP
Uninstalling a product will not remove product-related Web Parts from SharePoint site pages. To remove a Web Part from a page after a product is
uninstalled:
1. On the page that contains the Web Part, go to Site Actions > Edit Page.
2. Click the Edit menu for the Web Part and select Delete.
3. Exit Edit Mode to save the page.
TOP
After installing Workflow Conductor, go to Central Administration > Workflow Conductor Control Panel to configure Workflow Conductor. At a
minimum, you must configure items in the System Settings and Account Settings pages. To view more information about these and other
settings, click on each link below.
� System Settings: Configure the SQL Server for the Conductor database and the e-mail server Conductor uses to send e-mail. These settings
must be configured before you can use Workflow Conductor.
� Account Settings: Configure the Workflow Conductor access accounts used to access the database and to deploy workflows. These settings
must be configured before you can use Workflow Conductor.
� General Settings: Configure global options for Workflow Conductor.
� Workflow Designers: Configure who can design workflows in Workflow Conductor Studio.
� E-mail Settings: Set up the default e-mail templates used in some Workflow Conductor widgets.
� Widget Categories: Configure the categories for widgets in Workflow Conductor Studio.
� View Workflow Status: View the status of all workflow instances in your farm.
� Workflow Solution Management: View and manage Workflow Conductor workflow solutions in your farm.
� Licensing: Access the Bamboo Web License Manager. A license must be activated for production use, but is not required for trial installations.
� About Workflow Conductor: View the file version information for Workflow Conductor.
� Localizing Workflow Conductor: Learn how Workflow Conductor can take advantage of SharePoint localization capabilities (i.e. language packs).
To define required database and e-mail server settings for Workflow Conductor, go to Central Administration > Workflow Conductor Control
After Uninstalling a Product
Configuring Workflow Conductor
Workflow Conductor System Settings
Panel, and then click System Settings. You must configure these settings before you use Workflow Conductor.
SQL Server
Enter the name of the server and SQL Server instance where you installed the Workflow Conductor Configuration Database. For example:
� DBSERVER - The Conductor database is installed on the default SQL Server instance on the server DBSERVER.
� DBSERVER\OFFICESERVERS - The Conductor database is installed on the OFFICESERVERS instance on DBSERVER. This is common for
SharePoint 2007 installations that use SQL Server Express.
� DBSERVER\SharePoint - The Conductor database is installed on the SharePoint instance on DBSERVER. This is common for SharePoint 2010
installations that use SQL Server Express.
� DBSERVER\SQLINSTANCE - The Conductor database is installed on the SQLINSTANCE instance on DBSERVER. If the Conductor database is
installed on something other than the default instance on the SQL Server, you must specify the instance name.
E-mail Server
Enter the SMTP Server Name that you want to use to send e-mails from Conductor widgets. You can also enter the default From and Reply To e-
mail addresses. To use the SMTP Secure Authenticated Connection option, check the box and enter the secure SMTP port (usually 465) and
required login information.
To configure the Workflow Conductor access accounts, go to Central Administration > Workflow Conductor Control Panel, and then click
Account Settings. You must configure these accounts before you use Workflow Conductor.
Shared Services Account
Workflow Conductor Account Settings
The Shared Services Account is used by Conductor Studio, Conductor widgets, and at runtime as required by widgets. This account requires the
following permissions:
� Read, write, and execute permissions to the Conductor_Content database (the db_owner role is recommended).
� Must be a member of the local server Administrators group on each Web front-end server where Conductor is installed.
Deployment Account
The Deployment Account is used to deploy workflow solutions to your SharePoint farm. This account requires:
� Read, write, and execute permissions to the Conductor_Content database (the db_owner role is recommended). This account is used to save
the .wsp installation package to the database before it is deployed.
� Must be a member of the local server Administrators group on each Web front-end server where Conductor is installed and deployed.
� Must be a SharePoint Farm Administrator in order to deploy workflow solutions.
Moss User Profile Account
The MOSS User Profile Account is used by Workflow Conductor user profile widgets to access MOSS user profile data. The account you enter here
must have the Manage User Profiles Shared Services right, configurable in Shared Services Administration > Personalization services
permissions. This account is used to access the SharePoint User Profile Properties list. Access to specific user profile data is security trimmed at
runtime based on the permission of the user account configured for the widget in the Run As property.
Note: This setting is only required for Microsoft Office SharePoint Server.
To change global Workflow Conductor global settings, go to Central Administration > Workflow Conductor Control Panel, and then click
General Settings. You should review and update each setting listed here after you install Workflow Conductor.
� Default Task List Name
� Workflow Conductor Studio Logging
� Workflow Error Handling
� Workflow Deployment Schedule
� Workflow Conductor Log File Archiving
� Active Directory Settings
Select the default task list Conductor will use to enter tasks assigned by workflows.
TOP
Select the level of logging you would like Conductor Studio to perform during workflow design. This log level selection only affects logging during
design time. It is separate from the logging performed when a workflow runs, which is based on settings that are configurable for each widget in the
workflow.
Warning: Selecting All will write all possible log information to the database, but will increase the amount of database activity and may result in
performance issues.
Workflow Conductor General Settings
Default Task List Name
Workflow Conductor Studio Logging
TOP
Define how Conductor handles errors during workflow execution. By default, Conductor will stop a workflow if it encounters an error during runtime.
If you would like the workflow to continue with the next widget instead, select Go to Next Widget.
TOP
Define the behavior of the Deploy action in Conductor Studio. The default is Deploy workflows immediately. Since workflow solution deployment
requires that the application pool be recycled, administrators may want to schedule this activity. Select Schedule workflow deployment and
configure a deployment frequency and duration to modify the Conductor Studio Deploy action to schedule workflows for deployment instead of
deploying them immediately.
Note: If multiple workflows are scheduled for deployment, the application pool will be recycled after each workflow is deployed. A Deployment
Delay of “0” minutes will allow SharePoint to control the solution deployment schedule. To add a mandatory delay between each solution
deployment and associated application pool recycle, enter a specific number of minutes. Workflows that were not deployed during the specified Start
and End times will be deployed during the next scheduled window.
TOP
Define how Conductor handles log archiving for the Workflow Conductor Studio log files. By default, Conductor installs a SharePoint timer job that
will run weekly and will delete any Conductor Studio log entries in the Conductor database that are older than one month. If you would like to
change this behavior, the following options are available:
Archive Location: You can save archived log file data to a location on your server by entering a directory name. The directory you enter must
already exist on your system, and the Central Administration application pool user must have permissions to write to the directory.
Archive Log Entries Older Than: Select a filter for Conductor to use to delete log file entries from the database. You can delete entries older
than 1 month, 3 months, 6 months, or 12 months. The default is 1 month.
Archive Schedule: Select a schedule for the timer job to run. By default, it will run weekly.
Start Day/Time/Minute: Depending on what archival schedule you selected, you may also configure a day, time, and/or minute for the
timer job to start.
Workflow Error Handling
Workflow Deployment Schedule
Workflow Conductor Log File Archiving
TOP
Configure available LDAP paths for managing Active Directory users with Workflow Conductor widgets and set default account options for new Active
Directory accounts.
LDAP Paths: Click the Add New LDAP Path button to enter a new Active Directory LDAP path. Active Directory users and groups in this path
can be managed by Active Directory widgets in Conductor Studio.
� LDAP Path: Enter a valid LDAP connection string using RFC 4516 format: ldap://host:port/DN?attributes?scope?filter?extensions
� Example 1:ldap://ldap.example.org/dc=example,dc=org
� Example 2: ldap://ldap.example.org/ou=ChildOU,ou=ParentOU,dc=example,dc=org
� Example3:ldap://ldapserver/ou=ChildOU,ou=ParentOU,dc=example,dc=org
� LDAP Display Name: Enter the display name for the LDAP path in Active Directory widgets.
� User Name/Password: Enter the account information for an account with permission to modify objects in this LDAP path. Active
Directory widgets will run with the permission of this user.
� Users and groups: Enter a list of users and groups who will be able to see this LDAP path in Active Directory widgets. Separate multiple
entries with a semicolon (;). Users must be entered in the format DOMAIN\user. Groups must be entered in the format [Group] (including
the surrounding brackets).
Allow custom LDAP paths in widgets: Select this option to allow Conductor Studio designers to enter custom LDAP paths in Active Directory
widgets.
Account options: Define the default account options for all new accounts created with Active Directory widgets.
TOP
To specify who can design workflows in Conductor Studio, go to Central Administration > Workflow Conductor Control Panel, and then click
Workflow Designers. By default, any user with the Design Permission set in SharePoint can also use Conductor Studio.
To restrict who can design workflows in Conductor Studio, select the option Only the following users and groups and enter a list of SharePoint
users and/or groups. Only these users will be able to start Conductor Studio.
Note: All workflow designers must also have the Design permission set in SharePoint. Any user with Design permission will see the Create or Edit
Workflows option in lists and libraries, but only designers listed in the workflow designers list will be able to start Conductor Studio.
Active Directory Settings
Workflow Designers
To configure global e-mail templates for task e-mails sent by Workflow Conductor, go to Central Administration > Workflow Conductor Control
Panel, and then click E-mail Settings. You can configure templates for e-mail sent for Request Approval, Request Feedback, and Collect Data From
User task notifications, task reassignments, and task change requests.
To add references to elements like the list name, the workflow initiator, the workflow title, and other common elements, click the Add Lookup
button next to each section and select a lookup to insert. The actual value of the lookup will be filled in when the workflow runs.
Note: To add a hyperlink that has a display name different from the URL (e.g., Bamboo instead of http://www.bamboosolutions.com), enter the
hyperlink in the following format, including the surrounding brackets ([]): [_URL(http://url.com) ,_Text(Text to display)] See Using Lookups
and Variables for more information.
To set an e-mail template back to the system default, click the Reset to Default button below the template. To save changes to a template, make
sure to click OK at the bottom of the E-mail Settings page.
A sample e-mail using the example template above:
E-mail Settings
Widgets are displayed under different categories within Conductor Studio to make them easier to find. To add or delete categories or move widgets
to other categories, go to Central Administration > Workflow Conductor Control Panel, and then click Widget Categories.
View or edit the list of widgets in existing categories:
Category: Select the category you want to view or edit from the Category list. This will automatically update the Widgets list.
Show Widgets: Select All Widgets to show every widget available in Conductor Studio with a check next to those widgets that are assigned
to the category you have selected. Select Unassigned Widgets to show only those widgets NOT currently assigned to the category.
Widgets: To add a widget to the selected category, check its box and click OK. To remove a widget from a category, make sure All Widgets
is selected as the Show Widgets option, uncheck the box next to the widget you want to remove, and click OK. Prevent users from using a
particular widget in workflows by simply removing it from all categories. The widget can be easily added back in later.
Note: The full list of widgets is multiple pages. Click the 1 or 2 at the bottom of the widgets table to view the next page of widgets. Click OK
to save your updates on one page before clicking on the next page.
Add or Remove Categories: Click this link to add a new category or to remove an existing one.
To add a new category: Enter a Category Name and an optional Description for the new category, and click Save. There will be no
Widget Categories
widgets in the category by default. Add widgets to the category in the Widget Categories page.
To remove an existing category: Check the box next to the category or categories you want to delete, and click Delete .
Note: The widgets that were assigned to the category are not deleted, though you will no longer see them in Conductor Studio unless they are
assigned to another category.
The default localization file for this Bamboo Product is: Bamboo.{product name}.resx. This XML-based, English-US language file is installed in
several locations in order to take advantage of SharePoint’s built in localization capabilities (i.e. language packs). These locations are as follows:
� For Application Resources (Handles resources used in Application pages, custom actions including site action menu items and site settings
custom actions, navigation bars and Web Parts, and other application resource elements):
<drive>:\Program Files\Common Files\Microsoft Shared\web server extensions\12\CONFIG\Resources\
� For Provisioning Resources (Handles resources used within features, site definitions, list definitions, and other provisioning resource
elements):
<drive>:\Program Files\Common Files\Microsoft Shared\web server extensions\12\Resources\
� For the Global Resources for each Web Application in your farm (regardless of the web applications you choose during installation):
<drive>:\Inetpub\wwwroot\wss\VirtualDirectories\<port>\App_GlobalResources\
If you are using a language pack other than English-US (i.e. en-US), then you must make sure that the Bamboo.{product name}.resx file name
is changed to include the language pack culture name (i.e. Bamboo.{product name}.LanguageCode.resx). For example, if you are using the
language pack for French, then your Bamboo language resource file should be titled:
Bamboo.{product name}.fr-FR.resx
Where the green highlighting is the culture name for your language pack (including the period in front). You must title the language file in this way in
each of the locations it is installed (i.e. application resources, provisioning resources and global resources for each web application) if you are using
the French language pack.
Modifying the Language File
The Bamboo.{product name}.resx file is made up of IDs (i.e. data names) and strings (i.e. values). If you want to modify a string, make sure you
only modify the text between the <value> tags.
Once the file is updated, you must update this file in all of its locations. To update the application resources, you must open the Bamboo.{product
name}.resx file in the application resources location and make your changes. To propagate these changes out to the web applications, you must run
the following stsadm operation on each web frontend server to update the global resources location for each web application:
Stsadm –o CopyAppBinContent
Localization and Translation
To update the provisioning resources, you must manually copy the Bamboo.{product name}.resx file in the provisioning resources location.
NOTE: The Bamboo.{product name}.resx file will be overwritten with each upgrade of this product. If you choose to modify the strings in this file for
English-US, you must rename the file to Bamboo.{product name}.en-US.resx in order to keep your modifications. If this file is renamed for other
language packs, it will not be overwritten during upgrade.
Workflow Conductor allows Designers and Administrators to easily create custom workflows using a simple drag-and-drop interface. We call that
interface Workflow Conductor Studio, or Conductor Studio for short. It is a browser-based design interface that runs within SharePoint and can
be accessed directly from a list or library. For more information about using Conductor Studio, visit the following sections:
� Getting Started with Conductor Studio
� Workflow Settings
� Workflow Forms
� Building a Workflow
� Deploying a Workflow
� Workflow Conductor Templates
Note: Workflow Conductor Studio is installed along with the other core components of Workflow Conductor, but it also requires the Microsoft AJAX
Extensions to be installed and configured. Both of these steps are described in more detail in the section Installing the Product.
� Launching Conductor Studio
� Conductor Studio Interface
� Widget Pane
� Workflow Diagram Pane
� Settings Pane
� Conductor Studio Menus
Conductor Studio is the Workflow Conductor interface that allows you to create, edit, and deploy new workflows or workflow templates. To start
Conductor Studio, first make sure that the account you are using has Designer or administrator (Full Control) permissions for the list or library. Then,
navigate to a list or library and click Settings > Create or Edit Workflows.
Note: Administrators can further restrict who can design workflows in Conductor Studio using the Workflow Designers settings in Central
Administration > Workflow Conductor Control Panel. If you are a SharePoint Designer but do not have the Create or Edit Workflows option in the
Settings menu, contact your SharePoint administrator.
Using Workflow Conductor Studio
Getting Started with Conductor Studio
Launching Conductor Studio
The Workflow Conductor Studio interface is made up of four sections:
� The widget pane
� The workflow diagram pane
� The settings pane
� The Conductor Studio menus
The left section of Conductor Studio, the widget pane, contains a list of the widgets used to design a workflow. These are divided into several
categories based on the type of action a widget performs. To expand a category and view the widgets in it, click on the category name. To add a
widget to a workflow, drag it from the widget pane to the workflow diagram pane.
For more information about the features of a specific widget, see the Workflow Conductor Widgets section.
To learn how to edit widget categories and move widgets to new categories, see the Widget Category Settings section.
The center section of Conductor Studio is the workflow diagram pane, where widgets are dropped to create the workflow path. To add a widget to a
workflow, drag it from the widget pane to the workflow diagram pane and drop it to the desired location in the workflow.
Widgets can be dropped before or after any other widget, and in some cases they can even be dropped inside another widget. When a workflow
runs, widgets are executed from top to bottom. While some workflows may be a straight sequence of a few steps, certain widgets can be used to
create workflows with more complex paths (for example, the Conditional Branch widget).
The Conductor Studio Interface
Widget Pane
Workflow Diagram Pane
To copy, move, or delete a widget, right-click it in the workflow diagram pane and select Cut, Copy, Paste, or Delete from the shortcut menu.
� Cut and Copy copies the widget and its properties to the clipboard. Cut and Copy will retain any properties you have already configured for the
widget.
� To Paste a widget that you Cut or Copied, right-click in the desired location in the workflow and select Paste.
� Delete removes a widget from the workflow diagram.
The right section of Conductor Studio, the settings pane, contains two tabs:
Workflow Settings: Contains general settings for the workflow, including workflow start options, workflow variables and optional fields to be
completed when the workflow is started. For more information about available workflow settings, see the Workflow Settings section.
Widget Properties: Displays the properties of the currently selected widget.
After a widget is dropped into the workflow, it must be configured before the workflow can use it. To set the properties of a widget, click on it in the
Conductor Studio diagram to display the Widget Properties tab in the settings pane.
Widget Properties vary by widget. For a list of the properties unique to a particular widget, see the documentation for that widget in the Workflow
Conductor Widgets section. Properties marked with a red asterisk (*) in the Widget Properties tab are required. For a description of properties
common to all widgets, see the General Widget Properties section.
Important: After entering the properties for a widget, click Apply to save your settings. If something is not configured correctly, Conductor Studio
will warn you with a message at the bottom of the Widget Properties tab.
The following menu choices are available in Conductor Studio, at the top of the page:
� Workflow:
� New: Starts a new workflow. If you have a workflow already in progress, you will be prompted to save it.
� Open: Opens the Conductor Studio template gallery, where workflow templates are stored. See the Workflow Conductor Templates section
for more information.
� Save/Save As: Saves the workflow you are currently building.
� Print: Prints the workflow diagram pane.
Settings Pane
Conductor Studio Menus
� Import/Export: Imports or exports workflows to an .xoml file. XOML files can be used to transfer workflows between instances of
Workflow Conductor.
� Variables: Provides another way to access the Workflow Forms and Workflow Variables forms, which are also available in the Workflow Settings
tab in the settings pane.
� Publish: Allows you to deploy the current workflow to the farm, activate it in the site collection, and automatically associate it with the current
list. If you have not yet saved your workflow, you will be prompted to do so.
� View: Allows you to zoom in or out in the workflow diagram pane.
� Help: Displays links to the Product Documentation Online and version information for Workflow Conductor.
� Close: Closes Conductor Studio and returns to the list or library.
The Workflow Settings tab in the Conductor Studio settings pane allows you to set properties for the entire workflow.
Workflow Title (Required): Enter a name for the workflow. This name is displayed wherever this workflow is referenced within SharePoint.
Workflow Description: This is an optional setting that allows you to add a short description of the workflow. It is displayed in Conductor Studio,
and also in the list of workflows for a list or library.
Start Options: Select a start option for the workflow, from the list of workflow start options available in SharePoint. The default is Allow this
workflow to be manually started by an authenticated user with Edit Items Permissions.
Note: Start options that trigger a workflow to run automatically when an item is created, changed, or published cannot be used in combination with
workflow initialization forms. See the Workflow Forms section for more information.
Important: After entering or updating any of the settings listed above, click Apply to save your changes.
Workflow Settings
Workflow Forms: You can create a workflow initialization form that collects additional information from the user when a workflow is started. Data
collected via this form is stored in variables that can later be used by the workflow using a Workflow Variable lookup. For more information about
creating a workflow initialization form, see the Workflow Forms section.
This is an optional workflow setting.
Workflow Variables: Variables store data while the workflow is running. They can be accessed and manipulated by widgets, and some widgets may
require that a variable be created to store results. The contents of workflow variables are accessed using a lookup when the workflow runs.
To create a variable, click Add Variable to open the Workflow Variables form. Enter a Name for the variable, select a data Type, and optionally
define a Default Value. Click Add to add the new variable to the workflow. If you later want to delete a variable, return to the Workflow Variables
form and click the button next to the variable.
Workflow variables can also be added directly from widgets that use variables, using the Create new variable link. This link is a shortcut to the
Workflow Variables form.
Note: After adding, updating, or deleting variables using the Workflow Variables Form, always click Save Changes.
If you need to collect information from a user in an initialization form when a workflow is started, add a Workflow Form in Conductor Studio. The
Workflow Form is made up of one or more fields. Each field is stored in a workflow variable, which can be used by the widgets in the workflow. See
the example at the end of this section for more information about using Workflow Form variables.
Note: Workflows with an initialization form must be configured with a manual Start Option to allow users the opportunity to complete the required
form fields. The only supported Start Options are Allow this workflow to be manually started by an authenticated user with Edit Items
Permissions and Require Manage List Permissions to start the workflow.
To create a Workflow Initialization Form:
1. Click the Add Field button in the Workflow Settings tab. This will display the Form Builder. The Form Builder allows you to add fields to the
initialization form presented to the user when the workflow starts. Use this same form to edit, delete, or rearrange fields once the initialization
form is created.
2. In the Form Builder page:
� Click Add to add a new field to the initialization form.
� Select a field and click Modify to modify the settings for an existing field.
� Select a field and click Delete to delete an existing field from the form.
� Select a field and click Move Up or Move Down to rearrange the order of the field on the form.
3. When you click Add or Modify, complete the following in the Forms Settings pages:
Workflow Forms
Page One:
� Field Name: Enter a name for the field in the initialization form. The name can contain spaces, but not other special characters. This
name will also be the name of the variable in the workflow, which can be used by workflow widgets.
� Description: Optionally, enter a Description for the field. This text will appear below the field in the initialization form.
� Information Type: Select a data type for the form field. Supported data types are:
� Single line of text
� Multiple lines of text
� Number
� Date and Time
� Choice
� Yes/No
� Click Next to proceed to the second page of the Forms Settings.
Page Two:
� Optionally, enter a Default Value for the form field. You may have different options for default values depending on the data type
selected in the previous page. The screenshot below shows Default Value options for a Date and Time field.
� Click Finish to complete the initialization form field settings and return to the Form Builder.
The screenshot below shows an initialization form requesting two pieces of information from a workflow initiator. This form is displayed each time
this workflow is run on an item in the list or library. When the workflow initiator completes the fields and clicks Start Workflow, the workflow will
continue. If the workflow initiator clicks Cancel without completing the initialization form, the workflow will not run.
Example
The information collected from the user in the form above is stored in two workflow variables, which can be used by the widgets in the workflow. In
this example, the Due Date initialization form field above is used to set the Due Date on a Request Feedback widget.
Before building a workflow, make sure you are familiar with the Conductor Studio interface by reading Getting Started with Conductor Studio. All of
the actions referenced in the list below are described in that section. Once you understand how Conductor Studio works, the rest is easy:
1. First, plan your workflow. It may be helpful to draw it out on paper or a whiteboard so that you can make sure to capture all the steps in
your business process. Once you know what you want to accomplish:
2. In the list or library where you want the workflow to run, go to Settings > Create or Edit Workflows .
Building a Workflow
3. On the Workflow Settings tab in the settings pane, give your workflow a Title and Description and select the desired workflow Start Option. Make
sure to click Apply to save the workflow settings.
Tip: If you do not enter a Title and Description here, you will be prompted for one when you save the workflow.
4. Configure any workflow variables and workflow initialization form fields required for your workflow.
Tip: Workflow variables and form fields can be configured and updated at any time.
5. Drag widgets from the widget pane and arrange them in the workflow diagram pane according to your workflow requirements. For a description
of available widgets, see the Workflow Conductor Widgets section.
6. Set the required properties for each widget in the workflow on the Widget Properties tab in the settings pane. Make sure to click Apply after
configuring the properties for each widget.
7. When you are finished, click Save or Save As to save the workflow. See Workflow Conductor Templates for more information about saving
workflows.
Tip: If you do not save your workflow here, you will be prompted to save it when you deploy.
8. Click Publish > Deploy to deploy the workflow and associate it with the list or library. See Deploying a Workflow for more information about
what happens when you click Deploy.
9. Your workflow is now available in the list or library where you started Conductor Studio. Depending on the Start Option you selected for the
workflow, it can be started manually using the Workflows option for an item (as shown below), or will start automatically when an item is
created, changed, or published.
Now that you have successfully built and deployed a workflow, learn how to manage workflows in your farm.
A workflow cannot be used until it is deployed to SharePoint. To deploy a workflow, go to Deploy > Publish in the Conductor Studio menu. Several
things happen when you click Deploy:
1. First, Conductor checks to see whether the workflow is fully configured. If there is missing or invalid configuration information, Conductor will
display an error message with the details.
2. If there are any unsaved changes to your workflow, Conductor will prompt you to save the workflow as a template.
3. The workflow is compiled and deployed as a solution to all Web applications in the farm, according to the Workflow Deployment Schedule
settings in Workflow Conductor Control Panel > General Settings.
4. The workflow is also added and activated as a feature in the current site collection.
5. Finally, the new workflow is associated with the list or library where you launched Conductor Studio, with the Start Options you configured in the
workflow.
Note: Since the new workflow is a feature that is deployed and activated in SharePoint, the application pool will automatically cycle when a new
workflow is deployed. As a result, sites may be temporarily unavailable. You can control when this deployment and application pool recycle happens
by configuring a Workflow Deployment Schedule in Workflow Conductor Control Panel > General Settings.
The workflow is now ready to be used, and is displayed with other available workflows under the Workflows option for an item in that list or library.
Deploying a Workflow
When you create a workflow in Conductor Studio, you have the option to save it as a template in the Workflow Conductor template gallery, which is
stored in the Workflow Conductor database. Saving a workflow as a template has several advantages:
� Save a partially completed workflow and finish it later.
� Edit a previously deployed workflow to create a new version.*
� Save time when creating a new workflow by basing it on one you created earlier.
*Note: Once a workflow is deployed, you cannot deploy it again with the same name. You must either save and deploy it with a different name, or
remove the existing workflow solution from the farm. For more information about removing workflow solutions, see Bamboo Knowledge Base article
KB.12460: HOWTO: Remove a Workflow from a Site or Web Application.
Saving Workflow Templates
To save a workflow as a template in Conductor Studio:
� Go to Workflow > Save As or Workflow > Save in the Conductor Studio menu. Enter a Title and an optional Description for the workflow
when prompted.
� Go to Workflow > Save to save changes you have made since you last clicked Save or Save As.
� When you deploy a workflow (Publish > Deploy), you will be prompted to save your workflow if you have any unsaved changes.
� To overwrite an existing template, check the option to Overwrite existing files in the Save dialog box. This will overwrite any file with the
same name.
Opening Workflow Templates
To open a workflow template, go to Workflow > Open in the Conductor Studio menu. Click the radio button in front of a template name to select it,
and then click Open.
Using Workflow Conductor Templates
Deleting Workflow Templates
To delete a workflow template, go to Workflow > Open in the Conductor Studio menu. Click the Delete link next to the template name you want to
delete.*
*Note: Removing a workflow from your farm will not automatically delete the workflow template, and deleting a template from the template gallery
does not remove the workflow from your farm. Deployed copies of workflows are unaffected.
Workflow Conductor provides a number of tools to help you run, manage, and view the status of workflows in your farm.
For SharePoint contributors:
� Running Conductor Workflows
� My Workflows Web Part
� My Workflow Tasks Web Part
� Workflow Reports Web Part
For workflow designers:
� Viewing Workflow Status
� Managing Workflow Associations
� Running Workflows in Simulation Mode
� Log Viewer Web Part
For SharePoint administrators:
� Workflow Solution Management
Managing Workflows
Running Conductor Workflows
Workflows created and deployed with Workflow Conductor Studio are automatically associated with the list or library where you launched Conductor
Studio, and are started just like any other SharePoint workflow. Workflow start options can be configured when the workflow is designed, and can be
changed after the workflow is deployed.
If the workflow was configured to start automatically when an item is created, changed, or published, the workflow will start when one of those
actions takes place. If the workflow is configured to allow it to be manually started, it can be started as follows:
1. In the list or library where you created the workflow, choose Workflows from a list item shortcut menu, or click the Workflows link while
viewing the properties for an item.
2. A list of all workflows available for the list or library is displayed, and includes Workflow Conductor workflows and any available SharePoint
workflows. Select the workflow you want to run.
3. If you picked a workflow created in Workflow Conductor, a confirmation page is displayed. If the workflow has an initialization form associated
with it, the form is also displayed. Enter any required information and click Start Workflow to start the workflow.
Users with workflow Designer permissions have additional options to start the workflow in Simulation Mode and to override widget Logging Level
settings.
The My Workflows Web Part displays all the workflows initiated by the current user in the site, the Web application, or the entire farm. My
Workflows displays the status, workflow name, a link to the item the workflow was started on, and additional information that might be relevant
depending on the type of workflow. From this Web Part, the workflow initiator can also Cancel a workflow that is Running, or Restart a workflow
that Errored.
The My Workflows Web Part is available in the Web Part Gallery after Workflow Conductor is installed. Users with the Add and Customize Pages right
can add the Web Part to a page. The Add and Customize Pages right is included by default in the Design and Full Control permissions.
To add the Web Part to a Web site page:
1. On a Web site page, click Site Actions in the upper right corner.
2. Select Edit Page.
3. Find the zone where you want to install the Web Part and click Add a Web Part.
4. From the Add Web Parts window, find and select the My Workflows check box and then click Add.
To configure the Web Part:
My Workflows Web Part
The My Workflow Tasks Web Part displays tasks assigned by the Request Approval and Request Feedback widgets. My Workflow Tasks can display
tasks for the current user or for all users, and can display tasks for the site, the Web application, or the entire farm.
The My Workflow Tasks Web Part is available in the Web Part Gallery after Workflow Conductor is installed. Users with the Add and Customize Pages
right can add the Web Part to a page. The Add and Customize Pages right is included by default in the Design and Full Control permissions.
To add the Web Part to a Web site page:
1. On a Web site page, click Site Actions in the upper right corner.
2. Select Edit Page.
3. Find the zone where you want to install the Web Part and click Add a Web Part.
4. From the Add Web Parts window, find and select the My Workflow Tasks check box and then click Add.
Workflows:
� Select the scope of workflows to display. By default, the Web Part will display
workflows for the Current Site. You can also select Web Application or
Farm.
� Select which workflow statuses to include in the list. The Web Part will include
all workflow statuses by default.
Paging Settings:
� Select the maximum number of items to include in the list and the number of
items to display per page.
Display Settings:
� Select Display document titles to display the Title field of an item, if one is
available. Select Display filenames to display the Name field of an item, if
one is available.
� Uncheck the Wrap Text box if you prefer the Web Part zone width to
automatically adjust so that all items in this Web Part fit on one line.
Sorting:
� Select your preferred sort column and sort order.
My Workflow Tasks Web Part
To configure the Web Part:
The Workflow Reports Web Part allows you to create reports about workflows run in the current site or site collection. The report is displayed
graphically, with a summary list below the chart. You can define reporting periods, filter by workflow status, and print report results using the
controls at the top of the Web Part (see below for more information).
Tasks:
� Select the scope of workflows to display. By default, the Web Part will display
workflows for the Current Site. You can also select Web Application or Farm.
� Select whether to Display tasks for current user or Display tasks for all
users.
List Length:
� Select the maximum number of items to include in the list and the number of
items to display per page.
Display Settings:
� Select Display document titles to display the Title field of an item, if one is
available. Select Display filenames to display the Name field of an item, if one
is available.
� If desired, check options to Display Status column, Display time since task
was created, or Display workflow initiator.
� Uncheck the Wrap Text box if you prefer the Web Part zone width to
automatically adjust so that all items in this Web Part fit on one line.
Sorting:
� Select your preferred sort column and sort order.
Workflow Reports
The Workflow Reports Web Part is available in the Web Part Gallery after Workflow Conductor is installed. Users with the Add and Customize Pages
right can add the Web Part to a page. The Add and Customize Pages right is included by default in the Design and Full Control permissions.
To add the Web Part to a Web site page:
1. On a Web site page, click Site Actions in the upper right corner.
2. Select Edit Page.
3. Find the zone where you want to install the Web Part and click Add a Web Part.
4. From the Add Web Parts window, find and select the Workflow Reports check box and then click Add.
To configure the Web Part:
To use the Web Part:
� Define a reporting interval by selecting dates in the Start and End fields.
� Select a Period to summarize the data. You can summarize data by Day, Week, Month, or Quarter.
� If you want to filter for only a specific workflow status, choose it from the Workflow Status list.
� Once you have defined reporting options, click View Report to apply your settings.
� To print the chart and summary data, click the Print button.
There are several ways to view the status of a workflow in Workflow Conductor. Go to each of the sections listed below for more details about each
method.
� Workflow Conductor Workflow Status Page: View all workflows started on an item
� SharePoint Workflow Status Page: View the most recent workflow started on an item
� Workflow Conductor Control Panel > View Workflow Status: View all workflows started in the Web application
Workflow Conductor adds an option to the list item menu called Workflow Status. This option displays a Workflow Status page that lists all
instances of the workflow that have been started on that item, sorted by status. The list also includes the name of the person who started the
workflow instance, when it was started, and when there was last activity (useful for long-running workflows).
Workflows:
� Select the scope of workflows to display. By default, the Web Part will display
workflows for the Current Site. You can also select Site Collection.
Select Chart Type:
� Choose the Chart Type the Web Part will use to display results. By default,
the Web Part will use a Bar chart.
Select Chart Template:
� Select a Chart Template to format the chart area. A number of pre-defined
color schemes are available.
Display Settings:
� Optionally, enter a fixed Height and Width for the report.
List Length:
� Select the maximum number of items to include in the list and the number of
items to display per page.
Default Reporting Interval:
� Select a default reporting interval for the Web Part. The default (None) will
show the last week of data.
Viewing Workflow Status
Workflow Conductor Workflow Status Page
To view the detailed history of an individual workflow instance, click its name in the Workflow Name column. The Conductor Workflow History
page displays a list of tasks assigned during the workflow and the workflow history logged for that workflow instance.
When you start a workflow on a list or library item, SharePoint adds a column to the Default view of the list that matches the workflow name. This
column contains the status of the most recent workflow instance started on that item with a link to the SharePoint Workflow Status page for that
workflow instance.
Note: SharePoint will add a workflow status column for only the first 15 workflows associated to the list.
To view a consolidated workflow history of all workflows in the Web application, go to Central Administration > Workflow Conductor Control
Panel > View Workflow Status. On the View Workflow Status page, select a Web application to view the workflow history for all workflows in that
Web application.
SharePoint Workflow Status Page
View Workflow Status
The Workflow Status table has several features to help you organize and identify relevant workflow data:
� To filter workflow history data, enter a string in the filter box below the column name, click the filter icon, and select a filter criteria. You can
apply one filter at a time. To remove a filter, click the filter icon and select No Filter.
� To sort a column, click on the column name.
� To group workflow history data, drag a column name to the area above the columns. You can group by multiple columns. To change grouping
order, drag the column name to a different position. To remove a grouping, drag the column name away from the grouping area.
� To export the current view of workflow history data to Excel, click the Export to Excel button.
Any workflow deployed from Conductor Studio is automatically associated with the list or library where Conductor Studio was opened. This section
covers the following workflow association options:
� Adding a Workflow Association
� Removing a Workflow Association
� Disabling a Workflow
� Changing Workflow Options
Once you deploy a workflow, it is automatically associated with the list or library where you created it, but it is also available to any list or library in
the site collection. If your workflow configuration is generic enough, you may not need to modify the workflow at all for it to run with other lists.
To associate an existing workflow with a different list or library:
1. In the list or library, click the Settings menu, and then click Document Library Settings or List Settings.
2. In the Permissions and Management section, click Workflow settings.
Managing Workflow Associations
Adding a Workflow Association
3. In the Change Workflow Settings page, click Add a workflow.
Note: If you have never previously added a workflow to this list or library, you will bypass this screen.
4. Select the workflow from the Workflow list. Any Workflow Conductor workflows or default SharePoint workflows that are deployed to the farm
and activated as a feature in the site collection are displayed in the list of available workflows.
5. Give the workflow a name unique to this list (this does not have to match the workflow name), select the Task and History lists the workflow
will use, define your desired Start Options, and click OK.
Your workflow is now associated to the current list or library and is listed as an available workflow for list items.
To remove a workflow association, go to Settings > Associated Workflows in the list or library, and then click the Delete link next to the
workflow. The workflow will no longer be available for items in the list or library, but remains available to the site collection. Deleting an association
in one list does not affect the workflow in other lists, and you can re-associate the workflow to the list or library later (see the Adding an Association
section above).
For instructions to remove a workflow from the site collection or Web application, see the Bamboo Knowledge Base article HOWTO: Remove a
Workflow From a Site or Web Application.
Warning: Any instances of the workflow that are in progress will be terminated and you will lose access to all workflow history data. If you only
Removing a Workflow Association
want to prevent users from starting new instances of the workflow, see Disabling a Workflow.
The Removing a Workflow Association section showed you how to completely remove a workflow association from a list or library. Removing a
workflow terminates any instances of the workflow that might be running, and removes the workflow history. If you just want to prevent users from
starting new instances of the workflow but you want to let running instances finish or you want to keep workflow history data available, use the
SharePoint Workflow settings page to disable the workflow instead.
1. In the Workflow settings page (Settings > List Settings > Workflow Settings), click Remove a workflow.
2. In the Remove Workflows page, choose the No New Instances radio button for the workflow you want to disable. This will allow current
workflow instances to finish, but the workflow is no longer listed in the available workflows list.
If you want to remove the workflow association later, you can either return to the Remove a workflow page and choose the Remove option, or
follow the instructions for Removing a Workflow Association in the Workflow Conductor Associated Workflows feature. To enable the workflow
again, return to the Remove a workflow page and choose the Allow radio button.
Workflow Conductor workflows support the same options as any other SharePoint workflow. To set these options after a workflow is deployed, go to
Settings > List Settings in the list or library, and choose Workflow settings in the Permissions and Management section.
In the Workflow settings page, click the workflow name to change any of its settings, including:
� The workflow name
� The Task and History lists the workflow uses
� Start options for the workflow:
� Permissions required for starting the workflow
� Starting the workflow automatically when an item is created or changed
When a workflow is started manually, workflow designers have the option to run the workflow in Simulation Mode. Simulation Mode allows designers
to test workflow functionality without affecting other users. It skips all delays, and sends e-mail and assigns tasks only to the workflow initiator.
Specifically, Simulation Mode affects workflows in the following ways:
� All Delay For and Delay Until widgets are skipped.
� The Delay Time property in any Repeat While widgets is changed to "0".
� Approvers and Reviewers configured in Request Approval and Request Feedback widgets are changed to the workflow initiator.
Disabling a Workflow
Changing Workflow Options
Running Workflows in Simulation Mode
� Send Email widgets will send e-mail only to the workflow initiator.
� The Assigned To property of any Create Task widgets is changed to the workflow initiator.
� Echo Test widgets will send e-mail only to the workflow initiator.
To start a workflow in Simulation Mode, check the appropriate checkbox in the workflow initiation page before clicking the Start Workflow button.
Workflow designers also have the option to override the logging level configured for widgets and specify a new logging level for all widgets for that
workflow instance. To override the widget logging level, select the desired logging level in the workflow initiation page.
The Conductor Log Viewer displays log messages from the Conductor database. The Log Viewer can display messages generated from Conductor
Studio (Design time log) or from workflows (Run time log), and can show messages for the current site, for all sites in the Web application, or for
the entire Farm. The level of detail for Conductor Studio design time logs is based on the Workflow Conductor Studio Logging setting in the
Workflow Conductor Control Panel General Settings page. The level of detail for workflow run time logs is based on the Logging Level selected for
each widget in the workflow.
Note: If you leave the default Errors Logging Level setting for all widgets in your workflow and your workflow runs with no errors, you will not see
anything in the Run time log view in Log Viewer. This is normal behavior.
The Conductor Log Viewer Web Part is available in the Web Part Gallery after Workflow Conductor is installed. Users with the Add and Customize
Pages right can add the Web Part to a page. The Add and Customize Pages right is included by default in the Design and Full Control permissions.
To add the Web Part to a Web site page:
1. On a Web site page, click Site Actions in the upper right corner.
2. Select Edit Page.
3. Find the zone where you want to install the Web Part and click Add a Web Part.
4. From the Add Web Parts window, find and select the Conductor Log Viewer check box and then click Add.
Conductor Log Viewer
To configure the Web Part:
To use the Web Part:
� Select Run time log (the default) to view the workflow logs in the Conductor database. The level of detail for workflow run time logs is based
on the Logging Level selected for each widget in the workflow.
� Select Design time log to view the Conductor Studio logs in the Conductor database. The level of detail for Conductor Studio design time logs
is based on the Workflow Conductor Studio Logging setting in the Workflow Conductor Control Panel General Settings page.
� Select a scope for the log view: Current Site, Web Application, or Farm.
� Use the paging links at the bottom of the window to view additional log entries.
� Click the Export to Excel button to export the current view of log entries to Excel.
� If sorting is allowed by the Web Part Properties: Click on a column name to sort log entries.
� If filtering is allowed by the Web Part Properties: To filter log entries, enter a string in the filter box below the column name, click the filter icon,
and select a filter criteria. You can apply one filter at a time. To remove a filter, click the filter icon and select No Filter.
Paging Settings:
� Select the maximum number of items to include in the list and the
number of items to display per page.
Dynamic Settings:
� Allow Filtering: Check this box to allow users to filter log entries.
� Allow Group By: Check this box to allow users to group log entries.
� Allow Sorting: Check this box to allow users to sort log entries.
Export Settings:
� Check the Allow Export to Excel box to allow users to export log
entries from Log Viewer to an Excel spreadsheet.
Log File Archive Schedule:
� To archive Run time logs, select an archive period from the list and click
Run. Workflow logs older than the selected archive period will be
deleted from the Conductor database (there may be a delay of up to 5
minutes). You must be a site collection administrator to use this feature.
Note: This does not affect the Conductor Studio design time logs, which
can be archived from the General Settings page in the Workflow
Conductor Control Panel.
� If grouping is allowed by the Web Part Properties: Drag a column name to the area above the columns to group log entries. You can group by
multiple columns. To change grouping order, drag the column name to a different position. To remove a grouping, drag the column name away
from the grouping area.
Workflow Conductor provides a central page to view and manage workflow solutions deployed with Workflow Conductor. To view the list of Workflow
Conductor workflow solutions, go to Central Administration > Workflow Conductor Control Panel, and then click Workflow Solution
Management. This list is similar to the Operations > Solution Management list in SharePoint Central Administration, but limits the list of
solutions to those deployed by Workflow Conductor.
To retract a workflow solution from the Web application, click its name in the Workflow Solution Management list. Enter a time to schedule the
retraction (which will recycle the application pool), and click Retract Solution. For more information about retracting workflow solutions, see
Bamboo Knowledge Base article KB.12460 – HOWTO: Remove a workflow from a site or Web application.
Important: Before you retract a solution, make sure you have removed its associations with lists and libraries in the site collection. If you do not,
the workflow will still be listed as associated to the list or library, users will still see it as an available workflow for list items (though it will not run),
and new workflows deployed with the same name may have to be manually associated before they can run. This is an issue with WSSv3 and MOSS
2007. For more information about removing workflow associations, see Bamboo Knowledge Base article KB.12458 – HOWTO: Remove a workflow
from a list or library.
Managing Workflow Solutions
After the solution is retracted, its Status in the Workflow Solution Management list will change to Not Deployed (you may need to refresh the
page). The solution is no longer available to associate to any list in the Web application. If you want to be able to deploy the workflow solution again
later, you can leave it in the list. However, you will not be able to deploy any other workflows with the same name to the same Web application.
To completely remove the workflow solution from the farm, click its name again and click Remove Solution.
To view the number of associations for a workflow, go to Site Actions > Site Settings in the top-level site (you must be a Site Collection
Administrator). In the Galleries section, click Workflows.
For trials, no license key is required. For more information on our licensing, refer to http://store.bamboosolutions.com/BambooMainWeb/FAQ.aspx.
Once purchased, the product licensing is controlled through a separate license key and activation program installed on the server where
SharePoint Central Administration is installed. To license Bamboo products, you must:
1. Install the Bamboo Web License Manager on the SharePoint server where SharePoint Central Administration is installed (just install one time -
not for each product that you install).
2. From Bamboo Web License Manager, locate the product you want to activate, enter in your license key(s) and activate the product on the
servers you want the product to run - all from one place. You can activate the license online or via email.
You can also check the licensing status of Bamboo products you installed to determine whether a product trial will soon expire or whether the
product has been deactivated or not.
You must be a machine and SharePoint Farm administrator to install and run the Bamboo Web License Manager.
1. On the server where SharePoint Central Administration is installed, then from the Setup program screen, click the Bamboo Web License
Manager component button, then click Install.
2. Click Next to continue.
3. The program performs some system checks to determine whether your server is ready for installation. Click Next to continue.
4. The program is restricted to only install the Bamboo Web License Manager on the server where it detects the SharePoint Central Administration
has been installed. This Web application should be already selected for you as well as the Automatically activate this feature check box. Click
Next to continue.
5. The Bamboo Web License Manager is then installed on the server. Click Next to view a details screen of the installation.
6. Click Close.
For troubleshooting and additional information, see the Knowledge Base or log into My Bamboo.
TOP
1. Open SharePoint Central Administration (make sure you have the proper access rights to log in), click Operations under the Central
Administration section of the left navigation bar.
About Licensing
Installing the Bamboo Web License Manager
Licensing and Activating the Web Part
2. Under the Bamboo Solutions Corporation section, click Bamboo Web License Manager. Note: If you have not yet installed any Bamboo
products, the Web License Manager does not show any products.
3. Expand the Individual Products or Suites section (depending on the product you want to license), locate your product, and click the product
name to view the license status or click the drop-down arrow to Activate/Deactivate or view the Status.
4. Do one of the following:
� If you want to activate the product without viewing the status, click Activate/Deactivate from the drop-down (see screenshot above).
� If you are viewing the licensing Status, then click the status to activate or deactivate the license.
5. Do one of the following:
� To activate online, type or copy and paste the license key into the field provided and click Activate.
� To activate by email, enter the license key and select the Activate by E-mail check box, then click Activate.
6. If you choose to activate by email, click the [email protected] email address and send the License Key and Machine Key to Bamboo
Support. Our Support Team will reply with an activation key that you will then type into the boxes provided. Then click Activate.
7. Your product has now been activated and is ready for use.
8. Optional Step: Click the Choose License Server(s) link. This page allows you to select all the web front end servers you may want to install
Bamboo products on. However, this is optional. Please read the license servers page to determine your selections. Click OK, after you have
made your selections.
TOP