AS2ProfileMgr Class
Properties Methods Events Configuration Settings Errors
The AS2ProfileMgr class is used to manage self and trading partner profiles used for AS2 communication.
Syntax
class 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 data_dir 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 save_profile, alternatively you could retrieve previously saved settings using load_profile.
When a new trading partner profile is saved a sub-directory named after the trading partner is created within data_dir and the file partner.cfg is saved in it. If create_dir_struct 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.
| dir_deleted | Deleted files. |
| dir_incoming | Received files. |
| dir_logs | Log files. |
| dir_outgoing | Files to be sent. |
| dir_pending | Files pending async MDN. |
| dir_pending_info | Files having data to verify async MSN. |
| dir_sent | Sent files. |
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| async_mdnurl | The URL for posting Async MDNs. |
| create_dir_struct | Option to create file management directories. |
| data_dir | The directory that the AS2ProfileMgr uses to store self and trading partner profiles. |
| dir_deleted | The directory used to store deleted files. |
| dir_incoming | The directory used to store incoming files. |
| dir_logs | The directory used to store log files. |
| dir_outgoing | The directory used to store outgoing files. |
| dir_pending | The directory used to store files waiting for Async MDN. |
| dir_pending_info | The directory used to store files containing data to verify Async MDN. |
| dir_sent | The directory used to store sent files. |
| Your email address. | |
| encryption_cert_encoded | The certificate (PEM/base64 encoded). |
| encryption_cert_store | The name of the certificate store for the client certificate. |
| encryption_cert_store_password | If 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. |
| encryption_cert_store_type | The type of certificate store for this certificate. |
| encryption_cert_subject | The subject of the certificate used for client authentication. |
| option_compress | Preference to compress outgoing data. |
| option_encrypt | Preference to encrypt outgoing data. |
| option_sign | Preference to sign outgoing data. |
| organization | The name of your, or your trading partner's organization. |
| partner_count | The number of partners found in DataDir . |
| request_mdn | Preference to receive MDNs from trading partner. |
| request_mdn_signed | Preference to request for signed MDNs. |
| request_mdn_synchronous | Preference to request for synchronous MDNs. |
| require_encrypt | Preference to receive encrypted messages. |
| require_sign | Preference to receive signed messages. |
| signing_cert_encoded | The certificate (PEM/base64 encoded). |
| signing_cert_store | The name of the certificate store for the client certificate. |
| signing_cert_store_password | If 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. |
| signing_cert_store_type | The type of certificate store for this certificate. |
| signing_cert_subject | The subject of the certificate used for client authentication. |
| ssl_cert_encoded | The certificate (PEM/base64 encoded). |
| ssl_cert_store | The name of the certificate store for the client certificate. |
| ssl_cert_store_password | If 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. |
| ssl_cert_store_type | The type of certificate store for this certificate. |
| ssl_cert_subject | The subject of the certificate used for client authentication. |
| url | The URL for posting EDI data. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| delete_profile | Deletes the configuration of the specified partner. |
| get_property | Gets the property propName . |
| get_tp_info | Gets the profile of the specified partner as a XML TPInfo. |
| list_partners | Lists trading partners known to the AS2ProfileMgr . |
| list_properties | Lists the properties read from self or partner profile. |
| load_profile | Loads the profile of the trading partner identified by partnerOrganization . |
| reset | Resets the state of the control. |
| save_profile | Saves the profile of the trading partner identified by partnerOrganization . |
| set_property | Sets the property propName to propValue . |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| on_error | Information about errors during data delivery. |
| on_partner | Fired when ListPartners is invoked. |
| on_partner_directory | Fired before accessing partner.cfg of a trading partner. |
| on_property | Fired when ListProperties is invoked. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |