IP*Works! EDI ProfileMgr Component : ProfileMgr OCX, ProfileMgr .NET Component, ProfileMgr Class, ProfileMgr Bean, ProfileMgr Object

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

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

The ProfileMgr 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 ProfileMgr 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. Please refer to IPWorks! EDI AS2 Connector application to see an example of how these directories can be used.


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 ProfileMgr 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.
Email	Your email address.
EncryptionCertEffectiveDate	The date which this certificate becomes valid.
EncryptionCertEncoded	The certificate (PEM/base64 encoded).
EncryptionCertExpirationDate	The date the certificate expires.
EncryptionCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
EncryptionCertIssuer	The issuer of the certificate.
EncryptionCertKeyPassword	The password for the certificate's private key (if any).
EncryptionCertPrivateKey	The private key of the certificate (if available).
EncryptionCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
EncryptionCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
EncryptionCertPublicKey	The public key of the certificate.
EncryptionCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
EncryptionCertPublicKeyLength	The length of the certificate public key (in bits).
EncryptionCertSerialNumber	The serial number of the certificate encoded as a string.
EncryptionCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
EncryptionCertStore	The name of the certificate store for the client certificate.
EncryptionCertStorePassword	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.
EncryptionCertStoreType	The type of certificate store for this certificate.
EncryptionCertSubject	The subject of the certificate used for client authentication.
EncryptionCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
EncryptionCertThumbprintMD5	MD5 hash of the certificate.
EncryptionCertThumbprintSHA1	SHA1 hash of the certificate.
EncryptionCertUsage	Textual description of UsageFlags .
EncryptionCertUsageFlags	Flags that show intended use for the certificate.
EncryptionCertVersion	The certificate's version number.
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.
SigningCertEffectiveDate	The date which this certificate becomes valid.
SigningCertEncoded	The certificate (PEM/base64 encoded).
SigningCertExpirationDate	The date the certificate expires.
SigningCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
SigningCertIssuer	The issuer of the certificate.
SigningCertKeyPassword	The password for the certificate's private key (if any).
SigningCertPrivateKey	The private key of the certificate (if available).
SigningCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
SigningCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
SigningCertPublicKey	The public key of the certificate.
SigningCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
SigningCertPublicKeyLength	The length of the certificate public key (in bits).
SigningCertSerialNumber	The serial number of the certificate encoded as a string.
SigningCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
SigningCertStore	The name of the certificate store for the client certificate.
SigningCertStorePassword	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.
SigningCertStoreType	The type of certificate store for this certificate.
SigningCertSubject	The subject of the certificate used for client authentication.
SigningCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
SigningCertThumbprintMD5	MD5 hash of the certificate.
SigningCertThumbprintSHA1	SHA1 hash of the certificate.
SigningCertUsage	Textual description of UsageFlags .
SigningCertUsageFlags	Flags that show intended use for the certificate.
SigningCertVersion	The certificate's version number.
SSLCertEffectiveDate	The date which this certificate becomes valid.
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertExpirationDate	The date the certificate expires.
SSLCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
SSLCertIssuer	The issuer of the certificate.
SSLCertKeyPassword	The password for the certificate's private key (if any).
SSLCertPrivateKey	The private key of the certificate (if available).
SSLCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
SSLCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
SSLCertPublicKey	The public key of the certificate.
SSLCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
SSLCertPublicKeyLength	The length of the certificate public key (in bits).
SSLCertSerialNumber	The serial number of the certificate encoded as a string.
SSLCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	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.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
SSLCertThumbprintMD5	MD5 hash of the certificate.
SSLCertThumbprintSHA1	SHA1 hash of the certificate.
SSLCertUsage	Textual description of UsageFlags .
SSLCertUsageFlags	Flags that show intended use for the certificate.
SSLCertVersion	The certificate's version number.
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 ProfileMgr.
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.


CodePage	The system code page used for Unicode to Multibyte translations.

|

About

|

Privacy Policy

|

Terms of Use

|