IBM FileNet P8, Versión 5.2            

Personalizar los menús de complementos de Archivo, Insertar y Ayuda

IBM® FileNet P8 Application Integration proporciona soporte para la personalización de los menús emergentes de Archivo, Insertar y Ayuda de Microsoft Outlook, Word, Excel y PowerPoint. Application Integration utiliza complementos COM para ampliar estas aplicaciones añadiendo menús de complemento personalizados. Estos menús personalizados los pueden modificar los desarrolladores mediante el uso de los archivos XML suministrados, que contienen información utilizada por Application Integration para configurar el contenido de los menús para las aplicaciones Microsoft.

Una vez se ha instalado Application Integration, los desarrolladores pueden modificar manualmente el contenido de los archivos XML para poder personalizar los menús de complemento y cumplir los requisitos de sus aplicaciones. Los archivos XML personalizados se pueden copiar posteriormente a otros sistemas de la organización, para ofrecer un medio de control del entorno de aplicación y disponibilidad de características para un usuario o clase de usuario concretos. Cuando se necesite un nuevo cambio para una aplicación determinada, se puede actualizar el correspondiente archivo XML y copiarse de nuevo en los sistemas adecuados.

Técnicas de personalización XML

Los desarrolladores pueden personalizar los menús de complemento como se indica a continuación:
Tabla 1. Lista y describe las distintas formas de personalizar un menú de complemento
Personalizar ... Descripción
Visibilidad Especifique los mandatos y submenús emergentes de Application Integration que deben ser visibles en el menú. Esta técnica permite eliminar completamente un submenú o mandato de un menú para poder controlar la disponibilidad de una cierta característica.
Habilitar estado Especifique los mandatos y submenús emergentes de Application Integration que deben ser visibles pero inhabilitados (inactivos). Esta técnica permite a los desarrolladores controlar si un menú concreto se puede abrir o un mandato se puede ejecutar.
Etiqueta o título Especifique las etiquetas o títulos de los mandatos y submenús emergentes de Application Integration tal como deben aparecer ante el usuario. Por ejemplo, los desarrolladores pueden renombrar el mandato "Checkin" por "Almacenar documento" o agrupar ciertos mandatos en un submenú llamado "Autoría".
Acción de mandato Especifique la acción de Application Integration que debe realizarse cuando se selecciona un mandato de Application Integration.
Nota: No puede especificar mandatos de proveedor.
Jerarquía de menú Especifique la disposición de los mandatos de Application Integration en el menú, incluyendo el orden de los mandatos y si están contenidos en una jerarquía de carpetas de submenús emergentes.

Nombres de archivo y ubicaciones XML

Durante la instalación de Application Integration, los archivos XML se escriben en el directorio de instalación (el predeterminado es C:\Archivos de programa\FileNet\AppInt\). Siempre que se abre una de las aplicaciones Microsoft soportadas, Application Integration busca el correspondiente archivo XML en el directorio de instalación y configura el menú de complemento de dicha aplicación de acuerdo con las especificaciones contenidas en el archivo XML. Si Application Integration no puede localizar los archivos XML en el directorio de instalación, intenta reunir los archivos en el directorio del módulo. (El directorio del módulo es donde se almacenan habitualmente las aplicaciones Microsoft Office, por omisión en C:\Archivos de programa\Microsoft Office\Office.)

PRECAUCIÓN:
Mientras que los desarrolladores pueden modificar el contenido de los archivos XML, los nombres de los archivos XML no deben cambiarse y los archivos deben estar ubicados en el directorio de instalación o del módulo para que Application Integration pueda localizar y utilizar los archivos XML para configurar los menús de complemento.
En la siguiente tabla se identifican los nombres de los archivos XML, las aplicaciones Microsoft Office afectadas por cada archivo XML y las versiones soportadas de cada aplicación.
Tabla 2. Lista de cada nombre de archivo XML junto con las correspondientes aplicaciones Microsoft Office y las versiones soportadas de dichas aplicaciones.
Nombre de archivo XML Aplicación correspondiente Versiones soportadas
FnAppIntExcelMenus.xml Excel 2003, 2007, 2010
FnAppIntOutlookMenus.xml Outlook Explorer (ventana examinar elemento)

Outlook Inspector (ventana editar elemento)

2003, 2007, 2010
FnAppIntPowerPointMenus.xml PowerPoint 2003, 2007, 2010
FnAppIntWordMenus.xml Word 2003, 2007, 2010

Consideraciones para la modificación de XML

Deben considerarse los siguientes puntos antes de modificar los archivos XML:
  • Aunque los archivos XML se instalan como de sólo lectura, los desarrolladores pueden modificar los permisos de archivo para hacerlos grabables.
  • Los archivos XML proporcionados por IBM suministran la sintaxis y el uso correctos para especificar los menús de complemento y sus contenidos. Los desarrolladores deben seguir de cerca el formato XML y la sintaxis de los parámetros que se proporciona en dichos archivos. Asimismo, los desarrolladores pueden hacer una copia de seguridad de los archivos XML originales antes de implementar modificaciones. Esto facilita la depuración y resolución de errores potenciales de sintaxis en los archivos modificados.
  • Para poder configurar los menús de complemento, Application Integration busca los archivos XML por su nombre en el directorio de instalación. Mientras que los desarrolladores pueden modificar el contenido de los archivos XML, los nombres de los archivos XML no deben cambiarse y los archivos deben estar ubicados en el directorio de instalación o del módulo para que Application Integration pueda localizar y utilizar los archivos XML para configurar los menús de complemento.
  • Siempre que se instala Application Integration, incluyendo los fixpacks, se escriben los archivos XML originales en el directorio de instalación. Como consecuencia, es posible que se sobrescriban los archivos XML personalizados. Por lo tanto, los desarrolladores pueden realizar copias de seguridad de sus archivos XML modificados y guardarlos utilizando nombres de archivo exclusivos o en una carpeta exclusiva. Esto permite restaurar rápidamente los archivos XML personalizados si es necesario.

Esquema de menús de complemento XML

La estructura básica del esquema XML de los menús de complemento es como se indica a continuación:
  • addInMenusConfiguration - objeto de nivel superior del esquema que identifica que los siguientes objetos XML describen los menús de complemento para una aplicación. Este objeto también especifica la versión del esquema que se emplea.
  • applicationName - identifica la aplicación de destino para la que se configuran menús de complemento.
  • applicationVersion - especifica las versiones soportadas de la aplicación de destino.
  • addInMenusDefinition - cada objeto addInMenusConfiguration consiste en uno (o varios en el caso de Microsoft Outlook) de estos objetos, que contienen los objetos que especifican cómo debe configurarse cada menú de complemento (Archivo, Insertar o Ayuda) para la aplicación. Este objeto también especifica el tipo de menú de complemento que debe crearse. Application Integration soporta los siguientes tipos: main para Word, Excel y PowerPoint, y explorer e inspector para Outlook.
  • addInMenuItem - cada objeto addInMenusDefinition consiste en uno o varios de estos objetos, que describen la jerarquía de submenú y el comportamiento de botón de mandato de cada menú. Esto se logra mediante el uso del código itemType, que se puede establecer en popup o button.
    • Cuando itemType="popup", un objeto addInMenuItem puede contener un list de sus hijos de objeto addInMenuItem propio y, de este modo, permitir que se cree una estructura de submenú. Esta estructura jerárquica se puede repetir hasta cualquier profundidad necesaria para lograr los requisitos de la organización.
    • Cuando itemType="button", la estructura XML termina ya que sólo los elementos de menú popup puede tener elementos de menú hijos.
  • setting - cada objeto addInMenuItem (popup o button) contiene un número de códigos setting que definen el aspecto y el comportamiento de los submenús o botones, tales como una descripción del elemento de menú, la etiqueta o título visible, la posición de inserción del menú y la correspondiente acción de Application Integration a ejecutar cuando se abra o se seleccione el elemento de menú. La sección Códigos setting proporciona detalles completos de los códigos setting.

Para tener un ejemplo de cómo se utilizan estos códigos en el esquema XML, consulte Ejemplo de esquema XML.

Códigos setting

Cada objeto addInMenuItem utiliza códigos setting para definir el aspecto y comportamiento de los botones de mandato o submenús del menú de complemento. La sintaxis del código varía en función de la key que se esté definiendo. Por ejemplo, algunas key requieren el campo type, mientras que otras no:

<setting key="itemType">popup</setting>
<setting key="parent"
type="menuId">30002</setting>

En la tabla siguiente, cuando un key no requiere el uso del campo type o no necesita un valor especificado, la entrada de la columna Type o Value es "No aplicable". Cuando el valor de la key no es una variable de Application Integration conocida, por ejemplo popup o button, la entrada de la columna Valor aparece en cursiva; por ejemplo, 30002. Asimismo, cuando no se necesita una key, la entrada en la columna Descripción contiene el indicador [Opcional].

Application Integration soporta los siguientes códigos setting.
Tabla 3. Lista de cada clave, junto con su tipo, valor y descripción.
Clave Tipo Valor Descripción
itemType No aplicable popup Indica que el elemento de menú de complemento es un submenú emergente con hijos, que pueden incluir botones de mandato y submenús emergentes adicionales.
  No aplicable botón Indica que el elemento de menú de complemento es un botón de mandato sin hijos.
description No aplicable Menú Archivo P8 [Opcional] Proporciona una descripción del elemento de menú de complemento sólo a efectos informativos; esta descripción no es visible al usuario.
label enum eOpenSubMenuName Suministra la etiqueta o título visible del elemento de menú de complemento utilizando una de las siguientes constantes de enumeración:
  • eFileMenuName
  • eOpenButtonName
  • eOpenSubMenuName
  • eOpenMyCheckoutsButtonName
  • eOpenSelectItemButtonName
  • eAddDocumentButtonName
  • eAddDocumentSubMenuName
  • eAddDocumentUseWizardButtonName
  • eAddDocumentSelectTemplateButtonName
  • eAddFolderButtonName
  • eCheckinSubMenuName
  • eCheckinQuickButtonName
  • eCheckinUseWizardButtonName
  • eTasksMyInboxButtonName
  • eSaveButtonName
  • eCancelCheckoutButtonName
  • ePropertiesButtonName
  • eLogoffButtonName
  • eInsertMenuName
  • eInsertButtonName
  • eInsertHyperlinkButtonName
  • eInsertPropPageButtonName
  • eInsertPropertyButtonName
  • eRefreshPropertyButtonName
  • eDeletePropertyButtonName
  • eHelpButtonName
  resourceID 119 Suministra la etiqueta o título visible del elemento de menú de complemento, especificando un valor entero que corresponde al ID de recurso definido en un archivo de localización de recursos.
  text Incorporar... Suministra la etiqueta o título visible del elemento de menú de complemento que proporciona la serie de texto real.
visible No aplicable verdadero Especifica que el elemento de menú de complemento (y sus hijos si el elemento de menú es un submenú emergente) es visible al usuario.
    false Especifica que el elemento de menú de complemento (y sus hijos si el elemento de menú es un submenú emergente) no es visible al usuario (es decir, el elemento de menú no aparece en el menú de complemento).
enabled No aplicable verdadero Especifica que el elemento de menú de complemento está habilitado, lo que hace posible que el usuario pueda abrir el submenú emergente o seleccionar botones de mandatos.
    False Especifica que el usuario no puede abrir o seleccionar el elemento de menú de complemento (es decir, el elemento de menú está inhabilitado en el menú de complemento).
parent menuId 30002 Proporciona el valor de "menuId" del menú padre del elemento de menú de complemento. Cuando un elemento de menú es un submenú emergente, este valor generalmente es el ID de control de un menú emergente existente de Microsoft Office. Para obtener más información sobre los IDs de menú de las aplicaciones Microsoft Office, consulte la Microsoft Office Developers Guide for Office 2003/XP/2007.
  topLevel No aplicable Cuando el elemento de menú de complemento es un submenú emergente, este par clave-tipo indica que el submenú se sitúa en la barra de menú de nivel superior de la aplicación.
Nota: Este par clave-tipo sólo es válidos para submenús emergentes.
  No aplicable No aplicable Cuando el elemento de menú de complemento es un botón de mandato, el padre es implícito en el XML especificado mediante el uso del código <list key="children">. Por lo tanto, no es necesario especificar el padre en esta ubicación de setting en el XML.
Nota: Este par clave-tipo sólo es válido para botones de mandato.
location No aplicable 4 Especifica la posición de inserción de este elemento de menú de complemento en el menú padre. Un valor de -1 indica que el elemento de menú se añade a la parte inferior del menú existente.
Nota: Este valor indica la posición deseable del elemento de menú en el menú emergente padre.
command standard
OfficeAdd-In.
OpenSelection
Especifica la operación de Application Integration que se lleva a cabo cuando el usuario selecciona un botón de mandato. Puede especificarse una de las siguientes constantes de enumeración:
  • OfficeAdd-In.AddFolderUseAddWizard
  • OfficeAdd-In.OpenMyCheckouts
  • OfficeAdd-In.OpenSelectItem
  • OfficeAdd-In.AddDocumentUseAddWizard
  • OfficeAdd-In.AddDocumentSelectTemplate
  • OfficeAdd-In.CheckinDocumentUseCheckinWizard
  • OfficeAdd-In.CheckinDocumentQuickCheckin
  • OfficeAdd-In.Save
  • OfficeAdd-In.CancelCheckout
  • OfficeAdd-In.GetInfo
  • OfficeAdd-In.TasksMyInbox
  • OfficeAdd-In.Logoff
  • OfficeAdd-In.Help
  • OfficeAdd-In.InsertItem
  • OfficeAdd-In.InsertProperty
  • OfficeAdd-In.RefreshProperties
  • OfficeAdd-In.DeleteProperties
  • OfficeAdd-In.InsertHyperlink
  • OfficeAdd-In.InsertPropertiesPage
  standard No aplicable Cuando el elemento de menú de complemento es un submenú emergente, se ignoran las pulsaciones de ratón en el menú. Por lo tanto, no es necesario especificar el mandato en esta ubicación de setting en el XML.
Nota: Este par clave-tipo sólo es válidos para submenús emergentes.

Para tener un ejemplo de cómo se utilizan estos códigos en el esquema XML, consulte Ejemplo de esquema XML.

Ejemplo de esquema XML

El siguiente fragmento de código ilustra la estructura básica del esquema XML de los menús de complemento para la aplicación Excel:
<?xml version="1.0" ?>
 <!-- IBM FileNet P8 Application Integration 4.0 Excel Add-In Menus-->
 <!-- Add-In Menus - Configuration Info -->
 <object key="addInMenusConfiguration" version="1.0">
 <setting key="applicationName">Excel</setting>
 <array key="applicationVersion">
 <value>2003</value>
 <value>2007</value>
 <value>2010</value>
 </array>
 <!-- Add-In Menus - Main Menu Definitions -->
 <object key="addInMenusDefinition" type="main">
 <list key="children">
 <!-- P8 File Menu -->
 <object key="addInMenuItem">
 <setting key="itemType">popup</setting>
 ...
 <list key="children">
 <!-- Open Document SubMenu -->
 <object key="addInMenuItem">
 <setting key="itemType">popup</setting>
 <setting key="description">Submenu of commands for opening documents.</Setting>
 <setting key="label" type="text">Open Document</setting>
 <setting key="visible">true</setting>
 <setting key="enabled">true</setting>
 <setting key="location">3</setting>
 <setting key="command" type="standard"></setting>
 <list key="children">
 <!-- Open Document - My Checkouts... Button -->
 <object key="addInMenuItem">
 <setting key="itemType">button</setting>
 ...
 <list key="children" />
 </object>
 <!-- Open Document - Select Item... Button -->
 <object key="addInMenuItem">
 <setting key="itemType">button</setting>
 ...
 <list key="children" />
 </object>
 </list>
 <list key="children" />
 </object>
 <!-- Add Document SubMenu -->
 <object key="addInMenuItem">
 <setting key="itemType">popup</setting>
 ...
 <list key="children" />
 </object>
 ...
 <!-- Add Folder... Button -->
 <object key="addInMenuItem">
 <setting key="itemType">button</setting>
 <setting key="description">Performs the Add Folder Wizard</setting>
 <setting key="label" type="enum">eAddFolderButtonName</setting>
 <setting key="visible">true</setting>
 <setting key="enabled">true</setting>
 <setting key="parent" type="menuId">30002</setting>
 <setting key="location">1</setting>
 <setting key="command" type="standard">OfficeAdd-In.AddFolderUseAddWizard</setting>
 <list key="children" />
 </object>
 ...
 </list>
 <list key="children" />
 </object>
 <!-- P8 Insert Menu -->
 <object key="addInMenuItem">
 <setting key="itemType">popup</setting>
 ...
 <list key="children">
 ...
 </list>
 <list key="children" />
 </object>
 <!-- P8 Help Menu -->
 <object key="addInMenuItem">
 <setting key="itemType">popup</setting>
 ...
 <list key="children">
 ...
 </list>
 <list key="children" />
 </object>
 </list>
 </object>
 </object>
...


Comentarios

Última actualización: Marzo de 2013
overview_addin_menus.htm

© Copyright IBM Corp. 2013.
Este centro de información utiliza tecnología Eclipse. (http://www.eclipse.org)