AS2ProfileMgr Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksEDI_AS2ProfileMgr

Procedural Interface

 ipworksedi_as2profilemgr_open();
 ipworksedi_as2profilemgr_close($res);
 ipworksedi_as2profilemgr_register_callback($res, $id, $function);
 ipworksedi_as2profilemgr_get_last_error($res);
 ipworksedi_as2profilemgr_get_last_error_code($res);
 ipworksedi_as2profilemgr_set($res, $id, $index, $value);
 ipworksedi_as2profilemgr_get($res, $id, $index);
 ipworksedi_as2profilemgr_do_config($res, $configurationstring);
 ipworksedi_as2profilemgr_do_deleteprofile($res, $partnerorganization);
 ipworksedi_as2profilemgr_do_getproperty($res, $propname);
 ipworksedi_as2profilemgr_do_gettpinfo($res, $partnerorganization);
 ipworksedi_as2profilemgr_do_listpartners($res);
 ipworksedi_as2profilemgr_do_listproperties($res);
 ipworksedi_as2profilemgr_do_loadprofile($res, $partnerorganization);
 ipworksedi_as2profilemgr_do_reset($res);
 ipworksedi_as2profilemgr_do_saveprofile($res, $partnerorganization);
 ipworksedi_as2profilemgr_do_setproperty($res, $propname, $propvalue);

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.

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

AsyncMDNURL Property (IPWorksEDI_AS2ProfileMgr Class)

The URL for posting Async MDNs.

Object Oriented Interface

public function getAsyncMDNURL();
public function setAsyncMDNURL($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 1 );
ipworksedi_as2profilemgr_set($res, 1, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

Option to create file management directories.

Object Oriented Interface

public function getCreateDirStruct();
public function setCreateDirStruct($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 2 );
ipworksedi_as2profilemgr_set($res, 2, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

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

Object Oriented Interface

public function getDataDir();
public function setDataDir($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 3 );
ipworksedi_as2profilemgr_set($res, 3, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

The directory used to store deleted files.

Object Oriented Interface

public function getDirDeleted();

Procedural Interface

ipworksedi_as2profilemgr_get($res, 4 );

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 (IPWorksEDI_AS2ProfileMgr Class)

The directory used to store incoming files.

Object Oriented Interface

public function getDirIncoming();

Procedural Interface

ipworksedi_as2profilemgr_get($res, 5 );

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 (IPWorksEDI_AS2ProfileMgr Class)

The directory used to store log files.

Object Oriented Interface

public function getDirLogs();

Procedural Interface

ipworksedi_as2profilemgr_get($res, 6 );

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 (IPWorksEDI_AS2ProfileMgr Class)

The directory used to store outgoing files.

Object Oriented Interface

public function getDirOutgoing();

Procedural Interface

ipworksedi_as2profilemgr_get($res, 7 );

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 (IPWorksEDI_AS2ProfileMgr Class)

The directory used to store files waiting for Async MDN.

Object Oriented Interface

public function getDirPending();

Procedural Interface

ipworksedi_as2profilemgr_get($res, 8 );

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 (IPWorksEDI_AS2ProfileMgr Class)

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

Object Oriented Interface

public function getDirPendingInfo();

Procedural Interface

ipworksedi_as2profilemgr_get($res, 9 );

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 (IPWorksEDI_AS2ProfileMgr Class)

The directory used to store sent files.

Object Oriented Interface

public function getDirSent();

Procedural Interface

ipworksedi_as2profilemgr_get($res, 10 );

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 (IPWorksEDI_AS2ProfileMgr Class)

Your email address.

Object Oriented Interface

public function getEmail();
public function setEmail($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 11 );
ipworksedi_as2profilemgr_set($res, 11, $value );

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

EncryptionCertStore Property (IPWorksEDI_AS2ProfileMgr Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getEncryptionCertStore();
public function setEncryptionCertStore($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 27 );
ipworksedi_as2profilemgr_set($res, 27, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

EncryptionCertStorePassword Property (IPWorksEDI_AS2ProfileMgr Class)

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

Object Oriented Interface

public function getEncryptionCertStorePassword();
public function setEncryptionCertStorePassword($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 28 );
ipworksedi_as2profilemgr_set($res, 28, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getEncryptionCertStoreType();
public function setEncryptionCertStoreType($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 29 );
ipworksedi_as2profilemgr_set($res, 29, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

EncryptionCertSubject Property (IPWorksEDI_AS2ProfileMgr Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getEncryptionCertSubject();
public function setEncryptionCertSubject($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 37 );
ipworksedi_as2profilemgr_set($res, 37, $value );

Default Value

''

Remarks

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

EncryptionCertEncoded Property (IPWorksEDI_AS2ProfileMgr Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getEncryptionCertEncoded();
public function setEncryptionCertEncoded($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 38 );
ipworksedi_as2profilemgr_set($res, 38, $value );

Default Value

''

Remarks

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

Binary String

OptionCompress Property (IPWorksEDI_AS2ProfileMgr Class)

Preference to compress outgoing data.

Object Oriented Interface

public function getOptionCompress();
public function setOptionCompress($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 39 );
ipworksedi_as2profilemgr_set($res, 39, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

Preference to encrypt outgoing data.

Object Oriented Interface

public function getOptionEncrypt();
public function setOptionEncrypt($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 40 );
ipworksedi_as2profilemgr_set($res, 40, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

Preference to sign outgoing data.

Object Oriented Interface

public function getOptionSign();
public function setOptionSign($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 41 );
ipworksedi_as2profilemgr_set($res, 41, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

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

Object Oriented Interface

public function getOrganization();
public function setOrganization($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 42 );
ipworksedi_as2profilemgr_set($res, 42, $value );

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 classs.

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 (IPWorksEDI_AS2ProfileMgr Class)

The number of partners found in DataDir .

Object Oriented Interface

public function getPartnerCount();

Procedural Interface

ipworksedi_as2profilemgr_get($res, 43 );

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 (IPWorksEDI_AS2ProfileMgr Class)

Preference to receive MDNs from trading partner.

Object Oriented Interface

public function getRequestMDN();
public function setRequestMDN($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 44 );
ipworksedi_as2profilemgr_set($res, 44, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

Preference to request for signed MDNs.

Object Oriented Interface

public function getRequestMDNSigned();
public function setRequestMDNSigned($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 45 );
ipworksedi_as2profilemgr_set($res, 45, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

Preference to request for synchronous MDNs.

Object Oriented Interface

public function getRequestMDNSynchronous();
public function setRequestMDNSynchronous($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 46 );
ipworksedi_as2profilemgr_set($res, 46, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

Preference to receive encrypted messages.

Object Oriented Interface

public function getRequireEncrypt();
public function setRequireEncrypt($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 47 );
ipworksedi_as2profilemgr_set($res, 47, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

Preference to receive signed messages.

Object Oriented Interface

public function getRequireSign();
public function setRequireSign($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 48 );
ipworksedi_as2profilemgr_set($res, 48, $value );

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

SigningCertStore Property (IPWorksEDI_AS2ProfileMgr Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSigningCertStore();
public function setSigningCertStore($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 64 );
ipworksedi_as2profilemgr_set($res, 64, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SigningCertStorePassword Property (IPWorksEDI_AS2ProfileMgr Class)

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

Object Oriented Interface

public function getSigningCertStorePassword();
public function setSigningCertStorePassword($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 65 );
ipworksedi_as2profilemgr_set($res, 65, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSigningCertStoreType();
public function setSigningCertStoreType($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 66 );
ipworksedi_as2profilemgr_set($res, 66, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SigningCertSubject Property (IPWorksEDI_AS2ProfileMgr Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSigningCertSubject();
public function setSigningCertSubject($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 74 );
ipworksedi_as2profilemgr_set($res, 74, $value );

Default Value

''

Remarks

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

SigningCertEncoded Property (IPWorksEDI_AS2ProfileMgr Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSigningCertEncoded();
public function setSigningCertEncoded($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 75 );
ipworksedi_as2profilemgr_set($res, 75, $value );

Default Value

''

Remarks

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

Binary String

SSLCertStore Property (IPWorksEDI_AS2ProfileMgr Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 91 );
ipworksedi_as2profilemgr_set($res, 91, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorksEDI_AS2ProfileMgr Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 92 );
ipworksedi_as2profilemgr_set($res, 92, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 93 );
ipworksedi_as2profilemgr_set($res, 93, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (IPWorksEDI_AS2ProfileMgr Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 101 );
ipworksedi_as2profilemgr_set($res, 101, $value );

Default Value

''

Remarks

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 (IPWorksEDI_AS2ProfileMgr Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 102 );
ipworksedi_as2profilemgr_set($res, 102, $value );

Default Value

''

Remarks

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

Binary String

URL Property (IPWorksEDI_AS2ProfileMgr Class)

The URL for posting EDI data.

Object Oriented Interface

public function getURL();
public function setURL($value);

Procedural Interface

ipworksedi_as2profilemgr_get($res, 103 );
ipworksedi_as2profilemgr_set($res, 103, $value );

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 (IPWorksEDI_AS2ProfileMgr Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksedi_as2profilemgr_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (IPWorksEDI_AS2ProfileMgr Class)

Deletes the configuration of the specified partner.

Object Oriented Interface

public function doDeleteProfile($partnerorganization);

Procedural Interface

ipworksedi_as2profilemgr_do_deleteprofile($res, $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 (IPWorksEDI_AS2ProfileMgr Class)

Gets the property propName .

Object Oriented Interface

public function doGetProperty($propname);

Procedural Interface

ipworksedi_as2profilemgr_do_getproperty($res, $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 classs and thus not exposed as AS2ProfileMgr properties.

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

GetTPInfo Method (IPWorksEDI_AS2ProfileMgr Class)

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

Object Oriented Interface

public function doGetTPInfo($partnerorganization);

Procedural Interface

ipworksedi_as2profilemgr_do_gettpinfo($res, $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 (IPWorksEDI_AS2ProfileMgr Class)

Lists trading partners known to the AS2ProfileMgr .

Object Oriented Interface

public function doListPartners();

Procedural Interface

ipworksedi_as2profilemgr_do_listpartners($res);

Remarks

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

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

ListProperties Method (IPWorksEDI_AS2ProfileMgr Class)

Lists the properties read from self or partner profile.

Object Oriented Interface

public function doListProperties();

Procedural Interface

ipworksedi_as2profilemgr_do_listproperties($res);

Remarks

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

LoadProfile Method (IPWorksEDI_AS2ProfileMgr Class)

Loads the profile of the trading partner identified by partnerOrganization .

Object Oriented Interface

public function doLoadProfile($partnerorganization);

Procedural Interface

ipworksedi_as2profilemgr_do_loadprofile($res, $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 classs.

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 classs.

My Settings

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

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

Reset Method (IPWorksEDI_AS2ProfileMgr Class)

Resets the state of the control.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_as2profilemgr_do_reset($res);

Remarks

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

SaveProfile Method (IPWorksEDI_AS2ProfileMgr Class)

Saves the profile of the trading partner identified by partnerOrganization .

Object Oriented Interface

public function doSaveProfile($partnerorganization);

Procedural Interface

ipworksedi_as2profilemgr_do_saveprofile($res, $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 classes.

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 classes.

My Settings

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

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

SetProperty Method (IPWorksEDI_AS2ProfileMgr Class)

Sets the property propName to propValue .

Object Oriented Interface

public function doSetProperty($propname, $propvalue);

Procedural Interface

ipworksedi_as2profilemgr_do_setproperty($res, $propname, $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 AS2Receiverclasss and thus not exposed as AS2ProfileMgr properties.

Error Event (IPWorksEDI_AS2ProfileMgr Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksedi_as2profilemgr_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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 (IPWorksEDI_AS2ProfileMgr Class)

Fired when ListPartners is invoked.

Object Oriented Interface

public function firePartner($param);

Procedural Interface

ipworksedi_as2profilemgr_register_callback($res, 2, array($this, 'firePartner'));

Parameter List

 'partneridentifier'
 'partnerurl'

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 (IPWorksEDI_AS2ProfileMgr Class)

Fired before accessing partner.cfg of a trading partner.

Object Oriented Interface

public function firePartnerDirectory($param);

Procedural Interface

ipworksedi_as2profilemgr_register_callback($res, 3, array($this, 'firePartnerDirectory'));

Parameter List

 'name'
 'directory'

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 (IPWorksEDI_AS2ProfileMgr Class)

Fired when ListProperties is invoked.

Object Oriented Interface

public function fireProperty($param);

Procedural Interface

ipworksedi_as2profilemgr_register_callback($res, 4, array($this, 'fireProperty'));

Parameter List

 'propname'
 'propvalue'

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 Class)

The class 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 class, access to these internal properties is provided through the Config method.

Base Config Settings

Trappable Errors (AS2ProfileMgr Class)

AS2ProfileMgr Errors