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

This section includes the following:

1 UDR Related Functions
- 1.1 udrRoute
  - 1.1.1 Note!
  - 1.1.2 Example - udrRoute
- 1.2 udrCreate
  - 1.2.1 Example - udrCreate
- 1.3 udrIsPresent
  - 1.3.1 Example - udrIsPresent
- 1.4 udrUnsetPresent
- 1.5 udrConsume
  - 1.5.1 Note!
  - 1.5.2 Note!
2 Debug Related Functions
- 2.1 debug
- 2.2 isDebugEnabled
3 MIM Related Functions
- 3.1 mimGet
  - 3.1.1 Example - mimGet
- 3.2 mimSet
  - 3.2.1 Example - mimSet
4 Misc Functions
- 4.1 abort
  - 4.1.1 Note!
  - 4.1.2 Example - abort
- 4.2 wfStop
  - 4.2.1 Example - wfStop
- 4.3 isStopped
  - 4.3.1 Note!
  - 4.3.2 Example - isStopped
5 Dynamic Functions
- 5.1 dynamicFieldGet
  - 5.1.1 Example - dynamicFieldGet
6 Timeout Functions
- - 6.1.1 Note!
- 6.2 setTimeout
- 6.3 removeTimeout
7 Log Related Functions
- 7.1 logInformation
- 7.2 logWarning
- 7.3 logError
- 7.4 logException
  - 7.4.1 Example - logException
- 7.5 formatException
8 Functions for Python Agents in Batch Workflows Only
- 8.1 beginBatch
  - 8.1.1 Note!
  - 8.1.2 Example - beginBatch
- 8.2 endbatch
  - 8.2.1 Note!
- 8.3 cancelBatch
  - 8.3.1 Example - cancelBatch
- 8.4 splitBatch
  - 8.4.1 Note!
- 8.5 hintEndBatch
- 8.6 getTransactionId

UDR Related Functions

udrRoute

Note!

This function does not apply for the Python agent in task workflows.

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

def udrRoute(udr, route=None)

Parameter	Description

Parameter	Description
`udr`	The UDR to route
`route`	The route on which to send the UDR
Returns	Nothing

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)

Parameter	Description

Parameter	Description
`typename`	A defined UDR type
`**kwargs`	Keyword arguments to set the specified fields
Returns	A UDR of the type specified

Example - udrCreate

udrIsPresent

This function returns True if the UDR field is present.

Parameter	Description

Parameter	Description
`udr`	The UDR
`attr`	The attribute name
Returns	True if the UDR field is present.

udrUnsetPresent

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

Parameter	Description

Parameter	Description
`udr`	The UDR
`attr`	The attribute name
Returns	Nothing

udrConsume

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

Parameter	Description

Parameter	Description
`timeout`	The timeout in seconds, which waits forever if no timeout is specified
Returns	The 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.

Parameter	Description

Parameter

Description

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.

Returns

Nothing

isDebugEnabled

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

Parameter	Description

Parameter	Description
Returns	True 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.

Parameter	Description

Parameter	Description
`category`	The name of the agent or workflow that owns the MIM resource
`mimResourceName`	The name of the MIM resource whose value is to be returned
Returns	The MIM value.

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.

Parameter	Description

Parameter	Description
`name`	The name of the MIM resource to assign a value
`value`	The value to assign, which must match the published MIM type
Returns	Nothing

Misc Functions

abort

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

Parameter	Description

Parameter	Description
`message`	The message that is sent to the System Log when the workflow is aborted
Returns	Nothing

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.

Parameter	Description

Parameter	Description
`wfName`	You must provide the name of the workflow to be stopped.
`immediate`	For 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.
Returns	If the command is successful the value is `None`. Otherwise, a text message is returned.

isStopped

This function states if the workflow has been stopped.

Parameter	Description

Parameter	Description
Returns	True or False depending on if workflow has been stopped or not

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.

Parameter	Description

Parameter	Description
`category`	The cateogry of the dynamic field
`name`	The name of the dynamic field
Returns	The value of the selected dynamic field

Timeout Functions

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.

Parameter	Description

Parameter	Description
`obj`	The object can be of any type
`timeout`	The timeout in seconds
Returns	Nothing

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.

Parameter	Description

Parameter	Description
obj	The same object as used in `setTimeout`
Returns	Nothing

Log Related Functions

logInformation

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

Parameter	Description

Parameter	Description
`message`	A message appearing in the log
Returns	Nothing

logWarning

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

Parameter	Description

Parameter	Description
message	A message appearing in the log
Returns	Nothing

logError

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

Parameter	Description

Parameter	Description
`message`	A message appaering in the log
Returns	Nothing

logException

This function logs the current exception to the System Log.

Parameter	Description

Parameter	Description
Returns	Nothing

formatException

This function formats the current exception and returns the string.

Parameter	Description

Parameter	Description
Returns	The 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

This function starts a new batch.

Parameter	Description

Parameter	Description
Returns	Nothing

endbatch

This function ends the current batch.

Parameter	Description

Parameter	Description
Returns	Nothing

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).

Parameter	Description

Parameter

Description

message

A 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.

Returns

Nothing

splitBatch

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

Parameter	Description

Parameter	Description
Returns	Nothing

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.

Parameter	Description

Parameter	Description
Returns	Nothing

getTransactionId

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

Parameter	Description

Parameter	Description
Returns	The current transaction id or `None`

Usage Engine Private Edition 4 Documentation

Functions for Python (4.3)

UDR Related Functions

udrRoute

Note!

Example - udrRoute

udrCreate

Example - udrCreate

udrIsPresent

udrUnsetPresent

udrConsume

Debug Related Functions

debug

isDebugEnabled

MIM Related Functions

mimGet

mimSet

Misc Functions

abort

wfStop

isStopped

Dynamic Functions

dynamicFieldGet

Timeout Functions

setTimeout

removeTimeout

Log Related Functions

logInformation

logWarning

logError

logException

formatException

Functions for Python Agents in Batch Workflows Only

beginBatch

endbatch

cancelBatch

splitBatch

hintEndBatch

getTransactionId