How to troubleshoot mysterious SharePoint errors.

Overview:

Debugging is difficult when developing custom functionality for Windows SharePoint Services 3.0 (WSS) or Microsoft Office SharePoint Server (MOSS).  The main culprit is that SharePoint normally surfaces very little diagnostic information on the web browser when an error occurs.  This blog entry describes how to locate additional system-generated diagnostic information that can often provide that extra bit of detail that one needs in order to identify root causes.  This can then lead to solving the problem.

I have used this technique with great success to solve otherwise mysterious errors.

Approach:

SharePoint saves a great deal of information to a diagnostic log in a log file in the 12 hive.

The "12 hive" is usually located at "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12".  (I’m not sure if it’s possible for the 12 hive to live anywhere else, in fact).

The idea is to locate the current log file, force the error and then quickly open the log file.  These log files are characterized by:

  • Copious amounts of information.  SharePoint generates a very large amount of diagnostic information and writes it to that log file very quickly.  You need to be quick with the fingers to capture it.
  • Multiplicity.  SharePoint does not write to a single log file but rather generates multiple log files in sequence. 
  • Copy and paste nicely into MS Excel.

My favorite method:

  1. Open up a windows explorer pointing to the 12 hive\logs.
  2. Sort the view to show by modified date (most recent first).
  3. Highlight the most current log file.
  4. In a web browser window, force the error to occur.
  5. Quickly open the current log file and copy its contents to MS Excel.
  6. Jump to the end and analyze the relevant entries.

Other Notes:

By default, the diagnostic log is located in the 12 hive\LOGS directory.

MS Best practices (as per Mike T. of Microsoft) state that the log files should be saved to a separate hard drive.  One does this via central admin.  Your system administrator may have done this, in which case you’d obviously need to find the log file there instead of the default 12 hive location).

This entry addresses issues such as:

  • SharePoint workflow failed to start due to an internal error.
  • (more to be added over time)
  • This entry has been helpful diagnosing workflow errors (e.g. "The workflow failed to start due to an internal error").

 

 

MOSS: Effective introduction to an Organization

(this entry cross posted between http://paulgalvin.spaces.live.com/blog/ and http://blogs.conchango.com)

The postings on this site are my own and don’t necessarily represent Conchango’s positions, strategies or opinions.

Overview

This entry describes some background information on a large (3,000 users) Microsoft Office SharePoint Server (MOSS) rollout and what we did to get the project rolling in such a way that the client is happy and firmly down a path that ends with full adoption of the MOSS feature set.  As of the writing of the entry, we are approximately 50% complete with the first phase of the project.  As things progress, I’ll update this entry and/or write new entries.

In this specific case, the company had already installed SharePoint Portal Server 2003.  The IT group installed the product in a sort of "let’s see if anyone cares" fashion.  It was quickly adopted by many business users and became quite popular in the enterprise at large.  As you can imagine, this was not the best rollout strategy (which the client readily admits) and when MOSS arrived on the scene, the client resolved to "do it right" and hired us to help them.

One of the central questions facing us when we started implementing this project was: How do we introduce MOSS to this client?  Given that the client already had experience with SharePoint, we wondered — do we need to do "differential" training or do we start from the ground up?  After working with key users, we determined that treating this as a green field project made more sense. 

That decision gave a starting point but still left us with the major requirement of figuring out a good strategy for rolling MOSS out to the enterprise.  MOSS is such a big animal … it includes content management, document management, search, security, audience targeting, project management, "fabulous forty" templates, workflow, business data connector, etc.  Couple this with the fact that it’s a large organization that can truly make use of virtually every major MOSS feature and you have the makings of a great project with an enterprise reach and many good things happening.

We’re confronted with this issue time and time again … MOSS has an enterprise reach with its enterprise feature-set, yet even somewhat sophisticated clients have a hard time mentally absorbing those features, let alone incorporating an appreciable fraction of them into their daily routine.

I don’t have a magic solution to the problem.  I instead address just the very first steps that we’ve taken with the client to lead them down the path to successful long-term adoption.

Scope:

As much as I wanted the team to craft a project plan that included such milestones as "PoepleSoft Integration via BDC Completed", "New Cross-Departmental Product Launch Workflow Complete" and "Executive Management KPI’s Accepted", I had to settle for something less.  This is not to say that "less" is bad. In fact, the "less" that we decided for the initial rollout was miles ahead of where they were before we started.  In our case, the "less" turned into:

  • Simple document management using document libraries, version control and content types.
  • Effective search based on content types and customized advance search (via managed properties, XSLT to produce pretty results, etc).

In addition to the above enterprise-wide features (meaning that they were to be rolled out to all departments and users), we added the following singleton in-scope mini-projects:

  • Proof of concept BDC integration.
  • Multi-step and multi-branch workflow process created via SPD.
  • Complex InfoPath form.
  • Surfacing KPI’s for some business process (probably HR talent acquisition in our case, though that may change).

The scope here is not 100% accurate but representative of our approach and sufficient for my purpose here, which is to explain what I consider to be an "effective" introduction of MOSS that will set the client firmly down the golden path to full MOSS adoption.

I won’t write much more about the singleton in this entry.  I do want to point out that these are part of our over-arching strategy.  The idea is to implement the core document management and search features to all users yet provide highly functional, high visible and highly representative examples of other core MOSS features which are simply beyond the ability of most users to absorb at this early stage.  However, they will be "out there" and one hopes that other business units will know of or learn about them and want those features for themselves, leading to greater adoption.  These singleton success stories also serve to provide our sales team "ammunition" for successfully winning second, third and n-phase projects.

What Did We Introduce and Why? 

Having settled on document management and search as a baseline enterprise-wide requirement, we needed to start gathering details.  As a practical matter, this revolved around understanding their documents and that ultimately mapped to understanding content types.

I’ve found it’s difficult to explain content types without visual aides.  More technical folk can walk away from a discussion about content types when CT’s are described in database terms.  "A CT is similar to a database table, it has columns and columns are defined in terms of data types, but CT data types include more than simple integer/date, but also "choice" and "lookup" and the like."  We can talk about "extending" content types, much like one can inherit functionality from a base class in object oriented languages.  However this is obviously not helpful for the transportation department admin person who has no technical background.  I.e., nearly everyone that matters in a MOSS rollout.

Using a white board is iffy.  I’ve presented the idea of a content type and drawn brilliant (or so they seem) pictures of content types and what they do for you in terms of search and how they can be expanded, etc.  In the end, it does feel like some light bulbs have turned on, but the resulting white board picture is a mess. 

This led us to our current and so far most effective landing place: a MOSS sandbox site configured to show these features.

Using the sandbox site, we demonstrate:

  • Content types:
    • Creating a CT with multiple data types (text, date, choice, boolean, lookup, etc).
    • Extending a CT by creating a new CT based on a parent.
    • Searching for documents using CT metadata.
  • Document libraries:
    • Associating a single CT with a library.
    • What happens when we upload a document to that library?
    • Associating multiple CT’s with a doc library.
    • What happens when we upload a document to that library?
    • Filtering and sorting via column headings in a doc lib.
    • Document library views:
      • Sorting
      • Grouping
      • "Quick entry" (data sheet view)
      • "Untagged data" (to assist with migration to MOSS from other content sources; more on this below).

The Sandbox Site:

We designed our sandbox site to be a permanent feature in the development environment to be used for training purposes long after we finish the project and included several artifacts as described:

Content Types:

We defined the following content types: Invoice, Purchase Order, Services Invoice.

We selected Invoice and Purchase order because they are more or less universally under
stood entities.  Everyone in business understands that an invoice is a demand for payment to a customer for an amount issued on a certain date to be paid as per some payment terms.  This leads to a natural definition of a CT which we called "Training Invoice" (to distinguish it from any other kind of invoice).  The purchase order is similarly easily defined.  We also created a "Training Services Invoice" by creating a new CT based upon the "Training Invoice" CT and added just one column, "services rendered".

With the above, we can now demonstrate some key features of CT’s without getting bogged down trying to explain an abstract concept first; everyone already understands what we mean by "invoice" and "purchase order" and are instead able to focus on mechanics of the CT itself.

Custom Lists:

CT with columns of type "lookup" point to a custom list or document library.  We use this extensively and for the sandbox, we created one supporting custom list that contains customers.  We picked customers because it’s an easy concept to understand and easy to demonstrate.  The Invoice CT has a column, "customer" that is defined of type "lookup" that points at this list. 

We created a similar custom list to manage "vendors" for the "Purchase Order" CT.

Document libraries:

We created two document libraries: "Invoices" and "Mixed Documents".

We configured the invoices document library to manage only documents of CT type "Invoice".

We configured the "Mixed Documents" library to manage all three CT’s.

Create several views that show sorting, filtering, data sheet and grouping.

Search:

We defined two new managed properties and mapped them to Invoice Number and Customer.

We created a new customized advance search site and modified it to enable users to search for "invoices" using those two mapped properties.

Modify the XSLT so that the invoice and customer number, when present, appear in an HTML table in a bright color.  The objective here is to demonstrate that such formatting is possible.

Putting it all together:

We arrange for key users to participate in a demo.

We follow this simple script:

  1. Describe the meaning and purpose of a CT, using invoices and purchase orders as examples.
  2. Show the invoice CT definition while simultaneously assuring them that they don’t need to use those screens themselves, just pick up the concepts.
  3. Go to the invoices document library.
  4. Upload a document.
  5. Demonstrate that the customer drop-down is really sourced from a custom list.
  6. Add a new customer to the customer list and then update the recently uploaded invoice’s meta data with the newly created customer.
  7. Switch to the "mixed documents" library and upload a document.  Explain how the system prompts for a document type.
  8. Go back to invoices document library and show how clicking on a column name changes sort order.
  9. Demonstrate column-level filtering.
  10. Show different views that demonstrate multi-level sorting, filtering and grouping.
  11. Show the data sheet view.
  12. Explain the purpose of a "untagged documents" view.
  13. Switch to the customized advanced search.
  14. By now, the recently uploaded document should have been crawled and indexed, so perform a search that demonstrates ability to locate that invoice via the mapped property.
  15. We demonstrate the difference between searching via mapped properties vs. just a text search.

At this point, we are more or less done with the demo.  It seems to take about 30 to 45 minutes, depending on how many questions people ask.

We then send them back to their desks with "homework".  This consists of a simple excel spreadsheet where we ask them to define for us what they think they need in terms of CT’s, both at a high level (just name and business purpose) as well as columns and type of data they would store in the column.  We don’t ask them to define column data types in MOSS terms, but business terms. 

In Summary:

We’ve created a sandbox environment that we can use to demonstrate some core MOSS features whose appeal are enterprise-wide. 

We have modeled easily understood and common business entities so that users can focus on MOSS and not get bogged down on the entities / examples themselves.

Business users walk away from theses sessions with "homework" in the form of excel documents which they are now competent to fill out and use for designing their own first-cut content types.

Finally, as we perform demos over time, the client’s team members themselves become more able to carry forward, do the demo’s themselves and generally free up the rest of us up to work on more complex issues, such as global taxonomy, complex workflows, BDC and the like.

Learning Agile // Scrum

I asked for some advice today on good resources for getting started with learning Agile and Scrum.  Here is a summary of the response.  I trust the sources but I don’t know that this is comprehensive (I’m sure it is not).

I may have transcribed some of this incorrectly.

Multiple people provided responses and Agile Project Management by Ken Scwaber is the consistent "first dive" recommendation.

Personalities:

  • Ken Schwaber
  • Mike Cohn

Books:

  • Agile Project Management with Scrum by Ken Schwaber.
  • Lean Software Development: An Agile Toolkit for Software Development Managers by Mary and Tom Poppendieck.
  • "anything by Mike Cohn"
  • Agile Retrospectives by Ken Schwaber, Diana Larsen, Esther Derby.

Links:

MOSS advanced search customization — Case does matter in advanced search XSLT

I don’t modify advanced search XSLT very often, so it seems like I’m climbing small hills every time.

My newest lesson is this: Case matters when referencing a column. In my advanced search, I have columns defined as this:

<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <
Columns>
    <
Column Name="GafTrainingInvoiceNumber" />
    <
Column Name="GafTrainingInvoiceLocation" />
    <
Column Name="WorkId"/>
    <
Column Name="Rank"/>
    <
Column Name="Title"/>
    <
Column Name="Author"/>
    <
Column Name="Size"/>
    <
Column Name="Path"/>
    <
Column Name="Description"/>
    <
Column Name="Write"/>
    <
Column Name="SiteName"/>
    <
Column Name="CollapsingStatus"/>
    <
Column Name="HitHighlightedSummary"/>
    <
Column Name="HitHighlightedProperties"/>
    <
Column Name="ContentClass"/>
    <
Column Name="IsDocument"/>
    <
Column Name="PictureThumbnailURL"/>
  </
Columns>
</
root>

The XLST that displays the invoice number and invoice location had been:

    <p>
      Training Invoice Number: <xsl:value-of select="GafTrainingInvoiceNumber"/>
      <
br></br>
      Training Invoice Location: <xsl:value-of select="GafTrainingInvoiceLocation"/>
    </
p>

However, the select has to reference the property in all lower case, as in:

    <p>
      Training Invoice Number: <xsl:value-of select="gaftraininginvoicenumber"/>
      <
br></br>
      Training Invoice Location: <xsl:value-of select="gaftraininginvoicelocation"/>
    </
p>

    
 

Until I corrected that, search results showed the labels (i.e. "Training Invoice Number") but no data.

 

MOSS: Functional Example – Custom Data Type

Business Scenario:

Enterprise-wide implementation of MOSS for manufacturing company with 30+ sites and a few dozen corporate departments.

Business Objective:

Despite a multitude of business groups (departments, locations, etc), certain data should be maintained at a global level. For example, an authoritative master list of all physical locations of the company (e.g. manufacturing facilities, warehouse locations, sales offices) should be maintained in a central location.

Technical Problem:

The enterprise taxonomy was implemented using multiple site collections. We would have liked to create the authoritative list of physical locations in a custom WSS list. Then, when we needed to have a column in a content type (or a column added to a list or doc library) that contained corporate locations, we would create a column using the "lookup" datatype and point to this master list.

Unfortunately, lookup datatypes must access a source list "locally" meaning that our authoritative list cannot span site collections.

Technical Solution:

Implement a new custom data type implemented based on SPField and represented as a DropDownList in the UI whose ListItems populate from the master WSS list.

We created a new site collection called "http://localhost/EnterpriseData". There, we created a custom list named "Corporate Locations". This list just uses the standard "Title" field to contain the list of actual corporate locations.

One follows several discrete steps to create a custom data type in WSS. They are:

  1. Define a class which inherits from SPField (one may inherit from other fields if required).

Here is the code for that:

    public class XYZZYCorporateLocationField : SPFieldText
    {
        public XYZZYCorporateLocationField
            (SPFieldCollection fields, string typeName, string displayName)
            : base(fields, typeName, displayName) { }

        public XYZZYCorporateLocationField
                    (SPFieldCollection fields, string displayName)
            : base(fields, displayName) { }

        public override BaseFieldControl FieldRenderingControl
        {
            get
            {
                BaseFieldControl control = new XYZZYCorporateLocationFieldControl();
                control.FieldName = this.InternalName;
                return control;
            } //get
        } // fieldrenderingcontrol

        public override string GetValidatedString(object value)
        {
            if (this.Required || value.ToString().Equals(String.Empty))
            {
                throw new SPFieldValidationException ("Department is not assigned.");
            }
            return base.GetValidatedString(value);
        } // getvalidatedstring

      } // XYZZYCorporateLocation

  1. Define another class that inherits from the base field control, as in:

    public class XYZZYCorporateLocationFieldControl : BaseFieldControl
    {
        protected DropDownList XYZZYCorporateLocationSelector;
        
        protected override string DefaultTemplateName
        {
            get
            {
                return "XYZZYCorporateLocationFieldControl";
            }
        } // DefaultTemplateName

        public override object Value
        {
            get
            {
                EnsureChildControls();
                return this.XYZZYCorporateLocationSelector.SelectedValue;
            } // get
            set
            {
                EnsureChildControls();
                this.XYZZYCorporateLocationSelector.SelectedValue = (string)this.ItemFieldValue;
            } // set
        } // override object Value

        protected override void CreateChildControls()
        {

            if (this.Field == null || this.ControlMode == SPControlMode.Display)
                return;

            base.CreateChildControls();

            this.XYZZYCorporateLocationSelector =
                (DropDownList)TemplateContainer.FindControl("XYZZYCorporateLocationSelector");

            if (this.XYZZYCorporateLocationSelector == null)
                throw new Exception("ERROR: Cannot load .ASCX file!");

            if (!this.Page.IsPostBack)
            {

                using (SPSite site = new SPSite("http://localhost/enterprisedata"))
                {
                    using (SPWeb web = site.OpenWeb())
                    {

                        SPList currentList = web.Lists["Corporate Locations"];

                        foreach (SPItem XYZZYCorporateLocation in currentList.Items)
                        {
                            if (XYZZYCorporateLocation["Title"] == nullcontinue;

                            string theTitle;
                            theTitle = XYZZYCorporateLocation["Title"].ToString();

                            this.XYZZYCorporateLocationSelector.Items.Add  
                                (new ListItem(theTitle, theTitle));

                        } // foreach

                    } // using spweb web = site.openweb()
                } // using spsite site = new spsite("http://localhost/enterprisedata")

            } // if not a postback

        } // CreateChildControls

    } // XYZZYCorporateLocationFieldControl

The above code basically implements the logic for populating the DropDownList with values from the WSS custom list located at http://localhost/enterprisedata and named "Corporate Departments".

I defined both classes in a single .cs file, compiled it and put it into the GAC (strong required, of course).

  1. Implement a control template (.ascx) as shown:

     

<%@ Control Language="C#" Inherits="Microsoft.SharePoint.Portal.ServerAdmin.CreateSiteCollectionPanel1,Microsoft.SharePoint.Portal,Version=12.0.0.0,Culture=neutral,PublicKeyToken=71e9bce111e9429c"   compilationMode="Always" %>
<%
@ Register Tagprefix="wssawc" Namespace="Microsoft.SharePoint.WebControls" Assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %> <%@ Register Tagprefix="SharePoint" Namespace="Microsoft.SharePoint.WebControls" Assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<SharePoint:RenderingTemplate ID="XYZZYCorporateLocationFieldControl" runat="server">
  <Template>
    <asp:DropDownList ID="XYZZYCorporateLocationSelector" runat="server" />
  </Template>
</
SharePoint:RenderingTemplate>

The above is saved into c:\program files\common files\microsoft shared\web server extensions\12\controltemplates.

  1. Finally, we create an XML file to save into the …..\12\XML directory. This is CAML that defines our custom data type and for my example, looks like this:

<?xml version="1.0" encoding="utf-8" ?>
<
FieldTypes>
  <
FieldType>
    <
Field Name="TypeName">CorporateLocations</Field>
    <
Field Name="ParentType">Text</Field>
    <
Field Name="TypeDisplayName">Corporate Locations</Field>
    <
Field Name="TypeShortDescription">All XYZZY Corporate locations including manufacturing or other facilities.</Field>
    <
Field Name="UserCreatable">TRUE</Field>
    <
Field Name="ShowInListCreate">TRUE</Field>
    <
Field Name="ShowInDocumentLibraryCreate">TRUE</Field>
    <
Field Name="ShowInSurveyCreate">TRUE</Field>
    <
Field Name="ShowInColumnTemplateCreate">TRUE</Field>
    <
Field Name="FieldTypeClass">Conchango.XYZZYCorporateLocationField, XYZZYCorporateLocationField, Version=1.0.0.0, Culture=neutral, PublicKeyToken=b0b19e85410990c4</Field>
    <
RenderPattern Name="DisplayPattern">
      <
Switch>
        <
Expr>
          <
Column />
        </
Expr>

        <Case Value=""/>

        <Default>
          <
HTML>
            <![CDATA[
<span style="color:Red"><b>]]>
          </
HTML>
          
          <
Column SubColumnNumber="0" HTMLEncode="TRUE"/>

          <HTML><![CDATA[</b></span>]]></HTML>
          
        </
Default>
      </
Switch>
      
    </
RenderPattern>
  </
FieldType>
</
FieldTypes>
This XML file adds the custom data type to the WSS "library" and matches it up against the GAC’d assembly.

After moving all these bits into place, iisreset on the server and it should all start working nicely.

WSS: Technique for creating CAML field definitions.

Additional category: CAML

Here is a great posting by a fellow named "craig" on a technique for finding CAML definitions for field content types based off real live definitions from a site.

His posting says it all. In brief:

  1. Create a content type.
  2. Associate it with a list.
  3. Open up the list with SharePoint Designer.
  4. Export to a "personal web package".
  5. Rename to a .cab.
  6. Extract the manifest.
  7. Find your content type and associated CAML.

 

WSS: Summary steps to enable useful Features/Elements/etc. Intellisense in VS 2005

Additional categories: Visual Studio 2005

To enable useful intellisense for Features, elements, etc in visual studio 2005:

  1. Access a WSS server.
  2. Navigate to "c:\program files\common files\microsoft shared\web server extensions\12\TEMPLATE\XML"
  3. Open another windows explorer pointing to: "C:\Program Files\Microsoft Visual Studio 8\Xml\Schemas"
  4. Copy the following files from the WSS server to your VS 2005 schemas directory:
    1. Wss.xsd
    2. CamlQuery.xsd
    3. CamlView.xsd
    4. CoreDefintions.xsd
  5. Restart VS 2005
  6. Add a new XML file to a project.
  7. Click in the body of the XML file.
  8. In the properties pane, click on "Schemas" and pick "wss.xsd" from the choices. (It’s not necessary to select other xsd’s since they are referenced from wss.xsd).

Intellisense is now enabled for that XML document.

See here for more information on this subject and for instructions on how to automatically associate WSS intellisense with any XML file.

WSS exam 70-541, Microsoft Windows SharePoint Services 3.0 – Application Development

I took and passed the above mentioned test this morning. I found the exam to be difficult and fair.

There is a relative dearth of information on this exam on the web. I’m not sure why.

I obviously won’t get into any detail about the exam I took, but I think I can safely say the following:

  1. Trust this link: http://www.microsoft.com/learning/exams/70-541.mspx.

    It lists what you need to know to pass the exam and it’s, IMO, very accurate.

  2. The link also recommends Inside Microsoft Windows SharePoint Services 3.0 by Ted Pattison & Daniel Larson. This book covers nearly all the subjects that the test addresses. I found it to be great in and of itself beyond simple exam prep. It provides great examples and really got me thinking about some new and interesting things to try. If you want to skip a few bits in the book, just cross-reference the book’s TOC with the items in the link from above.
  3. Nothing beats actual hands-on experience. If you have time and interest, follow along with the examples in the book and then experiment with them. You’ll have an easier time on the exam as well as really learn WSS application programming.

</end>Subscribe to my blog!