Utilisation des actions distantes
Remote actions are used to trigger actions from the HCL Web Content Manager application.
[plugin:RemoteAction action=" " docid=" " dialog=" " dialogSize=" " dialogTitle=" " useCurrentContext=" " showInfoMsg=" " ]
action
- Action distante à exécuter.
docid
- ID document de l'élément sur lequel exécuter l'action distante.
useCurrentContext
- S'il est défini sur true, l'ID document est obtenu à partir du contexte d'affichage et non de l'attribut docid.
dialog
- Si la valeur est true, lors de l'affichage dans un portlet Afficheur de contenu Web, l'action distante est affichée en tant qu'adresse URL qui redirige l'utilisateur vers une page de portail masquée utilisée par le portlet Afficheur de contenu Web pour l'édition en ligne.
dialogSize
- Ce paramètre facultatif définit la taille de la boîte de dialogue exécutant l'action distante. Cette valeur doit être au format "largeur,hauteur". Par exemple,
dialogSize="200,300"
pour un dialogue d'une largeur de 200 pixels et d'une hauteur de 300 pixels. Si elle est omise, la taille de la boîte de dialogue est calculée à partir du contenu qui est affiché dans la boîte de dialogue. Ce paramètre est utilisé uniquement si dialog="true". dialogTitle
- Ce paramètre facultatif définit le titre de la boîte de dialogue exécutant l'action distante. S'il est omis, le nom de l'action est utilisé à la place. Ce paramètre est utilisé uniquement si dialog="true".
showInfoMsg
- Définissez cette valeur sur true pour afficher l'état de réussite et d'autres messages d'information une fois l'action distante terminée. Si la valeur est omise, ce paramètre est défini sur false et seuls des messages d'avertissement et d'erreur s'affichent. Ce paramètre ne peut être utilisé que si l'option dialog="true" est définie.
http://[host]/wps/myportal/wcmAuthoring?wcmAuthoringAction=actionVous pouvez également ajouter des actions distantes à l'URL d'un portlet d'afficheur de contenu Web local. Ceci peut être utile sur des sites qui proposent une édition en ligne des objets de contenu.
DocumentID.getID()
. Un ID document est constitué d'un type de document et d'un ID unique. Les valeurs du paramètre "docid" fournies dans ces exemples sont les marques de réservation de véritables ID document. Par exemple : com.ibm.workplace.wcm.api.WCM_Content/ID1
Types d'action distante
new
- Permet d'ouvrir un nouveau formulaire d'élément. Vous devez également définir le paramètre "type".Par exemple:
[plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" ]
Vous pouvez utiliser les paramètres "type" suivants :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
Lors de la création d'un objet de contenu, vous pouvez spécifier un modèle de création par défaut en indiquant l'ID document du modèle de création au paramètre atid :[plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" atid="com.ibm.workplace.wcm.api.WCM_AuthoringTemplate/ID1"]
Lors de la création de zones de site, d'objets de contenu et de catégories, vous pouvez spécifier l'ID document de l'objet parent sous lequel vous souhaitez sauvegarder le nouvel objet. Spécifiez cet ID dans le paramètre 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"]
Lorsque vous créez des zones de site, vous pouvez spécifier l'emplacement de la zone de site à l'aide d'un paramètre position. Vous vous spécifiez de sauvegarder la nouvelle zone de site au début ou à la fin par rapport à des zones de site existantes. Si aucune information n'est spécifiée, la nouvelle zone de site est enregistrée au début des zones de site existantes :[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
- Permet de supprimer un objet. Vous devez également spécifier le paramètre docid de l'élément.Par exemple:
[plugin:RemoteAction action="delete" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
edit
- Permet d'ouvrir un formulaire d'objet en mode Edition. Vous devez également spécifier le paramètre docid de l'élément.Par exemple:
[plugin:RemoteAction action="edit" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
read
- Permet d'ouvrir un formulaire d'objet en mode Lecture seule. Vous devez également spécifier le paramètre docid de l'élément.Par exemple:
[plugin:RemoteAction action="read" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
openmainview
- Permet d'ouvrir une vue dans un portlet de création. Vous devez également spécifier un paramètre view.Par exemple:
[plugin:RemoteAction action="openmainview" view="contentbysitearea"]
Vous pouvez utiliser les paramètres "view" suivants :contentbysitearea
contentbytitle
myrecent
mydraft
mypendingapproval
mypublished
myexpired
mydeleted
alldraftitems
allexpireditems
allpublisheditems
alldeleteditems
componentsbytype
move
- Utilisé pour déplacer une zone de site ou un objet de contenu. Par exemple, pour ouvrir la boîte de dialogue de déplacement pour un objet de contenu ou une zone de site :
[plugin:RemoteAction action="move" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
La direction du déplacement est spécifiée par "1" pour un déplacement vers le haut et par "-1" pour un déplacement vers le bas. Par exemple, pour déplacer un objet de contenu d'une position vers le haut :[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
- Permet de lier un objet de contenu à une zone de site. Par exemple:
[plugin:RemoteAction action="link" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID2"]
Lorsque vous liez des objets, vous pouvez spécifier le chemin vers l'objet parent à l'aide du paramètre ppath à la place du paramètre pid :[plugin:RemoteAction action="link" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" ppath="library1/sitearea1/sitearea2"]
Lorsque vous liez des objets, vous pouvez créer un nouvel objet parent à l'aide du paramètre autoCreateParent. Vous devez également spécifier la bibliothèque dans laquelle se trouve l'objet en cours de liaison à l'aide du paramètre slibrary. Le paramètre ppath permet de spécifier le paramètre existant sous lequel le nouvel objet parent est créé :[plugin:RemoteAction action="link" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" autoCreateParent="true" slibrary="libraryname" ppath="library1/sitearea1/sitearea2"]
copy
- Permet de copier un objet. Par exemple, pour copier un objet de contenu dans une nouvelle zone de site, entrez l'expression suivante :
[plugin:RemoteAction action="copy" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" pid="com.ibm.workplace.wcm.api.WCM_SiteArea/ID2"]
Vous pouvez utiliser les paramètres supplémentaires suivants pour la copie :copyAsDraft="true"
Ce paramètre redémarre le flux de travaux de la copie en cours. Dans la plupart des cas, la copie est créée en tant que brouillon.
wid="com.ibm.workplace.wcm.api.WCM_Workflow/ID1"
Utilisez ce paramètre pour indiquer un autre flux de travaux à utiliser pour créer la copie. Ce paramètre redémarre également le flux de travaux de la copie en cours. Dans la plupart des cas, la copie est créée en tant que brouillon.
position="start"
Ce paramètre crée la copie en tant que premier objet de l'objet parent spécifié. Si vous n'indiquez pas ce paramètre, l'objet est copié en tant que dernier enfant de l'objet parent spécifié.
Lorsque vous copiez des objets, vous pouvez spécifier le chemin vers l'objet parent à l'aide du paramètre ppath à la place du paramètre pid :[plugin:RemoteAction action="copy" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" ppath="library1/sitearea1/sitearea2"]
Lorsque vous copiez des éléments, vous pouvez créer un nouvel élément parent à l'aide du paramètre autoCreateParent. Vous devez également spécifier la bibliothèque dans laquelle se trouve l'objet en cours de copie à l'aide du paramètre slibrary. Le paramètre ppath permet de spécifier le paramètre existant sous lequel le nouvel objet parent est créé :[plugin:RemoteAction action="copy" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1" autoCreateParent="true" slibrary="libraryname" ppath="library1/sitearea1/sitearea2"]
approve
- Permet de valider un objet dans un flux de travaux. Vous devez également spécifier le paramètre docid de l'élément.Par exemple:
[plugin:RemoteAction action="approve" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
decline
- Permet de refuser un objet dans un flux de travaux. Vous devez également spécifier le paramètre docid de l'élément.Par exemple:
[plugin:RemoteAction action="decline" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
saveandapprove
- Permet de valider un objet dans un flux de travaux dans lequel cet objet est ouvert en mode édition dans la même session. Vous devez également spécifier le paramètre docid de l'élément.Par exemple:
[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
- Permet de déplacer un élément à l'étape précédente d'un flux de travaux. Vous devez également spécifier le paramètre docid de l'élément.Par exemple:
[plugin:RemoteAction action="previousstage" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
viewversions
- Ceci permet d'ouvrir la boîte de dialogue des versions d'un objet. Vous devez également spécifier le paramètre docid de l'élément.Par exemple:
[plugin:RemoteAction action="viewversions" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
viewhistory
- Ceci permet d'ouvrir la boîte de dialogue de l'historique d'un objet. Vous devez également spécifier le paramètre docid de l'élément.Par exemple:
[plugin:RemoteAction action="viewhistory" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"]
Renseignement des zones lors de la création ou l'édition de contenu
Lors de l'utilisation des paramètres "new" ou "edit" avec des objets de contenu, vous pouvez également ajouter des données à différentes zones de l'objet de contenu en utilisant une adresse 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=
(ne peut être utilisé que lors de la création de contenu)wcmfield.content.categories=
wcmfield.content.keywords=
wcmfield.element.elementname=
Remarque : Remplacez elementname par le nom de l'élément que vous remplissez. Le paramètre element ne peut être utilisé qu'avec les types d'éléments suivants :- Texte
- Html
- Texte riche
- Sélection d'option
- Sélection utilisateur
- Date et heure
- Nombre
- JSP
- Lien
- Référence de composant
[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"]
- Ajout d'un lien à un objet de contenu :
[plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="content" wcmfield.element.elementname.id="contentID"]
- Ajout d'un lien à composant de lien :
[plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="link" wcmfield.element.elementname.id="linkcomponentID"]
- Ajout d'un lien à un composant de ressource de fichier ou d'image :
[plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="resource" wcmfield.element.elementname.id="componentID"]
- Ajout d'un lien à une URL :
[plugin:RemoteAction action="new" type="com.ibm.workplace.wcm.api.WCM_Content" wcmfield.element.elementname.type="external" wcmfield.element.elementname.externalReference="myurl"]
- Pour spécifier l'utilisation du nom de l'élément lié en tant que texte de lien, ajoutez ce qui suit à la balise :
wcmfield.element.elementname.useReferenceLinkText="true"
- Pour spécifier une image à afficher en tant que lien, ajoutez ce qui suit à la balise :
wcmfield.element.elementname.linkImage="imagecomponentID"
- Pour spécifier le texte du lien, ajoutez ce qui suit à l'URL :
wcmfield.element.elementname.linkText="text"
- Pour spécifier la description du lien, ajoutez ce qui suit à l'URL :
wcmfield.element.elementname.linkDescription="text"
- Pour spécifier une cible de lien, ajoutez ce qui suit à l'URL :
wcmfield.element.elementname.linkTarget=
_blank
_parent
_self
_top
targetname
Paramètres save
Vous pouvez ajouter les paramètres "save" suivants à une balise d'action distante.
autoSave
- Permet d'enregistrer un contrôlable. Cette opération a lieu en arrière-plan et ne s'affiche aux utilisateurs.Par exemple:
wcmfield.autosave="true"
saveValidate
- Ce paramètre détermine si les messages d'avertissement et d'erreur résultant de la sauvegarde automatique sont affichés pour l'utilisateur. Si sa valeur est "true", les messages d'avertissement et d'erreur sont affichés pour l'utilisateur. En revanche, si sa valeur est false, les messages sont supprimés. La valeur par défaut est true.Par exemple:
&wcmfield.saveValidate="false"
Ajout de commentaires à l'historique de l'élément
Lorsque vous créez des éléments qui utilisent un flux de travaux avec l'option "Entrer un commentaire sur l'acceptation" définie sur true, vous pouvez ajouter un commentaire à l'historique de l'élément en ajoutant comment="comment text"
à l'URL.
[plugin:RemoteAction action="edit" docid="com.ibm.workplace.wcm.api.WCM_Content/ID1"
createDraft="true" comment="comment text"]
Exemples
- Balise :
[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
- Balise :
[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
- Balise :
[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
- Balise :
[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
- Balise :
[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
- Balise :
[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
- Balise :
[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
- Balise :
[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
- Balise :
[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
- Balise :
[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
- Balise :
[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
- Balise :
[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