Depurar el complemento con el registro en tiempo de ejecución

  • Artículo

Puede usar el registro en tiempo de ejecución para depurar el manifiesto del complemento, así como varios errores de instalación graves. Esta característica puede ayudarle a identificar y corregir los problemas del manifiesto que no se detectan mediante la validación de esquema XSD, como identificadores de recursos que no coinciden. El registro en tiempo de ejecución es especialmente útil para depurar complementos que implementan comandos de complemento y funciones personalizadas de Excel.

Nota:

La característica de registro en tiempo de ejecución está disponible actualmente para Office 2016 o posterior en el escritorio.

Importante

El registro de tiempo de ejecución afecta al rendimiento. Actívelo solamente cuando necesite depurar problemas en el manifiesto del complemento.

Usar el registro en tiempo de ejecución desde la línea de comandos

Habilitar el registro en tiempo de ejecución desde la línea de comandos es la manera más rápida de usar esta herramienta de registro. Estos usan npx, que se proporciona de forma predeterminada como parte de npm@5.2.0+. Si tiene una versión anterior de npm, pruebe el Registro en tiempo de ejecución en Windows o las Instrucciones de registro en tiempo de ejecución en Mac u instale npx.

Importante

La herramienta office-addin-dev-settings no se admite en Mac.

  • Habilitar el registro en tiempo de ejecución:

    npx office-addin-dev-settings runtime-log --enable

  • Para habilitar el registro en tiempo de ejecución solo para un archivo específico, utilice el mismo comando con un nombre de archivo:

    npx office-addin-dev-settings runtime-log --enable [filename.txt]

  • Desabilitar el registro en tiempo de ejecución:

    npx office-addin-dev-settings runtime-log --disable

  • Mostrar si está habilitado el registro en tiempo de ejecución:

    npx office-addin-dev-settings runtime-log

  • Mostrar la ayuda desde la línea de comandos para el registro en tiempo de ejecución:

    npx office-addin-dev-settings runtime-log --help

Registro de tiempo de ejecución en Windows

  1. Asegúrese de que está ejecutando la compilación 16.0.7019 o posterior de Office 2016 para equipos de escritorio.

  2. Agregue la clave de registro RuntimeLogging dentro de HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Developer\.

    Nota:

    Si la Developer clave (carpeta) aún no existe en HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\, complete los pasos siguientes para crearla.

    1. Haga clic derecho en la clave WEF (carpeta) y seleccione Nuevo>Clave.
    2. Denomine a la nueva clave Desarrollador.

  3. Establezca el valor predeterminado de la clave RuntimeLogging en la ruta de acceso completa del archivo donde quiere que se escriba el registro. El ejemplo siguiente que se ejecuta en un .reg archivo establece el registro en la C:\ClientLogs\log.txt carpeta .

    [HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\RuntimeLogging]
@="C:\\ClientLogs\\log.txt"`

    Nota:

    El directorio en el que se escribirá el archivo de registro ya debe existir y debe tener permisos de escritura al mismo.

La imagen siguiente muestra el aspecto que debe tener el registro. Para desactivar la función, quite la clave RuntimeLogging del registro.

Editor del Registro con una clave del Registro RuntimeLogging.

Registro de tiempo de ejecución en Mac

  1. Asegúrese de que ejecuta la compilación de escritorio de Office 2016 16.27.19071500 o posterior.

  2. Abra Terminal y establezca su preferencia de registro de tiempo de ejecución con el comando defaults:

    defaults write <bundle id> CEFRuntimeLoggingFile -string <file_name>

    <bundle id> identifica el anfitrión en el que se habilitará el registro de tiempo de ejecución. <file_name> es el nombre del archivo de texto en el que se escribirá el registro.

    Establezca <bundle id> en uno de los siguientes valores para habilitar el registro en tiempo de ejecución para la aplicación correspondiente.

    • com.microsoft.Word
    • com.microsoft.Excel
    • com.microsoft.Powerpoint
    • com.microsoft.Outlook

En el ejemplo siguiente se habilita el registro en tiempo de ejecución para Word y, a continuación, se abre el archivo de registro.

defaults write com.microsoft.Word CEFRuntimeLoggingFile -string "runtime_logs.txt"
open ~/library/Containers/com.microsoft.Word/Data/runtime_logs.txt

Nota:

Tendrá que reiniciar Office después de ejecutar el comando defaults para habilitar el registro del tiempo de ejecución.

Para desactivar el registro del tiempo de ejecución, use el comando defaults delete:

defaults delete <bundle id> CEFRuntimeLoggingFile

En el ejemplo siguiente se desactivará el registro en tiempo de ejecución para Word.

defaults delete com.microsoft.Word CEFRuntimeLoggingFile

Usar el registro del tiempo de ejecución para solucionar problemas con el manifiesto

Para usar el registro de tiempo de ejecución para solucionar problemas al cargar un complemento:

  1. Transferir localmente el complemento para hacer pruebas.

    Nota:

    Recomendamos que solo transfiera localmente el complemento que va a probar para minimizar el número de mensajes en el archivo de registro.

  2. Si no ocurre nada y no ve el complemento (y no aparece en el cuadro de diálogo Complementos), abra el archivo de registro.

  3. Busque en el archivo de registro el identificador del complemento, que habrá definido en el manifiesto. En el archivo de registro, este identificador lleva la etiqueta SolutionId.

Problemas conocidos con el registro de tiempo de ejecución

Puede ocurrir que los mensajes del archivo de registro resulten confusos o estén clasificados de forma incorrecta. Por ejemplo:

  • El mensaje Medium Current host not in add-in's host list seguido de Unexpected Parsed manifest targeting different host está clasificado incorrectamente como un error.

  • Si ve el mensaje Unexpected Add-in is missing required manifest fields DisplayName y no contiene un identificador SolutionId, lo más probable es que el error no esté relacionado con el complemento que está depurando.

  • Todos los mensajes Monitorable son errores esperados desde un punto de vista del sistema. A veces, indican un problema con el manifiesto, como un elemento mal escrito que se omitió, pero que no hizo que el manifiesto produjera errores.

Consulte también