Copyright © Cloud Software Group, Inc. All Rights Reserved

TIBCO Hawk Microagent Methods

This section describes the TIBCO Hawk microagent methods for the TIBCO ActiveMatrix BusinessWorks process engine.

ConfigureActivityTracing

Description:

Enables or disables tracing for specified activity. Activities can be specified by process definition and activity name or by class name. The class name is the Java implementation class' name.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessDefinition	Name of the process definition for which you wish to configure tracing. Specifying * signifies all process definitions. If ActivityClass is specified, this argument is optional.
Activity	Name of the activity for which you wish to configure tracing. Specifying * signifies all activities. If ActivityClass is specified, this argument is optional.
ActivityClass	Java implementation class name of the activity for which you wish to configure tracing. This argument is optional if you specify the ProcessDefinition and Activity arguments.
Enable	Specify true if you wish to enable tracing, false if you wish to disable tracing.

Output:

None

ConfigureAllTracing

Description:

Controls tracing for all activities and process starters.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
EnableAllActivities	If true, tracing is enabled for all activities. If false, tracing will be disabled for all activities.
EnableAllStarters	If true, tracing is enabled for all process starters. If false, tracing will be disabled for all process starters.
EnableAllUserRoles	If true, tracing is enabled for all user-defined roles. If false, tracing will be disabled for all user-defined roles.

Output:

None

ConfigureProcessStarterTracing

Description:

Enables or disables tracing for specified process starter. Process starters can be specified by name or class name. The class name is the Java implementation class' name.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessStarter	Name of the process starter for which you wish to configure tracing. Specifying * signifies all process starters. If StarterClass is specified, this argument is optional.
StarterClass	Java implementation class name of the process starter for which you wish to configure tracing. This argument is optional if you specify the ProcessStarter argument.
Enable	Specify true if you wish to enable tracing, false if you wish to disable tracing.

Output:

None

ConfigureRole

Description:

Enables or disables tracing for the specified role.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
Role	Name of the role for which you wish to configure tracing. Specifying * signifies all roles.
Enable	Specify true if you wish to enable tracing, false if you wish to disable tracing.

Output:

None

ConfigureUserDefinedTracing

Description:

Enables or disables tracing for the specified user-defined role.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
Role	Name of the user-defined role for which you wish to configure tracing. Specifying * signifies all user-defined roles.
Enable	Specify true if you wish to enable tracing, false if you wish to disable tracing.

Output:

None

DelayedStopApplicationInstance

Description:

Instructs all process starters to stop further job creation but stay active. The engine shuts down after all process instances have completed or the specified maximum delay has been reached. After shutdown, any remaining checkpoint files are preserved and the engine's operating system process exits.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
MaxDelay	Specifies the amount of time (in seconds) to wait before shutting down the process engine.
WaitForCheckpoints	When true is specified, the engine waits for any checkpointed process instances to complete before shutting down.

Output:

None

GetActivities

Description:

Retrieves information about the activities that have been executed for a given process definition since the engine was started. The activity information is cumulative. A single activity name represents all executions of that activity. The min/max fields can be reset with the ResetActivityStats method.

The ExecutionTime computation for the Call Process Activity includes the sum of the execution times for all activities in the called process, not just the execution time for the call process activity itself.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessDefinition	Name of the process definition.

Output:

The following table describes the output of this microagent method:

Column Name	Description
ProcessDefName	Name of the process definition.
Name	Name of the activity.
ActivityClass	Name of the class that implements the activity.
ExecutionCount	Number of times the activity has been executed.
ElapsedTime	Total clock time (in milliseconds) used by all executions of this activity. This includes waiting time for Sleep, Call Process, and Wait For... activities.
ExecutionTime	Total clock time (in milliseconds) used by all executions of this activity. This does not include waiting time for Sleep, Call Process, and Wait For... activities.
ErrorCount	Total number of executions of the activity that have returned an error.
LastReturnCode	Status code returned by most recent execution of this activity. This can be either OK, DEAD, or ERROR.
Tracing	True if tracing is enabled for this activity, false if tracing is disabled.
MinElapsedTime	Elapsed clock time (in milliseconds) of the activity execution that has completed in the shortest amount of elapsed time.
MaxElapsedTime	Elapsed clock time (in milliseconds) of the activity execution that has completed in the longest amount of elapsed time.
MinExecutionTime	Execution time (in milliseconds) of the activity execution that has completed in the shortest amount of execution time.
MaxExecutionTime	Execution time (in milliseconds) of the activity execution that has completed in the longest amount of execution time.
MostRecentElapsedTime	Elapsed clock time (in milliseconds) of the most recently completed activity execution.
MostRecentExecutionTime	Execution time (in milliseconds) of the most recently completed activity execution.
TimeSinceLastUpdate	Time (in milliseconds) since the statistics have been updated.
CalledProcessDefs	A comma-separated list of names of process definitions called by this activity.
ExecutionCountSinceReset	Number of activity executions that have completed since the last reset of the statistics.

GetExecInfo

Description:

Retrieves the process engine execution information.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
Status	Engine status. Can be one of the following: • ACTIVE • SUSPENDED • STANDBY • STOPPING
Uptime	Elapsed time (in milliseconds) since the process engine was started.
Threads	Number of worker threads used by the process engine.
Version	Version of the process engine.

getHostInformation

Description:

Returns the value of the specified property on the host machine on which the process engine is running.

Method Arguments:

he following table describes the arguments of this microagent method:

Argument Name

Description

Name

Name of the property to return. Leave this argument blank to return all properties. The following are the properties that can be returned: • Application Instance — is the name of the project that is running in the process engine. • Application Name — TIBCO Hawk display name of the process engine. This is set by the engine property Hawk.AMI.DisplayName. • Application State — state of the process engine. Can be UNINITIALIZED, INITIALIZING, RUNNING, STOPPING, or STOPPED

Output:

The following table describes the output of this microagent method:

Column Name	Description
Name	Name of the property returned.
Value	Value of the property.

GetMemoryUsage

Description:

Retrieves information about the process engine’s memory usage.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
TotalBytes	Total number of bytes allocated to the process engine.
FreeBytes	Total number of bytes that are not currently in use.
UsedBytes	Total number of bytes that are currently in use.
PercentUsed	Percentage of total bytes that are in use.

GetProcessCount

Description:

Returns the total number of running process instances.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
TotalRunningProcesses	Total number of currently executing process instances.

GetProcessDefinitions

Description:

Retrieves information about process definitions.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
Name	Name of the process definition.
Starter	Name of the process starter for the process.
Created	Number of process instances created for this process definition.
Suspended	Number of times process instances have been suspended.
Swapped	Number of times process instances have been swapped to disk.
Queued	Number of times process instances have been queued for execution.
Aborted	Number of times process instances have been aborted.
Completed	Number of process instances that have been successfully completed.
Checkpointed	Number of times process instances have executed a checkpoint.
TotalExecution	Total execution time (in milliseconds) for all successfully completed process instances.
AverageExecution	Average execution time (in milliseconds) for all successfully completed process instances.
TotalElapsed	Total elapsed time (in milliseconds) for all successfully completed process instances.
AverageElapsed	Average elapsed clock time (in milliseconds) for all successfully completed process instances.
MinElapsed	Elapsed clock time (in milliseconds) of the process instance that has completed in the shortest amount of elapsed time.
MaxElapsed	Elapsed clock time (in milliseconds) of the process instance that has completed in the longest amount of elapsed time.
MinExecution	Execution time (in milliseconds) of the process instance that has completed in the shortest amount of execution time.
MaxExecution	Execution time (in milliseconds) of the process instance that has completed in the longest amount of execution time.
MostRecentExecutionTime	Execution time (in milliseconds) of the most recently completed process instance.
MostRecentElapsedTime	Elapsed clock time (in milliseconds) of the most recently completed process instance.
TimeSinceLastUpdate	Time (in milliseconds) since the statistics have been updated.
CountSinceReset	Number of process instances that have completed since the last reset of the statistics.

GetProcesses

Description:

Retrieves information about active process instances. If arguments are specified, information for process instances that match the specified arguments is returned.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
Id	ID for the process instance.
Name	Name of the process definition used by the process instance.
EarliestStartTime	Earliest time (in milliseconds) at which the process instance started. All process instances started after the specified time will be retrieved.
MinimumDuration	Minimum time (in milliseconds) in elapsed clock time since the process instance started. All process instances that have elapsed times greater than the specified minimum duration will be retrieved.
MainProcessName	Name of the main process definition.

Output:

The following table describes the output of this microagent method:

Column Name	Description
Id	ID for the process instance.
Name	Name of the process definition used by the process instance.
TrackingId	Tracking ID for the process instance.
CustomId	Custom ID for the process instance.
Status	Status of the process.
StartTime	Time when the process instance started.
Duration	Elapsed clock time (in milliseconds) since the process instance started.
MainProcessName	Name of the main process definition.
CurrentActivityName	Name of the currently executing activity in the process instance.
StarterName	Name of the process starter that started this process instance.
SubProcessName	Name of the process definition for the sub-process.

GetProcessesExceptions

Description:

Retrieves error information reported by the specified process.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
Id	ID for the process instance. If not specified, or if 0 is specified, exceptions for all process instances are returned.

Output:

The following table describes the output of this microagent method:

Column Name	Description
Seq	Sequence number of the exception, with the most recent exception first.
Id	ID for the process instance.
Message	Exception message.
StackTrace	Exception stack trace.
ExceptionClass	Exception class name.
ProcessStack	Process stack at exception. This displays the [ProcessName/GroupName/ActivityName] of the activity issuing the exception. If the activity is in a called sub-process, then the calling activity’s process stack plus a '>' separator character will be pre-pended to the normal information to produce the process stack of the activity issuing the exception.
TrackingId	Tracking ID for the process instance.
ProcessDef	Name of the process definition.
State	State of the process.

GetProcessStarters

Description:

Retrieves information about either active or inactive process starters. The information is cumulative. A single process starter name represents all executions of that process starter.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ActiveOrInactive	Specify Active to retrieve information about process starters with the ACTIVE or READY status. Specify Inactive to retrieve information about process starters with the INACTIVE status.

Output:

The following table describes the output of this microagent method:

Column Name	Description
ProcessDef	Name of the process definition.
Name	Name of the process starter.
Status	Status of the process starter. The status can be INACTIVE, ACTIVE, or READY.
Created	Number of process instances created by this process starter.
CreationRate	Number of process instances per hour created by this process starter.
Running	Number of process instances currently executing.
Completed	Number of process instances that have completed.
StartTime	Time (in milliseconds) at which the process starter was started.
Duration	Elapsed clock time since the process starter was started.
CheckpointedStart	True if the process was restarted from a checkpoint.
Tracing	True if tracing is enabled for this process starter, false if tracing is disabled.

GetRecoverableProcesses

Description:

Retrieves the process instances that can be recovered. See Managing Recoverable Process Instances for more information about recoverable process instances. Use the returned process instance ID in the RestartRecoverableProcess or RemoveRecoverableProcess commands.

Method Arguments:

None.

Output:

The following table describes the output of this microagent method:

Column Name	Description
Id	ID for the process instance.
Status	Status of the process instance. Can be one of the following: • faulted — this status occurs when the process instance is terminated due to an unhandled exception. • interrupted — this status occurs when the process instance is terminated due to engine failure (and the instance did not automatically restart when the engine restarted) or a manual termination.
TrackingId	Tracking ID for the process instance.
CustomId	Custom ID for the process instance.
ProcessName	Process definition for this process instance.
RestartActivity	Name of the last executed Checkpoint activity in the process instance. This is the point at which the process instance will begin executing when it is restarted.

getRvCmConfig

Description:

Get information about all the TIBCO Rendezvous certified message transports.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
certifiedName	Name used for certified delivery.
service	Service parameter for the Rendezvous daemon.
daemon	Daemon parameter for the Rendezvous daemon.
network	Network parameter for the Rendezvous daemon.
ledgerFile	Name of the ledger file for the Rendezvous daemon.
cmTimeout	Timeout value for certified delivery.

GetStaticActivityInfo

Description:

Retrieves design time activity information for all activities in a given process definition.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessDefinition	Name of the process definition.

Output:

The following table describes the output of this microagent method:

Column Name	Description
Name	Name of the activity as specified in TIBCO Designer.
Type	A Java class name, for the type of the activity. For example, com.tibco.pe.core.CallProcessActivity.

GetStatsCollectorDestination

Description:

Retrieves the file name of the file where activity statistics are currently being collected. See Storing Process Instance and Activity Statistics for more information about collecting activity statistics.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
fileName	Name of the file where activity statistics are currently collected. This value is blank if statistics are not currently being collected.

GetStatus

Description:

Retrieves basic status information about the engine.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
InstanceID	Name of this instance of the process engine.
AdapterName	Name of the application.
Uptime	Number of milliseconds since this process engine was started.
NewErrors	Total number of errors encountered since the last time this method was called.
TotalErrors	Total number of errors encountered since the process engine was started.
ProcessID	Operating system process ID of the process engine.
Host	Name of the host machine on which the process engine is running.

GetTransactionStatistics

Description:

Retrieves statistics for XA transactions initiated using the TIBCO XA Transaction Manager or Arjuna Transaction Manager. Statistics are totals collected for the lifetime of the process engine. See TIBCO ActiveMatrix BusinessWorks Process Design Guidefor more information about XA transactions.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
Total Transactions	Total number of transactions since the process engine started.
Total Committed	Total number of committed transactions since the process engine started.
Rolledback	Total number of rolled back transactions since the process engine started.
Timeout Rollback	Total number of transactions rolled back because of a timeout since the process engine started. Timeout rollback occurs when the transaction or resource times out. Java transaction APIs do not provide explicit information about timeouts. Therefore the timeout rollback also covers scenarios that represent other illegal transaction states.
Resource Rollback	Total number of transactions rolled back due to resource issues since the process engine started.
Application Rollback	Total number of transactions rolled back due to application issues since the process engine started.
Heuristics	Total number of transactions with a heuristic outcome.

IsActivityTracingEnabled

Description:

Reports whether tracing is enabled or disabled for the specified activity. If tracing is enabled for all activities by way of a wildcard (*), this method returns false because tracing is not enabled for the activity specifically.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessDefinition	Name of the process definition for which you wish to determine tracing status.
Activity	Name of the activity for which you wish to determine tracing status.

Output:

The following table describes the arguments of this microagent method:

Column Name	Description
Enabled	true if tracing is enabled for the specified activity, false if tracing is disabled.

IsAllTracingEnabled

Description:

Reports whether tracing is enabled or disabled for all activities and process starters. True is returned when tracing is enabled using a wildcard (*). If tracing is enabled for all activities and/or process starters by specifying a tracing parameter individually for each one, this method will return false.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
ActivityTracingEnabled	true when tracing is enabled for all activities. false when tracing is disabled for all activities.
ProcessStarterTracingEnabled	true when tracing is enabled for all process starters. false when tracing is disabled for all process starters.

IsProcessStarterTracingEnabled

Description:

Reports whether tracing is enabled or disabled for the specified process starter. If tracing is enabled for all process starters by way of a wildcard (*), this method returns false because tracing is not enabled for the process starter specifically.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessStarter	Name of the process starter for which you wish to determine tracing status.

Output:

The following table describes the arguments of this microagent method:

Column Name	Description
Enabled	true if tracing is enabled for the specified process starter, false if tracing is disabled.

IsRoleEnabled

Description:

Reports whether tracing is enabled or disabled for the specified role. If tracing is enabled for all roles by way of a wildcard (*), this method returns false because tracing is not enabled for the role specifically.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
Role	Name of the role for which you wish to determine tracing status.

Output:

The following table describes the arguments of this microagent method:

Column Name	Description
Enabled	true if tracing is enabled for the specified role, false if tracing is disabled.

KillAllProcesses

Description:

Kills all process instances. All process instances are stopped immediately and are permanently removed from the engine.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessDefinition	The name of the process definition. Only process instances for the specified process definition are killed. If unspecified, this action applies to all process definition.

Output:

None

KillProcess

Description:

Kills the specified process instance. The process instance is stopped immediately and permanently removed from the engine.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessNameOrId	The name or process ID of the process instance you wish to kill. You can retrieve the process ID for a process instance by using the GetProcesses method.

Output:

None

ListAllRoles

Description:

Returns a list of all roles, along with the current state (enabled or disabled) of each role.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
Role	Name of the role.
Enabled	True if the role is enabled, false if the role is disabled.

ListDbConnections

Description:

Returns a list of all open and idle JDBC connections that have been opened by a single instance of ActiveMatrix BusinessWorks engine.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
Connection-State	State of the JDBC Connection. The connection state can be Active or Idle.
Connection-Name	Name of the JDBC Connection.
User-Name	Username used by the JDBC Connection resource to to connect the database.
Connection-Owner	Owner of the JDBC Connection. For active connections, this field displays the activity name and the job-id for which the connection has been acquired. For idle connections, this field is empty.
Idle-Time	Time in milliseconds for which the JDBC Connection has been idle. For active connections, the value is 0.

The statistics for idle connections are available for the time set by the engine property Engine.DBConnection.idleTimeout. By default, this property is set to 5 minutes.

ListInflightTransactions

Description:

Retrieves information about the currently in-flight XA transactions being processed by the TIBCO XA Transaction Manager or Arjuna Transaction Manager. In-flight transactions are all transactions that have not completed or rolled back. See TIBCO ActiveMatrix BusinessWorks Process Design Guidefor more information about XA transactions.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
Format ID	Format identifier part of the XID. Please refer to http://java.sun.com/products/jta/javadocs-1.0.1/index.html for more information about XID.
Global Transaction ID	Global transaction identifier part of XID.
Branch Qualifier	Transaction branch identifier part of XID.
Status	Current status of the transaction. For example, active, preparing, prepared, committing, committed, rolling back, rolled back.
Transaction Duration	Amount of time (in milliseconds) since this transaction has initiated.
Enlisted Resource	XA Resources enlisted in the transaction.

ListInstrumentProperties

Description:

Retrieves the current settings for all Instrumentation properties.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
Property	Lists the Instrumentation properties that are currently set in the form:   <ProcessDefinitionName>=<CurrentValue>

ListTraceProperties

Description:

Returns the names and current values for all engine trace properties.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
Property	Lists the tracing properties and their values in the form:   <TracingPropertyName>=<CurrentValue>

ListUserDefinedRoles

Description:

Returns a list of user-defined roles, along with the current state (enabled or disabled) of each role.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
Role	Name of the role.
Enabled	True if the role is enabled, false if the role is disabled.

OnProcessActivity

Description:

This method is called when a process executes an activity, and it is only called when instrumentation is on.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
ProcessId	ID of the process instance.
ProcessDef	Process definition name.
ActivityName	Name of the activity.
TrackID	ID of the execution track in which the activity was executed.

OnProcessAdded

Description:

This method is called whenever a process instance is added, and it is only called if instrumentation is on.

Method Arguments:

None

Output:

The following table describes the arguments of this microagent method:

Column Name	Description
ProcessId	Process ID of the process instance that was added.

OnProcessRemoved

Description:

This method is called whenever a process instance is removed, and it is only called if instrumentation is on.

Method Arguments:

None

Output:

The following table describes the arguments of this microagent method:

Column Name	Description
ProcessId	Process ID of the process instance that was added.

OnProcessStatusChanged

Description:

This method is called when a process is suspended or resumed, and it is only called when instrumentation on.

Method Arguments:

None

Output:

The following table describes the output of this microagent method:

Column Name	Description
ProcessId	ID of the process instance.
When	Date and time when the status of the process instance changed.
Active	Status of the process instance. True when the process instance is active, false when it is inactive.
TrackingID	Tracking ID for the process instance.
ProcessDef	Process definition name.

PreRegisterListener

Description:

Pre-register a listener for certified delivery.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
Publisher CM Name	Publisher certified name.
Subject	Subject used for certified delivery.
Listener CM Name	Listener certified name.

Output:

None

RemoveRecoverableProcess

Description:

Removes the specified recoverable process instance from the list of potential recoverable processes. After executing this method, the checkpoint data of the specified process instance is removed and the process instance will no longer be able to be recovered. Obtain the process ID of the recoverable process with the GetRecoverableProcesses method.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessId	Process ID of the process instance you wish to remove from the recoverable process instance list.

Output:

None

ResetActivityStats

Description:

Resets the min and max time calculations for each activity in the specified process definition. This method is for internal use only and should not be invoked.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessDefinition	Name of the process definition.

Output:

None

ResetProcessDefinitionStats

Description:

Resets the minimum, maximum, and average time statistics gathered for process instances. See GetProcessDefinitions for more information about process instance statistics.

Method Arguments:

The following table describes the argument of this microagent method:

Argument Name	Description
ProcessDefinition	Name of the process definition whose statistics you wish to reset.

Output:

None.

RestartRecoverableProcess

Description:

Restarts the specified recoverable process. Obtain the process ID of the recoverable process with the GetRecoverableProcesses method.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessId	Process ID of the process to restart. The process will be restarted from its last saved checkpoint.

Output:

None

ResumeAll

Description:

Resumes all process starters and/or processes.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
Action	Specifies what to resume. Can be one of the following: • AllProcessStarters — resumes all process starters. • AllProcesses — resumes all processes. • AllProcessStartersAndProcesses — resumes all processes and process starters.
ProcessDefinition	The name of the process definition.

Output:

None

ResumeProcess

Description:

Resumes the specified process instance.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessNameOrId	The name or process ID of the process instance you wish to resume. You can retrieve the process ID for a process instance by using the GetProcesses method.

Output:

The following table describes the output of this microagent method:

Column Name	Description
Status	Status of the process instance after executing this operation.

ResumeProcessStarter

Description:

Resumes the specified process starter.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessDefinition	Name of the process definition whose process starter you wish to resume.

Output:

The following table describes the output of this microagent method:

Column Name	Description
Status	Status of the process starter after executing this operation.

reviewLedger

Description:

Returns information retrieved from the certified message ledger for the given CM name and subject. If no values are supplied for the method arguments, all ledgers are returned.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
CM Name	Certified name.
Subject	Subject used for certified delivery.

Output:

The following table describes the output of this microagent method:

Column Name	Description
CM Name	Name used for certified delivery.
Subject	Subject used for certified delivery.
Last Sent Message	Sequence number of the most recent message sent with this subject name.
Total Messages	The total number of messages with this subject name for the given CM name.
Total Size	The total storage in bytes occupied by all messages with this subject name.
Listener CM Name	Name of the delivery-tracking listener for this subject.
Last Confirmed	Sequence number of the last message confirmed by the listener.
Unacknowledged Messages	Number of messages pending for this listener.

SetInstrumentProperty

Description:

Sets the Instrumentation property for the specified process definition to a given value. The OnProcessActivity and OnProcessStateChanged methods will be called for the specified processes definition names.

For example, use property name "*" and value "true" to enable those asynchronous methods for all process definitions. The property name does not need to begin with "Instrumentation.", but if it does, the leading "Instrumentation." will be ignored.

See Enabling TIBCO Hawk for more information about the Instrumentation property.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
Name	Name of the process definition for which you wish to alter the Instrumentation property. Specify * for this argument if you wish to enable or disable instrumentation for all process definitions.
Value	true if you wish to enable instrumentation for the given process definition. false if you wish to disable instrumentation for the given process definition.

Output:

None

SetTraceProperty

Description:

Sets the specified engine tracing property to the specified value. While you can set properties with this method, ConfigureActivityTracing, ConfigureProcessStarterTracing, and ConfigureUserDefinedTracing are simpler to use for setting trace properties.

See Trace Properties for more information about tracing properties.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
Name	Name of the tracing property you wish to set.
Value	true if you wish to enable the property. false if you wish to disable the property.

Output:

None

StartStatsCollection

Description:

Enables collection of statistics for each executed activity. See Storing Process Instance and Activity Statistics for more information about collecting activity statistics.

Method Arguments:

None

Output:

None

stopApplicationInstance

Description:

Shuts down the process engine immediately. All checkpoint files are preserved and the engine's operating system process exits.

Method Arguments:

None

Output:

None

StopStatsCollection

Description:

Disables collection of statistics for each executed activity. See Storing Process Instance and Activity Statistics for more information about collecting activity statistics.

Method Arguments:

None

Output:

None

SuspendAll

Description:

Suspends all process starters and/or processes.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
Action	Specifies what to suspend. Can be one of the following: • AllProcessStarters — suspends all process starters. • AllProcesses — suspends all processes. • AllProcessStartersAndProcesses — suspends all processes and process starters.
ProcessDefinition	The name of the process definition.

Output:

None

SuspendProcess

Description:

Suspends the specified process instance.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessNameOrId	The name or process ID of the process instance you wish to suspend. You can retrieve the process ID for a process instance by using the GetProcesses method.

Output:

The following table describes the output of this microagent method:

Column Name	Description
Status	Status of the process instance after executing this operation.

SuspendProcessStarter

Description:

Suspends the specified process starter.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
ProcessDefinition	Name of the process definition whose process starter you wish to suspend.

Output:

The following table describes the output of this microagent method:

Column Name	Description
Status	Status of the process starter after executing this operation.

unRegisterListener

Description:

Unregister a certified delivery listener.

Method Arguments:

The following table describes the arguments of this microagent method:

Argument Name	Description
Publisher CM Name	Publisher certified name.
Subject	Subject for certified delivery.
Listener CM Name	Listener certified name.

Output:

None

_onUnsolicitedMsg

Description:

Subscribing to this method returns any unsolicited notifications that are sent from the managed application corresponding to this microagent. Invoking this method returns the last such message that was received (if any).

Method Arguments:

None

Copyright © Cloud Software Group, Inc. All Rights Reserved