Files
alfresco-community-repo/config/alfresco/messages/workflow-interpreter-help.txt
Britt Park b2f9df29d1 Humongous merge. It is incomplete, however; faces-config-navigation.xml and ClientConfigElement
were both beyond me, and are just the raw conflict merge data.  If Kev can't figure out how they should
go together by tomorrow AM (for me) I'll dig back in.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@4306 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2006-11-08 05:17:40 +00:00

175 lines
3.8 KiB
Plaintext

##
## Meta commands
##
ok> help
List this help.
ok> r
Repeat last command.
ok> user [<userName>]
Switch to specified <userName>. If <userName> is omitted, the currently
selected user is shown.
ok> use
Show current workflow context.
##
## Workflow Definition Commands
##
ok> deploy <definitionClassPath>
Deploy workflow definition to Alfresco server.
<definitionClassPath> class path to workflow definition.
ok> redeploy
Redeploy the last workflow definition.
ok> show definitions
List all deployed workflow definitions.
ok> use definition [<workflowDefId>]
Switch to use the workflow definition identified by <workflowDefId>. If
<workflowDefId> is ommited, the currently selected workflow definition
is shown.
##
## Variable Commands
##
ok> var
Show all defined variables.
ok> var <varName>[*]=<varValue>
Define or update a variable.
<varName> variable name
[*] if specified, define a collection
<varValue> variable value (comma-seperate to specify a list of values)
e.g.
set bpm:assignee*=admin,fred
set wf:notifyMe=true
ok> var <varName>[*] person <varValue>
Define or update a (cm:person) node ref variable.
<varName> variable name
[*] if specified, define a collection
<varValue> variable value (comma-seperate to specify a list of values)
e.g.
set bpm:assignee* person admin,fred
ok> var <varName>=
Delete an existing variable.
<varName> variable name
##
## Workflow Commands
##
ok> start [<varName[=varValue>]]*
Start a new workflow using the currently selected workflow definition. Start
Task parameters are provided as name/value pairs or references to pre-defined
variables.
e.g.
start bpm:assignee=david wf:predefined
ok> show workflows
Display the list of active workflows for the currently selected workflow
definition.
ok> use workflow <workflowId>
Use the specified <workflowId>.
ok> show paths [<workflowId>]
Display the workflow paths for the specified <workflowId>. If <workflowId>
is omitted, the paths for the currently started workflow are shown.
ok> show transitions [<workflowId>]
Display all available transitions for the specified <workflowId>. If
<workflowId> is omitted, the transitions for the currently started workflow
are shown.
ok> signal <pathId> [<transitionName>]
Signal transition on specified <pathId>. If <transitionName> is omitted, the
default transition is taken.
ok> desc workflow <workflowId>
Describe the specified <workflowId>.
ok> end workflow <workflowId>
End (cancel) the specified <workflowId>.
##
## Task Commands
##
ok> show my tasks
List tasks assigned to the currently selected user.
ok> show my completed
List tasks completed by the currently selected user.
ok> show tasks [<pathId>]
List tasks associated with the specified workflow <pathId>. If <pathId> is
omitted, the tasks associated with the currently selected workflow path are
shown.
ok> desc task <taskId>
Describe the task identified by <taskId>.
ok> update task <taskid> [<varName[=varValue>]]*
Update the state of the specified <taskId>. Task properties are provided as
name/value pairs or references to pre-defined variables.
<varName> variable name
[*] if specified, define a collection
<varValue> variable value (comma-seperate to specify a list of values)
e.g.
update task jbpm$122 bpm:assignee=fred wf:notifyMe=false
ok> end task <taskId> [<transitionName>]
End the task identified by <taskId>. If <transitionName> is omitted, the
default transition is taken.
##
## end
##