Quest Solutions Manager for SharePoint 1.2 - User Guide

Transcription

Quest® Solutions Manager 1.2
for SharePoint
User Guide
© 2012 Quest Software, Inc.
ALL RIGHTS RESERVED.
This guide contains proprietary information, which is protected by copyright. The software
described in this guide is furnished under a software license or nondisclosure agreement. This
software may be used or copied only in accordance with the terms of the applicable agreement.
No part of this guide may be reproduced or transmitted in any form or by any means, electronic
or mechanical, including photocopying and recording, for any purpose other than the
purchaser's personal use without the written permission of Quest Software, Inc.
The information in this document is provided in connection with Quest products. No license,
express or implied, by estoppel or otherwise, to any intellectual property right is granted by
this document or in connection with the sale of Quest products. EXCEPT AS SET FORTH IN
QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS
PRODUCT, QUEST ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS,
IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FOR ANY
DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES
(INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS
INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO
USE THIS DOCUMENT, EVEN IF QUEST HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES. Quest makes no representations or warranties with respect to the accuracy or
completeness of the contents of this document and reserves the right to make changes to
specifications and product descriptions at any time without notice. Quest does not make any
commitment to update the information contained in this document.
If you have any questions regarding your potential use of this material, contact:
Quest Software World Headquarters
LEGAL Dept
5 Polaris Way
Aliso Viejo, CA 92656
e-mail: [email protected]
Refer to our Web site (www.quest.com) for regional and international office information.
TRADEMARKS
Quest, Quest Software, the Quest Software logo, Aelita, AppAssure, Benchmark Factory,
Big Brother, DataFactory, DeployDirector, ERDisk, Foglight, Funnel Web, I/Watch,
Imceda, InLook, IntelliProfile, Internet Weather Report, InTrust, IT Dad, JClass, Jint,
JProbe, LeccoTech, LiteSpeed, LiveReorg, NBSpool, NetBase, Npulse, PerformaSure,
PL/Vision, Quest Central, RAPS, SharePlex, Sitraka, SmartAlarm, Spotlight, SQL
LiteSpeed, SQL Navigator, SQLab, SQL Watch, Stat, Stat!, StealthCollect, Tag and
Follow, Toad, T.O.A.D., Vintela, Virtual DBA, Xaffire, and XRT are trademarks and
registered trademarks of Quest Software, Inc in the United States of America and other
countries. For a complete list of Quest Software’s trademarks, please see
http://www.quest.com/legal/trademark-information.aspx. Other trademarks and
registered trademarks used in this guide are property of their respective owners.
Quest Solutions Manager for SharePoint
Updated – November, 2012
Software version – 1.2
CONTENTS
ABOUT THIS GUIDE ..................................................................... 3 OVERVIEW ........................................................................ 4 CONVENTIONS .............................................................. 4 ABOUT QUEST SOFTWARE, INC. ................................................ 5 CONTACTING QUEST SOFTWARE.......................................... 5 CONTACTING QUEST SUPPORT ............................................ 5 INTRODUCTION .......................................................................... 7 ABOUT SOLUTIONS MANAGER FOR SHAREPOINT ............................. 8 DEPLOYING SOLUTIONS MANAGER FOR SHAREPOINT........................ 11 PRODUCT ARCHITECTURE .......................................................12 SYSTEM REQUIREMENTS ........................................................13 REQUIRED PERMISSIONS .......................................................13 INSTALLATION PROCEDURE.....................................................14 INSTALLING SOLUTIONS MANAGER CONSOLE .......................... 14 INSTALLING SOLUTIONS MANAGER EXTENSION WEB SERVICE ...... 16 UPGRADING SOLUTIONS MANAGER ...........................................17 WORKING WITH SOLUTIONS MANAGER FOR SHAREPOINT .................. 19 CONNECTING TO FARMS ........................................................20 WORKING WITH SOLUTIONS LIBRARY.........................................22 IMPORTING SOLUTIONS TO SOLUTIONS LIBRARY ...................... 22 SOLUTIONS LIBRARY DESCRIPTION .....................................23 USING SOLUTION REPORTS ....................................................25 FARM SOLUTION REPORT .................................................25 SOLUTION COMPARISON MATRIX ........................................28 MANAGING SOLUTIONS .........................................................30 DEPLOYING SOLUTION ....................................................30 UPGRADING SOLUTION ...................................................31 RETRACTING SOLUTION ..................................................33 VIEWING SOLUTION STRUCTURE ........................................34 VIEWING JOBS .............................................................36 i
SAVE LOGS .................................................................37 ii
About This Guide
• Overview
• Conventions
• About Quest Software
• Contacting Quest Software
• Contacting Quest Support
3
Overview
This document has been prepared to assist you in becoming familiar with
Solutions Manager for SharePoint. It explains how to install and use Solutions
Manager for SharePoint and is intended for network administrators,
consultants, analysts, and any other IT professionals using the product.
Conventions
In order to help you get the most out of this guide, we have used specific
formatting conventions. These conventions apply to procedures, icons,
keystrokes and cross-references.
ELEMENT
CONVENTION
Select
This word refers to actions such as choosing or highlighting
various interface elements, such as files and radio buttons.
Bolded text
Interface elements that appear in Quest products, such as
menus and commands.
Italic text
Used for comments.
Bold Italic text
Introduces a series of procedures.
Blue text
Indicates a cross-reference. When viewed in Adobe® Acrobat®,
this format can be used as a hyperlink.
Used to highlight additional information pertinent to the process
being described.
Used to provide Best Practice information. A best practice details
the recommended course of action for the best result.
Used to highlight processes that should be performed with care.
+
A plus sign between two keystrokes means that you must press
them at the same time.
|
A pipe sign between elements means that you must select the
elements in that particular sequence.
4
About This Guide
About Quest Software, Inc.
Established in 1987, Quest Software (Nasdaq: QSFT) provides simple and
innovative IT management solutions that enable more than 100,000 global
customers to save time and money across physical and virtual environments.
Quest products solve complex IT challenges ranging from database
management, data protection, identity and access management, monitoring,
user workspace management to Windows management. For more information,
visit www.quest.com.
Contacting Quest Software
E-mail:
[email protected]
Mail:
Quest Software, Inc.
World Headquarters
5 Polaris Way
Aliso Viejo, CA 92656
USA
Web site:
www.quest.com
Refer to our Web site for regional and international office information.
Contacting Quest Support
Quest Support is available to customers who have a trial version of a Quest
product or who have purchased a Quest product and have a valid maintenance
contract. Quest Support provides unlimited 24x7 access to our Support Portal
at www.quest.com/support.
From Support Portal, you can do the following:
•
Retrieve thousands of solutions from our online Knowledge Base
•
Download the latest releases and service packs
•
Create, update and review Support cases
View the Global Support Guide for a detailed explanation of support programs,
online services, contact information, policies and procedures.
The guide is available at: www.quest.com/support.
5
1
Introduction
• About Solutions Manager for SharePoint
7
About Solutions Manager for SharePoint
SharePoint solutions have become the standard way to package and deploy
customizations such as features, web parts and custom code on the
SharePoint platform. SharePoint provides a variety of command line and
Central Administration tools to install and manage solutions, which work well
for a single SharePoint farm with few customizations. However, managing
solutions across multiple SharePoint environments such as development,
testing and production using native tools can quickly become a challenge due
to lack of version control, centralized reporting and remote automation.
The Solutions Manager within Quest Deployment Manager for SharePoint
simplifies solution management in multi-tiered SharePoint 2013, 2010 and
2007 environments. With Solutions Manager administrators can:
8
•
Maintain a central version-enabled repository for managed
SharePoint solutions (Solutions Library);
•
Understand which farms/web applications each managed solution is
deployed to;
•
List solutions installed on each farm or on multiple farms at once;
•
Identify solutions that were not approved for deployment;
•
Detect farms with old or unknown versions of managed solutions;
•
Deploy, upgrade and retract solution packages remotely from a
single application;
Introduction
•
Execute tasks immediately or schedule them to run at a later time;
•
Keep a historical trail of all solution deployment activities.
9
2
Deploying Solutions
Manager for SharePoint
• Product Architecture
• System Requirements
• Required Permissions
• Installation Procedure
• Upgrading Solutions Manager
11
Product Architecture
Solutions Manager for SharePoint consists of the following components:
1.
Console – a desktop application that you will use to manage
solutions on multiple SharePoint 2013/2010/2007 farms. 2.
Extension Web Service – a custom web service that needs to be
installed on SharePoint 2013/2010/2007 farms to report and
manage farm solutions using the Solutions Manager Console.
The Solutions Manager Extension Web Service is deployed as a SharePoint
solution (WSP) itself and runs as part of the managed SharePoint farm.
The Solutions Manager Console communicates with extension web services on
SharePoint 2013/2010/2007 farms over HTTP/S.
12
Deploying Solutions Manager for SharePoint
System Requirements
The computer where you install the Solutions Manager Console must meet the
following system requirements:
•
Windows XP or higher, Windows Server 2008, Windows Server 2012
•
Microsoft .Net Framework 3.5
Solutions Manager supports the following SharePoint versions:
•
Microsoft SharePoint Server 2007
•
Windows SharePoint Services 3.0
•
•
Microsoft SharePoint Foundation 2010
•
•
Microsoft SharePoint Foundation 2013
Required Permissions
Solutions Manager requires the following permissions on the managed
SharePoint 2013/2010/2007 farms:
1.
Member of the Local Administrators group.
2.
Member of the Farm Administrators group.
By default, Solutions Manager connects to SharePoint farms as the currently
logged user. If the current user does not have the required permissions on a
SharePoint farm, the Farm Connection Wizard displays a warning and marks
the farm in the list. You can enter a different user for the farm, which is
cached by Solutions Manager until the application is closed.
13
Installation Procedure
To install Solutions Manager for SharePoint, install the Solutions Manager
Console first. Then deploy the Solutions Manager Extension Web Service to
your SharePoint 2013/2010/2007 farm(s) to be managed.
Solutions Manager is a part of Quest Deployment Manager for SharePoint
and requires that Deployment Manager is installed on the computer. If
Deployment Manager is not present, not activated or expired, you will get
an error message when you start the Solutions Manager Console and the
application will close.
Installing Solutions Manager Console
To install Solutions Manager for SharePoint, run Quest.SMSP.Console.msi
file from the /Solutions Manager for SharePoint folder on the installation
package and follow the Quest Solutions Manager for SharePoint Setup wizard
steps:
14
1.
On the Welcome screen, click Next.
2.
On the End-User License Agreement step, select the I accept
the terms in the License Agreement check box and click Next.
3.
4.
On the Select Features screen, either accept the default
installation path or click Browse to specify an alternate installation
folder. Click Install:
Once installation is complete, click Finish to exit the wizard.
If the Run Solutions Manager when setup exits check box was
selected, the tool will be started immediately after you exit the
wizard.
At the first start of the tool, you will be prompted to add a SharePoint farm.
If the Extension Web Service is not installed on the farm, you will get the
corresponding message when trying to add the farm.
15
Installing Solutions Manager Extension Web Service
To install the Extension Web Service on a SharePoint 2013/2010/2007 farm,
copy the Extension Service folder for your SharePoint version from the
Solutions Manager for SharePoint installation folder to a member server of the
farm (e.g. web front end server), run setup.exe and follow the steps of the
wizard:
16
1.
On the Welcome screen, click Next.
2.
On the System Check screen, wait while the system checks are
completed and then click Next.
3.
On the End-User License Agreement screen, select the I accept
the terms in the License Agreement check box and click Next.
4.
On the Farm Deployment Targets screen, select one or more web
applications you want to install the service on and click Next.
5.
Once installation is complete, click Close to exit the wizard.
Upgrading Solutions Manager
To upgrade Solutions Manager to version 1.2, perform the following:
1.
Uninstall the previous version of Solutions Manager for SharePoint.
2.
Install the new Solutions Manager Console by running the Solutions
Manager setup.
3.
Update the Solutions Manager Extension Web Service.
You can update the Solutions Manager Extension Service directly from the
tool interface. When selecting a farm, you will see a warning message
window prompting you to update the agent.
You can also update Solutions Manager Extension Web Service manually
using the new Quest.SM.Agent.wsp.
17
3
Working with Solutions
Manager for SharePoint
• Connecting to Farms
• Working with Solutions Library
• Using Solution Reports
• Managing Solutions
19
Connecting to Farms
In order to manage farm solutions on SharePoint farms, you need to connect
the farms to the Solutions Manager Console.
Make sure the Extension Service is installed on the farm before adding it to
the Solutions Manager console. If the service is not installed, you will get an
error when trying to add the farm.
To start the tool, select: Programs | Quest Software | Solutions Manager
for SharePoint.
At the first start of Solutions Manager, you will be prompted to add a
SharePoint farm:
Then, you can add farms by clicking Connect on the ribbon.
All added farms are displayed under Solutions Library in the left pane of the
tool.
If you do not have the required permissions on the SharePoint farm you add,
the Connect to SharePoint Farm Wizard will display a warning message and
mark the farm in the list with the
icon. In this case, you can specify an
20
Working with Solutions Manager for SharePoint
alternative user account for the farm. If the user credentials are not saved in
Stored Credentials, they are cached by Solutions Manager until the application
is closed.
To specify an alternative user account:
1.
Right-click the required farm and select Enter credentials from
the shortcut menu. The Windows Security dialog appears:
2.
Specify the name in the domain\user format and password.
3.
Either leave the Remember my credentials check box cleared or
select it to save your credentials.
4.
Click OK.
21
Working with Solutions Library
Solutions Library is a repository for your managed solutions packages. Once a
solution package is imported into Solutions Library, you can use Solutions
Manager to deploy the package to SharePoint farms, maintain versions of the
solution, and get reports on where the solution is deployed in the environment
and more.
Importing Solutions to Solutions Library
Importing from Disk
To import a solution package to Solutions Library, click Disk on the ribbon.
Select the solutions to import (use multi-select to import multiple solution
packages), and click Open:
If you import a different version of a solution that is already in Solutions
Library, Solutions Manager will add it as a new version of the managed
solution package (e.g. 2.0). Solutions Manager uses the latest version of a
solution when you deploy or upgrade it in the application.
22
Importing from SharePoint
In addition to importing solution packages from disk, you can now import
WSPs deployed on SharePoint farms directly into Solutions Library. To do that,
select unmanaged solutions from a farm, and then click either SharePoint on
the ribbon or Download from the shortcut menu.
Solutions Library Description
For each managed solution in Solutions Library, the following information is
displayed in the list:
•
Name - the solution name
•
Import Date - the date and time when the solution was imported
to the library
•
Note – user-provided notes about the solution. To enter a note,
click inside the column.
You can click on a solution to see more detailed information:
•
The solution unique ID
•
Farms hosting the solution
•
Versions of the solution package
23
Right-clicking the solution opens the shortcut menu, where you can select to
deploy, upgrade, retract or delete the solution from the library. See the
Managing Solutions section below for more information.
24
Using Solution Reports
Solutions Manager for SharePoint provides the following reports:
•
Farm Solution Report
•
Solution Comparison Matrix
Farm Solution Report
Select the SharePoint farm in the left pane to display a list of installed
solutions on the farm.
The list includes both managed and unmanaged farm solutions:
•
Managed are the solutions imported into the Solutions Library.
Management actions and version reporting are only available for
managed solutions.
•
Unmanaged are the solutions not in the Solutions Library.
Unmanaged solutions are grayed.
25
For each solution on the farm, the following information is displayed:
•
Managed – if the solution is managed, it is marked with the
icon.
•
Name - the solution name
•
Status - the solutions status (Deployed/Not Deployed)
•
Version - the solution version (for managed solutions only)
•
Modified on - the date and time when the solution was last
modified
•
Note - user-provided additional information.
When clicking a solution in the list, you can view the solution GUID and all web
applications the solution is deployed to.
26
You can deploy, upgrade or retract managed solutions right from the list.
Available actions depend on the solution status:
You can also download unmanaged solutions to Solutions Library from the list.
To do that, select unmanaged solutions, and then click either SharePoint on
the ribbon or Download from the shortcut menu.
27
Solution Comparison Matrix
Solutions Manager for SharePoint provides the Farms Solutions Comparison
matrix, which allows you to understand the deployment status of SharePoint
solutions (both managed and unmanaged) across multiple SharePoint farms.
This report will help you quickly identify configuration inconsistencies (if any)
in your SharePoint environment.
To view the report, click the Compare icon on the ribbon, select the farms you
want to compare, and then click Compare:
The report displays all solutions (both managed and unmanaged) within the
selected farms. Unmanaged solutions are grayed.
If the solution is deployed to a farm, the
if the solution is unmanaged).
If the solution is not deployed to a farm, the
gray if the solution is unmanaged).
icon is displayed (the icon is gray
icon is displayed (the icon is
If the version of the deployed solution differs from the version in Solutions
Library, the
icon and the number of the current deployed version are
displayed.
28
You can deploy, upgrade, retract managed solutions or download unmanaged
solutions to Solutions Library from the report. To do that, navigate to the icon
next to the required solution, and then select the required action from the
drop-down menu.
To export the report to a PDF file, click the Export button.
29
Managing Solutions
You can deploy, upgrade or retract managed solutions on connected
SharePoint farms by running a corresponding task in Solutions Manager.
Deploying Solution
To deploy a solution, perform the following steps:
1.
Select the solution from the list, and click Deploy on the ribbon.
Alternatively, you can right-click the solution and select Deploy
from the shortcut menu.
The Deployment Job wizard starts:
2.
Select the target farm for the deployed solution.
3.
Select either of the following:
•
•
30
Deploy globally - the solution will be deployed to all web
applications within the target farm
Deploy to specific web applications - the solution will be
deployed only to the selected web applications within the target
farm.
Some solutions can be deployed only to specific web applications or globally
to a farm.
4.
By default, the job is started immediately after the wizard
completes. If you want to schedule the job to start later, expand
the Scheduling options and select the required date and time.
5.
Click Deploy.
If the solution you deploy has multiple versions in Solutions Library, the
version with the highest version number will be deployed.
After a new job is created, it appears on the Jobs tab page in the right pane of
the tool. For more information, please refer to the Viewing Jobs section below.
Upgrading Solution
To upgrade a solution, perform the following steps:
1.
Select the solution from the list, and click Upgrade on the ribbon.
Alternatively, you can right-click the solution and select Upgrade
The Upgrade option is available only in Solutions Library.
31
The Upgrading Job wizard starts:
2.
Select the target farm for the upgraded solution.
3.
4.
Click Upgrade.
If the solution you upgrade has multiple versions in Solutions Library, the
version with the highest version number will be used to upgrade.
32
Retracting Solution
To retract a solution, perform the following steps:
1.
Select the solution from the list, and click Retract on the ribbon.
Alternatively, you can right-click the solution and select Retract
The Retracting Job wizard starts:
2.
Select the target farm for the retracted solution.
3.
Select either of the following:
•
•
•
4.
Retract globally - the solution will be retracted from all web
applications within the farm
Retract and remove - the solution will be retracted from the
farm and removed from the Solutions library.
Retract from specific web applications - the solution will be
retracted only from the selected web applications within the farm
33
5.
Click Retract.
Viewing Solution Structure
Solution Explorer allows you to get an insight into solution packages. It
reveals both logical and file contents of a WSP package to help you
understand what exactly each solution installs when deployed.
To access Solution Explorer, double-click a solution. Alternatively, you can
select the required solution, and then click Explore on the ribbon.
The Solution explore window contains two tabs: Content View and File
View.
The Content View tab presents the logical structure of the solution. Selecting
any item from the tree in the left pane displays the following information in the
right pane:
34
•
the item title
•
the item location
•
the item ID
•
the item description
•
the item version
•
the item scope
•
whether the item is hidden or not
The File View tab displays the file structure of the solution. Selecting any file
from the tree in the left pane displays its content in the right pane:
35
Viewing Jobs
the tool. The job list is automatically filtered depending on what is selected in
the left-hand side pane. When a specific farm is selected, you will see jobs
targeting this farm only. When you are in the Solutions Library, all jobs are
shown in the list.
While on this page, you can view the job details and its history.
36
The following information for each job is displayed:
•
Start time - the time when the job was started. If the job is not
started, it is marked with the
icon.
•
Action - the action taken on the solution
•
Solution - the solution name
•
Farm - the farm hosting the solution
•
State - the job status.
For each job you can view the history of its execution at the bottom of the
pane.
Save Logs
If any issues occurred when deploying, upgrading or retracting solutions, you
can quickly and easily save all logs to one file, which you can then send to
support, using the Save Logs option:
37

Quest Solutions Manager for SharePoint 1.2 - User Guide

Transcription

Similar documents

Granjas Sharepoint Server para Escenarios Empresariales

AppRiver guards your inbox against unwanted

john fluevog shoes - Page One Publishing

Critical_Success_Fac..

Adventure Quest

Financial Strength - Indiana Farm Bureau Insurance

Configuring Windows® SharePoint Services™ for PEM v1.0 to Work

SharePoint Troubleshooting

Pro Farm Manager is a virtual simulation/management oriented game

Health In Your Hands

25, 26,27,28 September-2015 VOC Ground, Erode-India.

Farm Boy keeps it close to home with 40+ local suppliers New

January

Warrior Adventure Quest

Using Word, Excel, and Excel Services with SharePoint 2007

DocAve 6 Administrator User Guide

Bid 10 - State of West Virginia

Table of Contents Table of Contents

DocAve® 6 EMC Documentum Migrator

Microsoft SharePoint 2013 Designing and Architecting Solutions