1. Product Introduction
SharePoint Project Timer is a SharePoint project time management web part designed to help users track deadlines. It allows the configuration of a countdown timer to a specific target date, which is then displayed on the screen. This tool is particularly useful in project management environments for structuring tasks and ensuring timely completion.
This user guide provides instructions for installing and configuring Project Timer within a SharePoint environment.
For the latest version of this user guide or other documentation, please visit: http://www.boostsolutions.com/download-documentation.html
2. Installation
2.1 Product Files
After downloading and unzipping the Project Timer zip file from www.boostsolutions.com, the following files will be available:
| Path | Descriptions |
|---|---|
Setup.exe | A program that installs and deploys the WSP solution packages to the SharePoint farm. |
EULA.rtf | The product End-User-License-Agreement. |
Project Timer _V1_User Guide.pdf | User guide for Project Timer in PDF format. |
Library\2.0\Setup.exe | The product installer for .Net Framework 2.0. |
Library\2.0\Setup.exe.config | A file containing the configuration information for the installer. |
Library\4.0\Setup.exe | The product installer for .Net Framework 4.0. |
Library\4.0\Setup.exe.config | A file containing the configuration information for the installer. |
Solutions\Foundtion\BoostSolutions.FoundationSetup12.1.wsp | A SharePoint solution package containing Foundation files and resources for SharePoint 2007 or WSS 3.0. |
Solutions\Foundtion\BoostSolutions.FoundationSetup14.1.wsp | A SharePoint solution package containing Foundation files and resources for SharePoint 2010 or SharePoint Foundation 2010. |
Solutions\Foundtion\BoostSolutions.FoundationSetup15.1.wsp | A SharePoint solution package containing Foundation files and resources for SharePoint 2013 or SharePoint Foundation 2013. |
Solutions\Foundtion\Install.config | A file containing the configuration information for the installer. |
Solutions\ProjectTimer\BoostSolutions.ProjectTimerSetup12.1.wsp | A SharePoint solution package containing Project Timer files and resources for SharePoint 2007 or WSS 3.0. |
Solutions\ProjectTimer\BoostSolutions.ProjectTimerSetup14.1.wsp | A SharePoint solution package containing Project Timer files and resources for SharePoint 2010 or SharePoint Foundation 2010. |
Solutions\ProjectTimer\Install.config | A file containing the configuration information for the installer. |
2.2 Software Requirements
Ensure your system meets the following requirements before installing Project Timer:
SharePoint 2010
- Operating System: Microsoft Windows Server 2008 x64, Microsoft Windows Server 2008 R2
- Server: Microsoft SharePoint Foundation 2010 or Microsoft SharePoint Server 2010, Microsoft .NET Framework 3.5
- Browser: Microsoft Internet Explorer 7 or greater, Mozilla Firefox
SharePoint 2007
- Operating System: Microsoft Windows Server 2003 x86/x64, Microsoft Windows Server 2008 x86/x64, Microsoft Windows Server 2008 R2
- Server: Microsoft Windows SharePoint Services v3 or Microsoft Office SharePoint Server 2007, Microsoft .NET Framework 2.0 or 3.0. ? Note: This product is not compatible with SPS 2003 and WSS v2.
- Browser: Microsoft Internet Explorer 6 or greater
2.3 Installation
Follow these steps to install Project Timer on your SharePoint servers.
Installation Preconditions
Before installation, ensure the following services are running on your SharePoint servers: SharePoint Administration and SharePoint Timer.
Project Timer must run on a front-end Web server in the SharePoint farm where Microsoft SharePoint Foundation Web Application services are active. Verify this in Central Administration ➡️ System Settings.
Required Permissions
To perform this installation, you need specific permissions:
- Member of the local server's Administrators group.
- Member of the Farm Administrators group.
To install Project Timer on SharePoint server
- Download the product zip file (*.zip) from the BoostSolutions website and extract its contents.
- Open the created folder and run the
Setup.exefile. ? Note: If you encounter issues running the setup file, right-clickSetup.exeand select "Run as administrator". - A system check will verify if your machine meets all installation requirements. Click Next after the check is complete.
- Review and accept the End-User License Agreement, then click Next.
- In the "Web Application Deployment Targets", select the web applications for installation and click Next. ? Note: Selecting "Automatically activate features" will activate product features in the target site collection during installation. Uncheck this box to activate features manually later.
- Upon completion, installation details will show the web applications where the product was installed. Click Close.
2.4 Upgrade
Download the latest version of the product and run the Setup.exe file. In the "Program Maintenance" window, select Upgrade and click Next.
2.5 Uninstallation
To uninstall the product, double-click the Setup.exe file. In the "Repair or Remove" window, select Remove and click Next. The application will then be removed.
2.6 Command_Line Installation
The following instructions detail installing Project Timer solution files using the SharePoint STSADM command-line tool.
Required permissions
To use STSADM, you must be a member of the local Administrators group on the server.
To install Project Timer to SharePoint servers
- Extract the product zip pack files to a folder on a SharePoint server.
- Open a command prompt and ensure your path is set to the SharePoint bin directory:
- SharePoint 2013:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\BIN - SharePoint 2010:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\BIN - SharePoint 2007:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\BIN
- SharePoint 2013:
- Add the solution files to SharePoint using STSADM:
stsadm -o addsolution -filename BoostSolutions.ProjectTimerSetup14.1.wspstsadm -o addsolution -filename BoostSolutions.FoundationSetup14.1.wsp - Deploy the added solutions using the following commands:
stsadm -o deploysolution -name BoostSolutions.ProjectTimerSetup14.1.wsp -allowgacdeployment -url [virtual server url] -immediatestsadm -o deploysolution -name BoostSolutions.FoundationSetup14.1.wsp -allowgacdeployment -url [virtual server url] -immediate - Wait for deployment to complete. Check the final status with these commands:
stsadm -o displaysolution -name BoostSolutions.ProjectTimerSetup14.1.wspstsadm -o displaysolution -name BoostSolutions.FoundationSetup14.1.wspThe result should show a<Deployed>parameter with a value ofTRUE. - Activate the features in the STSADM tool:
stsadm -o activatefeature -name Brandysoft.SharePoint.CountdownTimer -url [site collection url] -force
To remove Project Timer from SharePoint servers
- Initiate removal with the following command:
stsadm -o retractsolution -name BoostSolutions.ProjectTimerSetup14.1.wsp -immediate -url [virtual server url] - Wait for removal to finish. Check the final status using this command:
stsadm -o displaysolution -name BoostSolutions.ProjectTimerSetup14.1.wspThe result should show<Deployed>asFALSEand<LastOperationResult>asRetractionSucceeded. - Remove the solution from SharePoint storage:
stsadm -o deletesolution -name BoostSolutions.ProjectTimerSetup14.1.wsp
To remove BoostSolutions Foundation from SharePoint servers
BoostSolutions Foundation provides a centralized interface for managing licenses for all BoostSolutions software within SharePoint Central Administration. If you are still using BoostSolutions products on your SharePoint server, do not remove Foundation.
- Initiate removal with the following command:
stsadm -o retractsolution -name BoostSolutions.FoundationSetup14.1.wsp -immediate -url [virtual server url] - Wait for removal to finish. Check the final status using this command:
stsadm -o displaysolution -name BoostSolutions.FoundationSetup14.1.wspThe result should show<Deployed>asFALSEand<LastOperationResult>asRetractionSucceeded. - Remove the solution from SharePoint storage:
stsadm -o deletesolution -name BoostSolutions.FoundationSetup14.1.wsp
2.7 Feature Activation
Activate Project Timer's feature in site collection
By default, product features are automatically activated upon installation. Manual activation is also possible.
- On the Site Actions menu, click Site Settings.
- Under "Site Collection Administration", click Site collection features.
- Find the application feature and click Activate. The "Status" column will then list the feature as "Active".
The Project Timer web part displays a countdown to a specified date and time. Example: "Product Release Deadline" with countdown values like 25 DAYS, 06 HOURS, 39 MINUTES, 55 SECONDS.
3. Configuring the Project Timer Web Part
3.1 Add a Project Timer Web Part
To add a Project Timer Web Part to a page, you require at least Design permission level.
- From any page, click the Page tab on the ribbon, then click the Edit command.
- Click the Insert tab, then click Web Part.
- Under "Categories", select the "BoostSolutions Web Parts" category, then select "BoostSolutions Project Timer Web Part", and click Add.
After adding the web part, you can configure its text and countdown target date according to your requirements.
3.2 Web Part Text Configuration
Select the Project Timer web part, click its drop-down menu, and choose Edit Web Part.
The "Edit Web Part" page will present two text boxes. The first is for entering a project title, and the second is for the message displayed after the countdown end-date is reached. You can click Preview to see the current state of the web part.
? Note: Both text boxes support Rich text editing features.
After configuration, the Project Timer web part will begin tracking your project deadline. When the countdown end-time passes, the display will change to the expiration message.
3.3 Countdown Configuration
The Project Timer web part settings box, located on the right side of the "Edit Web Part" page, is used to configure the "Countdown Configuration" section. The "Appearance", "Layout", and "Advanced" sections are included by default in SharePoint. For assistance with these sections, refer to SharePoint Help.
Countdown End-Date and Time
Select the desired date and time in the "Countdown End-Date and Time" box. This date should represent the end time of your project.
Display Option
Choose a time display format from the "Display Option" dropdown list. The options are:
- Default (DD:HH:MM:SS): Displays Days, Hours, Minutes, and Seconds.
- DD:HH:MM: Displays Days, Hours, and Minutes.
- Days Only: Displays only the number of days.
Style
You can set the style of the web part. Selecting "Custom Style" allows for customization, including uploading different digit styles and setting background colors for the time and text areas.
To customize numbers, enter a valid image path in the "Image Path Location" field. Options include specifying a URL within SharePoint or a folder on your SharePoint server.
? Note: For folder paths, use: C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\IMAGES\Brandysoft.SharePoint.CountdownTimer. Create a new folder within this path and copy your custom pictures. Then, use the path /_layouts/images/Brandysoft.SharePoint.CountdownTimer/New Folder in the "Image Location Path" field. Valid picture types are .gif, .jpg, and .png. Ensure files are named according to the number they represent (e.g., 0.jpg, 1.jpg...).
Zoom
Adjust the size of the web part. 100% is the default size.
License Management
Click the license link to access the Project Timer License Management page. For more details on licenses, refer to Appendix 1: License Management.
4. Troubleshooting & Support
Troubleshooting FAQ:
http://www.boostsolutions.com/general-faq.html#Show=ChildTitle9
Contact Info:
- Product & Licensing Inquiries: sales@boostsolutions.com
- Technical Support (Basic): support@boostsolutions.com
- Request a New Product or Feature: feature_request@boostsolutions.com
Live chat:
http://www.boostsolutions.com/support/chat/livezilla.php?intgroup=U3VwcG9ydA==&reset=true
Appendix 1: License Management
Project Timer can be used for 30 days without a license code upon first use. After expiration, a license must be purchased and registered.
Finding License Information
- On the product's main page, click the trial link to access the License Management Center.
- Click "Download License Information", select a license type, and download the relevant information (Server Code, Farm ID, or Site Collection ID).
To obtain a license from BoostSolutions, provide your SharePoint environment identifier. A server license requires a server code, a Farm license requires a farm ID, and a site collection license requires a site collection ID.
Send this information to sales@boostsolutions.com to generate a license code.
License Registration
- When you receive a product license code, navigate to the License Management Center page.
- Click "Register" on the license page to open the "Register or Update license" window.
- Upload the license file or enter the license code and click Register. A confirmation will appear once your license is validated.
The confirmation message "Registered Successfully" indicates the license verification. It thanks the user for choosing BoostSolutions and provides contact information (support@boostsolutions.com) for any issues or suggestions.
For more details on license management, refer to the BoostSolutions Foundation.
