Assistência ao utilizador para autores de conteúdo |
---|
Utilizar suplementos de acção remotas
Os suplementos de acções remotas são utilizados para accionar acções a partir da aplicação do IBM® Web Content Manager.
[plugin:RemoteAction action=" " docid=" " dialog=" " dialogSize=" " dialogTitle=" " useCurrentContext=" " showInfoMsg=" " ]
- action
- Trata-se da acção remota a executar.
- docid
- Trata-se do ID de documento do item no qual a acção remota é executada.
- useCurrentContext
- Se definido como true, o ID de documento é obtido a partir do contexto de apresentação, em vez do atributo docid.
- dialog
- Se definido como true, ao apresentar com a portlet de visualizador de conteúdo da Web JSR 286, a acção remota é apresentada como um URL que redirecciona o utilizador para uma página do portal oculta utilizada pelo visualizador de conteúdo da Web JSR 286 para edição incluída.
- dialogSize
- Esta definição opcional especifica o tamanho da caixa de diálogo que está a executar a acção remota. O valor tem de estar no formato "largura,altura". Por exemplo, dialogSize="200,300" para uma caixa de diálogo com uma largura de 200 píxeis e uma altura de 300 píxeis. Caso seja omitida, o tamanho da caixa de diálogo é calculado a partir do conteúdo apresentado na caixa de diálogo. Esta definição é apenas utilizada se dialog="true".
- dialogTitle
- Esta definição opcional especifica o título da caixa de diálogo que está a executar a acção remota. Se omitida, é utilizado o nome da acção em alternativa. Esta definição é apenas utilizada se dialog="true".
- showInfoMsg
- Defina como true para apresentar mensagens de estado de êxito e outras mensagens informativas após a acção remota estar concluída. Em caso de omissão, este parâmetro é definido como false e apenas são apresentadas mensagens de aviso e de estado de erro. Esta definição é apenas utilizada se dialog="true".
http://[host]/wps/myportal/wcmAuthoring?wcmAuthoringAction=actionPode também acrescentar suplementos de acção remota ao URL de uma portlet de visualizador de conteúdo da Web local. Este procedimento pode ser útil em sítios que contêm a edição incluída de itens de conteúdo.
Tipos de acções remotas
- new
- É utilizado para abrir um novo formulário do item. Tem igualmente de especificar um parâmetro "type".Por exemplo:
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" ]
É possível utilizar os seguintes parâmetros de tipo:- 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
Ao criar um novo item de conteúdo, pode especificar um modelo de autoria predefinido fornecendo o ID de documento do modelo de autoria no parâmetro atid:- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" atid="com.ibm.workplace.wcm.api.WCM_AuthoringTemplate/ID1"]
Ao criar áreas do sítio, itens de conteúdo e categorias, pode especificar o ID de documento do item ascendente para guardar o novo item. Especifique este ID no 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"]
Ao criar áreas do sítio, pode especificar a posição da nova área do sítio utilizando um parâmetro position. Pode especificar para guardar a nova área do sítio no início ou no fim, relativamente a quaisquer áreas do sítio existentes. Caso não seja especificado, a nova área do sítio será guardada no início, relativamente a quaisquer áreas do sítio existentes:- [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
- É utilizado para eliminar um item. Tem igualmente de especificar o
docid do item.Por exemplo:
- [plugin:RemoteAction action="delete" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- edit
- É utilizado para abrir um formulário do item em modo de edição. Tem igualmente de especificar o
docid do item.Por exemplo:
- [plugin:RemoteAction action="edit" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- read
- É utilizado para abrir um formulário do item no modo só de leitura. Tem igualmente de especificar o
docid do item.Por exemplo:
- [plugin:RemoteAction action="read" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- openmainview
- É utilizado para abrir uma vista numa portlet de autoria. Tem igualmente de
especificar um parâmetro
view.Por exemplo:
- [plugin:RemoteAction action="openmainview" view="contentbysitearea"]
É possível utilizar os seguintes parâmetros de vista:- contentbysitearea
- contentbytitle
- myrecent
- mydraft
- mypendingapproval
- mypublished
- myexpired
- mydeleted
- alldraftitems
- allexpireditems
- allpublisheditems
- alldeleteditems
- componentsbytype
- move
- É utilizado para mover uma área do sítio ou item de conteúdo. Por exemplo, para abrir a caixa de diálogo Mover para um item de conteúdo ou área do sítio:
- [plugin:RemoteAction action="move" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
Uma direcção para mover é especificada como "1" para cima e "-1" para baixo. Por exemplo, para mover um item de conteúdo uma posição para cima:- [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
- Irá ligar um item de conteúdo a uma área do sítio. Por exemplo:
- [plugin:RemoteAction action="link" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID2"]
Ao ligar itens, é possível especificar o caminho para o item ascendente utilizando o parâmetro ppath em vez do parâmetro pid:- [plugin:RemoteAction action="link" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" ppath="library1/sitearea1/sitearea2"]
Ao ligar itens, é possível criar um novo item ascendente utilizando o parâmetro autoCreateParent. Tem também de especificar a biblioteca na qual está localizado o item a ser ligado utilizando o parâmetro slibrary. O parâmetro ppath é utilizado para especificar o ascendente existente sob o qual o novo item ascendente é criado:- [plugin:RemoteAction action="link" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" autoCreateParent="true" slibrary="libraryname" ppath="library1/sitearea1/sitearea2"]
- copy
- É utilizado para fazer uma cópia de um item. Por exemplo, para copiar um item de conteúdo para uma nova área do sítio:
- [plugin:RemoteAction action="copy" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID2"]
É possível utilizar os seguintes parâmetros adicionais ao copiar:- copyAsDraft="true"
Irá reiniciar o fluxo de trabalho da cópia a ser criada. Na maioria dos casos, poderá resultar na criação da cópia com um estado de rascunho.
- wid="com.ibm.workplace.wcm.api.WCM_Workflow/ID1"
Utilize este parâmetro para especificar um fluxo de trabalho diferente a utilizar ao criar a cópia. Irá igualmente reiniciar o fluxo de trabalho da cópia a ser criada. Na maioria dos casos, poderá resultar na criação da cópia com um estado de rascunho.
- position="start"
Irá criar a cópia como primeiro item sob o item ascendente especificado. Caso não seja especificado, o item será copiado como o último descendente do item ascendente especificado.
Ao copiar itens, pode especificar o caminho para o item ascendente utilizando o parâmetro ppath em vez do parâmetro pid:- [plugin:RemoteAction action="copy" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" ppath="library1/sitearea1/sitearea2"]
Ao copiar itens, pode criar um novo item ascendente utilizando o parâmetro autoCreateParent. Tem também de especificar a biblioteca na qual está localizado o item a ser copiado utilizando o parâmetro slibrary. O parâmetro ppath é utilizado para especificar o ascendente existente sob o qual o novo item ascendente é criado:- [plugin:RemoteAction action="copy" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" autoCreateParent="true" slibrary="libraryname" ppath="library1/sitearea1/sitearea2"]
- approve
- É utilizado para aprovar um item num fluxo de trabalho. Tem igualmente de especificar o
docid do item.Por exemplo:
- [plugin:RemoteAction action="approve" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- decline
- É utilizado para recusar um item num fluxo de trabalho. Tem igualmente de especificar o
docid do item.Por exemplo:
- [plugin:RemoteAction action="decline" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- saveandapprove
- É utilizado para aprovar um item num fluxo de trabalho, no qual esse item
está actualmente aberto em modo de edição, na mesma sessão. Tem igualmente de especificar o
docid do item.Por exemplo:
- [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
- É utilizado para mover um item para a etapa anterior num fluxo de trabalho.
Tem igualmente de especificar o
docid do item.Por exemplo:
- [plugin:RemoteAction action="previousstage" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- viewversions
- É utilizado para abrir a caixa de diálogo de versões de um item. Tem igualmente de especificar o
docid do item.Por exemplo:
- [plugin:RemoteAction action="viewversions" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
- viewhistory
- É utilizado para abrir a caixa de diálogo do histórico de um item. Tem igualmente de especificar o
docid do item.Por exemplo:
- [plugin:RemoteAction action="viewhistory" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
Preencher campos ao criar ou editar conteúdo
Ao utilizar os parâmetros "new" ou "edit" com itens de conteúdo, pode também adicionar dados a campos diferentes no item de conteúdo utilizando um 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= (Apenas pode ser utilizado aquando da criação de conteúdo.)
- wcmfield.content.categories=
- wcmfield.content.keywords=
- wcmfield.element.elementname= Nota: Substitua elementname= pelo nome do elemento que está a preencher. O parâmetro do elemento apenas pode ser utilizado com os seguintes tipos de elementos:
- Texto
- Html
- Rich text
- Selecção de opções
- Selecção de utilizador
- Data e hora
- Número
- JSP
- Ligação
- Referência 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"]
- Adicionar uma ligação a um item de conteúdo:
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="content" wcmfield.element.elementname.id="contentID"]
- Adicionar uma ligação a um componente de ligação:
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="link" wcmfield.element.elementname.id="linkcomponentID"]
- Adicionar uma ligação a um componente de recurso de ficheiros ou imagens:
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="resource" wcmfield.element.elementname.id="componentID"]
- Adicionar uma ligação a um URL:
- [plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="external" wcmfield.element.elementname.externalReference="myurl"]
- Para especificar se deverá ser utilizado o nome do item ao qual está a ligar como texto de ligação, adicione o seguinte ao controlo:
- wcmfield.element.elementname.useReferenceLinkText="true"
- Ao especificar uma imagem a apresentar como ligação, adicione o seguinte ao controlo:
- wcmfield.element.elementname.linkImage="imagecomponentID"
- Ao especificar o texto da ligação, adicione o seguinte ao URL:
- wcmfield.element.elementname.linkText="text"
- Ao especificar a descrição da ligação, adicione o seguinte ao URL:
- wcmfield.element.elementname.linkDescription="text"
- Ao especificar o destino de uma ligação, adicione o seguinte ao URL:
- wcmfield.element.elementname.linkTarget=
- _blank
- _parent
- _self
- _top
- targetname
Parâmetro de gravação
É possível adicionar os seguintes parâmetros de "gravação" a um controlo de acção remota.
- autoSave
- É utilizado para guardar um controllable. Esta acção ocorre em segundo plano e não é apresentada aos utilizadores.Por exemplo:
- wcmfield.autosave="true"
- saveValidate
- Este parâmetro determina se serão apresentadas ao utilizador mensagens de erro e de aviso resultantes da gravação automática. Se definido como "true", as mensagens de erro e de aviso serão apresentadas ao utilizador. Se definido como "false", as mensagens são suprimidas. A predefinição é true.Por exemplo:
- &wcmfield.saveValidate="false"
Adicionar comentários ao histórico do item
Ao criar itens que utilizam um fluxo de trabalho com a opção "Introduzir comentário na aprovação" definida como true, pode adicionar um comentário ao histórico do item, adicionando comment="comment text" ao URL.
[plugin:RemoteAction action="edit" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" createDraft="true" comment="comment text"]
Exemplos
- Controlo: [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
- Controlo: [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
- Controlo: [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
- Controlo: [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
- Controlo: [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
- Controlo: [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
- Controlo: [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
- Controlo: [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
- Controlo: [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
- Controlo: [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
- Controlo: [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
- Controlo: [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