Author: objectiser Date: 2010-07-05 09:58:55 -0400 (Mon, 05 Jul 2010) New Revision: 834 Added: branches/RiftSaw-2.1.x/docs/docbook/userguide/src/main/images/ActivateRetire.png trunk/docs/docbook/userguide/src/main/images/ActivateRetire.png Modified: branches/RiftSaw-2.1.x/distribution/src/main/release/db/bpel.properties branches/RiftSaw-2.1.x/docs/docbook/userguide/src/main/module/admin.xml branches/RiftSaw-2.1.x/pom.xml trunk/distribution/src/main/release/db/bpel.properties trunk/docs/docbook/userguide/src/main/module/admin.xml trunk/pom.xml Log: RIFTSAW-241 - added documentation on activate/retire and the stable interface property. Modified: branches/RiftSaw-2.1.x/distribution/src/main/release/db/bpel.properties =================================================================== --- branches/RiftSaw-2.1.x/distribution/src/main/release/db/bpel.properties 2010-07-05 09:40:40 UTC (rev 833) +++ branches/RiftSaw-2.1.x/distribution/src/main/release/db/bpel.properties 2010-07-05 13:58:55 UTC (rev 834) @@ -90,6 +90,7 @@ bpel.db.mode=EXTERNAL db.emb.create=false bpel.db.ext.dataSource=java:BPELDB + # if set to true will self-register BPEL endpoints upon deployment to a UDDI. # this uses the juddi-client-3.0.x and the uddi client config can be set in the uddi.xml # file @@ -131,6 +132,3 @@ jta.UserTransaction=UserTransaction ode.persistence=hibernate - -ode.process.checkguid=false -ode.process.store=org.apache.ode.store.JBossProcessStoreImpl Added: branches/RiftSaw-2.1.x/docs/docbook/userguide/src/main/images/ActivateRetire.png =================================================================== (Binary files differ) Property changes on: branches/RiftSaw-2.1.x/docs/docbook/userguide/src/main/images/ActivateRetire.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: branches/RiftSaw-2.1.x/docs/docbook/userguide/src/main/module/admin.xml =================================================================== --- branches/RiftSaw-2.1.x/docs/docbook/userguide/src/main/module/admin.xml 2010-07-05 09:40:40 UTC (rev 833) +++ branches/RiftSaw-2.1.x/docs/docbook/userguide/src/main/module/admin.xml 2010-07-05 13:58:55 UTC (rev 834) @@ -14,7 +14,7 @@ </section> <section> - <title>BPM Console</title> + <title>BPEL Console</title> <section> <title>Overview</title> @@ -116,7 +116,100 @@ </imageobject> </section> + + <section> + <title>Retiring and Reactivating Process Definitions</title> + + <para> + When a process definition is initially deployed (i.e. the first version of the process), + it automatically becomes the active process definition. If that BPEL process definition + is subsequently change and redeployed, then the previous version is <emphasis>retired</emphasis>, + and the new version becomes the <emphasis>active</emphasis> version. + </para> + + <para> + The only difference between an <emphasis>active</emphasis> and <emphasis>retired</emphasis> + process definition is that a <emphasis>retired</emphasis> process definition can no longer + create new process instances. However if there are current process instances associated + with the <emphasis>retired</emphasis> process definition version, then these will continue + to execute. + </para> + + <para> + On some occasions, the administrator may wish to change which version of a process definition + is considered the <emphasis>active</emphasis> version. Or they may simply want to + <emphasis>retire</emphasis> the currently active process definition, so that no more + process instances can be created, only allowing the already running process instances to + continue until completed. + </para> + + <para> + To change the status of a process definition, the administrator should select the + <emphasis>Runtime</emphasis> tab from the lefthand panel, and then select the + <emphasis>Deployments</emphasis> option. This will show the process definitions, their + versions and their current status (active or retired). + </para> + + <imageobject> + <imagedata fileref="images/ActivateRetire.png" align="center" width="6in" /> + </imageobject> + + <para> + To change a particular version from <emphasis>retired</emphasis> to <emphasis>active</emphasis>, + simply select the <emphasis>retired</emphasis> version and press the <emphasis>Activate</emphasis> + button in the bottom right. + </para> + + <para> + To retire a currently active process definition, simply select the particular version and + then press the <emphasis>Retire</emphasis> button in the bottom right. + </para> + + </section> </section> + <section> + <title>BPEL Properties</title> + + <para> + When RiftSaw has been installed within the JBossAS environment, there is a property file + located at <filename>${JBossAS}/server/default/deploy/riftsaw.sar/bpel.properties</filename>. + </para> + + <para> + This property file contains a number of properties that are specific to ODE, and if interested + in these properties, then you should refer to the ODE documentation. Only one point to note, + the name of the property in this file maybe prefixed with <emphasis>bpel.</emphasis>, however + in the ODE documentation the prefix would be <emphasis>ode.</emphasis>. + </para> + + <para> + This section will present the properties that are specific to RiftSaw. + </para> + + <table frame="all"> + <title>RiftSaw specific properties</title> + <tr> + <td>bpel.uddi.*</td> + <td>These properties relate to the UDDI support, which is discussed in a subsequent chapter.</td> + </tr> + <tr> + <td>bpel.jaxws.client.initializer.impl</td> + <td>This property is automatically set upon installation, based on the JAXWS stack being used. + This value should not be changed.</td> + </tr> + <tr> + <td>bpel.ws.stableInterface (default false)</td> + <td>This property determines whether the Web Service interface, associated with a BPEL process, + will be updated when a new version of the BPEL process is deployed. The benefit of setting this + to <emphasis>false</emphasis> is that changes to the WSDL will be made active with the BPEL + process. However the issue is that during the transition between the interfaces, the web service + will momentarily be unavailble - which may cause heavily used services to reject requests. By + setting this value to <emphasis>true</emphasis>, then the web service will remain available + while the BPEL process is updated, however any changes in the WSDL will not be made available.</td> + </tr> + </table> + </section> + </chapter> Modified: branches/RiftSaw-2.1.x/pom.xml =================================================================== --- branches/RiftSaw-2.1.x/pom.xml 2010-07-05 09:40:40 UTC (rev 833) +++ branches/RiftSaw-2.1.x/pom.xml 2010-07-05 13:58:55 UTC (rev 834) @@ -74,7 +74,7 @@ <properties> <riftsaw.ode.version>2.1.0-SNAPSHOT</riftsaw.ode.version> <riftsaw.engine.version>2.1.0-SNAPSHOT</riftsaw.engine.version> - <bpm.console.version>2.1</bpm.console.version> + <bpel.console.version>2.1.1-SNAPSHOT</bpel.console.version> <commons.logging.version>1.1.1</commons.logging.version> <junit.version>3.8.1</junit.version> <jboss.version>5.1.0.GA</jboss.version> @@ -97,24 +97,24 @@ <dependency> <groupId>org.jboss.bpm</groupId> <artifactId>gwt-console-rpc</artifactId> - <version>${bpm.console.version}</version> + <version>${bpel.console.version}</version> </dependency> <dependency> <groupId>org.jboss.bpm</groupId> <artifactId>gwt-console-server-integration</artifactId> - <version>${bpm.console.version}</version> + <version>${bpel.console.version}</version> </dependency> <dependency> <groupId>org.jboss.bpm</groupId> <artifactId>gwt-console-server</artifactId> - <version>${bpm.console.version}</version> + <version>${bpel.console.version}</version> <classifier>riftsaw</classifier> <type>war</type> </dependency> <dependency> <groupId>org.jboss.bpm</groupId> <artifactId>gwt-console</artifactId> - <version>${bpm.console.version}</version> + <version>${bpel.console.version}</version> <classifier>riftsaw</classifier> <type>war</type> </dependency> Modified: trunk/distribution/src/main/release/db/bpel.properties =================================================================== --- trunk/distribution/src/main/release/db/bpel.properties 2010-07-05 09:40:40 UTC (rev 833) +++ trunk/distribution/src/main/release/db/bpel.properties 2010-07-05 13:58:55 UTC (rev 834) @@ -90,6 +90,7 @@ bpel.db.mode=EXTERNAL db.emb.create=false bpel.db.ext.dataSource=java:BPELDB + # if set to true will self-register BPEL endpoints upon deployment to a UDDI. # this uses the juddi-client-3.0.x and the uddi client config can be set in the uddi.xml # file @@ -131,6 +132,3 @@ jta.UserTransaction=UserTransaction ode.persistence=hibernate - -ode.process.checkguid=false -ode.process.store=org.apache.ode.store.JBossProcessStoreImpl Added: trunk/docs/docbook/userguide/src/main/images/ActivateRetire.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/ActivateRetire.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/docs/docbook/userguide/src/main/module/admin.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/module/admin.xml 2010-07-05 09:40:40 UTC (rev 833) +++ trunk/docs/docbook/userguide/src/main/module/admin.xml 2010-07-05 13:58:55 UTC (rev 834) @@ -14,7 +14,7 @@ </section> <section> - <title>BPM Console</title> + <title>BPEL Console</title> <section> <title>Overview</title> @@ -116,7 +116,100 @@ </imageobject> </section> + + <section> + <title>Retiring and Reactivating Process Definitions</title> + + <para> + When a process definition is initially deployed (i.e. the first version of the process), + it automatically becomes the active process definition. If that BPEL process definition + is subsequently change and redeployed, then the previous version is <emphasis>retired</emphasis>, + and the new version becomes the <emphasis>active</emphasis> version. + </para> + + <para> + The only difference between an <emphasis>active</emphasis> and <emphasis>retired</emphasis> + process definition is that a <emphasis>retired</emphasis> process definition can no longer + create new process instances. However if there are current process instances associated + with the <emphasis>retired</emphasis> process definition version, then these will continue + to execute. + </para> + + <para> + On some occasions, the administrator may wish to change which version of a process definition + is considered the <emphasis>active</emphasis> version. Or they may simply want to + <emphasis>retire</emphasis> the currently active process definition, so that no more + process instances can be created, only allowing the already running process instances to + continue until completed. + </para> + + <para> + To change the status of a process definition, the administrator should select the + <emphasis>Runtime</emphasis> tab from the lefthand panel, and then select the + <emphasis>Deployments</emphasis> option. This will show the process definitions, their + versions and their current status (active or retired). + </para> + + <imageobject> + <imagedata fileref="images/ActivateRetire.png" align="center" width="6in" /> + </imageobject> + + <para> + To change a particular version from <emphasis>retired</emphasis> to <emphasis>active</emphasis>, + simply select the <emphasis>retired</emphasis> version and press the <emphasis>Activate</emphasis> + button in the bottom right. + </para> + + <para> + To retire a currently active process definition, simply select the particular version and + then press the <emphasis>Retire</emphasis> button in the bottom right. + </para> + + </section> </section> + <section> + <title>BPEL Properties</title> + + <para> + When RiftSaw has been installed within the JBossAS environment, there is a property file + located at <filename>${JBossAS}/server/default/deploy/riftsaw.sar/bpel.properties</filename>. + </para> + + <para> + This property file contains a number of properties that are specific to ODE, and if interested + in these properties, then you should refer to the ODE documentation. Only one point to note, + the name of the property in this file maybe prefixed with <emphasis>bpel.</emphasis>, however + in the ODE documentation the prefix would be <emphasis>ode.</emphasis>. + </para> + + <para> + This section will present the properties that are specific to RiftSaw. + </para> + + <table frame="all"> + <title>RiftSaw specific properties</title> + <tr> + <td>bpel.uddi.*</td> + <td>These properties relate to the UDDI support, which is discussed in a subsequent chapter.</td> + </tr> + <tr> + <td>bpel.jaxws.client.initializer.impl</td> + <td>This property is automatically set upon installation, based on the JAXWS stack being used. + This value should not be changed.</td> + </tr> + <tr> + <td>bpel.ws.stableInterface (default false)</td> + <td>This property determines whether the Web Service interface, associated with a BPEL process, + will be updated when a new version of the BPEL process is deployed. The benefit of setting this + to <emphasis>false</emphasis> is that changes to the WSDL will be made active with the BPEL + process. However the issue is that during the transition between the interfaces, the web service + will momentarily be unavailble - which may cause heavily used services to reject requests. By + setting this value to <emphasis>true</emphasis>, then the web service will remain available + while the BPEL process is updated, however any changes in the WSDL will not be made available.</td> + </tr> + </table> + </section> + </chapter> Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-07-05 09:40:40 UTC (rev 833) +++ trunk/pom.xml 2010-07-05 13:58:55 UTC (rev 834) @@ -74,7 +74,7 @@ <properties> <riftsaw.ode.version>2.2.0-SNAPSHOT</riftsaw.ode.version> <riftsaw.engine.version>2.2.0-SNAPSHOT</riftsaw.engine.version> - <bpm.console.version>2.1.1-SNAPSHOT</bpm.console.version> + <bpel.console.version>2.1.1-SNAPSHOT</<bpel.console.version>> <commons.logging.version>1.1.1</commons.logging.version> <junit.version>3.8.1</junit.version> <jboss.version>5.1.0.GA</jboss.version> @@ -97,24 +97,24 @@ <dependency> <groupId>org.jboss.bpm</groupId> <artifactId>gwt-console-rpc</artifactId> - <version>${bpm.console.version}</version> + <version>${bpel.console.version}</version> </dependency> <dependency> <groupId>org.jboss.bpm</groupId> <artifactId>gwt-console-server-integration</artifactId> - <version>${bpm.console.version}</version> + <version>${bpel.console.version}</version> </dependency> <dependency> <groupId>org.jboss.bpm</groupId> <artifactId>gwt-console-server</artifactId> - <version>${bpm.console.version}</version> + <version>${bpel.console.version}</version> <classifier>riftsaw</classifier> <type>war</type> </dependency> <dependency> <groupId>org.jboss.bpm</groupId> <artifactId>gwt-console</artifactId> - <version>${bpm.console.version}</version> + <version>${bpel.console.version}</version> <classifier>riftsaw</classifier> <type>war</type> </dependency>