interface ICIAS2SendActionParams : IDispatch

Example (VBScript):

If ActionStatement.Action.Type = AS2SendAction Then
Set AS2SendParams = ActionStatement.Action.Params
‘ Modify AS2 Send File parameters and assign them back to the action
ActionStatement.Action.Params = AS2SendParams
End If

The CIAS2SendActionParams co-class supports creation of the Send AS2 File Event Action. The co-class implements the ICIAS2SendActionParams interface.

Example (VBScript):

Set AS2Params = CreateObject("SFTPCOMInterface.CIAS2SendActionParams")
‘ Setup Send AS2 File parameters
‘ . . .
Rule.AddActionStatement(0, AS2Params)

Members

• Property AS2ID As String

Specifies or retrieves the AS2 ID of the file sender.

HRESULT AS2ID([out, retval] BSTR* pVal);
HRESULT AS2ID([in] BSTR newVal);

Examples:

Retrieving:

MsgBox "Send message as " & AS2SendParams.AS2ID & " AS2 identifier"

Specifying:

AS2SendParams.AS2ID = "EFT : User1"

EFT v6.1 and later

• Property AsyncReceiptTimeoutMin As Long

This property is applicable only if asynchronous receipt is requested (i.e., ReceiptPolicy property is not set to NoReceipt and ReceiptDelivery property is set to Async).

Specifies or retrieves the maximum wait time (in minutes) for asynchronous AS2 receipt.

HRESULT AsyncReceiptTimeoutMin([out, retval] long* pVal);
HRESULT AsyncReceiptTimeoutMin([in] long newVal);

Example (VBScript):

Retrieving:

If AS2SendParams.AsyncReceiptTimeoutMin < 60 Then
MsgBox ‘Asynchronous receipt waiting period is too short’
End If

Specifying:

AS2SendParams.AsyncReceiptTimeoutMin = 7200 ‘5 days

EFT v6.1 and later

• Property ClientProfile As String

Specifies or retrieves the username of AS2 partner whose AS2 Outbound Profile will be used for this AS2 Send operation.

HRESULT ClientProfile([out, retval] BSTR* pVal);
HRESULT ClientProfile([in] BSTR newVal);

Example (VBScript):

Retrieving:

If AS2SendParams.UseClientProfile Then
MsgBox AS2SendParams.ClientProfile & "’s AS2 profile will be used"
End If

Specifying:

AS2SendParams.UseClientProfile = True
AS2SendParams.ClientProfile = "Some_User"

EFT v6.1 and later

• Property Compress As Boolean

Specifies or retrieves whether an AS2 file will be compressed before sending.

HRESULT Compress([out, retval] VARIANT_BOOL* pVal);
HRESULT Compress([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

If Not AS2SendParams.Compress Then
MsgBox "Sending large files without compression is time-consuming!"
End If

Specifying:

AS2SendParams.Compress = True

EFT v6.1 and later

• Property ContentType As AS2ContentType

Specifies or retrieves content type of AS2 message to send.

HRESULT ContentType([out, retval] AS2ContentType* pVal);
HRESULT ContentType([in] AS2ContentType newVal);

Example (VBScript):

Retrieving:

If AS2SendParams.ContentType = Binary Then
MsgBox "File type: Binary"
End If

Specifying:

AS2SendParams.ContentType = Plaintext

EFT v6.1 and later

• Property CustomHeaders As String

Used to specify a custom header for outbound AS2 transfers.

EFT v7.4.9

• Property DeleteSourceFile As Boolean

Specifies or retrieves whether source file will be removed after successful delivery to AS2 partner.

HRESULT DeleteSourceFile([out, retval] VARIANT_BOOL* pVal);
HRESULT DeleteSourceFile([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

If AS2SendParams.DeleteSourceFile Then
MsgBox "Warning! Source file will be removed after delivery!"
End If

Specifying:

AS2SendParams.DeleteSourceFile = True

EFT v6.1 and later

• Property Encrypt As Boolean

Specifies or retrieves whether an AS2 message will be encrypted with the AS2 partner certificate.

HRESULT Encrypt([out, retval] VARIANT_BOOL* pVal);
HRESULT Encrypt([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

If Not AS2SendParams.Encrypt Then
MsgBox "Sending data without encryption is not secure!"
End If

Specifying:

AS2SendParams.Encrypt = True

EFT v6.1 and later

• Property EncryptionAlgorithm As String  

Retrieves or specifies encryption algorithm to use for AS2 transfers. Refer to the Enumerations Reference for allowed algorithms.

EFT v7.4.9 and later

• Property Host As String

Specifies or retrieves the remote host to which you are sending an AS2 file, and the protocol prefix, http:// or https://. If no protocol prefix is specified, plain HTTP protocol will be used.

HRESULT Host([out, retval] BSTR* pVal);
HRESULT Host([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "The file will be sent to " & AS2SendParams.Host

Specifying:

AS2SendParams.Host = "https://some_as2_server.com"

EFT v6.1 and later

• Property LocalPath As String

Specifies or retrieves local path of the file to send.

HRESULT LocalPath([out, retval] BSTR* pVal);
HRESULT LocalPath([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox AS2SendParams.LocalPath & " file will be sent"

Specifying:

AS2SendParams.LocalPath = "%FS.PATH%"

EFT v6.1 and later

• Property PartnerAS2ID As String

Specifies or retrieves the AS2 ID of the AS2 partner to which you are sending an AS2 file.

HRESULT PartnerAS2ID([out, retval] BSTR* pVal);
HRESULT PartnerAS2ID([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "Send message to " & AS2SendParams.PartnerAS2ID & " partner"

Specifying:

AS2SendParams.PartnerAS2ID = "John Smith"

EFT v6.1 and later

• Property PartnerCertificatePath As String

Specifies or retrieves the path to the AS2 partner certificate for AS2 message encrypting.

HRESULT PartnerCertificatePath([out, retval] BSTR* pVal);
HRESULT PartnerCertificatePath([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "Encrypt message with " & AS2SendParams.PartnerCertificatePath

Specifying:

AS2SendParams.PartnerCertificatePath = "C:\Partner.pem"

EFT v6.1 and later

• Property Password As String

Specifies or retrieves the password used for authentication on the AS2 Server to which you are sending an AS2 file.

HRESULT Password([out, retval] BSTR* pVal);
HRESULT Password([in] BSTR newVal);

Example (VBScript):

Retrieving:

sHTTPCredentials = AS2SendParams.User & ":" & AS2SendParams.Password

Specifying:

AS2SendParams.Password = "Password1"

EFT v6.1 and later

• Property Port As Long

Specifies or retrieves the remote port.

HRESULT Port([out, retval] long* pVal);
HRESULT Port([in] long newVal);

Example (VBScript):

Retrieving:

If (AS2SendParams.Port <> 80) And (AS2SendParams.Port <> 443) Then
MsgBox "Are you sure you want to use non-standard HTTP port?"
End If

Specifying:

AS2SendParams.Port = 443

EFT v6.1 and later

• Property PortAsString As String

HRESULT PortAsString([out, retval] BSTR *pVal);
HRESULT PortAsString([in] BSTR newVal);

EFT v7.4.6 and later

• Property ProxyHostName As String

Used to specify the AS2 proxy host name.

EFT v7.4.9 and later

• Property ProxyPassword As String

Used to specify the AS2 proxy password.

EFT v7.4.9 and later

• Property ProxyPort As Long

Used to specify the AS2 proxy port.

EFT v7.4.9 and later

• Property ProxyType As AS2ProxyType

Used to specify the AS2 proxy type.

EFT v7.4.9 and later

• Property ProxyUserName As String

Used to specify the AS2 proxy user name.

EFT v7.4.9 and later

• Property ReceiptDelivery As AS2ReceiptDelivery

This property is applicable only if ReceiptPolicy property, below, is not set to NoReceipt.

Specifies or retrieves the mechanism of receipt delivery required for an AS2 message. (Refer to AS2ReceiptDelivery enumeration for available mechanisms.)

HRESULT ReceiptDelivery([out, retval] AS2ReceiptDelivery* pVal);
HRESULT ReceiptDelivery([in] AS2ReceiptDelivery newVal);

Example (VBScript):

Retrieving:

If (AS2SendParams.ReceiptPolicy <> NoReceipt) 
And (AS2SendParams.ReceiptDelivery = Async)
Then
MsgBox "Are you ready to wait for receipt for several days?"
End If

Specifying:

AS2SendParams.ReceiptDelivery = Sync

EFT v6.1 and later

• Property ReceiptPolicy As AS2ReceiptPolicy

Specifies or retrieves the type of the receipt required for AS2 message. (Refer to AS2ReceiptPolicy enumeration for available receipt types).

HRESULT ReceiptPolicy([out, retval] AS2ReceiptPolicy* pVal);
HRESULT ReceiptPolicy([in] AS2ReceiptPolicy newVal);

Example (VBScript):

Retrieving:

If AS2SendParams.ReceiptPolicy <> SignedReceipt Then
MsgBox "Request signed receipt to authenticate AS2 partner!"
End If

Specifying:

AS2SendParams.ReceiptPolicy = SignedReceipt

EFT v6.1 and later

• Property RemotePath As String

Specifies or retrieves the remote path to which you are sending an AS2 file.

HRESULT RemotePath([out, retval] BSTR* pVal);
HRESULT RemotePath([in] BSTR newVal);

Example (VBScript):

Retrieving:

sURL = AS2Params.Host & ":" & CStr(AS2Params.Port) & AS2Params.RemotePath

Specifying:

AS2SendParams.RemotePath = "/AS2.aspx"

EFT v6.1 and later

• Property RetriesCount As Long

Specifies or retrieves the maximum amount of sending retries in the case of failure (timeout, network errors, etc.); 0 means ‘no retry if failed’.

HRESULT RetriesCount([out, retval] long* pVal);
HRESULT RetriesCount([in] long newVal);

Example (VBScript):

Retrieving:

If AS2SendParams.RetriesCount = 0 Then
MsgBox "Are you sure no retry is needed for sending failures?"
End If

Specifying:

AS2SendParams.RetriesCount = 5 ‘Try another 5 times if fails to send

EFT v6.1 and later

• Property RetryDelaySec As Long

Specifies or retrieves the interval between successive sending retries (in seconds) in the case of sending failure. This property is applicable only if RetriesCount property is not set to 0.

HRESULT RetryDelaySec([out, retval] long* pVal);
HRESULT RetryDelaySec([in] long newVal);

Example (VBScript):

Retrieving:

MsgBox "Will wait for " & AS2Params.RetryDelaySec " seconds before resend"

Specifying:

AS2SendParams.RetryDelaySec = 60 ‘1 minute

EFT v6.1 and later

• Property Sign As Boolean

Specifies or retrieves whether an AS2 message will be signed with the certificate specified in the Site's AS2 settings.

HRESULT Sign([out, retval] VARIANT_BOOL* pVal);
HRESULT Sign([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

If Not AS2SendParams.Sign Then
MsgBox "Unsigned message will not allow partner to authenticate you!"
End If

Specifying:

AS2SendParams.Sign = True

EFT v6.1 and later

• Property SignatureAlgorithm As AS2SignatureAlgorithm  

HRESULT SignatureAlgorithm([out, retval] AS2SignatureAlgorithm* pVal);
HRESULT SignatureAlgorithm([in] AS2SignatureAlgorithm newVal);

EFT v7.4.11 and later

• Property Subject As String

Specifies or retrieves the AS2 message subject.

HRESULT Subject([out, retval] BSTR* pVal);
HRESULT Subject([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "Message Subject: " & AS2SendParams.Subject

Specifying:

AS2SendParams.Subject = "Requested client list attached"

EFT v6.1 and later

• Property TimeoutSec As Long

Specifies or retrieves the timeout (in seconds) while sending the file.

HRESULT TimeoutSec([out, retval] long* pVal);
HRESULT TimeoutSec([in] long newVal);

Example (VBScript):

Retrieving:

MsgBox "Send Timeout: " & CStr(AS2SendParams.TimeoutSec) & " seconds"

Specifying:

AS2SendParams.TimeoutSec = 900 ‘ 15 minutes

EFT v6.1 and later

• Property UseClientProfile As Boolean

Specifies or retrieves whether a whole AS2 Outbound Profile of certain EFT client will be used for this AS2 Send operation. Otherwise, you must explicitly specify each AS2 Send parameter. (Refer also to the ClientProfile property.)

HRESULT UseClientProfile([out, retval] VARIANT_BOOL* pVal);
HRESULT UseClientProfile([in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

If Not AS2SendParams.UseClientProfile Then
‘ Specify each AS2 Send parameter
End If

Specifying:

AS2SendParams.UseClientProfile = True

EFT v6.1 and later

• Property UseProxy As Boolean

Specify whether to use proxy settings when connecting to a remote host.

HRESULT UseProxy([out, retval] VARIANT_BOOL* pVal); 
HRESULT UseProxy([in] VARIANT_BOOL newVal);

EFT v7.4.11 and later

• Property User As String

Specifies or retrieves the username for authentication on the AS2 Server to which you are sending an AS2 file.

HRESULT User([out, retval] BSTR* pVal);
HRESULT User([in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "Will send the file using " & AS2SendParams.User & " account"

Specifying:

AS2SendParams.User = "User1"

EFT v6.1 and later

Dialog Box Equivalents