AS2ProfileMgr Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TibeAS2ProfileMgr

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.

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

AsyncMDNURL Property (AS2ProfileMgr Component)

The URL for posting Async MDNs.

Syntax

__property String AsyncMDNURL = { read=FAsyncMDNURL, write=FSetAsyncMDNURL };

Default Value

""

Remarks

This is the URL to which your trading partners would post Async MDNs, if you choose to get asynchronous notifications. The choice of receiving asynchronous notifications can be made on a per partner basis and is reflected in RequestMDNSynchronous.

Data Type

String

CreateDirStruct Property (AS2ProfileMgr Component)

Option to create file management directories.

Syntax

__property bool CreateDirStruct = { read=FCreateDirStruct, write=FSetCreateDirStruct };

Default Value

true

Remarks

Set CreateDirStruct to false if you would like AS2ProfileMgr not to create file management directories. These are created for a trading partner when SaveProfile is invoked.

Data Type

Boolean

DataDir Property (AS2ProfileMgr Component)

The directory that the AS2ProfileMgr uses to store self and trading partner profiles.

Syntax

__property String DataDir = { read=FDataDir, write=FSetDataDir };

Default Value

""

Remarks

AS2ProfileMgr uses DataDir to store self and trading partner configuration. The self profile is stored in the XML file me.cfg and the trading partner profiles are stored in the XML file partner.cfg. The partner.cfg is stored in a separate sub-directory for each trading partner. The sub-directory name is derived from the parameter PartnerOrganization of SaveProfile.

Data Type

String

DirDeleted Property (AS2ProfileMgr Component)

The directory used to store deleted files.

Syntax

__property String DirDeleted = { read=FDirDeleted };

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing deleted files would have been created. The path to this directory can be read from DirDeleted after invoking LoadProfile.

This property is read-only.

Data Type

String

DirIncoming Property (AS2ProfileMgr Component)

The directory used to store incoming files.

Syntax

__property String DirIncoming = { read=FDirIncoming };

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing incoming files would have been created. The path to this directory can be read from DirIncoming after invoking LoadProfile.

This property is read-only.

Data Type

String

DirLogs Property (AS2ProfileMgr Component)

The directory used to store log files.

Syntax

__property String DirLogs = { read=FDirLogs };

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing log files would have been created. The path to this directory can be read from DirLogs after invoking LoadProfile.

This property is read-only.

Data Type

String

DirOutgoing Property (AS2ProfileMgr Component)

The directory used to store outgoing files.

Syntax

__property String DirOutgoing = { read=FDirOutgoing };

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing outgoing files would have been created. The path to this directory can be read from DirOutgoing after invoking LoadProfile.

This property is read-only.

Data Type

String

DirPending Property (AS2ProfileMgr Component)

The directory used to store files waiting for Async MDN.

Syntax

__property String DirPending = { read=FDirPending };

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing files waiting for Async MDN would have been created. The path to this directory can be read from DirPending after invoking LoadProfile.

This property is read-only.

Data Type

String

DirPendingInfo Property (AS2ProfileMgr Component)

The directory used to store files containing data to verify Async MDN.

Syntax

__property String DirPendingInfo = { read=FDirPendingInfo };

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing files containing data for Async MDN verification would have been created. The path to this directory can be read from DirPendingInfo after invoking LoadProfile.

This property is read-only.

Data Type

String

DirSent Property (AS2ProfileMgr Component)

The directory used to store sent files.

Syntax

__property String DirSent = { read=FDirSent };

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing sent files would have been created. The path to this directory can be read from DirSent after invoking LoadProfile.

This property is read-only.

Data Type

String

Email Property (AS2ProfileMgr Component)

Your email address.

Syntax

__property String Email = { read=FEmail, write=FSetEmail };

Default Value

""

Remarks

Email is used to store your email address. The email address is used to request a MDN. It is simply used as a token to request a MDN, it does not imply that the MDN would be sent to this address. Please refer to the property MDNTo in AS2Sender for details.

After invoking LoadProfile, the Email will contain your currently configured email address, alternatively Email may be set and saved by invoking SaveProfile.

Data Type

String

EncryptionCertEncoded Property (AS2ProfileMgr Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String EncryptionCertEncoded = { read=FEncryptionCertEncoded, write=FSetEncryptionCertEncoded };
__property DynamicArray<Byte> EncryptionCertEncodedB = { read=FEncryptionCertEncodedB, write=FSetEncryptionCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The EncryptionCertStore and EncryptionCertSubject properties also may be used to specify a certificate.

When EncryptionCertEncoded is set, a search is initiated in the current EncryptionCertStore for the private key of the certificate. If the key is found, EncryptionCertSubject is updated to reflect the full subject of the selected certificate; otherwise, EncryptionCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

EncryptionCertStore Property (AS2ProfileMgr Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String EncryptionCertStore = { read=FEncryptionCertStore, write=FSetEncryptionCertStore };
__property DynamicArray<Byte> EncryptionCertStoreB = { read=FEncryptionCertStoreB, write=FSetEncryptionCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The EncryptionCertStoreType property denotes the type of the certificate store specified by EncryptionCertStore. If the store is password protected, specify the password in EncryptionCertStorePassword.

EncryptionCertStore is used in conjunction with the EncryptionCertSubject property to specify client certificates. If EncryptionCertStore has a value, and EncryptionCertSubject or EncryptionCertEncoded is set, a search for a certificate is initiated. Please see the EncryptionCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

EncryptionCertStorePassword Property (AS2ProfileMgr Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String EncryptionCertStorePassword = { read=FEncryptionCertStorePassword, write=FSetEncryptionCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

EncryptionCertStoreType Property (AS2ProfileMgr Component)

This is the type of certificate store for this certificate.

Syntax

__property TibeAS2ProfileMgrEncryptionCertStoreTypes EncryptionCertStoreType = { read=FEncryptionCertStoreType, write=FSetEncryptionCertStoreType };

enum TibeAS2ProfileMgrEncryptionCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

EncryptionCertSubject Property (AS2ProfileMgr Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String EncryptionCertSubject = { read=FEncryptionCertSubject, write=FSetEncryptionCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

OptionCompress Property (AS2ProfileMgr Component)

Preference to compress outgoing data.

Syntax

__property bool OptionCompress = { read=FOptionCompress, write=FSetOptionCompress };

Default Value

false

Remarks

OptionCompress is used to store your preference of compressing the data sent to your trading partner.

After invoking LoadProfile, the OptionCompress will contain your compression preference for your trading partner, alternatively OptionCompress may be set and saved by invoking SaveProfile.

Data Type

Boolean

OptionEncrypt Property (AS2ProfileMgr Component)

Preference to encrypt outgoing data.

Syntax

__property bool OptionEncrypt = { read=FOptionEncrypt, write=FSetOptionEncrypt };

Default Value

false

Remarks

OptionEncrypt is used to store your preference of encrypting data sent to your trading partner. If OptionEncrypt is set to true EncryptionCert must be specified.

After invoking LoadProfile, the OptionEncrypt will contain your encryption preference for your trading partner, alternatively OptionEncrypt may be set and saved by invoking SaveProfile.

Data Type

Boolean

OptionSign Property (AS2ProfileMgr Component)

Preference to sign outgoing data.

Syntax

__property bool OptionSign = { read=FOptionSign, write=FSetOptionSign };

Default Value

false

Remarks

OptionSign is used to store your preference of signing the data sent to your trading partner.

After invoking LoadProfile, the OptionSign will contain your signing preference for your trading partner, alternatively OptionSign may be set and saved by invoking SaveProfile.

Data Type

Boolean

Organization Property (AS2ProfileMgr Component)

The name of your, or your trading partner's organization.

Syntax

__property String Organization = { read=FOrganization, write=FSetOrganization };

Default Value

""

Remarks

Generally, Organization is used to store your, or your trading partner's AS2 identifier. It is used to configure or verify AS2From and AS2To in AS2Sender and AS2Receiver components.

Invoking LoadProfile reads the AS2 identifier into Organization, alternatively you can save the AS2 identifier by setting Organization and invoking SaveProfile.

Data Type

String

PartnerCount Property (AS2ProfileMgr Component)

The number of partners found in DataDir .

Syntax

__property int PartnerCount = { read=FPartnerCount };

Default Value

0

Remarks

This property returns the number of partners found in DataDir. This proprety is populated after calling ListPartners.

This property is read-only and not available at design time.

Data Type

Integer

RequestMDN Property (AS2ProfileMgr Component)

Preference to receive MDNs from trading partner.

Syntax

__property bool RequestMDN = { read=FRequestMDN, write=FSetRequestMDN };

Default Value

false

Remarks

RequireMDN is used to store your preference of receiving MDNs for the messages you send to your trading partner.

After invoking LoadProfile, the RequireMDN will contain your preference of receiving MDNs, alternatively RequireMDN may be set and saved by invoking SaveProfile.

Data Type

Boolean

RequestMDNSigned Property (AS2ProfileMgr Component)

Preference to request for signed MDNs.

Syntax

__property bool RequestMDNSigned = { read=FRequestMDNSigned, write=FSetRequestMDNSigned };

Default Value

true

Remarks

MDNRequestSigned is used to store your preference of requesting signed MDNs from your trading partner.

After invoking LoadProfile, the MDNRequestSigned will contain your preference of requesting signed MDNs, alternatively MDNRequestSigned may be set and saved by invoking SaveProfile.

Data Type

Boolean

RequestMDNSynchronous Property (AS2ProfileMgr Component)

Preference to request for synchronous MDNs.

Syntax

__property bool RequestMDNSynchronous = { read=FRequestMDNSynchronous, write=FSetRequestMDNSynchronous };

Default Value

true

Remarks

MDNRequestSynchronous is used to store your preference of requesting synchronous MDNs from your trading partner.

After invoking LoadProfile, the MDNRequestSynchronous will contain your preference of requesting synchronous MDNs, alternatively MDNRequestSynchronous may be set and saved by invoking SaveProfile.

Data Type

Boolean

RequireEncrypt Property (AS2ProfileMgr Component)

Preference to receive encrypted messages.

Syntax

__property bool RequireEncrypt = { read=FRequireEncrypt, write=FSetRequireEncrypt };

Default Value

false

Remarks

RequireEncrypt is used to store your preference of receiving encrypted messages from your trading partner.

After invoking LoadProfile, the RequireEncrypt will contain your preference of receiving encrypted messages, alternatively RequireEncrypt may be set and saved by invoking SaveProfile.

Data Type

Boolean

RequireSign Property (AS2ProfileMgr Component)

Preference to receive signed messages.

Syntax

__property bool RequireSign = { read=FRequireSign, write=FSetRequireSign };

Default Value

false

Remarks

RequireSign is used to store your preference of receiving signed messages from your trading partner.

After invoking LoadProfile, the RequireSign will contain your preference of receiving signed messages, alternatively RequireSign may be set and saved by invoking SaveProfile.

Data Type

Boolean

SigningCertEncoded Property (AS2ProfileMgr Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SigningCertEncoded = { read=FSigningCertEncoded, write=FSetSigningCertEncoded };
__property DynamicArray<Byte> SigningCertEncodedB = { read=FSigningCertEncodedB, write=FSetSigningCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SigningCertStore and SigningCertSubject properties also may be used to specify a certificate.

When SigningCertEncoded is set, a search is initiated in the current SigningCertStore for the private key of the certificate. If the key is found, SigningCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SigningCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SigningCertStore Property (AS2ProfileMgr Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SigningCertStore = { read=FSigningCertStore, write=FSetSigningCertStore };
__property DynamicArray<Byte> SigningCertStoreB = { read=FSigningCertStoreB, write=FSetSigningCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SigningCertStoreType property denotes the type of the certificate store specified by SigningCertStore. If the store is password protected, specify the password in SigningCertStorePassword.

SigningCertStore is used in conjunction with the SigningCertSubject property to specify client certificates. If SigningCertStore has a value, and SigningCertSubject or SigningCertEncoded is set, a search for a certificate is initiated. Please see the SigningCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SigningCertStorePassword Property (AS2ProfileMgr Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SigningCertStorePassword = { read=FSigningCertStorePassword, write=FSetSigningCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SigningCertStoreType Property (AS2ProfileMgr Component)

This is the type of certificate store for this certificate.

Syntax

__property TibeAS2ProfileMgrSigningCertStoreTypes SigningCertStoreType = { read=FSigningCertStoreType, write=FSetSigningCertStoreType };

enum TibeAS2ProfileMgrSigningCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SigningCertSubject Property (AS2ProfileMgr Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String SigningCertSubject = { read=FSigningCertSubject, write=FSetSigningCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (AS2ProfileMgr Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (AS2ProfileMgr Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (AS2ProfileMgr Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (AS2ProfileMgr Component)

This is the type of certificate store for this certificate.

Syntax

__property TibeAS2ProfileMgrSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TibeAS2ProfileMgrSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (AS2ProfileMgr Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

URL Property (AS2ProfileMgr Component)

The URL for posting EDI data.

Syntax

__property String URL = { read=FURL, write=FSetURL };

Default Value

""

Remarks

URL is the URL provided by your trading partner for posting EDI Data. Please refer to the URL property in AS2Sender for details.

In the case of "self" profile i.e. when the parameter partnerIdentifier is "self" in LoadProfile or SaveProfile, URL refers to the URL that your trading partners use to post data to you.

After invoking LoadProfile, the URL will contain the URL of your trading partner, alternatively URL may be set and saved by invoking SaveProfile.

Data Type

String

Config Method (AS2ProfileMgr Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DeleteProfile Method (AS2ProfileMgr Component)

Deletes the configuration of the specified partner.

Syntax

void __fastcall DeleteProfile(String partnerOrganization);

Remarks

The profile of the partner identified by partnerIdentifier is deleted. This method also deletes the directory in which the partner profile is stored, consequently deleting file management directories of the partner.

If the partnerOrganization specified is "self", the self profile i.e. me.cfg, is cleared.

GetProperty Method (AS2ProfileMgr Component)

Gets the property propName .

Syntax

String __fastcall GetProperty(String propName);

Remarks

GetProperty can be used to query any property from "self" or partner profile. It is specially useful in retrieving properties not interpreted by AS2Sender AS2Receiver components and thus not exposed as AS2ProfileMgr properties.

GetProperty returns null if property propName was not read by LoadProfile.

GetTPInfo Method (AS2ProfileMgr Component)

Gets the profile of the specified partner as a XML TPInfo.

Syntax

String __fastcall GetTPInfo(String partnerOrganization);

Remarks

If the parameter partnerOrganization is "self", GetTPInfo returns a XML string representing the "self" profile otherwise it returns a XML string of partner profile. These strings can be directly fed to AS2Sender and AS2Receiver using the method SetTPInfo.

ListPartners Method (AS2ProfileMgr Component)

Lists trading partners known to the AS2ProfileMgr .

Syntax

void __fastcall ListPartners();

Remarks

Invoking ListPartners causes the event Partner to be fired for each trading partner profile found by the AS2ProfileMgr component.

After this method returns PartnerCount is populated with the number of found partners.

ListProperties Method (AS2ProfileMgr Component)

Lists the properties read from self or partner profile.

Syntax

void __fastcall ListProperties();

Remarks

Invoking ListProperties causes the event Property to be fired for each property read by LoadProfile.

LoadProfile Method (AS2ProfileMgr Component)

Loads the profile of the trading partner identified by partnerOrganization .

Syntax

void __fastcall LoadProfile(String partnerOrganization);

Remarks

If the partnerOrganization is not "self", the properties of AS2ProfileMgr are read from the XML file partner.cfg. The file is expected to be in a sub-directory within DataDir. The name of the sub-directory is derived from partnerOrganization.

Although all properties are read from the partner profile, the following are interpreted by AS2Sender and AS2Receiver components.

Partner Settings

• Organization
• URL
• OptionSign
• OptionEncrypt
• OptionCompress
• RequireSign
• RequireEncrypt
• RequestMDN
• RequestMDNSigned
• RequestMDNSynchronous
• EncryptionCert
• SigningCert
• SSLCert

If the partnerOrganization specified is "self", the properties of AS2ProfileMgr are read from the XML file me.cfg. The file is expected to be in DataDir.

Although all properties are read from the self profile, the following are interpreted by AS2Sender and AS2Receiver components.

My Settings

• Organization
• URL
• Email
• EncryptionCert
• SigningCert
• SSLCert
• AsyncMDNURL

Note: "self" cannot be the name of a trading partner organization.

Reset Method (AS2ProfileMgr Component)

Resets the state of the control.

Syntax

void __fastcall Reset();

Remarks

Resets all properties. After invoking this method the component may be reused as if it were newly created.

SaveProfile Method (AS2ProfileMgr Component)

Saves the profile of the trading partner identified by partnerOrganization .

Syntax

void __fastcall SaveProfile(String partnerOrganization);

Remarks

If the partnerOrganization is not "self", the properties of AS2ProfileMgr are saved to the XML file partner.cfg placed in a sub-directory within DataDir. The name of the sub-directory is derived from partnerOrganization. In addition to saving the partner profile, SaveProfile also creates the following directories if CreateDirStruct is set to true.

Although any number of properties may be saved to the partner profile, the following are interpreted by AS2Sender and AS2Receiver components.

Partner Settings

• Organization
• URL
• OptionSign
• OptionEncrypt
• OptionCompress
• RequireSign
• RequireEncrypt
• RequestMDN
• RequestMDNSigned
• RequestMDNSynchronous
• EncryptionCert
• SigningCert
• SSLCert

If the partnerOrganization specified is "self", the properties of AS2ProfileMgr are saved to the XML file me.cfg placed in DataDir.

Although any number of properties may be saved to the self profile, the following are interpreted by AS2Sender and AS2Receiver components.

My Settings

• Organization
• URL
• Email
• EncryptionCert
• SigningCert
• SSLCert
• AsyncMDNURL

Note: "self" cannot be the name of a trading partner organization.

SetProperty Method (AS2ProfileMgr Component)

Sets the property propName to propValue .

Syntax

void __fastcall SetProperty(String propName, String propValue);

Remarks

SetProperty can be used to set any property in self or partner profile. It is specially useful in setting properties not interpreted by AS2Sender AS2Receivercomponents and thus not exposed as AS2ProfileMgr properties.

Error Event (AS2ProfileMgr Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibeAS2ProfileMgrErrorEventParams;
typedef void __fastcall (__closure *TibeAS2ProfileMgrErrorEvent)(System::TObject* Sender, TibeAS2ProfileMgrErrorEventParams *e);
__property TibeAS2ProfileMgrErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Partner Event (AS2ProfileMgr Component)

Fired when ListPartners is invoked.

Syntax

typedef struct {
  String partnerIdentifier;
  String partnerURL;
} TibeAS2ProfileMgrPartnerEventParams;
typedef void __fastcall (__closure *TibeAS2ProfileMgrPartnerEvent)(System::TObject* Sender, TibeAS2ProfileMgrPartnerEventParams *e);
__property TibeAS2ProfileMgrPartnerEvent OnPartner = { read=FOnPartner, write=FOnPartner };

Remarks

This event is fired when ListPartners is called. It fires for each partner found by the AS2ProfileMgr in DataDir. The parameter partnerIdentifier is same as provided to SaveProfile to save the partner profile. The URL provided by the trading partner to post AS2 messages can be read from partnerURL.

PartnerDirectory Event (AS2ProfileMgr Component)

Fired before accessing partner.cfg of a trading partner.

Syntax

typedef struct {
  String Name;
  String Directory;
} TibeAS2ProfileMgrPartnerDirectoryEventParams;
typedef void __fastcall (__closure *TibeAS2ProfileMgrPartnerDirectoryEvent)(System::TObject* Sender, TibeAS2ProfileMgrPartnerDirectoryEventParams *e);
__property TibeAS2ProfileMgrPartnerDirectoryEvent OnPartnerDirectory = { read=FOnPartnerDirectory, write=FOnPartnerDirectory };

Remarks

This event is fired every time partner.cfg needs to be accessed i.e when LoadProfile or GetTPInfo are invoked with partner name not being "self". The Name provides the partner name and Directory indicates the directory in which partner profile is expected. Setting Directory to a different path will make the component look for partner.cfg in that directory. Note: PartnerDirectory event is not fired when ListPartners is invoked.

Property Event (AS2ProfileMgr Component)

Fired when ListProperties is invoked.

Syntax

typedef struct {
  String propName;
  String propValue;
} TibeAS2ProfileMgrPropertyEventParams;
typedef void __fastcall (__closure *TibeAS2ProfileMgrPropertyEvent)(System::TObject* Sender, TibeAS2ProfileMgrPropertyEventParams *e);
__property TibeAS2ProfileMgrPropertyEvent OnProperty = { read=FOnProperty, write=FOnProperty };

Remarks

This event is fired when ListProperties is called. It fires for each property read by LoadProfile. The parameters propName and propValue provide property name and value respectively.

Config Settings (AS2ProfileMgr Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

Base Config Settings

Trappable Errors (AS2ProfileMgr Component)

AS2ProfileMgr Errors

	601   Cannot access data directory.
	602   This operation requires data directory to be set.
	603   Cannot save personal profile.
	604   Cannot load personal profile.
	605   Cannot save partner profile.
	606   Cannot load partner profile.