CRNT-25678 - Added new structure and oid command merge issue

git-svn-id: http://emeafrazerg/svn/ipp/product/branches/b_dev_7_1_0/stardust/documentation@61170 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b

1 files changed, 79 insertions, 5 deletions

diff --git a/org.eclipse.stardust.docs.dev/html/handbooks/operation/commandline/ag-commandline-2.htm b/org.eclipse.stardust.docs.dev/html/handbooks/operation/commandline/ag-commandline-2.htm
index 99f13cc..56fbfb1 100644
--- a/org.eclipse.stardust.docs.dev/html/handbooks/operation/commandline/ag-commandline-2.htm
+++ b/org.eclipse.stardust.docs.dev/html/handbooks/operation/commandline/ag-commandline-2.htm
@@ -147,23 +147,33 @@ sysconsole.</p>
     <tr>

         <th>Command</th>

         <th>Description</th>

+        <th>Example</th>
     </tr>

     <tr>

         <td>archive</td>

         <td>Deletes or archives the audit trail or parts of it. Please refer to

         section <a href="#archive">Audit Trail Archive Administration</a> for detailed

-        information.

+        information. Also, refer to the chapter 
+        <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/operation/audit-trail/ag-archiving.htm">
+        Audit Trail Archive</a> of the 
+        <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/operation/ag-preface.htm">Operation Guide</a>
+        
         <ul>

             <li><tt>-batchSize, -b &lt;arg&gt; - </tt> Determines how many process
             instances should be performed in a transaction. The data will be kept in a

             consistent state. If this option is missing, a default batch size of 1000 will

-            be used.</li>

+            be used. You have to specify at least one of the following options: model, processes, 
+            deadModels, deadProcesses, deadData, logEntries and userSessions.</li>
+            <li><tt>-deadData, -d 'arg' - </tt>deletes dead workflow data values.
+            It has to be used together with option <tt>-noBackup</tt>.
+            Accepts as argument a single data ID or a comma separated list of data IDs.
+            </li>
             <li><tt>-deadData, -d &lt;arg&gt; - </tt>deletes dead workflow data values.
             It has to be used together with option <tt>-noBackup</tt>.

             Accepts as argument a single data ID or a comma separated list of data IDs.</li>

             <li><tt>-deadModels, -m </tt>deletes or archives audit trail for all dead models

             (models not having nonterminated

-            process instances) and their preferences.</li>

+            process instances) and their preferences. You need to specify archive audit trail schema with this option.</li>
             <li><tt>-deadProcesses, -p</tt> deletes or archives terminated process instances

             and their preferences.</li>

             <li><tt>-interval, -i &lt;arg&gt;- </tt> The interval for which the archiving
@@ -191,7 +201,22 @@ sysconsole.</p>
 				can be archived or deleted.</li>

         </ul>

         </td>

-    </tr>

+        <td>
+        <ul>
+        		<li>sysconsole -password sysop archive -s &lt;Specify target schemaname&gt; -deadModels -batchSize 2000</li>
+        		<li>sysconsole -password sysop -force archive -deadData aBoolean,aString,anInt,aBigSerializable,OrderBook1 -noBackup</li>
+        		<li>sysconsole -password sysop archive -s &lt;Specify target schemaname&gt; -deadModels</li>
+        		<li>sysconsole -password sysop archive -s &lt;Specify target schemaname&gt; -deadProcesses</li>
+        		<li>sysconsole -password sysop archive -deadData aBoolean,aString,anInt,aBigSerializable,OrderBook1 -noBackup -interval 1m</li>
+        		<li>sysconsole -password sysop archive -s &lt;Specify target schemaname&gt; -logEntries </li>
+        		<li>sysconsole -password sysop archive -s &lt;Specify target schemaname&gt; -model &lt;model OID&gt;</li>
+        		<li>sysconsole -password sysop archive -s &lt;Specify target schemaname&gt; -deadProcesses -partition &lt;Specify partition ID&gt;</li>
+        		<li>sysconsole -p sysop archive -noBackup -userSession</li>
+        	</ul>
+        </td>
+       </tr>
+       
+       
     <tr>

         <td>archiveDDL</td>

         <td>Creates DDL for the @productname@  schema:

@@ -201,6 +226,13 @@ sysconsole.</p>
             contain the backup tables.</li>

         </ul>

         </td>

+        <td>
+        <ul>
+        	<li>sysconsole -password sysop archiveDDL -file &lt;Specify file name&gt; -s &lt;Specify schemaname&gt;</li>
+        
+        </ul>
+        </td>
+              
     </tr>

     <tr id="auditTrail">
         <td>auditTrail</td>

@@ -250,10 +282,24 @@ sysconsole.</p>
             <li><tt>-verifySequenceTable, -vst</tt> - checks if data synchronization is required.</li>
         </ul>
         </td>

-    </tr>

+        <td>
+        <ul>
+        	<li>sysconsole -password sysop auditTrail -createPartition 15</li>
+        	<li>sysconsole -password sysop auditTrail -dropPartition 15</li>
+        	<li>sysconsole -password sysop auditTrail -listPartitions</li>
+        	<li>sysconsole -password sysop auditTrail -dropLockTables [-sql C:/myfile.sql]</li>
+        	<li>sysconsole -password sysop auditTrail -enableDataClusters -configFile &lt;specify .xml 
+        	cluster configuration file&gt; </li>
+        	<li>sysconsole -p sysop auditTrail -verifyDataClusters</li>
+        	<li>sysconsole -p sysop auditTrail -dropDataClusters</li>
+        
+        </ul>
+        </td>
+     </tr>
     <tr>

         <td>createschema</td>

         <td>Creates the @productname@  schema.</td>

+        <td>sysconsole -password sysop createschema</td>
     </tr>

     <tr>

         <td>ddl</td>

@@ -265,12 +311,19 @@ sysconsole.</p>
             used</li>

         </ul>

         </td>

+        <td>
+        <ul>
+        	<li>sysconsole ddl -file newddlfile</li>
+        	<li>sysconsole -p sysop dropschema</li>
+        </ul>
+        </td>
     </tr>

     <tr>

         <td>dropschema</td>

         <td>Drops the @productname@  schema. This command requires the system operator

         password to be passed with the -password global option, which by default is sysop.

         </td>

+        <td></td>
     </tr>

 	<tr>

 		<td>encrypt</td>

@@ -293,6 +346,7 @@ sysconsole.</p>
             option simultaneously passed will be ignored.</li>
 		</ul>

 		</td>

+		<td></td>
 	</tr>

 <!--     <tr>
       <td>fixruntimeoids</td>
@@ -310,6 +364,7 @@ sysconsole.</p>
             <li><tt>-new/-n &lt;arg&gt; -</tt> the new password.</li>
         </ul>

         </td>

+        <td></td>
     </tr>

     <tr>

         <td>property</td>

@@ -327,6 +382,7 @@ sysconsole.</p>
             runtime property.</li>

         </ul>

         </td>

+        <td></td>
     </tr>

     <tr>

         <td>upgrademodel</td>

@@ -343,6 +399,7 @@ sysconsole.</p>
             href="../../modelling/models/model-upgrade.html">Model Upgrade</a>

         of the <a href="../../modelling/mg-preface.htm">Modeling Guide</a>

         chapter for more information.</td>

+        <td></td>
     </tr>

     <tr>

         <td>upgraderuntime</td>

@@ -366,11 +423,24 @@ sysconsole.</p>
             versions.</li>

         </ul>

         </td>

+        <td></td>
     </tr>

     <tr>

         <td>version</td>

         <td>Returns version information for the @productname@  Process engine.</td>

+        <td></td>
+    </tr>
+    <tr>
+    	<td>fixruntimeoids</td>
+    	<td>Fixes invalid runtime OIDs in the audit trail database. Possible arguments: 
+		<ul>
+			<li>logonly - If specified, no database operation will be performed.</li> 
+			<li>nolog - If specified, no log file will be written.</li>
+		</ul>
+		</td>
+    	<td></td>
     </tr>

+    
 </table>

 <p>The following sections provide details on archiving as well as

 lock table and cluster table administration:</p>

@@ -470,6 +540,10 @@ this might lead to inconsistency in the audit trail.</p>
 <h4 id="backup">Backing Up A Model</h4>

 <p>The following option is backing up a model with all its dependent objects:</p>

 <p><tt>-model oid </tt>(to find in the database table <tt>model</tt>)</p>

+<p>
+Whenever a new model is archived, the archive command checks for OID consistency with the 
+older models and fixes the according OID registry and related references, if required.</p>
+
 <p>Without the <tt>-noBackup</tt> command the dead models stay in the audit trail.</p>

 <p>In case of physical deletion the optional command</p>

 <p><tt>-noBackup</tt></p>