Know the Unknown When Developing in SharePoint 2010

Transcription

1 Know the Unknown When Developing in SharePoint 2010 Derek Sanderson, Mariner Melissa Coates, Intellinet Carolina Code Camp May 14, 2011

2 About the Speakers Derek Sanderson Lead SharePoint developer at Mariner Specialist in SP,.NET, C#, Web Services, CRM Blog: Melissa Coates BI developer at Intellinet Specialist in SQL Server SSRS, SSAS, SSIS Blog:

3 Overview of Session This session is based upon things we have learned & dealt with during two BI-oriented SharePoint 2010 implementations late 2010-early One implementation: SharePoint Foundation on a public facing site The other: SharePoint Enterprise on an internally authenticated site

4 Agenda Figuring out Unexpected Errors Web Config Updates Using SPDiagnosticsCategory to Write to the ULS Log Web Part Maintenance Page Development Environment Developer Dashboard PowerShell for deployment Choosing Technologies Dashboards, Scorecards, Reports SSRS Native Mode vs. SharePoint Integrated Mode PowerPoint for Quick Branding Dealing with Limitations Performance Issues with Report Viewer Control 10 Foundation Limitations Q&A

5 Unexpected Errors

6 Unexpected Error Default unexpected error display:

7 Web Config Updates c:\inetpub\wwwroot\wss\virtualdirectories\80\web.config CustomErrors CallStack (SafeMode node) Debug (Compilation node) Dev Only!

8 Errors Displayed CustomErrors = on CallStack = true Debug = true

9 Errors Displayed (cont d) CustomErrors = off CallStack = true Debug = true

10 Searching the ULS Log %ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\14\LOGS Finding error by correlation ID can be tedious; Requires searching each WFE s log

11 SPDiagnostics Category

12 Using SPDiagnosticsCategory to Write to the ULS Log Much easier in 2010 to write to ULS logs using the SPDiagnosticsService class

13 Using SPDiagnosticsCategory to Write to the ULS Log (cont d) Search ULS log by your custom category name

14 ULS Viewers

15 ULS Viewers (cont d) Allows for real time logging.

16 Web Part Maintenance Page

17 Deleting a Web Part When Page is Erroring Out We lose the link if we suppress the default unexpected error page with our Web.Config settings

18 Deleting a Web Part When Page is Erroring Out Add query string parameter?contents=1 to access Web part Maintenance If the URL of the page already has existing query string parameters: Use &contents=1 instead of?contents=1

19 Web Part Maintenance Page

20 Remote SSRS Errors

21 Remote SSRS Errors To enable Remote Errors in SQL Server Mgmt Studio:

22 Developer Dashboard

23 Developer Dashboard New in 2010 to troubleshoot page rendering time. Off by default.

24 Developer Dashboard (cont d)

25 Developer Dashboard (cont d) 3 Ways to Enable the Developer Dashboard: PowerShell, STSADM, or Object Model 3 Options: On Off On Demand provides an icon to toggle the view Farm-Wide Setting

26 Developer Dashboard (cont d) Controlling who sees the Developer Dashboard: One option: Group which controls who sees the output: SPDeveloperDashboardSettings.RequiredPermissions Another option: 1. Enable On Demand 2. Remove icon in the master page 3. Access it by appending query parameter:

27 Developer Dashboard (cont d) Using PowerShell to Enable the Developer Dashboard: $DevDashboardSettings = [Microsoft.SharePoint.Administration.SPWebService]::ContentSer vice.developerdashboardsettings; $DevDashboardSettings.DisplayLevel = [Microsoft.SharePoint.Administration.SPDeveloperDashboardLevel ]::OnDemand; $DevDashboardSettings.RequiredPermissions = 'EmptyMask'; $DevDashboardSettings.TraceEnabled = $true; $DevDashboardSettings.Update(); (Get-SPFarm).PerformanceMonitor.DeveloperDashboardLevel = OnDemand

28 Developer Dashboard (cont d) Using STSADM to Enable the Developer Dashboard: STSADM o setproperty pn developer-dashboard pv OnDemand

29 Developer Dashboard (cont d) Adding custom code to the event pipeline: Utilize SPMonitoredScope to monitor custom code in Developer Dashboard: Execution time Number of SPRequests Number of SQL Queries (incl. query text) using Microsoft.SharePoint.Utilities; using (SPMonitoredScope monitoredscope = new SPMonitoredScope( Custom Web Service Call )) { mywebservicecall(); } Limitation: Won t capture code from a Sandboxed component (User Solution).

30 Developer Dashboard (cont d) Adding Developer Dashboard to a custom master page: <Sharepoint:DeveloperDashboardLauncher ID="DeveloperDashboardLauncher" NavigateUrl="javascript:ToggleDeveloperDashboard()" runat="server" ImageUrl="/_layouts/images/fgimg.png" Text="<%$Resources:wss,multipages_launchdevdashalt_text%>" OffsetX=0 OffsetY=78 Height=16 Width=16 /> <div id="developerdashboard" class="ms-developerdashboard" /> <SharePoint:DeveloperDashboard runat="server" />

31 Developer Dashboard (cont d) CodePlex project to extend the Developer Dashboard:

32 PowerShell for Deployment

33 PowerShell for Deployment Dev > QA > Prod Site Collection Backup Site Collection Restore Restoring permissions on different domain Setting primary & secondary site collection admins

34 PowerShell for Deployment (con td)

35 PowerShell for Deployment (con td) This script asks to proceed before each step. Facilitates doing multiple things within a single script. Typically used to establish proper permissions.

36 PowerShell for Deployment (con td) Invoke script to restore a site collection backup: Console Display: y performs restore / n skips / *ctrl]-c aborts *enter+ performs default action (which is y )

37 Choosing Technologies

38 Dashboards, Scorecards, Reports

39 Dashboards, Scorecards, Reports BI Tool Especially Good At SharePoint Edition Required Excel Pivot tables using SSAS cube Any Excel Services Hiding or simplifying an Excel workbook; server processing Enterprise PowerPivot Power User Ad-Hoc Enterprise PerformancePoint Services (incl. Decomposition Tree) Interactivity (SSAS drilldown to more detail) Enterprise (incl. Silverlight for Decomp) Report Builder End User Ad-Hoc Any (SQL Server) SharePoint Charts Simple requirements Enterprise SharePoint Dashboards SharePoint KPIs SQL Server Reporting Services Parameterized reports; printable reports Visio Services Data-driven diagrams Enterprise Any (Native or Integrated Mode)

40 Wiki Pages for System Documentation Wiki pages are a great option for creating a knowledgebase for users System / Security / Login info Help and FAQs How To Run reports Enter data into lists the possibilities here are endless Consider making the wiki page data-driven Ex: documentation for how to understand a Key Performance Indicator store its URL within DB along with the value, status, trend data

41 Master Data Services New in SQL Server 2008 R2 (Stratature acquisition) Great for handling hierarchies of data, or additional attributes not in the source system

42 SSRS: Native vs. SP Integrated Mode User Interface: Native Mode Report Manager -or- Report Viewer Control Web Part Integrated Mode SharePoint Document Libraries & Report Viewer Control (RVC) Web Part SP Edition: N/A Can use any Edition (more features with Enterprise Edition) Security: 2 nd layer of security in Report Manager folders Reports:.rdl.rdl Integrated w/ SP security Data Sources:.rds.rsds (different format) Limitations: -Separate site for users -Separate security model -Report Manager not very customizable -No Linked Reports

43 PowerPoint for Quick Branding

44 PowerPoint for Quick Branding Goals: Avoid time-consuming CSS and master page edits Permit business users to be involved 20 predefined themes available in SP predefined themes available in PPT 2010 Customized themes in PowerPoint Easy Fully customized colors: iterative No themes for anonymous users

45 PowerPoint for Quick Branding (cont d) Step 1. Create in PowerPoint.

46 PowerPoint for Quick Branding (cont d) Step 2. Export from PowerPoint.

47 PowerPoint for Quick Branding (cont d) Step 3. Upload into SharePoint.

48 PowerPoint for Quick Branding (cont d) Step 4. Apply Theme within SharePoint.

49 PowerPoint for Quick Branding (cont d) Cross-referencing color selections in SharePoint:

50 Dealing with Limitations

51 SSRS: Report Viewer Web Part 9 vs 10 An expected ~1 second additional overhead (due to API calls between SSRS and SP) Known performance issue with RVC 10: embedding charts/gauges/maps within a Tablix performs filling which is costly. RVC 9 does not support new SSRS 2008 R2 features (such as indicators, sparklines, maps) seconds after user clicks the +/- sign to show 3 rows of data

52 SharePoint Foundation Limitations Limitations which affected our implementation: No enhanced Web Analytics. Alternatives: Google Analytics SSRS Execution Log Reporting Insert shameless plug for 2pm session! No Audience Targeting. Workarounds: Place authenticated items in different site Security trimming (SPSecurityTrimmedControl which uses base Sharepoint permissions)

53 SharePoint Foundation Limitations (cont d) No Themes for Anonymous Users. Workaround: Ribbon is displayed for anonymous users. Workaround: Security trimming (SPSecurityTrimmedControl which uses base Sharepoint permissions) No I Like It Social Bookmarks. Workarounds: Facebook Like Google +1

54 SharePoint Foundation Limitations (cont d) ActiveX prompt on anonymous sites (IE). Resolution: Set Person Name Actions and Presence Settings to No.

55 Q&A

56 References SharePoint Editions Comparison.aspx Features Supported by SSRS in Integrated Mode SSRS Performance in SP Integrated Mode SQL Server 2008 R2 g-services-performance-in-sharepoint-integrated-mode-in-sqlserver-2008-r2.aspx

57 References (cont d) Using Developer Dashboard Using SP Monitored Scope:

58 Thanks for attending! Derek Sanderson Blog: Slides posted on the Presentations page Melissa Coates Blog: Creative Commons License: Attribution-NonCommercial-NoDerivative Works 3.0