IBM FileNet P8, Versione 5.1.+            

Personalizzazione delle azioni di Workplace XT

Per gli oggetti a cui è possibile accedere dai menu pop-up o dalle modalità Sfoglia e Ricerca di IBM® FileNet Workplace XT, l'applicazione presenta una serie di operazioni o azioni che un utente finale può eseguire su un particolare tipo di oggetto. Ad esempio, le azioni disponibili per un oggetto documento includono il check out, il download, il passaggio a composto e lo spostamento; per un oggetto cartella, includono l'aggiunta di oggetti, lo spostamento e l'eliminazione.

Come amministratore, è possibile personalizzare le azioni che possono essere eseguite sugli oggetti visualizzati nell'interfaccia utente di Workplace XT. È possibile anche eseguire modifiche relative all'aspetto, come la rimozione completa di un'azione dall'interfaccia utente. Utilizzando criteri di filtro, è possibile inoltre definire le condizioni in cui viene visualizzata un'azione. Ad esempio, è possibile definire che un'azione di download venga visualizzata solo quando gli utenti fanno clic sui documenti di una determinata descrizione classe, stato versione e tipo di contenuto.

Questo argomento indica i punti dell'interfaccia di Workplace XT in cui le azioni vengono presentate agli utenti e descrive il file XML di descrizione delle azioni di menu utilizzato per configurare queste azioni.

Nota: Se in precedenza sono state personalizzate delle azioni nell'applicazione Workplace modificando il relativo file Actions.xml e si desidera utilizzare le stesse azioni personalizzate in Workplace XT, è necessario aggiungere manualmente le personalizzazioni correlate a Workplace al file Actions.xml di Workplace XT.

Azioni nella UI di Workplace XT

Azioni sono disponibili per l'utente nei menu pop-up, nel menu Azioni, nel menu Strumenti e nelle pagine di informazioni Proprietà. Le azioni presenti nelle pagine di informazioni Proprietà e nel menu pop-up di Il mio Workplace sono definite dal file Actions.xml; il file MenuActions.xml definisce tutte le altre azioni. Il menu pop-up viene visualizzato quando un utente fa clic con il pulsante destro del mouse su un oggetto in una visualizzazione elenco o su una voce nella visualizzazione percorso. L'elenco delle azioni disponibili dipende dal tipo di oggetto selezionato. Le stesse azioni vengono visualizzate nella pagina di informazioni Proprietà per l'oggetto. Quando un utente seleziona una o più voci nella visualizzazione elenco, quindi fa clic sul pulsante "Azioni", si apre il menu Azioni. Se vengono selezionate più voci, solo le azioni valide per tutte le voci selezionate vengono visualizzate nel menu.

In Workplace XT, è possibile anche presentare una nuova azione utilizzando il menu di scelta rapida. Per attivare un'azione nel menu Azioni, è necessario aggiungere JavaScript personalizzati al file ActionsMenu.js.

Nella funzione showActionsMenu in ActionsMenu.js, aggiungere il seguente codice:
if ($("ACTIONS_MENU__actionid"))
validActions.push("actionid");

Dove "actionid" è l'ID dell'azione specificata nel file MenuActions.xml.

File XML di descrizione delle azioni di menu

Il file MenuActions.xml contiene le definizioni delle azioni visualizzate nel menu pop-up e nel menu a più selezioni per le modalità Sfoglia e Ricerca. Il file si trova nella cartella <percorso_distribuzione_XT>\FileNet\Config\WebClient, dove <percorso_distribuzione_XT> è il percorso in cui viene distribuito Workplace XT. Il file MenuActions.xml segue lo Schema XML delle preferenze di Workplace, Preferences.xsd, situato in <percorso_distribuzione_XT>\FileNet\WebClient\WorkplaceXT\WEB-INF\xml.

Nota:  
  • Eseguire il backup del file MenuActions.xml prima di modificarlo.
  • Se si modifica il file MenuActions.xml per includere qualsiasi carattere esteso, salvare il file come UTF-8.
  • Dopo aver modificato il file MenuActions.xml, ricaricare il file da Workplace XT per evitare di riavviare il server Web su cui è distribuita l'applicazione.
Struttura del file
Come riportato nell'elenco in basso, il file MenuActions.xml è costituito da cinque sezioni: multiSelectActions, toolbarActions, folderToobarActions, topLevelActions e actionDefinitions.
Nell'array topLevelActions e nell'array multiSelectActions, è definito l'ordine delle azioni visualizzate nell'interfaccia utente. Ciò significa che nell'array topLevelActions, l'ordine degli elementi di valore è riflesso nel menu pop-up e nelle pagine di informazioni. Nell'array multiSelectActions l'ordine degli elementi di valore è riflesso nel menu a più selezioni. È possibile nascondere le azioni contrassegnandole come commento.
Nell'array multiSelectActions, è possibile specificare solo le azioni a più selezioni, ciò significa che un'azione a più selezioni non deve essere elencata nell'array topLevelActions.
Nelle sezioni toolbarActions e folderToolbarActions, vengono definiti i pulsanti della barra degli strumenti visualizzati accanto al pulsante Azioni nella barra degli strumenti quando si sfogliano o ricercano documenti e cartelle. La sezione toolbarActions controlla le azioni correlate ai documenti, la sezione folderToolbarActions controlla le azioni correlate alle cartelle.
L'elenco actionDefinitions è costituito da oggetti action, ciascuno dei quali contiene un elenco di condizioni che definiscono se l'azione viene visualizzata per ciascun singolo oggetto. Un'azione di livello superiore può contenere un sottomenu e, in questo caso, la definizione dell'azione di livello superiore deve includere un'impostazione subActions. La definizione di un'azione elencata nell'array multiSelectActions deve inoltre includere un'impostazione multiSelectURL. Per una descrizione di tutte le impostazioni, vedere Impostazioni di definizione MenuAction.
Sezioni del file XML di descrizione delle azioni di 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>

Impostazioni di definizione delle azioni di menu

Nella tabella che segue vengono descritte le impostazioni di definizione di ciascuna azione presente in MenuActions.xml. Ciascuna impostazione è identificata dal relativo attributo chiave. A meno che non sia specificato diversamente, un'impostazione è facoltativa. Se un'impostazione facoltativa non è presente, viene utilizzato il relativo valore di default.
Tabella 1. In questa tabella viene descritta l'impostazione di definizione di ciascuna azione presente in MenuActions.xml.
Chiave Impostazione Valore
baseURLKey
<setting key="baseURLKey">
 rm
</setting>
Se questa impostazione è presente, l'URL di base dell'applicazione Records Manager viene utilizzato al posto dell'URL di base di Workplace XT (l'impostazione di default). L'unico valore valido è "rm".
classes
<array key="classes">
 <value>{63F8AA94-E2B9-11D0
 -ADF6-00C04FB66DAD}</value>
 <value>{A73BEEB2-B0B7-11D2
 -8853-0000F80883E3}</value>
</array>
Definisce l'elenco di classi valide per questa azione. I valori devono essere in formato GUID. L'azione è disponibile solo per le classi elencate.
Nota: Se questa impostazione è presente, non impostare excludedClasses
.
contentTypes
<array key="contentTypes">
 <value>image/jpeg</value>
 <value>image/tiff</value>
 <value>text/*</value>
 <value>application/??-word</value>
</array>
Definisce l'elenco di tipi mime e di tipi contenitore validi per questa azione. L'azione è disponibile solo per gli oggetti dei tipi di contenuto specificati. Se non è presente, l'azione è disponibile per tutti i tipi di contenuto. I valori in questa impostazione supportano i caratteri jolly "*" e "?" . "*" indica qualsiasi numero di caratteri (inclusi i caratteri 0). "?" indica un solo carattere.
Nota: Se questa impostazione è presente, non impostare excludedContentTypes.
excludedClasses
<array key="excludedClasses">
 <value>{d24d4450-1f01-11d1
 -8e63-006097d2df48}</value>
 <value>{f81e9010-6ea4-11ce
 -a7ff-00aa003ca9f6}</value>
</array>
Definisce l'elenco di classi non valide per questa azione. I valori devono essere in formato GUID. L'azione non è disponibile per le classi elencate.
Nota: Se questa impostazione è presente, non impostare classes.
excludedContentTypes
<array key="excludedContentTypes">
 <value>text/xml</value>
 <value>text/plain</value>
</array>
Definisce l'elenco di tipi mime e di tipi contenitore non validi per questa azione. L'azione è disponibile per tutti gli oggetti che non sono di nessuno dei tipi di contenuto elencati. I valori in questa impostazione supportano anche i caratteri jolly "*" e "?" .
Nota: Se questa impostazione è presente, non impostare contentTypes.
excludedObjectTypes
<array key="excludedObjectTypes">
 <value>storedsearch</value>
 <value>publishtemplate</value>
 <value>securitytemplate</value>
</array>
Definisce l'elenco di tipi di oggetti non validi per questa azione.
Nota: Se questa impostazione è presente, non impostare objectTypes.
favoritesOnly
<setting key="favoritesOnly">
 true
</setting>
Se il valore è true, l'azione viene visualizzata solo nella pagina Preferiti. Il valore di default è false.
hideBasedOnVersionStatusConditions
<setting key="hideBasedOnVersionStatusConditions">
 true
</setting>
Se il valore è true (impostazione di default), lo stato della versione dell'oggetto determina se l'azione viene visualizzata nella pagina. Questa chiave è applicabile solo alle definizioni delle azioni promoteVersion e demoteVersion. Il valore di default è false.
hideForFavorites
<setting key="hideForFavorites">
 true
</setting>
Se il valore è true, l'azione non viene visualizzata nella pagina Preferiti. Questa chiave è applicabile solo alle definizioni dell'azione addToFavorites. Il valore di default è false.
hideForVersions
<setting key="hideForVersions">
 true
</setting>
Se il valore è true, questa azione non viene visualizzata per una versione di un oggetto in una pagina di informazioni. Ciò significa che, se da una pagina di informazioni relativa ad un oggetto si passa alla pagina di proprietà "Versioni", quindi alla pagina di informazioni per un particolare oggetto, l'azione non è disponibile. Il valore di default è true.
hideInSitePreferences
<setting key="hideInSitePreferences">
 true
</setting>
Se il valore è true, l'azione non viene visualizzata nell'interfaccia utente Preferenze sito. Il valore di default è false.
hideWhenCheckedOut
<setting key="hideWhenCheckedOut"> true </setting>
Se il valore è true, l'azione non viene visualizzata quando si esegue il check out del documento. Il valore di default è false.
id
<setting key="id"> download </setting>
Definisce un identificativo univoco per un'azione. Un valore è obbligatorio.
img
<setting key="img">
 images/action/TestAction16.gif
</setting>
Definisce l'icona per l'azione. Questa impostazione non è obbligatoria. Il valore deve essere un percorso valido ad un'immagine con una dimensione di 16x16 pixel.
Nota: Simile a url, è possibile utilizzare un percorso relativo.
isPopup
<setting key="isPopup">
 true
</setting>
Se il valore è true, questa azione si apre in una nuova finestra quando viene selezionato un oggetto. Il valore di default è false.
multiSelectPopupHeight
<setting key="multiSelectPopupHeight">
 250
</setting>
Definisce l'altezza in pixel della nuova finestra. Questa impostazione viene ignorata se isPopup è impostato su false o se multiSelectURL non viene utilizzato. Il valore di default è 600.
multiSelectPopupWidth
<setting key="multiSelectPopupWidth">
 550
</setting>
Definisce la larghezza in pixel della nuova finestra. Questa impostazione viene ignorata se isPopup è impostato su false o se multiSelectURL non viene utilizzato. Il valore di default è 800.
multiSelectURL
<setting key="multiSelectURL">
 operations/WcmMultiDownloadObject.jsp?
 returnUrl={RETURN_URL}
</setting>
Definisce l'URL a più selezioni. Questa impostazione definisce l'URL della pagina che implementa l'azione a più selezioni. Qualsiasi azione che supporta la selezione multipla deve avere questa impostazione. L'azione deve essere inoltre inclusa nella sezione multiSelectActions di MenuActions.xml.
objectTypes
<array key="objectTypes">
 <value>document</value>
 <value>folder</value>
</array>
Definisce l'elenco di tipi di oggetti validi per questa azione. Se questa impostazione non è presente, sono validi tutti i tipi di oggetti. I valori validi sono:
  • objectstore
  • folder
  • document
  • storedsearch
  • searchtemplate
  • link
  • event
Nota: Se questa impostazione è presente, non impostare excludedObjectTypes.
onclick
<setting key="onclick">
 return FNActions.open(event, this)
</setting>
Definisce l'azione evento da richiamare quando l'utente fa clic sull'azione nell'interfaccia utente.
popupHeight
<setting key="popupHeight">
 250
</setting>
Definisce l'altezza in pixel della nuova finestra. Questa impostazione viene ignorata se isPopup è impostato su false. Il valore di default è 600.
popupWidth
<setting key="popupWidth">
 600
</setting>
Definisce la larghezza in pixel della nuova finestra. Questa impostazione viene ignorata se isPopup è impostato su false. Il valore di default è 800.
renderSeparatorAbove
<setting key="renderSeparatorAbove">
 true
</setting>
Se il valore è true, questa azione traccia una linea di separazione sull'elenco di azioni. Il valore di default è false.
returnParameters
<setting key="returnParameters">
 eventName=StateChanged&op=checkin
</setting>
Definisce i parametri URL da includere una volta completata l'elaborazione dell'azione. Questa impostazione viene utilizzata in alcuni casi per fornire un meccanismo per aggiornare la pagina principale dopo il completamento di un'azione.
rmHideIfAlreadyDeclared
<setting key="rmHideIfAlreadyDeclared">
 true
</setting>
Se il valore è true, l'azione viene visualizzata solo quando il documento non è stato dichiarato come un record. Il valore di default è false.
Nota: Questa impostazione è valida solo se Records Manager è selezionato in Preferenze sito.
rmOnly
<setting key="rmOnly">
 false
</setting>
Se il valore è true, questa azione viene visualizzata solo quando Records Manager è selezionato in Preferenze sito. Il valore di default è false.
roles
<array key="roles"> <value>PSDesigner</value> <value>PWAdministrator</value> </array>
Definisce l'elenco di ruoli di accesso validi per questa azione. Solo gli utenti membri di uno o più ruoli elencati visualizzano l'azione. I ruoli di accesso sono definiti in Content Engine. Il valore di default è "Chiunque".
Nota: È possibile impostare i ruoli anche in Preferenze sito, nella pagina relativa ai ruoli di accesso per le azioni.
shortId
<array key="shortId">
 addDocument
</array>
Definisce l'identificativo breve dell'azione.
Nota: Disponibile solo dalla barra degli strumenti e dal pulsante Azioni.
showInActionsMenuOnly
<setting key="showInActionsMenuOnly"> true </setting>
Se il valore è true, le azioni Aggiungi documento, Aggiungi documento avanzato e Aggiungi cartella vengono visualizzate solo nel menu Azioni e non nei menu pop-up della voce selezionata. Il valore di default è false.
showOnlyWhenCheckedOut
<setting key="showOnlyWhenCheckedOut"> true </setting>
Se il valore è true, l'azione viene visualizzata solo quando si esegue il check out del documento. Il valore di default è false.
subActions
<array key="subActions">
 <value>infoProperties</value>
 <value>infoSystemProperties</value>
 <value>infoSecurity</value>
 <value>infoFolders</value>
</array>
Definisce l'elenco di azioni visualizzate in un sottomenu. È necessario definire un'impostazione actionDefinition per ciascun valore presente nell'array subActions.
Nota: È possibile avere un unico livello di sottomenu, nessuna azione elencata nell'array subActions può avere propri sottomenu.
title
<setting key="title">
 TEST ACTION 
</setting>
Definisce l'etichetta dell'azione, visualizzata nell'interfaccia utente. Questa impostazione è obbligatoria.
titleForSitePreferences
<setting key="titleForSitePreferences">
 Scarica documenti
</setting>
Il titolo dell'azione non appena l'azione viene visualizzata in Preferenze sito, nella pagina relativa ai ruoli di accesso per le azioni. Se questa impostazione è esclusa, viene utilizzato il valore di title.
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>
Definisce l'URL della pagina che implementa l'azione e i parametri trasmessi a quella pagina attraverso l'URL. Il formato di questa stringa è descritto in Macro dei modelli di URL.

Questa impostazione è obbligatoria.

Nota: Spazi e interruzioni riga sono consentiti nel valore per praticità. Quando viene letto il file MenuActions.xml, gli spazi e le interruzioni riga (che non sono caratteri URL validi) vengono rimossi automaticamente da questa stringa.
useToken
<setting key="useToken"> 
 true
</setting>
Se il valore è true, un token utente viene aggiunto all'URL prima del reindirizzamento. Ciò accade solo se il supporto token è selezionato nelle preferenze sito. Il valore di default è false.
versionStatusConditions
<array key="versionStatusConditions">
 <value>released</value>
 <value>superseded</value>
</array>
Definisce i valore dello stato della versione validi per l'azione. Se questa impostazione non è presente, è valido qualsiasi valore relativo allo stato della versione. I valori validi sono:
  • released
  • reserved
  • superseded
  • inprocess
  • inprocessNoMajor

Utilizzare inprocess per una serie di versioni con una versione principale. Utilizzare inprocessNoMajor per una serie di versioni senza una versione principale. Per informazioni su questi valori, consultare Versioning Properties.

Macro dei modelli di URL

Le macro presenti nella tabella che segue vengono utilizzate nell'impostazione url delle definizioni di azioni. Tali macro definiscono l'URL della pagina che implementa l'azione e i parametri trasmessi a quella pagina attraverso l'URL. Le macro vengono sostituite dal valore corrispondente nell'URL effettivo. Ad esempio, se il modello è operations/Test.jsp?id={OBJECT_ID} e l'oggetto per cui viene richiamata l'operazione presenta un ID di {A73BEEB2-B0B7-11D2-8853-0000F80883E3}, l'URL dell'operazione sarà operations/Test.jsp?id={A73BEEB2-B0B7-11D2-8853-0000F80883E3}.
Tabella 2. In questa tabella vengono descritte le macro utilizzate nell'impostazione URL delle definizioni delle azioni.
Macro Valore
{OBJECT_STORE_NAME} Nome archivio oggetti, ad esempio, "TEST_OS".
{OBJECT_ID} ID oggetto in formato GUID o percorso.
{OBJECT_LABEL} Etichetta oggetto, come l'etichetta viene visualizzata nell'interfaccia utente.
{OBJECT_TYPE} Tipo di oggetto come Stringa, ad esempio, "documento" o "cartella".
{VERSION_SERIES_ID} ID serie di versioni in formato GUID.
{CLASS_ID} ID classe in formato GUID.
{CONTENT_TYPE} Tipo di contenuto come Stringa, con codifica URL.
{MAJOR_VERSION} Versione principale, ad esempio "1".
{MINOR_VERSION} Versione secondaria, ad esempio "2".
{VERSION_STATUS} Stato della versione come numero, ad esempio, "1".
{RETURN_URL} URL di restituzione, con codifica URL, ad esempio, "http://<server>:<port>/WorkplaceXT/Browse.jsf"
{TIME_ZONE} ID del fuso orario.


Feedback

Ultimo aggiornamento: Luglio 2011


© Copyright IBM Corp. 2011.
Questo centro informazioni è una tecnologia Eclipse. (http://www.eclipse.org)