Class SqlEffect

Namespace

DCR.Workflow.Effect

Assembly

DCR.Workflow.dll

public class SqlEffect : EffectBase, IEffect

Inheritance

object

EffectBase

SqlEffect

Implements

IEffect

Inherited Members

EffectBase.LocalParameters

EffectBase.SetSecrets(Dictionary<string, string>)

EffectBase.GetIntParameter(Dictionary<string, string>, string)

EffectBase.ActivityDidExecute(Model, Activity, Dictionary<string, string>)

EffectBase.ShouldRunActivityDidExecute

EffectBase.AtMostOnce

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

MiscExtensions.ToLog<T>(T?)

Constructors

SqlEffect(ILogger<SqlEffect>, SqlEffectOptions)

public SqlEffect(ILogger<SqlEffect> logger, SqlEffectOptions options)

Parameters

logger ILogger<SqlEffect>

options SqlEffectOptions

Properties

Description

public override string Description { get; }

Property Value

string

Id

Id of the effect

public override string Id { get; }

Property Value

string

Remarks

This is the id used to identify the effect. Modellers use this id to indicate that an activity should have the effect

RequiredParameters

Parameters required to be set

public override string[] RequiredParameters { get; }

Property Value

string[]

Remarks

The context parameter to Runtime.Execute must define at least the keys listed here.

ShouldRunActivityWillExecute

public override bool ShouldRunActivityWillExecute { get; }

Property Value

bool

Methods

ActivityWillExecute(Model, Activity, Dictionary<string, string>)

Callback to run effect before activity execution

public override Task<Result> ActivityWillExecute(Model m, Activity a, Dictionary<string, string> arguments)

Parameters

m Model

a Activity

arguments Dictionary<string, string>

Returns

Task<Result>

A pair of a Result structure and an optional state object to be passed in to a subsequent call to ActivityDidExecute.

Remarks

Execute the effect, possibly returning an updated value. The effect executes before the underlying activity is executed, and if the effect fails (throws), execution of the activity is aborted.