agentTaskDefinition

References

Used by the following properties:

• bibus » agentTaskState » definition

Container Information

Contained by instances of the following classes

• bibus » authoredAgentDefinition

Related information:

• Running Agents

Properties

This class has the following properties.

eventKey

Specifies additional query items in the report contained by the containing agent that can be checked when a change event occurs.

This property

• is an array of type string

  is encoded as type tns:stringArrayProp

eventTypes

Specifies the event types that are of interest to this task.

This property

• is an array of type bibus » eventTypeEnum

  is encoded as type tns:eventTypeEnumArrayProp

filterDataItemName

Specifies the name of a data item that must be defined in the agent's condition report (the bibus » report object contained by the bibus » agentDefinition object). Event conditions that evaluate to true for the named data item are processed by this agent task.

If the bibus » agentTaskDefinition » filterDataItemName property is not specified or references a data item from the agent's condition report that does not produce boolean values, all events are passed to the agent task.

This property

• is of type bibus » metadataModelItemName

  is encoded as type tns:metadataModelItemNameProp

New in Version 8.3 — Agent Task Event Filters

This property was added.

options

Contains the set of options for this object.

Options can also be specified in other locations. For more information, see Specifying Options and Parameters.

This property

• is an array of type bibus » option

  is encoded as type tns:optionArrayProp

packageBase

Specifies the path to the ancestor package. The format of this property is the same as the format of the bibus » baseClass » searchPath property.

If the object is not a descendant of a package, the value of this property is the path to the root object.

This property

• is of type string

  is encoded as type tns:stringProp

• is read-only

• must contain no more than 4096 characters

• can be acquired from a containing object

New in Version 8.3 — Package Hierarchies

This property is deprecated. Use the bibus » baseClass » ancestors property instead.

parameterAssignments

Contains the parameter assignments for the object.

This property

• is an array of type bibus » baseParameterAssignment

  is encoded as type tns:baseParameterAssignmentArrayProp

parameters

Contains the set of execution parameter values for this object.

Parameter values can also be specified in other locations. For more information, see Specifying Options and Parameters.

This property

• is an array of type bibus » parameterValue

  is encoded as type tns:parameterValueArrayProp

runCondition

Specifies when the agent task should be run based on the bibus » runStatusEnum of other tasks.

This property

• is of type bibus » runConditionEnum

  is encoded as type tns:runConditionEnumProp

New in Version 8.3 — Run Agent Tasks on Failure

This property was added.

taskObject

Refers to the object that runs as this agent task.

This property

• is an array of type bibus » baseClass

  has items that must be of class bibus » baseAgentDefinition, bibus » baseDataIntegrationTask, bibus » baseDataMovementTask, bibus » basePowerPlay8Report, bibus » baseReport, bibus » baseRSSTask, bibus » contentTask, bibus » exportDeployment, bibus » humanTask, bibus » importDeployment, bibus » indexUpdateTask, bibus » jobDefinition, bibus » memo, bibus » migrationTask, bibus » planningMacroTask, bibus » planningTask, bibus » queryServiceTask, bibus » storedProcedureTask, or bibus » webServiceTask

  is encoded as type tns:baseClassArrayProp

• refers to other objects in the content store using an id-based search path

• must have exactly 1 item

New in Version 10.1.0 — Variable Support for Data Movement Tasks

This property was extended to allow instances of the bibus » dataMovementTaskAlias class to be referenced by instances of this property.

New in Version 8.4 — Migration Service

This property was extended to allow instances of the bibus » migrationTask class to be referenced by instances of this property.

New in Version 8.4 — PowerPlay 8 Integration

This property was extended to allow instances of the bibus » basePowerPlay8Report class to be referenced by instances of this property.

New in Version 10.1.0 — Query Service Administration Task

This property was extended to allow instances of the bibus » queryServiceTask class to be referenced by instances of this property.

New in Version 10.1.0 — Human Task

This property was extended to allow instances of the bibus » humanTask class to be referenced by instances of this property.