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 de document comprennent la réservation, le téléchargement, la modification du composite 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 en incrustation, 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 en incrustation Mon Workplace sont définis par le fichier Actions.xml. Le fichier MenuActions.xml définit toutes les autres actions.) Le menu en incrustation 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__idaction"))
                validActions.push("idaction");

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

Fichier XML descripteur des actions du menu

MenuActions.xml contient les définitions des actions affichées dans le menu en incrustation et le menu à sélection multiple pour le mode de recherche et d'exploration. Le fichier se trouve dans le dossier <chemin_déploiement_XT>\FileNet\Config\WebClient, où <chemin_déploiement_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_déploiement_XT>\FileNet\WebClient\WorkplaceXT\WEB-INF\xml.

REMARQUES : 

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 en incrustation 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.

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}.

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.