ICIAWTaskActionParams Interface

Use ICIAWTaskActionParams::TaskName to create, modify, retrieve, and execute Automated Workflow Engine (AWE) Event Rule Actions.

interface ICIAWTaskActionParams : IDispatch

Examples (VBScript):

If ActionStatement.Action.Type = AWTaskAction Then

Set AWTaskParams = ActionStatement.Action.Params

‘ Modify AW Task parameters and assign them back to the action

‘ . . .

ActionStatement.Action.Params = AWTaskParams

End If

The CIAWTaskActionParams co-class supports creation of the AWE Task Event Action. The co-class implements ICIAWTaskActionParams interface.

Set AWTaskParams = CreateObject("SFTPCOMInterface.CIAWTaskActionParams")

‘ Setup AW task parameters

‘ . . .

Rule.AddActionStatement(0, AWTaskParams)

Retrieving:

MsgBox AWTaskParams.TaskName & " task will be executed"

Specifying:

AWTaskParams.TaskName = "Sample - SNMP Get"

ICON_Info.gif "Function" and "Sub" indicate that the member is a method; "Property" indicates that it is a property.

Members

Adds new variable

HRESULT AddVariable(

[in] BSTR bstrVarName,

[in] BSTR bstrVarValue);

Example (VBScript):

oAWT.AddVariable "Variable_0", "Value_0"

EFT v6.3 and later

Retrieves a variable name by index.

HRESULT GetVariableName(

[in] LONG nIndex,

[out,retval] BSTR* pVal);

Example (VBScript):

MsgBox "Variable name at 0 index is: " & CStr(oAWT.GetVariableName(0))

EFT v6.3 and later

Retrieves a variable value by index.

HRESULT GetVariableValue(

[in] LONG nIndex,

[out,retval] BSTR* pVal);

Example (VBScript):

MsgBox "Variable value at 0 index is: " & CStr(oAWT.GetVariableValue(0))

EFT v6.3 and later

Remove variable by index.

HRESULT RemoveVariable(

[in] LONG nIndex);

Example (VBScript):

oAWT.RemoveVariable 0

EFT v6.3 and later

Set new variable name and value by index

HRESULT SetVariable(

[in] LONG nIndex,

[in] BSTR bstrVarName,

[in] BSTR bstrVarValue);

Example (VBScript):

oAWT.AddVariable 1, "NewName", "NewValue"

EFT v6.3 and later

Retrieve or specify the name of an AWE task (workflow) to execute.

HRESULT TaskName(

[out, retval] BSTR* pVal);

HRESULT TaskName(

[in] BSTR newVal);

EFT v6.1 and later

Retrieves the number of variables.

HRESULT VariablesCount(

[out, retval] LONG* pVal);

Example (VBScript):

Retrieving:

MsgBox "Variable count is: " & oAWT.VariablesCount

EFT v6.3 and later