flux

Interface AuditTrailTrigger

All Superinterfaces:

Action, java.lang.Cloneable, RuntimeDataMap, java.io.Serializable, Trigger

public interface AuditTrailTrigger
extends Trigger

Fires when an audit trail event that matches certain criteria is reported to the audit trail. Useful when one flow chart needs to wait for other flow charts to reach milestones or for other flow charts to finish.

The properties on this trigger act as search criteria on the audit trail. The wildcard character "*" can be used in any property.

This trigger waits for an audit trail event that matches its properties before firing. When it fires, this trigger returns the details about the specific audit trail event that caused it to fire.

Each time this trigger fires, it returns an audit trail event that is no older than its previous firing's audit trail event.

The Audit Trail Trigger returns its result in the flow context variable "RESULT". The following table contains more information on accessing and using the result.

Flow Context Variable	Field	Java Type	Description
RESULT	username	java.lang.String	The name of the user that generated the event. For audit trail events that are not generated by user actions, this will be empty.
RESULT	timestamp	java.util.Date	The Date that the audit trail event was recorded.
RESULT	actionName	java.lang.String	The name of the trigger or action that generated this audit trail event. For audit trail events that are not associated with an action, this will be empty.
RESULT	engineName	java.lang.String	The name of the engine that reported this audit trail event.
RESULT	eventMessage	java.lang.String	This audit trail event's message.
RESULT	eventName	java.lang.String	This audit trail event's name.
RESULT	namespace	java.lang.String	The fully-qualified name of the workflow that generated this audit trail event. For audit trail events that are not associated with a workflow, this will be empty.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

See Also:

FlowContext.sendToAuditTrail(java.lang.String, java.lang.String), Engine.sendToAuditTrail(java.lang.String, java.lang.String)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuditTrailTrigger.AuditTrailTriggerResult Provides the details of the audit trail event that caused this audit trail trigger to fire.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionName() Returns the action name filter.
java.lang.String	getEngineName() Returns the engine name filter.
java.lang.String	getEventMessage() Returns the event message filter.
java.lang.String	getEventName() Returns the event name filter.
java.lang.String	getNamespace() Returns the namespace filter.
java.lang.String	getUsername() Returns the username filter.
void	setActionName(java.lang.String actionName) Sets the action name filter.
void	setEngineName(java.lang.String engineName) Sets the engine name filter.
void	setEventMessage(java.lang.String eventMessage) Sets the event message filter.
void	setEventName(java.lang.String eventName) Sets the event name filter.
void	setNamespace(java.lang.String namespace) Sets the namespace filter.
void	setUsername(java.lang.String username) Sets the username filter.

Methods inherited from interface flux.Action

addFlow, addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutBusinessIntervalNamespace, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutBusinessIntervalNamespace, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Method Detail

getActionName

java.lang.String getActionName()

Returns the action name filter.

Returns:

The action name filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.actionName

getEngineName

java.lang.String getEngineName()

Returns the engine name filter.

Returns:

The engine name filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.engineName

getEventMessage

java.lang.String getEventMessage()

Returns the event message filter.

Returns:

The event message filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.eventMessage

getEventName

java.lang.String getEventName()

Returns the event name filter.

Returns:

The event name filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.eventName

getNamespace

java.lang.String getNamespace()

Returns the namespace filter.

Returns:

The namespace filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.namespace

getUsername

java.lang.String getUsername()

Returns the username filter.

Returns:

The username filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.username

setActionName

void setActionName(java.lang.String actionName)

Sets the action name filter.

Parameters:

actionName - The action name filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.actionName

setEngineName

void setEngineName(java.lang.String engineName)

Sets the engine name filter.

Parameters:

engineName - The engine name filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.engineName

setEventMessage

void setEventMessage(java.lang.String eventMessage)

Sets the event message filter.

Parameters:

eventMessage - The event message filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.eventMessage

setEventName

void setEventName(java.lang.String eventName)

Sets the event name filter.

Parameters:

eventName - The event name filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.eventName

setNamespace

void setNamespace(java.lang.String namespace)

Sets the namespace filter.

Parameters:

namespace - The namespace filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.namespace

setUsername

void setUsername(java.lang.String username)

Sets the username filter.

Parameters:

username - The username filter.

See Also:

AuditTrailTrigger.AuditTrailTriggerResult.username