NetCode Task

The NetCode Task can be used to encode or decode data using a variety of web standards.

Remarks

The NetCode Task 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 task, 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 task with short descriptions. Click on the links for further details.


Format	The type of encoding used.
InputFile	The full path to the input file.
Other	Defines a set of configuration settings to be used by the task.
OutputFile	The full path to the output file.
Overwrite	Whether or not the component should overwrite the output file.
RuntimeLicense	Specifies the component runtime license key.

Decoder Property List

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


Format	The type of encoding used.
InputFile	The full path to the input file.
Other	Defines a set of configuration settings to be used by the task.
OutputFile	The full path to the output file.
Overwrite	Whether or not the component should overwrite the output file.
RuntimeLicense	Specifies the component runtime license key.

Config Settings

The following is a list of config settings for the task 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).
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 Task)

The type of encoding used.

Data Type

Enumeration

Possible 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

Remarks

The following formats are only supported in the Encoder:

MD5Hash
SHA1Hash
HMAC
SHA256Hash

InputFile Property (NetCode Task)

The full path to the input file.

Data Type

String

Default Value

Remarks

The task will encode or decode the file specified by this property.

Other Property (NetCode Task)

Defines a set of configuration settings to be used by the task.

Data Type

String

Default Value

Remarks

The task 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 task, 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:

  Copy
configname1=value1
configname2=value2

OutputFile Property (NetCode Task)

The full path to the output file.

Data Type

String

Default Value

Remarks

The output of the encode or decode operation will be written to the file specified by this property.

Overwrite Property (NetCode Task)

Whether or not the component should overwrite the output file.

Data Type

Boolean

Default Value

false

Remarks

This property specifies whether the task should overwrite the OutputFile if it already exists on disk.

RuntimeLicense Property (NetCode Task)

Specifies the component runtime license key.

Data Type

String

Default Value

Remarks

You can use the RuntimeLicense property to set the runtime key for the task license.

Config Settings (NetCode Task)

The task 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 task, access to these internal properties is provided through the Other property.

EzCrypt Config Settings

Base64LineBreak: Tells the task 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:

"SHA-224"
"SHA-256"
"SHA-384"
"SHA-512"

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

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.