Depuración de soluciones de SharePoint

Puede depurar soluciones de SharePoint mediante el depurador de Visual Studio. Al iniciar la depuración, Visual Studio implementa los archivos de proyecto en el servidor de SharePoint y, a continuación, abre una instancia del sitio de SharePoint en el explorador web. En las secciones siguientes se explica cómo depurar aplicaciones de SharePoint en Visual Studio.

• Habilitar depuración

• Proceso de depuración e implementación de F5

• Características del proyecto de SharePoint

• Flujos de trabajo de depuración

• Receptores de eventos de características de depuración

• Habilitar información de depuración mejorada

Habilitar la depuración

Al depurar por primera vez una solución de SharePoint en Visual Studio, un cuadro de diálogo le alerta de que el archivo web.config no está configurado para habilitar la depuración. (El archivo web.config se crea al instalar el servidor de SharePoint. Para obtener más información, vea Trabajar con archivos de Web.config). El cuadro de diálogo le ofrece la opción de ejecutar el proyecto sin depurar ni modificar el archivo web.config para habilitar la depuración. Si elige la primera opción, el proyecto se ejecuta normalmente. Si elige la segunda opción, el archivo web.config está configurado para:

• Activar la pila de llamadas (CallStack="true")

• Deshabilitar errores personalizados en Visual Studio (<customErrors mode="Off" />)

• Habilitar la depuración de compilación (<compilation debug="true">)

  El archivo web.config resultante sigue:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <configuration>
        ...
        <SharePoint>
            <SafeMode MaxControls="200"
                CallStack="true"
                DirectFileDependencies="10"
                TotalFileDependencies="50"
                AllowPageLevelTrace="false">
                ...
            </SafeMode>
        ...
        </SharePoint>
        <system.web>
            ...
            <customErrors mode="Off" />
            ...
            <compilation debug="true">
            ...
            </compilation>
            ...
        </system.web>
        ...
    </configuration>

Para invertir los cambios y deshabilitar la depuración, cambie el siguiente XML en el archivo web.config:

• Desactivar la pila de llamadas (CallStack="false")

• Habilitar errores personalizados en Visual Studio (<customErrors mode="On" />)

• Desactivar la depuración de compilación (<compilation debug="false">)

Proceso de depuración e implementación de F5

Al ejecutar el proyecto de SharePoint en modo de depuración, el proceso de implementación de SharePoint realiza las tareas siguientes:

1. Ejecuta los comandos personalizables de pre-despliegue.

2. Crea un archivo de paquete de solución web (.wsp) mediante comandos de MSBuild. El archivo .wsp incluye todos los archivos y características necesarios. Para obtener más información, consulte Introducción a las soluciones.

3. Si la solución de SharePoint es una solución de granja de servidores, recicla el grupo de aplicaciones de IIS para la dirección URL del sitio especificada. En este paso se liberan los archivos bloqueados por el proceso de trabajo de IIS.

4. Si ya existe una versión anterior del paquete, retira la versión anterior de las características y los archivos del archivo .wsp. Este paso desactiva las características, desinstala el paquete de solución y, a continuación, elimina el paquete de solución en el servidor de SharePoint.

5. Instala la versión actual de las características y archivos en el archivo .wsp. Este paso agrega e instala la solución en el servidor de SharePoint.

6. En el caso de los flujos de trabajo, instala el ensamblado de flujo de trabajo. Puede cambiar su ubicación mediante la propiedad Ubicación del ensamblado .

7. Activa la característica del proyecto en SharePoint si el ámbito es Sitio o Web. Las características en los ámbitos de Farm y WebApplication no están activadas.

8. En el caso de los flujos de trabajo, asocia el flujo de trabajo a la biblioteca, lista o sitio de SharePoint que seleccionó en el Asistente para personalizar SharePoint.

   Nota:

   Esta asociación solo se produce si seleccionó Asociar automáticamente el flujo de trabajo en el asistente.

9. Ejecuta los comandos posteriores a la implementación personalizables.

10. Asocia el depurador de Visual Studio al proceso de Windows SharePoint Services (w3wp.exe). Si el tipo de proyecto le permite cambiar la propiedad Sandboxed Solution y está establecido en true, el depurador se asocia a un proceso diferente (SPUCWorkerProcess.exe). Para más información, consulte Consideraciones sobre soluciones de entorno aislado.

11. Inicia el depurador de JavaScript si la solución de SharePoint es una solución de granja de servidores.

12. Muestra la página de biblioteca, lista o sitio adecuada en el explorador web.

    Visual Studio muestra un mensaje de estado en la ventana Salida una vez completada cada tarea. Si no se puede completar una tarea, Visual Studio muestra un mensaje de error en la ventana Lista de errores.

Características del proyecto de SharePoint

Una característica es una unidad de funcionalidad portátil y modular que simplifica la modificación de sitios mediante definiciones de sitio. También es un paquete de elementos de Windows SharePoint Services (WSS) que se pueden activar para un ámbito específico y que ayuda a los usuarios a lograr un objetivo o tarea concretos. Las plantillas se implementan como características.

Al ejecutar un proyecto en modo de depuración, el proceso de implementación crea una carpeta en el directorio de características en %COMMONPROGRAMFILES%\Microsoft Shared\web server extensions\14\TEMPLATE\FEATURES. Los nombres de características tienen el nombre del proyecto de formato_Featurex, como TestProject_Feature1.

La carpeta de la solución en el directorio de características contiene un archivo de definición de características y un archivo de definición de flujo de trabajo . El archivo de definición de características (Feature.xml) describe los archivos de la característica del proyecto. El archivo de definición de proyecto (Elements.xml) describe la plantilla de proyecto. Elements.xml se puede encontrar en el Explorador de soluciones, pero Feature.xml se genera cuando se crea el paquete de solución. Para obtener más información sobre estos archivos, vea Plantillas de proyecto y elemento de proyecto de SharePoint.

Flujos de trabajo de depuración

Al depurar proyectos de flujo de trabajo, Visual Studio agrega la plantilla de flujo de trabajo (según su tipo) a una biblioteca o a una lista. A continuación, puede iniciar manualmente la plantilla de flujo de trabajo o agregando o actualizando un elemento. Después, puede usar Visual Studio para depurar el flujo de trabajo.

Sin embargo, el proceso de implementación no inicia el flujo de trabajo. Debe iniciar el flujo de trabajo desde el sitio web de SharePoint. También puede iniciar el flujo de trabajo mediante una aplicación cliente como Microsoft Office Word 2010 o mediante código independiente del lado servidor. Use uno de los enfoques especificados en el Asistente para personalizar SharePoint.

Por ejemplo, si especificó que el flujo de trabajo se puede iniciar manualmente, inicie el flujo de trabajo directamente desde el elemento de la biblioteca o lista. Para obtener más información sobre cómo iniciar manualmente un flujo de trabajo, consulte Inicio manual de un flujo de trabajo en un elemento de documento.

Depurar receptores de eventos de funcionalidades

De forma predeterminada, cuando se ejecuta una aplicación de SharePoint de Visual Studio, sus características se activan automáticamente en el servidor de SharePoint. Sin embargo, esto provoca problemas al depurar receptores de eventos de características, ya que cuando Visual Studio activa una característica, se ejecuta en un proceso diferente al del depurador. Esto significa que algunas funcionalidades de depuración, como los puntos de interrupción, no funcionarán correctamente.

Para deshabilitar la activación automática de la característica en SharePoint y permitir la depuración adecuada de receptores de eventos de características, establezca el valor de la propiedad Configuración de implementación activa del proyecto en Sin activación antes de la depuración. Después de empezar a depurar la aplicación de SharePoint en Visual Studio, active manualmente la característica en SharePoint. Para activar la característica, abra el menú Acciones del sitio en SharePoint, elija Configuración del sitio, elija el vínculo Administrar características del sitio y, a continuación, elija el botón Activar situado junto a la característica, para continuar con la depuración como normal.

Habilitar información de depuración mejorada

Debido a las interacciones a veces complejas entre el proceso de Visual Studio (devenv.exe), el proceso de host de SharePoint de Visual Studio (vssphost4.exe), SharePoint y la capa de WCF, diagnosticar errores que se producen al compilar, implementar, etc. puede ser un desafío. Para ayudarle a solucionar este tipo de errores, puede activar la información de depuración mejorada. Para ello, vaya a la siguiente clave del Registro en el Registro de Windows:

HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\11.0\SharePointTools

Si el valor "EnableDiagnostics" REG_DWORD aún no existe, créelo manualmente. Establezca el valor "EnableDiagnostics" en "1".

Al establecer este valor de clave en 1, la información de seguimiento de la pila aparecerá en la ventana Salida siempre que se produzcan errores del sistema del proyecto mientras se ejecuta en Visual Studio. Para deshabilitar la información de depuración mejorada, establezca EnableDiagnostics en 0 o elimine el valor.

Para obtener más información sobre otras claves del Registro de SharePoint, vea Depurar extensiones para las herramientas de SharePoint en Visual Studio.

Contenido relacionado

• Solución de problemas de soluciones de SharePoint