Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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

This section includes the following:

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)
ParameterDescription
udrThe UDR to route
routeThe route on which to send the UDR
ReturnsNothing

Example - udrRoute

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)
ParameterDescription
typenameA defined UDR type
**kwargsKeyword arguments to set the specified fields
ReturnsA UDR of the type specified

Example - udrCreate

#
# 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)
ParameterDescription
udrThe UDR
attrThe attribute name
ReturnsTrue if the UDR field is present.

Example - udrIsPresent

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)
ParameterDescription
udrThe UDR
attrThe attribute name
ReturnsNothing

udrConsume

Note!

This function applies for the Python Connector agent only.

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

Note!

UDRs that have not been consumed are overwritten.

def udrConsume(timeout=None)         
ParameterDescription
timeoutThe timeout in seconds, which waits forever if no timeout is specified
ReturnsThe UDR or bytearray routed, or None if timed out while waiting

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)
ParameterDescription
obj

The object to write to debug output. The object can be of any type.

Note that printing a UDR type will dump all the field values, which may be a large amount of data. Similarly, the debug output for a table, map, list or bytearray type may be very large.

The output is the string representation of object.

ReturnsNothing

isDebugEnabled

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

def isDebugEnabled()
ParameterDescription
ReturnsTrue or False depending on if debug is enabled or not

MIM Related Functions

mimGet

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

def mimGet(category, mimResourceName)
ParameterDescription
categoryThe name of the agent or workflow that owns the MIM resource
mimResourceNameThe name of the MIM resource whose value is to be returned
ReturnsThe MIM value.

Example - mimGet

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)
ParameterDescription
nameThe name of the MIM resource to assign a value
valueThe value to assign, which must match the published MIM type
ReturnsNothing

Example - mimSet

mimSet("My MIM", 88)

Misc Functions

abort

Note!

This function does not apply for the Python Connector agent.

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

def abort(message)


ParameterDescription
messageThe message that is sent to the System Log when the workflow is aborted
ReturnsNothing

Example - abort

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)
ParameterDescription
wfNameYou must provide the name of the workflow to be stopped.
immediateFor a real-time workflow, the immediate flag has no significance. For a batch workflow, when immediate=True, the function stops the currently handled batch; when immediate=False, the currently handled batch is run and then the workflow stops.
ReturnsIf the command is successful the value is None. Otherwise, a text message is returned.

Example - wfStop

wfStop("Default.MyWorkflow.workflow_1")

isStopped

Note!

This function does not apply for the Python Connector agent.

This function states if the workflow has been stopped.

def isStopped()
ParameterDescription
ReturnsTrue or False depending on if workflow has been stopped or not

Example - 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)
ParameterDescription
categoryThe cateogry of the dynamic field
nameThe name of the dynamic field
ReturnsThe value of the selected dynamic field

Example - dynamicFieldGet

dynamicFieldGet('Control', 'Filename')

Timeout Functions

Note!

The timeout functions only apply for the Python collection and processing agents in real-time workflows.

setTimeout

A timeout can be set to trigger delayed actions, see the def timeout(obj) function block in 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)
ParameterDescription
objThe object can be of any type
timeoutThe timeout in seconds
ReturnsNothing

removeTimeout

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

def removeTimeout(obj)
ParameterDescription
objThe same object as used in setTimeout
ReturnsNothing

Log Related Functions

logInformation

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

def logInformation(message)
ParameterDescription
messageA message appearing in the log
ReturnsNothing

logWarning

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

logWarning(message)
ParameterDescription
messageA message appearing in the log
ReturnsNothing

logError

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

def logError(message)
ParameterDescription
messageA message appaering in the log
ReturnsNothing

logException

This function logs the current exception to the System Log.

def logException()
ParameterDescription
ReturnsNothing

Example - 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()
ParameterDescription
ReturnsThe current exception formatted as a string

 Functions for Python Agents in Batch Workflows Only

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

beginBatch

Note!

This function only applies for Python collection agents in batch workflows.

This function starts a new batch.

def beginBatch()
ParameterDescription
ReturnsNothing

Example - beginBatch

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

endbatch

Note!

This function only applies for Python collection agents in batch workflows.

This function ends the current batch.

def endBatch()
ParameterDescription
ReturnsNothing

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)
ParameterDescription
messageA message, which is logged to the System Log when the batch is cancelled.
errorUDR

It is possible to send an error UDR containing any useful information.

This parameter is optional.

ReturnsNothing

Example - cancelBatch

cancelBatch("Cancel this batch")

splitBatch

Note!

This function only applies for Python collection agents in batch workflows.

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

def splitBatch()
ParameterDescription
ReturnsNothing

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()
ParameterDescription
ReturnsNothing

getTransactionId

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

def getTransactionId()
ParameterDescription
ReturnsThe current transaction id or None
  • No labels