AS2ProfileMgr Component
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 component allows you to manage such settings using simple XML files, furthermore these configuration files can be directly fed to the AS2Sender and AS2Receiver Component 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.
| DirDeleted | Deleted files. |
| DirIncoming | Received files. |
| DirLogs | Log files. |
| DirOutgoing | Files to be sent. |
| DirPending | Files pending async MDN. |
| DirPendingInfo | Files having data to verify async MSN. |
| DirSent | Sent files. |
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| AsyncMDNURL | The URL for posting Async MDNs. |
| CreateDirStruct | Option to create file management directories. |
| DataDir | The directory that the AS2ProfileMgr uses to store self and trading partner profiles. |
| DirDeleted | The directory used to store deleted files. |
| DirIncoming | The directory used to store incoming files. |
| DirLogs | The directory used to store log files. |
| DirOutgoing | The directory used to store outgoing files. |
| DirPending | The directory used to store files waiting for Async MDN. |
| DirPendingInfo | The directory used to store files containing data to verify Async MDN. |
| DirSent | The directory used to store sent files. |
| Your email address. | |
| EncryptionCert | Certificate used for encryption or decryption. |
| OptionCompress | Preference to compress outgoing data. |
| OptionEncrypt | Preference to encrypt outgoing data. |
| OptionSign | Preference to sign outgoing data. |
| Organization | The name of your, or your trading partner's organization. |
| PartnerCount | The number of partners found in DataDir . |
| RequestMDN | Preference to receive MDNs from trading partner. |
| RequestMDNSigned | Preference to request for signed MDNs. |
| RequestMDNSynchronous | Preference to request for synchronous MDNs. |
| RequireEncrypt | Preference to receive encrypted messages. |
| RequireSign | Preference to receive signed messages. |
| SigningCert | Certificate used for signing or signature validation. |
| SSLCert | Certificate used for secure communication over SSL. |
| URL | The URL for posting EDI data. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| DeleteProfile | Deletes the configuration of the specified partner. |
| GetProperty | Gets the property propName . |
| GetTPInfo | Gets the profile of the specified partner as a XML TPInfo. |
| ListPartners | Lists trading partners known to the AS2ProfileMgr . |
| ListProperties | Lists the properties read from self or partner profile. |
| LoadProfile | Loads the profile of the trading partner identified by partnerOrganization . |
| Reset | Resets the state of the control. |
| SaveProfile | Saves the profile of the trading partner identified by partnerOrganization . |
| SetProperty | Sets the property propName to propValue . |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| Partner | Fired when ListPartners is invoked. |
| PartnerDirectory | Fired before accessing partner.cfg of a trading partner. |
| Property | Fired when ListProperties is invoked. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| BuildInfo | Information about the product's build. |
| GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
| LicenseInfo | Information about the current license. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |