US 1.877.212326.2662
Browse Search
INFO: Best Practices for Installing Bamboo Products
Created on: 27-May-10. Print Article
Last Modified on: 24-Mar-16. Email Article
Skill Level: Novice.
Article has been viewed: 41684 times.
Rated: 6 out of 10 based on 45 votes.
KB.12464

APPLIES TO:

  • All Bamboo Products
  • WSS 3.0, MOSS 2007, SharePoint Foundation 2010/2013, and SharePoint Server 2010/2013/2016

This article contains best practices for installing, licensing, and activating Bamboo products. The information provided below will guide you through the installation process and assist you with product licensing and activation. It also includes troubleshooting tips for installation problems. For more specific installation instructions, refer to the Online Documentation for your product.

Click a topic below to get started.

 

Before Installing a Bamboo Product

  1. Back up your system before making any changes.
     
  2. Verify the system requirements for the product you are installing. The system requirements can be found in the Online Documentation for the product you are installing.
     
  3. Carefully review the installation instructions in the Online Documentation for the product you are installing.
     
  4. If you are installing the product in a SharePoint farm, verify the installation location requirements for the product you are installing. Installation location requirements are listed in the Setup program in the description for each product component. 
     
  5. Verify the permissions required for the installation account you are using to install the product. Required installation permissions are listed in the Setup program in the description for each product component. Most Bamboo products require at least the following permissions for the installation account:
    • Must be a member of the local server Administrators group to install application files.
    • Must have the db_owner role for the SharePoint configuration database. 
    • To automatically activate product features during installation, use an account that is also a SharePoint site collection administrator.
       
  6. Prepare your SharePoint farm for the installation. On all servers in the SharePoint farm running the Microsoft SharePoint Foundation Web Application service (SharePoint 2010) or the Windows SharePoint Services Web Application service (SharePoint 2007), go to Start > Administrative Tools > Services and stop or restart the following services:
    • Stop the web application pools for the content web applications and for Central Administration via the IIS Manager.  (If you stop the World Wide Web Publishing Service and you are using Claims Based Authentication, the installation will fail (Note: Read KB.12732 for more information)).
    • Restart the SharePoint 2010 Timer service (SharePoint 2010) or Windows SharePoint Services Timer service (SharePoint 2007) on all servers. Do this step even if the service is currently running.
    • Restart the SharePoint 2010 Administration service (SharePoint 2010) or Windows SharePoint Services Administration service (SharePoint 2007) on all servers. Do this step even if the service is currently running.
       
  7. If you are migrating a product from a SharePoint 2007 farm to a SharePoint 2010 farm, read KB.12630: Migrating Bamboo Products from SharePoint 2007 to SharePoint 2010, from SharePoint 2010 to SharePoint 2013, read KB.12896: Migrating Bamboo Products from SharePoint 2010 to SharePoint 2013, from SharePoint 2013 to SharePoint 2016, read KB.13057: Migrating Bamboo Products from SharePoint 2013 to SharePoint 2016.  

About the Setup Program

Bamboo products are downloaded as a self-extracting executable (EXE) that contains an installation wizard (the Setup program), all required product installation files, and an Installation and Licensing Quick Start Guide. To access the Setup program:

  1. Download the self-extracting product EXE from the Bamboo Storefront and save it to a folder on your SharePoint server.
     
  2. Double-click the product EXE file. The contents of the EXE are extracted into the same folder where the product EXE resides.
     
  3. The Setup program will automatically start. To start the Setup program manually, double-click the Setup.bat file in the root of the extracted folder.

The Setup program contains links to each product component under the Core Components and Optional Components headers on the left. Click on any of these links to view a description of the component on the right. The component description contains important information about where to install the component and the required permissions for the installation account. Read this information carefully before proceeding.

 

Installing Product Components

To install a product component, click the Install button below the component description in the Setup program. If your product contains multiple components, click the Install button for each component.

Installing Product Components

After you click the Install button, the installation wizard for that component will start. The Online Documentation for your product contains detailed installation instructions to walk you through the installation wizard. Follow these instructions carefully to ensure a successful installation.

When the installation is finished, the installation wizard will display a screen with the installation results. Read the information in this screen to make sure all components installed successfully. If a component did not install, the error message will provide additional information for troubleshooting.

Product Installation Summary

Selecting Web Applications
During the installation for some product components, you will be asked to select the Web applications where the product will be installed. The product will be deployed as a site collection feature for all site collections in the selected Web applications.

Deployment Targets

If the option to Automatically activate features is selected in the Web application selection screen (the default option), the product features will be activated in each site collection. If you deselect this option, or if the installation account does not have the required permissions to activate site collection features, you can manually activate features later.

Once a product feature is installed and activated, it is ready to use. The Online Documentation for your product contains information about configuring and using the product.

Installing Product Components in a Farm Environment
If you are installing your product in a farm environment, make sure to start the installation on the correct server in your farm. The required installation location is listed in the Setup program in the description for each component. In general, Bamboo product components must be installed in one of the following locations:

  • On one Web front-end (WFE) server in your farm. WFE servers run the Windows SharePoint Services Web Application service (WSS 3.0 and MOSS 2007) or the Microsoft SharePoint Foundation Web Application service (SharePoint Foundation 2010 and SharePoint Server 2010). The product will be automatically deployed on all other WFE servers in your farm.
  • On one server in your farm running the Central Administration service. The product will be automatically deployed to all other servers in your farm running this service.
  • On ALL WFE servers in your farm. Some products must be installed separately on each WFE.
  • Some Bamboo products are desktop/server applications and do not have to be installed on a SharePoint server at all.

Required Installation Permissions
For a successful installation, the installation account must have required permissions on the server and in SharePoint. Required installation permissions are listed in the Setup program in the description for each component. The following installation permissions are required for most Bamboo products:

  • Must be a member of the local server Administrators group to install application files.
  • Must be a member of the SharePoint Farm Administrators group to deploy solutions to the farm.
  • Must be a SharePoint site collection administrator to automatically activate features during installation.

 

Product Licensing and Activation

Bamboo products include a fully-functional 30-day trial that starts the date the product is installed. After the trial period, you must purchase and activate a license for the product to continue to use it. Licenses for Bamboo products that are installed on SharePoint servers are activated using Bamboo Web License Manager. Bamboo Web License Manager enables management of Bamboo product licenses in SharePoint Central Administration. To activate a license, first install Bamboo Web License Manager, then activate the license as described in this section.

Note: Licenses for desktop/server applications such as List Bulk Import, User Profile Sync, and Office to PDF Conversion are activated using a standalone version of the licensing application, called Bamboo License Manager. Products that require license activation with Bamboo License Manager will include it (instead of Bamboo Web License Manager) with the Setup application. For a complete list of products licensed with Bamboo License Manager and links to instructions for activating the license for these products, read the Bamboo Knowledge Base article KB.12629: Products Activated Using Bamboo License Manager.

Installing Bamboo Web License Manager

Bamboo Web License Manager is included with the Setup program for all Bamboo products that require licensing. You only need to install it once. After that, it will be available in Central Administration and can be used to activate and manage Bamboo product licenses. To install Bamboo Web License Manager:

  1. Select Bamboo Web License Manager from the Setup program. 
     
  2. Verify the installation location and required permissions listed in the component description, and then click the Install button.

    Note: Bamboo Web License Manager must be installed on the SharePoint server running the Central Administration service. The installation account must be a member of the local server Administrators group and a SharePoint Farm Administrator.
     
    Install Web License Manager
     
  3. In the installation Welcome screen, click Next to continue.
     
  4. A system check is performed to determine if your server is ready for installation. Once all checks are successful, click Next. If a system check fails, click Abort, fix any problems, and then restart the installation.
     
    system checks
     
  5. Review and accept the End-User License Agreement, and then click Next.
     
    agree to the end-user license agreement
     
  6. In the Deployment Targets screen, the Central Administration Web application is selected by default. Leave it selected and click Next.
     
    Web License Manager Deployment Targets 
     
  7. The Bamboo Web License Manager feature is installed. When installation is finished, click Next.
     
  8. Setup displays an installation summary screen. Check that the solution was successfully deployed, and then click Close.
     
    Web License Manager Install Summary 

You are now ready to activate a product license.

 

Activating a Product License

  1. Open SharePoint Central Administration.
     
  2. SharePoint 2007: Click the Operations link. In the Bamboo Solutions Corporation section, click Bamboo Web License Manager.
     
    Access Bamboo Web License Manager in Central Administration (SharePoint 2007) 
     
    SharePoint 2010: In the Bamboo Solutions section in Central Administration, click Manage My License Keys.
     
    manage my license keys
     
  3. In the Bamboo Web License Manager page, expand the section (Suites and Packs or Individual Products) that contains the product you purchased, and click the link for the product name.
     
    Web License Manager Product List 
     
  4. The license Status will display as Trial or Not Active for each front-end Web server until you have activated your license. Click the Status link to display the Activation page.
     
    Web License Manager License Status Page 
     
  5. In the Activation page, enter the License Key provided when you purchased the product (also available in My Bamboo), and then click the Activate button. You need a separate license key for each front-end Web server.
     
    Web License Manager Activation Page
    Web License Manager Status Page
     
    Note: If your server does not have an Internet connection or if you prefer to activate your license offline, follow the instructions below for
    offline activation.
     
  6. Optional Step: If you have multiple servers in your farm, you can select which front-end Web servers to license. In the Bamboo Web License Manager page, click the Choose License Server(s) link. Read the descriptive text and make your selections. You must have a license key for each front-end Web server where you install Bamboo products.
     
    Web License Manager Choose License Servers
    Web License Manager Choose License Server 

Offline Activation

If your server does not have an Internet connection or if you prefer to activate your license offline, follow the instructions below to activate a license using My Bamboo or by e-mail.

Activating a License in My Bamboo (Preferred Method)

  1. Follow steps 1 through 4 in the Activating a Product License section above to access the Bamboo Web License Manager Activation page for your product.
     
  2. In the Activation page, enter the License Key provided when you purchased the product (also available in My Bamboo).
     
  3. Check the option Activate by E-mail, and then click the Activate button. You will be presented with a License Key and Machine Key, as shown below. Leave this Offline Activation page up or copy the two keys down - you will need them in the next steps.
     
    Web License Manager Activation Page
    Web License Manager Offline Activation Page
     
  4. To activate the license immediately, log in to My Bamboo with the account you created when you purchased your product. Go to the My Orders > Manage License page.
     
  5. In the Product Licenses page, enter the License Key and Machine Key from step 3 in the boxes provided in the Activate Your License tool.
     
    My Bamboo License Activation 
     
  6. Click the Generate Activation Key button. You will be presented with an activation key for your product. Copy this key - you will need it in the next step.
     
    My Bamboo Activation Key 
     
  7. Return to the Bamboo Web License Manager Offline Activation page. Enter the activation key from My Bamboo into the boxes provided, and then click Activate.
     
    Web License Manager Offline Activation
    Web License Manager Status Page
     

Activating a License by E-mail (Alternate Method)

If you prefer to activate your license by e-mail, you can do so. Be advised that e-mail activation takes additional time. For immediate license activation, active your license online or use My Bamboo.

  1. Follow steps 1 through 4 in the Activating a Product License section above to access the Bamboo Web License Manager Activation page for your product.
     
  2. In the Activation page, enter the License Key provided when you purchased the product (also available in My Bamboo).
     
  3. Check the option Activate by E-mail, and then click the Activate button. You will be presented with a License Key and Machine Key, as shown below. 
     
    Web License Manager Activation Page
    Web License Manager Offline Activation Page
     
  4. E-mail the License Key and Machine Key to Bamboo Support.
     
    Offline Activation E-mail 
     
  5. Bamboo Support will reply with your activation key.
     
  6. Return to the Bamboo Web License Manager Offline Activation page (you can follow steps 1 through 3 again to return to the page). Enter the activation key provided by Bamboo Support into the boxes provided, and then click Activate.
     
    Web License Manager Offline Activation
    Web License Manager Status Page
     

 

Manual Feature Activation/Deactivation

Product feature activations can be done automatically at the site collection level when the product is installed. There are several reasons why you may need to manually activate (or deactivate) Bamboo product features:

  • You opted out of automatic feature activation during installation.
  • You add a new site collection and want to add Bamboo features to it.
  • You want to remove Bamboo product features from an existing site collection.

To manually activate (or deactivate) Bamboo product features, follow the instructions below. The steps are the same for SharePoint 2007 and SharePoint 2010.

Note: You must be a SharePoint site collection administrator to activate or deactivate features. Site collection administrators are assigned in SharePoint Central Administration.

  1. From the top-level site in the site collection, go to Site Actions > Site Settings > Site Collection Administration > Site Collection Features
     
    Site Settings 
     
  2. Locate the Bamboo product feature and click Activate to activate it for the entire site collection, or click Deactivate to deactivate it. 
     
    Feature Activation 

 

Manual Product Installation

WARNING: Bamboo recommends using the Setup program to install product components whenever possible. The Setup program is designed to ensure a successful product installation. Manual installation may lead to unexpected behavior during product configuration, licensing, or use, especially if your SharePoint environment contains issues normally detected and resolved when running the Setup program.

To run an individual product component Setup without accessing the main Setup program, navigate to the individual [Product].wsp folder where the product EXE was extracted. Double-click Setup.exe and follow the installation instructions.

Some components (and desktop/server applications) are installed using a Windows MSI installer. The installer for these components is located in the \msi folder where the product EXE was extracted. Double-click the .MSI file for the component you want to install and follow the installation instructions.

If you want to perform a command-line installation of your Bamboo product, read Bamboo Knowledge Base article KB.12128 - HOWTO: Manually install a Bamboo Web Part.

 

Troubleshooting Tips

If your installation fails or appears to be successful but you are unable to use your product, please perform the following troubleshooting steps before contacting Bamboo Support.

  1. Review the Online Documentation for your product
  2. Search the Bamboo Knowledge Base
  3. Retry the Installation
  4. Restart the SharePoint Timer service
  5. Restart the SharePoint Administration service
  6. Restart the World Wide Web Publishing Service (W3SVC)
  7. Restart IIS
  8. Open a Support Ticket

 
Review the Online Documentation

The first places to look for installation troubleshooting assistance are the Installing the Product section of the Online Documentation for your product and the installation requirements listed in the product Setup program.

  • Review all installation steps in the Online Documentation carefully to make sure you completed them all.
  • Make sure you installed the product on the correct server in your farm, as listed in the Setup program.
  • Verify that the installation account you used has the correct permissions, as listed in the Setup program.

If you missed an installation step or find that you need to correct a problem and run the installation again, read the information in the section Retry the Installation.

The Online Documentation may also contain additional installation troubleshooting steps, links to relevant Bamboo Knowledge Base articles, and the location of log files where you might find more information.

 
Search the Bamboo Knowledge Base

The Bamboo Knowledge Base contains troubleshooting, instructional, and informational information about Bamboo products. You can browse the section of the Knowledge Base for your product, or search using keywords that describe the problem or error message. To access the Bamboo Knowledge Base, click the Knowledge Base link in the Support section of the Bamboo Website or in the Help section of the Setup program.

 
Retry the Installation

You can run the installation for one or more product components again if you need to. Simply start the Setup program by double-clicking Setup.bat in the root of the extracted folder. Click the name of the component you want to reinstall, and click the Install button.

If you have to reinstall a product, pay special attention to the following:

Stop the World Wide Web Publishing Service
System checks are performed at the beginning of the installation to make sure your system is ready. You must correct any errors before proceeding. You may see a warning to stop the World Wide Web Publishing Service. If you did not do this the first time you performed the installation and the installation failed, make sure to do it the second time. Stopping the World Wide Web Publishing Service ensures that system files that must be updated are not in use.
Note: If your SharePoint environment is configured for Claims Based Authentication, you should not stop the World Wide Web Publishing Service if you want to automatically activate product features during installation. You will stop the web application pools via the IIS Manager. Read KB.12732 for more information.

Repair/Install New or Remove and Reinstall?
If you run the installation for a component a second time, the installer may detect that the component is already installed or partially installed. If so, you may see an option to Repair/Install New. This option will review the list of installed components, install ones that are missing, and retract/redeploy ones that are already installed. If you want to make absolutely sure that the product is completely reinstalled, choose the Remove option instead. Then, re-run the installer to install the component again.

 
Restart the SharePoint Timer Service

The SharePoint Timer service runs timer jobs that propagate the configuration changes made during product installation to all the servers in the farm. If there is a problem with the timer service, these changes may not be made on all servers. To restart the SharePoint Timer service, perform the following steps on each server in the farm:

From the command line:

  1. sc stop sptimerv3
  2. sc start sptimerv3

From the Control Panel:

  1. Go to Start > All Programs > Administrative Tools > Services.
  2. In the services list, right-click Windows SharePoint Services Timer or SharePoint 2010 Timer, and then click Restart.

 
Restart the SharePoint Administration Services

The SharePoint Administration Service performs the actual configuration changes scheduled by the SharePoint Timer service during installation. If restarting the SharePoint Timer service did not fix the problem, you can try restarting the SharePoint Administration service.

From the command line:

  • sc stop spadmin
  • sc start spadmin
  • sc query spadmin will show you the service status

From the Control Panel:

  1. Go to Start > All Programs > Administrative Tools > Services.
  2. In the services list, right-click Windows SharePoint Services Administration or SharePoint 2010 Administration, and then click Restart.

 
Stop and Restart the World Wide Web Publishing Service

You should stop the World Wide Web Publishing Service (W3SVC) on all Web front-end servers in your farm during installation. This ensures that system files that need to be updated are not in use during installation. Once installation is finished, you can restart the service. Instructions for stopping and starting the service are below.

If you are troubleshooting a problem with installation and the problem appears to be with your Web server, try restarting the W3SVC service on one or all of your front-end Web servers. 

From the command line:

  1. sc stop w3svc
  2. sc start w3svc
  3. sc query w3svc will show you the service status

From the Control Panel:

  1. Go to Start > All Programs > Administrative Tools > Services.
  2. In the services list, right-click World Wide Web Publishing Service, and then click Stop (to stop the service), Start (to start it after it has been stopped), or Restart (to restart the service when it is running).

 
Restart IIS

If all other troubleshooting steps have failed, try restarting IIS.

From the command line:

  • iisreset /noforce

 
Open a Support Ticket

If you are unable to resolve your installation issues with the troubleshooting steps above, open a ticket with Bamboo Support. You can open a Support ticket even if you have not yet purchased a product (response times vary by support plan).

To open a Support ticket, log in to My Bamboo by clicking the link at the top of the Bamboo Support Web site. If you have not yet created a My Bamboo account, you can do so from the My Bamboo login page (see below). After you log in, select your product from the product list in the Home page, and click the Create Ticket button.

So that we may better assist you, be sure to follow KB.12456: Help Desk Ticket Submission Best Practices.

 

My Bamboo

Access to My Bamboo is free and does not require a product purchase. My Bamboo gives you access to product download and purchase history, up-to-date product information, access to Bamboo Support, and more.

To get started, click the My Bamboo link at the top of the Bamboo Solutions page. If you created an account when you purchased or downloaded your product, enter the account information you provided. To create a new account, click the new member signup link at the top of the login page.

 
My Bamboo Login Page

Related Articles
No Related Articles Available.

Article Attachments
No Attachments Available.

Related External Links
No Related Links Available.
Help Us Improve This Article
What did you think of this article?

poor 
1
2
3
4
5
6
7
8
9
10

 excellent
Tell us why you rated the content this way. (optional)
   
Approved Comments
No user comments available for this article.