IBM FileNet P8, Version 5.2            

Personnalisation des actions Workplace XT

Pour les objets accessibles depuis les menus en incrustation ou depuis les modes d'exploration et de recherche d'IBM® FileNet Workplace XT, l'application présente un ensemble d'opérations ou d'actions réalisables par un utilisateur final sur un type d'objet en particulier. Par exemple, les actions disponibles pour un objet document comprennent la réservation, le téléchargement, la modification du composé et le déplacement. Pour un objet dossier, elles comprennent l'ajout d'objets, le déplacement et la suppression.

En tant qu'administrateur, vous pouvez personnaliser les actions réalisables sur des objets apparaissant dans l'interface utilisateur Workplace XT. Vous pouvez également effectuer des modifications d'apparence, par exemple supprimer entièrement une action de l'interface utilisateur. Grâce aux critères de filtrage, vous pouvez aussi définir les conditions dans lesquelles une action apparaît. Par exemple, vous pouvez décider que l'action de téléchargement doit apparaître uniquement lorsque les utilisateurs cliquent sur des documents d'une description de classe, d'un état de version et d'un type de contenu définis.

La présente rubrique indique les espaces de l'interface Workplace XT où les actions sont présentées aux utilisateurs et décrit le fichier XML descripteur d'actions de menu qui vous permet de configurer ces actions.

Remarque : Si vous avez déjà personnalisé des actions dans l'application Workplace en modifiant son fichier Actions.xml et souhaitez utiliser ces mêmes actions personnalisées dans Workplace XT, vous devez ajouter manuellement les actions personnalisées liées à Workplace au fichier Actions.xml de Workplace XT.

Actions dans l'interface utilisateur Workplace XT

Des actions peuvent être sélectionnées par l'utilisateur dans les menus contextuels, dans le menu Actions, dans le menu Outils et sur les pages Informations de propriétés. (Les actions des pages Informations de propriétés et les menus contextuels Mon Workplace sont définis par le fichier Actions.xml. Le fichier MenuActions.xml définit toutes les autres actions.) Le menu contextuel apparaît lorsqu'un utilisateur clique avec le bouton droit sur un objet de la vue de liste ou sur un élément de la vue de chemin. La liste des actions disponibles dépend du type d'objet sélectionné. Les mêmes actions apparaissent dans la page Informations de propriétés de l'objet. Lorsqu'un utilisateur sélectionne un ou plusieurs éléments dans la vue de liste, puis clique sur le bouton Actions, le menu Action s'ouvre. Si plusieurs éléments sont sélectionnés, seules les actions valides pour tous les éléments sélectionnés apparaissent dans le menu.

Dans Workplace XT, vous pouvez aussi exposer une nouvelle action à l'aide du menu contextuel. Vous devez ajouter un JavaScript personnalisé au fichier ActionsMenu.js pour activer une action dans le menu Actions.

Dans la fonction showActionsMenu d'ActionsMenu.js, ajoutez le code suivant :
if ($("ACTIONS_MENU__actionid"))
validActions.push("actionid");

Où "idaction" est l'ID de votre action comme spécifié dans le fichier MenuActions.xml.

Fichier XML descripteur des actions du menu

MenuActions.xml contient les définitions des actions affichées dans le menu contextuel et le menu à sélection multiple pour le mode de recherche et d'exploration. Le fichier se trouve dans le dossier <chemin de déploiement de XT>\FileNet\Config\WebClient, où <chemin de déploiement de XT> correspond au chemin de déploiement de Workplace XT. MenuActions.xml suit le schéma XML des préférences, Preferences.xsd, situés dans <chemin de déploiement de XT>\FileNet\WebClient\WorkplaceXT\WEB-INF\xml.

Remarques :  
  • Sauvegardez MenuActions.xml avant de le modifier.
  • Si vous modifiez le fichier MenuActions.xml pour inclure les caractères étendus, enregistrez le fichier au format UTF-8.
  • Après avoir modifié MenuActions.xml, rechargez-le à partir de Workplace XT pour éviter de redémarrer le serveur Web sur lequel l'application est déployée.
Structure de fichier
Comme indiqué dans la liste ci-après, MenuActions.xml comprend cinq sections : multiSelectActions, toolbarActions, folderToobarActions, topLevelActions et actionDefinitions.
Dans les tableaux topLevelActions et multiSelectActions, vous devez définir l'ordre des actions telles qu'elles apparaissent dans interface utilisateur. En d'autres termes, dans le tableau topLevelActions, l'ordre des éléments de valeur se répercute dans le menu contextuel et sur les pages d'informations. Dans le tableau multiSelectActions, l'ordre des éléments de valeur se répercute dans le menu à sélection multiple. Vous pouvez masquer des actions en les mettant en commentaire.
Dans le tableau multiSelectActions, vous pouvez indiquer des actions uniquement pour qu'elles soient de sélection multiple. Ainsi, elles ne doivent pas nécessairement figurer dans le tableau topLevelActions.
Dans les sections toolbarActions et folderToolbarActions, vous définissez les boutons de la barre d'outils qui apparaissent en regard du bouton Actions lorsque vous recherchez des documents et des dossiers. La section toolbarActions contrôle les actions associées au document et la section folderToolbarActions contrôle celles associées au dossier.
La liste actionDefinitions comprend des objets action, dont chacun contient une liste de conditions définissant si l'action est affichée pour tel ou tel objet. Vous remarquerez que si une action de niveau supérieur contient un sous-menu, la définition d'action de niveau supérieur doit contenir un paramètre subActions. D'autre part, la définition d'une action répertoriée dans le tableau multiSelectActions doit inclure un paramètre multiSelectURL. Pour avoir une description de tous les paramètres, voir Paramètres de définition des actions de menu.
Sections du fichier XML descripteur des actions du menu
<object key="actionsConfiguration" version="1.0">
...

 <array key="multiSelectActions">
 <value>download</value>
 <value>checkout</value>
 <value>cancelCheckout</value>
 <value>file</value>
 <value>delete</value>
 <value>assignSecurityPolicy</value>
 <value>sendMail</value>
 </array>

 <array key="toolbarActions">
 <value>download</value>
 <value>checkout</value>
 <value>quickCheckin</value>
 <value>cancelCheckout</value>
 <value>addToFavorites</value>
 <value>infoProperties</value>
 <value>sendMail</value>
 </array>

 <array key="folderToolbarActions">
 <value>addDocument</value>
 <value>addFolder</value>
 </array>

 <array key="topLevelActions">
 <value>view</value> <!-- for documents, publish templates -->
 <value>open</value> <!-- for folders, searches, object stores -->

 <value>download</value>
 <value>checkout</value>
 <value>quickCheckin</value>
 <value>cancelCheckout</value>
 <value>addToFavorites</value>
 <value>removeFavorite</value>
 <value>renameFavorite</value>
 <value>sendMail</value>
 <value>launch</value>
 <value>transfer</value>
 <value>addSubscription</value>
 <value>declareAsRecord</value>
 <value>declareVersionsAsRecord</value>

 <value>testFormTemplate</value>
 <value>modifyDocumentPolicy</value>
 <value>modifyWorkflowPolicy</value>
 <value>takeOffline</value>
 <value>modifyEntryTemplate</value>
 <value>modifyRecordEntryTemplate</value>

 <!-- RM changes start-->
 <value>requestchargeout</value>
 <value>viewDocumentInfo</value>
 <!-- RM changes end -->

 <value>infoProperties</value>
 <value>moreInformation</value>

 <value>documentActions</value>
 <value>folderActions</value>

 <!-- always in the end -->
 <value>addDocument</value>
 <value>addFolder</value>
 </array>

<list key="actionDefinitions">

...

 <object key="action">
 <setting key="id">download</setting>
 <setting key="title" localizationKey="server.MenuActions_xml.download">Download...</setting>
 <setting key="url">
 getContent?
 mode=download&amp;
 objectType={OBJECT_TYPE}&amp;
 id={OBJECT_ID}&amp;
 vsId={VERSION_SERIES_ID}&amp;
 objectStoreName={OBJECT_STORE_NAME}&amp;
 returnUrl={RETURN_URL}
 </setting>

 <setting key="multiSelectURL">
 operations/WcmMultiDownloadObject.jsp?
 returnUrl={RETURN_URL}
 </setting>
 <setting key="img">images/action/toolbar/Download23.gif</setting>
 <array key="objectTypes">
 <value>document</value>
 </array>
 <array key="excludedContentTypes">
 <!--RM Change start -->
 <value>application/x-filenet-rm-physicalrecord</value>
 <value>application/x-filenet-rm-electronicrecord</value>
 <value>application/x-filenet-rm-emailrecord</value>
 <!-- RM Change ends -->

 <!-- entry template mime types -->
 <value>application/x-filenet-entrytemplate</value>
 <value>application/x-filenet-documententrytemplate</value>
 <value>application/x-filenet-folderentrytemplate</value>
 <value>application/x-filenet-customobjectentrytemplate</value>
 <value>application/x-filenet-formdataentrytemplate</value>
 <value>application/x-filenet-declarerecordentrytemplate</value>
 <value>application/x-filenet-pageentrytemplate</value>
 <value>application/x-filenet-sectionentrytemplate</value>
 <value>application/x-filenet-cfwpageentrytemplate</value>
 <value>application/x-filenet-cfwsectionentrytemplate</value>
 <value>application/x-filenet-cfwtextentrytemplate</value>
 <value>application/x-filenet-localsectionentrytemplate</value>

 <!-- wcm mime types -->
 <value>application/x-filenet-sp-cr</value>
 <value>application/x-filenet-sp-target</value>
 <value>application/x-filenet-sp-page</value>
 <value>application/x-filenet-sp-section</value>
 <!-- Form policies -->
 <value>application/x-filenet-documentpolicy</value>
 <value>application/x-filenet-workflowpolicy</value>

 <!-- external documents (pointing to an URL) -->
 <value>application/x-filenet-external</value>
 </array>
 <setting key="isPopup">false</setting>
 <setting key="popupHeight">600</setting>
 <setting key="popupWidth">750</setting>
</object>

Paramètres de définition des actions de menu

Le tableau ci-dessous décrit chaque paramètre de définition d'action dans MenuActions.xml. Chaque paramètre est identifié par son attribut de clé. Sauf indication contraire, les paramètres sont facultatifs. Si un paramètre facultatif est absent, sa valeur par défaut est utilisée.
Tableau 1. Ce tableau décrit chaque paramètre de définition d'action dans MenuActions.xml.
Clé Paramètre Valeur
baseURLKey
<setting key="baseURLKey">
 rm
</setting>
Si ce paramètre est présent, l'URL de base de l'application Records Manager est utilisée à la place de l'URL de base de Workplace XT (utilisée par défaut). La seule valeur valide est "rm".
classes
<array key="classes">
 <value>{63F8AA94-E2B9-11D0
 -ADF6-00C04FB66DAD}</value>
 <value>{A73BEEB2-B0B7-11D2
 -8853-0000F80883E3}</value>
</array>
Définit la liste des classes valides pour cette action. Les valeurs doivent être au format GUID. L'action est disponible uniquement pour les classes répertoriées.
Remarque : Si ce paramètre est présent, ne définissez pas excludedClasses.
.
contentTypes
<array key="contentTypes">
 <value>image/jpeg</value>
 <value>image/tiff</value>
 <value>text/*</value>
 <value>application/??-word</value>
</array>
Définit la liste des types mime et des types de conteneur valides pour cette action. L'action est disponible uniquement pour les objets des types de contenu spécifiés. S'ils sont absents, elle est disponible pour tous les types de contenu. Les valeurs de ce paramètre prennent en charge les caractères génériques "*" et "?". "*" signifie n'importe quel nombre de caractères (y compris 0 caractères). "?" signifie un caractère.
Remarque : Si ce paramètre est présent, ne définissez pas excludedContentTypes.
excludedClasses
<array key="excludedClasses">
 <value>{d24d4450-1f01-11d1
 -8e63-006097d2df48}</value>
 <value>{f81e9010-6ea4-11ce
 -a7ff-00aa003ca9f6}</value>
</array>
Définit la liste des classes non valides pour cette action. Les valeurs doivent être au format GUID. L'action n'est pas disponible pour les classes répertoriées.
Remarque : Si ce paramètre est présent, ne définissez pas classes.
excludedContentTypes
<array key="excludedContentTypes">
 <value>text/xml</value>
 <value>text/plain</value>
</array>
Définit la liste des types mime et des types de conteneur non valides pour cette action. L'action est disponible pour tous les objets n'appartenant à aucun type de contenu répertorié. Les valeurs de ce paramètre prennent également en charge les caractères génériques "*" et "?".
Remarque : Si ce paramètre est présent, ne définissez pas contentTypes.
excludedObjectTypes
<array key="excludedObjectTypes">
 <value>storedsearch</value>
 <value>publishtemplate</value>
 <value>securitytemplate</value>
</array>
Définit la liste des types d'objet non valides pour cette action.
Remarque : Si ce paramètre est présent, ne définissez pas objectTypes.
favoritesOnly
<setting key="favoritesOnly">
 true
</setting>
Si la valeur est true, l'action apparaît uniquement sur la page Favoris. La valeur par défaut est false.
hideBasedOnVersionStatusConditions
<setting key="hideBasedOnVersionStatusConditions">
 true
</setting>
Si la valeur est true (valeur par défaut), l'état de la version de l'objet détermine si l'action apparaît sur la page. Cette clé est applicable uniquement aux définitions d'action promoteVersion et demoteVersion. La valeur par défaut est false.
hideForFavorites
<setting key="hideForFavorites">
 true
</setting>
Si la valeur est true, l'action n'apparaît pas sur la page Favoris. Cette clé est applicable uniquement aux définitions d'action addToFavorites. La valeur par défaut est false.
hideForVersions
<setting key="hideForVersions">
 true
</setting>
Si la valeur est true, cette action n'apparaît pas pour une version d'un objet dans une page d'informations. En d'autres termes, si, à partir d'une page d'information correspondant à un objet, vous accédez à la page de propriétés Versions, puis accédez à une page d'informations pour un objet en particulier, l'action est indisponible. La valeur par défaut est True.
hideInSitePreferences
<setting key="hideInSitePreferences">
 true
</setting>
Si la valeur est true, l'action n'apparaît pas dans l'interface utilisateur Préférences de site. La valeur par défaut est false.
hideWhenCheckedOut
<setting key="hideWhenCheckedOut"> true </setting>
Si la valeur est true, l'action n'apparaît pas lorsque le document est réservé. La valeur par défaut est false.
id
<setting key="id"> download </setting>
Définit un identificateur unique pour une action. Une valeur est obligatoire.
img
<setting key="img">
 images/action/TestAction16.gif
</setting>
Définit l'icône de l'action. Ce paramètre n'est pas obligatoire. La valeur doit être un chemin valide d'accès à une image avec une taille de 16x16 pixels.
Remarque : Comme avec url, vous pouvez utiliser un chemin relatif.
isPopup
<setting key="isPopup">
 true
</setting>
Si la valeur est true, cette action apparaît dans une nouvelle fenêtre lorsqu'un seul objet est sélectionné. La valeur par défaut est false.
multiSelectPopupHeight
<setting key="multiSelectPopupHeight">
 250
</setting>
Définit la hauteur en pixels de la nouvelle fenêtre. Ce paramètre est ignoré si isPopup est défini sur false ou si multiSelectURL n'est pas utilisé. La valeur par défaut est 600.
multiSelectPopupWidth
<setting key="multiSelectPopupWidth">
 550
</setting>
Définit la largeur en pixels de la nouvelle fenêtre. Ce paramètre est ignoré si isPopup est défini sur false ou si multiSelectURL n'est pas utilisé. La valeur par défaut est 800.
multiSelectURL
<setting key="multiSelectURL">
 operations/WcmMultiDownloadObject.jsp?
 returnUrl={RETURN_URL}
</setting>
Définit l'URL à sélection multiple. Ce paramètre définit l'URL de la page qui met en oeuvre l'action de sélection multiple. Toute action prenant en charge la sélection multiple doit avoir ce paramètre. L'action doit également être incluse de la section multiSelectActions de MenuActions.xml.
objectTypes
<array key="objectTypes">
 <value>document</value>
 <value>folder</value>
</array>
Définit la liste des types d'objet valides pour cette action. Si ce paramètre est absent, tous les types d'objet sont valides. Les valeurs valides sont :
  • objectstore
  • folder
  • document
  • storedsearch
  • searchtemplate
  • link
  • event
Remarque : Si ce paramètre est présent, ne définissez pas excludedObjectTypes.
onclick
<setting key="onclick">
 return FNActions.open(event, this)
</setting>
Définit l'action liée à un événement JavaScript à appeler lorsque l'utilisateur clique sur l'action dans l'interface utilisateur.
popupHeight
<setting key="popupHeight">
 250
</setting>
Définit la hauteur en pixels de la nouvelle fenêtre. Ce paramètre est ignoré si isPopup est défini sur false. La valeur par défaut est 600.
popupWidth
<setting key="popupWidth">
 600
</setting>
Définit la largeur en pixels de la nouvelle fenêtre. Ce paramètre est ignoré si isPopup est défini sur false. La valeur par défaut est 800.
renderSeparatorAbove
<setting key="renderSeparatorAbove">
 true
</setting>
Si la valeur est true, cette action permet de dessiner une ligne séparatrice au-dessus de la liste d'actions. La valeur par défaut est false.
returnParameters
<setting key="returnParameters">
 eventName=StateChanged&op=checkin
</setting>
Définit les paramètres d'URL à inclure lorsque l'action est terminée. Utilisé dans certain cas pour fournir un mécanisme afin de régénérer la page principale après la fin d'une action.
rmHideIfAlreadyDeclared
<setting key="rmHideIfAlreadyDeclared">
 true
</setting>
Si la valeur est true, cette action apparaît uniquement lorsque le document n'a pas été déclaré comme enregistrement. La valeur par défaut est false.
Remarque : Ce paramètre est valide uniquement si Records Manager est sélectionné dans les préférences de site.
rmOnly
<setting key="rmOnly">
 false
</setting>
Si la valeur est true, cette action apparaît uniquement lorsque Records Manager est sélectionné dans Préférences de site. La valeur par défaut est false.
roles
<array key="roles"> <value>PSDesigner</value> <value>PWAdministrator</value> </array>
Définit la liste des rôles d'accès valides pour cette action. Seuls les utilisateurs membres d'un ou plusieurs des rôles répertoriés ont accès à l'action. Les rôles d'accès sont définis sur le moteur de contenu Content Engine. La valeur par défaut est "Everyone".
Remarque : Vous pouvez également définir les rôles dans les préférences de site, page d'accès aux rôles d'actions.
shortId
<array key="shortId">
 addDocument
</array>
Défini l'identificateur abrégé de l'action.
Remarque : Disponible uniquement à partir de la barre d'outils et du bouton Actions.
showInActionsMenuOnly
<setting key="showInActionsMenuOnly"> true </setting>
Si la valeur est true, les actions Ajouter un document, Ajouter un document (options avancées) et Ajouter un dossier apparaissent uniquement dans le menu Actions, et non dans les menus contextuels de l'élément sélectionné. La valeur par défaut est false.
showOnlyWhenCheckedOut
<setting key="showOnlyWhenCheckedOut"> true </setting>
Si la valeur est true, l'action apparaît uniquement lorsque le document est réservé. La valeur par défaut est false.
subActions
<array key="subActions">
 <value>infoProperties</value>
 <value>infoSystemProperties</value>
 <value>infoSecurity</value>
 <value>infoFolders</value>
</array>
Définit la liste des actions affichées dans un sous-menu. Vous remarquerez que vous devez définir actionDefinition pour chaque valeur du tableau subActions.
Remarque : Un seul niveau de sous-menus est disponible. Aucune action répertoriée dans le tableau subActions ne peut avoir ses propres sous-menus.
title
<setting key="title">
 TEST ACTION 
</setting>
Définit l'étiquette de l'action, qui apparaît dans l'interface utilisateur. Ce paramètre est obligatoire.
titleForSitePreferences
<setting key="titleForSitePreferences">
 Download Documents
</setting>
Titre de l'action telle qu'elle apparaît dans les préférences de site, page d'accès aux rôles d'actions. Si ce paramètre est exclu, la valeur title est utilisée.
url
<setting key="url">
 operations/MyOperation.jsp?
 id={OBJECT_ID}&amp;
 classId={CLASS_ID}&amp;
 label={OBJECT_LABEL}&amp;
 objectStoreName={OBJECT_STORE_NAME}&amp;
 minorVersion={MINOR_VERSION}&amp;
 objectType={OBJECT_TYPE}&amp;
 vsId={VERSION_SERIES_ID
</setting>
Définit l'URL de la page qui met en oeuvre l'action et les paramètres transmis à cette page sur l'URL. Le format de cette chaîne est décrit à la section Macros des modèles d'URL.

Ce paramètre est obligatoire.

Remarque : Les espaces et les retours à la ligne sont autorisés dans la valeur pour des raisons de commodité. Lors de la lecture de MenuActions.xml, ils sont automatiquement supprimés de cette chaîne (ce ne sont pas des caractères valides pour une URL).
useToken
<setting key="useToken"> 
 true
</setting>
Si la valeur est true, un jeton utilisateur est ajouté à l'URL avant le réacheminement. Ce paramètre est valide uniquement si la prise en charge des jetons est sélectionnée dans les préférences de site. La valeur par défaut est false.
versionStatusConditions
<array key="versionStatusConditions">
 <value>released</value>
 <value>superseded</value>
</array>
Définit les valeurs de l'état de la version valides pour l'action. Si ce paramètre est absent, toutes les valeurs de l'état de la version sont valides. Les valeurs valides sont :
  • released
  • reserved
  • superseded
  • inprocess
  • inprocessNoMajor

Utilisez inprocess pour les listes de versions comportant une version principale et inprocessNoMajor pour les autres. Pour plus d'informations sur ces valeurs, consultez la page Web Versioning Properties.

Macros des modèles d'URL

Les macros du tableau suivant sont utilisées dans le paramètre url des définitions d'action. Elles définissent l'URL de la page qui met en oeuvre l'action et les paramètres transmis à cette page sur l'URL. Les macros sont remplacées par la valeur correspondante dans l'URL réelle. Par exemple, si le modèle est operations/Test.jsp?id={OBJECT_ID}, et si l'objet pour lequel l'opération est appelée possède l'ID, {A73BEEB2-B0B7-11D2-8853-0000F80883E3}, l'URL de l'opération sera operations/Test.jsp?id={A73BEEB2-B0B7-11D2-8853-0000F80883E3}.
Tableau 2. Ce tableau décrit les macros utilisées dans le paramètre d'URL des définitions d'action.
Macro Valeur
{OBJECT_STORE_NAME} Nom du conteneur d'objets, par exemple, "TEST_OS".
{OBJECT_ID} ID objet au format GUID ou de chemin.
{OBJECT_LABEL} Etiquette de l'objet telle qu'elle apparaît dans l'interface utilisateur.
{OBJECT_TYPE} Type d'objet en tant que chaîne ; par exemple, "document" ou "folder".
{VERSION_SERIES_ID} ID liste de versions au format GUID.
{CLASS_ID} ID de classe au format GUID.
{CONTENT_TYPE} Type de contenu en tant que chaîne, avec codage URL.
{MAJOR_VERSION} Version principale, par exemple, "1".
{MINOR_VERSION} Version secondaire, par exemple, "2".
{VERSION_STATUS} Etat de la version sous la forme d'un numéro, par exemple, "1".
{RETURN_URL} URL de retour, avec codage URL, par exemple, "http://<serveur>:<port>/WorkplaceXT/Browse.jsf"
{TIME_ZONE} ID fuseau horaire.


Commentaires

Dernière mise à jour : Mars 2013
wpxt_menuactions_config.htm

© Copyright IBM Corp. 2013.
Ce centre de documentation est doté de la technologie Eclipse. (http://www.eclipse.org)