tridion-sites-extensions-api-docs

Home > @tridion-sites/models > TridionActivityDefinition

TridionActivityDefinition class

Represents the data of a Tridion proprietary Activity Definition.

Signature:

export declare class TridionActivityDefinition extends ActivityDefinition

Extends: ActivityDefinition

Constructors

Constructor Modifiers Description
(constructor)({ backendModel, activityType, finishApprovalStatus, nextActivityDefinitions, …activityDefinitionArgs })   Constructs a new instance of the TridionActivityDefinition class

Properties

Property Modifiers Type Description
_backendModel   BackendTridionActivityDefinition  
activityType   ActivityType | undefined A value indicating whether this instance represents a decision or not.
allowOverrideDueDate   boolean A value indicating whether “Activity.DueDate” can be changed manually, or not. true if “Activity.DueDate” can be changed manually otherwise, false.
expirationScript   string | undefined A string that contains CSharp code. When “PerformingTimeout” is set, Workflow agent executes this script to expire the Activity.
expirationScriptType   string | undefined The value must be the name of one of the configured Workflow script types.
finishApprovalStatus   Link | undefined Approval Status that is assigned to the Workflow Item when the Activity finishes.
getInternalModel   () => BackendTridionActivityDefinition  
nextActivityDefinitions   ReadonlyArray<Link> | undefined <p>Potential next activities in the Workflow. Will be undefined if the Activity Definition is read stand-alone. In the context of a Process Definition it will be set.</p><p>The collection should be empty if this represents the last activity or it should contain exactly one activity, unless this represents a decision. Note that the next activity should be identified (linked) by title, not by Id.</p>
performingTimeout   number | undefined The timeout for performing current activity, in minutes. If value for this property set, default value for “Activity.DueDate” will be set, during creating instance of this activity definition.
script   string | undefined <p>Script of an automated Activity. A string that contains CSharp code.</p><p>An Activity Definition can represent an automated activity to which a script is associated. This script is then executed by the TCM Workflow Agent once the workflow process reaches the activity.</p><p>When you create a Process Definition, you can define an automatic Activity Definition simply by setting the Script property. You don’t need to explicitly specify the “ActivityDefinition.Assignee”, it will be automatically set to the TCM Workflow Agent during the creation of the Process Definition.</p><p>The TCM Workflow Agent user is declared in the TCM configuration in the workflow section as the following example illustrates:</p>
scriptType   string | undefined The value must be the name of one of the configured Workflow script types.