ICIAdvancedWorkflowParams Interface

The ICIAdvancedWorkflowParams interface allows you to create/modify/retrieve Advanced Workflow configuration.

Example (VBScript):

‘Edit workflow

idxAW = site.GetAdvancedWorkflowIndex(“My Workflow”)

if idxAW <> -1 Then

Set AWparams = site.GetAdvancedWorkflowParams(idxAW)

‘Change AWparams properties

‘...

‘and apply changes

site.SetAdvancedWorkflowParams idxAW, AWparams

End If

 

The CIAdvancedWorkflowParams co-class supports the creation of Advanced Workflows, and implements the ICIAdvancedWorkflowParams interface.

Example (VBScript):

set AWParams = CreateObject("SFTPCOMInterface.CIAdvancedWorkflowParams")

‘...setup workflow parameters

site.AddAdvancedWorkflow(AWParams)

Properties

Retrieves or specifies the source code of Advanced Workflow.

HRESULT Code([out, retval] BSTR *pVal);

HRESULT Code([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox AWparams.Code

Specifying:

‘ Let some_code_from_file be a content of a file

‘ produced by AW Task Builder

AWparams.Code = some_code_from_file

EFT v6.5 and later

(Read-only)

Retrieves the time when the Advanced Workflow was created.

HRESULT DateCreated([out, retval] DATE *pVal);

Example (VBScript):

MsgBox “Task was created: ” & CStr(AWparams.DateCreated)

EFT v6.5 and later

Retrieves or specifies the description of Advanced Workflow.

HRESULT Description([out, retval] BSTR *pVal);

HRESULT Description([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox AWparams.Description

Specifying:

‘Mark as updated

AWparams.Description = AWparams.Name & “ (updated)”

EFT v6.5 and later

HRESULT GetACL([out, retval] IDispatch** ppVal);

See also SetACL.

EFT v7.2

(See AWLogMode enum.)

Retrieves or specifies the debug logging mode of the Advanced Workflow

HRESULT LogMode([out, retval] AWLogMode *pVal);

HRESULT LogMode([in] AWLogMode newVal);

Example (VBScript):

Retrieving:

If AWparams.LogMode = 0 Then

‘ no logging...

End If

Specifying:

‘ Turn on most detailed logging

AWparams.LogMode = 3

EFT v6.5 and later

Retrieves or specifies the name of Advanced Workflow.

HRESULT Name([out, retval] BSTR *pVal);

HRESULT Name([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox AWparams.Name

Specifying:

‘Mark as updated

AWparams.Name = AWparams.Name & “ (updated)”

EFT v6.5 and later

HRESULT SetACL([in] IDispatch* pVal);

See also GetACL.

EFT v7.2

Retrieves or specifies the maxim duration (in seconds) of the Advanced Workflow execution after which it is forcibly terminated by EFT. (Value of 0 means "no timeout".)

HRESULT TimeoutSeconds([out, retval] long *pVal);

HRESULT TimeoutSeconds([in] long newVal);

Example (VBScript):

Retrieving:

If AWparams.TimeoutSeconds = 0 Then

‘ no timeout...

End If

Specifying:

‘ Set max duration of workflow execution to 2 minutes

AWparams.TimeoutSeconds = 120

EFT v6.5 and later

Dialog Box Equivalents