Asistencia al usuario para autores de contenido |
---|
Utilización de plug-ins de acción remota
Los plugins de acción remota sirven para desencadenar acciones desde la aplicación IBM® Web Content Manager.
[plugin:RemoteAction action=" " docid=" " dialog=" " dialogSize=" " dialogTitle=" " useCurrentContext=" " showInfoMsg=" " ]
- action
- Se trata de la acción remota a ejecutar.
- docid
- Se trata del ID de documento del elemento en relación al que se ejecuta la acción remota.
- useCurrentContext
- Si se establece en true, el ID de documento se obtiene del contexto de representación en lugar del atributo docid.
- dialog
- Si se establece en true, cuando se representa dentro de un portlet de visor de contenido web JSR 286, la acción remota se representa como un URL que redirecciona al usuario a una página oculta de portal que el visor de contenido web JSR 286 utiliza para la edición en línea.
- dialogSize
- Este valor opcional define el tamaño del diálogo ejecutando la acción remota. El valor debe tener el formato "ancho,alto". Por ejemplo, dialogSize="200,300" para un diálogo de 200 píxeles de anchura y 300 píxeles de altura. Si se omite, el tamaño del diálogo se calcula a partir del contenido visualizado en el diálogo. Este valor se utiliza solo si dialog="true".
- dialogTitle
- Este valor opcional establece el título del diálogo ejecutando la acción remota. Si se omite, se utiliza en su lugar el nombre de acción. Este valor se utiliza solo si dialog="true".
- showInfoMsg
- Establézcalo en true para visualizar el estado y otros mensajes de información después de que haya finalizado la acción remota. Si se omite, este parámetro se establece en false y únicamente se visualizan los mensajes de estado de error y aviso. Este valor se utiliza solo si dialog="true".
http://[host]/wps/myportal/wcmAuthoring?wcmAuthoringAction=actionTambién se pueden añadir plugins de acción remota al URL de un portlet Visor de contenido web local. Esto es de utilidad en sitios con la posibilidad de edición en línea de elementos de contenido.
Tipos de acción remota
- new
- Sirve para abrir un nuevo formulario de elemento. Se debe especificar también un parámetro "type".Por ejemplo:
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" ]
Se pueden utilizar los siguientes parámetros de type:- com.ibm.workplace.wcm.api.WCM_AuthoringTemplate
- com.ibm.workplace.wcm.api.WCM_Category
- com.ibm.workplace.wcm.api.WCM_Content
- com.ibm.workplace.wcm.api.WCM_DateComponent
- com.ibm.workplace.wcm.api.WCM_FileComponent
- com.ibm.workplace.wcm.api.WCM_HTMLComponent
- com.ibm.workplace.wcm.api.WCM_ImageComponent
- com.ibm.workplace.wcm.api.WCM_NumericComponent
- com.ibm.workplace.wcm.api.WCM_PresentationTemplate
- com.ibm.workplace.wcm.api.WCM_RichTextComponent
- com.ibm.workplace.wcm.api.WCM_ShortTextComponent
- com.ibm.workplace.wcm.api.WCM_SiteArea
- com.ibm.workplace.wcm.api.WCM_Taxonomy
- com.ibm.workplace.wcm.api.WCM_TextComponent
- com.ibm.workplace.wcm.api.WCM_Workflow
- com.ibm.workplace.wcm.api.WCM_WorkflowStage
Cuando se crea un nuevo elemento de contenido, se puede especificar una plantilla de creación predeterminada proporcionando el ID de documento de la plantilla de creación en el parámetro atid:- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" atid="com.ibm.workplace.wcm.api.WCM_AuthoringTemplate/ID1"]
A la hora de crear áreas de sitio, categorías y elementos de contenido existe la posibilidad de especificar el ID de documento del elemento padre bajo el que guardar el nuevo elemento. Este ID se especifica en el parámetro pid:- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID"]
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_SiteArea" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID"]
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Category" pid="com.ibm.workplace.wcm.api.WCM_Taxonomy/ID"]
A la hora de crear áreas de sitio existe la posibilidad de especificar la posición de la nueva área de sitio mediante un parámetro position. La nueva área de sitio se puede guardar al principio o al final en relación a cualquier área de sitio que exista. Si no se especifica, la nueva área de sitio se guardará al principio en relación a las áreas de sitio que ya existan:- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" position="start"]
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_SiteArea" position="end"]
- delete
- Se utiliza para suprimir un elemento. También es necesario especificar el docid del elemento.Por ejemplo:
- [plugin:RemoteAction action="delete" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- edit
- Sirve para abrir un formulario de elemento en modalidad de edición. También es necesario especificar el docid del elemento.Por ejemplo:
- [plugin:RemoteAction action="edit" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- read
- Sirve para abrir un formulario de elemento en modalidad de sólo lectura. También es necesario especificar el docid del elemento.Por ejemplo:
- [plugin:RemoteAction action="read" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- openmainview
- Sirve para abrir una vista dentro de un portlet de creación. Se debe especificar también un parámetro view.Por ejemplo:
- [plugin:RemoteAction action="openmainview" view="contentbysitearea"]
Se pueden utilizar los siguientes parámetros de view:- contentbysitearea
- contentbytitle
- myrecent
- mydraft
- mypendingapproval
- mypublished
- myexpired
- mydeleted
- alldraftitems
- allexpireditems
- allpublisheditems
- alldeleteditems
- componentsbytype
- move
- Sirve para mover un elemento de contenido o un área de sitio. Por ejemplo, para abrir el diálogo mover para elemento de contenido o un área de sitio:
- [plugin:RemoteAction action="move" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
La dirección de la acción "move" se especifica con "1" hacia arriba y con "-1" hacia abajo. Por ejemplo, para mover un elemento de contenido una posición hacia arriba:- [plugin:RemoteAction action="move" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID1" moveDirection="1"]
- link
- Sirve para enlazar un elemento de contenido con un área de sitio. Por ejemplo:
- [plugin:RemoteAction action="link" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID2"]
Al enlazar elementos existe la posibilidad de especificar la vía de acceso al elemento padre mediante el parámetro ppath en lugar del parámetro pid:- [plugin:RemoteAction action="link" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" ppath="library1/sitearea1/sitearea2"]
Al enlazar con elementos existe la posibilidad de crear un nuevo elemento padre mediante el parámetro autoCreateParent. Debe especificar también la biblioteca donde se encuentra el elemento que se está enlazando utilizando el parámetro slibrary. Se utiliza el parámetro ppath para especificar el padre existente bajo el que se crea el nuevo elemento padre:- [plugin:RemoteAction action="link" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" autoCreateParent="true" slibrary="libraryname" ppath="library1/sitearea1/sitearea2"]
- copy
- Este parámetro sirve para realizar una copia de un elemento. Por ejemplo, para copiar un elemento de contenido en una nueva área de sitio:
- [plugin:RemoteAction action="copy" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID2"]
Existe la posibilidad de utilizar los siguientes parámetros adicionales a la hora de realizar la copia:- copyAsDraft="true"
Se reiniciará el flujo de trabajo de la copia que se está creando. En la mayoría de los casos lo que ocurrirá es que la copia se creará con un estado de borrador.
- wid="com.ibm.workplace.wcm.api.WCM_Workflow/ID1"
Sirve para especificar que se debe utilizar un flujo de trabajo diferente a la hora de crear la copia. También se reiniciará el flujo de trabajo de la copia que se está creando. En la mayoría de los casos lo que ocurrirá es que la copia se creará con un estado de borrador.
- position="start"
Creará la copia como el primer elemento bajo el elemento padre especificado. Si no se especifica, el elemento se copiará como el último hijo del elemento padre especificado.
Al copiar elementos existe la posibilidad de especificar la vía de acceso al elemento padre mediante el parámetro ppath en lugar del parámetro pid:- [plugin:RemoteAction action="copy" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" ppath="library1/sitearea1/sitearea2"]
Al copiar con elementos existe la posibilidad de crear un nuevo elemento padre mediante el parámetro autoCreateParent. Debe especificar también la biblioteca donde se encuentra el elemento que se copia utilizando el parámetro slibrary. Se utiliza el parámetro ppath para especificar el padre existente bajo el que se crea el nuevo elemento padre:- [plugin:RemoteAction action="copy" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" autoCreateParent="true" slibrary="libraryname" ppath="library1/sitearea1/sitearea2"]
- approve
- Se utiliza para aprobar un elemento en un flujo de trabajo. También es necesario especificar el docid del elemento.Por ejemplo:
- [plugin:RemoteAction action="approve" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- decline
- Se utiliza para rechazar un elemento en un flujo de trabajo. También es necesario especificar el docid del elemento.Por ejemplo:
- [plugin:RemoteAction action="decline" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- saveandapprove
- Se utiliza para aprobar un elemento en un flujo de trabajo en donde dicho elemento está actualmente abierto en modalidad de edición dentro de la misma sesión. También es necesario especificar el docid del elemento.Por ejemplo:
- [plugin:RemoteAction action="saveandapprove" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- [plugin:RemoteAction action="saveandapprove" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" isdraft="true"]
- previousstage
- Se utiliza para mover un elemento a la página anterior en un flujo de trabajo.
También es necesario especificar el docid del elemento.Por ejemplo:
- [plugin:RemoteAction action="previousstage" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- viewversions
- Se utiliza para abrir el diálogo de versiones para un elemento. También es necesario especificar el docid del elemento.Por ejemplo:
- [plugin:RemoteAction action="viewversions" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- viewhistory
- Se utiliza para abrir el diálogo de historial para un elemento. También es necesario especificar el docid del elemento.Por ejemplo:
- [plugin:RemoteAction action="viewhistory" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
Cómo llenar campos al crear o editar contenido
Al utilizar los parámetros "new" o "edit" con elementos de contenido, también se pueden añadir datos a distintos campos en el elemento de contenido utilizando un URL.
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.content.name="newcontent"]
- wcmfield.content.name=
- wcmfield.content.title=
- wcmfield.content.description=
- wcmfield.content.authors=
- wcmfield.content.owners=
- wcmfield.content.publishDate=
- wcmfield.content.expiryDate=
- wcmfield.content.generalDateOne=
- wcmfield.content.generalDateTwo=
- wcmfield.content.workflow= (únicamente se puede utilizar al crear contenido).
- wcmfield.content.categories=
- wcmfield.content.keywords=
- wcmfield.element.elementname= Nota: elementname= se puede sustituir con el nombre del elemento que está llenando. El parámetro element sólo se puede utilizar con los siguientes tipos de elemento:
- Texto
- Html
- Texto enriquecido
- Selección de opción
- Selección de usuario
- Fecha y hora
- Número
- JSP
- Enlace
- Referencia de componente
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.content.authors="uid=usera,cn=cn-name,dc=dc-name"]
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.content.workflow="ID1"]
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.content.categories="ID1"]
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.content.generalDateOne="Feb 14, 2008 12:53:03 PM"]
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.content.generalDateOne="Feb 14, 2008"]
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.jspelementname="/wps/wcm/jsp/html/example.jsp"]
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.mycompref.type="com.aptrix.pluto.cmpnt.NavigatorCmpnt" wcmfield.element.mycompref.id="e4bdf10042d0769698ccbeb0e25cc973"]
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname="AA" wcmfield.element.elementname="BB"]
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname="uid=wpsadmin,o=defaultWimFileBasedRealm" wcmfield.element.elementname="uid=wpsadmin2,o=defaultWimFileBasedRealm"]
- Añadiendo un enlace a un elemento de contenido:
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="content" wcmfield.element.elementname.id="contentID"]
- Añadiendo un enlace a un componente de enlace:
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="link" wcmfield.element.elementname.id="linkcomponentID"]
- Añadiendo un enlace a un componente de recurso de archivo o imagen:
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="resource" wcmfield.element.elementname.id="componentID"]
- Añadiendo un enlace a un URL:
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="external" wcmfield.element.elementname.externalReference="myurl"]
- Al especificar si debe utilizarse el nombre del elemento al que está enlazando como el texto de enlace, añada esto al código:
- wcmfield.element.elementname.useReferenceLinkText="true"
- Al especificar una imagen para visualizar como el enlace, añada esto al código:
- wcmfield.element.elementname.linkImage="imagecomponentID"
- Al especificar el texto del enlace, añada esto al URL:
- wcmfield.element.elementname.linkText="text"
- Al especificar la descripción del enlace, añada esto al URL:
- wcmfield.element.elementname.linkDescription="text"
- Al especificar un destino de enlace, añada esto al URL:
- wcmfield.element.elementname.linkTarget=
- _blank
- _parent
- _self
- _top
- targetname
Parámetros Save
Se pueden añadir los siguientes parámetros "save" a un código de acción remota.
- autoSave
- Se utiliza para guardar un controlable. Esto ocurre en un segundo plano y no se visualiza a los usuarios.Por ejemplo:
- wcmfield.autosave="true"
- saveValidate
- Este parámetro determina si se visualizan al usuario mensajes de error y de aviso de autosave. Si se establece en "true" se visualizarán al usuario mensajes de error y aviso. Si se establece en false, se suprimen los mensajes. El valor predeterminado es true.Por ejemplo:
- &wcmfield.saveValidate="false"
Adición de comentarios al historial de elementos.
Al crear elementos que utilizan un flujo de trabajo con "Especificar comentario sobre la aprobación" establecido en true, puede añadir un comentario al historial de elementos añadiendo comment="comment text" al URL.
[plugin:RemoteAction action="edit" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" createDraft="true" comment="comment text"]
Ejemplos
- Código: [plugin:RemoteAction action="viewversions" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=viewversions&docid=com.ibm.workplace.wcm.api.WCM_Content/ID1
- Código: [plugin:RemoteAction action="viewhistory" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=viewhistory&docid=com.ibm.workplace.wcm.api.WCM_Content/ID1
- Código: [plugin:RemoteAction action="read" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=read&docid=com.ibm.workplace.wcm.api.WCM_Content/ID1
- Código: [plugin:RemoteAction action="edit" &docid=com.ibm.workplace.wcm.api.WCM_Content/ID1]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=edit&docid=com.ibm.workplace.wcm.api.WCM_Content/ID1
- Código: [plugin:RemoteAction action="move" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" moveDirection="1" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID1"]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=move&docid=com.ibm.workplace.wcm.api.WCM_Content/ID1&moveDirection=1&pid=com.ibm.workplace.wcm.api.WCM_SiteArea/ID1
- Código: [plugin:RemoteAction action="move" docid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID1" "moveDirection="-1" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID1"]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=move&docid=com.ibm.workplace.wcm.api.WCM_SiteArea/ID1&moveDirection=-1&pid=com.ibm.workplace.wcm.api.WCM_SiteArea/ID1
- Código: [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.content.title="newcontent"]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=new&type=com.ibm.workplace.wcm.api.WCM_Content&wcmfield.content.title=newcontent
- Código: [plugin:RemoteAction action="edit" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" wcmfield.content.keywords="keyword1" wcmfield.content.keywords="keyword2"]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=edit&docid=com.ibm.workplace.wcm.api.WCM_Content/ID1&wcmfield.content.keywords=keyword1&wcmfield.content.keywords=keyword2
- Código: [plugin:RemoteAction action="edit" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" wcmfield.content.keywords="keyword1" wcmfield.content.keywords="keyword2" wcmfield.autosave="true"]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=edit&docid=com.ibm.workplace.wcm.api.WCM_Content/ID1&wcmfield.content.keywords=keyword1&wcmfield.content.keywords=keyword2&wcmfield.autosave=true
- Código: [plugin:RemoteAction action="edit" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" wcmfield.content.keywords="keyword1" wcmfield.autosave="true" wcmfield.saveValidate="false"]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=edit&docid=com.ibm.workplace.wcm.api.WCM_Content/ID1&wcmfield.content.keywords=keyword1&wcmfield.autosave=true&wcmfield.saveValidate=false
- Código: [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" atid="com.ibm.workplace.wcm.api.WCM_AuthoringTemplate/ID1" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID2" wcmfield.content.name="newcontent" wcmfield.autosave="true" wcmfield.saveValidate="true"]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=new&type=com.ibm.workplace.wcm.api.WCM_Content&atid=com.ibm.workplace.wcm.api.WCM_AuthoringTemplate/ID1&pid=com.ibm.workplace.wcm.api.WCM_SiteArea/ID2&wcmfield.content.name=newcontent&wcmfield.autosave=true&wcmfield.saveValidate=true
- Código: [plugin:RemoteAction action="edit" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" createDraft="true" comment="comment"]
- URL: http://<host>/wps/myportal/wcmAuthoring?wcmAuthoringAction=edit&docid=com.ibm.workplace.wcm.api.WCM_Content/ID1&createDraft=true&comment=comment