Création d'une classe d'action de flux de travaux personnalisée
Vous pouvez créer des classes d'actions de flux de travaux personnalisées pour ajouter des actions de flux de travaux personnalisées à un flux de travaux.
Création de la classe d'action de flux de travaux personnalisée
- Créez une classe java qui implémente l'interface
com.ibm.workplace.wcm.api.custom.CustomWorkflowAction
. Cette classe peut implémenter les méthodes suivantes :public Date getExecuteDate(Document p_document) {}
(Cette méthode indique à quel moment l'action personnalisée est exécutée.)public CustomWorkflowActionResult execute(Document p_document) {}
(Cette méthode contient le code qui est exécuté lorsque l'action personnalisée est exécutée.)
- Mettre en œuvre
execute()method
. Cette méthode contient le code qui est exécuté par rapport au document fourni. Cette méthode doit renvoyer un objetcom.ibm.workplace.wcm.api.custom.CustomWorkflowActionResult
pour indiquer le résultat du code personnalisé à l'aide decom.ibm.workplace.wcm.api.custom.Directives
.- Une action de flux de travaux personnalisée est créée en récupérant une référence à l'objet
WebContentCustomWorkflowService
, puis en appelant la méthodewebContentCustomWorkflowService.getCustomWorkflowService().createResult
. SiCustomWorkflowActionResult
ne mentionne aucun incident, les modifications apportées au document sont enregistrées.Consultez la documentation Javadoc pour plus d'informations. The Javadoc files for Web Content Manager are in the
PortalServer_root/doc/Javadoc/spi_docs/com/ibm/workplace/wcm
directory. - Pour plus d'informations, voir également la documentation Java sur Web Content Manager.
- Une action de flux de travaux personnalisée est créée en récupérant une référence à l'objet
- Créez une classe de fabrique d'action de flux de travaux personnalisée qui implémente l'interface
com.ibm.workplace.wcm.api.custom.CustomWorkflowActionFactory
.
Création d'un fichier plugin.xml
Un fichier plugin.xml est requis, que le déploiement soit effectué via un fichier WAR, EAR ou JAR. Si vous effectuez un déploiement via une application dans un fichier WAR ou EAR, ajoutez le fichier plugin.xml au dossier WEB-INF de l'application. Lorsque vous utilisez un fichier JAR, vous devez inclure le fichier plugin.xml à la racine de ce fichier JAR.
<?xml version="1.0" encoding="UTF-8"?> <plugin id="com.ibm.workplace.wcm.sample.customworkflowaction" name="Sample Custom Workflow Action Factory" version="1.0.0" provider-name="IBM"> <extension point="com.ibm.workplace.wcm.api.CustomWorkflowActionFactory" id="SimpleCustomWorkflowActionFactory"> <provider class="com.ibm.workplace.wcm.sample.customworkflowaction.SimpleCustomWorkflowActionFactory"/> </extension> </plugin>
- L'ID de chaque plug-in doit être unique. Vous devez remplacer l'ID plug-in spécifié dans cet exemple, com.ibm.workplace.wcm.sample.customworkflowaction, par un ID différent pour chaque flux de travaux personnalisé que vous créez.
- Chaque fabrique d'action de flux de travaux personnalisée est représentée par une balise
<extension></extension>
unique. - La valeur de l'attribut de point doit être
com.ibm.workplace.wcm.api.CustomWorkflowActionFactory
. - Entrez l'ID de votre choix.
- Indiquez la classe de fournisseur associée à votre fabrique d'actions de flux de travaux personnalisée.
Naming conventions :
Si vous créez une nouvelle application de plug-in associée aux mêmes nom et ID qu'un plug-in existant, le nouveau plug-in risque de remplacer le premier. Lorsque vous créez des applications de plug-in, vérifiez que les éléments suivants sont uniques sur votre système :
- L'ID plug-in, le nom de plug-in et l'ID extension du fichier plugin.xml.
- Le nom de classe qualifié complet et le chemin de toutes les classes dans l'application.
- le chemin d'accès aux fichiers de l'application.