NetCode Pipeline Component
The NetCode Pipeline Component can be used to encode or decode data using a variety of web standards.
Remarks
The NetCode Pipeline Component supports the following encoding standards:
- Hex
- URL
- Base64
- Base64URL
- Base32
- HTML
- Quoted-Printable (QP)
- UTF7
- UTF8
- Japanese Industrial Standards (JIS)
- YEncode
- HMAC
- MD5 Hash
- SHA1 Hash
- SHA256 Hash
To configure the adapter, simply set the Format property to the appropriate encoding/decoding standard.
Encoder Property List
The following is the full list of the properties of the encoder Pipeline Component with short descriptions. Click on the links for further details.
Format | The type of encoding used. |
Other | Defines a set of configuration settings to be used by the pipeline component. |
RuntimeLicense | Specifies the component runtime license key. |
TempPath | The path to which temporary files are written at runtime. |
TransportLog | Tells the component where and how to report information about its operations. |
Decoder Property List
The following is the full list of the properties of the decoder Pipeline Component with short descriptions. Click on the links for further details.
Format | The type of encoding used. |
Other | Defines a set of configuration settings to be used by the pipeline component. |
RuntimeLicense | Specifies the component runtime license key. |
TempPath | The path to which temporary files are written at runtime. |
TransportLog | Tells the component where and how to report information about its operations. |
Config Settings
The following is a list of config settings for the Pipeline Component with short descriptions. Click on the links for further details.
Base64LineBreak | Tells the component whether to include line breaks in Base64 encoded content or not. |
EncodeHash | Whether the hash value is hex encoded. |
HMACAlgorithm | The hash algorithm to use when generating a Hash-based Message Authentication Code (HMAC). |
HMACKey | A key to use when generating a Hash-based Message Authentication Code (HMAC). |
PipelineOptions | Options defining the validation and protection functionality of the pipeline component. |
UseExtendedHexBase32 | Specifies whether or not the Extended Hex alphabet is used. |
UseModifiedUTF7 | Specifies whether or not a modified form of UTF-7 for IMAP mailbox naming is used. |
Format Property (NetCode Pipeline component)
The type of encoding used.
Data Type
EnumerationPossible Values
Base 64 (1)QP (2)
URL (3)
JIS (4)
YEncode (5)
MD5Hash (6)
SHA1Hash (7)
Hex (8)
HTML (9)
HMAC (10)
UTF8 (11)
UTF7 (12)
Base 32 (13)
Base 64URL (14)
SHA256Hash (15)
Default Value
1Remarks
The following formats are only supported in the Encoder:
- MD5Hash
- SHA1Hash
- HMAC
- SHA256Hash
Other Property (NetCode Pipeline component)
Defines a set of configuration settings to be used by the pipeline component.
Data Type
StringDefault Value
""Remarks
The pipeline component accepts one or more configuration settings. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the pipeline component, access to these internal properties is provided through the Other property.
The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line.
For example:
configname1=value1
configname2=value2
RuntimeLicense Property (NetCode Pipeline component)
Specifies the component runtime license key.
Data Type
StringDefault Value
""Remarks
You can use the RuntimeLicense property to set the runtime key for the adapter license.
This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.
TempPath Property (NetCode Pipeline component)
The path to which temporary files are written at runtime.
Data Type
StringDefault Value
""Remarks
If you are planning on working with binary files or large files, it is recommended that you set a valid path for this property. When set to a valid path this property tells the adapter to use temp files when performing operations. If this is not set, all operations are done in memory.
This property accepts the "%TEMP%" macro, which will be replaced with the default system temporary directory at runtime.
TransportLog Property (NetCode Pipeline component)
Tells the component where and how to report information about its operations.
Data Type
LogRemarks
This is a Log type property which contains fields describing how and where the adapter will record information about its execution.
This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.
Certificate Type
The digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
Store String |
The name of the certificate store for the client certificate. The StoreType field specifies the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword. Store is used in conjunction with the Subject field in order to specify client certificates. If Store has a value, and Subject is set, a search for a certificate is initiated. Please refer to the Subject field for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. 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. PKCS12 certificate store). If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file. |
||||||||||||||||||||||||||||||||||||||||||||||||
StorePassword String |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||
StoreType CertStoreTypes |
The type of certificate store for this certificate. The adapter supports both public and private keys in a variety of formats. When the cstAuto value is used the adapter will automatically determine the type. This field can take one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
Subject String |
The subject of the certificate used for client authentication. When this property is set, a search is performed in the current certificate store certificate with matching subject. If an exact match is not found, the store is searched for subjects containing the value of the property. When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US Example (Searching with partial subject)
If a match is 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. If a matching certificate is found, Subject is set to the full subject of the matching certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
Thumbprint String |
The thumbprint of the certificate. This field is used to specify the thumbprint of the certificate. When there are multiple certificates in the store that have the same subject, the thumbprint will be used to distinguish between them. |
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public Certificate();
Creates a Certificate instance whose properties can be set.
public Certificate(string certificateFile);
Opens CertificateFile and reads out the contents as an X509 public key.
public Certificate(byte[] certificateData);
Parses CertificateData as an X509 public key.
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.
Fields
AutoDetect Boolean |
Tells the adapter whether or not to automatically detect and use firewall system settings, if available. |
||||||||
FirewallType FirewallTypes |
Determines the type of firewall to connect through. The applicable values are the following:
|
||||||||
Host String |
Name or IP address of firewall (optional). If a Host is given, requested connections will be authenticated through the specified firewall when connecting. If the Host field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the Host field is set to the corresponding address. If the search is not successful, an error is returned. |
||||||||
Password String |
A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired. |
||||||||
Port Integer |
The TCP port for the firewall Host. See the description of the Host field for details. Note that the Port is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details. |
||||||||
User String |
A user name if authentication is to be used connecting through a firewall. If the Host is specified, the User and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, a trappable error is fired. |
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public Firewall();
Log Type
A log where the component will record information about its operations.
Remarks
This describes how and where the adapter will record information describing its execution.
Fields
Location String |
This field describes the location where the logging information is to be written. If the EventLog LogType has been chosen, this field must contain the name of the Event Log to which the information should be written. The default value for this field is "Application". If a value other than "Application" is set the computer must be restarted for the change to take effect. Note that the same event log must be used for all send ports and receive locations that use the same adapter. If the File LogType has been chosen, this field must contain the location of the file to write logging information to on the file system. The adapter also supports logging to files based on the current date and time. This allows for log files to be organized by days, months, or other intervals as specified. When specifying a log filename include a valid .NET date and time format string within the < and > characters. For instance C:\logs\sftp_<yyyyMMdd>.log or C:\logs\as2_<yyyyMMdd>T<hhmm>.log. |
||||||||||
LogMode LogModes |
This field controls what information the adapter logs. The possible values have the following affect on the adapter's behavior:
|
||||||||||
LogType LogTypes |
This property controls where the adapter will log the information. The possible values have the following affect on the adapter's behavior:
|
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public Log();
public Log(LogTypes logType, string location, LogModes logMode);
Config Settings (NetCode Pipeline component)
The adapter 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 adapter, access to these internal properties is provided through the Other property.EzCrypt Config Settings | ||||||||
Base64LineBreak: Tells the adapter whether to include line breaks in Base64 encoded content or not.By default, when encoding to Base64 format, the component will insert line breaks every 76 characters. Setting this config to false will cause these line breaks to be omitted from the Base64 encoded content. The default value is true. | ||||||||
EncodeHash: Whether the hash value is hex encoded.This setting determines whether the MD5, SHA1, or SHA256 hash value is hex encoded. The default is True. | ||||||||
HMACAlgorithm:
The hash algorithm to use when generating a Hash-based Message Authentication Code (HMAC).HMACAlgorithm can be "SHA1" (Secure Hash Algorithm 1), "MD5" (Message Digest 5), or one of the SHA-2 algorithms mentioned below. You may truncate the hash output by specifying the desired number of bits. For instance "SHA1-96" and "MD5-96" are acceptable.
SHA-2 algorithms:
|
||||||||
HMACKey: A key to use when generating a Hash-based Message Authentication Code (HMAC).When Format is set to fmtHMAC, it may be necessary to supply the component with a key to use when generating the Hash-based Message Authentication Code (HMAC). This key is incorporated into the hashing process to add entropy to the resulting hash code, making the plaintext harder to guess and increasing the message security. You may also set this to a hex value, e.g. "0xAAAAAA". | ||||||||
PipelineOptions:
Options defining the validation and protection functionality of the pipeline component.By default the pipeline will protect (encrypt) sensitive fields such as passwords, and will validate
required properties are set. In some cases it may be desirable to change this behavior. This
setting may be used to disable the protection, validation, or both. Possible values are:
|
||||||||
UseExtendedHexBase32: Specifies whether or not the Extended Hex alphabet is used.When Format is set to fmtBase32, this config determines whether or not to use the Extended Hex alphabet. The default value is False. | ||||||||
UseModifiedUTF7: Specifies whether or not a modified form of UTF-7 for IMAP mailbox naming is used.When Format is set to fmtUTF7, this config determines whether or not to use a modified version of UTF-7 for IMAP mailbox naming. The default value is False. |
Supported Macros
The adapter also supports the following Macros. These values are not case sensitive and would be supplied to a property in the form %MacroName%.
Temp | This is resolved to the full path to the system's temporary directory. |
MessageID | Globally unique identifier (GUID) of the message in BizTalk Server. |
SourceFileName | The original file name. This includes the extension and excludes the file path, for example, Sample.xml |
SourceFileNameNoExt | The original file name without the extension or file path, for example, Sample |
RemoteFileName | The name of the file as it was uploaded to the remote server. This includes the extension and excludes the file path, for example, Sample.xml. Valid only for AS3, FTP, and SFTP Send Adapters. |
DestinationParty | Name of the destination party. |
DestinationPartyQualifier | Qualifier of the destination party. |
SourceParty | Name of the source party. |
SourcePartyQualifier | Qualifier of the source party. |
DateTime:CustomFormat | This special value allows you to specify your own custom time format. For instance DateTime:yyyy would be resolved to the 4 digit year. |
Date | The date format yyyy-MM-dd. |
DateTime | The date format yyyy-MM-ddThhmmss. |
Time | The date format hhmmss. |
DateTime_BTS2000 | The date format yyyyMMddhhmmssf. |
DateTime.TZ | The date format yyyy-MM-ddThhmmsszzz. |
Time.TZ | The date format hhmmsszzz. |
Property#<Schema>#<Name> | This special value allows you to include a property from the incoming message. For instance "PROPERTY#http://schemas.microsoft.com/BizTalk/2003/system-properties#ReceivePortName" would resolve to the ReceivePortName property of the message. |