Quick Apps For SharePoint 6.4 User Guide Appsfor Share Point_6.6_User Point 6.6
User Manual: QuickAppsforSharePoint_6.6_UserGuide
Open the PDF directly: View PDF 
.
Page Count: 403
| Download | |
| Open PDF In Browser | View PDF |
AgreeYa QuickApps for SharePoint® 6.6 User Guide © 2016 AgreeYa Solutions, 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 AgreeYa Inc. The information in this document is provided in connection with AgreeYa 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 AgreeYa products. EXCEPT AS SET FORTH IN THE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, AGREEYA 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 AGREEYA 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 AGREEYA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. AgreeYa 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. AgreeYa 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: AgreeYa Solutions, Inc. 605 Coolidge Dr. Folsom, CA 95630 USA Refer to our web site (www.agreeya.com) for regional and international office information. Trademarks AgreeYa, the AgreeYa logo are trademarks of AgreeYa Solutions, Inc. and/or its affiliates. Microsoft, Internet Explorer, SharePoint, Windows, Windows Server, SQL Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Salesforce and Salesforce.com are trademarks of Salesforce.com. K2, K2BlackPearl are registered trademarks of Sourcecode Technology Holdings Inc. in the United States and/or other countries. Domino is a registered trademark of International Business Machines Corporation. Telerik is a registered trademark of Telerik AD in the United States and either a registered trademark or trademark of Telerik AD in other countries. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Nintex and its product logos are registered trademarks owned by Nintex USA LLC and Nintex Pty Ltd. SAP is the trademark(s) or registered trademark(s) of SAP AG in Germany and in several other countries. Google and Google Chrome is a trademark or registered trademark of Google Inc. Netscape Navigator is a registered trademark of AOL Inc. Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. AgreeYa disclaims any proprietary interest in the marks and names of others. Legend CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed. WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death. IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information. AgreeYa QuickApps for SharePoint User Guide Updated - January 2016 Software Version - 6.6 Contents Introducing QuickApps for SharePoint® . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 About QuickApps for SharePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Features of QuickApps for SharePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 qCalendarView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 qCalendar Pages . . . . Content Page . . . Behavior Page . . . Appearance Page . Advanced Page . . .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... ... ... ... ... ... . .10 . .11 . .22 . .28 . .32 qCaptionDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34 qCaptionDisplay Pages Content Page . . . Appearance Page . Advanced Page . . .... .... .... .... ... ... ... ... .... .... .... .... .... .... .... .... ... ... ... ... .... .... .... .... ... ... ... ... .... .... .... .... .... .... .... .... ... ... ... ... .... .... .... .... ... ... ... ... . .35 . .35 . .35 . .37 qCascadingMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39 qCascadingMenu Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41 Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42 Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 qCascadingMenu Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45 Configuring qCascadingMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45 qChartView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47 qChartView Pages . . . Content Page . . . Behavior Page . . . Appearance Page . Advanced Page . . .... .... .... .... .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85 qChartView Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87 Configuring qChartView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87 Formatting Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87 Setting Number Formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90 Setting Number Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94 Using MultiSeriesStackedColumn2D and MultiSeriesStackedColumn2DLineDual YAxis Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97 AgreeYa QuickApps for SharePoint 6.6 User Guide 3 qDiscussionView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99 qDiscussionView Pages Content Page . . . Behavior Page . . . Appearance Page . Advanced Page . . .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... ... ... ... ... ... . .99 . .99 . 109 . 109 . 112 qDiscussionView Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Configuring qDiscussionView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Sorting the qDiscussionView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Understanding the Complex Category Index List . . . . . . . . . . . . . . . . . . . . . . . . 115 Configuring qDiscussionView with the Complex Category Index List . . . . . . . . . . . . 116 qDynamicLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 qDynamicLayout Pages Content Page . . . Appearance Page . Advanced Page . . .... .... .... .... ... ... ... ... .... .... .... .... .... .... .... .... ... ... ... ... . . . . . . . . . . . . . . . . . . . . . . . . . . 119 . . . . . . . . . . . . . . . . . . . . . . . . . . 119 . . . . . . . . . . . . . . . . . . . . . . . . . . 121 . . . . . . . . . . . . . . . . . . . . . . . . . . 122 qDynamicLayout Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 Configuring qDynamicLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 qExcelViewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 qExcelViewer Pages . . Content Page . . . Appearance Page . Advanced Page . . .... .... .... .... ... ... ... ... .... .... .... .... ....... ....... ....... ....... ....... ....... ....... ....... .... .... .... .... .... .... .... .... ... ... ... ... .... .... .... .... ... ... ... ... . 124 . 124 . 125 . 127 qExcelViewer Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 Configuring qExcelViewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 qHelpLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 qHelpLink Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 qItemDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 qItemDisplay Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 qListForm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140 AgreeYa QuickApps for SharePoint 6.6 User Guide 4 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 User Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 qListForm Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 qListForm Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 Adding items to a list in SharePoint using qListForm . . . . . . . . . . . . . . . . . . . . . . 182 Creating and Editing Collapsible Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 qListView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Configuration Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 qListView Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 qListView Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 Configuring Basic Settings using the Configuration Wizard . . . . . . . . . . . . . . . . . . 217 Configuring a Basic ListView with Filters using ezEdit . . . . . . . . . . . . . . . . . . . . . 217 qManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 qManagement Pages . Content Page . . . Appearance Page . Advanced Page . . .... .... .... .... ... ... ... ... .... .... .... .... .... .... .... .... ... ... ... ... .... .... .... .... ... ... ... ... .... .... .... .... .... .... .... .... ... ... ... ... .... .... .... .... ... ... ... ... . 219 . 219 . 220 . 222 qManagement Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Configuring qManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Exploring Web Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 Searching Web Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 Setting New Property Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 qMediaView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .226 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 qMediaView Pages . . . Content Page . . . Appearance Page . Advanced Page . . .... .... .... .... ... ... ... ... .... .... .... .... .... .... .... .... ... ... ... ... .... .... .... .... ... ... ... ... .... .... .... .... .... .... .... .... ... ... ... ... .... .... .... .... ... ... ... ... . 226 . 227 . 230 . 234 qMultiSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .235 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 qMultiSelector Pages . Content Page . . . Appearance Page . Advanced Page . . .... .... .... .... ... ... ... ... .... .... .... .... .... .... .... .... ... ... ... ... .... .... .... .... ... ... ... ... .... .... .... .... .... .... .... .... ... ... ... ... .... .... .... .... ... ... ... ... AgreeYa QuickApps for SharePoint 6.6 User Guide . 235 . 235 . 238 . 239 5 qPageRedirector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 qPageRedirector Pages . . . . . . . Content Page . . . . . . . . . . Appearance Page . . . . . . . . Advanced Page . . . . . . . . . .... .... .... .... .... .... .... .... ... ... ... ... .... .... .... .... ... ... ... ... .... .... .... .... .... .... .... .... ... ... ... ... .... .... .... .... ... ... ... ... . 242 . 242 . 242 . 244 qPanelMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .246 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 qPanelMenu Pages . . . Content Page . . . Behavior Page . . . Appearance Page . Advanced Page . . .... .... .... .... .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 qPanelMenu Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 Configuring qPanelMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 qSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .254 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 qSelector Pages . . . . Content Page . . . Appearance Page . Advanced Page . . .... .... .... .... ... ... ... ... .... .... .... .... .... .... .... .... ... ... ... ... . . . . . . . . . . . . . . . . . . . . . . . . . . 255 . . . . . . . . . . . . . . . . . . . . . . . . . . 255 . . . . . . . . . . . . . . . . . . . . . . . . . . 257 . . . . . . . . . . . . . . . . . . . . . . . . . . 259 qSIChartView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .261 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 qSIChartView Pages . . Content Page . . . Behavior Page . . . Appearance Page . Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305 qSIChartView Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307 Configuring qSIChartView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307 Formatting Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307 Setting Number Formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309 Setting Number Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314 Using MultiSeriesStackedColumn2D and MultiSeriesStackedColumn2DLineDual YAxis Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317 qSIListForm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .318 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318 qSIListForm Pages . . . Content Page . . . Behavior Page . . . Appearance Page . Advanced Page . . .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... ... ... ... ... ... . 319 . 319 . 327 . 336 . 338 qSIListView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .340 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340 AgreeYa QuickApps for SharePoint 6.6 User Guide 6 qSIListView Pages . . . Content Page . . . Behavior Page . . . Appearance Page . Advanced Page . . .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... .... .... .... .... .... ... ... ... ... ... .... .... .... .... .... ... ... ... ... ... . 341 . 341 . 352 . 356 . 360 qSISelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .363 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363 qSISelector Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364 Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364 Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370 Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370 Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 Custom Action Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .374 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374 Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ICustomActionEx Interface . . . . . . . . . . . . . . . . . . . ICustomAction Interface (Deprecated) . . . . . . . . . . . . Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Custom Action Class . . . . . . . . . . . . . . . . . Deploying Custom Action Class . . . . . . . . . . . . . . . . . .... .... .... .... .... .... .... .... .... .... .... .... ... ... ... ... ... ... .... .... .... .... .... .... ... ... ... ... ... ... . 374 . 374 . 380 . 383 . 384 . 384 ezLocalizer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .385 Creating a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385 Opening an Existing Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386 Finding Values in a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386 My First App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .387 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387 Using My First App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387 Application Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .388 Installing the Application Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388 Adding the CRM template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388 Adding the Help Desk Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389 Adding the Project Dashboard Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390 Adding the Project Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390 Sample Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .392 Contacting AgreeYa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403 Technical support resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403 AgreeYa QuickApps for SharePoint 6.6 User Guide 7 Contents Introducing QuickApps for SharePoint® • About this Guide • About QuickApps for SharePoint • Features of QuickApps for SharePoint About this Guide This guide describes how to use the web parts component of QuickApps for SharePoint. It contains the information required to perform general tasks and is intended for network administrators, consultants, analysts, and any other IT professionals using QuickApps for SharePoint. Before using this guide, see the QuickApps for SharePoint Quick Start Guide for installing and activating QuickApps for SharePoint. The same document also introduces the basic operation of QuickApps for SharePoint, using a simple configuration to externalize documents in a sample SharePoint environment. About QuickApps for SharePoint QuickApps for SharePoint enables you to build applications that can be easily supported, maintained, and upgraded to ensure their long-term impact and return on investment. Because web parts automates simple or mundane tasks, you can free up SharePoint development resources and satisfy business requirements without costly custom coding. Features of QuickApps for SharePoint QuickApps for SharePoint is deployed as a SharePoint Solution. The benefit of the solution package deployment is the ability to deploy web parts in selected Web Applications using the SharePoint Central Administration site. It also provides the flexibility to turn on/off QuickApps for SharePoint as a site feature. When a new site or site collection is created, the Admin or Site Designer can activate the QuickApps for SharePoint - Web Parts Library to enable the web parts for newly added site collections. This product allows you to: • use point-and-click configuration instead of custom code to customize SharePoint solutions up to 80 percent faster • meet your most complex business requirements, from interface enhancements to complete solutions, without needing custom development training or experience • use My First App to configure compelling SharePoint list views and charts in a few simple mouse clicks • quickly build better SharePoint solutions with easy-to-use web parts featuring built-in video training and tutorials. Discover best practices and tips and tricks from SharePoint peers and AgreeYa experts in the collaborative QuickApps community at www.SharePointforAll.com. • maximize your SharePoint investment by accelerating SharePoint development cycles in order to save resources, time and money on costly enhancements • empower end users to make their own customizations without risk to the environment, freeing expensive development resources for more value-added projects AgreeYa QuickApps for SharePoint 6.6 User Guide 8 • accelerate SharePoint application development cycles using ready-made templates to deliver help desk, project management and CRM applications that are easily supported, maintained, and extended • build applications that you can easily maintain and support with no custom coding • exceed user expectations and extend applications beyond what’s natively possible with features that deliver tabular forms to save screen space, dynamically show and hide parts of a form, and establish parent-child relationships to ensure reliable data entry • deliver sophisticated custom solutions that can be upgraded with ease from SharePoint version to version • bring data together from all of your enterprise application systems, such as Oracle®, SAP®, SQL Server® and Salesforce.com®, without the hassle of copying the data manually into SharePoint • build dashboards and charts that provide full visibility of your K2® workflows (including real-time workflow) status. Then build rich SharePoint forms that drive business processes, so users can take action on K2 workflows from directly within the SharePoint form (for SharePoint 2010 only) • create custom actions with out-of-the-box and Nintex® workflows • use ribbons. For more information, see Ribbon Groups on page 9. Ribbon Groups A Ribbon group is delivered for each web part that supports the SharePoint and SharePoint Foundation Server Ribbon UI. The contextual group contains the “Commands” contextual tab for the web part on the page, which in turn, contains different Ribbon groups. When you select a web part, you can access such functions as ezEdit and Help. NOTE: To hide the Ribbon, enable the corresponding property in the Configuration Editor. When multiple web parts are added to the page, different Ribbon tabs are added in the order of the web part appearance on the page. Each tab’s name defaults to the Title property of the web part. The display name of the tab can be changed using the web part property, Ribbon Appearance. This property allows you to customize the display name for the tab. If this property is filled out, it overrides the web part's Title property. If both of these properties are empty, the default name, “Commands”, is used. The web part’s ribbon may consists of one or more of the following groups: Table 1. Ribbon Groups Group Description Manage Group Contains the buttons: “Save and Close”, “Edit Item”, “Edit Series”, and “Cancel” depending on the context. For example, if you are working with a form of type EditListItem, the group will contain the “Save and Close” button. If the form type is DisplayListItem or DisplayDocument, and you are working with a Calendar list, the button is “Edit Series”. The text for Save and Cancel buttons can be changed by using the Toolbar Appearance tab. Actions Group Contains a set of action buttons seen in the regular toolbar, The Ribbon organizes the actions into different groups. In general, any button shown in the toolbar and not in the “Manage” or “Custom Actions” groups is found in the “Actions” group. This includes “Alert Me”, “Manage Permissions”, or “Manage Copies”. Custom Actions Group Contains a set of custom actions defined in the Custom Actions properties. Setting & Help Group Contains buttons from the web part context menu: “ezEdit”, “Help” and “About”. AgreeYa QuickApps for SharePoint 6.6 User Guide 9 2 qCalendarView • Overview • qCalendar Pages Overview The qCalendarView aggregates data from one or more SharePoint lists and displays it in calendar form. The qCalendarView allows you to: • Aggregate data from multiple lists that reside in different SharePoint sites. The lists to be aggregated are defined in the Viewed Lists property. • Ensure the referential integrity of the records in the dependent lists by preventing the deletion of the parent record. The dependent lists are defined in the Viewed Lists property. • View your data by Month, Week, or Day. • Display non-recurring and recurring events from Calendar lists. • Customize the look and feel for each part of the calendar by using a skin. • Define a static filter using the CAML Filter expression or Complex Filter expression. The Complex Filter expression supports time functions (for example, AddDays) and time expression (such as [TODAY]) to filter out the data based on the moving time window. This feature is called Data Aging. • Access the most common functions on the data item, such as View Properties, Edit Properties, Alert Me, Export to ICalendar, and Delete. The author can turn off the context menu by setting the Enable Context Menu property to False. • Show or hide the calendar based on the site group and cross-site group membership of the currently logged-in user by using the Show User Groups and Hide User Groups properties. • Enable the chart view to consume a filter from another web part that implements IWebPartRow or IWebPartParameter interface. TIP: To maintain the same look and feel across all web parts, save the web part as a template, and reimport it into the SharePoint gallery to reuse it. NOTE: The IWebPartParameter consumer implementation is labeled with Get Filter From in the web part Connection menu. This interface cannot be connected with the obsolete IFilterProvider or IRowProvider implementation. Do not connect this new interface with the old interface that is marked obsolete. qCalendar Pages You can configure this web part through its pages that are accessible through ezEdit. qCalendar contains the following pages: • Content Page • Behavior Page • Appearance Page www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 10 • Advanced Page Content Page The Content page allows you to enter the content for your web part. It contains the following: • Primary Content • Optional Content • Search/Filter Panel • Filtering Primary Content The Primary Content page is default category. You need to configure one or more elements in this page to get started using this web part. Primary Content contains the following: Table 1. Primary Content Element Description Title Allows you to enter a title for the Web Part, or accept the default. This field is mandatory. Viewed Lists See Viewed Lists on page 11. ID HTTP Parameter Allows the qListForm and several other web parts to an HTTP Parameter called ID to identify the item to be displayed or edited. This HTTP Parameter is usually generated automatically by the viewer web part, such as qListForm or qCalendarView, when you select an item to be displayed or edited. NOTE: If qCalendar is placed on a web part page that is contained within a document library, the page will generate an error if the value of the ID HTTP Parameter is bigger than the number of pages within the document library. To prevent this error from happening, rename the ID HTTP Parameter. By default, the value of this property is "ID". You can change the value of this property to something else, such as LID. In that case, when you select "View Properties" or "Edit Properties" in the context menu, the URL of the display or edit form becomes: http://mysite.com/EditFormURL.aspx?LID=xxx NOTE: Set the same property in the qListForm to the same value. Begin Date Field Name Allows you to enter the name of the field in the SharePoint list that contains the begin date information. The default value is Start Time, which is the begin date field name for the SharePoint calendar list. If the calendar displays data from another type of list, you may have to adjust the value of this property. For example, if you want to display data from the Tasks list based on the Due Date of the tasks, then use Due Date as the value of this property. End Date Field Name Allows you to enter the name of the field in the SharePoint list that contains the end date information. This property is optional. The default value is End Time, which is the end date field name for the SharePoint calendar list. If the calendar displays data from another type of list, you may have to adjust the value of this property or leave the value of the properly blank if it is not applicable. Viewed Lists The Viewed Lists section defines: • the lists whose data is aggregated in the calendar www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 11 • the Dependent Lists for each list. If the Dependent Lists information is provided, the Calendar View checks whether or not there are child records in the Dependent Lists when the user tries to delete an item from the calendar. If there are, the Calendar View does not delete the selected item. Viewed List contains the following list attributes: Table 2. Viewed Lists List Attributes Description Advanced Mode Turn on if you want to edit Viewed Lists in XML format. For example:Site URL The URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory. When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash (/) to denote the root path. List Name The name of the SharePoint list that is edited or displayed by this Calendar View. The list name is case sensitive. If the list name contains spaces, include the spaces here as well. To denote the current list, you can use a single dot (.) as the list name. NOTE: This only works if the qCalendarView is contained in the AllItems.aspx. For example, if you are replacing the Microsoft Calendar View in the AllItems.aspx of the Tasks list and you use a single dot as the ListName attribute, the ListName attribute of the qCalendarView ise set to Tasks. If you want to save the list as a template and then use it somewhere else, the name of the new list might not be Tasks and using this relative list name automatically picks up the new list name for the view. Include Subsites If selected, the Calendar View searches all the subsites for a list whose name specified in the ListName and aggregate the information from those list. NOTE: If you have many subsites, the information may take a long time to aggregate. Use this attribute if you have only a few subsites. You must test this feature in your environment to see whether or not the response comes back in a reasonable amount of time and the request does not time out. Include This Site Used in conjunction of the IncludeSubsites attribute. If you set this property to true, the list in the current site is not aggregated by the Calendar View. The current site is the site whose URL is specified in the SiteUrl attribute. Is Rollup List Indicates whether or not the list specified by the SiteUrl and ListName attributes contains the Site URLs of the lists to be aggregated instead of the data to be aggregated. If you set this to true, the list specified by the SiteUrl and ListName must have a field that contains the URL information. By default, the name of that field is Site URL. If you use different field name, specify the name using the SiteUrlFieldName attribute below. Rolled Up List Name Used in conjunction with the Is Rollup List property, indicates the name of the lists to be rolled up if you check the Is Rollup List check box. If you want to aggregate more than one list from each site specified in the rollup list, you can define more than one List elements with the same rollup list, but different Rolled Up List Name. For example, if you want to aggregate Public Library and Private Library document libraries from each site, you can specify the following: Site URL Field Name Used in conjunction with the Is Rollup List property, indicates the field that contains the Site URLs of the lists to be aggregated. This attribute is optional if the field name is Site URL. NOTE: The Site URL field must be a single line of text field. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 12 Table 2. Viewed Lists List Attributes Description Active Field Name Used in conjunction with the Is Rollup List property. The rollup list may contain a Yes/No field to indicate whether or not a particular site should be included in the rollup. This property is optional if the name of this field is Active. NOTE: The Active field must be a Yes/No field. Reset Session Names Resets (sets to NULL) the value of the session variables whose name is specified in this attribute. You can specify multiple names by separating them with commas. You can reset the session name if you have Multi Persistent Selectors in the target page. Usually, you must reset all but the last persistent selector session values. This ensures that the item that you want to pre-select in the last persistent selector is not filtered out by the previous persistent selector. Set Session Name Allows the calendar to store the selected item in the session under the name specified in the attribute. The item is selected when the user clicks a hyperlink created by using the Link To, Link To Target URL, or the Link To Source properties. You can specify this attribute when you have a Persistent Selector web part in the target page and you want that persistent selector to pre-select the item the user chose in this calendar. Target URL When the LinktoTargetUrl attribute of a specific column is selected (in the Primary Content page), the data in that column becomes a hyperlink to the URL specified in this attribute. NOTE: The Target Url can use the <%field name%> field replacement expression. If you are using Advanced Mode, you must use the encoded form of the < and > characters, which are < and > respectively. NOTE: Use the LinktoTargetUrl attribute if you want each list to have a different URL; for example, when you want to aggregate multiple lists from the same workspace and connect a certain column to the display form of the list. In that case, the URL to the display form of each list can be different. New Form URL Indicates the URL where the form to create a new item in the list resides. The URL is relative to the Site URL of the list. The user is redirected to the specified URL when the New Item button in the toolbar is clicked. If not defined, the user is redirected to the NewForm.aspx of the list (or Upload.aspx for the document library). Edit Form URL Indicates the URL where the form to edit an item in the list resides. The URL is relative to the Site URL of the list. The user is redirected to the specified URL when the user clicks Edit Properties in the Context Menu. If not defined, the user is redirected to the EditForm.aspx of the list. Redefining the Edit Form URL is useful if you have different ways of editing an item depending on the current view. For example, in the view for external vendor, you may want to give them an edit form that does not contain all the fields in the list. NOTE: The ID and Source HTTP parameters are automatically appended to the Edit Form URL during redirection. This attribute is usually used in conjunction with the qListForm web part. Display Form URL Indicates where the URL where the form to display an item in the list resides. The URL is relative to the Site URL of the list. The user is redirected to the specified URL when the user clicks View Properties in the Context Menu. If not defined, the user is redirected to the DisplayForm.aspx of the list. Redefining the Display Form URL is useful if you have different way of displaying an item depending on the current view. For example, in the view for external vendor, you may want to give them a display form that does not contain all the fields in the list. NOTE: The ID and Source HTTP parameters are automatically appended to the Display Form URL during redirection. This attribute is usually used in conjunction with the qListForm web part. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 13 Optional Content You can configure the following optional content: Table 3. Optional Content Element Description Recurrence Field Name Allows you to enter the name of the field in the SharePoint list that contains the recurrence data. This property is optional. The default value is RecurrenceData, the name of the field for the SharePoint calendar list that contains the recurrence data. If the calendar displays data from another type of list, leave the value of the properly blank. Only the event list can have recurrence data (SharePoint does not allow you to add a new field to the list with Recurrence type). Display Field Name Allows you to enter the name of the field in the SharePoint list that contains the title for the item. The default value is Title, which is the name of the field for the SharePoint event list that contains the event title. If the calendar displays data from another type of list, you may have to adjust the value of this property. For example, if you want to display data from the Projects list, you may use Project Name for the value of this property. If you want to display the information from more than one fields, then specify the format in the Display Format property. Display Format Allows you to enter the format of the title. You can use the <%FieldName%> field replacement expression to refer to a certain field. The FieldName is case sensitive. This property takes precedence over the Display Field Name property. NOTE: For more information, see Display Format on page 14. Tooltip Field Name Allows you to enter the name of the field in the SharePoint list that contains the description for the item. The description for the item is displayed as a tooltip when you hover your mouse over an item in the calendar. The default value is Description, which is the name of the field for the SharePoint event list that contains the event description. If the calendar displays data from another type of list, you may have to adjust the value of this property. For example, if you want to display data from the Tasks list, you may use Task Description for the value of this property. If you want to display the information from more than one field, specify the format in the Tooltip Format property. Tooltip Format Allows you to enter the format of the tooltip. You can use the <%FieldName%> field replacement expression to refer to a certain field. The FieldName is case sensitive. This property takes precedence over the Tooltip Field Name property. Display Format This attribute specifies how the field value is formatted when displayed. The syntax for the Display Format string is as follow: {0:FormatString}. The following are the value of the Display Format attribute grouped by the type of the value to be formatted. Table 4. Basic Number Formatting Format Type Output (if input is double value 2.34) Output (if input is integer value 12400) {0:c} Currency $2.34 $12,400 {0:d} Decimal (whole number) N/A 12400 {0:e} Scientific 2.340000e+000 1.240000e+004 www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 14 Table 4. Basic Number Formatting Output (if input is double value 2.34) Output (if input is integer value 12400) Number with commas for thousands 2.34 12,400 Hexadecimal N/A cf90 Example Output (if input is 12400.25) Format Type {0:n} {0:x} Table 5. Custom Number Formatting Specifier Note 0 Zero placeholder {0:00.00} 12400.250 # Digit placeholder {0:##.####} 12400.25 . Decimal point {0:0.0} 12400.3 , Thousands separator {0:0,0} 12,400 % Percent (Multiplies by 100 and add % sign) {0:0%} 1240025% For custom number formatting, you can combine different specifiers. For example: {0:0,0%} will output 1,240,025%. Table 6. Date Formatting Format Type Output (if input is November 14, 2007 10:34:23 PM) {0:d} Short date 11/14/2007 {0:D} Long date November 14, 2007 {0:t} Short time 10:34 PM {0:T} Long time 10:34:23 PM {0:f} Full date and time November 14, 2007 10:34 PM {0:F} Full date and time (long) November 14, 2007 10:34:23 PM {0:g} Default date and time 11/14/2007 10:34 PM {0:G} Default date and time (long) 11/14/2007 10:34:23 PM {0:M} Month and day November 14 {0:r} RFC1123 date string Wed, 14Nov2007 10:24:23 GMT {0:s} Sortable date string 2007-14-11T22:34:23 {0:u} Universal sortable, local time 2007-14-11 22:34:23 PM {0:U} Universal GMT November 14, 2007 10:34:23 PM {0:Y} Month and year November, 2007 Table 7. Custom Date Formatting Specifier Note Example Output (if input is November 14, 2007 10:34:23 PM) dd Day {0:00.0} 14 ddd Day name {0:##.####} Wed ddd Full day name {0:0.0} Wednesday www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 15 Table 7. Custom Date Formatting Specifier Note Example Output (if input is November 14, 2007 10:34:23 PM) f,ff,... Second fraction {0:fff} 230 gg Era {0:gg} A.D. hh 2 digit hour {0:hh} 10 HH 2 digit hour in 24 hour format {0:HH} 22 mm Minute 00-59 {0:mm} 34 MM Month 01-12 {0:MM} 11 MMM Month abbreviation {0:MMM} Nov MMMM Full month name {0:MMMM} November ss Seconds 00-59 {0:ss} 23 tt AM or PM {0:tt} PM yy Year, 2 digits {0:yy} 07 yyyy Year {0:yyyy} 2007 zz Timezone offsets, 2 digits {0:zz} -05 zzz Full timezone offsets {0:zzz} -05:00 : Separator {0:hh:mm:ss} 10:34:23 / Separator {0:dd/MM/yyyy 14/11/2007 Search/Filter Panel The Search/Filter Panel allows you to define the panels for search, filter, and replace in the web part. The Search/Filter Panel contains the following elements: Table 8. Search/Filter Panel Element Description Searched Fields See Searched Fields on page 17. Show Search All Fields Determines whether the Filter panel should display the control to search all fields in Control in Search the list. When set to true, the following control is shown in the Filter panel: Panel The Search All Fields Control allows you to do the following: • Combine the search all fields functionality with other search criteria that has been entered for specific fields. When the search all fields criteria is entered, the Filter panel will construct a filter expression with the "Contain" operator for the following fields in the list: Single line of text, Multiple lines of text, Choice, Lookup (only Lookup to a Single Text field and Lookup to a Number field are supported), Person or Group and Hyperlink or Picture. If the list contains a Lookup to Number field, Search All Fields will not work for negative numbers for that field. The Filter panel will use the entire keywords as the value to be searched. Therefore, if you enter "High Priority" in the search all fields control and perform the search, it will find the following sentence: ‘This is a high priority task’ However, it will not find the following sentence: ‘The priority is not always high’ www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 16 Table 8. Search/Filter Panel Expand Filter panel on Load Allows you to automatically open the Filter panel by default so that the user can perform a search quickly. When set to true, the Filter panel opens when the web part is loaded for the first time. Panel Button Location Determines the location of the Go, Reset and Close buttons in the Filter panel. This property also determines the location of the Go and Close buttons in the Replace panel. Searched Fields This property defines what fields are displayed in the Filter panel. If defined, the calendar view displays the Filter button in the toolbar. To disable the search feature in the calendar view, you can leave this property blank. If defined, the calendar view displays Filter or Search menu items under the Actions button in the toolbar. To disable the search feature in the calendar view, you can leave this property blank. You will be able to perform a search by pressing Enter. NOTE: Pressing Enter will not allow you to perform a search on such fields as external data, people picker, managed metadata, and a drop-down list. Instead, the default behavior will occur. NOTE: For the Number type field, the “Contain” operator is not supported for negative numbers, and is not available for the following fields: Lookup to DateTime field, Lookup to Calculated field, and Lookup to ID field. Specify the following field properties: Table 9. Searched Fields Field Property Description Advanced Mode Turn on if you want to edit Searched Fields in XML format. Field Name Indicates the element you are editing. Title Displays title for the field. The value can be a plain string or an encoded HTML string. Description Describes the field. This is useful if you want to give a short instruction or explanation about the field. Default Value Defines the default value for the field. You can define a text, a number or a date. A date value must be specified in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ, for example: midnight of February 14, 2002 is 2002-02-14T00:00:00Z. Default Operator Defines the default operator for the field. Fixed Operator Defines the operator for the field. If specified, the list to select the operator for this field is turned off. Use People Editor Enables you to enter any user information that is in your directory service. If you set this to True and the field to be searched is a People and Group field, the Filter panel shows the People Editor control for entering the search criteria. Column Count Defines the number of columns for the options in a multi-choice field or in a choiceand-lookup field if the Enable Multi Choice attribute is set to True. This is useful in case your choice or lookup fields have too many choices and you want to break the choices into several columns to minimize the vertical scrolling in your form. Enable Multi Choice If set to True, allows you to select multiple options for the choice-and-lookup field. Therefore, the user can specify a condition like "A or B". This attribute is ignored by other field types. To search a cross-site lookup field, you must specify one or more List elements inside the Field element. The cross-site lookup field is displayed as two drop downs. Sort Field www.agreeya.com Defines the field that is used to sort the value in the list menu. The field name is case sensitive. AgreeYa QuickApps for SharePoint 6.6 User Guide 17 Table 9. Searched Fields Field Property Description Sort Order Allows you to sort the values in ascending or descending order. AutoPostBack When set to true, this attribute causes the Filter panel to refresh when the user changes the selection in a lookup field or cross-site lookup field. You need to set AutoPostBack to true if this field is a lookup or a cross-site lookup field and it is being used to filter another lookup or cross-site lookup field in the Filter panel. Parent Field Defines another lookup or cross-site lookup field that is used to filter this field. Parent Filter Field Name Defines the field in the parent field that is used to filter this field. It is the primary key in the list that is used in the lookup or cross-site lookup field. Filter Field Name Defines the field in the list that is used by this lookup or cross-site lookup field that is filtered by the parent filter field. Display Field Name Shows the name of the field whose value is displayed in the list menu. The field name is case sensitive. Use this attribute instead of the Display Format attribute if you only want to display a single field in the list menu. Display Format Indicates the format of the value that is displayed in the list menu. Define this attribute instead of the Display Field Name attribute if you want to display multiple fields in the list menu. You can use the field replacement expression <%Field%> to refer to a field. NOTE: If you are using Advanced Mode, you must use the encoded form of the < and > characters, which are < and >, respectively unless you type in the value in the Searched Fields editor in the List View Editor, where the Editor encodes the characters automatically. NOTE: For more information, see Display Format on page 14. Site URL Indicates the Site URL of the field. You can use an absolute or relative URL. List Name Indicates the name of the List. The field name is case sensitive. Site Name Indicates the name of the site specified in the Site URL. This is used in case you have multiple lists. In this case, the first list menu to select the list displays as "List Name in Site Name". You can use any name for the Site Name. It does not have to match the real title of the Site. Filtering The Filtering page allows you to use CAML filters to dynamically filter records or use Complex Filters to define static filter for the data. The Filtering page contains the following: Table 10. Filtering Element Description CAML Filter Allows you to specify the CAML (Collaboration Application Markup Language) query expression to filter your data. CAML is an XML-based query language. The CAML Filter will only be applied to the data. The filter will not be applied to the responses. For more information, see CAML Filters on page 19. Complex Filter Allows you to use the Complex Filter expression to define a static filter for the data. The complex filter is applied to the data after the CAML Filter is applied. NOTE: The Complex Filter is provided here only for backward compatibility reason. In the past, Complex filter was used to support date functions. For more information, see Complex Filters on page 21. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 18 CAML Filters CAML Filter expressions help filter data by providing a way to link multiple conditions. Turn Advanced Mode on if you want to edit CAML Filters in XML format. CAUTION: If the web part supports both CAML Filter and Complex Filter, use the CAML Filter. The CAML Filter processes data in the SQL Server, so the data is transferred to the Web Server. The Complex Filter processes data in the Web Server. If you specify both CAML Filter and Complex Filter, the CAML Filter is processed first.The Complex Filter remains for backward compatibility reasons. The operators and field names in the CAML Filter are case sensitive. For the field name, use the internal name of the field. NOTE: This is different from the Complex Filter that uses the Display Name. The Boolean operators
and are supported in CAML Filter. These operators are used to combine two conditions. They must contain exactly two conditions. For example: If you need to link more than two conditions, such as Condition1 And Condition 2 And Condition3, you must nest these operators. For example: ... ... You can specify conditions for CAML Filter in either of the following ways: • ... ... ... This returns all entries whose field specified by InternalFieldName does not contain any value. • This returns all entries whose field specified by InternalFieldName contains values (including empty string value). • ValueToCompare Where: Value is Operator One of the following: www.agreeya.com • Eq — equals to operator • Neq — not equals to operator • Gt — greater than operator • Geq — greater than or equals to operator • Lt — less than operator • Leq — less than or equals to operator • Contains — a string operator to check whether a string contains the specified value • BeginsWith — a string operator to check whether a string begins with the specified value AgreeYa QuickApps for SharePoint 6.6 User Guide 19 Value is TypeName One of the following: • Text • Integer • Float • DateTime NOTE: When you compare a DateTime value, only the date is being processed. The time part is ignored by SharePoint ValueTo Compare One of the following: • String • Number • Date/Time value in the format — YYYY-MM-DDTHH:MM:SSZ • Date/Time value in the format : - — today's date with optional number of days to offset the today's date. You can use the OffsetDays attribute to do date range filter. The OffsetDays attribute value must be a number (both positive and negative numbers)) - — the current user. This value only works if the field is a user lookup field) Using CAML Filters CAML filters allow you set the following variables to validate text fields: Table 11. CAML Filter variables Variable Description <%Now%> Current time and date %FilePath%> Complete path for a file in a document library <%CurrentUserName%> Display name of the current user <%CurrentLoginName%> Login name of the current user <%CurrentUserID%> ID of the current user, for example: 1 <%CurrentUserEmail%> Email address of the current user Variables work if you store either the user name, login name, user ID, or email address in a Single Line of Text field. qListForm and qSIListForm use variables in the Fixed Value or Form Component Behavior sections. For a field of type Single-line-of-Text or Multi-line Plain Text, the Operator drop-down menu contains the value, Matches, as an operator for comparing the field value to a regular expression. Examples of common regular expressions: • Match beginning of a string: ^Test matches any string that starts with “Test”. • Match ending of a string: test$ matches any string that ends with “test”. • Telephone number: ^\d{3}-\d{3}-\d{4}$ matches any phone number in the format of 555-555-5555. Using Dynamic Variables The CAML Filter can also be used with dynamic variables. The Value element in the CAML Filter can come from various sources such as an HTTP Parameter and Session. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 20 NOTE: If you want to use Advanced Mode, you can extend the value element in the CAML filter. Some examples are: • to enter the value in the Value element - Some Text • to retrieve the value from an HTTP parameter -to retrieve the value from the Session variable - to compare values of two fields - Editor Complex Filters Complex Filter provides a powerful way to concatenate multiple conditions. CAUTION: If the web part supports both CAML Filter and Complex Filter, use the CAML Filter. The CAML Filter processes data in the SQL Server, so the data is transferred to the Web Server. The Complex Filter processes data in the Web Server. If you specify both CAML Filter and Complex Filter, the CAML Filter is processed first. The Complex Filter remains for backward compatibility reasons. The date and time value must be enclosed in # and specified in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ. For example, midnight of February 14, 2002 is #2002-02-14T00:00:00Z#. The operators and field names in the Complex Filter are case sensitive. For the field name, use the display name of the field (include all spaces if there are any). The following Boolean operators are supported in Complex Filter: • NOT — This is used to negate a condition. For example, to get all employees whose name does not start with M, they syntax is: NOT Employee Name LIKE 'M%' • AND and OR — This is used to concatenate two conditions. The AND operator takes precedence over the OR. Use parentheses to change the precedence of the operator. For example, to get all employees in the Accounting or IT department and hired after 1/1/2004: (Department='Accounting' OR Department='IT') AND Hired Date>#2004-01-01T00:00:00Z# Specify conditions for Complex Filter is specified in one of following ways: 1 FieldName IS NULL This will return all entries whose field specified by FieldName does not contain any value. Some entries contain an empty string value ("") and their display is indistinguishable from the entries with a NULL value. If you want to return such entries, use FieldName='' as the filter expression. 2 FieldName IS DBNULL This will return all entries whose field specified by FieldName contains DBNull value. It is tricky to determine whether a field is empty, contains null value or contains DBNull value. It all depends on the field type and the type of back end system that you are dealing with. Therefore, try each one ("fieldName IS NULL", "fieldName IS DBNULL" or "fieldName=''") in order to identify which one is the appropriate option for your needs. 3 FieldName IS NOT NULL This will return all entries whose field specified by FieldName contains values (including empty string value). 4 FieldName comparison-operator FieldExpression Comparison operator is one of these: =, <> (not equal), <, >, <=, >=, LIKE FieldExpression can be one of the following: www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 21 • String — A string is enclosed with single quote; for example 'Accounting'. A string can contain wildcard character % or * when used in conjunction with the LIKE operator. For example: 'M%', 'M*'. A wild-card character is not allowed in the middle of a string. Therefore, this expression is illegal: 'Te*xt' • Numbers — Numbers are not enclosed. For example: 20, 20.5, 0.5. If you enclose a number with a single quote, it is treated as string. • Dates • [ME] • [TODAY] • [NOW] — This expression is replaced with the current date and time. • Date function — The following date functions are supported: AddSeconds, AddMinutes, AddHours, AddDays, AddMonths and AddYears. Their syntax is DateFunction(dateValue, number). For example: AddDays([TODAY], 7) adds 7 days to today's date — — For example: February 5, 2005 11:50 PM is #2005-02-05T23:50:00Z#. This expression is replaced with the name of the currently logged-in user. — This expression is replaced with midnight of today's date. The following are some examples of the complex filter: 1 All my current task that are due within 7 days PerformedBy=[ME] AND DueDate>=[TODAY] AND DueDate<=AddDays([TODAY], 7) 2 All unassigned tasks that are due within 3 days PerformedBy IS NULL AND DueDate>=[TODAY] AND DueDate<=AddDays([TODAY], 3) 3 All overdue tasks DueDate<[TODAY] Behavior Page The Behavior page allows you to configure behaviors, such as adding buttons or menus, so the user can perform operations when using the web part. The Behavior page contains the following: • Actions • Navigation • Views Actions The list form has some pre-defined actions, such as Save, Delete, Copy or Move. You can also write your own custom action and hook it up with the list form. The Actions page contain the following elements: Table 12. Actions Element Description Custom Actions For more information, see Custom Actions on page 22. Custom Actions This property enables you to define additional buttons in the toolbar or context menu item in the context menu. You can program that button or context menu item to do a series of actions. The List Form supports some built- www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 22 in actions. However, you can write your own custom action using one of the .NET languages, compile it, and call it by the List Form. See Custom Action Help on page 374 to see how to write your own custom actions. NOTE: The toolbar button affects all the items that are selected in the List Form. The context menu item affects only the item that is being right-clicked regardless of how many items are selected in your List Form. Here are some ways that you can use this functionality: • Add a custom toolbar button called "Assign All to Me" that will assign all of the selected tasks in the List Form to me. • Add a custom toolbar called "Approve" that will change the status of all of the selected expense items to Approved. • Create a custom context menu item called "Publish" that will move the right-clicked document into another document library. • Create a custom context menu item or toolbar item to start a workflow. • With the ability to write your own custom action, you can virtually do anything to the data when you click the custom button that you define. NOTE: The custom action in the List Form does not support the Save action. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 23 Table 13. Custom Actions Element Description Advanced Mode Turn on if you want to edit Custom Actions in XML format:www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 24 Table 13. Custom Actions Element Description IsSeparator Allows you to set the item as a separator. ID Allows you to enter a unique ID that will identify the item. Use a descriptive identifier to configure the action item with the editor. Text Allows you to enter how the action item is displayed in the toolbar. Text Resource ID Allows you to define this property if you support a a multi-lingual site. This attribute defines the identifier of the string in the Resource List that is used as the title of the Web Part. The Text Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the value in the Text attribute is used. Prompt Text Allows you to prompt the user to click the toolbar button or the context menu item. Prompt Text Resource ID Allows you to define this property if you support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the title of the Web Part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used. Access Key (Toolbar Only) Allows you to define one character from the Text attribute that becomes the access key to this toolbar button or context menu item. For example, if you define a letter T as the access key, you can press ALT+T and the browser will put the focus on this button or context menu item. If there are multiple elements on the page with the same access key, you can repeat ALT+T repeatedly until you get the focus on this toolbar button or context menu item. Position Allows you to set the position of the button in the toolbar. The index starts with 0. Show User Groups Allows you to list SharePoint groups whose members can view the Web Part. Separate groups with commas. Hide User Groups Allows you to list SharePoint groups whose members cannot view the Web Part. Separate site group names with commas (for example, Administrators, Readers). If a user is a member of a group that is defined in both Show User Groups and Hide User Groups, the user cannot www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 25 When you add an action, you can configure the following: Element Description Name An optional element which allows you to identify a given action in order to access it from another action. You can refer to this action from the GoToURL action and from ICustomActionEx Interface. Type Allows you to determine the type of the action. Here are the options: • Delete — deletes the item. • GoToURL — redirects the user to a specific URL. You must specify the URL and where you want the URL to open. You must select from one of the following source parameters: • Input - the current user information as the value of the parameter • Session - the name of the session variable where the value comes from when the source is set to Session • HttpRequest - the value of the parameter that is retrieved from the HTTP parameters in the page URL. The name of the HTTP parameter is defined in the SourceName attribute. As an example, say the current page URL is http://mysite.com/default.aspx?ProductType=Hardware. If the SourceName attribute is ProductType, the value of the ProductType HTTP parameter, which is Hardware, is used as the value of the parameter. • ListItem - the value of the parameter is a list item or row • RowFromAnotherWebPart — the parameter for the GoToURL action can be retrieved from the output of another action that comes first in the sequence of actions defined in the ActionItem. There are two types of action that can produce an output: an action with Type of ExecuteOperation, and an action with Type of Custom that points to custom action implementation of ICustomActionEx Interface. You do that by defining the SourceName attribute of the action. This is the syntax of the SourceName attribute when you use ResultFormAction source: . [.Name], where ActionName refers to the Name attribute of the action that produces the output, ResultType can be OutParameter (if the action result is returned through one of the out or inout parameter) or RawData - (if the action result is returned as an object). Name is optional. It further designates the object we want to use for the parameter. You do not have to specify the Name when the ResultType is RawData. However, if the ResultType is OutParameter, this name specifies the name of the out or input key value pair. • ResultFromAction - the parameter for the GoToURL action can be retrieved from the output of another action that comes first in the sequence of actions defined in the ActionItem You must define a source name (where in the source you want to get your information from), name (the name of the parameter that is appended to the URL you specified), and Session (the name of the session variable where the value comes from when the source is set to Session) www.agreeya.com • GoToSource — redirects the user to the URL specified in the Source HTTP parameter. The URL to the page must look like: http://...?Source=URL for this option to work. • StartWorkflow — starts the specified workflow in the Workflow Name drop-down field. You must select a Workflow name. • ReturnToMasterChart — returns the user to the master chart page. You use this action type if this web part is located in the drill down page. • Custom — implements your own custom action and call it with this action type. Enter a Class name that implements the ICustomActionEx or ICustomAction interface, or select a class from the drop-down list, if available. AgreeYa QuickApps for SharePoint 6.6 User Guide 26 Navigation The Navigation page allows you to configure how and where the user will navigate in the web part. It contains the following elements: Table 14. Navigation Element Description LinkTo Allows you to turn the field into a hyperlinked column to the specified URL. The URL can be an absolute or relative URL. The LinkTo can use the <%field name%> field replacement expression. NOTE: If you are using Advanced Mode, you must use the encoded form of the < and > characters, which are < and >, respectively. If you use a relative URL, the URL is appended to the site URL of the target site. For example, specify "Lists/Calendar/EditForm.aspx?ID=<%ID%>" as the value of this property. If the user clicks an event that comes from the Calendar list in Workspace A, whose site URL is "http://mydomain/sites/mysite", the user is directed to http://mydomain/sites/mysite/Lists/Calendar/EditForm.aspx?ID=23 (this assumes that the user clicks the event with ID=23). When the calendar view points to a document library, you can use a special field replacement expression <%FilePath%> to get a complete path for the file. LinkToTargetURL Allows you to make the field value a hyperlink to the URL specified in the TargetUrl attribute in the Viewed Lists property. Use the LinkToTarget URL when you aggregate lists with different name. In that case, specify a different TargetUrl for each list in the Viewed Lists property and the calendar view redirects the user to the correct URL depending on the list from where the clicked item comes. Link To Source Allows you to make the field value a hyperlink to the URL specified in the Source HTTP parameter of the current request. For this option to work, the current page URL must look like: http://.....?Source=.... When do you use this attribute as opposed to the Link To or the Link To Target URL attributes? A typical case is when the URL for the hyperlink is dynamic. This could be because it contains dynamic parameters or the URL is different depending on the referral page. Use the LinkToSource when you want to make the URL in the link dynamic. In that case, you can pass in the URL for the link into the HTTP parameter of your page. For example, say that we have a page where the user can select a particular contact from the Contacts list. This page might be useful for several cases in your application and you cannot hard code the URL because you may want the user to be redirected to different URL depending where they are in the application. In that case, you can specify the URL for the hyperlink in the URL of the page. Views The Views page allows you to set views so the user to view the data in a calendar. The Views page contains the following element: Table 15. Views Element Description Search Session Name The calendar will store the search criteria, last selected folder, sort criteria, and other list view dynamic settings in the session variable with this name. The calendar also use the Search Session Name to communicate those settings to qExcelViewer and qChartView located in the page whose URL specified in the Excel Viewer URL or Chart Viewer URL property, respectively. Therefore, the Search Session Name in those web parts must be set to the same value as the session name in this calendar. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 27 Appearance Page The Appearance page allows you to set the overall look and feel of the web part. This page contains the following: • Ribbon • Toolbar • Legend • Calendar • Context Menu • Layout • Other Ribbon The Ribbon page allows you to set the display name of the Ribbon. Table 16. Ribbon Element Description SharePoint Ribbon Tab Name Allows you to edit the display name of the Ribbon tab. Toolbar The Toolbar page allows you to configure the appearance of the toolbar. It contains the following: Table 17. Toolbar Element Description Toolbar Skin Name Allows you to enter the skin name for the toolbar. Show New Button Allows you to display the New button. Show Connect To Outlook Button Allows you to display the Connect to Outlook button. Show Alert Me Button Allows you to show the Alert Me button in the toolbar. Legend The Legend page allows you to configure the appearance of the legend. It contains the following: Table 18. Legend Element Description Legend Title Allows you to enter a title of the legend. Legend Color Appearance Allows you to select the list title and color and font color for a list that your selected in Viewed Lists. Show Legend Allows you to show the legend. Legend Show Mode Allows you to select where to position the legend. Legend Show User Groups Allows you to select the SharePoint members who can view the legend. Legend Hide User Groups Allows you to select the SharePoint members who cannot view the legend. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 28 Calendar The Calendar page contains the following: Table 19. Calendar Element Description Skin Name Allows you to enter the skin name for the calendar view. Calendar Width Allows you to enter the width of the calendar view in pixels. The default is 700. Calendar Width Unit Allows you to enter unit of measure for the calendar width. Calendar Height Allows you to enter the height of the calendar view in pixels. The default is 500. Row Height Allows you to specify the row height for each day/week view and the appointment for the month view in pixels. Month View Visible Appointments Per Day Allows you to enter the number of appointments visible per day when in the month view. The default is 3. Overflow Behavior Allows you to o scroll or expand the page when the calendar view is not large enough to display all the data. Default Calendar View Allows you to set the default view for the Calendar web part. This can be either Day, Week or Month. Enable Day View Allows you to switch to view one day at a time in the Calendar web part Enable Week View Allows you to switch to view one week at a time in the Calendar web part. Enable Month View Allows you to switch to view one month at a time in the Calendar web part. First Day of Week Allows you to determine the first day that is displayed in the week view and month view. The default value is Sunday. Last Day of Week Allows you to determine the last day that is displayed in the week view and month view. The default value is Saturday. Allow Delete Allows you to determine whether or not the delete button should be shown on every appointment in the calendar. The delete button appears when you hover your mouse over the appointment. If you set this property to false, the delete button is not shown during the mouse over. By default, Allow Delete is set to true. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 29 Table 19. Calendar Element Description Appearance Field Name Allows you to determine the name of the field whose values is used to determine the color of the appointment. This allows appointments to be displayed in different colors based on the value in this predefined field. For example, to display all appointments in conference room 5 with red and all appointments in conference room 6 with blue, the Appearance Field Name would be "Location". There are 2 additional fields that you can use as Appearance Field Name. These fields are not part of the list but used internally by the Calendar View: Color Appearance • Workspace URL — this is the URL of the site that contains the containing list. When using the Workspace URL in the Appearance Field Name, you need to specify the absolute URL of the site in the FieldValue attribute in the Color Appearance property, for example: http://www.mysite.com/site1 • List Name — this is the name of the list that contains the appointment. When using the List Name in the Appearance Field Name, you need to specify the name of the list in the FieldValue attribute in the Color Appearance property, for example: Project Calendar Allows you to determine the color of the appointment for a certain value in the field specified by the Appearance Field Name. Turn on Advanced Mode if you want to edit Color Appearance in XML: For example: The following are the attributes of the Color Appearance property: • FieldValue — specifies the value for the field. • BackgroundColor — is optional and it specifies the background color of the appointment for the specified value in the FieldValue attribute. The color can be specified as a well-known color such as white, black, cyan, lightGray, as a RGB value such as 255, 255,255, or you can specify it as #FFFFFF, #CCDDEE. • FontColor — is optional and it specifies the font color of the appointment for the specified value in the FieldValue attribute. The color can be specified as a wellknown color such as white, black, cyan, lightGray, as a RGB value such as 255, 255,255, or you can specify it as #FFFFFF, #CCDDEE. The FontColor attribute is ignored if you specify a URL in the Link To property or set the Link To Source or Link To Target URL properties to true. • FieldValueRange — Instead of using the FieldValue attribute, you can also use this attribute to determine a range of value, such as 0-100, 101-200. FieldValueRange can only be used if you specify the name of a Number or Currency field in the Appearance Field Name property. Context Menu The Context Menu page contains the following: www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 30 Table 20. Context Menu Element Description Enable Context Menu Allows you to show the context menu. Context Menu Skin Name Allows you to set he skin name for the context menu. Show View Properties Allows you to show the View Properties menu item in the context menu. Show Edit Properties Allows you to show the Edit Properties menu item in the context menu. Show Manage Permissions Allows you to show the Manage Permissions menu item in the context menu. Show Alert Me Allows you to show the Alert Me menu item in the context menu. Show Workflows Allows you to show the Workflows Properties menu item in the context menu. Layout The Layout page allows you to set the overall layout of the web part. It contains the following: Table 21. Layout Element Description Width Allows you to set the web part to a fixed width Height Allows you to set the web part to a fixed height Chrome State Allows you to select if the web part can be minimized or not when you open the web part. If Minimized is selected, then only the Title Bar displays. Chrome Type Allows you to select the kind of border to display around the web part. Hidden Select this check box if you want the web part hidden Direction Allows you to set how the text in the web part displays depending on the language, either from Left to Right or Right to Left Other The Other page allows you to set the appearance of other elements in the web part. It contains the following: Table 22. Other Element Description Allow Minimize Select this check box if you want the web part minimized Allow Close Select this check box if you want the web part removed from the page Allow Hide Select this check box if you want the web part hidden Allow Zone Change Select this check box if you want the web part moved to a different zone Allow Connections Select this check box if you want the web part to participate in connections to other web parts Allow Editing in Personal View Select this check box if you want the web part modified in a personal view Export Mode Allows you to select the level of data that can be exported for this web part Title URL Allows you to add the title of a URL as extra information about the web part Description Allows you to enter a description of the web part that is displayed as a Tooltip when you hover your mouse over the web part title or icon. Help URL Allows you to enter the location of a file containing Help information about the web part. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 31 Table 22. Other Element Description Help Mode Allows you to specify how a browser displays Help content for the web part, either in a separate window which you must close before returning to the Web Page (Mode), in a separate window that you do not need to close before returning to the Web Page (Modeless), or in the current browser window (Navigate) Catalog Icon Image URL Allows you to specify the location of a file containing an image to be used as the web part icon in the Web Part List. The image size must be 16 by 16 pixels. Title Icon Image URL Allows you to specify the location of a file containing an image to be used in the web part title bar. The image size must be 16 by 16 pixels. Import Error Message Allows you to specify a message that appears if there is a problem importing the web part Advanced Page The Advanced page allows you to set advanced features of the web part, such as the following: • Security • Resources Security The Security page allows you to set which users are allowed to view the web part. It contains the following: Table 23. Security Element Description Show User Groups Allows you to list SharePoint groups whose members can view the Web Part. Separate groups with commas. Hide User Groups Allows you to list SharePoint groups whose members cannot view the Web Part. Separate site group names with commas (for example, Administrators, Readers). If a user is a member of a group that is defined in both Show User Groups and Hide User Groups, the user cannot Target Audiences Allows you to have the Web Part to appear only to people who are members of a particular group or audience. An audience can be identified by using a SharePoint group, a distribution list, a security group, or a global audience. Resources The Resources page allows you to enable Localization in the web part using resource lists. Localization Localization contains the following elements. NOTE: While this feature is still available to use, we recommend using ezLocalizer. For more information, see ezLocalizer on page 385. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 32 Table 24. Localization Element Description Resource List Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns: • Resource ID — This field contains the identifier to refer to the string. You can have multiple strings with the same Resource ID as long as their Culture value is different. • Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank. • Value — This field contains the value for the string. The Lists element can contain only one List element. The following are the attributes for the List element: Title Resource ID • SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory. • ListName — The name of the resource List. The list name is case sensitive. Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used. View Properties Context Allows you to set the text for the View Properties context menu. Menu Text Resource ID Edit Properties Context Menu Text Resource ID Allows you to set the text for the Edit Properties context menu. Manage Permissions Context Menu Text Resource ID Allows you to set the text for the Manage Permissions context menu. Alert Me Context Menu Text Resource ID Allows you to set the text for the Alert Me context menu. Workflows Context Menu Text Resource ID Allows you to set the text for the Workflows context menu. New Button Text Resource ID Allows you to enter a text resource ID for the New button. Connect to Outlook Allows you to enter a text resource ID for the Connect to Outlook button. Button Text Resource ID Alert Me Button Text Resource ID Allows you to enter a text resource ID for the Alert Me button. Filter Button Text Resource ID Allows you to enter a text resource ID for the Filter button. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 33 3 qCaptionDisplay • Overview • qCaptionDisplay Pages Overview The qCaptionDisplay is a web part that displays a message from a SharePoint list. The text for the message is identified with a Caption ID. Storing the message in a list, as opposed to hard coding it in a page, increases the site maintainability. This is useful if the site is replicated. If you need to make a change to the message, you only have to do it in one place; just change the list. The list usually resides outside of the replicated site. You can localize the title and the messages displayed by the caption display. You can define different Title for different cultures using the Resource List and the Title Resource ID properties. The culture for the page can be defined by appending the Culture HTTP parameter to the page URL. For example: http://hostname/sites/sitename/default.aspx?Culture=en-US To use the caption display, you must first define a source list for the captions. The SharePoint list for the caption display should contain these fields: This field is mandatory. It is a single-line text field that contains the identifier for the • Caption ID caption. • Caption • Culture — This field is optional. You must have this field if you want to have different messages for a different culture. You can define different captions with the same Caption ID, but different Culture. You must leave the value for the default culture blank. For example: — — This field is mandatory. This is a multiple-line text field that contains the message. Table 1. Culture Caption ID Culture sites.mysite.default.aspx sites.mysite.default.aspx Caption Welcome to my site id-ID Selamat datang ke situs saya NOTE: Make sure that the Allow rich HTML text in the Caption field is set to No. If your list uses different name for the fields, define the name in the Caption ID Field Name, Caption Field Name and Culture Field Name properties. NOTE: The Caption field can contain plain text or a piece HTML. You can create the source by selecting AgreeYa Caption Display List (under Custom Lists in SharePoint). This automatically creates a list that contains all of the above fields. Define a convention for the Caption ID value that makes it easy for you to identify where the message is used. For example, use the URL of the page, remove the host name from the URL and replace all / with . (period). Therefore, if the page URL is http://hostname/sites/mysite/default.aspx, the Caption ID is sites.mysite.default.aspx. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 34 qCaptionDisplay Pages You can configure this web part through its tabs that are accessible through ezEdit. qCaptionDisplay contains the following tabs: • Content Page • Appearance Page • Advanced Page Content Page The Content page allows you to enter the content for your web part. It contains the following: • Primary Content Primary Content The Primary Content page is default category. You need to configure one or more elements in this page to get started using this web part. Primary Content contains the following: Table 2. Primary Content Element Description Title Allows you to enter a title for the Web Part. This field is mandatory. Site URL Allows you to enter the URL to the site that contains the list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory. List Name Allows you to enter a list name. The name is case sensitive. If the name of the list contains spaces, include the spaces in the List Name. Caption ID Allows you to enter the identifier that locates the message in the list. Caption ID Field Name Allows you to enter the name of the field containing the caption ID. The default value is User Caption ID. Caption Field Name Allows you to enter the name of the field containing the message. The default value is Caption. Culture Field Name Allows you to enter the name of the field containing the Culture. The default value is User Culture. Appearance Page The Appearance page allows you to set the overall look and feel of the web part. This page contains the following: • Ribbon • Layout • Other Ribbon The Ribbon page allows you to set the display name of the Ribbon. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 35 Table 3. Ribbon Element Description SharePoint Ribbon Tab Name Allows you to edit the display name of the Ribbon tab. Layout The Layout page allows you to set the overall layout of the web part. It contains the following: Table 4. Layout Element Description Width Allows you to set the web part to a fixed width Height Allows you to set the web part to a fixed height Chrome State Allows you to select if the web part can be minimized or not when you open the web part. If Minimized is selected, then only the Title Bar displays. Chrome Type Allows you to select the kind of border to display around the web part. Hidden Select this check box if you want the web part hidden Direction Allows you to set how the text in the web part displays depending on the language, either from Left to Right or Right to Left Other The Other page allows you to set the appearance of other elements in the web part. It contains the following: Table 5. Other Element Description Allow Minimize Select this check box if you want the web part minimized Allow Close Select this check box if you want the web part removed from the page Allow Hide Select this check box if you want the web part hidden Allow Zone Change Select this check box if you want the web part moved to a different zone Allow Connections Select this check box if you want the web part to participate in connections to other web parts Allow Editing in Personal View Select this check box if you want the web part modified in a personal view Export Mode Allows you to select the level of data that can be exported for this web part Title URL Allows you to add the title of a URL as extra information about the web part Description Allows you to enter a description of the web part that is displayed as a Tooltip when you hover your mouse over the web part title or icon. Help URL Allows you to enter the location of a file containing Help information about the web part. Help Mode Allows you to specify how a browser displays Help content for the web part, either in a separate window which you must close before returning to the Web Page (Mode), in a separate window that you do not need to close before returning to the Web Page (Modeless), or in the current browser window (Navigate) Catalog Icon Image URL Allows you to specify the location of a file containing an image to be used as the web part icon in the Web Part List. The image size must be 16 by 16 pixels. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 36 Table 5. Other Element Description Title Icon Image URL Allows you to specify the location of a file containing an image to be used in the web part title bar. The image size must be 16 by 16 pixels. Import Error Message Allows you to specify a message that appears if there is a problem importing the web part Advanced Page The Advanced page allows you to set advanced features of the web part, such as the following: • Security • Resources Security The Security page allows you to set which users are allowed to view the web part. It contains the following: Table 6. Security Element Description Show User Groups Allows you to list SharePoint groups whose members can view the Web Part. Separate groups with commas. Hide User Groups Allows you to list SharePoint groups whose members cannot view the Web Part. Separate site group names with commas (for example, Administrators, Readers). If a user is a member of a group that is defined in both Show User Groups and Hide User Groups, the user cannot Target Audiences Allows you to have the Web Part to appear only to people who are members of a particular group or audience. An audience can be identified by using a SharePoint group, a distribution list, a security group, or a global audience. Resources The Resources page allows you to enable Localization in the web part using resource lists. Localization Localization contains the following elements. NOTE: While this feature is still available to use, we recommend using ezLocalizer. For more information, see ezLocalizer on page 385. www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 37 Table 7. Localization Element Description Resource List Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns: • Resource ID — This field contains the identifier to refer to the string. You can have multiple strings with the same Resource ID as long as their Culture value is different. • Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank. • Value — This field contains the value for the string. The Lists element can contain only one List element. The following are the attributes for the List element: Title Resource ID www.agreeya.com • SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory. • ListName — The name of the resource List. The list name is case sensitive. Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used. AgreeYa QuickApps for SharePoint 6.6 User Guide 38 4 qCascadingMenu • Overview • qCascadingMenu Pages • qCascadingMenu Procedures Overview The qCascadingMenu lets you create complex menus that occupy minimum screen real estate. qCascadingMenu offers the ability to: • display items from multiple SharePoint lists. Each list can contain multiple top-level items. • define a static FilterExpression using a Complex Filter expression. The ability to filter enables you to define the items to be displayed in your menu. • show or hide the top-level items that come from a certain list based on the site group membership of the currently logged-in user. • hide menu items whose target URLs are not accessible by the current user. • define an icon for each menu item, and define the target frame for the target page. • localize the title and the menu item text. You can define different Title for different cultures using the Resource List and the Title Resource ID properties. Your can define the culture appending the Culture HTTP parameter to the page URL. For example: http://hostname/sites/sitename/default.aspx?Culture=en-US To configure this web part, we recommend that you use the AgreeYa Menu List custom list template. Use the template to define a source list for the menu items on a SharePoint site. For information on how to create the source list, see Configuring qCascadingMenu on page 45. This automatically creates a list which contains the following columns by default: Table 1. List Columns Column Description Text Provide the text for the menu item. Menu ID Provides the ID for the menu item. Parent Menu ID Provides the ID of the menu item that is the parent of this menu item. Target Url Provides the target URL for the menu item. NOTE: This is not a Hyperlink field because Hyperlink field does not let you use a relative URL. Target Indicates where to open the target page. Specify _blank to open the page in a new window. Leave the target column empty to redirect the current window to the target URL. Icon Url Provides the URL to the icon for the menu item. Access Key Indicates the shortcut key to activate the menu item. You can activate the menu item by pressing ALT+Access Key Character. Culture Indicates the culture for this menu item www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 39 You must map these columns in the source list to the corresponding field names in the Configuration section in the Web Part. For more information on the Configuration section, see Configuration on page 40. For more information on how to configure the qCascadingMenu Web Part, see Configuring qCascadingMenu on page 45. qCascadingMenu Pages You can configure this Web Part through its tabs that are accessible through ezEdit. qCascadingMenu contains the following tabs: • Content Page • Behavior Page • Appearance Page • Advanced Page Content Page The Content page allows you to enter the content for your web part. It contains the following: • Primary Content Primary Content The Primary Content page is default category. You need to configure one or more elements in this page to get started using this web part. Primary Content contains the following: Table 2. Primary Content Element Description Title Allows you to enter a title for the Web Part, or accept the default. This field is mandatory. Configuration See Configuration on page 40. Configuration This property defines the source list and behavior of the cascading menu. The Configuration element can contain one or more Menu elements. Each menu element can read a different source. You can define the following in the Configuration section: www.agreeya.com AgreeYa QuickApps for SharePoint 6.6 User Guide 40 Table 3. Configuration Field Description Advanced Mode Turn on Advanced Mode if you want to edit Configuration in XML format: