ICIAS2InboundSettings Interface

The ICIAS2InboundSettings interface is used to define the AS2 inbound (retrieve) transaction settings for a partner account. See also ICIAS2OutboundSettings Interface, ICIAS2SendActionParams  Interface, and ICIAS2TransactionInfo Interface.

interface ICIAS2InboundSettings : IDispatch

See also:

NOTE: "Sub" indicates that the member is a method; "Property" indicates that it is a property.

Members

  • Property AS2ID As String

    • Retrieves or specifies a unique AS2-To ID that EFT will accept from this partner’s inbound messages.

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

    Example (VBScript):

    Retrieving:

    MsgBox "My AS2 ID is: " & oAS2I.AS2ID

    Specifying:

    oAS2I.AS2ID = "my_as2_id"

    EFT v6.3 and later

  • Property AuthenticationType As AS2AuthenticationType

    • Retrieves or specifies whether the client is authenticating with username and password or using Message Level Security (MLS).

    HRESULT AuthenticationType([out, retval] AS2AuthenticationType* pVal);
HRESULT AuthenticationType([in] AS2AuthenticationType newVal);

    Example (VBScript):

    Retrieving:

    if AS2AuthTypeUsernameAndPassword = oAS2I.AuthenticationType then
MsgBox "Usename and password"
end if

    Specifying:

    oAS2I.AuthenticationType = AS2AuthTypeMsgLevelSecurity

    EFT v6.3 and later

  • Property DoubleContentPolicy As AS2DoubleContentPolicy

    • Retrieves or specifies overwrite, numerate, or reject AS2 transactions where the file is a duplicate of an existing file already residing in the upload directory.

    HRESULT DoubleContentPolicy([out, retval] AS2DoubleContentPolicy* pVal);
HRESULT DoubleContentPolicy([in] AS2DoubleContentPolicy newVal);

    Example (VBScript):

    Retrieving:

    if AS2DoubleContentPolicyOverwrite = oAS2I.DoubleContentPolicy then
MsgBox "Overwrite"
end if

    Specifying:

    oAS2I.DoubleContentPolicy = AS2DoubleContentPolicyReject

    EFT v6.3 and later

  • Property DoubleMsgIDPolicy As AS2DoubleMsgIDPolicy

    • Retrieves or specifies whether to accept or reject AS2 transactions with duplicate Message IDs.

    If an incoming request has the same Message ID and the same payload as a prior incoming message, EFT sends the exact same response from that prior transaction back to the client, and does not extract or process the payload (that is, discards the payload, does not save to file system, does not trigger Event Rules, etc.).

    If an incoming request has the same Message ID, but the payload is different, EFT processes or discards the message based on the configuration provided by the user.

    HRESULT DoubleMsgIDPolicy([out, retval] AS2DoubleMsgIDPolicy* pVal);
HRESULT DoubleMsgIDPolicy([in] AS2DoubleMsgIDPolicy newVal);

    Example (VBScript):

    Retrieving:

    if AS2DoubleMsgIDPolicyAccept = oAS2I.DoubleMsgIDPolicy then
MsgBox "Accept"
end if

    Specifying:

    oAS2I.DoubleMsgIDPolicy = AS2DoubleMsgIDPolicyReject

    EFT v6.3 and later

  • Property EncryptionAlgorithm As String  

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

    EFT v7.4.9 and later

  • Property EFTIDMismatchPolicy As AS2IDMismatchPolicy

    • Retrieves or specifies accept or reject AS2 transactions where the connecting partner’s AS2-To ID does not match EFT AS2 identifier defined for that partner in that partner’s AS2 Inbound tab.

    HRESULT EFTIDMismatchPolicy([out, retval] AS2IDMismatchPolicy* pVal);
HRESULT EFTIDMismatchPolicy([in] AS2IDMismatchPolicy newVal);

    Example (VBScript):

    Retrieving:

    if AS2IDMismatchPolicyAccept = oAS2I.EFTIDMismatchPolicy then
MsgBox "Accept."
end if

    Specifying:

    oAS2I.EFTIDMismatchPolicy = AS2IDMismatchPolicyReject

    EFT v6.3 and later

  • Property EncryptMissingPolicy As AS2EncryptMissingPolicy

    • Retrieves or specifies whether EFT will Accept or Reject the transaction if it is not encrypted.

    HRESULT EncryptMissingPolicy([out, retval] AS2EncryptMissingPolicy* pVal);
HRESULT EncryptMissingPolicy([in] AS2EncryptMissingPolicy newVal);

    Example (VBScript):

    Retrieving:

    if AS2EncryptMissingPolicyAccept = oAS2I.EncryptMissingPolicy then
MsgBox "accept"
end if

    Specifying:

    oAS2I.EncryptMissingPolicy = AS2EncryptMissingPolicyReject

    EFT v6.3 and later

  • Function GetFailureCommand() As Object

    • Retrieve ICICommandActionParams interface, which specified a custom command to occur upon failure.

    HRESULT GetFailureCommand([out, retval] IDispatch** ppdispCommandParams);

    Example (VBScript):

    Set oCmd = oAS2O.GetFailureCommand()

    EFT v6.3 and later

  • Function GetFailureEmail() As Object

    • Retrieves the ICIMailActionParams interface, which specified e-mail notification parameters that will be send after failure transaction happened.

    HRESULT GetFailureEmail([out, retval] IDispatch** ppdispEmailParams);

    Example (VBScript):

    Set oMailParams = oAS2O.GetFailureEmail()

    EFT v6.3 and later

  • Function GetSuccessCommand() As Object

    • Retrieve ICICommandActionParams interface, which specified a custom command to occur upon successful transaction.

    HRESULT GetSuccessCommand([out, retval] IDispatch** ppdispCommandParams);

    Example (VBScript):

    Set oCmd = oAS2O.GetSuccessCommand()

    EFT v6.3 and later

  • Function GetSuccessEmail() As Object

    • Retrieve the ICIMailActionParams interface, which specified e-mail notification parameters that will be sent after successful transaction happened.

    HRESULT GetSuccessEmail([out, retval] IDispatch** ppdispEmailParams);

    Example (VBScript):

    Set oMailParams = oAS2O.GetSuccessEmail()

    EFT v6.3 and later

  • Property MDNAsyncSendTimeoutSec As Long

    • Retrieves or specifies the timeout period after which an asynchronous MDN send attempt shall be considered a failure if no response is received from the remote server. Range: 0-600, 60 seconds is the default. 0 = no timeout.

    HRESULT MDNAsyncSendTimeoutSec([out, retval] LONG* pVal);
HRESULT MDNAsyncSendTimeoutSec([in] LONG newVal);

    Example (VBScript):

    Retrieving:

    MsgBox "MDN send timout is: " & CStr(oAS2I.MDNSendTimeoutSec)

    Specifying:

    oAS2I.MDNSendTimeoutSec = 50

    EFT v6.3 and later

  • Property MDNSendRetriesCount As Long

    • (In v6.3.0, it was "MDNSendAttemptRetries")

    Retrieves or specifies number of time to attempt to send MDN. Range: 0 (no retry) to 999; 10 is the default.

    HRESULT MDNSendRetriesCount([out, retval] LONG* pVal);
HRESULT MDNSendRetriesCount([in] LONG newVal);

    Example (VBScript):

    Retrieving:

    MsgBox "MDN send retries is: " & CStr(oAS2I.MDNSendRetriesCount)

    Specifying:

    oAS2I.MDNSendRetriesCount = 40

    EFT v6.3 and later

  • Property MDNSendRetryDelaySec As Long

    • Retrieves or specifies retry interval. Range: 0 (no wait) to - 600 seconds; 30 seconds is the default.

    HRESULT MDNSendRetryDelaySec([out, retval] LONG* pVal);
HRESULT MDNSendRetryDelaySec([in] LONG newVal);

    Example (VBScript):

    Retrieving:

    MsgBox "MDN retry delays is: " & CStr(oAS2I.MDNSendRetryDelaySec)

    Specifying:

    oAS2I.MDNSendRetryDelaySec = 120

    EFT v6.3.1 and later

  • Property MICAlgorithm  As AS2MICHash

    • HRESULT MICAlgorithm([out, retval] AS2MICHash* pVal);
HRESULT MICAlgorithm([in] AS2MICHash newVal);

    EFT v7.4.11 and later

  • Property MoveReceivedDataToFolder As String

    • Retrieves or specifies a folder in which to save received data.

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

    Example (VBScript):

    Retrieving:

    MsgBox "Destination folder is: " & oAS2I.MoveReceivedDataToFolder

    Specifying:

    oAS2I.MoveReceivedDataToFolder = "C:\DestFolder"

    EFT v6.3 and later

  • Property PartnerCertificatePath As String

    • Retrieves or specifies the AS2 certificate to be used for verifying signed messages.

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

    Example (VBScript):

    Retrieving:

    MsgBox "AS2 partner certificate path: " & CStr(oAS2I.PartnerCertificatePath)

    Specifying:

    oAS2I.PartnerCertificatePath = "C:\Certs\Ivan.crt"

    EFT v6.3 and later

  • Property PartnerAS2ID As String

    • Retrieves or specifies your AS2 partner id. Used to identify the AS2-From ID for inbound messages emanating from partners.

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

    Example (VBScript):

    Retrieving:

    MsgBox "My AS2 partner ID is: " & oAS2I.PartnerAS2ID

    Specifying:

    oAS2I. PartnerAS2ID = "my_as2_partner_id"

    EFT v6.3 and later

  • Property PartnerIDMismatchPolicy As AS2IDMismatchPolicy

    • Retrieves or specifies accept or reject AS2 transactions where the connecting partner’s AS2-From ID does not match the AS2 identifier defined for that partner.

    HRESULT PartnerIDMismatchPolicy([out, retval] AS2IDMismatchPolicy* pVal);
HRESULT PartnerIDMismatchPolicy([in] AS2IDMismatchPolicy newVal);

    Example (VBScript):

    Retrieving:

    if AS2IDMismatchPolicyAccept = oAS2I.PartnerIDMismatchPolicy then
MsgBox "Accept."
end if

    Specifying:

    oAS2I.PartnerIDMismatchPolicy = AS2IDMismatchPolicyReject

    EFT v6.3 and later

  • Property RenameFilesTo As String

    • Retrieves or specifies string that appends filename to path using specified variables. Preserve filename if undefined.

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

    Example (VBScript):

    Retrieving:

    MsgBox "Rename files to: " & oAS2I.RenameFilesTo

    Specifying:

    oAS2I.RenameFilesTo = ""

    EFT v6.3 and later

  • Sub SetFailureCommand(pdispCommandParams As Object)

    • Specify ICICommandActionParams interface, which specified a custom command to occur upon failed send.

    HRESULT SetFailureCommand(IDispatch* pdispCommandParams);

    Example (VBScript):

    oAS2O.SetFailureCommand oCmd

    EFT v6.3 and later

  • Sub SetFailureEmail(psidpEmailParams As Object)

    • Use the ICIMailActionParams interface to specified e-mail notification parameters that will be sent after failure transaction happened.

    HRESULT SetFailureEmail(IDispatch* pdispEmailParams);

    Example (VBScript):

    oAS2O.SetFailureEmail oMailParams

    EFT v6.3 and later

  • Sub SetSuccessCommand(psidpCommandParams As Object)

    • Specify the ICICommandActionParams interface, which specified a custom command to occur upon successful transaction.

    HRESULT SetSuccessCommand(IDispatch* pdispCommandParams);

    Example (VBScript):

    oAS2O.SetSuccessCommand oCmd

    EFT v6.3 and later

  • Sub SetSuccessEmail(psidpEmailParams As Object)

    • Use the ICIMailActionParams interface to specify e-mail notification parameters that will be send after successful transaction happened.

    HRESULT SetSuccessEmail(IDispatch* pdispEmailParams);

    Example (VBScript):

    oAS2O.SetSuccessEmail oMailParams

    EFT v6.3 and later

  • Property SignatureAlgorithm As String

    • Used to retrieve or specify the allowed signature algorithm for inbound AS2 transfers.

    EFT v7.4.9 and later

  • Property SignatureMissingPolicy As AS2SignatureMissingPolicy

    • Retrieves or specifies whether EFT will accept or reject the transaction if it is not signed.

    HRESULT SignatureMissingPolicy([out, retval] AS2SignatureMissingPolicy* pVal);
HRESULT SignatureMissingPolicy([in] AS2SignatureMissingPolicy newVal);

    Example (VBScript):

    Retrieving:

    if AS2SignatureMissingPolicyAccept = oAS2I.SignatureMissingPolicy then
MsgBox "accept"
end if

    Specifying:

    oAS2I.SignatureMissingPolicy = AS2SignatureMissingPolicyReject

    EFT v6.3 and later

  • Property SkipHTTPContinue As Boolean

    • Retrieves or specifies "continue" option. "100 Continue" is a part of the HTTP protocol and means "Everything is OK for now, continue this transaction." Many AS2 servers use it to avoid timeouts. It is the client software's responsibility to process this reply properly (just skip until 200 OK or real HTTP error is received). If the client does not process the reply correctly, you can turn off the "100 Continue" response. If your AS2 partner receives multiple MDN failures when sending to EFT in HTTPS, turn off the "100 Continue" reply.

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

    Example (VBScript):

    Retrieving:

    MsgBox "Skip continue: " & CStr(oAS2I.SkipHTTPContinue)

    Specifying:

    oAS2I.SkipHTTPContinue = False

    EFT v6.3 and later

Dialog Box Equivalents