boostsolutions 1.0 Site User Directory User Guide
- June 5, 2024
- boostsolutions
Table of Contents
Site User Directory 1.0
User Guide
Introduction
The Site User Directory web part gives you several navigational tree view
display options, either alphabetically, by OUs, SharePoint site category or
online status. Painlessly organize a list to search for users by categories.
Users that have an active status in SharePoint will show up as “Online” to
allow for swift responses if they are still currently online. Conveniently
search and display SharePoint users profiles in our Site User Directory,
whether it is for finding specified people or expertise. This user guide is
intended to assist and instruct you on how to install/uninstall, configure and
use SharePoint Site User Directory.
For the latest copy of this user guide and other guides, please visit:
http://www.boostsolutions.com/download-documentation.html
Installation
2.1 Product Files
After you download and unzip the Site User Directory zip file from www.boostsolutions.com, you will find the following files:
| 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.
Site User Directory_V1_User Guide.pdf| User guide for Site User Directory in
PDF format.
Library\2.0\Setup.exe| The product installer for .Net Framework 2.0.
Library\2.0\Setup.exe.config| A file that contains 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 that contains the configuration
information for the installer.
Solutions\Foundtion\ BoostSolutions.FoundationSetup12.1.wsp| A SharePoint
solution package that contains Foundation files and resources for SharePoint
2007 or WSS 3.0.
Solutions\Foundtion\ BoostSolutions.FoundationSetup14.1.wsp| A SharePoint
solution package that contains Foundation files and resources for SharePoint
2010 or SharePoint Foundation 2010.
Solutions\Foundtion\ BoostSolutions.FoundationSetup15.1.wsp| A SharePoint
solution package that contains Foundation files and resources for SharePoint
2013 or SharePoint Foundation 2013.
Solutions\Foundtion\Install.config| A file that contains the configuration
information for the installer.
Solutions\ SiteUserPlus\ BoostSolutions.SiteUserDirectorySetup12.1.wsp| A
SharePoint solution package that contains Site User Directory files and
resources for SharePoint 2007 or WSS 3.0.
Solutions\ SiteUserPlus\ BoostSolutions.SiteUserDirectorySetup14.1.wsp| A
SharePoint solution package that contains Site User Directory files and
resources for SharePoint 2010 or SharePoint Foundation 2010.
Solutions\ SiteUserPlus\ BoostSolutions.SiteUserDirectorySetup15.1.wsp| A
SharePoint solution package that contains Site User Directory files and
resources for SharePoint 2013 or SharePoint Foundation 2013.
Solutions\SiteUserPlus\Install.config| A file that contains the configuration
information for the installer.
2.2 Software Requirements
Before you install the Site User Directory, ensure your system meets the
following requirements:
SharePoint 2013
Operating System| Microsoft Windows Server 2012 Standard or Datacenter X64
Microsoft Windows Server 2008 R2 SP1
---|---
Server| Microsoft SharePoint Foundation 2013 or Microsoft SharePoint Server
2013 Microsoft .NET Framework 4.5
Browser| Microsoft Internet Explorer 8 or greater Mozilla Firefox
Google Chrome
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
---|---
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 the Site User Directory on your SharePoint
servers.
Installation Preconditions
Before you start installing the product, please make sure these services are
started on your SharePoint servers: SharePoint Administration and SharePoint
Timer.
Site User Directory must be run on one front-end Web server in the SharePoint farm where Microsoft SharePoint Foundation Web Application services are running. Check Central Administration → System Settings for a list of servers running this service.
Required Permissions
To perform this procedure, you must meet either of the following requirements:
- Member of the local server’s Administrators group.
- Member of the Farm Administrators group.
To install Site User Directory on the SharePoint server
a. Download the zip file (*.zip) of the product of your choice from the
BoostSolutions website, then extract the file.
b. Open the created folder and run the Setup.exe file.
Note If you cannot run the setup file, please right-click the Setup.exe
file and choose Run as administrator.
c. A system check is performed to verify if your machine meets all the
requirements for installing the product. After the system check is finished,
click Next.
d. Review and accept the End-User License Agreement and click Next.
e. In the Web Application Deployment Targets, select the web applications you
are going to install and click Next.
Note If you select Automatically activate features, the product features
will be activated in the target site collection during the installation
process. If you want to manually activate the product feature later, uncheck
this box.
f. Upon completion of the installation, details are displayed showing which
web applications your product has been installed to. Click Close.
2.4 Upgrade
Download the latest version of our product and run the Setup.exe file.
In the Program Maintenance window, select Upgrade and click Next.
2.5 Uninstallation
If you want to uninstall the product, double-click the Setup.exe file.
In the Repair or Remove window, select Remove and click Next. Then the
application will be removed.
2.6 Command Line Installation
The following instructions are for installing the solution files for Site User
Directory in SharePoint 2013 by 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.
Install Site User Directory on SharePoint Server
a. Extract the files from the product zip pack to a folder on one SharePoint
server.
b. Open a command prompt and make sure your path is set with the SharePoint
bin directory.
▪ SharePoint 2013
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\BIN
SharePoint 2007
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\BIN
c. Add the solution files to SharePoint in the STSADM command line tool.
stsadm -o add solution -filename BoostSolutions.SiteUserDirectorySetup15.1.wsp
stsadm -o add solution -filename BoostSolutions.FoundationSetup14.1.wsp
d. Deploy the added solution with the following command:
stsadm -o deploy solution -name BoostSolutions.SiteUserDirectorySetup15.1.wsp
-allow a deployment –URL [virtual server url] –immediate stsadm -o deploysolution -name BoostSolutions.FoundationSetup14.1.wsp -allow a deployment – URL [virtual server url] –immediate
e. Wait for the deployment to complete. Check the final status of the
deployment with this command:
stsadm -o displaysolution -name BoostSolutions.SiteUserDirectorySetup15.1.wsp
stsadm -o displaysolution -name BoostSolutions.FoundationSetup14.1.wsp
The result should contain a
f. In the STSADM tool, activate the features.
stsadm -o activatefeature -name SharePointBoost.Admin.SiteUserPlus –url [site
collection url] – force
Remove Site User Directory from SharePoint Servers
a. Removal is initiated with the following command:
stsadm -o retractsolution -name BoostSolutions.SiteUserDirectorySetup15.1.wsp
-immediate -url [virtual server url] b. Wait for the removal to finish. To
check the final status of the removal you can use the following command:
stsadm -o displaysolution -name BoostSolutions.SiteUserDirectorySetup15.1.wsp
The result should contain the
c. Remove the solution from the storage of the SharePoint solution:
stsadm -o deletesolution -name BoostSolutions.SiteUserDirectorySetup15.1.wsp
To remove BoostSolutions Foundation from SharePoint servers
The BoostSolutions Foundation is designed to provide a centralized interface
to manage licenses for all BoostSolutions software from within SharePoint
Central Administration. If you are still using BoostSolutions product on your
SharePoint server, DO NOT remove Foundation from the servers.
a. Removal is initiated with the following command:
stsadm -o retract solution -name BoostSolutions.FoundationSetup14.1.wsp
–immediate –url [virtual server url] b. Wait for the removal to finish. To
check the final status of the removal you can use the following command:
stsadm -o displaysolution -name BoostSolutions.FoundationSetup14.1.wsp
The result should contain the
c. Remove the solution from the SharePoint solutions storage: stsadm -o
deletesolution -name BoostSolutions.FoundationSetup14.1.wsp
2.7 Feature Activation
Activate Feature in Site Collection
By default, the application’s features are automatically activated once the
product is installed. You can also activate the product feature manually.
a. On the Site Actions menu, click Site Settings.
b. Under Site Collection Administration, click Site collection features.
c. Find the application feature and click Activate. After the feature is
activated, the Status column lists the feature as Active.
How to Use Site User Directory
3.1 Add a Site User Directory Web Part
To add a Site User Directory Web Part, ensure you have at least the Design
permission level.
a. From any page, look for and click the Edit command.
b. Click on the page where you want to add the Web Part, click the Insert tab,
and then click Web Part.
c. Under Categories, select BoostSolutions Web Parts, select BoostSolutions
Site User Directory Web Part, and then click Add. 
3.2 Web Part Configuration
3.2.1 Basic Settings
In the Basic Settings section, you can specify which tabs show on the Web
Part. By default, four tabs:
SITE, ORGANIZATION, ALPHABETICAL, and STATUS will be displayed on the Web
Part.
SITE: Displays the SharePoint group and users based on the site structure.
ORGANIZATION: This shows the organizational unit structure as an active
directory.
ALPHABETICAL: Shows all SharePoint active users in alphabetical order.
STATUS: Shows SharePoint active users based on their status, online and
offline.
3.2.2 Organizational Unit
In this section, you can specify whether or which Organization Unit will
display under the ORGANIZATION tab.
- Choose an Organizational Unit to display
Enable this option to choose an organizational unit to display under the ORGANIZATION tab.
After choosing this option, click the down arrow to expand an active domain structure and then select an organizational unit.
- Display the Users directory as an Organizational Unit
Specify if the Users container shows under the tab.
3.2.3 Online Presence Settings 
-
Display SharePoint Login Status
User’s that have an active status in SharePoint will show up as “Online”; otherwise, users will show up as “Offline”. Choose this option to show a user’s login status under the SITE, ORGANIZATION, and ALPHABETICAL tabs. -
Display MSN Status
This option is for SharePoint 2007. Show a user’s MSN status on the web part. Choose this option to show a user’s MSN status under the SITE, ORGANIZATION, and ALPHABETICAL tabs. -
Do not display online status
Do not display a user’s login or MSN status under the SITE, ORGANIZATION, and ALPHABETICAL tabs.
3.2.4 Property Settings
In the Property Settings section, you can specify which properties show on the
web part and how to group these properties in tabs.
Manage a Tab
By default, there are 4 tabs to group properties: General, Address, Telephone,
and Organization. You can add, rename or delete these tabs.
To add a tab, click the Add Tab button. A new tab will be added; give your new
tab a name.
To delete a tab, click on the icon on the tab.
To change the order of the tabs, click the tab and then click or move the
tab up or down.
To change the tabs name, click on the name of the tab. When the field changes
to editable, enter a new name and click Apply. 
Manage a Property
In the Property Settings section, Active Directory common properties are
listed by default. You can add more Active Directory attributes on the web
part.
To add a property, expand the tab to which you want to add a property to.
Click Add Properties. If the property is listed, select the checkbox next to
the property name, and click Add. 
If the property is not listed here, click New. Input the property name (LDAP
Name) and display name and then click Add. The property will be added in the
specified tab. 
To remove a property from a tab, click the icon next to the property name.
If you want to restore a property name from the changed one to the initial
one, click the icon next to the property name.
To rename a property, click on the name of the property. When the field
changes to editable, enter a new name and click Apply.
3.3 Tabs
On the Site User Directory Web Part, there are four tabs that show the
SharePoint groups or users’ information. They are the Site, Organization,
Alphabetical and Status tabs.
Follow these steps to specify which tabs are shown on the Web Part:
a. From a page, look for and click the Edit command.
b. On the page, point to the Web Part, click the down arrow, and then click
Edit Web Part.
c. On the Web Part configuration panel, select the checkboxes to the left of
the tab name in the Basic Settings section. 
d. Click Apply.
3.3.1 Site Tab
In the Site tab, all active SharePoint groups, domain groups, and users are
shown based on the site structure. An active SharePoint group, domain group or
user means that the group or user is created or added on SharePoint and
granted permissions.
You can also check the members of a SharePoint group or domain group by
clicking the icon to the left of the group name.
To view a user’s profile, you just need to click the user’s name and the
profile will be shown on the right side of the web part.
3.3.2 Organization Tab
The Organization tab displays the specified organizational unit structure on
the Web Part.
Follow these steps to specify the organizational unit:
a. On the Web Part configuration panel, select the checkbox next to Choose an
Organizational Unit to display in the Organizational Unit
section.
b. Click the down arrow to choose the organizational unit.
c. If you want to display a Users container on the web part, select the
checkbox next to Display the
Users directory as an organizational unit.
d. Click Apply.
3.3.3 Alphabetical Tab
The Alphabetical tab displays the active SharePoint users in alphabetical
order. 
3.3.4 Status Tab
The Status tab displays the SharePoint users based on their status, online or
offline.
User’s that have an active status in SharePoint will show up as “Online”;
otherwise, they will show up as “Offline”.
3.4 Search for a User
To search for a user, enter the user’s name in the search box, and
click.
The result will be shown the Search tab as follows:
3.5 Print a User’s Profile
When you view a user’s profile, you may need to print it.
To print a user’s profile, click the command on the top right corner of the
user’s profile.
The user’s profile is shown in a new browser tab or window as
follows:
The browser’s Print function will appear as follows: . 
Troubleshooting & Support
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: License Management
You can use the Site User Directory without entering any license code for a
period of 30 days from when you first use it.
To use the product after expiration, you will need to purchase a license and
register the product.
Finding License Information
a. On the Site User Directory Web Part, click the trial link and enter the
License Management Center.
b. Click Download License Information, choose a license type and download the
information (Server Code, Farm ID or Site Collection ID).
In order for BoostSolutions to create a license for you, you need to send us
your SharePoint environment identifier (Note: different license types need
different information). A server license needs a server code; a Farm license
needs a farm ID, and a site collection license needs a site collection ID.
c. Send the above information to us
(sales@boostsolutions.com) to generate a
license code.
License Registration
a. When you receive a product license code, enter the License Management
Center page.
b. Click Register on the license page and a Register or Update license window
will open. 
c. Upload the license file or enter the license code and click Register. You
will get confirmation that your license has been validated.
For more details on license management, see BoostSolutions Foundation.
Copyright
Copyright ©2008-2013 BoostSolutions Co., Ltd. All rights reserved.
All materials contained in this publication are protected by copyright and no
part of this publication may be reproduced, modified, displayed, stored in a
retrieval system, or transmitted in any form or by any means, electronic,
mechanical, photocopying, recording or otherwise, without the prior written
consent of BoostSolutions.
Our website: http://www.boostsolutions.com