Update show workflows all description.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5755 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
David Caruana
2007-05-22 17:58:30 +00:00
parent 3682ff9474
commit c9fdaad645

View File

@@ -1,61 +1,61 @@
## ##
## Meta commands ## Meta commands
## ##
ok> help ok> help
List this help. List this help.
ok> r ok> r
Repeat last command. Repeat last command.
ok> user [<userName>] ok> user [<userName>]
Switch to specified <userName>. If <userName> is omitted, the currently Switch to specified <userName>. If <userName> is omitted, the currently
selected user is shown. selected user is shown.
ok> quit | exit ok> quit | exit
Quit this workflow console. Quit this workflow console.
ok> use ok> use
Show current workflow context. Show current workflow context.
## ##
## Workflow Definition Commands ## Workflow Definition Commands
## ##
ok> show file <definitionClassPath> ok> show file <definitionClassPath>
Output the contents of the file located at <definitionClassPath>. Output the contents of the file located at <definitionClassPath>.
<definitionClassPath> class path to workflow definition file. <definitionClassPath> class path to workflow definition file.
ok> deploy <definitionClassPath> ok> deploy <definitionClassPath>
Deploy workflow definition to Alfresco server. Deploy workflow definition to Alfresco server.
<definitionClassPath> class path to workflow definition. <definitionClassPath> class path to workflow definition.
ok> redeploy ok> redeploy
Redeploy the last workflow definition. Redeploy the last workflow definition.
ok> show definitions [all] ok> show definitions [all]
List latest deployed workflow definitions. Or, display all workflows List latest deployed workflow definitions. Or, display all workflows
definitions (including previous versions) with the additional keyword definitions (including previous versions) with the additional keyword
'all'. 'all'.
ok> use definition [<workflowDefId>] ok> use definition [<workflowDefId>]
Switch to use the workflow definition identified by <workflowDefId>. If Switch to use the workflow definition identified by <workflowDefId>. If
<workflowDefId> is ommited, the currently selected workflow definition <workflowDefId> is ommited, the currently selected workflow definition
is shown. is shown.
ok> undeploy definition <workflowDefId> ok> undeploy definition <workflowDefId>
Undeploy the latest version of the workflow definition identified by Undeploy the latest version of the workflow definition identified by
<workflowDefId>. This will also terminate and remove all "in-flight" <workflowDefId>. This will also terminate and remove all "in-flight"
@@ -65,21 +65,21 @@ ok> undeploy definition <workflowDefId>
each in turn to remove the definition completely or issue the 'undeploy each in turn to remove the definition completely or issue the 'undeploy
definition name' command. definition name' command.
ok> undeploy definition name <workflowName> ok> undeploy definition name <workflowName>
Undeploy all versions of a workflow definition. As with 'undeploy Undeploy all versions of a workflow definition. As with 'undeploy
definition', all "in-flight" workflows associated with each version definition', all "in-flight" workflows associated with each version
are terminated. are terminated.
## ##
## Variable Commands ## Variable Commands
## ##
ok> var ok> var
Show all defined variables. Show all defined variables.
ok> var <varName>[*]=<varValue> ok> var <varName>[*]=<varValue>
Define or update a variable. Define or update a variable.
@@ -92,7 +92,7 @@ ok> var <varName>[*]=<varValue>
var bpm:assignee*=admin,fred var bpm:assignee*=admin,fred
var wf:notifyMe=true var wf:notifyMe=true
ok> var <varName>[*] person <varValue> ok> var <varName>[*] person <varValue>
Define or update a (cm:person) node ref variable. Define or update a (cm:person) node ref variable.
@@ -104,7 +104,7 @@ ok> var <varName>[*] person <varValue>
var bpm:assignee* person admin,fred var bpm:assignee* person admin,fred
ok> var <varName>[*] group <varValue> ok> var <varName>[*] group <varValue>
Define or update a (usr:authorityContainer) node ref variable. Define or update a (usr:authorityContainer) node ref variable.
@@ -116,7 +116,7 @@ ok> var <varName>[*] group <varValue>
var bpm:groupAssignee group GROUP_Engineering var bpm:groupAssignee group GROUP_Engineering
ok> var <varName> package <itemCount> ok> var <varName> package <itemCount>
Define or update a (bpm:workflowPackage) node ref variable. Define or update a (bpm:workflowPackage) node ref variable.
@@ -126,17 +126,17 @@ ok> var <varName> package <itemCount>
var bpm:package package 4 var bpm:package package 4
ok> var <varName>= ok> var <varName>=
Delete an existing variable. Delete an existing variable.
<varName> variable name <varName> variable name
## ##
## Workflow Commands ## Workflow Commands
## ##
ok> start [<varName[=varValue>]]* ok> start [<varName[=varValue>]]*
Start a new workflow using the currently selected workflow definition. Start Start a new workflow using the currently selected workflow definition. Start
Task parameters are provided as name/value pairs or references to pre-defined Task parameters are provided as name/value pairs or references to pre-defined
@@ -146,94 +146,94 @@ ok> start [<varName[=varValue>]]*
start bpm:assignee=david wf:predefined start bpm:assignee=david wf:predefined
ok> show workflows [all] ok> show workflows [all]
Display the list of active workflows for the currently selected workflow Display the list of active workflows for the currently selected workflow
definition. Or, display the list of all workflows when used with the definition. Or, display the list of all workflows (latest and previous
additional keyword 'all'. versions of process definitions) when used with the additional keyword 'all'.
ok> use workflow <workflowId> ok> use workflow <workflowId>
Use the specified <workflowId>. Use the specified <workflowId>.
ok> desc workflow <workflowId> ok> desc workflow <workflowId>
Describe the specified <workflowId>. Describe the specified <workflowId>.
ok> show paths [<workflowId>] ok> show paths [<workflowId>]
Display the workflow paths for the specified <workflowId>. If <workflowId> Display the workflow paths for the specified <workflowId>. If <workflowId>
is omitted, the paths for the currently started workflow are shown. is omitted, the paths for the currently started workflow are shown.
ok> desc path <pathId> ok> desc path <pathId>
Describe the specified <pathId>. Includes the list of properties associated Describe the specified <pathId>. Includes the list of properties associated
with the path. with the path.
ok> show transitions [<workflowId>] ok> show transitions [<workflowId>]
Display all available transitions for the specified <workflowId>. If Display all available transitions for the specified <workflowId>. If
<workflowId> is omitted, the transitions for the currently started workflow <workflowId> is omitted, the transitions for the currently started workflow
are shown. are shown.
ok> signal <pathId> [<transitionName>] ok> signal <pathId> [<transitionName>]
Signal transition on specified <pathId>. If <transitionName> is omitted, the Signal transition on specified <pathId>. If <transitionName> is omitted, the
default transition is taken. default transition is taken.
ok> event <pathId> <eventtype> ok> event <pathId> <eventtype>
Fire an event of custom 'eventtype' against the specified path. Fire an event of custom 'eventtype' against the specified path.
ok> end workflow <workflowId> ok> end workflow <workflowId>
End (cancel) the specified <workflowId>. End (cancel) the specified <workflowId>.
ok> delete workflow <workflowId> ok> delete workflow <workflowId>
Force deletion of the specified <workflowId>. Force deletion of the specified <workflowId>.
ok> delete all workflows ok> delete all workflows
Force deletion of all "in-flight" workflows. Use with care! Force deletion of all "in-flight" workflows. Use with care!
## ##
## Timer Commands ## Timer Commands
## ##
ok> show timers [all] ok> show timers [all]
Display the list of active timers for the currently selected workflow Display the list of active timers for the currently selected workflow
definition. Or, display the list of all timers when used with the definition. Or, display the list of all timers when used with the
additional keyword 'all'. additional keyword 'all'.
## ##
## Task Commands ## Task Commands
## ##
ok> show my tasks ok> show my tasks
List tasks assigned to the currently selected user. List tasks assigned to the currently selected user.
ok> show my completed ok> show my completed
List tasks completed by the currently selected user. List tasks completed by the currently selected user.
ok> show my pooled ok> show my pooled
List tasks in a pool for the currently selected user. List tasks in a pool for the currently selected user.
ok> show tasks [<pathId>] ok> show tasks [<pathId>]
List tasks associated with the specified workflow <pathId>. If <pathId> is List tasks associated with the specified workflow <pathId>. If <pathId> is
omitted, the tasks associated with the currently selected workflow path are omitted, the tasks associated with the currently selected workflow path are
shown. shown.
ok> desc task <taskId> ok> desc task <taskId>
Describe the task identified by <taskId>. Describe the task identified by <taskId>.
ok> update task <taskid> [<varName[=varValue>]]* ok> update task <taskid> [<varName[=varValue>]]*
Update the state of the specified <taskId>. Task properties are provided as Update the state of the specified <taskId>. Task properties are provided as
name/value pairs or references to pre-defined variables. name/value pairs or references to pre-defined variables.
@@ -246,12 +246,12 @@ ok> update task <taskid> [<varName[=varValue>]]*
update task jbpm$122 bpm:assignee=fred wf:notifyMe=false update task jbpm$122 bpm:assignee=fred wf:notifyMe=false
ok> end task <taskId> [<transitionName>] ok> end task <taskId> [<transitionName>]
End the task identified by <taskId>. If <transitionName> is omitted, the End the task identified by <taskId>. If <transitionName> is omitted, the
default transition is taken. default transition is taken.
ok> query task [predicate]* ok> query task [predicate]*
Query for tasks. If no predicates are provided, all "in-progress" tasks Query for tasks. If no predicates are provided, all "in-progress" tasks
are returned (across all "active" workflows). are returned (across all "active" workflows).
@@ -289,6 +289,6 @@ ok> query task [predicate]*
query task taskName=wcmwf:submitpending taskState=IN_PROGRESS \ query task taskName=wcmwf:submitpending taskState=IN_PROGRESS \
process.wcwmf:webproject=workspace://SpacesStore/projectx orderBy=TaskDue_Desc,TaskActor_Asc process.wcwmf:webproject=workspace://SpacesStore/projectx orderBy=TaskDue_Desc,TaskActor_Asc
## ##
## end ## end
## ##