FOR SHAREPOINT. Quick Start Guide

Transcription

1 Quick Apps v6.2 FOR SHAREPOINT Quick Start Guide

2 2013 Quest Software, Inc. ALL RIGHTS RESERVED. This guide contains proprietary information 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. 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 USA legal@quest.com Refer to our Web site for regional and international office information. TRADEMARKS Quest, Quest Software, and the Quest Software logo 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 Other trademarks and registered trademarks are property of their respective owners. Disclaimer 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. Quick Apps for SharePoint Quick Start Guide Updated - August 2013 Software Version - v6.2

3 CONTENTS About this Guide Introducing Quick Apps for SharePoint Installing Quick Apps for SharePoint Preparing to Install Installing Quick Apps for SharePoint Licensing Deploying Quick Apps for SharePoint in SharePoint Central Administration Activating and Deactivating Site Collection Features Activating and Deactivating Site Features Deploying Quick Apps for SharePoint on SharePoint 2013 using SharePoint 2010 Experience Viewing Log Files Upgrading from a Previous Version Upgrading Custom Skins Configuring Quick Apps for SharePoint Editing Web Configuration File Editing SI Configuration File Refining Availability Uninstalling Quick Apps for SharePoint About Quest Software Contacting Quest Software Contacting Quest Support Third Party Components iii

4 Quick Apps for SharePoint iv

5 Quick Start Guide About this Guide This Quick Start Guide allows you to install and configure Quick Apps for basic operation. For detailed information required to use Quick Apps in a commercial environment, see Quick Apps for SharePoint User Guide. The Quick Start Guide is intended for network administrators, consultants, analysts, and any other IT professionals who use the product. Introducing Quick Apps for SharePoint Quick Apps for SharePoint is deployed as a SharePoint Solution. The benefit of the solution package deployment is the ability to deploy Quick Apps for SharePoint in selected Web Applications using the SharePoint Central Administration site. When a new site collection is created, the Admin or Site Designer can activate the Quick Apps for SharePoint - Web Parts Library to enable the web parts for newly added site collections. This product allows you to: accelerate SharePoint application development using ready-made templates to deliver project management, CRM, and help desk applications that are easily supported, maintained, and extended build applications that you can easily support and maintain extend applications beyond native capabilities and exceed user expectations with the use of tabular forms to save screen space, parent-child relationships to ensure reliable data entry, and hide/show-when logic to govern what data users can see deliver sophisticated applications that are easily upgraded when new versions of SharePoint are released bring data together from all of your enterprise application systems, such as SAP, Oracle, Lotus Domino, without the hassle of manually copying the data into SharePoint display, create, and edit data in your external systems using SI Web Parts. Out of the box, the SI Web Parts support the DAO Provider for: Web Services SQL Server Oracle Domino Server using XML over HTTP Salesforce K2Server (for SharePoint 2010 only) You can write a custom DAO Provider. See the System Integration Developer Guide. 5

6 Quick Apps for SharePoint Installing Quick Apps for SharePoint Before beginning installation of Quick Apps for SharePoint, review this section to ensure required privileges are set and system requirements are met. To upgrade your existing license, go to If you encounter an issue upgrading your license, contact your sales representative to get a new license or send an to license@quest.com. Preparing to Install Before installing Quick Apps for SharePoint, ensure: you meet the minimum system requirements (see Minimum System Requirements on page 6) you uninstall any previous versions of Quick Apps for SharePoint (see Uninstalling Quick Apps for SharePoint on page 16) Minimum System Requirements Quick Apps for SharePoint requires administrator rights on the SharePoint server during installation. If your SQL Server is located on a different computer than the SharePoint server, ensure that you log in as a domain user that has permission to write to the SharePoint configuration and content databases in the SQL Server. Software and hardware requirements for Quick Apps for SharePoint are the same as those for SharePoint. For hardware and software requirements for SharePoint 2010, see For hardware and software requirements for SharePoint 2013, see Although administrative tasks on SharePoint sites are optimized for Internet Explorer 8 or later, Office SharePoint Server also provides rendering support for other browsers that are commonly used. To ensure that you have complete access to all the functionality, we recommend that you use Internet Explorer 8 or later for administrative tasks. Installing Quick Apps for SharePoint Install Quick Apps for SharePoint on one web front end server. Do not install the product on more than one server in the farm. If you want to run the Configuration Editor on multiple servers, you must manually copy and paste the ConfigurationEditor.exe and its related files from the server on which it was installed to your other servers. The installer adds the Quick Apps for SharePoint solution package file to the SharePoint store. The installer installs the following groups: 6

7 Quick Start Guide Quest.DataViewer Quest.Display Quest.ListForm Quest.Navigation Quest.PersistentSelector Quest.SystemIntegration The assemblies for these Web Parts are installed to the Global Assembly Cache (GAC). The GAC is used to store assemblies that will be used by several applications. It is located under: %windir%\assembly, and includes: Quest.Configuration Quest.Core Quest.QuickApps Quest.Resources Quest.Taxonomy Quest.WebParts Quest.WebPartsFeature Additional files installed to the GAC are the Quick Apps for SharePoint support files. They include: WA.Common WA.Core WA.DataViewer WA.Display WA.LayoutPages WA.ListForm WA.MOSS WA.Navigation WA.PersistentSelector WA.Resources WA.SystemIntegration WA.WebPart The following assemblies for Telerik web controls are also installed in the GAC: Telerik.Web.UI Telerik.Web.UI.Skins In some Operating Systems, the User Account Control (UAC) prevents the downloading of the QWP install package. If this is the case, you will need to run Setup.exe instead of launching the.msi directly. In the case that the Setup.exe does not work, run Setup.msi instead. 7

8 Quick Apps for SharePoint To install Quick Apps for SharePoint 1. From the Autorun page, select Quick Apps for SharePoint 2010 V6.2 or Quick Apps for SharePoint 2013 V Click Next, and read and accept the license agreement. 3. Select a target installation folder, and click Next. 4. Click Next again. A dialog box appears telling you how to update your license if you wish to do so. 5. Click Next. 6. Specify options. Restore the status of the Quick Apps for SharePoint - Web Parts Library in your farm. Choose this option if you are upgrading this product from a previous version and have backed up and saved your feature status when you uninstalled the previous version. I do NOT want deploy the solution package. I will use SharePoint Central Administration to do so later. Choose this option if you want to schedule the deployment for a specific time or you want to choose a subset of servers on which to install. If you choose this option, you must use SharePoint Central Administration to deploy the solution package. See Deploying Quick Apps for SharePoint in SharePoint Central Administration on page 10 for more information. Install on every Virtual Server on the local server or server farm. Install ONLY to the specified URL of the virtual server on the local server or server farm. 7. Click Next. The deployment will take a while. The solution package that is used by the installer contains all the files that will be deployed in the SharePoint 14 (for SharePoint 2010) or 15 (for SharePoint 2013) hive folder. These files will be transmitted from the configuration database to your server over the wire. 8. Click Next. 9. Optionally, you can click Launch Configuration Editor button. You can configure your system now or after installation is complete. See Configuring Quick Apps for SharePoint on page 14 for instructions. 10. Click Next. 11. Check to perform an IIS reset, and click Next. 12. Click Finish, then click Close. All Quick Apps for SharePoint site collection features and site features are activated. If not, see Activating and Deactivating Site Collection Features on page 10 and Activating and Deactivating Site Features on page 10 respectively. Licensing To upload a valid license 1. If you are using SharePoint 2010, from the SharePoint 2010 Central Administration page, go to General Application Settings Quick Apps Manage Quick Apps License. OR If you are using SharePoint 2013, open the SharePoint 2013 Central Administration page, go to General Application Settings Quick Apps Manage Quick Apps License. 2. Click Browse to upload the license file (*.asc). 8

9 Quick Start Guide 3. Select a web front-end server from the drop down list and click Import to apply the selected license to the selected server. Do this for each web front-end server. 4. To apply the license, click OK. When you change selection in the server drop down list, the detailed license information applied to the selected server is displayed below it. If no license is provided, you will automatically have a 30-day trial license. Quick Apps for SharePoint will work for 30 days from the installation date as a fully bundled package. After 30 days, Quick Apps for SharePoint will display a "License Expired" message on the SharePoint Central Administration Page under the Manage Quick Apps License Section. Ensuring Quick Apps for SharePoint is Installed To ensure Quick Apps for SharePoint is installed 1. If you are using SharePoint 2010, from the SharePoint 2010 Central Administration page, select General Application Settings Manage Quick Apps for SharePoint 2010 License. OR If you are using SharePoint 2013, from SharePoint 2013 Central Administration, select General Application Settings Manage Quick Apps License. 2. Ensure your license is valid. If not, select a valid license and import it to your Web Front-end server. 3. Click OK. If these steps are not performed, a trial license is applied and will expire after 30 days from the date of installation. 4. Ensure an entry for HTTP handlers is added to your web.config file for the ASP.NET AJAX to function properly. If not, to make the required modification, you can do either one of the following: From the Configuration Editor, open web.config. Ensure there are no missing entries. If entries are missing, select the message, click Fix, and save the file. This will add the required HTTP handlers entry. If you are working from a server where Quick Apps for SharePoint is not installed, the Configuration Editor will not be available. You can copy the ConfigurationEditor.exe and its related files from the server on which it was installed to your server to run the Configuration Editor. OR From SharePoint Central Administration, ensure Quick Apps for SharePoint - Configuration is activated. If not, select Activate for the Quick Apps for SharePoint - Configuration. The required web.config changes happen automatically during feature activation and the changes are removed upon feature deactivation. 9

10 Quick Apps for SharePoint To find Quick Apps for SharePoint - Configuration 1. From SharePoint Central Administration, select Application Management Manage web applications. 2. Select a web application. 3. From the ribbon, click Manage Features. Deploying Quick Apps for SharePoint in SharePoint Central Administration To deploy Quick Apps for SharePoint 1. From SharePoint Central Administration, select System Settings Farm Management Manage farm solutions. 2. Select quick.apps.wsp and click Deploy Solution. 3. Select a time and location to deploy Quick Apps for SharePoint, and click OK. Once deployed all Quick Apps features are automatically activated. If not, you must manually activate them. See Activating and Deactivating Site Collection Features and Activating and Deactivating Site Features for more information. Activating and Deactivating Site Collection Features The Web Parts Library and My First App features must be activated or deactivated at the site collection level. To activate or deactivate a site collection feature 1. Open the SharePoint site where Quick Apps for SharePoint is deployed. 2. If you are using SharePoint 2010, select Site Actions Site Settings Site collection features. OR If you are using SharePoint 2013, from the Settings icon, select Site Settings Site collection features. 3. Find Quick Apps for SharePoint - Web Parts Library or Quick Apps for SharePoint - My First App and click Activate or Deactivate. Activating and Deactivating Site Features After installing Quick Apps for SharePoint, you must activate the site feature. To activate or deactivate a site feature 1. Open the SharePoint site where Quick Apps for SharePoint is deployed. 10

11 Quick Start Guide 2. If you are using SharePoint 2010, select Site Actions Site Settings Manage site features. OR If you are using SharePoint 2013, from the Settings icon, select Site Settings Manage site features. 3. Find Quick Apps for SharePoint - List Templates and click Activate or Deactivate. Deploying Quick Apps for SharePoint on SharePoint 2013 using SharePoint 2010 Experience If you are using SharePoint 2010 Experience on SharePoint 2013, the Quick Apps for SharePoint features are not visible. To make the features visible, you must manually deploy the Quick Apps solution on SharePoint To deploy Quick Apps solution 1. Open the SharePoint 2013 Management Shell, and enter the following cmdlet: Install-SPSolution -Identity Quick.Apps.wsp -GACDeployment -CompatibilityLevel {14,15} -AllWebApplications -confirm:$false force This deploys the solution package to the SharePoint 14 hive and redeploys the package to the SharePoint 15 hive and any common folders. The Install-SPSolution cmdlet begins a timer job. Allow the timer job to finish before executing any other steps. To see the status of the timer job, use the following cmdlet: Get-SPTimerJob?{ $_.Name -like "*solution-deployment*quick.apps*" } 2. If a SharePoint 2010 Experience site collection already exists, use SharePoint 2013 Central Administration to activate all Quick Apps features. For more information, see Activating and Deactivating Site Collection Features on page 10 and Activating and Deactivating Site Features on page 10 respectively. If a SharePoint 2010 Experience site collection does not exist, create one. All Quick Apps features are activated automatically. If not, see Activating and Deactivating Site Collection Features on page 10 and Activating and Deactivating Site Features on page 10. Viewing Log Files If errors occur when using Quick Apps for SharePoint, the details are logged to the SharePoint ULS log. The easiest way to view these details is with a ULS log viewer. If you want to use the Microsoft ULS Log Viewer tool, it is available here. The ULSViewer tool is an unsupported application, and Microsoft does not provide support for this tool. Use this tool at your own risk. Microsoft Product Support Services (PSS) cannot answer questions about the ULSViewer tool. To view log files 1. If not already done so, start SharePoint Tracing Service. 2. From SharePoint Central Administration, select Monitoring Configure diagnostic logging. 11

12 Quick Apps for SharePoint 3. In the Trace Log Levels section, select High. For more information on Diagnostic Logging in SharePoint 2010, see For more information on Diagnostic Logging in SharePoint 2013, see 4. Open your log viewer and filter your view by product (that is Quick Apps for SharePoint). You can view any error messages from Quick Apps for SharePoint only. Upgrading from a Previous Version If you are currently using version 4.x, you need a new license to upgrade to version 6.2. Do not upgrade, if you do not have the new license file for Quick Apps for SharePoint version 6.2. To upgrade your existing license, go to http ://license.quest.com/upgrade. If you encounter an issue upgrading your license using this page, contact your sales representative to get a new license file or send an to license@quest.com. When upgrading to the full version from the Shared version, you need to clear HTML/CSS cache in IE. Otherwise, the Shared version opens when you click the "question mark" icon in the ezedit. To upgrade to version Clear your browser s cache. 2. Uninstall any previous versions of Development Studio for SharePoint, Web Parts for SharePoint, or Quick Apps for SharePoint. See Uninstalling Quick Apps for SharePoint on page Select a folder location if you want to backup your skin layouts and feature status. Click Next. The uninstall on every virtual server on the local server or server farm radio button is selected. 4. If you want to reset IIS, select the Perform iisreset after uninstall check box, and click Next. Click Finish. 5. Install Quick Apps for SharePoint version 6.2. See Installing Quick Apps for SharePoint on page Upload a valid license. See Licensing on page Select Restore the status of the Quick Apps for SharePoint - Web Parts Library in your farm. 8. Launch the Configuration Editor and address any issues shown in the message window of the Web.Config tab. Select the message and click Fix. See Configuring Quick Apps for SharePoint on page Save the file. 12

13 Quick Start Guide Upgrading Custom Skins This product uses web controls, which support the capability of "skinning". SharePoint 2010 uses the.net Framework version 3.5 of the DLL. SharePoint 2013 uses the.net Framework version 4.0 of the DLL. If you are creating custom skins, you can add them to the following folders: For SharePoint 2010: Telerik skins are located at %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012\Skins DevExpress skins are located at %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\DevExpress\9.3\Themes For SharePoint 2013: Telerik skins are located at %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012\Skins DevExpress skins are located at %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\DevExpress\9.3\Themes With these skin files, you can change the appearance of the Web Controls used by the Quick Apps for SharePoint product. If your custom skin files are not compatible with the skin files for the Telerik ASP.NET AJAX Controls version Q3 2012, you must do the following before upgrading. To upgrade custom skins 1. Backup your custom skin files manually. Your custom skins can be under one of the following folders: $TELERIK_FOLDER\Q22007SP1\NET2\RadControls $TELERIK_FOLDER\Q22009\Skins $TELERIK_FOLDER\Q22010\Skins For SharePoint 2010, your folders are located here: C:\Program Files\Common Files\Microsoft Shared\web server extensions\14\template\layouts\questsoftware\telerik For SharePoint 2013, your folders are located here: C:\Program Files\Common Files\Microsoft Shared\web server extensions\15\template\layouts\questsoftware\telerik. 2. After installing Quick Apps for SharePoint version 6.2, add your custom skins manually to $TELERIK_FOLDER\Q32012\Skins. 3. Test your custom skins. If they are not applied properly, you must recreate your custom skin files and make them compatible with the Telerik controls installed in this version. To create a new custom skin for Telerik RadControls, see You can also use the Sample Skin folder in the install directory as an example. For examples on creating custom skin for RadEditor, see For changes and backward compatibility reference from Telerik, see 13

14 Quick Apps for SharePoint Configuring Quick Apps for SharePoint After a successful installation there are a few steps that are essential to ensure that the product will work properly: Editing Web Configuration File Editing SI Configuration File Refining Availability Editing Web Configuration File The modifications can also be done automatically from the Configuration feature accessible from the SharePoint Central Administration page. The required web.config changes happen automatically during feature activation and the changes are removed upon feature deactivation. This method does not support System Integration metadata configuration and other advanced features available in the Configuration Editor tool. For more information on the Configuration Editor, see the Configuration Editor User Guide. To edit the Web Configuration File 1. Click Start All Programs Quest Software Quick Apps for SharePoint Configuration Editor. The Configuration Editor opens. If you are working from a server on which Quick Apps for SharePoint was not installed, the Configuration Editor will not be available. You can copy the ConfigurationEditor.exe and its related files from the server on which it was installed to your server to run the Configuration Editor. 2. Open the web configuration file by following either of the following paths: a) Click File Open File. b) Browse to the SharePoint site web.config file. OR c) Click File Open Web. d) Select the SharePoint site which automatically locates the web.config file. 3. Open the file. 4. If you see any or all of the following messages, select the message, click Fix, then click Yes. "You must enable session state in your web.config" "You must insert <add name="session" type="system.web.sessionstate.sessionstatemodule" /> element in your web.config" "Your web.config file has no QuestSoftware section group defined in <configsections>" "Your web.config file has no <QuestSoftware> section defined" "You must add missing httphandler elements in your web.config" 14

15 Quick Start Guide 5. Save the file. If the product is going to be installed in a server farm or web garden without using sticky session, out-of-process state management will be needed. You must modify the <sessionstate> element in the Web.Config file to use either a StateServer or Microsoft SQL Server. The following is an excerpt if you want to use a StateServer: <configuration> <system.web> <!-- You must change the trust level to Full in order to use out of state session management --> <trust level="full" origin nurl="" /> <sessionstate mode="stateserver" cookieless="false" timeout="60" stateconnectionstring="tcpip= :42424" /> </system.web> </configuration> Note: For more information regarding all of the features of the Configuration Editor, see the Configuration Editor User Guide. Editing SI Configuration File To configure the System Integration Web Parts, refer to the System Integration Configuration File section in the Configuration Editor User Guide. The Configuration Editor will make a backup of the web configuration file or SI configuration file before you save. The backup file name follows the same convention as the stsadm command, that is. web_yyyy_mm_dd_tt.bak. Refining Availability By default, when you install Quick Apps for SharePoint and activate the Quick Apps for SharePoint - Web Parts Library, Web Parts are added to the web part gallery making it available for site designers to use. As the Farm Administrator, you can further refine which web parts will be available by using the SharePoint Central Administration pages. You can manage web parts by: Web Application Single Site Collection/Multiple Site Collections If you make a change by any of these links, the change is made essentially to the site collection (for Web Application, all site collections within the web are affected). The last change made will overwrite the previous settings. 15

16 Quick Apps for SharePoint Web Application This allows you to control what web parts become available to the selected SharePoint Web Application. If you clear all the web parts check boxes, no web parts will be available to the specified SharePoint Web Application and all its site collections and subsites. Even though the feature will still be displayed in the Site Feature list, activating it will not bring these web parts available to the site designer. To manage web parts by Web Application From SharePoint Central Administration, click General Application Settings Manage Web Parts by Web application. Single Site Collection/Multiple Site Collections These allow you to manage web parts at the Web Application/Site Collection level. You will need to pick the SharePoint Web Application first, and then pick a site collection. The display will show you what the current available web parts are based on your license type and bundle. The checked web parts are the ones available to the site designer. Managing Web Parts by single site collection will display currently available web parts when you display the page. This is because at the Web Application level or multiple site collections level, each site collection may have different available and active web parts. To manage Web Parts by Single Site Collection or Multiple Site Collections From SharePoint Central Administration, click General Application Settings Manage Web Parts by Site application. OR From SharePoint Central Administration, click General Application Settings Manage Web Parts by multiple Site application. Uninstalling Quick Apps for SharePoint To uninstall Quick Apps for SharePoint 1. Use the Control Panel to uninstall Quick Apps for SharePoint. 2. Click Yes when asked if you are sure you want to uninstall Quick Apps for SharePoint. 3. If you are upgrading and want to backup your skins and features, enter or browse to a folder location, and click Next. If you do not want to backup your skins and features, just click Next. The uninstall on every virtual server on the local server or server farm radio button is selected. 4. If you want to reset IIS, select the Perform iisreset after uninstall check box, and click Next. 5. Click Finish. 16

17 Quick Start Guide About Quest Software 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 Contacting Quest Software Mail Web site Quest Software, Inc. World Headquarters 5 Polaris Way Aliso Viejo, CA USA Please 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. Visit our Support Portal at From our Support Portal, you can do the following: Retrieve thousands of solutions from our 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 Third Party Components Quick Apps for SharePoint contains some third party components (listed below). Copies of their licenses may be found on our website at COMPONENT async.js n/a LICENSE OR ACKNOWLEDGEMENT Caolan McMahon 17