IPWorks EDI 2020 macOS Edition

Questions / Feedback?

AS2ProfileMgr Module

Properties   Methods   Events   Configuration Settings   Errors  

The AS2ProfileMgr component is used to manage self and trading partner profiles used for AS2 communication.

Syntax

nsoftware.IPWorksEDI.As2profilemgr

Remarks

AS2 communication require management of several configuration settings such as encryption certificate, signing certificate and TLS/SSL certificates. Both for your self and your trading partners.

The AS2ProfileMgr class allows you to manage such settings using simple XML files, furthermore these configuration files can be directly fed to the AS2Sender and AS2Receiver Class as a convenient way to set communication parameters.

To use the AS2ProfileMgr you should first set DataDir to configure the directory that it will use to store the profiles. You can then set the properties to be retained and save them by invoking SaveProfile, alternatively you could retrieve previously saved settings using LoadProfile.

When a new trading partner profile is saved a sub-directory named after the trading partner is created within DataDir and the file partner.cfg is saved in it. If CreateDirStruct is set to true, the following sub-directories are created within the partner directory. These can be helpful in managing other data for the trading partner.

DirDeletedDeleted files.
DirIncomingReceived files.
DirLogsLog files.
DirOutgoingFiles to be sent.
DirPendingFiles pending async MDN.
DirPendingInfoFiles having data to verify async MSN.
DirSentSent files.

Property List


The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

AsyncMDNURLThe URL for posting Async MDNs.
CreateDirStructOption to create file management directories.
DataDirThe directory that the AS2ProfileMgr uses to store self and trading partner profiles.
DirDeletedThe directory used to store deleted files.
DirIncomingThe directory used to store incoming files.
DirLogsThe directory used to store log files.
DirOutgoingThe directory used to store outgoing files.
DirPendingThe directory used to store files waiting for Async MDN.
DirPendingInfoThe directory used to store files containing data to verify Async MDN.
DirSentThe directory used to store sent files.
EmailYour email address.
EncryptionCertEncodedThe certificate (PEM/base64 encoded).
EncryptionCertStoreThe name of the certificate store for the client certificate.
EncryptionCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
EncryptionCertStoreTypeThe type of certificate store for this certificate.
EncryptionCertSubjectThe subject of the certificate used for client authentication.
OptionCompressPreference to compress outgoing data.
OptionEncryptPreference to encrypt outgoing data.
OptionSignPreference to sign outgoing data.
OrganizationThe name of your, or your trading partner's organization.
PartnerCountThe number of partners found in DataDir .
RequestMDNPreference to receive MDNs from trading partner.
RequestMDNSignedPreference to request for signed MDNs.
RequestMDNSynchronousPreference to request for synchronous MDNs.
RequireEncryptPreference to receive encrypted messages.
RequireSignPreference to receive signed messages.
SigningCertEncodedThe certificate (PEM/base64 encoded).
SigningCertStoreThe name of the certificate store for the client certificate.
SigningCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SigningCertStoreTypeThe type of certificate store for this certificate.
SigningCertSubjectThe subject of the certificate used for client authentication.
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
URLThe URL for posting EDI data.

Method List


The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
DeleteProfileDeletes the configuration of the specified partner.
GetPropertyGets the property propName .
GetTPInfoGets the profile of the specified partner as a XML TPInfo.
ListPartnersLists trading partners known to the AS2ProfileMgr .
ListPropertiesLists the properties read from self or partner profile.
LoadProfileLoads the profile of the trading partner identified by partnerOrganization .
ResetResets the state of the control.
SaveProfileSaves the profile of the trading partner identified by partnerOrganization .
SetPropertySets the property propName to propValue .

Event List


The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
PartnerFired when ListPartners is invoked.
PartnerDirectoryFired before accessing partner.cfg of a trading partner.
PropertyFired when ListProperties is invoked.

Configuration Settings


The following is a list of configuration settings for the module with short descriptions. Click on the links for further details.

BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 macOS Edition - Version 20.0 [Build 8162]