From portal-commits at lists.jboss.org Fri Jul 18 17:07:01 2008
Content-Type: multipart/mixed; boundary="===============6853754795293541979=="
MIME-Version: 1.0
From: portal-commits at lists.jboss.org
To: portal-commits at lists.jboss.org
Subject: [portal-commits] JBoss Portal SVN: r11505 -
 docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules.
Date: Fri, 18 Jul 2008 17:07:00 -0400
Message-ID: <E1KJxAK-0003BW-Uo@committer01.frg.pub.inap.atl.jboss.com>

--===============6853754795293541979==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: chris.laprun(a)jboss.com
Date: 2008-07-18 17:07:00 -0400 (Fri, 18 Jul 2008)
New Revision: 11505

Modified:
   docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/workflow=
.xml
Log:
- JBPORTAL-1757: Updated workflow documentation.

Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/w=
orkflow.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/workflo=
w.xml	2008-07-18 20:59:11 UTC (rev 11504)
+++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/workflo=
w.xml	2008-07-18 21:07:00 UTC (rev 11505)
@@ -9,170 +9,120 @@
    </chapterinfo>
    <title>Portal Workflow</title>
    <para>
-   		JBoss Portal packages a Workflow Service based on JBPM. This service =
provides you with the JBPM services that your portal can use
-   		to build out the end-user/application workflows that should meet your=
 portal's requirements. =

+      JBoss Portal packages a Workflow Service based on jBPM. This service=
 provides you with the jBPM services that your
+      portal can use to build out the end-user/application workflows that =
should meet your portal's requirements.
    </para>   =

    <section>
-      <title>JBPM Workflow Engine Integration</title>
+      <title>jBPM Workflow Engine Integration</title>
       <para>
-      	The JBPM Workflow service is packaged as an mbean and takes care of=
 all the low-level JBPM related functions. The configuration is found in
-      	jboss-portal.sar/portal-cms.sar/portal-workflow.sar/META-INF/jboss-=
service.xml. The mbean service configuration is as follows:
-      	<programlisting><![CDATA[<!-- Hibernate service -->   =

-<mbean
-   code=3D"org.jboss.portal.jems.hibernate.SessionFactoryBinder"
-   name=3D"portal:service=3DHibernate,type=3DWorkflow"
-   xmbean-dd=3D""
-   xmbean-code=3D"org.jboss.portal.jems.as.system.JBossServiceModelMBean">
-   <xmbean/>
-   <depends>jboss.jca:service=3DDataSourceBinding,name=3D@portal.datasourc=
e.name@</depends>
-   <attribute name=3D"DoChecking">true</attribute>
-   <attribute name=3D"ConfigLocation">conf/hibernate/workflow/hibernate.cf=
g.xml</attribute>
-   <attribute name=3D"JNDIName">java:/portal/workflow/WorkFlowSessionFacto=
ry</attribute>
-</mbean>
-
-<!-- Workflow service -->   =

-<mbean
-   code=3D"org.jboss.portal.workflow.service.WorkflowServiceImpl"
-   name=3D"portal:service=3DWorkflow,type=3DWorkflowService"
-   xmbean-dd=3D""
-   xmbean-code=3D"org.jboss.portal.jems.as.system.JBossServiceModelMBean">
-   <xmbean/>
-   <depends>portal:service=3DHibernate,type=3DWorkflow</depends>  =

-   <attribute name=3D"JbpmConfigurationXml">
-      <jbpm-configuration>
-         <jbpm-context>
-            <service name=3D"persistence"
-               factory=3D"org.jbpm.persistence.db.DbPersistenceServiceFact=
ory"/> =

-         </jbpm-context>	      	      	      =

-         <string name=3D"resource.hibernate.cfg.xml"
-            value=3D"conf/hibernate/workflow/hibernate.cfg.xml"/>
-         <string name=3D"resource.business.calendar"
-            value=3D"org/jbpm/calendar/jbpm.business.calendar.properties"/>
-         <string name=3D"resource.default.modules"
-            value=3D"org/jbpm/graph/def/jbpm.default.modules.properties"/>
-         <string name=3D"resource.converter"
-            value=3D"org/jbpm/db/hibernate/jbpm.converter.properties"/>
-         <string name=3D"resource.action.types" value=3D"org/jbpm/graph/ac=
tion/action.types.xml"/>
-         <string name=3D"resource.node.types" value=3D"org/jbpm/graph/node=
/node.types.xml"/>
-         <string name=3D"resource.varmapping" value=3D"org/jbpm/context/ex=
e/jbpm.varmapping.xml"/>
-      </jbpm-configuration>
-   </attribute>
-</mbean>
-      	]]>
-      	</programlisting>
+         The jBPM Workflow service is packaged as an mbean and takes care =
of all the low-level jBPM related functions.
+         The configuration is found in <filename>portal-workflow.sar/META-=
INF/jboss-service.xml</filename>.
       </para>
    </section>
    <section>
-   		<title>CMS Publish/Approve Workflow Service</title>
-   		<para>
-   		The CMS Publish/Approval Workflow feature can be optionally turned on=
 so that, every file that is created or updated needs to go through an <emp=
hasis role=3D"bold">Approval process</emphasis> =

-   		before it can be published to go Live. The current implementation, cr=
eates a pending queue for managers. The managers can then either approve or=
 reject the publishing of the document in question.   		=

-   		</para>
-   		<sect1>
-   			<title>How activate this feature?</title>
-   			<para>
-   				In the following file, jboss-portal.sar/portal-cms.sar/META-INF/jbo=
ss-service.xml, activate this feature on the org.jboss.portal.cms.impl.jcr.=
JCRCMS MBean
-   				<programlisting>
-   				<![CDATA[
+      <title>CMS Publish/Approve Workflow Service</title>
+      <para>
+         The CMS Publish/Approval Workflow feature is turned on by default=
, so that every file that is created or
+         updated needs to go through an <emphasis role=3D"bold">approval p=
rocess</emphasis> before it can be published to
+         go live. The current implementation creates a pending queue for m=
anagers. The managers can then either approve
+         or reject the publishing of the document in question.
+      </para>
+      <sect1>
+         <title>How to deactivate this feature?</title>
+         <para>
+            The CMS Publish/Approval Workflow feature can be deactivated b=
y commenting out the
+            <literal>ApprovePublishWorkflow</literal> attribute of the <li=
teral>portal:service=3DCMS</literal> mbean in
+            <filename>portal-cms.sar/META-INF/jboss-service.xml</filename>:
+            <programlisting><![CDATA[
 <mbean
-   code=3D"org.jboss.portal.cms.impl.jcr.JCRCMS"
-   name=3D"portal:service=3DCMS"
-   xmbean-dd=3D""
-   xmbean-code=3D"org.jboss.portal.jems.as.system.JBossServiceModelMBean">
-   <xmbean/>
-   <!-- The datasource hibernate depends on,
-        it can be commented when the file store is used -->
-   <depends>jboss.jca:service=3DDataSourceBinding,name=3DPortalDS</depends>
-   <depends>portal:service=3DJAASLoginModule</depends>
-   <depends>portal:service=3DHibernate,type=3DCMS</depends>
-   <depends>portal:service=3DModule,type=3DIdentityServiceController</depe=
nds>
-			=

-   <!-- Uncomment this to activate publish/approval workflow integration -=
->
-   <depends optional-attribute-name=3D"ApprovePublishWorkflow"
-      proxy-type=3D"attribute">portal:service=3DApprovePublish,type=3DWork=
flow</depends>
-			=

-   <depends optional-attribute-name=3D"StackFactory" proxy-type=3D"attribu=
te">
-      portal:service=3DInterceptorStackFactory,type=3DCms
-   </depends>            =

-   <attribute name=3D"DoChecking">true</attribute>
-   <attribute name=3D"DefaultContentLocation">
-                                       portal/cms/conf/default-content/def=
ault/</attribute>
-   <attribute name=3D"DefaultLocale">en</attribute>
-   <attribute name=3D"RepositoryName">PortalRepository</attribute>
-   <attribute name=3D"HomeDir">${jboss.server.data.dir}${/}portal${/}cms${=
/}conf</attribute>      =

-   <attribute name=3D"Config">
-   				]]>
-   				</programlisting>
-   			</para>
-   		</sect1>
-   		<sect1>
-   			<title>How to configure this feature?</title>
-   			<para>
-   				The configuration for this workflow service is found in the jboss-p=
ortal.sar/portal-cms.sar/portal-workflow.sar/META-INF/jboss-service.xml
-   				file
-   				<programlisting>
+      code=3D"@cms.service.code@"
+      name=3D"portal:service=3DCMS"
+      xmbean-dd=3D""
+      xmbean-code=3D"org.jboss.portal.jems.as.system.JBossServiceModelMBea=
n">
+      <xmbean/>
+
+      ...
+
+      <!-- Comment this out to deactivate publish/approval workflow integr=
ation -->
+      <depends optional-attribute-name=3D"ApprovePublishWorkflow" proxy-ty=
pe=3D"attribute">portal:service=3DApprovePublish,type=3DWorkflow</depends>
+
+      ...
+</mbean>]]></programlisting>
+         </para>
+      </sect1>
+      <sect1>
+         <title>How to configure this feature?</title>
+         <para>
+            The workflow service can be configured by editing the <literal=
>portal:service=3DApprovePublish,type=3DWorkflow</literal>
+            mbean found in <filename>portal-cms.sar/META-INF/jboss-service=
.xml</filename>.
+            <programlisting>
    <![CDATA[
-<!-- ApprovePublish workflow service -->   =

-<mbean
-   code=3D"org.jboss.portal.workflow.cms.ApprovePublishImpl"
-   name=3D"portal:service=3DApprovePublish,type=3DWorkflow"
-   xmbean-dd=3D""
-   xmbean-code=3D"org.jboss.portal.jems.as.system.JBossServiceModelMBean">
-   <xmbean/>
-   <depends optional-attribute-name=3D"WorkflowService" proxy-type=3D"attr=
ibute">
-      portal:service=3DWorkflow,type=3DWorkflowService
-   </depends>
-   <depends optional-attribute-name=3D"IdentityServiceController" proxy-ty=
pe=3D"attribute">
-      portal:service=3DModule,type=3DIdentityServiceController
-   </depends>     =

-   <!-- JBPM process definition -->
-   <attribute name=3D"Process">     	     =

-      <!-- cms approval workflow -->
-      <process-definition name=3D"approval_workflow">
-         <start-state>
-            <transition to=3D"request_approval"/>			=

-         </start-state>
-         <task-node name=3D"request_approval" signal=3D"first">
-            <task name=3D"approve_publish">
-               <assignment class=3D"org.jboss.portal.cms.workflow.PublishA=
ssignmentHandler"/>
-               <event type=3D"task-start">
-                  <action class=3D"org.jboss.portal.cms.workflow.FinalizeP=
ublish"/>	=

-               </event>
-               <exception-handler>
-                  <action class=3D"org.jboss.portal.workflow.cms.TaskExcep=
tionHandler"/>	=

-               </exception-handler>
-            </task>		          =

-            <transition name=3D"approval" to=3D"end"/>		          	  =

-            <transition name=3D"rejection" to=3D"end"/>	                  =
     =

-         </task-node>			      =

-         <end-state name=3D"end"/>		          =

-      </process-definition>			      =

-   </attribute>
-   <!-- =

-   overwrite =3D false creates the process first time if does not exist, f=
or
-   subsequent server restarts, this process definition remains in tact
- =

-   overwrite =3D true creates the process first time if does not exist,
-   for subsequent server restarts, it creates a new version of the process=
 definition
-   which will be used for processes created from then onwards. Old process=
es created
-   for an older version of the definition remain in tact and use their cor=
responding
-   process definition.
-  	          =

-   Typically use overwrite=3Dfalse and overwrite=3Dtrue only when a new pr=
ocess definition
-   elated to this workflow needs to be deployed
+<!-- ApprovePublish workflow service -->
+   <mbean
+      code=3D"org.jboss.portal.cms.workflow.ApprovePublishImpl"
+      name=3D"portal:service=3DApprovePublish,type=3DWorkflow"
+      xmbean-dd=3D""
+      xmbean-code=3D"org.jboss.portal.jems.as.system.JBossServiceModelMBea=
n">
+      <xmbean/>
+      <depends optional-attribute-name=3D"WorkflowService" proxy-type=3D"a=
ttribute">
+      	portal:service=3DWorkflow,type=3DWorkflowService
+      </depends>
+      <depends optional-attribute-name=3D"IdentityServiceController" proxy=
-type=3D"attribute">
+      	portal:service=3DModule,type=3DIdentityServiceController
+      </depends>
+      <!-- JBPM process definition -->
+      <attribute name=3D"Process">
+         <!-- cms approval workflow -->
+         <process-definition name=3D"approval_workflow">
+            <start-state>
+               <transition to=3D"request_approval"/>
+            </start-state>
+            <task-node name=3D"request_approval" signal=3D"first">
+               <task name=3D"approve_publish">
+                  <assignment class=3D"org.jboss.portal.cms.workflow.Publi=
shAssignmentHandler"/>
+                  <event type=3D"task-start">
+                     <action class=3D"org.jboss.portal.cms.workflow.Finali=
zePublish"/>
+                  </event>
+                  <exception-handler>
+                     <action class=3D"org.jboss.portal.cms.workflow.TaskEx=
ceptionHandler"/>
+                  </exception-handler>
+               </task>
+               <transition name=3D"approval" to=3D"end"/>
+               <transition name=3D"rejection" to=3D"end"/>
+            </task-node>
+            <end-state name=3D"end"/>
+         </process-definition>
+      </attribute>
+      <!--
+         overwrite =3D false creates the process first time if does not ex=
ist, for
+         subsequent server restarts, this process definition remains in ta=
ct
+
+         overwrite =3D true creates the process first time if does not exi=
st,
+         for subsequent server restarts, it creates a new version of the p=
rocess definition
+         which will be used for processes created from then onwards. Old p=
rocesses created
+         for an older version of the definition remain in tact and use the=
ir corresponding
+         process definition.
+
+         Typically use overwrite=3Dfalse and overwrite=3Dtrue only when a =
new process definition
+         related to this workflow needs to be deployed
       -->
-   <attribute name=3D"Overwrite">false</attribute>
-   <!-- =

-a comma separated list of portal roles that are designated
-to act as workflow managers. They are allowed to =

-approve/reject content publish requests =

-   -->
-   <attribute name=3D"ManagerRoles">Admin</attribute>
-   <attribute name=3D"JNDIName">java:portal/ApprovePublishWorkflow</attrib=
ute>
-</mbean>  =

-   ]]>
-   </programlisting>
-   			</para>
-   		</sect1>
+      <attribute name=3D"Overwrite">false</attribute>
+      <!--
+         A comma separated list of portal roles that are designated
+         to act as workflow managers. They are allowed to
+         approve/reject content publish requests
+      -->
+      <attribute name=3D"ManagerRoles">Admin</attribute>
+      <attribute name=3D"JNDIName">java:portal/ApprovePublishWorkflow</att=
ribute>     =

+   </mbean>]]></programlisting>
+         </para>
+         <para>
+            Of note in this configuration are the <literal>Process</litera=
l> and <literal>ManagerRoles</literal>
+            attributes. The <literal>Process</literal> attribute is used t=
o provide the jBPM process definition to be
+            followed by the workflow service during the approval process. =
This follows the standard jBPM syntax
+            for process definition. <literal>ManagerRoles</literal>, on th=
e other hand, is a comma-delimited list of
+            user roles that are being marked as "managers" who can approve=
 the publication of CMS documents.
+         </para>
+      </sect1>
    </section>   =

 </chapter>


--===============6853754795293541979==--