OOQL language workflow

application workflow


define - create new workflow definition

  workflow define   AdminName {Workflow_DefineOption} [force];

clone - duplicate a workflow and set the properties for the new instance

  workflow clone  AdminName define AdminName {Workflow_EditOption} [force];

edit - update the workflow properties (if no instance is running)

  workflow edit   AdminName {Workflow_EditOption} [force];

show - print the workflow properties

  workflow show   AdminName [Workflow_GetOption] [Token_Option] [ExportFile_Option] ;

select - extract workflows on the base of query filters

  workflow select AdminPatternList {Filter_Option} [Workflow_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

validate - validate the workflow: check if all connections are valid

  workflow validate AdminName ;

undefine - remove a workflow from the database (if no instance is running)

  workflow undefine AdminName ;

Workflow_DefineOption
description GenericValue
application AdminName
image  FileName
imagedata GenericString
execute  AdminActor { AdminActor }
Workflow_Parameters
Workflow_StepListOption
[! /not] hidden

Workflow_EditOption
name AdminName
description GenericValue
application AdminName
svnrev NUMBER
image  FileName
imagedata GenericString
execute  Edit_Operator   AdminActor { Edit_Operator   AdminActor }
params Workflow_Parameter { Workflow_Parameter }
Workflow_StepEditListOption
[! /not] hidden

Workflow_Parameters
params AdminName = GenericValue { AdminName = GenericValue }

Workflow_Parameter
AdminName = GenericValue
remove AdminName
remove all

Workflow_GetOption
get [Workflow_GetBasicOption]
   
  Workflow_GetBasicOption
  { Workflow_GetBasicToken [as IDENTIFIER] { Workflow_GetBasicToken [as IDENTIFIER] } }
  Workflow_GetBasicToken [as IDENTIFIER]
     
    Workflow_GetBasicToken
    Common_GetBasicOption  
    execute  
    params  
    params[]  
    params[ AdminName ]  
    step [. Workflow_GetStepBasicOption]
    step[] [. Workflow_GetStepBasicOption]
    step[ AdminName ] [. Workflow_GetStepBasicOption]
    access  


KEYWORDs
access check if the framework user has access to execute this workflow
application the associated application menu
description the workflow description
execute list of actors enabled to execute this workflow
force this flag allows to ignore errors during the creation/update (for example, some actors not yet defined)
hidden administration hidden objects are not visible/usable
image local path for the workflow icon to upload
imagedata base64 code for the workflow icon
moddate last modification date
name the workflow name
params workflow global parameters
step a single step of the workflow
svnrev SVN repository revision number

workflow - step

Workflow_StepListOption
step AdminName  Workflow_StepType { Workflow_StepOption  }
       
    Workflow_StepOption
   
description GenericValue
    image   FileName
    imagedata  GenericString
    duration  NUMBER
    hpos  GenericNumber
    vpos  GenericNumber
    changestate trigger AdminName
action
& decision
label
href
[! / not] holder
[! / not] notify
execute AdminActorAdminActor }
completion trigger AdminName
completion Workflow_StepCompletion
decision Workflow_StepDecision
system program AdminName
executable FileName
notification language GenericValue
subject GenericValue
body GenericValue
bodyform AdminName
to AdminActorAdminActor }
cc AdminActorAdminActor }
bcc AdminActorAdminActor }
join threshold  NUMBER
[! / not] stopothers
[! / not] expireothers
lifecycle operation Workflow_StepOperation
    params Workflow_StepParameter { Workflow_StepParameter }
    Workflow_StepTransitionList

Workflow_StepEditListOption
step  add  AdminName  Workflow_StepType { Workflow_StepOption  }
step  change  AdminName  { Workflow_StepModOption  }
step  remove  AdminName  
       
    Workflow_StepModOption
   
name AdminName
   
description GenericValue
    image   FileName
    imagedata  GenericString
    type  Workflow_StepType
    duration  NUMBER
    hpos  GenericNumber
    vpos  GenericNumber
    changestate trigger AdminName
action
& decision
label
href
[! / not] holder
[! / not] notify
execute  Edit_Operator AdminActor { Edit_Operator AdminActor }
completion trigger AdminName
completion Workflow_StepCompletion
decision Workflow_StepDecision
system program AdminName
executable FileName
notification language GenericValue
subject GenericValue
body GenericValue
bodyform AdminName
to  Edit_Operator AdminActor { Edit_Operator AdminActor }
cc  Edit_Operator AdminActor { Edit_Operator AdminActor }
bcc  Edit_Operator AdminActor { Edit_Operator AdminActor }
join threshold  NUMBER
[! / not] stopothers
[! / not] expireothers
lifecycle operation Workflow_StepOperation
    params Workflow_StepParameter { Workflow_StepParameter }
    Workflow_StepTransitionModList

Workflow_StepType
start
stop
action
system
lifecycle
decision
notification
or-join
and-join
split

Workflow_StepParameter
AdminName = GenericValue [from AdminName] [to AdminName]
remove AdminName
remove all

Workflow_StepCompletion
any
all
min

Workflow_StepOperation
progress
regress
setstage AdminName
validate AdminName
ignore AdminName
refuse AdminName

Workflow_StepDecision
single
multiple

Workflow_GetStepBasicOption
{ Workflow_GetStepBasicToken [as IDENTIFIER] { Workflow_GetStepBasicToken [as IDENTIFIER] }}
Workflow_GetStepBasicToken [as IDENTIFIER]
   
  Workflow_GetStepBasicToken
  Common_GetBasicOption  
  type  
  duration  
  hpos  
  vpos  
  changestate.trigger [. Program_GetBasicOption]
action
& decision
label  
href  
holder  
notify  
execute  
completion.trigger [. Program_GetBasicOption]
completion  
decision  
system program [. Program_GetBasicOption]
executable  
notification language  
subject  
body  
bodyform [. Form_GetBasicOption]
to  
cc  
bcc  
join threshold  
stopothers  
expireothers  
lifecycle operation  
operation.option  
  params  
  params[]  
  params[ AdminName ]  
  transition [. Workflow_GetTransitionBasicOption]
  transition[] [. Workflow_GetTransitionBasicOption]
  transition[ AdminName ] [. Workflow_GetTransitionBasicOption]
  access[ AdminName ]  


KEYWORDs
access check if the given user has access to execute this step action
bcc blind carbon copy recipients (users / teams /assignments) for notification steps
body the mail body text for notification steps; also used for decision and action steps when the notify options is enabled
bodyform form used to compose the mail body text in notification steps
cc carbon copy recipients (users / teams /assignments) for notification steps
changestate trigger trigger executed when the step changes its state in the workflow-process runtime
completion for action/decision steps indicate if all users, a single user or a minimum number of users have to perform the action to complete the step
decision for decision steps set the user choice mode (single or multiple choices)
decision.trigger this trigger runs for any user action / decision
description the step description
duration the step maximum duration time in seconds
executable filesystem path of an executable program or script
execute list of actors enabled to execute this step (only for action/decision steps)
expireothers used for or-join / and-join steps to put in the expired status the not yet completed incoming steps
holder step execution permitted to the object holder(s) (when objects are involved)
hpos the horizontal position inside the workflow graphical representation
href the action url (hyperlink to jsp page or SWT panel)
image local path for the step icon to upload
imagedata base64 code for the step icon
label the action label (can include keyword substitutions and dictionary keywords)
language the notification language for mail subject and body translation; if not specified will be used for each recipient the default language
name the step name
notify send notification to enabled actors when the step starts the execution
operation type of operation executed in lifecycle action step
operation.option the name of the stage or the name of the validation
params the step local parameters (when steps start the execution the parameter values can be copyed from global parameters and at the end copyed back to global parameters)
stopothers used for or-join / and-join steps to put in the terminated status the not yet completed incoming steps
program the program automatically executed by the process manager in a system step
subject the mail subject for notification steps; also used for decision and action steps when the notify options is enabled
to message recipients (users / teams /assignments) for notification steps
transition transitions from the current step to other workflow steps
threshold used for and-join steps to set the minimum of incoming steps, for considering the them completed
type the step behaviour:
start the first step executed when a workflow instance (process) is started.
action define workflow actions associated to a user interface link (href and label)
decision define a task where users can decide for the next steps
system define workflow actions associated to a system program
lifecycle perform lifecycle actions on the primary object
notification send mail to a recipient list
split decomposes the information flow in two or more branches
or-join unifies two or more branches of the information flow; go forward to next step when ONE of the input tasks will be completed.
and-join unifies two or more branches of the information flow; go forward to next step when ALL (or a minimal number) of the input tasks will be completed.
stop stops the workflow execution independently from other branches.
vpos the vetical position inside the workflow graphical representation

workflow - step - transition

Workflow_StepTransitionList
transition AdminName stepfork AdminName { Workflow_StepTransitionOption }
       
    Workflow_StepTransitionOption
    description GenericValue
    [! / not] required
    check trigger AdminName
    action trigger AdminName

Workflow_StepTransitionModList
transition  add  AdminName stepfork AdminName { Workflow_StepTransitionOption }
transition  change  AdminName { Workflow_StepTransitionModOption }
transition  remove  AdminName
       
    Workflow_StepTransitionModOption
    name AdminName
    description GenericValue
    [! / not] required
    stepfork AdminName
    check trigger AdminName
    action trigger AdminName

Workflow_GetTransitionBasicOption
{ Workflow_GetTransitionBasicToken [as IDENTIFIER] { Workflow_GetTransitionBasicToken [as                                  IDENTIFIER] } }
Workflow_GetTransitionBasicToken [as IDENTIFIER]
   
  Workflow_GetTransitionBasicToken
  name  
  description  
  stepfork  
  required  
  check.trigger [. Program_GetBasicOption]
  action.trigger [. Program_GetBasicOption]


KEYWORDs
action.trigger program used to perform additional action during the step transition
check.trigger program used to check if the conditions for step transition are satisfied
description the transition description
name the transition name
required if set, force the "and-join" step to include the incoming step related to this transaction
stepfork the transition target step

common syntax

Common_GetBasicOption
Common_GetBasicToken [ as IDENTIFIER ]

Common_GetBasicToken
id  
name  
origdate  
moddate  
moduser  
description  
svnrev  
hidden  
image  
imagedata  
feature[ AdminName ] [. Feature_GetBasicOption]
feature[] [. Feature_GetBasicOption]
feature [. Feature_GetBasicOption]
application [. Menu_GetBasicOption]
super  
admintype  

Edit_Operator
add
remove

Edit_RefOperator
addbefore AdminName set
addafter AdminName set
add
remove
movebefore
moveafter

Edit_AddOperator
addbefore AdminName define
addafter AdminName define
append

Edit_MoveOperator
movebefore
moveafter

Event_Type
action
check

AdminPatternList
AdminNamePattern {, AdminNamePattern}

AdminNamePattern
*
PATTERNIDENTIFIER
STRINGVAL
AdminName

GenericPatternList
GenericPattern {, GenericPattern}

GenericPattern
*
IDENTIFIER
PATTERNIDENTIFIER
GenericValue

AdminActor
user AdminName
team AdminName
assignment AdminName

AdminName
IDENTIFIER
QUOTED_STRING
SQUOTED_STRING

GenericValue
DATETIME
GenericNumber
GenericString
BOOLEANVAL

GenericString
STRINGVAL
QUOTED_STRING
SQUOTED_STRING

GenericNumber
NUMBER
REALNUMBER

Filter_Option
moddate Date_Range
application AdminNamePattern

Date_Range
=  DATETIME  
!= DATETIME
 
<  DATETIME
 
>  DATETIME
 
<= DATETIME
 
>= DATETIME
 
in [ DATETIME , DATETIME ]
 
in ( DATETIME , DATETIME ]
 
in [ DATETIME , DATETIME )
 
in ( DATETIME , DATETIME )  

Token_Option
token { Token_Separator { Token_Separator } }
token Token_Separator

Token_Separator
QUOTED_STRING
SQUOTED_STRING
IDENTIFIER
STRINGVAL
json
json-
json+
xml
xml-
xml+

ExportFile_Option
exportfile FileName [append] [xml | json ]

ImportFile_Option
importfile FileName [xml | json |emxxml]

LogFile_Option
logfile FileName [append]

FileName
QUOTED_STRING
SQUOTED_STRING

basic elements
grammar rules
[ ] = optional element - only one item is allowed : ( 0 or 1 )
{ } = optional element - more than one is allowed : ( 0 or N )
/ = alternative
= one of ...
   
  all bold texts represent keywords or command syntax

IDVAL
#<5 dec digits [ 0-9 ]>-<8 hex digits [ 0-9 A-F ]>
  example:
  #00020-34F2A80E

COMMENT
// <any character until the end of the line(\n \r)>
  example:
  // My single line comment

LONGCOMMENT
/* <any character> */
 

example:
  /* My multi line comment starts here
  continue here
  and finish here */


DATETIME
<year 4 digits>[ - /. ]<month 2 digits>[ - /. ]<day 2 digits>
  examples:
   2009-12-23    2009/03/19   2009.11.14
<year 4 digits>[ - /. ]<month 2 digits>[ - /. ]<day 2 digits> <hours>:<minutes>:[<seconds>]
  examples:
   2009-12-23 10:23   2009/03/19 16:03:34  2009.11.14 00:20:04

NUMBER
[+-]<decimal digits [ 0-9 ]>
  examples:
   -1203   +276   25

BOOLEANVAL
true / false

REALNUMBER
[+-]<decimal digits [ 0-9 ]>.<decimal digits [ 0-9 ]>[E(+-)<esponent [0-9]>]
  example:
   -37.837   +2.3874   13.887   1.4862E-04

QUOTED_STRING
"<any character>"
  example:
   "my quoted string"

SQUOTED_STRING
'<any character>'
  example:
   'my single quoted string'

IDENTIFIER
<one or more of [ a-z A-Z ]><zero or more of [ a-z A-Z 0-9 _ ]>
  example:
   Var1    object_Name_02

VARIABLE
$<one o more of [ a-z A-Z 0-9 ]><zero or more of [ a-z A-Z 0-9 _ ]>
 

example:
   $1   $var_02    $1b


STRINGVAL
<one or more of [ a-z A-Z 0-9 -_ $ ? @ | ~ % & / = : + \ # ' ]>
  a string not recognized as identifier

PATTERNIDENTIFIER
<a string with * (match 0 or more characters) and ? (match 1 character) wildcards>
  example:
   mypa*er?_ide?ti*

© 2008-2015 MS Enterprise Solutions | Website Templates by IceTemplates.com
Please Read: Privacy Policy and Terms of Use