IBM FileNet P8, Version 5.1.+            

Personnalisation des menus complémentaires Fichier, Insérer et Aide

IBM® FileNet P8 Application Integration prend en charge la personnalisation des menus en incrustation Fichier, Insertion et Aide de Microsoft Outlook, Word, Excel, et PowerPoint. Application Integration utilise des compléments COM pour étendre ces applications en ajoutant des menus complémentaires personnalisés. Les développeurs peuvent modifier ces menus personnalisés grâce à des fichiers XML fournis, qui contiennent des informations permettant à Application Integration de configurer le contenu des menus pour les applications Microsoft.

Après l'installation d'Application Integration, les développeurs peuvent modifier manuellement le contenu des fichiers XML afin de personnaliser les menus complémentaires et de répondre ainsi aux exigences de leurs applications. Les fichiers XML peuvent alors être copiés dans d'autres systèmes de l'organisation pour permettre un contrôle de la disponibilité des fonctions et environnements d'application pour un utilisateur ou une classe d'utilisateurs en particulier. Chaque fois qu'une application en particulier nécessite une modification, le fichier XML correspondant peut être mis à jour et de nouveau copié sur les systèmes appropriés.

Techniques de personnalisation XML

Les développeurs peuvent personnaliser les menus complémentaires comme suit :
Tableau 1. Répertorie et décrit les divers moyens de personnaliser un menu complémentaire.
Personnalisation des éléments suivants Description
Visibilité Indiquez les commandes Application Integration et les sous-menus contextuels qui doivent apparaître sur le menu. Cette technique permet de supprimer complètement un sous-menu ou une commande d'un menu pour contrôler la disponibilité d'une fonction en particulier.
Etat d'activation Indiquez les commandes Application Integration et les sous-menus contextuels qui doivent apparaître mais être désactivés (en grisé). Cette technique permet aux développeurs de déterminer si un menu en particulier peut être ouvert ou une commande exécutée.
Etiquette ou légende Indiquez les étiquettes ou les légendes des commandes Application Integration et des sous-menus contextuels telles qu'elles doivent apparaître sur le poste de l'utilisateur. Par exemple, les développeurs peuvent renommer la commande "Checkin" en "Store Document" ou regrouper certaines commandes sur un sous-menu appelé "Création".
Action liée à une commande Indique l'action Application Integration qui doit être effectuée lorsqu'une commande Application Integration est sélectionnée.
Remarque : Vous ne pouvez pas indiquer de commandes des fournisseurs.
Hiérarchie des menus Indiquez la disposition des commandes Application Integration sur le menu, y compris leur ordre d'apparition et si elles sont contenues dans une arborescence de dossiers de sous-menus contextuels.

Noms et emplacement des fichiers XML

Pendant l'installation d'Application Integration, les fichiers XML sont écrits dans le répertoire d'installation (par défaut C:\Program Files\FileNet\AppInt\). Chaque fois qu'une des applications Microsoft prises en charge est ouverte, Application Integration recherche le fichier XML dans le répertoire d'installation, puis configure le menu de cette application en fonction des spécifications contenues dans ce fichier. Si Application Integration ne peut pas localiser le fichier XML dans le répertoire d'installation, il essaie de regrouper les fichiers du répertoire Module. (Le répertoire Module est l'emplacement habituel de stockage des applications Microsoft Office, par défaut dans C:\Program Files\Microsoft Office\Office.)

ATTENTION :
Alors que les développeurs peuvent modifier le contenu des fichiers XML, les noms de ces fichiers ne doivent pas être modifiés et ces derniers doivent se trouver dans le répertoire d'installation ou de module afin qu'Application Integration puisse les repérer et les utiliser pour configurer les menus complémentaires.
Le tableau suivant identifie les fichiers XML, les applications Microsoft Office affectées par chacun d'entre eux et les versions de chaque application.
Tableau 2. Répertorie chaque nom de fichier XML avec les applications Microsoft Office correspondantes et les versons prises en charge de ces applications.
Nom du fichier XML Application correspondante Versions prises en charge
FnAppIntExcelMenus.xml Excel 2003, 2007, 2010
FnAppIntOutlookMenus.xml Outlook Explorer (fenêtre d'exploration des éléments)

Outlook Inspector (fenêtre d'édition des éléments)

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

Remarques sur les modifications des fichiers XML

Les points doivent être pris en considération avant la modification des fichiers XML :
  • Bien que les fichiers XML soient en lecture seule à l'installation, les développeurs peuvent modifier les droits d'accès à ces fichiers pour les rendre accessibles en lecture et en écriture.
  • Les fichiers XML fournis par IBM fournissent la syntaxe correcte permettant d'indiquer les menus complémentaires et leur contenu. Les développeurs doivent respecter scrupuleusement la syntaxe des paramètres et du formatage XML fournie dans ces fichiers. En outre, ils peuvent sauvegarder les fichiers XML d'origine avant d'implémenter des modifications. Cela facilite le débogage et la résolution des erreurs de syntaxe éventuelles dans les fichiers modifiés.
  • Afin de configurer les menus complémentaires, Application Integration recherche les fichiers XML par nom dans le répertoire d'installation. Alors que les développeurs peuvent modifier le contenu des fichiers XML, les noms de ces fichiers ne doivent pas être modifiés et ces derniers doivent se trouver dans le répertoire d'installation ou de module afin qu'Application Integration puisse les repérer et les utiliser pour configurer les menus complémentaires.
  • Chaque fois qu'Application Integration est installé, y compris les groupes de correctifs, les fichiers XML sont écrits dans le répertoire d'installation. Ainsi, les fichiers XML personnalisés peuvent être écrasés. Par conséquent, les développeurs peuvent créer des copies de sauvegarde des fichiers XML modifiés et les enregistrer à l'aide de noms de fichier uniques ou dans un dossier unique. Cela permet, si nécessaire, de restaurer rapidement les fichiers XML personnalisés.

Schéma XML des menus complémentaires

La structure de base du schéma XML des menus complémentaires est la suivante :
  • addInMenusConfiguration - objet sommet du schéma qui indique que les objets XML suivants décrivent les menus complémentaires d'une application. Cet objet indique également la version du schéma employé.
  • applicationName - identifie l'application cible pour laquelle les menus complémentaires sont configurés.
  • applicationVersion - indique les versions prises en charge de l'application cible.
  • addInMenusDefinition - chaque objet addInMenusConfiguration comprend un (ou plusieurs dans le cas de Microsoft Outlook) de ces objets qui contiennent les objets indiquant comment chaque menu complémentaire (Fichier, Insertion ou Aide) doit être configuré pour l'application. Cet objet indique également le type de menu complémentaire à créer. Application Integration prend en charge les types suivants : main pour Word, Excel, et PowerPoint, explorer et inspector pour Outlook.
  • addInMenuItem - chaque objet addInMenusDefinition comprend un ou plusieurs objets qui décrivent le comportement de la hiérarchie de sous-menus et des boutons de commande pour chaque menu. Pour cela, la balise itemType peut être définie sur popup ou sur button.
    • Si itemType="popup", un objet addInMenuItem peut contenir une liste de ses propres enfants addInMenuItem, ce qui permet de créer une structure de sous-menus. Cette structure hiérarchique peut être répétée jusqu'au niveau requis par votre organisation.
    • Si itemType="button", la structure XML se termine car seuls les éléments de menu popup (contextuels) peuvent avoir des éléments de menu enfants.
  • setting - chaque objet addInMenuItem (popup ou button) contient un certain nombre de balises setting. Celles-ci définissent l'apparence et le comportement du sous-menu ou du bouton en question, par exemple : description de l'élément de menu, étiquette ou légende visible, position d'insertion du menu et action Application Integration correspondante à exécuter lorsque l'élément de menu est ouvert et sélectionné. La section Balises setting fournit des détails complets sur les balises setting.

Pour avoir un exemple d'utilisation de ces balises dans le schéma XML, voir Exemple de schéma XML.

Balises setting

Chaque objet addInMenuItem utilise des balises setting pour définir l'apparence et le comportement des sous-menus ou des boutons de commande des menus complémentaires. La syntaxe de la balise varie en fonction de la clé (key) définie. Par exemple, certaines clés nécessitent la zone type, contrairement à d'autres :

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

Dans le tableau suivant, lorsqu'une clé ne requiert pas l'utilisation de la zone type ou n'a pas besoin d'une valeur spécifiée, l'entrée dans la colonne Type ou Valeur est "Non applicable". Lorsque la valeur de la clé ne correspond pas à une variable Application Integration connue, comme popup ou button, l'entrée de la colonne Valeur apparaît en italique, par exemple, 30002. En outre, lorsqu'une clé n'est pas obligatoire, l'entrée de la colonne Description contient l'indicateur [Facultatif].

Application Integration prend en charge les balises setting suivantes.
Tableau 3. Répertorie chaque clé avec son type, sa valeur et la description.
Clé Type Valeur Description
itemType Non applicable popup Indique que l'élément de menu complémentaire est un sous-menu contextuel avec des enfants, pouvant inclure des boutons de commande et des sous-menus contextuels supplémentaires.
  Non applicable button Indique que l'élément de menu complémentaire est un bouton de commande sans enfants.
description Non applicable Menu de fichier P8 [Facultatif] Fournit une description de l'élément de menu complémentaire uniquement à titre d'information ; cette description n'est pas visible par l'utilisateur.
label enum eOpenSubMenuName Fournit l'étiquette ou la légende visible pour l'élément de menu complémentaire à l'aide d'une des constantes d'énumération suivantes :
  • 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 Fournit l'étiquette ou la légende visible pour l'élément de menu complémentaire en indiquant une valeur de type entier correspondant à un ID ressource défini dans un fichier de localisation des ressources.
  text Restitution... Fournit l'étiquette ou la légende visible pour l'élément de menu qui fournira la chaîne de texte réelle.
visible Non applicable true Indique que l'élément de menu complémentaire (et les enfants s'il s'agit d'un sous-menu contextuel) est visible par l'utilisateur.
    false Indique que l'élément de menu complémentaire (et les enfants s'il s'agit d'un sous-menu contextuel) n'est pas visible par l'utilisateur, à savoir qu'il n'apparaît pas dans le menu complémentaire.
enabled Non applicable true Indique que l'élément de menu complémentaire est activé, ce qui permet à l'utilisateur d'ouvrir le sous-menu contextuel ou de sélectionner le bouton de commande.
    Non Indique que l'élément de menu complémentaire ne peut pas être ouvert ou sélectionné par l'utilisateur, en d'autres terme, il est désactivé dans le menu complémentaire.
parent menuId 30002 Fournit la valeur "menuId" du menu parent de l'élément de menu complémentaire. Lorsque l'élément de menu est un sous-menu en incrustation, cette valeur est généralement l'ID contrôle d'un menu en incrustation Microsoft Office. Pour plus d'informations sur les ID menu dans les applications Microsoft Office, voir Microsoft Office Developers Guide for Office 2003/XP/2007.
  topLevel Non applicable Lorsque l'élément de menu complémentaire est un sous-menu contextuel, cette paire clé/type indique que le sous-menu est placé sur la barre de menus de niveau supérieur de l'application.
Remarque : Cette paire clé et type est valide uniquement pour les sous-menus contextuels.
  Non applicable Non applicable Lorsque l'élément de menu complémentaire est un bouton de commande, le parent est impliqué dans le fichier XML spécifié via la balise <list key="children">. Par conséquent, aucune spécification de parent n'est obligatoire à cet emplacement setting du fichier XML.
Remarque : Cette paire clé et type est valide uniquement pour les boutons de commande.
emplacement Non applicable 4 Indique la position d'insertion de l'élément de menu complémentaire concerné sur le menu parent. La valeur -1 indique que l'élément de menu est ajouté au bas du menu existant.
Remarque : Cette valeur indique la position souhaitée de l'élément de menu sur le menu contextuel parent.
command standard
OfficeAdd-In.
OpenSelection
Indique l'opération Application Integration à effectuer lorsqu'un bouton de commande est sélectionné par l'utilisateur. Une des constantes d'énumération suivantes peut être indiquée :
  • 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 Non applicable Lorsque l'élément de menu complémentaire est un sous-menu contextuel, les clics sur les menus sont ignorés. Par conséquent, aucune spécification de commande n'est obligatoire à cet emplacement setting du fichier XML.
Remarque : Cette paire clé et type est valide uniquement pour les sous-menus contextuels.

Pour avoir un exemple d'utilisation de ces balises dans le schéma XML, voir Exemple de schéma XML.

Exemple de schéma XML

Le fragment de code suivant illustre la structure de schéma XML de bas pour les menus complémentaires de l'application 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>
...


Commentaires

Dernière mise à jour : Juillet 2011


© Copyright IBM Corp. 2011.
Ce centre de documentation utilise la technologie Eclipse. (http://www.eclipse.org)