The extension WorkflowCallbacksDemo demonstrates the use of
global callbacks to implement a custom process or action before or after a Workbench
Project Schematic operation. Specifically, it defines pre-
and post-operation callbacks for each available operation. Each task, or argument
passed to the invoked method, defines an action: writing a message in the command
line window either before or after execution of the operation.
This example also shows how to specify that a callback method (in this case,
onAfterUpdate) is processed only for a specific task or
template.

The XML extension definition file WorkflowCallbacksDemo.xml performs the following actions:
References the IronPython script main.py.
For the <interface> block, specifies that
the attribute context is set to
Project, which means that the extension is
executed on the Project tab.
For the <workflow> block:
Defines the attributes name and
context.
Defines pre- and post-operation global callbacks for each available Project Schematic operation.
<extension version="1" name="WorkflowCallbacksDemo"> <guid shortid="WorkflowCallbacksDemo">96d0195b-e138-4841-a13a-de12238c83f2</guid> <script src="main.py" /> <interface context="Project"> <images>images</images> </interface> <workflow name="WorkflowDemo1" context="Project" version="1"> <callbacks> <onbeforetaskreset>onBeforeReset</onbeforetaskreset> <onaftertaskreset>onAfterReset</onaftertaskreset> <onbeforetaskrefresh>onBeforeRefresh</onbeforetaskrefresh> <onaftertaskrefresh>onAfterRefresh</onaftertaskrefresh> <onbeforetaskupdate>onBeforeUpdate</onbeforetaskupdate> <onaftertaskupdate>onAfterUpdate</onaftertaskupdate> <onbeforetaskduplicate>onBeforeDuplicate</onbeforetaskduplicate> <onaftertaskduplicate>onAfterDuplicate</onaftertaskduplicate> <onbeforetasksourceschanged>onBeforeSourcesChanged</onbeforetasksourceschanged> <onaftertasksourceschanged>onAfterSourcesChanged</onaftertasksourceschanged> <onbeforetaskcreation>onBeforeCreate</onbeforetaskcreation> <onaftertaskcreation>onAfterCreate</onaftertaskcreation> <onbeforetaskdeletion>onBeforeDelete</onbeforetaskdeletion> <onaftertaskdeletion>onAfterDelete</onaftertaskdeletion> <onbeforetaskcanusetransfer>onBeforeCanUseTransfer</onbeforetaskcanusetransfer> <onaftertaskcanusetransfer>onAfterCanUseTransfer</onaftertaskcanusetransfer> <onbeforetaskcanduplicate>onBeforeCanDuplicate</onbeforetaskcanduplicate> <onaftertaskcanduplicate>onAfterCanDuplicate</onaftertaskcanduplicate> <onbeforetaskstatus>onBeforeStatus</onbeforetaskstatus> <onaftertaskstatus>onAfterStatus</onaftertaskstatus> <onbeforetaskpropertyretrieval>onBeforePropertyRetrieval</onbeforetaskpropertyretrieval> <onaftertaskpropertyretrieval>onAfterPropertyRetrieval</onaftertaskpropertyretrieval> </callbacks> </workflow> </extension>
The IronPython script main.py contains the code defining the methods invoked by the global callbacks. This script performs the following actions:
Defines 23 methods:
One method for each of the 22 global callback defined in the XML extension definition file.
One method to format a message to write to the command line window.
Specifies (via the method arguments) that the methods
onBeforeUpdate and
onAfterUpdate should be executed only for
updates of Engineering Data tasks.
The script main.py contains the following code:
def onBeforeReset(task):
msg = getPrintMessage('pre-reset', task)
print msg
def onAfterReset(task):
msg = getPrintMessage('post-reset', task)
print msg
def onBeforeRefresh(task):
msg = getPrintMessage('pre-refresh', task)
print msg
def onAfterRefresh(task):
msg = getPrintMessage('post-refresh', task)
print msg
def onBeforeUpdate(task):
if task.Name == "Engineering Data":
msg = getPrintMessage('post-update', task)
print msg
else:
print("ignored")
def onAfterUpdate(task):
if task.Name == "Engineering Data":
msg = getPrintMessage('post-update', task)
print msg
else:
print("ignored")
def onBeforeDuplicate(task):
msg = getPrintMessage('pre-duplicate', task)
print msg
def onAfterDuplicate(task):
msg = getPrintMessage('post-duplicate', task)
print msg
def onBeforeSourcesChanged(task):
msg = getPrintMessage('pre-sources-changed', task)
print msg
def onAfterSourcesChanged(task):
msg = getPrintMessage('post-sources-changed', task)
print msg
def onBeforeCreate(task):
msg = getPrintMessage('pre-creation', task)
print msg
def onAfterCreate(task):
msg = getPrintMessage('post-creation', task)
print msg
def onBeforeDelete(task):
msg = getPrintMessage('pre-deletion', task)
print msg
def onAfterDelete(task):
msg = getPrintMessage('post-deletion', task)
print msg
def onBeforeCanUseTransfer(sourceTask, targetTask):
msg = 'in pre-can-use-transfer with source task ' + sourceTask.Name +
' and target task ' + targetTask.Name
print msg
def onAfterCanUseTransfer(sourceTask, targetTask):
msg = 'in post-can-use-transfer with source task ' + sourceTask.Name +
' and target task ' + targetTask.Name
print msg
def onBeforeCanDuplicate():
msg = getPrintMessage('pre-can-use-transfer', None)
print msg
def onAfterCanDuplicate():
msg = getPrintMessage('post-can-use-transfer', None)
print msg
def onBeforeStatus(task):
msg = getPrintMessage('pre-status', task)
print msg
def onAfterStatus(task):
msg = getPrintMessage('post-status', task)
print msg
def onBeforePropertyRetrieval(task):
msg = getPrintMessage('pre-property', task)
print msg
def onAfterPropertyRetrieval(task):
msg = getPrintMessage('post-property', task)
print msg
def getPrintMessage(msg, task):
taskName = 'none'
if task != None:
taskName = task.Name
return 'in ' + msg + ' callback for task ' + taskName