From c9fdaad64529569ebcce0d8d31218f5d62536fc8 Mon Sep 17 00:00:00 2001 From: David Caruana Date: Tue, 22 May 2007 17:58:30 +0000 Subject: [PATCH] Update show workflows all description. git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5755 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261 --- .../messages/workflow-interpreter-help.txt | 544 +++++++++--------- 1 file changed, 272 insertions(+), 272 deletions(-) diff --git a/config/alfresco/messages/workflow-interpreter-help.txt b/config/alfresco/messages/workflow-interpreter-help.txt index 001ee36cbb..fe186b9d12 100644 --- a/config/alfresco/messages/workflow-interpreter-help.txt +++ b/config/alfresco/messages/workflow-interpreter-help.txt @@ -1,294 +1,294 @@ -## -## Meta commands -## - -ok> help - - List this help. - -ok> r - - Repeat last command. - -ok> user [] - - Switch to specified . If is omitted, the currently - selected user is shown. - -ok> quit | exit - - Quit this workflow console. + ## + ## Meta commands + ## -ok> use - - Show current workflow context. - -## -## Workflow Definition Commands -## - -ok> show file - - Output the contents of the file located at . + ok> help - class path to workflow definition file. - -ok> deploy - - Deploy workflow definition to Alfresco server. - - class path to workflow definition. - -ok> redeploy - - Redeploy the last workflow definition. - -ok> show definitions [all] - - List latest deployed workflow definitions. Or, display all workflows - definitions (including previous versions) with the additional keyword - 'all'. - -ok> use definition [] - - Switch to use the workflow definition identified by . If - is ommited, the currently selected workflow definition - is shown. - -ok> undeploy definition - - Undeploy the latest version of the workflow definition identified by - . This will also terminate and remove all "in-flight" - workflows associated with the definition. + List this help. - If multiple versions of the definition exist, you will have to undeploy - each in turn to remove the definition completely or issue the 'undeploy - definition name' command. - -ok> undeploy definition name - - Undeploy all versions of a workflow definition. As with 'undeploy - definition', all "in-flight" workflows associated with each version - are terminated. - -## -## Variable Commands -## - -ok> var - - Show all defined variables. - -ok> var [*]= - - Define or update a variable. - - variable name - [*] if specified, define a collection - variable value (comma-seperate to specify a list of values) - - e.g. - - var bpm:assignee*=admin,fred - var wf:notifyMe=true - -ok> var [*] person - - Define or update a (cm:person) node ref variable. - - variable name - [*] if specified, define a collection - variable value (comma-seperate to specify a list of values) - - e.g. + ok> r - var bpm:assignee* person admin,fred - -ok> var [*] group - - Define or update a (usr:authorityContainer) node ref variable. - - variable name - [*] if specified, define a collection - variable value (comma-seperate to specify a list of values) - - e.g. + Repeat last command. - var bpm:groupAssignee group GROUP_Engineering - -ok> var package - - Define or update a (bpm:workflowPackage) node ref variable. + ok> user [] - A new workflow package is created containing content items. + Switch to specified . If is omitted, the currently + selected user is shown. - e.g. + ok> quit | exit - var bpm:package package 4 - -ok> var = - - Delete an existing variable. - - variable name - -## -## Workflow Commands -## + Quit this workflow console. + + ok> use -ok> 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 - variables. + Show current workflow context. - e.g. + ## + ## Workflow Definition Commands + ## - start bpm:assignee=david wf:predefined + ok> show file -ok> show workflows [all] - - Display the list of active workflows for the currently selected workflow - definition. Or, display the list of all workflows when used with the - additional keyword 'all'. - -ok> use workflow - - Use the specified . - -ok> desc workflow - - Describe the specified . - -ok> show paths [] - - Display the workflow paths for the specified . If - is omitted, the paths for the currently started workflow are shown. - -ok> desc path - - Describe the specified . Includes the list of properties associated - with the path. - -ok> show transitions [] - - Display all available transitions for the specified . If - is omitted, the transitions for the currently started workflow - are shown. - -ok> signal [] - - Signal transition on specified . If is omitted, the - default transition is taken. - -ok> event - - Fire an event of custom 'eventtype' against the specified path. - -ok> end workflow - - End (cancel) the specified . - -ok> delete workflow - - Force deletion of the specified . - -ok> delete all workflows - - Force deletion of all "in-flight" workflows. Use with care! - -## -## Timer Commands -## - -ok> show timers [all] - - Display the list of active timers for the currently selected workflow - definition. Or, display the list of all timers when used with the - additional keyword 'all'. - -## -## 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 my pooled - - List tasks in a pool for the currently selected user. + Output the contents of the file located at . + + class path to workflow definition file. -ok> show tasks [] - - List tasks associated with the specified workflow . If is - omitted, the tasks associated with the currently selected workflow path are - shown. - -ok> desc task - - Describe the task identified by . - -ok> update task []]* - - Update the state of the specified . Task properties are provided as - name/value pairs or references to pre-defined variables. - - variable name - [*] if specified, define a collection - variable value (comma-seperate to specify a list of values) + ok> deploy - e.g. + Deploy workflow definition to Alfresco server. - update task jbpm$122 bpm:assignee=fred wf:notifyMe=false - -ok> end task [] - - End the task identified by . If is omitted, the - default transition is taken. - -ok> query task [predicate]* - - Query for tasks. If no predicates are provided, all "in-progress" tasks - are returned (across all "active" workflows). + class path to workflow definition. - Predicates are: + ok> redeploy - taskId= - taskName= e.g. taskName=wf:reviewTask - taskState=IN_PROGRESS|COMPLETED - taskActor= e.g. taskActor=admin - task.= e.g. task.bpm:outcome=approve - processId= - processName= e.g. processName=wf:review - processActive=true|false e.g. processActive=true - process.= e.g. process.initiator=admin - orderBy=* e.g. orderBy=TaskDue_Desc,TaskActor_Asc + Redeploy the last workflow definition. - Where is one of: + ok> show definitions [all] - TaskId_Asc, - TaskId_Desc, - TaskCreated_Asc, - TaskCreated_Desc, - TaskDue_Asc, - TaskDue_Desc, - TaskName_Asc, - TaskName_Desc, - TaskActor_Asc, - TaskActor_Desc, - TaskState_Asc, - TaskState_Desc + List latest deployed workflow definitions. Or, display all workflows + definitions (including previous versions) with the additional keyword + 'all'. - e.g. query all in-progress pending submissions for web project X, ordered by pending due date, submitter + ok> use definition [] - query task taskName=wcmwf:submitpending taskState=IN_PROGRESS \ - process.wcwmf:webproject=workspace://SpacesStore/projectx orderBy=TaskDue_Desc,TaskActor_Asc + Switch to use the workflow definition identified by . If + is ommited, the currently selected workflow definition + is shown. -## -## end -## + ok> undeploy definition + + Undeploy the latest version of the workflow definition identified by + . This will also terminate and remove all "in-flight" + workflows associated with the definition. + + If multiple versions of the definition exist, you will have to undeploy + each in turn to remove the definition completely or issue the 'undeploy + definition name' command. + + ok> undeploy definition name + + Undeploy all versions of a workflow definition. As with 'undeploy + definition', all "in-flight" workflows associated with each version + are terminated. + + ## + ## Variable Commands + ## + + ok> var + + Show all defined variables. + + ok> var [*]= + + Define or update a variable. + + variable name + [*] if specified, define a collection + variable value (comma-seperate to specify a list of values) + + e.g. + + var bpm:assignee*=admin,fred + var wf:notifyMe=true + + ok> var [*] person + + Define or update a (cm:person) node ref variable. + + variable name + [*] if specified, define a collection + variable value (comma-seperate to specify a list of values) + + e.g. + + var bpm:assignee* person admin,fred + + ok> var [*] group + + Define or update a (usr:authorityContainer) node ref variable. + + variable name + [*] if specified, define a collection + variable value (comma-seperate to specify a list of values) + + e.g. + + var bpm:groupAssignee group GROUP_Engineering + + ok> var package + + Define or update a (bpm:workflowPackage) node ref variable. + + A new workflow package is created containing content items. + + e.g. + + var bpm:package package 4 + + ok> var = + + Delete an existing variable. + + variable name + + ## + ## Workflow Commands + ## + + ok> 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 + variables. + + e.g. + + start bpm:assignee=david wf:predefined + + ok> show workflows [all] + + Display the list of active workflows for the currently selected workflow + definition. Or, display the list of all workflows (latest and previous + versions of process definitions) when used with the additional keyword 'all'. + + ok> use workflow + + Use the specified . + + ok> desc workflow + + Describe the specified . + + ok> show paths [] + + Display the workflow paths for the specified . If + is omitted, the paths for the currently started workflow are shown. + + ok> desc path + + Describe the specified . Includes the list of properties associated + with the path. + + ok> show transitions [] + + Display all available transitions for the specified . If + is omitted, the transitions for the currently started workflow + are shown. + + ok> signal [] + + Signal transition on specified . If is omitted, the + default transition is taken. + + ok> event + + Fire an event of custom 'eventtype' against the specified path. + + ok> end workflow + + End (cancel) the specified . + + ok> delete workflow + + Force deletion of the specified . + + ok> delete all workflows + + Force deletion of all "in-flight" workflows. Use with care! + + ## + ## Timer Commands + ## + + ok> show timers [all] + + Display the list of active timers for the currently selected workflow + definition. Or, display the list of all timers when used with the + additional keyword 'all'. + + ## + ## 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 my pooled + + List tasks in a pool for the currently selected user. + + ok> show tasks [] + + List tasks associated with the specified workflow . If is + omitted, the tasks associated with the currently selected workflow path are + shown. + + ok> desc task + + Describe the task identified by . + + ok> update task []]* + + Update the state of the specified . Task properties are provided as + name/value pairs or references to pre-defined variables. + + variable name + [*] if specified, define a collection + 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 [] + + End the task identified by . If is omitted, the + default transition is taken. + + ok> query task [predicate]* + + Query for tasks. If no predicates are provided, all "in-progress" tasks + are returned (across all "active" workflows). + + Predicates are: + + taskId= + taskName= e.g. taskName=wf:reviewTask + taskState=IN_PROGRESS|COMPLETED + taskActor= e.g. taskActor=admin + task.= e.g. task.bpm:outcome=approve + processId= + processName= e.g. processName=wf:review + processActive=true|false e.g. processActive=true + process.= e.g. process.initiator=admin + orderBy=* e.g. orderBy=TaskDue_Desc,TaskActor_Asc + + Where is one of: + + TaskId_Asc, + TaskId_Desc, + TaskCreated_Asc, + TaskCreated_Desc, + TaskDue_Asc, + TaskDue_Desc, + TaskName_Asc, + TaskName_Desc, + TaskActor_Asc, + TaskActor_Desc, + TaskState_Asc, + TaskState_Desc + + e.g. query all in-progress pending submissions for web project X, ordered by pending due date, submitter + + query task taskName=wcmwf:submitpending taskState=IN_PROGRESS \ + process.wcwmf:webproject=workspace://SpacesStore/projectx orderBy=TaskDue_Desc,TaskActor_Asc + + ## + ## end + ##