AS2 Objects

In addition to the ICIAS2InboundSettings Interface, ICIAS2OutboundSettings Interface, ICIAS2SendActionParams Interface, and ICIAS2TransactionInfo Interface, the following AS2 settings are in the ICISite Interface, ICIClientSettings Interface, and Enum Reference.

For SFTPAdvBool, used below:

  • abFalse = 0

  • abInherited = -2

  • abTrue = 1

In the ICISite interface:

  • Property AS2AccountManagementPath As String (read only)

    • Retrieves URL for AS2 account management.

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

    Example (VBScript):

    MsgBox "AS2 management path is: " & oSite.AS2AccountManagementPath

    EFT v6.3 and later

  • Property AS2Certificate As String

    • Retrieves or specifies AS2 certificate path.

    HRESULT AS2Certificate([out, retval] BSTR* pVal);
HRESULT AS2Certificate([in] BSTR newVal);Example (VBScript):

    Retrieving:

    MsgBox "AS2 certificate is: " & oSite.AS2Certificate

    Specifying:

    oSite.AS2Certificate = "C:\MyCerts\AS2Cert.crt"

    EFT v6.3 and later

  • Property AS2Identifier As String

    • Retrieves or specifies the AS2 identifier.

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

    Example (VBScript):

    Retrieving:

    MsgBox "AS2 identifier is: " & oSite.AS2Identifier

    Specifying:

    oSite.AS2Identifier = "my_as2_id"

    EFT v6.3 and later

  • Property AS2Passphrase As String

    • Retrieves or specifies the AS2 passphrase.

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

    Example (VBScript):

    Retrieving:

    MsgBox "AS2 passphrase is: " & oSite.AS2Passphrase

    Specifying:

    oSite.AS2Passphrase = "new_passphrase"

    EFT v6.3 and later

  • Property AS2PrivateKey As String

    • Retrieves or specifies the AS2 private key.

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

    Example (VBScript):

    Retrieving:

    MsgBox "AS2 certificate is: " & oSite.AS2PrivateKey

    Specifying:

    oSite.AS2PrivateKey = "C:\MyCerts\AS2Cert.crt"

    EFT v6.3 and later

  • Property EnableAS2 As Boolean

    • Retrieves or specifies whether AS2 is enabled on the Site.

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

    True = Enabled; False = Disabled

    Example (VBScript):

    Retrieving:

    if False = oSite.EnableAS2 then
MsgBox "Disable"
else
MsgBox "Remove"
end if

    Specifying:

    oSite.EnableAS2 = True

    EFT v6.3 and later

  • Function GetAS2Transactions(vbShowSuccesses As Boolean, vbShowFailures As Boolean, vbShowInProgress As Boolean, bstrMessageIDFilter As String, bstrFileNameFilter As String, lLastDays As Long) As Variant

    • Retrieves AS2 transactions.

    HRESULT GetAS2Transactions([in] VARIANT_BOOL vbShowSuccesses,
[in] VARIANT_BOOL vbShowFailures,[in] VARIANT_BOOL vbShowInProgress,
[in] BSTR bstrMessageIDFilter,[in] BSTR bstrFileNameFilter,
[in] LONG lLastDays,[out,retval] VARIANT* pTransInfo);

    Example (VBScript):

    For Each trans In oSite.GetAS2Transactions(True, True, True, "*", "*", 7)
MsgBox "Transaction id: " & trans.TransactionID
Next

    EFT v6.3 and later

    In the ICIClientSettings interface:

  • Property AS2InboundSettings As CIAS2InboundSettings

    • Retrieves user account's AS2 inbound settings.

    HRESULT AS2InboundSettings(
[out,retval] IDispatch** pSttg); 
[out,retval] ICIAS2InboundSettings** pSttg);

    Example (VBScript):

    Set oAS2InboundSettings = oClientSettings.AS2InboundSettings

    EFT v6.3 and later

  • Property AS2OutboundSettings As CIAS2OutboundSettings

    • Retrieves user account's AS2 outbound settings.

    HRESULT AS2OutboundSettings(
[out,retval] IDispatch** pSttg);

    Example (VBScript):

    Set oAS2OutboundSettings = oClientSettings.AS2OutboundSettings

    EFT v6.3 and later

  • Function AS2TestOutboundProfile() As AS2OutboundProfileStatus

    • Tests user account's AS2 outbound profile and returns status.

    HRESULT AS2TestOutboundProfile(
[out,retval] AS2OutboundProfileStatus* pVal);

    Example (VBScript):

    if AS2StatusOk = oClientSettings.AS2TestOutboundProfile then
MsgBox “Success.”
else
MsgBox “Some going wrong.”
end if

    EFT v6.3 and later

  • Function GetAS2Inbound([pInherited]) As Boolean

    • Retrieve whether AS2 inbound transactions are enabled for the user or Settings Template.

    HRESULT GetAS2Inbound(
[out, optional] VARIANT* pInherited,
[out, retval] VARIANT_BOOL* pVal);

     VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled

    Example (VBScript):

    bEnabled = oClientSettings.GetAS2Inbound(bInherited)
MsgBox "Enabled: " & CStr(bEnabled) & " Inherited: " & CStr(bInherited)

    EFT v6.3 and later

  • Function GetAS2Outbound([pInherited]) As Boolean

    • Retrieve whether AS2 outbound transactions are enabled for the user or Settings Template.

    HRESULT GetAS2Outbound(
[out, optional] VARIANT* pInherited,
[out, retval] VARIANT_BOOL* pVal);

    VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled

    Example (VBScript):

    bEnabled = oClientSettings.GetAS2Outbound(bInherited)
MsgBox "Enabled: " & CStr(bEnabled) & " Inherited: " & CStr(bInherited)

    EFT v6.3 and later

  • Sub SetAS2Inbound(val As SFTPAdvBool)

    • Specify whether AS2 Inbound is enabled for the user or Settings Template.

    HRESULT SetAS2Inbound(
[in] SFTPAdvBool val);

    Example (VBScript):

    oClientSettings.SetAS2Inbound abInherited

    EFT v6.3 and later

  • Sub SetAS2Outbound(val As SFTPAdvBool)

    • Specify whether AS2 Outbound is enabled for the user or Settings Template.

    HRESULT SetAS2Outbound(
[in] SFTPAdvBool val);

    Example (VBScript):

    oClientSettings.SetAS2Outbound abTrue

    EFT v6.3 and later

In the Enum Reference:

  • AS2AuthenticationType (v6.3 and later)

    • Used in the ICIAS2InboundSettings AuthenticationType property used to specify the AS2 authentication mechanism.

    • AS2AuthTypeUsernameAndPassword = 0

    • AS2AuthTypeMsgLevelSecurity = 1

  • AS2ContentType (v6.1 and later)

    • Used to specify the type of the document to send in the ICIAS2OutboundSettings and ICIAS2SendActionParamsContentType properties.

    • X12 = 0

    • EDIConsent = 3

    • EDIFACT = 1

    • Binary = 4

    • XML = 2

    • Plaintext = 5

  • AS2DoubleContentPolicy (v6.3 and later)

    • Used in the ICIAS2InboundSettings DoubleContentPolicy property to specify the AS2 duplicate contents policy.

    • AS2DoubleContentPolicyOverwrite = 0

    • AS2DoubleContentPolicyNumerate = 1

    • AS2DoubleContentPolicyReject = 2

  • AS2DoubleMsgIDPolicy (v6.3 and later)

    • Used in the ICIAS2InboundSettings DoubleMsgIDPolicy policy used to specify the AS2 duplicate message ID policy.

    • AS2DoubleMsgIDPolicyAccept = 0

    • AS2DoubleMsgIDPolicyReject = 1

  • AS2EncryptionAlgorithm (v7.4.9 and later)

    • Used in the ICIAS2InboundSettings EncryptionAlgorithm property to specify allowed encryption algorithms.

    • Const Encryption_3DES = 0

    • Const Encryption_DES = 1

    • Const Encryption_AESCBC128 = 2

    • Const Encryption_AESCBC192 = 3

    • Const Encryption_AESCBC256 = 4  

  • AS2EncryptMissingPolicy (v6.3 and later)

    • Used in the ICIAS2InboundSettings EncryptMissingPolicy property.

    • AS2EncryptMissingPolicyAccept = 0

    • AS2EncryptMissingPolicyReject = 1

  • AS2IDMismatchPolicy (v6.3 and later)

    • Used in the ICIAS2InboundSettings EFTIDMismatchPolicy and PartnerIDMismatchPolicy properties to specify the mismatch policy.

    • AS2IDMismatchPolicyAccept = 0

    • AS2IDMismatchPolicyReject = 1

  • AS2OutboundProfileStatus (v6.3 and later)

    • Used in the ICIClientSettings AS2TestOutboundProfile method to retrieve the result for AS2 Test Outbound Profile operation.

    • AS2StatusOk = 0

    • AS2StatusVerifyMDNFailed = 4

    • AS2StatusNotRegistered = 1

    • AS2StatusDatabaseFailure = 5

    • AS2StatusCreateRequestFailed = 2

    • AS2StatusUnexpectedError = 6

    • AS2StatusSendDataFailed = 3

  • AS2ProxyType (v6.3 and later)

    • Used in the ICIAS2OutboundSettings ProxyType property to specify the AS2 proxy type.

    • AS2ProxyDMZ = 0

    • AS2ProxyHTTP = 1

  • AS2ReceiptDelivery (v6.1 and later)

    • Used to specify the receipt delivery mechanism in the ICIAS2OutboundSettings and ICIAS2SendActionParamsReceiptDelivery property.

    • Sync = 0

    • Async = 1

  • AS2ReceiptPolicy (v6.1 and later)

    • Used to specify the type of the receipt required in the ICIAS2OutboundSettings and ICIAS2SendActionParamsReceiptPolicy property.

    • NoReceipt = 0

    • UnsignedReceipt = 1

    • SignedReceipt = 2

  • AS2SignatureAlgorithm (v7.4.9 and later)

    • The AS2SignatureAlgorithm enum is used in the ICIAS2OutboundSettings SignatureAlgorithm property.

    • Signature_MD5 = 1

    • Signature_SHA1 = 0

    • Signature_SHA_224 = 5

    • Signature_SHA_256 = 2

    • Signature_SHA_384 = 3

    • Signature_SHA_512 = 4

  • AS2SignatureMissingPolicy (v6.3 and later)

    • Used in the ICIAS2InboundSettings SignatureMissingPolicy property to specify the AS2 signature-missing policy.

    • AS2SignatureMissingPolicyAccept = 0

    • AS2SignatureMissingPolicyReject = 1

  • AS2TransactionDirection (v6.3 and later)

    • Used in the ICIAS2TransactionInfo Interface Direction property to retrieve the direction of an AS2 transaction.

    • AS2TransDirectionInbound = 0

    • AS2TransDirectionOutbound = 1

  • AS2TransactionStatus (v6.3 and later)

    • Used in the ICIAS2TransactionInfo Interface Status property to retrieve the status of an AS2 transaction.

    • AS2TransactionInProgress = 0

    • AS2TransactionSuccess = 1

    • AS2TransactionFailedCanResend = 2

    • AS2TransactionFailedNoResend = 3

    • AS2TransactionOkSendMDNFailed = 4

Dialog Box Equivalents

Site AS2 Settings