IBM FileNet P8, Versión 5.1.+            

Personalizar acciones de Workplace XT

Para los objetos accesibles desde menús emergentes o desde las modalidades de examinar y buscar de IBM® FileNet Workplace XT, la aplicación presenta un conjunto de operaciones o acciones que el usuario final puede realizar en un tipo de objeto concreto. Por ejemplo, las acciones disponibles para un objeto de documento incluyen extraer, descargar, cambiar a compuesto y mover; para un objeto de carpeta, incluyen añadir objetos, mover y suprimir.

Como administrador puede personalizar las acciones que se pueden realizar en los objetos que aparecen en la interfaz de usuario de Workplace XT. También puede realizar cambios cosméticos, como eliminar completamente una acción de la interfaz de usuario. Utilizando criterios de filtro, también puede definir las condiciones bajo las cuales aparece una acción. Por ejemplo, puede definir que la acción de descargar solamente aparezca cuando os usuarios pulsen documentos de una cierta descripción de clase, estado de versión y tipo de contenido.

Este tema destaca los lugares de la interfaz de Workplace XT en los que se presentan acciones a los usuarios, y describe el archivo XML descriptor de acciones de menú que se utiliza para configurar dichas acciones.

Nota: Si anteriormente ha personalizado acciones en la aplicación Workplace modificando su archivo Actions.xml y desea utilizar esas mismas acciones personalizadas en Workplace XT, debe añadir manualmente las personalizaciones relacionadas con Workplace XT Archivo Actions.xml de Workplace XT.

Acciones de la UI de Workplace XT

Las acciones están disponibles para los usuarios en menús emergentes, en el menú Acciones, el menú Herramientas y en las páginas de información de Propiedades. (Las acciones de las páginas de información de Propiedades y los menús emergentes de Mi lugar de trabajo se definen mediante el archivo Actions.xml; el archivo MenuActions.xml define todas las demás acciones.) El menú emergente aparece cuando un usuario pulsa con el botón derecho del ratón en un objeto de la vista de lista o en un elemento de la vista de vía de acceso. La lista de acciones disponibles depende del tipo de objeto seleccionado. Las mismas acciones aparecen en la página de información de Propiedades del objeto. Cuando un usuario selecciona uno o varios elementos en la vista de lista y pulsa el botón "Acciones", se abre el menú Acciones. Si se seleccionan varios elementos, en el menú solamente se muestran las acciones válidas para todos los elementos seleccionados.

En Workplace XT también puede exponer una nueva acción utilizando el menú contextual. Debe añadir JavaScript personalizado en el archivo ActionsMenu.js para habilitar una acción en el menú Acciones.

En la función showActionsMenu de ActionsMenu.js, añada el siguiente código:
if ($("ACTIONS_MENU__actionid"))
validActions.push("actionid");

Donde "id_acción" es el ID de la acción tal como se ha especificado en el archivo MenuActions.xml.

Archivo XML descriptor de acciones de menú

MenuActions.xml contiene las definiciones de las acciones mostradas en el menú emergente y menú de selección múltiple para la modalidad de navegación y búsqueda. El archivo está ubicado en la carpeta <vía_acceso_despliegue_XT>\FileNet\Config\WebClient, donde <vía_acceso_despliegue_XT> es la vía de acceso en la que se ha desplegado Workplace XT. MenuActions.xml sigue el Esquema de preferencias XML de Workplace, Preferences.xsd, ubicado en <vía_acceso_despliegue_XT>\FileNet\WebClient\WorkplaceXT\WEB-INF\xml.

Notas:  
  • Realice una copia de seguridad de MenuActions.xml antes de modificarlo.
  • Si modifica el archivo MenuActions.xml para que incluya caracteres ampliados, guarde el archivo en formato UTF-8.
  • Después de modificar MenuActions.xml, vuelva a cargarlo desde Workplace XT para evitar tener que reiniciar el servidor web en el cual se ha desplegado la aplicación.
Estructura de archivo
Como se muestra en el listado siguiente, MenuActions.xml consiste en cinco secciones: multiSelectActions, toolbarActions, folderToobarActions, topLevelActions y actionDefinitions.
En la matriz topLevelActions y en la matriz multiSelectActions se define el orden de las acciones tal como aparecen en la interfaz de usuario. Es decir, en la matriz topLevelActions, el orden de los elementos de valor se reflejan en el menú emergente y en las páginas de información. En la matriz multiSelectActions, el orden de los elementos de valor se refleja en el menú de selección múltiple. Puede ocultar acciones comentándolas.
En la matriz multiSelectActions puede especificar que algunas acciones sean solamente de selección múltiple; es decir, una acción de selección múltiple no tiene que figurar en la matriz topLevelActions.
En las secciones toolbarActions y folderToolbarActions se definen los botones de barra de herramientas que aparecen junto al botón Acciones en la barra de herramientas cuando se examinan o se buscan documentos y carpetas. La sección toolbarActions controla acciones relacionadas con documentos; la sección folderToolbarActions controla acciones relacionadas con carpetas.
La lista actionDefinitions está formada de objetos action, y cada uno de ellos contiene una lista de condiciones que definen si la acción se visualiza para cada objeto concreto. Tenga en cuenta que una acción de nivel superior puede contener un submenú y, si lo hace, la definición de acción de nivel superior debe incluir un valor subActions. Tenga en cuenta también que la definición de una acción que figure en la matriz multiSelectActions debe incluir un valor multiSelectURL. Consulte los Valores de definición de MenuAction para obtener una descripción de todos los valores.
Secciones del archivo XML descriptor de acciones de menú
<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>

Valores de definición de acción de menú

La siguiente tabla describe cada uno de los valores de definición de acción de MenuActions.xml. Cada valor se identifica mediante su atributo de clave. A menos que se indique lo contrario, un valor es opcional. Si un valor opcional no está presente, se utiliza su valor predeterminado.
Tabla 1. Esta tabla describe cada valor de definición de acción de MenuActions.xml.
Clave Configuración Valor
baseURLKey
<setting key="baseURLKey">
 rm
</setting>
Si este valor está presente, se utiliza el URL base de la aplicación de Records Manager en lugar del URL base de Workplace XT (el valor predeterminado). El único valor válido es "rm".
classes
<array key="classes">
 <value>{63F8AA94-E2B9-11D0 -ADF6-00C04FB66DAD}</value>
 <value>{A73BEEB2-B0B7-11D2 -8853-0000F80883E3}</value>
</array>
Define la lista de clases válidas para esta acción. Los valores deben tener el formato GUID. La acción sólo está disponible para las clases enumeradas.
Nota: Si este valor está presente, no establezca excludedClasses
.
contentTypes
<array key="contentTypes">
 <value>image/jpeg</value>
 <value>image/tiff</value>
 <value>text/*</value>
 <value>application/??-word</value>
</array>
Define la lista de tipos MIME y tipos de contenedor válidos para esta acción. La acción sólo está disponible para los objetos de los tipos de contenido especificados. Si no está presente, la acción está disponible para todos los tipos de contenidos. Los valores de esta configuración soportan los caracteres comodines "*" y "?". "*" significa cualquier número de caracteres (incluyendo 0 caracteres). "?" significa un carácter.
Nota: Si este valor está presente, no establezca excludedContentTypes.
excludedClasses
<array key="excludedClasses">
 <value>{d24d4450-1f01-11d1 -8e63-006097d2df48}</value>
 <value>{f81e9010-6ea4-11ce -a7ff-00aa003ca9f6}</value>
</array>
Define la lista de clases que no son válidas para esta acción. Los valores deben tener el formato GUID. La acción no está disponible para las clases enumeradas.
Nota: Si este valor está presente, no establezca classes.
excludedContentTypes
<array key="excludedContentTypes">
 <value>text/xml</value>
 <value>text/plain</value>
</array>
Define la lista de tipos MIME y tipos de contenedor no válidos para esta acción. La acción está disponible para todos los objetos que no figuren en esta lista de tipos de contenidos. Los valores de esta configuración también soportan los caracteres comodines "*" y "?".
Nota: Si este valor está presente, no establezca contentTypes.
excludedObjectTypes
<array key="excludedObjectTypes">
 <value>storedsearch</value>
 <value>publishtemplate</value>
 <value>securitytemplate</value>
</array>
Define la lista de tipos de objeto no válidos para esta acción.
Nota: Si este valor está presente, no establezca objectTypes.
favoritesOnly
<setting key="favoritesOnly">
 true </setting>
Si el valor es true, la acción solo aparece en la página Favoritos. El valor predeterminado es false.
hideBasedOnVersionStatusConditions
<setting key="hideBasedOnVersionStatusConditions">
 true </setting>
Si el valor es true (predeterminado), el estado de la versión del objeto determina si la acción aparece en la página. Esta clave sólo es aplicable a las definiciones de las acciones promoteVersion y demoteVersion. El valor predeterminado es false.
hideForFavorites
<setting key="hideForFavorites">
 true </setting>
Si el valor es true, la acción no aparece en la página Favoritos. Esta clave sólo es aplicable a las definiciones de acción de addToFavorites. El valor predeterminado es false.
hideForVersions
<setting key="hideForVersions">
 true</setting>
Si el valor es true, esta acción no se muestra para una versión de un objeto en la página de información. Es decir, si desde una página de información de un objeto va a la página de propiedades de Versiones y a continuación va a la página de información de un objeto concreto, la acción no está disponible. El valor predeterminado es true.
hideInSitePreferences
<setting key="hideInSitePreferences">
 true</setting>
Si el valor es true, la acción no se muestra en la interfaz de usuario de Preferencias de sitio. El valor predeterminado es false.
hideWhenCheckedOut
<setting key="hideWhenCheckedOut"> true </setting>
Si el valor es true, la acción no se muestra cuando se extrae el documento. El valor predeterminado es false.
id
<setting key="id"> download </setting>
Define un identificador exclusivo para una acción. Es necesario un valor.
img
<setting key="img">
 images/action/TestAction16.gif
</setting>
Define el icono de la acción. Este valor no es necesario. El valor debe ser una vía de acceso válida a una imagen con un tamaño de 16x16 píxeles.
Nota: Similar a url, puede utilizar una vía de acceso relativa.
isPopup
<setting key="isPopup">
 true</setting>
Si el valor es true, esta acción se abre en una nueva ventana cuando se selecciona un objeto. El valor predeterminado es false.
multiSelectPopupHeight
<setting key="multiSelectPopupHeight">
 250</setting>
Define la altura en píxeles de la nueva ventana. Este valor se ignora si isPopup se establece en false o si no se utiliza multiSelectURL. El valor predeterminado es 600.
multiSelectPopupWidth
<setting key="multiSelectPopupWidth">
 550
</setting>
Define el ancho en píxeles de la nueva ventana. Este valor se ignora si isPopup se establece en false o si no se utiliza multiSelectURL. El valor predeterminado es 800.
multiSelectURL
<setting key="multiSelectURL">
 operations/WcmMultiDownloadObject.jsp?
 returnUrl={RETURN_URL}
</setting>
Define un URL de selección múltiple. Este valor define el URL de la página que implementa la acción de selección múltiple. Cualquier acción que soporte la selección múltiple debe tener este valor. La acción también debe incluirse en la sección multiSelectActions de MenuActions.xml.
objectTypes
<array key="objectTypes">
 <value>document</value>
 <value>folder</value>
</array>
Define la lista de tipos de objeto válidos para esta acción. Si este valor no está presente, todos los tipos de objeto son válidos. Los valores válidos son:
  • objectstore
  • folder
  • document
  • storedsearch
  • searchtemplate
  • link
  • event
Nota: Si este valor está presente, no establezca excludedObjectTypes.
onclick
<setting key="onclick">
 return FNActions.open(event, this)
</setting>
Define la acción de suceso a la que debe llamarse cuando el usuario pulsa en la acción en la interfaz de usuario.
popupHeight
<setting key="popupHeight">
 250</setting>
Define la altura en píxeles de la nueva ventana. Este valor se ignora si isPopup se establece en false. El valor predeterminado es 600.
popupWidth
<setting key="popupWidth">
 600
</setting>
Define el ancho en píxeles de la nueva ventana. Este valor se ignora si isPopup se establece en false. El valor predeterminado es 800.
renderSeparatorAbove
<setting key="renderSeparatorAbove">
 true</setting>
Si el valor es true, esta acción dibuja una línea de separador encima de la lista de acciones. El valor predeterminado es false.
returnParameters
<setting key="returnParameters">
 eventName=StateChanged&op=checkin
</setting>
Define los parámetros URL que deben incluirse cuando la acción ha completado el proceso. Se utiliza en algunos casos como mecanismo para renovar la página principal cuando se ha completado una acción.
rmHideIfAlreadyDeclared
<setting key="rmHideIfAlreadyDeclared">
 true</setting>
Si el valor es true, esta acción sólo aparece cuando el documento no se ha declarado como registro. El valor predeterminado es false.
Nota: Este valor sólo es válidos si se selecciona Records Manager en las preferencias de sitio.
rmOnly
<setting key="rmOnly">
 false</setting>
Si el valor es true, esta acción sólo aparece cuando se selecciona Records Manager en las preferencias de sitio. El valor predeterminado es false.
roles
<array key="roles"> <value>PSDesigner</value> <value>PWAdministrator</value> </array>
Define la lista de roles de acceso válidos para esta acción. Solamente los usuarios que sean miembros de uno o varios de los roles que figuran en la lista verán la acción. Los roles de acceso se definen en Content Engine. El valor predeterminado es "Todos".
Nota: También puede establecer roles en las preferencias de sitio, página Acceso a roles de acciones.
shortId
<array key="shortId">
 addDocument
</array>
Define el identificador resumido de la acción.
Nota: Solamente disponible en la barra de herramientas y el botón Acciones.
showInActionsMenuOnly
<setting key="showInActionsMenuOnly"> true </setting>
Si el valor es true, las acciones Agregar documento, Agregar documento avanzado y Agregar carpeta solamente aparecen en el menú Acciones, no en los menús emergentes del elemento seleccionado. El valor predeterminado es false.
showOnlyWhenCheckedOut
<setting key="showOnlyWhenCheckedOut"> true </setting>
Si el valor es true, la acción sólo se muestra cuando se extrae el documento. El valor predeterminado es false.
subActions
<array key="subActions">
 <value>infoProperties</value>
 <value>infoSystemProperties</value>
 <value>infoSecurity</value>
 <value>infoFolders</value>
</array>
Define la lista de acciones mostradas en un submenú. Tenga en cuenta que debe definir una actionDefinition por cada valor de la matriz subActions.
Nota: Sólo puede tener un nivel de submenús; ninguna acción que figure en la matriz subActions puede tener submenús.
title
<setting key="title">
 TEST ACTION
</setting>
Define la etiqueta de la acción, que aparece en la interfaz de usuario. Este valor es necesario.
titleForSitePreferences
<setting key="titleForSitePreferences">
 Download Documents
</setting>
Título de la acción cuando la acción aparece en las preferencias de sitio, página Acceso a roles de acciones. Si se excluye este valor, se utiliza el valor de 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>
Define el URL de la página que implementa la acción y los parámetros pasados a dicha página en el URL. El formato de esta serie se describe en Macros de patrón de URL.

Este valor es necesario.

Nota: Se permiten espacios y saltos de línea en el valor por comodidad. Cuando se lee MenuActions.xml, los espacios y saltos de línea (que no son caracteres XML válidos) se eliminan automáticamente de este valor.
useToken
<setting key="useToken">
 true</setting>
Si el valor es true, se añade una salida de usuario relacionada con tareas al URL antes de redirigirlo. Esto solamente ocurre si se selecciona el soporte de señal en las preferencias de sitio. El valor predeterminado es false.
versionStatusConditions
<array key="versionStatusConditions">
 <value>released</value>
 <value>superseded</value>
</array>
Define los valores del estado de versión válidos para la acción. Si este valor no está presente, cualquier valor del estado de versión es válido. Los valores válidos son:
  • released
  • reserved
  • superseded
  • inprocess
  • inprocessNoMajor

Utilice inprocess para una serie de versión que tenga una versión principal. Utilice inprocessNoMajor para una serie de versión que no tenga una versión principal. Para obtener información sobre estos valores, consulte las Propiedades de mantenimiento de versiones.

Macros de patrón de URL

Los macros de la siguiente tabla se utilizan en el valor url de las definiciones de acción. Definen el URL de la página que implementa la acción y los parámetros pasados a dicha página en el URL. Los macros se sustituyen por el correspondiente valor del URL real. Por ejemplo, si el patrón es operations/Test.jsp?id={OBJECT_ID} y el objeto para el que se invoca la operación tiene un ID de {A73BEEB2-B0B7-11D2-8853-0000F80883E3}, el URL de la operación será operations/Test.jsp?id={A73BEEB2-B0B7-11D2-8853-0000F80883E3}.
Tabla 2. Esta tabla describe los macros utilizados en el valor de URL de las definiciones de acción.
Macro Valor
{OBJECT_STORE_NAME} Nombre de almacén de objetos; por ejemplo, "TEST_OS".
{OBJECT_ID} ID de objeto en formato GUID o de vía de acceso.
{OBJECT_LABEL} Etiqueta del objeto como etiqueta que aparece en la interfaz de usuario.
{OBJECT_TYPE} Tipo de objeto como serie; por ejemplo, "document" o "folder".
{VERSION_SERIES_ID} ID de serie de versión en formato GUID.
{CLASS_ID} ID de clase en formato GUID.
{CONTENT_TYPE} Tipo de contenido como serie, codificación URL.
{MAJOR_VERSION} Versión principal; por ejemplo "1".
{MINOR_VERSION} Versión menor; por ejemplo "2".
{VERSION_STATUS} Estado de versión como número; por ejemplo, "1".
{RETURN_URL} URL de retorno, URL codificado; por ejemplo, "http://<servidor>:<puerto>/WorkplaceXT/Browse.jsf"
{TIME_ZONE} ID de huso horario.


Comentarios

Última actualización: Julio de 2011


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