Remove a Workflow Solution From a Site Collection or Web Application

APPLIES TO:

Workflow Conductor 1.0 through 1.6.1
Workflow Conductor 2.0 and higher configured to use Solution Deployment
Windows SharePoint Services 3.0 and Microsoft Office SharePoint Server 2007
SharePoint Foundation 2010 and SharePoint Server 2010

A Workflow Conductor workflow solution must be deployed in order to test it. If a Designer creates multiple versions of a workflow before a “final” version is ready, the earlier versions remain in the site in multiple places:

As an associated workflow in the list or library
As an active feature in the site collection
As a deployed solution in the Web application

Designers or administrators may want to remove these earlier versions to prevent confusion and to maintain a clean SharePoint environment. There are multiple ways to do this, depending on how completely you want to remove the workflow solution and what permissions you have in the site:

Disable the workflow in the list or library ( Design or Full Control permission on the list or library)
Delete the workflow association in the list or library ( Design or Full Control permission on the list or library)
Deactivate the workflow feature in the site collection (Site Collection Administrator)
Retract and remove the workflow solution from the Web application (member of the Farm Administrators SharePoint group)

How to modify a web.config file using PowerShell

Background

Some custom SharePoint products make changes to the web.config file of a web application via SPWebConfigModification calls in order to support particular features. There is a web.config file for each web application on your farm and they reside on each WFE server. If your farm has 3 WFE servers and 2 web applications, you have 6 web.config files.

For SharePoint 2010, Bamboo product installs may add entries to the web.confg to support Telerik functionality. Telerik is a 3rd party that provides some user interface controls for some Bamboo products. See Bamboo products that use Telerik for a list.
For SharePoint 2007, Bamboo product installs may add entries to the web.confg to support Telerik and AJAX functionality. We use AJAX to allow web applications to send data to, and retrieve data from, a server asynchronously (in the background) without interfering with the display and behavior of the existing page. See Bamboo products that use AJAX for more information.

At times, some of these changes need to be modified (via additions to the web.config), or partially removed for particular web applications on your SharePoint farm.

It is neither recommended nor a best practice to manually update a web.config file. Manual changes are not tracked by SharePoint in the configuration database; as such, they will likely cause future problems for users on the farm. For example, when creating a new web application, the new web.config is generated automatically by SharePoint and the auto-generated file will not include any changes that were made manually.

Resolution

Use PowerShell to programmatically remove or add web.config modifications so that changes are updated in the configuration database as well as on the server(s). An added benefit of making changes via PowerShell is that SharePoint will propagate the changes, so if you have 6 web.config files on your farm, you need to run the PowerShell script only once.

For more information, please see:

Release Notes for Workflow Conductor

NOTE: Release Notes will open in a new browser tab

WSSv3/MOSS	SharePoint 2010	SharePoint 2013	SharePoint 2016
Release Notes	Release Notes	Release Notes	Release Notes
Microsoft ended mainstream support for SharePoint 2007 in October 2012. See Microsoft’s Lifecycle Support Policy. At that time, Bamboo stopped enhancements to our SharePoint 2007 product line, but continues to provide support and bug fixes to customers with active support contracts until October 2017. Previously purchased licenses will continue to function after October 2017, but support for these products will end, and no additional bug fixes will be provided beyond that time. Bamboo plans to cease selling new licenses and annual support contacts for its SharePoint 2007 products in October 2016 to ensure customers will be eligible to receive support for at least one year after purchase.	Microsoft plans to end mainstream support for SharePoint 2010 in October 2015. See Microsoft’s Lifecycle Support Policy. At that time, we will stop any enhancements for our SharePoint 2010 product line but will continue to provide support and bug fixes for our SharePoint 2010 products to customers with active support contracts until October 2020. Previously purchased licenses will continue to function after October 2020, but support for these products will end, and no additional bug fixes will be provided beyond that time. Bamboo plans to cease selling new licenses and annual support contacts for its SharePoint 2010 products in October 2019 to ensure customers will be eligible to receive support for at least one year after purchase.	Visit our website where you can get the latest info about each of our products for SharePoint 2013. A separate installation package and license key is required for SharePoint 2013 deployment. For additional details, review the following knowledge base articles: How to Migrate Your Bamboo Products to SharePoint 2013 How to Move Bamboo Product Licenses to SharePoint 2013	Bamboo Solutions has also begun releasing products for SharePoint 2016. For additional details, check the product release notes in the link above, or contact us. For details on migration, see the Knowledge Base Article “Migrate Bamboo Products from SharePoint 2013 to SharePoint 2016”

WSSv3/MOSS

SharePoint 2010

SharePoint 2013

SharePoint 2016

Release Notes

Microsoft ended mainstream support for SharePoint 2007 in October 2012. See Microsoft’s Lifecycle Support Policy.
At that time, Bamboo stopped enhancements to our SharePoint 2007 product line, but continues to provide support and bug fixes to customers with active support contracts until October 2017. Previously purchased licenses will continue to function after October 2017, but support for these products will end, and no additional bug fixes will be provided beyond that time. Bamboo plans to cease selling new licenses and annual support contacts for its SharePoint 2007 products in October 2016 to ensure customers will be eligible to receive support for at least one year after purchase.

Microsoft plans to end mainstream support for SharePoint 2010 in October 2015. See Microsoft’s Lifecycle Support Policy. At that time, we will stop any enhancements for our SharePoint 2010 product line but will continue to provide support and bug fixes for our SharePoint 2010 products to customers with active support contracts until October 2020. Previously purchased licenses will continue to function after October 2020, but support for these products will end, and no additional bug fixes will be provided beyond that time. Bamboo plans to cease selling new licenses and annual support contacts for its SharePoint 2010 products in October 2019 to ensure customers will be eligible to receive support for at least one year after purchase.

Visit our website where you can get the latest info about each of our products for SharePoint 2013.

A separate installation package and license key is required for SharePoint 2013 deployment. For additional details, review the following knowledge base articles:

Bamboo Solutions has also begun releasing products for SharePoint 2016. For additional details, check the product release notes in the link above, or contact us.

For details on migration, see the Knowledge Base Article “Migrate Bamboo Products from SharePoint 2013 to SharePoint 2016”

Understanding Bamboo Releases:

Bamboo offers Trial, Basic and Premium support.
- Free Trial support expires after 30 days.
- For more information about Basic and Premium support, please see the Support Plans page.
- There may be a fee to upgrade from a major version to another.

See Also:

Reassign Task

Reassign Task is an option reviewers and approvers have when completing Request Feedback and Request Approval tasks, and is not a separate widget. This option allows a reviewer or approver to delegate the original review, approval, or data collection task to another user. The Reassign Task option is available if the Allow Reassignment property for the Request Feedback or Request Approval Widget is set to Yes, as shown here. If this property is set to Yes, a Reassign Task button is displayed at the bottom of the feedback, approval, or data collection task form.

To reassign a review or approval task to another user, edit a task assigned to you:

Step	Action	Result
1.	Click the Reassign Task button at the bottom of the review or approval task form.
2.	Enter a single user or group in the Delegate To box, enter a due date in the Due Date* box (if the task needs one), and enter a Description for the task.	NOTE: The earliest Due Date is always used. Forexample, if the reviewer or approver assigns a Due Date that is earlier than the Due Date in the original task, the workflow uses the new Due Date. However, if the reviewer or approver assigns a Due Date that is later than the Due Date in the original task, then the workflow uses the Due Date in the original task.
3.	Click Submit to reassign the task.

After you click Submit in the Reassign Task form, several things happen:

A new task is created for the user or group you entered in the Delegate To box.
If the Send Email property in the Request Feedback or Request Approval widget is set to Yes, the new user or group is sent a notification e-mail. You can customize the content of this e-mail in the Request Feedback or Request Approval widget Reassignment Subject/Body properties. Default text is specified in the Request Approval or Request Feedback Task Reassignment sections of the Workflow Conductor Control Panel E-mail Settings.
The original task status is updated to Completed.
The Outcome field for the original task and the Description field for the new task show the task reassignment details.

Best Practices for a successful install

Follow these guidelines to ensure a successful installation:

No.	Function
1.	Back up your system.
2.	Make sure that your system meets the requirements listed in the System_Requirements section.
3.	Installing PM Central, Community Central, Grants Management, or other applications may upgrade some Bamboo components previously installed in your SharePoint farm. For example, PM Central includes the Data Viewer Web Part (among other things) and installing PM Central may upgrade the Data Viewer Web Part that you may have previously installed. Before installing PM Central or another Bamboo application, make sure you understand the effect upgrading installed components will have on your existing solutions.
4.	Before installing, review information about where to run the Setup program in Location of Install Files and the Required Installation Permissions. This information is shown on the Installation/Setup program interface, but is also available from the links above.
5.	If you are upgrading an existing, installed product rather than installing it for the first time, read the information about Upgrading for the product you are interested in. The upgrade process is slightly different than installing for the first time.
6.	On all servers in the SharePoint farm where the solution will be deployed: Go to Start > Administrative Tools > Services and stop or restart the following services: Stop the World Wide Web Publishing Service on all servers. Do this step first because it prevents users from accessing sites during installation and files that may need to be updated from being locked. Note: If your SharePoint environment is configured for Claims Based Authentication or is running SharePoint 2013 or SharePoint 2016, you should NOT stop the World Wide Web Publishing Service if you wish to automatically activate product features during installation. Read SharePoint 2010 solution deployment when Claims Based Authentication is configured for more information. Restart the Microsoft SharePoint Foundation Timer service (called SharePoint Timer Service for SharePoint 2013 and 2016, SharePoint 2010 Timer service if you are using SharePoint 2010, or Windows SharePoint Services Timer service if you are using SharePoint 2007) on all servers. Do this step even if the service is currently running. It will ensure no files that may need updating are locked. Restart the Microsoft SharePoint Foundation Administration service (called SharePoint Administration in SharePoint 2013 and 2016, SharePoint 2010 Administration service if you are using SharePoint 2010, or Windows SharePoint Services Administration service if you are using SharePoint 2007) on all servers. Do this step even if the service is currently running. It will ensure no files that may need updating are locked.
7.	Review the Options for Installing.

Return to Installing for the first time

Best Practices for a successful Workflow Conductor Install

Installing WF Conductor for the first time…

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.

Top

Before Installing	During the Installation	After Installing

Top Before Installing for the first time
Read Best practices for a successful intstall. This information is generic and applies to all Bamboo products.
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 Workflow 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.
Required SQL Server permissions for the Workflow Conductor Configuration Database component are listed in the installation, but also shown in the screenshot below because they are often overlooked.
See Options for Installing and Overview of Workflow Conductor Components to Install for additional details.
Top During the Install
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 or the App Pools if you are using SharePoint 2013 or Claims-based Authentication to ensure that no one can access the system.
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 component installation will tell you what, if anything, 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 After Installing
Go to the Workflow Conductor section 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, Select the Workflow Conductor database you created during installation, and Enter the e-mail server to use for e-mail sent by Workflow Conductor widgets. NOTE: Workflow Conductor will not work if you do not configure the SQL Server and Workflow Conductor Database settings. Account Settings. Configure the access accounts for Workflow Conductor. Workflow Conductor will not work if you do not configure these accounts. Licensing. If you have purchased a license for Workflow Conductor, see [] for more information about activating it. All other Workflow Conductor settings are optional, and can be configured as needed to customize Workflow Conductor for your environment.

Query Database

The Query Database widget executes a single SELECT, INSERT, UPDATE, or DELETE SQL statement against a database. The results of SELECT statements can be stored in a workflow variable. The widget supports SQL Server, Oracle, ODBC, and OLEDB connections.

NOTE: In the case of SELECT statements, the Query Database widget returns either a single value (field) or a single record (row). SQL statements should be constructed with this in mind.

If the query returns multiple fields or rows, the widget will only store the first row or the first field from the first row of results, depending on the variable type selected for the results. See the Save To Variable property description below for more information.

Widget Properties:

Column	Description
Connection Type (Required)	Select the type of database connection to use. Available choices are SQL Server, ODBC, OLEDB, and Oracle.
Connection String (Required)	For ODBC, OLEDB, and Oracle connection types, manually enter the connection string. For SQL Server connections, click the button to define the following additional properties: Server name: Enter the Server name for your SQL Server database. Authentication: Select Windows Authentication or SQL Server Authentication. Windows Authentication will use the login credentials of the workflow initiator. SQL Server Authentication will use the Username and Password defined in the widget. Username/Password: To connect using SQL Server Authentication, enter a Username and Password. Database: Click the Get Database button to retrieve a list of databases on the specified server, and select the database you want to query. Query: Enter a valid SQL statement. Any SQL statement you enter here will propagate to the Query String property in the main Widget Properties form. Results: To test your database connection, enter a SQL statement in the Query box and click the Test button. For INSERT, UPDATE, or DELETE statements, only the database connection string is tested. For SELECT statements, the query string is also tested, and a result indicating success or failure is shown in the Results field. Statements containing lookups cannot be tested, since lookup values are not determined until the workflow runs. NOTE: You can also test ODBC, OLEDB, and Oracle connection types from this property form.
Query String	Enter a single SQL statement to execute against the database. SELECT statements should be constructed to return a single field from a single row or a single record (row) of results. Click the button to include lookups in your statement.
Save to Variable	Select a workflow variable with a Text or Record data type to store the query results (applicable only for the results of a SELECT statement). Create variables in the Workflow Settings tab in the settings pane, or click the Create new variable link next to the variable list.
Run As	This widget can run with the permissions of the workflow initiator, the workflow designer, or another user. Select the option in the Run As property that best matches your requirement. For more information, see the Common Widget Properties topic.
Click Apply to save the widget settings.

Example Using Query Database Widget

Return to External Data Widgets

See Also:

Pause Workflow

If you would like the opportunity to either select the error-handling option or resolve the error and continue the workflow, use the Pause Workflow option. The workflow is paused, although its status in the list remains In Progress.

If you view the status using the Workflow Status option in the item drop-down menu, the status displayed is Paused.

Pause Workflow triggers the following actions:

A notification is sent to the list of people defined in the Workflow Error Reporting settings. The notification includes a link to an Error Handling Form, where you can select the error-handling option to use. You can also access this form by clicking the Paused link in the Workflow Status page.
The Error Handling Form includes the details of the error message and provides options to cancel the workflow, skip the step with the error, or repeat the step if the error is now resolved.

After you select an action in the Error Handling Form, the workflow will either continue or be canceled, according to the option you selected.

See Also:

Overview of Workflow Conductor Studio

Workflow Conductor provides a simple, yet powerful way to automate and manage your business processes. A simple drag-and-drop interface lets designers easily create and deploy complex workflows without the need for custom coding. Conductor Studio is the Workflow Conductor interface that allows you to create, edit, and deploy new workflows or workflow templates.

The image has been edited to better display the configuration options

Step	Action	Result
1.	Workflow Conductor Ribbon	The Workflow Conductor ribbon replaces the list ribbon when you open the Workflow Conductor Studio. Detailed information about the options on the menu ribbon are illustrated here.
2.	Widgets	The left section of Conductor Studio, the widget pane, contains a list of the widgets used to design a workflow. You can optionally change which widgets appear in which group from the Configuring WF Conductor Categories page of the Workflow Conductor Control Panel in SharePoint Central Administration.
3.	Workflow Diagram Pane	The center section of Conductor Studio is the workflow diagram pane, where widgets are dropped to create the workflow path. The diagram pane is described in more detail here.
4.	Widget Properties Tab	Displays the properties of the currently selected widget. You can read an overview of the widget pane and the common widget properties here, but keep in mind each widget has its own unique properties so if you are working on a specific widget and want to get an understanding of the properties for that widget, find the widget in the Alphabetical List of Workflow Conductor Widgets.
5.	Workflow Settings Tab	This tab contains general settings for the workflow, including the title and description, workflow start options, and workflow variables. You can read more in depth information about the settings tab here.

To start Conductor Studio, first make sure that the account you are using has the Design or Full Control permission level for the list or library. Then, navigate to a list or library and click the Create or Edit Workflows button in the List or Library tab of the Tools ribbon.

NOTE: Administrators can further restrict who can design workflows in Conductor Studio using the Workflow Designers settings in Central Administration > Workflow Conductor. If you are a SharePoint Designer but do not have the Create or Edit Workflows option in the Tools ribbon, contact your SharePoint administrator.

Overview of Workflow Conductor Components to Install

Installing WF Conductor for the first time…

WFC r3.5 install components.jpg Workflow Conductor’s installation interface (shown at right) lists the Components available for install with the Workflow Conductor Installation/Setup application. For a description of each component, see the table below.

NOTE: Previous releases of the Workflow Conductor may have had other components listed. For example, Release 3.x had Legacy Workflow Assemblies listed, but that component has been combined with the Workflow Conductor component in R3.5 and is no longer listed separately.

The Workflow Start Feature listed under Optional Items is new for R3.5. If you don’t see it, you may be installing an earlier version.

Component	Description
Workflow Conductor	Installs the core Workflow Conductor components, including Conductor Studio, widgets, and reporting Web Parts. As of Release 3.5, it also installs the Legacy Workflow Assemblies, which maintain support for workflows created in previous releases of 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. This component needs to be installed on the farm servers that run the Central Administration service.
Legacy Workflow Assemblies	Installs the Legacy Workflow Assemblies are needed to maintain support for workflows created in previous releases of Workflow Conductor.
Configuration Database	Installs the Workflow Conductor Configuration Database utility, which installs and configures the Workflow Conductor database.
Bamboo Feature Activation	This component automatically finds and activates specific product features that may not properly activate when automatic activation is selected during the installation. This step doesn’t install any new components, it runs the utility.
Workflow Start Feature	The Workflow Start Feature provides the ability to add configurable buttons to the SharePoint item ribbon to allow user to easily start a specific workflow on a selected item. It installs like other components. When installation is complete, see How to configure the Workflow Start Feature for more information.
Bamboo Web License Manager	The Bamboo Web License Manager controls the licensing for Bamboo products. It is included in the installation for all Bamboo products. Install it only if you need to activate a purchased license and it has not been previously installed on your SharePoint farm. See Activating Your Bamboo Product License for more information. If you are trialing the Workflow Conductor, you will not need to install this component.

Overview of Workflow Conductor Web Parts

There are three web parts included with the Workflow Conductor. They are described below.

Web Part	Description
My Workflows	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 that triggered the workflow, and additional information that might be relevant depending on the type of workflow. From this Web Part, the workflow initiator can Cancel a workflow that is Running, or Restart a workflow that errored. Use this web part to see a list of all your workflows, particularly ones that may have errored, in one central place so you can more easily manage them. How to use the My Workflows Web Part How to configure the My Workflows Web Part
My Workflow Tasks	The My Workflow Tasks Web Part displays tasks created by workflows. These tasks typically reside in lists called Workflow Tasks. 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. Use this web part to provide a central location to see all your workflow tasks. How to use the My Workflow Tasks Web Part How to configure the My Workflow Tasks Web Part
Workflows Reports	The Workflow Reports Web Part allows you to create reports about workflows in the current site or site collection. The report is displayed graphically, with a summary text-based list below the chart. there are options to specify the workflows you wish to see in the generated report. How to use the Workflow Reports Web Part How to configure the Workflow Reports Web Part

Web Part

Description

My Workflows

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 that triggered the workflow, and additional information that might be relevant depending on the type of workflow. From this Web Part, the workflow initiator can Cancel a workflow that is Running, or Restart a workflow that errored. Use this web part to see a list of all your workflows, particularly ones that may have errored, in one central place so you can more easily manage them.

How to use the My Workflows Web Part
How to configure the My Workflows Web Part

My Workflow Tasks

The My Workflow Tasks Web Part displays tasks created by workflows. These tasks typically reside in lists called Workflow Tasks. 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. Use this web part to provide a central location to see all your workflow tasks.

How to use the My Workflow Tasks Web Part
How to configure the My Workflow Tasks Web Part

Workflows Reports

The Workflow Reports Web Part allows you to create reports about workflows in the current site or site collection. The report is displayed graphically, with a summary text-based list below the chart. there are options to specify the workflows you wish to see in the generated report.

How to use the Workflow Reports Web Part
How to configure the Workflow Reports Web Part

Overview of the Installation/Setup Program

Options for Installing

IMPORTANT: As of April 2017, Bamboo no longer includes the Installation/Setup Program in product download packages. Please see Overview of the Updated Installation Process for Bamboo components for details.

There are several areas of note in the Installation/Setup program interface, shown below.

No.	Function
1.	The Setup program contains links to various product components listed under the Components header on the left. Click on any of these links to view additional information about the component on the right. The product components fall into the following categories: Prerequisites: Some products include prerequisite components that must be installed before the Bamboo product core components. Not all products will have prerequisites. Examples of prerequisites include the Microsoft Exchange Web Services (EWS) Managed API, Shared Assemblies Library, Microsoft AJAX Extensions, and Bamboo AJAX Config. If you have more than one Bamboo product installed on your farm, some of the pre-requisites may already be installed. 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. 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. If you have previously installed the Bamboo Web License Manager with another Bamboo product, it may not be necessary for you to install it again. Help: When clicking the Help component, you will see links for the Online Documentation and other product-related resources. Click the Home icon () at the top of the components list to return to the Setup main page.
2.	The Installation Location section will tell you where to run the Installation/Setup program for the selected component. Read this information carefully before proceeding.
3.	The Required Installation Permissions section will explain required permissions for the selected component. Read this information carefully before proceeding. If the person running the installation/setup doesn’t have the appropriate level of permission, the install will fail.
4.	When ready, click the Install button to begin the installation process. It will do a few system checks, ask you to agree to our End User License Agreement, ask which Web Applications you want to install to (you don’t have to pick any), and ask if you want to automatically activate the solution on the selected web apps. When the install is complete, it will display an Installation Summary that you should review carefully. See an example below.

Click here for information about running the installation or go back to Installing for the first time… topics.

Overview of the Updated Installation Process for Bamboo components

Options for Installing

In April 2017, with the Q1 Cumulative Update (CU) Bamboo introduced updated install/uninstall processes for component products (web parts). Instead of the Setup.exe Installation Application, we now supply two PowerShell scripts – one for Install/Upgrade and the other for Uninstall – to be used to install, upgrade, or uninstall the product. The install package downloaded from My Bamboo is now a *.zip file rather than a self-extracting executable.

The installation process was updated based on feedback from our customers. We are excited about the benefits the new processes offer:

Benefits
The processes are now very transparent; you know exactly what happens during the install/upgrade/uninstall. If you want/need to modify the scripts for your farm, you can do that.
If you are upgrading to a new version of a Bamboo product or if a new install updates a shared component used by another Bamboo product installed previously, the installed solution is saved before the upgrade. If the new install fails, you can easily rollback to the previously installed solution.
Rather than deploying each solution individually, deployments are queued which minimizes farm disruption by reducing the IIS Resets on the farm.
By design, the scripts are written to be compatible with PowerShell versions found on an SP2010 WFE server. Written to use the features of the older version of PowerShell, the scripts are simple and should work the same in all environments. If you would prefer to employ some PowerShell features available in new versions (e.g., output results to the grid/table), you can modify the scripts to use the PowerShell features available in your environment.

Please note the following for the new scripts:

The script installs all the WSPs found in the installation folder, in alpha order
The install/upgrade script deploys to all content web apps. If you would prefer to deploy to a single web app, you can modify the script or deploy via Central Administration.
Uses Upgrade instead of Install for existing components.

For additional information about how to use the updated processes:

Overview of Licensing and Product Activation

When to Activate

After you purchase, you receive License Keys to use to activate the product license on each WFE server on your farm. License Keys never expire. See How many License Keys do I need for my SharePoint farm for more information. You can use a license key on only one server at a time. Servers in non-production (i.e., Staging, Test, Dev) farms require licenses too, just like servers in your production farm.

Activating a Standard Product License

For most Bamboo products, license keys are required for each WFE server in the SharePoint Farm. For certain products, such as Alert Plus or List Rollup, additional license keys may be required for application servers as well to use certain features. See Activating Your Bamboo Product License

Suites, Packs, Libraries, and Toolkits

For Bamboo Suites, Packs, Libraries and Toolkits, a single license activates all the products in the suite or pack for a specific WFE server. See Overview of Suite or Pack Licensing.

Keyless Licensing

On very large farms with several Bamboo products installed, it is often difficult to manage so many license keys. Bamboo offers keyless licensing for these scenarios. Please contact your Sales Manager for more information about keyless licensing.

Use the Bamboo Web License Manager to activate Bamboo products install on the SharePoint farm. For additional details, please see

Installing the Bamboo Web License Manager
Activating Your Bamboo Product License
Activating My Bamboo Product License Offline if your server doesn’t have access to the Internet.

Desktop Applications

Some Bamboo products are not installed on the SharePoint farm, but on a PC or server somewhere on your network. To activate the license for these products, please see Activating a Bamboo Desktop Product Using the License Manager.

Moving or Migrating your farm

If you are moving your SharePoint farm to new servers, please see Migrating my Bamboo Product License to a New Server. Licenses are activated to a particular hardware profile of the server. If the profile changes (i.e., you add a hard drive), the license will require migration.

If you have migrated your environment to a new SharePoint version (i.e., from SharePoint 201 to SharePoint 2013), see Migrate your Bamboo Product License Key From one SharePoint version to another. License keys for products running in different SharePoint versions are different. On-Prem Bamboo products on active support are eligible for no-cost upgrades to a newer SharePoint version (2016/2019/2022) as long as the two farms are not running concurrently for more than 60 days. Migrations to Microsoft 365 will require the purchase of new licenses. However, we do offer a discount for customers on current support for an on-premise product that has a Microsoft 365 equivalent

Trials

For product trials, no license is required. If you are wondering about the status of your trial or when it will expire, please see

Overview of Workflow Conductor Control Panel

The Workflow Conductor configuration options are farm-wide and as such, are configured in SharePoint Central Administration. After installing Workflow Conductor, go to Central Administration > Workflow Conductor to configure. See the table below for general information about each configuration area.

IMPORTANT: At a minimum, you must configure features in the System Settings and Account Settings pages before you can use Workflow Conductor.

No.	Description
1.	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. See Configuring WF Conductor System Settings for more information.
2.	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. See Configuring WF Conductor Account Settings for more information.
3.	General Settings. Configure global options for Workflow Conductor. See Configuring WF Conductor General Settings for more information.
4.	E-mail Settings. Set up the default e-mail templates used in some Workflow Conductor widgets. See Configuring WF Conductor E-mail Settings for more information.
5.	Workflow Designers. Configure who can design workflows in Workflow Conductor Studio. See Configuring WF Conductor Workflow Designers for more information.
6.	View Workflow Status. View the status of all workflow instances in your farm.
7.	Widget Categories. Configure the categories for widgets in Workflow Conductor Studio. See Configuring WF Conductor Categories for more information.
8.	Template Management. Assign users to manage workflow templates in the Conductor Studio Template Gallery, and manage featured templates. See Manage WF Conductor Templates from Central Admin for more information.
9.	Workflow Solution Management. View and manage Workflow Conductor workflow solutions in your farm. See Managing Workflow Solutions for more information.
10.	Licensing. Click this link to access the Bamboo Web License Manager. A license must be activated for production use, but is not required for trial installations.See Activating Your Bamboo Product License for more information.
11.	About Workflow Conductor. View the file version information for Workflow Conductor. See About Workflow Conductor for more information.

Other Workflow Conductor configuration tasks:

Localizing Workflow Conductor: Learn how Workflow Conductor can take advantage of SharePoint localization capabilities (i.e. language packs).
Customizing Task Forms: Learn how to customize InfoPath task forms used for Request Approval, Request Feedback, and Collect Data from User widgets.

Opening a Workflow Template

Overview of Workflow Conductor Templates

open option on menu R4.jpg To open a workflow template from the template gallery, click the Open icon in the Conductor Studio ribbon.

A list of your available templates will be displayed in the My Templates tab of the Template Gallery. Select one or click the Shared Templates or Featured Templates tab to select a template from one of those tabs and then click Open. The workflow template will load into Conductor Studio.

NOTES:

Opening a workflow template in Conductor Studio does not open the workflow deployed or published to the current list. You are opening the template that is saved to the template gallery.

By default, a saved workflow template can only be opened and edited by the designer who saved it, or by a template manager. For information about sharing templates so other users can view and save a copy of them, see Sharing Workflow Templates.

More Information About the Template Gallery

The Template Gallery is organized into the tabs described in the table below. By default, the templates in each tab are sorted in the order the template was last saved so the one created most recently is at the top of the list. To sort or filter the list, see Filter or Sort the List of Templates in the Template Gallery.

To open a template, select it and then click Open.

Gallery Tab	Description
My Templates	This is the tab that is displayed by default. Workflow templates created and saved by the logged in user (the current workflow designer) appear in this list. No one else, except template managers, can see these templates unless the workflow designer chooses to share a template.
Shared Templates	Workflow templates that all workflow designers can open appear here. When you open a shared template, any changes you make to it are saved as a new copy of the template in your My Templates list. The original shared template is not affected. Any workflow designer can share a template. See Sharing Workflow Templates for more information.
Featured Templates	These are templates a system administrator with access to the Workflow Conductor Control Panel in SharePoint Central Administration has selected to appear in the Featured Templates list. This list may include frequently used templates or templates approved for use in your SharePoint environment. See Featured workflow templates for more information.
Manage Templates	If you are a template manager, you can open or delete shared templates, featured templates, or templates created by any designer from the Manage Templates tab. See Managing Workflow Templates or Manage WF Conductor Templates from Central Admin for more information.

Overview of Bamboo Product Trials

Overview of Licensing and and Product Activation

Try our products before you buy!

Trials are fully functional for 30 days from the date of installation.
Once a 30 day trial of a product has been installed on a server or farm, no further trial copies of the same product will function on the server or farm. When a product license key is purchased and activated (even after the trial has expired), the product will continue to work as it did during the trial.
Users who need additional time to evaluate a product will need to request a trial extension from their Bamboo Sales Account Manager (sales@bamboosolution.com).
There is no functional difference between the trial and purchased version of our products, with the exception of List Bulk Import and List Bulk Export. When a trial user purchases a license, it is not necessary to install a new version to replace the trial. You simply activate the license of the “trial” copy. Any configuration done on the product during the trial period will remain after the license is activated.
The List Bulk Import and the List Bulk Export product trials are limited in the number of items that can be imported/exported. Regardless of the number of items in an import file or in a SharePoint List/Library, only 15 items will be imported/exported with the trial version of these products. Once the license is activated, this restriction is lifted.

Overview of the new Bamboo product Logging

In April 2017, Bamboo released Bamboo.Logging v3.1.0.0 with the Q1 (2017) Cumulative Update of Bamboo component products.

In response to customer feedback the new logging version uses SharePoint ULS logs by default, instead of the the Bamboo logs. The main benefits of this change are:

Bamboo Log files will not fill the C: drive on WFE servers. Previously, Bamboo products reported errors to proprietary log files located in C:WindowsTempBambooSolutions on each web front end server in the farm as described in Error Log Files.
SharePoint administrators are very familiar with ULS logs and the ULS Log Viewer. When Bamboo products log to ULS, SharePoint administrators have one less set of logs to review.
ULS log files can be more easily managed for size and archived, a feature that was not previously available for Bamboo logs.

Bamboo component products installed or upgraded after April 2017 will have the new Bamboo Logging deployed as part of the Bamboo.Framework.wsp solution, which is common to Bamboo products and globally deployed to the SharePoint farm.

IMPORTANT:
1) If you have multiple Bamboo products installed on your farm, some Bamboo log files may remain in C:/Windows/Temp/BambooSolutions until you upgrade all of the Bamboo products.
2) Bamboo applications (e.g., PM Central, Workflow Conductor, In/Out Schedule Board) will not have the new Bamboo Logging until their respective CU’s are available in Q2 2017.

Please note the following for the new scripts:

The script installs all the WSPs found in the installation folder, in alpha order
The install/upgrade script deploys to all content web apps. If you would prefer to deploy to a single web app, you can modify the script or deploy via Central Administration.
Uses Upgrade instead of Install for existing components.

For additional information about how to use the updated processes:

Installing using the updated install process
Upgrading using the updated process
Uninstalling using the updated process

How to configure the My Workflow Tasks Web Part

Overview of Workflow Conductor Web Parts

The My Workflow Tasks Web Part displays tasks created by workflows. These tasks typically reside in a list called Workflow Tasks. 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.)

NOTE: If you don’t see the web part in the gallery, check to make sure the site collection feature shown below is activated in your site collection.

Add the web part to a web part page. If you do not know how to add a web part to a page, read the topic How to add a web part to a Web Part page.

To configure the web part once its on the page:

Section	Setting
Tasks:	Select the scope of workflows to display. By default, the Web Part will display workflow tasks 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. NOTE: Displaying tasks for all users across the farm will take longer than displaying tasks for just the logged in user.	If you decide to display tasks assigned to all users, you may consider changing the name of the web part in the Appearance section of the tool pane. It should no longer be called My Workflow Tasks if it displays tasks for everyone.
Paging Settings:	Select the number of items to display per page and the maximum number of items to include in the list. The larger the numbers, the longer the page will take to load.
Display Settings	Select Display document titles to display the Title column of the item that triggered the workflow in the Item column of the web part display. The Title column of an item in a SharePoint list or library is a hyperlink to the display form of that item. Alternatively, you can select Display file names to display the Name column of the file in the Item column of the web part display, when the item that triggered the workflow is a file in a SharePoint document library. The Name column of an file in a SharePoint document library is a hyperlink that opens the file rather than the item display form. If desired, check options to Display Status column, Display time since task was created, or Display workflow initiator. The Wrap Text box is checked by default. Uncheck it if you prefer the Web Part zone width to automatically adjust so that all items in this Web Part fit on one line. Uncheck them if you would prefer those columns not to appear in the web part display.	NOTE: The workflow tasks displayed in this web part may be associated with items in SharePoint document libraries or other types of lists. If the item that triggers the workflow is not in a document library, the Title column will always be displayed, regardless of the selection in the Display Settings. There is no file name column for items in these types of lists.
Sorting:	Select your preferred default sort column and sort order. You can choose to sort on workflow name or workflow initiator. NOTE: Users can re-sort the display on the fly, if needed. This setting is just for the sort order for the initial display when the page first loads.

For information on how to use the My Workflow Tasks Web Part, see How to use the My Workflow Tasks Web Part.

How to use the My Workflows Web Part

Overview of Workflow Conductor Web Parts

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:

Cancel a workflow that is running, by clicking the Cancel link associated with the specific workflow.
Restart a workflow that errored, by clicking the Restart link associated with the specific workflow.
Resume a paused workflow, by clicking the Resume link associated with the specific workflow.

Sort the list of workflows displayed by clicking on a column heading. Click the same heading a second time to reverse the sort order.

For information about configuring this web part, see How to configure the My Workflows Web Part.

My product was licensed yesterday and today there is an error; what happened?

License keys are tied to the hardware GUID of the WFE server and if the GUID changes, the license will revert to the trial status. You will need to deactivate the license key and then re-activate the license using the same key.

GUIDs may change when a WFE server is dropped from a farm and then re-added.

IMPORTANT: For products licensed with the Bamboo License Manager (rather than the Web License Manager), the license key is tied to the hardware profile of the PC where the product is installed. If the hardware profile changes (i.e., a hard drive is added), the license will revert to the trial status. You will need to deactivate it and then re-activate it using the original license key. Products that use the Bamboo License Manager include: List Bulk Import, List Bulk Export, and User Profile Sync.

The problem is that the license status will no longer show the license key once the GUID changes, it will show as an expired trial license. See Is there a way to find a lost or unknown Bamboo product license key and then How to move your Bamboo Product License to a new server to resolve this issue.

Move Item Widget

The Move Item widget moves a list or library item from one list or library to another. Fields that exist in both the source and target lists are copied. The item is first copied to the target list, and then deleted from the source list.

Widget Limitation: The source and target list types and column types must match or the Move Item widget will fail.

Widget Properties:

Column	Description
Source Item (Required)	Click the button to select an item to move. Select source item: To move the current item, select Current Item (the default). To move a different item in the current list or an item in another list, site, or site collection, select External List Lookup and make the desired selections in the Site Collection, Site, and List boxes. To identify the item in the list that you want to move, select a Filter Field and enter a match criteria in the Equals box, either by typing one or by adding a lookup using the Add Lookup () icon. If more than one item is matched, the first item returned is selected as the source item to move.
Target List (Required)	Click to select a target list or library to move the source item to. Select target item: To create a copy of the item in the current list and delete the original item, select Current List. To move the item to a different list in the current site or to a list in another site or site collection, select Other List and make the desired selections in the Site Collection, Site, and List boxes. Overwrite existing items: To overwrite an item with the same Name in the target library, check the Overwrite existing items checkbox. Note: This option is only available for document libraries.
Run As	This widget can run with the permissions of the workflow initiator, the workflow designer, or another user. Select the option in the Run As property that best matches your requirement. For more information, see the Common Widget Properties topic.
Click Apply to save the widget settings.

Example Using Move Item Widget

Return to Lists and Items Widgets

See Also:

Overview of moving a Bamboo Product License

To move a license, you need to deactivate the license key for the old server so you can activate it on the new server. A license key can be used on only one server at a time.

If the WFE servers in your SharePoint farm have access to the Internet, see How to move your Bamboo Product License to a new server.
If your WFE servers do not have Internet access, you will need to deactivate the license key via My Bamboo. See How to deactivate your Bamboo Product License is your server doesn’t have access to the Internet.

More Examples of Formulas Used With the Calculate Widget

TEXT Formulas
Example	Assumption	Outcome
TEXT(DATEVALUE(“{Variable: varCalcDate}”),”m/d/yyyy”))	varCalcDate = “2015-07” and you are using U.S. Date Format	7/1/2015
TEXT(DATEVALUE(“{Variable: varCalcDate}”),”d/m/yyyy”))	varCalcDate = “2015-07” and you are using U.S. Date Format	1/7/2015
TEXT(DATEVALUE(“2015-07″),”mmmm”)	Using U.S. Date Format	July
TEXT(DATEVALUE(“2015-09″),”mmmm”)	Using U.S. Date Format	Sept
TEXT(DATEVALUE({CurrentItem:Valid To})-{CurrentItem:Reminder Period},”m/d/yyyy”)	Using U.S. Date Format, you want to calculate the Reminder Date for an item based on the Valid To date and the Reminder Period. Valid To is a DateTime column in the current list with a value of 4/30/2013 for the current item. Reminder Period is a Number column in the current list with a value of 1 for the current item. Reminder Period is intended to store the number of days.	4/28/2015

Return to

Modify a Workflow Initialization Form

If you need to collect information from a user in an initialization form when a workflow is started, add a Workflow Initialization Form to your workflow in Conductor Studio. The Workflow Form is made up of one or more fields. Each field is stored in a workflow parameter, which can be used by the widgets in the workflow. Workflow parameters, like workflow variables, appear in the lookup list for Workflow 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. When workflows start automatically, users don’t see the initialization form.

If you have already created an initialization form for your workflow, clicking Init Form from the menu or Workflow Settings tab will edit your existing form. If no form has been created yet, clicking Init Form will allow you to create a new form (see Workflow Forms for more information).

To modify an initialization form, follow these steps:

Step	Action	Result
1.	In the Workflow Conductor Studio, click the Add Field button in the Workflow Settings tab. Alternatively, click the Init Form option in the Variables section of the Workflow Conductor ribbon.	The Form Builder is displayed. Fields added previously are listed in the Input Field list. The Form Builder allows you to add more fields to the initialization form or edit, delete, or rearrange fields.
2.	To modify the fields on an initialization form, select the field that needs updating and click Modify. For more details about Information Types, see Information Types used on Workflow Initialization Forms.	The Forms Settings dialog will appear. See below for an example of a Date and Time field ready to be modified.
3.	Modify the parameters as needed. When ready, click Finish to save changes made to the field. Otherwise, click Cancel to close the Form Settings dialog without saving any changes.	The Form Settings dialog will close. IMPORTANT: If you change the field name and have already referenced the parameter in a widget of your workflow, you will need to re-reference the parameter. It will not be updated with the new name automatically.
4.	If you want to delete a field, select it in the Form Builder and click Remove.	The selected field will be deleted. NOTE: There is no warning asking if you are sure you want to remove the field. Clicking Remove, removes the field and you won’t be able to get it back unless you close the Workflow Conductor Studio without saving changes to your template.
5.	If you want to change the order that the fields are displayed to the end user, select a field and choose Move Up or Move Down as appropriate.	The selected field will move up or down the list one position. NOTE: The Move Up and Move Down buttons are disabled unless there is more than one field on the form.
6.	Repeat steps 2-5 to modify, remove, or move more fields, as needed.
7.	When your form is complete, click Close to close the Form Builder.	Your form will be saved.

Migrating Workflow Conductor from SharePoint 2007 to SharePoint 2010

Be sure you have at least the Minimum SharePoint 2007 Product Release (shown in the table below) installed before migrating. If not, upgrade your Bamboo product release before migrating. For more information, see Upgrading your Bamboo Web Part. Also, the target SharePoint 2010 farm requires at least the Minimum SharePoint 2010 product release shown.

IMPORTANT: When migrating from SharePoint 2007 to SharePoint 2010, you MUST select the option to change existing SharePoint sites to use the new user experience. Your Bamboo products will not perform as expected with the old look and feel.

Minimum SharePoint 2007 Product Release	1.5.1	Minimum SharePoint 2010 Product Release	10.5.1

In-Place Upgrade
Issues	Follow the steps described in the Online Documentation
Resolution	TBD
Database Attach Upgrade Method
Issues	Workflow Conductor does not fully support this method.
Resolution	To migrate Workflow Conductor using the Database Attach and Upgrade Method, users should follow these steps: Export the workflow templates from Workflow Conductor Studio. Upgrade the SharePoint site. Import the workflow templates into Workflow Conductor Studio. Reconfigure the workflows with any necessary changes. Save and Redeploy the workflow.

Migrating Workflow Conductor from SharePoint 2010 to SharePoint 2013

Be sure you have at least the Minimum SharePoint 2010 Product Release (shown in the table below) installed before migrating. If not, upgrade your Bamboo product release before migrating. For more information, see Upgrading your Bamboo Web Part. Also, the target SharePoint 2013 farm requires at least the Minimum SharePoint 2013 product release shown.

IMPORTANT: When migrating from SharePoint 2010 to SharePoint 2013, the Database Attach Upgrade Method is the only method supported.

Minimum SharePoint 2010 Product Release	30.5.0	Minimum SharePoint 2013 Product Release	30.5.1.2013

Database Attach Upgrade Method
Issues	The Workflow Conductor does NOT migrate successfully…. It does NOT support the SP2010 Look and Feel in SP2013. You must upgrade to the SP2013 Look and Feel when migrating Workflow Conductor.
Resolution	TBD

Database Attach Upgrade Method

Issues

The Workflow Conductor does NOT migrate successfully….

It does NOT support the SP2010 Look and Feel in SP2013. You must upgrade to the SP2013 Look and Feel when migrating Workflow Conductor.

Resolution

TBD

Migrate your Bamboo Product License Key From one SharePoint version to another

Overview of Licensing and and Product Activation

Bamboo Solutions completed its migration of more than 60 Bamboo products to SharePoint 2013 I the fall of 2013. A few years earlier, we completed the migration of many of those same products from SharePoint 2007 to SharePoint 2010.

Bamboo License Keys for previous versions of SharePoint are not valid for newer versions. If eligible, you can retrieve license keys for newer SharePoint versions through the My Bamboo area of the Bamboo Solutions web site.

When you activate product license keys for a newer SharePoint version, the keys for the older version become invalid after 60 days.

Bamboo Policy for Migrating License Keys

To receive a free SharePoint 2010 or SharePoint 2013 license key, you must have a valid Premium Support Contract for the product you are migrating to SharePoint 2010 or SharePoint 2013.

We support a 1:1 exchange of license keys. If your SharePoint 2007 farm had two WFE servers and your SharePoint 2010 farm has four WFE servers, you will need to purchase two additional SharePoint 2010 license keys. The same requirement holds for SharePoint 2010 farms you are migrating to SharePoint 2013.

How to get your new license keys

If you have a valid Premium Support Contract for the product you intend to migrate, follow these steps:

Step	Action
1.	Login to My Bamboo with the Bamboo account that made the original SharePoint 2007 Bamboo license key purchase or an account that can see the purchases.
2.	Click My Orders Product Licenses under the sectionlocated at the bottom of the page.
3.	On the Product Licenses tab of the My Orders page, each product purchased is listed. If an update is available, a Request SP 2013 License button is displayed in the Update Keys column. Click the button for the product you want to migrate. NOTES: 1. The Request SP 2010/2013 License button will not be available unless a Premium Support Contract is in place. 2. If you see something you think is wrong with your Product License listing, please contact your Bamboo Sales Representative at Sales@Bamboosolutions.com
4.	An order will be created automatically and you will be redirected to the order completion page, where you can retrieve the installation package. You will also receive an e-mail that provides you the link to the download package and your SharePoint 2013 License Keys. NOTE: If the text Not Available is displayed, this means either you do not have an active Premium Support contract or there is no SharePoint 2010 version of that product. Please contact your Sales Representative at Sales@bamboosolutions.com for additional assistance. For information about migrating the product, see these topics.

Migrate your Bamboo product from SharePoint 2010 to SharePoint 2013

Overview

This article outlines how to migrate Bamboo products from SharePoint 2010 to SharePoint 2013 (SharePoint Foundation 2013 & SharePoint Server 2013).

NOTE: In order to migrate a Bamboo product to SharePoint 2103 from a SharePoint 2010 environment, you need to ensure that the SharePoint 2010 farm has the appropriate version installed. If your Bamboo product version is older, you may need to upgrade the SharePoint 2010 version before migrating to SharePoint 2013. Please refer to information about the specific products that are installed on the farm you are migrating for possible additional steps needed or limitations of the migration (including whether the product is supported on SharePoint 2013 with the SharePoint 2010 look and feel).

For additional information about upgrading your existing SharePoint 2010 Farm to SharePoint 2013, read these TechNet articles:

Bamboo Solutions supports the Database Attach upgrade method for upgrading to SharePoint 2013. The migration of Bamboo products deployed on SharePoint 2007 environments directly to SharePoint 2013 Farms is not supported. These environments must be migrated to SharePoint 2010 first. Bamboo also does not support the downgrade of SharePoint editions during a migration. (i.e., SharePoint Server 2010 to SharePoint Foundation 2013)

Migration Steps

Step	Description
1.	Before migrating, update the Bamboo products you have in SharePoint 2010 to the latest available release.
2.	Uninstall any products that are not available on SharePoint 2013. Cross List is an example of a product that was not ported to SharePoint 2013. If you do not remove the Bamboo Cross List from the SharePoint 2010 farm before migrating, the migration will fail because the feature will not be available in the SharePoint 2013 farm.
3.	Retrieve the SharePoint 2013 installation package and license keys for the Bamboo products you are migrating. See Migrate your Bamboo Product License Key From one SharePoint version to another for additional details. Install the Bamboo products on the SharePoint 2013 farm.
4.	Backup the SharePoint 2010 content database and attach it to the SharePoint 2013 farm. If the database attach fails, see steps 1-3 above. IMPORTANT: Follow Microsoft’s Upgrade databases from SharePoint 2010 to SharePoint 2013 article to perform the database-attach migration.
5.	After the 2010 content databases have been successfully attached and upgraded to SharePoint 2013, you MUST retract and redeploy (or uninstall and reinstall) your Bamboo SharePoint 2013 products on the SharePoint 2013 farm. This process removes the SharePoint 2010 Web Part references and replaces them with SharePoint 2013 references in the newly attached content databases. This is not a Bamboo specific step. It must be performed for most 3rd party SharePoint software installations. If this step is skipped users will usually see errors when adding web parts to pages. IMPORTANT: If you have a staged migration that moves content databases in stages, you need to retract and re-deploy after each database (or group of databases are attached.
6.	Perform the permanent Visual Upgrade to upgrade your SharePoint 2010 site collections to the SharePoint 2013 Look and Feel. IMPORTANT: Bamboo does not support our SharePoint 2013 products running on a SharePoint 2013 server using the SharePoint 2010 Look and Feel.

Migrate your Bamboo product from SharePoint 2013 to SharePoint 2016

Overview

This article outlines how to migrate Bamboo products from SharePoint 2013 to SharePoint 2016.

NOTE: In order to migrate a Bamboo product to SharePoint 2106 from a SharePoint 2013 environment, you need to ensure that the SharePoint 2013 farm has the appropriate version installed. If your Bamboo product version is older, you may need to upgrade the SharePoint 2013 version before migrating to SharePoint 2016. Please refer to information about the specific products that are installed on the farm you are migrating for possible additional steps needed or limitations of the migration.

For additional information about upgrading your existing SharePoint 2013 Farm to SharePoint 2016, read these TechNet articles:

Bamboo Solutions supports the Database Attach upgrade method for upgrading to SharePoint 2016. The migration of Bamboo products deployed on SharePoint 2007 or SharePoint 2010 environments directly to SharePoint 2016 Farms is not supported. These environments must be migrated to SharePoint 2013 first.

Migration Steps

Step	Description
1.	Before migrating, update the Bamboo products you have in SharePoint 2013 to the latest available release.
2.	Uninstall any products that are not available on SharePoint 2016. Group Email is an example of a product that was not ported to SharePoint 2016. If you do not remove the Bamboo Group Email from the SharePoint 2013 farm before migrating, the migration will fail because the feature will not be available in the SharePoint 2016 farm.
3.	Retrieve the SharePoint 2016 installation package and license keys for the Bamboo products you are migrating. See Migrate your Bamboo Product License Key From one SharePoint version to another for additional details. Install the Bamboo products on the SharePoint 2016 farm.
4.	Backup the SharePoint 2013 content database(s) and attach it to the SharePoint 2016 farm. If the database attach fails, see steps 1-3 above. IMPORTANT: Follow Microsoft’s Upgrade databases from SharePoint 2013 to SharePoint 2016 article to perform the database-attach migration.
5.	After the 2013 content databases have been successfully attached and upgraded to SharePoint 2016, you MUST retract and redeploy (or uninstall and reinstall) your Bamboo SharePoint 2016 products on the SharePoint 2016 farm. This process removes the SharePoint 2013 Web Part references and replaces them with SharePoint 2016 references in the newly attached content databases. This is not a Bamboo specific step. It must be performed for most 3rd party SharePoint software installations. If this step is skipped users will usually see errors when adding web parts to pages. IMPORTANT: If you have a staged migration that moves content databases in stages, you need to retract and re-deploy after each database (or group of databases are attached.

Manually Install using PowerShell

Options for Installing

IMPORTANT: As of April 2017, Bamboo no longer includes ManualInstallation.ps1 or DisableAllBambooTimerJobDefinitions.bat in product download packages. An updated uninstall script is included instead. Please seeOverview of the Updated Installation Process for Bamboo components and Uninstalling using the updated process for details.

Perform the actions below to manually install or repair a product.

NOTE: Pay close attention to where a command should be run. Some commands must be run on either ONE or ALL Web front-end servers (WFE). A WFE is a server running the Microsoft SharePoint Foundation Web Application service. Refer to the System Settings > Manage Servers on this farm page in Central Administration for a list of servers running this service.

Step	Action
1.	Shut down the application pools for each Web application where you are installing the product. This will prevent other users from accessing sites and locking files that the installation script needs to update. NOTE: If you are using SharePoint 2010 and not Claims Based Authentication (CBA), instead of shutting down the app pools, you can stop the World Wide Web Publishing Service to prevent users from accessing sites and locking files. You should NOT stop the WWW Publishing service in SP2013 or in a CBA environment.
2.	On one Web front-end server (WFE), run the product .EXE file to extract its installation files. Browse to the misc folder. NOTE: If you do not see the misc folder or a file called ManualInstallation in this folder, your Bamboo product does not support this type of install.
3.	Right-click on the file DisableAllBambooTimerJobDefinitions.bat and choose Run as administrator. This script stops the timer job services for all Bamboo products installed on the farm, helping to put the farm in a quiescent state for the install. NOTE: If this script is not present in the misc folder for your Bamboo product, skip this step.
4.	On all WFE servers in the farm, perform the following actions: Run the command iisreset. Restart the SharePoint 2013 Timer (or SharePoint 2010) service.
5.	On the WFE where you extracted the product folders, right-click on the PowerShell application in the Start menu and choose Run as administrator. You can use Windows PowerShell or SharePoint 2013 Management Shell.
6.	Change to the misc folder in the extracted product installation files and enter the following command to start the manual installation script: `.ManualInstallation.ps1`
7.	When prompted, enter the Web application URL and choose whether you want to automatically activate the product features in the site collection(s). NOTE: To allow the installation script to run without prompting for input, edit the miscManualInstallation.ps1 script file and replace Read-Host with the highlighted text shown below: The script file installs Bamboo.Core.V2.wsp and Bamboo.Logging.V2.wsp, if they are not already in the solution store, and any required product components.
8.	Return to the misc folder. Right-click on EnableAllBambooTimerJobDefinitions.bat and choose Run as administrator. This enables all Bamboo timer job services. NOTE: If this script is not present in the misc folder for your Bamboo product, skip this step.
9.	Re-start the Application pools.
10.	Manually Activate the Product Feature(s) in the appropriate Site Collection(s) If you didn’t choose to activate site collection features automatically in step 7 above, don’t forget to activate those features in the site collections where you want to use them. After a Bamboo product solution is deployed to a Web Application, it’s feature(s) must be activated in the site collection before it can be used. When you are ready to activate the site collection feature, please see Activating a Bamboo Site Collection Feature. NOTE: You must be a Site Collection Administrator to activate site collection features.

Manually Install using stsadm

Options for Installing

These instructions use the stsadm.exe command, which can be found in the following location:

SharePoint 2007: %PROGRAMFILES%Common FilesMicrosoft SharedWeb Server Extensions12BIN
SharePoint 2010: %PROGRAMFILES%Common FilesMicrosoft SharedWeb Server Extensions14BIN
SharePoint 2013: %PROGRAMFILES%Common FilesMicrosoft SharedWeb Server Extensions15BIN

NOTE: Your product may include several SharePoint solutions in multiple [Component].wsp installation folders. Follow all steps for each solution to install the product for the first time.

Step	Description
1.	Review Best practices_for_a_successful_intstall to learn which servers to install on and what services to stop or restart.
2.	Add the solution to the SharePoint solution store. Run this command on the appropriate server in your farm and be sure you are running the command with an account that is a member of the local server Administrators group. The appropriate servers are typically those running the Foundation Web Application service or the Microsoft SharePoint Foundation Web Application service (or Windows SharePoint Services Web Application if you are using SharePoint 2007). Refer to Location of Install Files for more information. `stsadm.exe -o addsolution -filename [path][Component].wspcab[Component].wsp` where: [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 slightly different than the installation folder name.
3.	Deploy the SharePoint solution. After adding the solution to the SharePoint solution store on your farm, it must be deployed to one or more Web Applications. This can be accomplished via Central Administration (see Deploying a Bamboo solution to a new Web Application for more information) or by running one of the following commands on the same server where you added the solution in Step 1 above. To deploy to a specific Web Application, run this command: `stsadm.exe -o deploysolution -name [Component].wsp -immediate -url [http://WebApplicationUri:portNumber] -allowGacDeployment -allowCasPolicies` where: [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. Repeat this command for each web app you need to deploy to. OR To deploy to all Web applications EXCEPT the Central Administration Web application, run this command: `stsadm.exe -o deploysolution -name [Component].wsp -immediate -allcontenturls -allowGacDeployment -allowCasPolicies` where: [Component] – the name of the component you installed, as shown in the cab installation sub-folder
4.	Execute the deployment job(s). This is an optional step. The SharePoint Timer job will take care of the deployment eventually, but if you don’t want to wait for it, you can run this command. NOTE: This command needs to be run on every server on the farm that runs the Foundation Web Application service (or the Windows SharePoint Services Web Application service if you are using SharePoint 2007): `stsadm.exe -o execadmsvcjobs`
5.	Manually Activate the Product Feature(s) in the appropriate Site Collection After the Bamboo product solution is deployed to a Web Application, it must be activated in the site collection before it can be used. When you are ready to activate the site collection feature, please see Activating a Bamboo Site Collection Feature. NOTE: You must be a Site Collection Administrator to activate site collection features.

Manually uninstall using stsadm

A single Bamboo product may include a combination of one or more SharePoint solutions (WSPs) and components installed using an MSI installer. Refer to the original installation files from your product for information about the components that may have been installed.

To manually uninstall a Bamboo SharePoint solution, follow the steps below. If you need to uninstall a component that was installed using an MSI installed, see Manually Uninstalling a Bamboo .msi.

NOTE: The steps in these instructions use the stsadm.exe command, which can be found in the BIN folder of the 12/14/15 hive of a SharePoint server. For example, on a SharePoint 2010 farm, that would be %PROGRAMFILES%Common FilesMicrosoft SharedWeb Server Extensions14BIN

NOTE: You can also retract and remove a SharePoint solution from SharePoint Central Administration. To uninstall your Bamboo product this way, see Uninstalling from SharePoint Central Admin.

Step	Action
1.	Locate your stsadm.exe command utility. These instructions use the stsadm.exe command, which can be found in the BIN folder of the 12/14/15 hive of a SharePoint server. For example, on a SharePoint 2010 farm, that would be %PROGRAMFILES%Common FilesMicrosoft SharedWeb Server Extensions14BIN
2.	Schedule the solution Retraction. You can schedule the solution to be retracted from one web application at a time: `stsadm.exe -o retractsolution -name [Component].wsp -immediate -url [http://WebApplicationUri:Port]` or from all web applications at once: `stsadm.exe -o retractsolution -name [Component].wsp -immediate -allcontenturls` Where: [Component] is the name of the installed component (i.e., Bamboo.TreeView.wsp), as shown in the cab installation sub-folder or in the list of solutions in the Manage Farm Solutions page of SharePoint Central Administration. [http://WebApplicationUri:portNumber] is the URL and Port for the web application where the solution is installed.
3.	Execute the solution retraction. NOTE: This command needs to be run on each Web front-end (WFE) server in the farm. `stsadm.exe -o execadmsvcjobs`
4.	Remove the solution. Delete the solution from the SharePoint solution store only AFTER the retraction job is complete. `stsadm.exe -o deletesolution -name [Component].wsp` Where: [Component] is the name of the installed component (i.e., Bamboo.TreeView.wsp), as shown in the cab installation sub-folder or in the list of solutions in the Manage Farm Solutions page of SharePoint Central Administration.
5.	Repeat steps 2-4 for each solution included in the product. NOTE: There are two solutions that are common across multiple Bamboo products. They are: Bamboo AJAX Config (SP2007 only) and Bamboo Core. Do NOT uninstall them unless you are sure there are no other Bamboo products remaining on your farm. If there are no other Bamboo products on your farm, uninstall these two solutions last.

Managing Workflow Solutions

Overview of Workflow Conductor Control Panel

Workflow Conductor provides a central page to view and manage Workflow Conductor workflow solutions deployed using the Solution Deployment method. This page is accessed from Central Administration by clicking Workflow Conductor > Workflow Solution Management.

NOTE: If you are looking for information about managing workflows deployed using the Simple Publishing method, see Workflow Association for more information.

The following tasks can be performed in the Workflow Solution Management page of the Workflow Conductor Control Panel in Central Admin:

View workflow solutions across the farm
Retract and remove workflow solutions
Manually deploy workflow solutions scheduled for deployment

Top

View workflow solutions across the farm

To view the list of workflow solutions from the Workflow Solution Management page, follow these steps:

Step	Action
1.	Workflow solutions deployed to the SharePoint farm are listed in the Deployed Solutions section of the Workflow Conductor Solution Management page. For more information about the solution, view the entries in the Status and Deployed To columns or click the Workflow Name.
2.	Clicking a Workflow Name displays details about the solution. NOTE: The Deployed Solutions list and the details are similar to the Central Administration > System Settings > Manage farm solutions list in SharePoint Central Administration, but limits the list of solutions to only those deployed by Workflow Conductor.

Step

Action

Workflow solutions deployed to the SharePoint farm are listed in the Deployed Solutions section of the Workflow Conductor Solution Management page. For more information about the solution, view the entries in the Status and Deployed To columns or click the Workflow Name.

Clicking a Workflow Name displays details about the solution.

NOTE: The Deployed Solutions list and the details are similar to the Central Administration > System Settings > Manage farm solutions list in SharePoint Central Administration, but limits the list of solutions to only those deployed by Workflow Conductor.

Top

Retract and remove workflow solutions

Retracting a workflow solution removes it as a site collection feature. The workflow will no longer be available to associate to lists and libraries. Any workflow instances that are running will be terminated. Removing the workflow solution removes it from the list of solutions in the SharePoint farm.

IMPORTANT: As with any SharePoint solution, before retracting, make sure you have removed any associations to the solution. For a workflow solution, this means that you need to remove the association with any lists and libraries in the appropriate site collection(s). If you do not remove the association before retracting, the workflow will still be associated to the list or library, users will still see it as an available workflow for list items although it will not run, and new workflows deployed with the same name may need to be manually associated before they can run.

For more information about viewing, disabling, and removing workflow associations, see Workflow Association.

To retract and remove a workflow solution from the Workflow Conductor Solution Management page, follow these steps:

Step	Action
1.	Click the solution name in Deployed Solutions section of the Workflow Solution Management list.
2.	In the Solution Properties page, click Retract Solution.
3.	Enter a date and time to schedule the retraction and click OK. You can also schedule the retraction for Now, however note the warning below. While the app pool is recycled, the SharePoint farm is unavailable to users. IMPORTANT: The application pool is recycled during a retraction.
4.	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 to see the change). 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. NOTE: Any instances of a workflow that were running when the solution is retracted are terminated.
5.	To completely remove the workflow solution from the farm, click its name again and click Remove Solution. NOTE: If a workflow solution remains deployed (whether it is retracted or not), you will not be able to deploy any other workflows with the same name to the same Web application.

Top

Manually deploy workflow solutions scheduled for deployment

If Workflow Conductor is configured for scheduled solution deployment, solutions that are waiting to be deployed will be listed separately. To deploy a solution immediately instead of waiting for the scheduled time, follow these steps:

Step	Action
1.	In the Solutions Scheduled for Deployment section of the Workflow Conductor Solution Management page, click the Deploy link for the solution. IMPORTANT: The application pool will be recycled when the solution is deployed. Sites in the Web application may be temporarily unavailable.

Managing workflow templates from WF Conductor Studio

Overview of Workflow Conductor Templates

Template managers can open and delete templates created by any designer, and can remove any shared template. To manage workflow templates, follow the steps below:

Step	Action
1.	In the Workflow Conductor Studio ribbon, click the Open icon to open the Template Gallery.
2.	In the Template Gallery, click the Manage Templates tab. NOTE: The Manage Templates tab is only visible to template managers, and lists all templates created by any designer, all shared templates, and all featured templates.
3.	Locate the template you want to open or delete. Note that templates may be presented on multiple pages in the gallery. Use the sort and/or filter features to more easily find a template. See Filter or Sort the List of Templates in the Template Gallery for more information.
4.	Select a template by clicking it’s radio button in the Select column. Only one template can be selected at once. Once a template is selected, click Open to open it, or click the Delete link (X in the Delete column) to delete it. IMPORTANT: If a template is marked as Shared or Featured (there is a + in the Shared or Featured column), you are opening or deleting the shared or featured copy. If the template is not marked as Shared or Featured, you are acting on the copy owned by the designer listed in the Created By column. There is no recycle bin; deleted templates are gone forever.
5.	This example shows three copies of a template named WF123a. Because each is created at a different time and date, they may be three completely different workflows even though they have the same name. However, the first and the third were both created by the same designer, SP User2. If you notice the values in the Last Edited column, the one that is shared was created almost 2 hours later than the one that appears in the SP User2 My Templates tab. Because of the difference in the time, it is probably not good to assume they are exactly the same template. IMPORTANT: Be sure to verify which copy of a template you are acting on.

Manage WF Conductor Templates from Central Admin

Overview of Workflow Conductor Control Panel

template mgmt.jpg On the Template Management page of the Workflow Conductor Control Panel in SharePoint Central Administration, globally configure:

Template Managers
Featured Templates

Template Managers

select temp mgrs2.jpg Template managers have special rights in the Conductor Studio Template Gallery:

Template managers can open or delete any template created by any workflow designer using the Manage Templates tab of the Template Gallery, even if the template hasn’t been shared. This tab is only visible to Template Managers.
Template managers can remove a template from the list in the Shared Templates tab by deleting it from the Manage Templates tab.
Template managers can remove a template from the list in the Featured Templates tab by deleting it from the Manage Templates tab. Adding a template to the Featured Templates list can only be done through the Workflow Conductor Control Panel in Central Administration.

To make a user a Template Manager, follow these steps:

Step	Action
1.	In the Select Template Managers section of the Template Management page, enter one or more SharePoint users separated by semi-colons. Use the Lookup () to search for names. When ready, click to resolve the names and ensure they are entered correctly. IMPORTANT: Since templates are managed from within the Conductor Studio, to be a Template Manager, a user must also be a Workflow Designer. See Configuring WF Conductor Workflow Designers for more information.
2.	Click OK at the bottom of the page so save your changes.

Step

Action

In the Select Template Managers section of the Template Management page, enter one or more SharePoint users separated by semi-colons. Use the Lookup () to search for names. When ready, click to resolve the names and ensure they are entered correctly.

IMPORTANT: Since templates are managed from within the Conductor Studio, to be a Template Manager, a user must also be a Workflow Designer. See Configuring WF Conductor Workflow Designers for more information.

Click OK at the bottom of the page so save your changes.

Top

Featured Templates

Featured templates, like Shared Templates, are available to all Workflow Designers from the Featured Templates tab of the Open Workflow Template dialog in the Conductor Studio. The list of Featured Templates, because it is more tightly controlled, is usually shorter than Shared Templates and therefore may be easier for your end users to use.

To add a workflow template to the Featured Templates area of the template gallery, see Featured workflow templates

Location of Installation

IMPORTANT: As of April 2017, Bamboo has changed the installation process for Bamboo components. The Setup Program has been replaced by an updated process. Please see Overview of the Updated Installation Process for Bamboo components and Uninstalling using the updated process for details.

If you are installing a Bamboo product in a SharePoint farm environment, make sure to start the installation on the correct server. The required installation location is listed in the Setup/Installation program interface in the description for each component. See Overview of the Setup Program from more information.

Most Bamboo products are installed on a farm server running the Microsoft SharePoint Foundation Web Application service (or the Windows SharePoint Services Web Application if you are using SharePoint 2007), but some are installed on a farm server running the Central Administration service. Refer to SharePoint Central Administration -> System Settings -> Servers -> Manage servers on this farm for a list of farm servers running these services. If you are using SharePoint 2007, find the list of farm servers in Central Administration > Operations > Servers in Farm.

CA-Manage Servers on this farm.png
During the install process, the component will be automatically deployed to all Web front-end servers by the SharePoint Timer service via SharePoint Solution Deployment. There is no need to run the Setup/Installation program on more than one server in the farm.

Refer to Required Installation Permissions for information about the level of permission the installation account requires.

Log to History

The Log to History widget writes a custom message to the workflow history. Workflow history messages are shown on the workflow status page. Read Viewing Workflow Status for more information.

Widget Properties:

Column	Description
Message	Enter text for the workflow history Description column by typing text in the property field or by clicking the button to open the text editor. Add lookups to the Description text using the Add Lookup button () in the text editor.
Outcome	Enter text for the workflow history Outcome column by typing text in the property field or by clicking the button to open the text editor. Add lookups to the Outcome text using the Add Lookup button in the text editor.
Click Apply to save the widget settings.

Example Using Log to History Widget

Return to Lists and Items Widgets

See Also:

Lists and Items Widgets

This is a high level overview of the types of List and Items Widgets available. Click on the name of the widget to get details and examples.

Add Attachment: The Add Attachment widget attaches a file to a SharePoint List item.
Add Column: Add an existing site column to a list or library.
Check In: Check in an item.
Check Out: Check out an item.
Complete Task: Set a task Status field to Completed.
Copy Item: Copy an item to a list or library.
Create Column: Create a new column in a list or library.
Create Item: Create a new item in a list or library.
Create List: Create a new list.
Create Task: Create a Task list item.
Delete Item: Delete an item from a list or library.
Delete List: Delete a list.
Discard Check Out: Remove the Checked Out status from an item.
Get Previous Version: Query and return the value of a field for the previous version of an item.
Log to History: Write an entry to the Workflow History list.
Move Item: Move an item to a list or library.
Set Approval Status: Set the Approval Status on an item.
Set Field Value: Set the value of a field for an item in a list or library.
Set Item Permissions: Set unique item permissions for an item in a list or library.
Update Item: Update one or more fields for an item in a list or library.

See Also:

Localize Bamboo Web Parts for your Language

Overview of the localization process for Bamboo Products

Applies to:

All Bamboo Web Part components
Windows SharePoint Services 3.0 and Microsoft Office SharePoint Server 2007
SharePoint Foundation 2010 and SharePoint Server 2010
SharePoint Foundation 2013 and SharePoint Server 2013

Bamboo products can be configured to display product menus, user interface text, and settings in your local language. You can also customize the default text provided with the product. To change the language or text a product displays, perform the steps described in this page. Click a link below for detailed information about each step.

About the Language Files
Editing Text in Language Files
Selecting a New Language File for a Product

Top

About the Language Files

There are four language files included with Bamboo products. Their name and location may differ by product.

Setting	Older Products	Newer Products
Web Part Language Settings		Newer products will show the language choices in the Web Part settings using the abbreviated [language]-[COUNTRY] format (e.g. “en-US”)
Language File Names	1033.English.xml (the default) 1031.German.xml 1034.Spanish.xml 1036.French.xml	Bamboo.[Product].en-US.resx (the default) Bamboo.[Product].de-DE.resx Bamboo.[Product].es-ES.resx Bamboo.[Product].fr-FR.resx
Language File Location	These files are located in the wpresources folder. This folder and its associated language files may be located under one of the following paths on each SharePoint server: servernamedriveInetpubwwwrootwss VirtualDirectoriesportwpresources[Product] servernamedriveInetpubwwwrootwss VirtualDirectoriesportwpresources[Product] LanguageFiles servernamedriveProgram FilesCommon FilesMicrosoft Sharedweb server extensionswpresources[Product]	Depending on your version of SharePoint, your localization files may be found in the following locations. servernamedriveProgram FilesCommon Filesmicrosoft sharedWeb Server Extensions15CONFIGAdminResources (SharePoint 2013) servernamedriveProgram FilesCommon Filesmicrosoft sharedWeb Server Extensions14CONFIGAdminResources (SharePoint 2010)

Setting

Older Products

Newer Products

Web Part Language Settings

Newer products will show the language choices in the Web Part settings using the abbreviated [language]-[COUNTRY] format (e.g. “en-US”)

Language File Names

1033.English.xml (the default)
1031.German.xml
1034.Spanish.xml
1036.French.xml

Bamboo.[Product].en-US.resx (the default)
Bamboo.[Product].de-DE.resx
Bamboo.[Product].es-ES.resx
Bamboo.[Product].fr-FR.resx

Language File Location

These files are located in the wpresources folder. This folder and its associated language files may be located under one of the following paths on each SharePoint server:

servernamedriveInetpubwwwrootwss
VirtualDirectoriesportwpresources[Product]
servernamedriveInetpubwwwrootwss
VirtualDirectoriesportwpresources[Product] LanguageFiles
servernamedriveProgram FilesCommon FilesMicrosoft Sharedweb server extensionswpresources[Product]

Depending on your version of SharePoint, your localization files may be found in the following locations.

servernamedriveProgram FilesCommon Filesmicrosoft sharedWeb Server Extensions15CONFIGAdminResources (SharePoint 2013)
servernamedriveProgram FilesCommon Filesmicrosoft sharedWeb Server Extensions14CONFIGAdminResources (SharePoint 2010)

The German, Spanish and French files have not yet been translated; although the file name suggests otherwise, their content is English. Edit these files to provide your own text or translation of the product user interface and settings.

IMPORTANT: If you do not rename the files you modify, your customizations will be overwritten when you upgrade to a new Bamboo product release.

To make sure that your customizations do not get overwritten when you upgrade the product, follow these steps:

Step

Action

Copy the default file for the appropriate language and rename the copy. For example, you might save a localized French language file as CompanyName.1036.French.xml or Copy.Bamboo.ProductName.fr-FR.resx.

NOTE: When you next upgrade the product, the default file (i.e., 1036.French.xml) will be overwritten with the new version. Your file will not. You can use any file name, as long as the file extension is .xml (or .resx for newer products).

To create language files for languages other than German, English, Spanish, or French, copy one of the existing language files and rename it. Then edit the file to provide your own translation.

When you upgrade your Bamboo product, the installation/setup application will not remove or overwrite language files you created if you saved them with a name other than the default. However, product upgrades may require that you merge new resource strings for the new product release.

NOTE: If you forget to add new resource strings to your custom language file, you may see strange things in the user interface. The product will display missing resource string IDs instead of text.

Copy these new resource string IDs from a default language file to your custom file and make any desired translations.

Top

Editing Text in Language Files

IMPORTANT: Before making any changes to any file, back up your original file and put it in a safe place.

To change text in a language file, follow these steps:

Step	Action
1.	Open the language file in a text editor and locate the text you want to change.
2.	Edit the text between the <resource></resource> tags but do not edit the tags. NOTE: Do NOT modify the resource id value. Modify only the text between the <resource></resource> tags. If you want to remove text completely, delete only the text; do not delete the <resource> entry from the file, or the product interface will display an error message. In the example below, the text you can modify is highlighted in gray.
3.	When you are finished with your changes, save the file and copy it to the appropriate resources folder on all Web front-end servers in your SharePoint farm.
4.	Follow the instructions below to select your new language file in the product settings.

Top

Selecting a New Language File for a Product

The instructions below for changing language file settings apply to Bamboo products with settings configured in the Web Part tool pane or Web Part Settings pop-up page. If you have multiple instances of a product in your portal, you must make the same change for each instance that requires the change.

Change the Language Settings in the Web Part Tool Pane:

Step	Action
1.	Click the edit drop-down menu on the Web Part title bar and select Edit Web Part (or Modify Shared Web Part if you are using SharePoint 2007). See the example from the Group Email Web Part.
2.	In the Language Settings section of the Web Part tool pane, select the language file you want to use. See the example from the Group Email Web Part. If you have created a new file (i.e., Copy.Bamboo.ProductName.fr-FR.resx), it should appear in the list as a valid selection.
3.	Click Apply and then OK in the Web Part tool pane to apply your changes.

Change the Language Settings in the Web Part Settings Pop-up Page:

Step	Action
1.	Click the edit drop-down menu on the Web Part title bar and select Edit Web Part (or Modify Shared Web Part if you are using SharePoint 2007).
2.	Click the [Product] Settings button in the Web Part tool pane.
3.	Click Language Settings in the Web Part Settings page and select the language file you want to use. If your product does not have a Language Settings section, look for the Select a Language drop-down list in General Settings instead. If you have created a new language file (i.e., Copy.Bamboo.ProductName.fr-FR.resx), it should appear in the list as a valid selection.
4.	Click the Save & Close button to save the Web Part settings.
5.	Click Apply and then OK in the Web Part tool pane to apply your changes.

Localize Bamboo Applications or Custom Columns

Overview of the localization process for Bamboo Products

Bamboo applications and custom columns are slightly different than web parts when it comes to localizing/translating. The user interface isn’t confined to a web part, but can exist as site definitions or other custom pages. For example, the configuration of a Bamboo custom column is within the SharePoint list settings area.
The text strings that require translation are located in different files than the strings that appear in a web part.

Changing the language or text for an application or custom column is a multi-step process:

About the Language files
Editing text in resource files
Applying Language File Updates

Top

About the Language Files

Text displayed in a Bamboo application may be included in one or both of the following locations:

Provisioning Resources. These resources are located in the 12, 14, or 15 “Hive”, in the Resources folder. The number of the Hive depends on the version of SharePoint you are using (e.g., SP2007 has a 12 Hive, SP2010 has a 14 Hive, and SP2013 has a 15 Hive).

The Bamboo.*.resx files include text used in site features, site definitions, list definitions, and other provisioning resource elements. Any changes you make in these files will apply to new product instances only.
Application/Runtime Resources. These are also located in the 12, 14, or 15 Hive, but in the CONFIGResources folder.The Bamboo.*.resx file in the CONFIG folder is different than the one included in the Resource folder. This one includes text used in application pages, custom site menu actions, navigation elements, and other runtime resources. Any changes you make will apply to new and existing product instances only.

In each location, there may be multiple versions of Bamboo.*.resx files with identical content. The different files are provided for English (en-US), German (de-DE), French (fr-FR), and Spanish (es-ES). The content of all files is in English until you translate it to your language. If your site is configured to use a language that does not have a corresponding Bamboo product .resx file, copy an existing file and rename it to include the culture name for that language pack. For example, create a file for Italian by saving the default file as Bamboo.[Product].it-IT.resx. Make your changes to this new file. If your site is configured to use a specific language but you do not have a culture-specific file, the product will use the default Bamboo.[Product].resx file instead.

IMPORTANT: If you customize one of the default resource files provided with the product, your changes will be overwritten when you upgrade.

To avoid losing customizations, copy the customized file to a different location (not the same folder) before upgrading. After the upgrade is finished, compare the new file with your customized file to incorporate any new entries. Then copy the merged file to the Resources folder. Culture-specific files created for languages that are not provided with the product will not be overwritten during an upgrade, but you still need to incorporate new resource entries.

Top

Editing text in resource files

IMPORTANT: Before making any changes, back up your original file to a different folder.

To change text in a resource file, open it in a text editor and locate the text you want to change. Editable text is usually found between the <value></value> tags, as shown in the screen shot below. Do not modify the data tag. If you want to remove text completely, delete only the text; do not delete the <data> or <value> entries from the file, or the server will display an error message. In the example below, the editable text is highlighted in gray.

When you are finished with your changes, save the file and copy it to the appropriate Resources *folder on *all Web front-end servers in your SharePoint farm. Follow the instructions below to make your changes take effect.

Top

Applying Language File Updates

To apply changes to Provisioning Resource Files:

If you modified the provisioning resources file, apply your changes by restarting Web services with the following command on all Web front-end servers.

iisreset

NOTE: changes to provisioning resources affect new instances of the Bamboo product only; existing instances of the product are not updated.

To apply changes to Application/Runtime Resource Files:

If you modified the application/runtime resources file, apply your changes by executing the following stsadm command on all Web front-end servers. This command copies the updated resource file to the App_GlobalResources folder of each Web application. Changes apply to existing product instances and any new instances you create.

stsadm -o CopyAppBinContent

NOTE: Changes apply to EXISTING product instances AND any new instances you create.

Is there a way to find a lost or unknown Bamboo product license key?

If your Bamboo Product License is invalidated because of a change to the hardware profile of a server, the license key used to activate it previously will not be shown in the Bamboo Web License Manager in SharePoint Central Administration.

You should be able to find the license keys associated with your purchase in the My Bamboo area of the Bamboo Solutions web site.

Step

Action

Click the My Orders link from the Home page.

Mb-Home squares.jpg

On the Product Licenses tab of the My Orders page, the license keys associated with the products you’ve purchased are listed.

MB-MyOrders blurred.jpg

NOTE: If you don’t see your orders listed on the page, please contact your Bamboo Sales Representative at Sales@bambooosolutions.com

Installing the Bamboo Web License Manager

Overview of Licensing and and Product Activation

If you need to activate your Bamboo product license, you most likely need the Bamboo Web License Manager installed on your farm. If you need to activate a Bamboo Desktop application, please see Activating a Bamboo Desktop Product Using the License Manager

NOTE: If you are running with a free trial license, there is no need to install this component.

Install the Bamboo Web License Manager on one of the servers in the SharePoint farm that is running the Central Administration service. The component will be automatically deployed to all Central Administration Web applications by the SharePoint timer service.

NOTE: You must be a member of the local server Administrators group and have the db_owner role for the SharePoint configuration database to install and run the Bamboo Web License Manager.

Step	Action
1.	On the server running the Central Administration service, run the Setup program for any Bamboo product. NOTES: 1. Refer to System Settings in SharePoint Central Administration for a list of servers running this service. 2. Although every product Setup package includes the Web License Manager, it is necessary to install it only once on the farm.
2.	From the Setup interface, click the Bamboo Web License Manager component. Verify that the installation location is correct. Verify that the you have the required installation permissions. Click the Install button. The installation for the Web License Manager will begin.
3.	Click Next to continue.
4.	The install will run through some system checks. If they pass, click Next. NOTE: The Web License Manager expects Bamboo Logging V1 to have been previously installed. If you have installed a Bamboo product before installing the Web License Manager, this Prerequisite Component will already be installed.
5.	Read and accept the Bamboo End-User License Agreement. When you check the box labeled “I accept the terms in the License Agreement”, the Next button will be enabled. Click it to continue.
6.	The Web Application where Central Administration is running should be displayed in the Deployment Targets page. Check the box at the bottom to automatically activate the feature during the install. NOTE: If desired, you can always activate the feature manually in Central Administration.
7.	Monitor the progress of the install. When its complete, click Next.
8.	A Summary of the installation is presented. Click Close to complete the process.
9.	After a successful installation of the Web License Manager, you should see a Bamboo Solutions entry on the main page of SharePoint Central Administration on the main page.

Installing the Workflow Start Feature

This feature allows you to create buttons on list/library ribbons that, when clicked, start a workflow on the highlighted item.

Step	Action
1.	Highlight the Workflow Start Feature item in the Optional Items section of the Workflow Conductor Setup program. When a component is selected, information specific to it is displayed on the right side of the interface. When ready, click Install. The Workflow Start Feature installation/upgrade program starts and the Welcome page is displayed.
2.	Verify that the system checks pass successfully and click Next. If the system checks do not pass, you will not be able to proceed. NOTE: It will be possible to proceed if the World Wide Publishing Service is started, although a yellow warning icon will be displayed. If you are running with Claims Based Authentication (CBA) or if you are installing on SharePoint 2013, you need to keep this service on in order to automatically activate features during the install. Other than these scenarios, we strongly recommend that you stop this service before installing or upgrading. See Recommendations for a successful intstall for more information.
3.	Read and accept the Bamboo Solutions End-User License Agreement (EULA).
4.	In the Deployment Targets page, select the Web Application(s) on the farm where you want to deploy the feature. If you are a Site Collection Administrator for all the site collections in the selected Deployment Targets (web apps), it’s OK to leave the Automatically activate features… option checked, otherwise uncheck it. NOTE: If you prefer that Site Collection Administrators activate product features as they are needed, uncheck the Automatically activate features option, then read read How to activate a Bamboo Site Collection Feature to understand how to manually activate these features at a later time.
5.	Wait while the installation progresses. When the process completes, the All operations successfully completed message will be displayed and the Next button will be enabled. When ready, click Next.
6.	Details about the process are shown. Review the details carefully to make sure everything was successful. When ready, click Close.
7.	See Using the Workflow Start Feature for more information about how to activate and use this feature.

Installing using the updated install process

Overview of the Updated Installation Process

In April 2017, with the Q1 Cumulative Update (CU) Bamboo introduced updated install/uninstall processes for component products (web parts). For more information about why this was introduced, please see Overview of the Updated Installation Process for Bamboo components

To install using the updated install process, please follow these steps (Warning.. Installs should be performed in Non-Peak hours as your farm will temporarily go offline):

No.	Function
1.	Download the install package from My Bamboo.
2.	Extract the contents of the package.
3.	Run the Install.ps1 from a WFE server in PowerShell as an admin.
4.	The script will look for WSPs in the install folder and list those found. It will install them in alpha order. Rather than deploying the solution immediately after its installed, the script schedules deployment time for 1 minute in the future so multiple installs won’t collide. IMPORTANT: By default, the script deploys solutions to all content web applications. If you don’t want to do this, please update the script for your needs.
5.	When the deployment completes, check Central Administration to confirm deployment completion.
6.	Activate in the desired Site Collections. See Activating a Bamboo Site Collection Feature for details.

Install the WF Conductor Configuration Database

IMPORTANT: For installations on Windows Server 2008 and 2012 with UAC, you must disable UAC. If you attempt to install the Conductor Configuration Database component on Windows Server 2008 or 2012 with UAC enabled, the database installation may fail with the error message Database creation failed.

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:

Step	Action
1.	On a server in the SharePoint farm with access to the SQL Server where the SharePoint configuration and content databases are located, start the Workflow Conductor install and highlight the Configuration Database component. Verify the installation location and required installation permissions and then click the Install button.
2.	In the first installation screen, click Next.
3.	Select an installation folder location and click Next, and then click Next in the Confirm Installation screen to begin configuring the Workflow Conductor database.
4.	In the Workflow Conductor Configuration Database screen enter the name of your database server and SQL Server instance. For example: Entering just a . will install and configure the Conductor database on the default SQL Server instance on the server where you are running the install. Entering DBSERVER will install and configure the Conductor database in the default SQL Server instance on the server DBSERVER. Entering DBSERVEROFFICESERVERS will install and configure the Conductor database in the OFFICESERVERS instance on DBSERVER. This is common for SharePoint installations that use SQL Server Express. Entering DBSERVERSQLINSTANCE 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. If you are installing Workflow Conductor for the first time, enter a name for the Workflow Conductor database. The database will be created with the name Conductor_Content_[NameYouEnter]. Typical names are Conductor_Content_Database or Conductor_Content_DB. Select Windows authentication if your database is on a different server than the one where you are running the install. If the database is on the server where you are installing, you can optionally use a SQL authentication account.
5.	Click Finish. The Workflow Conductor database will be created and populated. You will see some progress notes displayed at the bottom of the page.
6.	When the database is created, the Installation Complete page is displayed. Click Close to exit the installation.

Options for Installing

Option

When or Why to use this?

Use the Updated Installation Process for Bamboo components

Based on feedback from our customers, Bamboo introduced updated install/uninstall processes for component products (web parts). Instead of the Setup.exe Installation Application, we now supply two PowerShell scripts – one for Install/Upgrade and the other for Uninstall – to be used to install, upgrade, or uninstall the product.

For more information, see Overview of the Updated Installation Process for Bamboo components.

Use the Bamboo Installation/Setup program

IMPORTANT: As of April 2017, Bamboo no longer includes the Installation/Setup program in product download packages.

This is an easy option for small to medium sized farms with not too many web applications and/or WFE servers. The program will automatically check certain conditions, ask which Web Applications you want to deploy to, and then ask if you want to automatically activate site collection features. These are things that are easy to forget when installing any other way.

For more information, see Overview of the Setup Program and How to run the Installation/Setup program.

NOTE: You may decide NOT to use the Installation/Setup Program if your farm has several web front end servers (WFEs) or Web Applications. The installation and/or the solution deployment may timeout trying to deploy to a very large farm. In this case, it may be best to manually install the product on your farm.

Manually Install

Extra care must be used when installing a product manually because the series of automated checks performed by the Bamboo Installation program will not be available. Unexpected behavior during product configuration, licensing, or use may occur if some steps are skipped.

Generating Activation Keys using My Bamboo

All Bamboo products that deploy to SharePoint can be activated online and the license(s) managed using Bamboo Web License Manager. Bamboo Web License Manager is included with the Setup program for every Bamboo product. You only need to install it once on your farm to manage all Bamboo products that have been or will be installed. After installation, it is accessed via SharePoint Central Administration.

If you are activating a Bamboo product on a server that does not have Internet access, you can activate your license offline and send the License Key and Machine Key to the Bamboo Support Team.
Alternatively, you can generate the Activation Key yourself via the My Bamboo area of the Bamboo Solutions website.

To generate the Activation Code yourself, follow these instructions.

Step	Action
1.	On a computer with Internet access, log in to My Bamboo with any valid account. In the My Orders tab, click Manage License.
2.	On the Manage License tab, enter the License Key and Machine Key. NOTE: See Activating My Bamboo Product License Offline to get the Machine Key. Click the Generate button to generate the activation key. Copy this key and put it in a safe place. You will need it in the next step. NOTE: If you are unable to successfully generate an activation key, send the License Key and the associated Machine Key to the Bamboo Support Team via Support@bamboosolutions.com. They will send the Activation Key to you via Email.
3.	Return to the Bamboo Web License Manager Offline Activation page in SharePoint Central Administration. Paste the activation key in the Activation Key box, and then click Activate.
4.	Your Bamboo product is now Active and is ready for use, as shown by the Status column. If you ever need to check which license key you used to activate each server, the license key used is shown on this status page.

Information Types used on Workflow Initialization Forms

Create a New Workflow Initiation Form

Use the information in the table below to learn about the Information Types available for Workflow Conductor Initialization Forms.

Single line of text	Date Time	Number
Multiple lines of text	Choice	Yes/No

Type	Description
Single line of text	Top Enter a default value, if desired, and check Requires value if you need this field to have a value before the workflow continues.
Multiple lines of text	TopEnter a default value, if desired, and check Requires value if you need this field to have a value before the workflow continues. Need more info about HTML format allowed.
Number	TopSpecify the following for the Number field: Enter a default value, if desired Check Requires value if you need this field to have a value before the workflow continues. If you want to force the value entered to be greater than a minimum, check the Minimum value allowed box and enter the minimum value. If you want to force the value entered to be less than a maximum, check the Maximum value allowed and enter the maximum value.
Date	TopSpecify the following for the Date field: Enter a default value, if desired. You can select the current date as the default or enter a specific date. Check Requires value if you need this field to have a value before the workflow continues. Choose the format for the date displayed. It can include time or not include time. Check the box if you want the date entered to be greater than the date the workflow runs.
Choice	TopSpecify the following for the Choice field: Enter the choices for the end user. If you would like to display different text than that saved to the parameter, include a vertical separator. For example, to store “1 – High” but display “High”, enter the choice value as 1 – High \| High. Enter a default value, if desired. Check Requires value if you need this field to have a value before the workflow continues. Choose to display the choices in a drop-down menu or as radio buttons.
Yes/No	TopEnter a default value, if desired. NOTE: This field will always have a value, so there is no option to make it a required field.

How to View Workflow Status

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.

View all workflows started on an item

Workflow Conductor adds an option to the list item menu called Workflow Status. This option displays a Workflow Status page (as shown below) 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).

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.

View the most recent workflow started on an item

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.

View all workflows started in the Web application

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.

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.