9.63.5.21 Functions for Python

The following functions apply to Python agents in both real-time and batch workflows.

This section includes the following:

• UDR Related Functions
• Debug Related Functions
• MIM Related Functions
• Misc Functions
• Dynamic Functions
• Timeout Functions
• Log Related Functions
• Functions for Python Agents in Batch Workflows Only

UDR Related Functions

udrRoute

This function routes a UDR or bytearray to all the output routes, or a named output route.

def udrRoute(udr, route=None)

def consume(input):
    if isinstance(input, InstallModel):
        udrRoute(input, 'install')
    else:
        udrRoute(input) 

udrCreate

This function creates a new UDR of the specified type, and can take keyword arguments to set its fields.

def udrCreate(typename, **kwargs)

#
# The following shows six different ways of creating UDRs
#

from ultra.MyFolder.MyUltra import MyUDR

myudr1 = MyUDR(field1=33, field2=88)

myudr2 = MyUDR()
myudr2.field1 = 33
myudr2.field2 = 88

myudr3 = udrCreate(MyUDR, field1=33, field2=88)

myudr4 = udrCreate(MyUDR)
myudr4.field1 = 33
myudr4.field2 = 88

myudr5 = udrCreate("MyFolder.MyUltra.MyUDR", field1=33, field2=88)

myudr6 = udrCreate("MyFolder.MyUltra.MyUDR")
myudr6.field1 = 33
myudr6.field2 = 88

udrIsPresent

 This function returns True if the UDR field is present.

def udrIsPresent(udr, attr)

if udrIsPresent(myudr, 'field1'):
    debug("The optional field 'field1' is present") 

udrUnsetPresent

 This function marks an optional attribute for a UDR as not present.

def udrUnsetPresent(udr, attr)

udrConsume

This function consumes a UDR routed to the Python Connector agent. The timeout is in seconds.

def udrConsume(timeout=None)         

Debug Related Functions

debug

This function prints the supplied object to the output target specified in the Execution tab of the Workflow Properties dialog. 

If Event is selected, the output is shown in the Workflow Monitor.

def debug(obj)

isDebugEnabled

This function states if debugging has been enabled for the workflow. A debug event is only sent if isDebugEnabled returns True.

def isDebugEnabled()

MIM Related Functions

mimGet

This function returns the value of a MIM resource available in the workflow. 

def mimGet(category, mimResourceName)

mimGet("Workflow", "Batch Count") # Retrieving a MIM resource owned by the workflow.
mimGet("Python_1", "Source File Count") # Retrieving a MIM resource owned by the agent "Python_1".

mimSet

This function assigns a value to a user defined MIM resource. The function may be called at any time. Note that it is the responsibility of the user to make sure the MIM value is available in accordance with the specified assigned type.

def mimSet(name, value)

mimSet("My MIM", 88)

Misc Functions

abort

This function stops the workflow, and logs a user defined message to the System Log. 

def abort(message)

abort("The processing failed, aborting this workflow!")

wfStop

This function stops a running workflow. wfStop produces a single stop signal and does not wait for the workflow to stop. If it succeeds in stopping the workflow, the stop is registered in the System Log. 

def wfStop(wfName, immediate=True)

wfStop("Default.MyWorkflow.workflow_1")

isStopped

This function states if the workflow has been stopped.

def isStopped()

if not isStopped():
    debug('Not stopped yet')

Dynamic Functions

dynamicFieldGet

This function retrieves the stated dynamic field from the workflow instance table. The returned value can either be a boolean, an integer, or a string. 

def dynamicFieldGet(category, name)

dynamicFieldGet('Control', 'Filename')

Timeout Functions

setTimeout

A timeout can be set to trigger delayed actions, see the def timeout(obj) function block in 9.63.5.1.2 Function Blocks for Agents in Real-Time Workflows. The timeout is in seconds. Setting a timeout on an object sets or updates the current timeout in seconds on that object. A timeout is triggered once on the object, and then it has to be set again to be repeated.

def setTimeout(obj, timeout)

removeTimeout

A timeout can be removed, see the def timeout(obj) function block in 9.63.5.1.2 Function Blocks for Agents in Real-Time Workflows. The timeout is in seconds.

def removeTimeout(obj)

Log Related Functions

logInformation

This function logs a message string to the System Log of type information.

def logInformation(message)

logWarning

This function logs a message string to the System Log of type warning.

logWarning(message)

logError

This function logs a message string to the System Log of type error.

def logError(message)

logException

This function logs the current exception to the System Log.

def logException()

try:
    some_function()
except:
    # Log exception to the System Log instead of aborting the workflow.
    logException()

formatException

This function formats the current exception and returns the string.

def formatException()

 Functions for Python Agents in Batch Workflows Only

The following functions only apply for the Python agents in batch workflows.

beginBatch

This function starts a new batch.

def beginBatch()

def execute():
    beginBatch()
    udrRoute(PulseUDR())
    endBatch()

endbatch

This function ends the current batch.

def endBatch()

cancelBatch

This function emits a Cancel Batch that aborts the processing of the current batch and possibly continues with the next batch (depending on the workflow configuration).

def cancelBatch(message, errorUDR=None)

cancelBatch("Cancel this batch")

splitBatch

When invoked, this function propagates to the other agents that the input batch will be split.

def splitBatch()

hintEndBatch

This function sends a Hint End Batch message to the collection agent in the workflow, possibly causing a split of the current batch being processed.

def hintEndBatch()

getTransactionId

This function returns the current transaction id, or None if there is currently no active transaction.

def getTransactionId()