CargoTranslator Component

Properties   Methods   Events   Config Settings   Errors  

The CargoTranslator component is optimized for Cargo-IMP translation, providing a simple way to convert Cargo-IMP documents to and from XML or JSON.

Syntax

nsoftware.IPWorksEDITranslator.Cargotranslator

Remarks

The CargoTranslator component provides a simple way to convert Cargo-IMP to XML or JSON and vice versa.

Getting Started

The component will convert a document from the format specified by InputFormat to the format specified by OutputFormat. In practice this allows for converting to XML or JSON from Cargo-IMP and vice versa.

Before translating from Cargo-IMP to XML or JSON it is recommended to load a schema using the LoadSchema method. This ensures additional information can be included in the XML or JSON document. If a schema is specified the XML or JSON will include types and descriptions as element attributes which are useful for interpreting the data.

After calling Translate the resulting output will contain the Cargo-IMP, XML or JSON data as defined by OutputFormat.

Input and Output Properties

The component will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

Schemas are written in JSON format: { "name": "FSU", "desc": "FSU MESSAGE", "children": { "1": { "desc": "Standard Message Identification", "children": { "1.1": { "desc": "Standard Message Identifier", "value": "FSU" }, "1.2": { "value": "/" }, "1.3": { "desc": "Message Type Version Number", "format": "n[...3]" }, "1.4": { "value": "\r\n" } } }, "2": { ... For example schemas and questions, please contact support@nsoftware.com.

Property List


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

ErrorsA collection of errors that occurred when parsing the Cargo-IMP messages.
InputDataThe data to translate.
InputFileThe file to translate.
InputFormatThe format of the input data.
OutputDataThe translated data.
OutputFileThe file to which the translated data will be written.
OutputFormatThe format of the output data.
OverwriteWhether to overwrite the file.
SuffixWhat to append after each segment delimiter.

Method List


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

ConfigSets or retrieves a configuration setting.
LoadSchemaLoads a schema file describing a Message type.
ResetResets the component.
SetInputStreamSets the stream from which the component will read the data to parse.
SetOutputStreamThe stream to which the component will write the translated data.
TranslateTranslates the specified data.

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.

ErrorInformation about errors during data delivery.
ResolveSchemaFires whenever a new Cargo-Imp message is encountered and no schema is found for it.

Config Settings


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

BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseFIPSCompliantAPITells the component whether or not to use FIPS certified APIs.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Errors Property (CargoTranslator Component)

A collection of errors that occurred when parsing the Cargo-IMP messages.

Syntax

public CargoErrorList Errors { get; }
Public ReadOnly Property Errors As CargoErrorList

Remarks

This property is populated with error information. After calling Translate, check this property to determine if any errors occurred while parsing the message. If there are any errors present, the output from translation will likely be incorrect.

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

Please refer to the CargoError type for a complete list of fields.

InputData Property (CargoTranslator Component)

The data to translate.

Syntax

public string InputData { get; set; }
Public Property InputData As String

Default Value

""

Remarks

This property specifies the data to be translated. This may be set to Cargo-IMP data or XML/JSON data. To specify the type of data held by the property set InputFormat.

Input and Output Properties

The component will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

InputFile Property (CargoTranslator Component)

The file to translate.

Syntax

public string InputFile { get; set; }
Public Property InputFile As String

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed. To specify the type of data in the input file set InputFormat.

Input and Output Properties

The component will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

This property is not available at design time.

InputFormat Property (CargoTranslator Component)

The format of the input data.

Syntax

public CargotranslatorInputFormats InputFormat { get; set; }

enum CargotranslatorInputFormats { eifXML, eifJSON, eifCargo }
Public Property InputFormat As CargotranslatorInputFormats

Enum CargotranslatorInputFormats eifXML eifJSON eifCargo End Enum

Default Value

2

Remarks

This property specifies the format of the input data. The value set here, along with OutputFormat, determines how the data is converted when Translate is called.

Possible values are:

  • 0 (ifXML)
  • 1 (ifJSON)
  • 2 (ifCargo)
Before calling Translate, both InputFormat and OutputFormat must be specified. Translation from XML or JSON to Cargo-IMP and vice versa are supported. If InputFormat is ofXML or ofJSON, OutputFormat must be ofCargo. Similarly, if InputFormat is ofCargo, OutputFormat must be ofXML or ofJSON.

This property is not available at design time.

OutputData Property (CargoTranslator Component)

The translated data.

Syntax

public string OutputData { get; set; }
Public Property OutputData As String

Default Value

""

Remarks

This property will be populated with the translated data after calling Translate if OutputFile and SetOutputStream are not set.

Input and Output Properties

The component will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

This property is not available at design time.

OutputFile Property (CargoTranslator Component)

The file to which the translated data will be written.

Syntax

public string OutputFile { get; set; }
Public Property OutputFile As String

Default Value

""

Remarks

This property specifies the file to which the translated data will be written. This may be set to an absolute or relative path. This should be set before calling Translate.

Input and Output Properties

The component will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

This property is not available at design time.

OutputFormat Property (CargoTranslator Component)

The format of the output data.

Syntax

public CargotranslatorOutputFormats OutputFormat { get; set; }

enum CargotranslatorOutputFormats { eofXML, eofJSON, eofCargo }
Public Property OutputFormat As CargotranslatorOutputFormats

Enum CargotranslatorOutputFormats eofXML eofJSON eofCargo End Enum

Default Value

0

Remarks

This property specifies the format of the output data. The value set here, along with InputFormat, determines how the data is converted when Translate is called.

Possible values are:

  • 0 (ofXML)
  • 1 (ofJSON)
  • 2 (ofCargo)
Before calling Translate, both InputFormat and OutputFormat must be specified. Translation from XML or JSON to Cargo-IMP and vice versa are supported. If InputFormat is ofXML or ofJSON, OutputFormat must be ofCargo. Similarly, if InputFormat is ofCargo, OutputFormat must be ofXML or ofJSON.

This property is not available at design time.

Overwrite Property (CargoTranslator Component)

Whether to overwrite the file.

Syntax

public bool Overwrite { get; set; }
Public Property Overwrite As Boolean

Default Value

False

Remarks

This property specifies whether the file is overwritten when Translate is called. If set to False (default) the component throws an exception when attempting to write to a file which already exists. If set to True the component will overwrite the existing file.

Suffix Property (CargoTranslator Component)

What to append after each segment delimiter.

Syntax

public CargotranslatorSuffixes Suffix { get; set; }

enum CargotranslatorSuffixes { suffixNone, suffixCR, suffixLF, suffixCRLF }
Public Property Suffix As CargotranslatorSuffixes

Enum CargotranslatorSuffixes suffixNone suffixCR suffixLF suffixCRLF End Enum

Default Value

3

Remarks

If Suffix is different from suffixNone, trailing (suffix) characters are appended after each segment delimiter. This is useful if you want to have a carriage return/line feed after each segment to make the document more readable.

This property is not available at design time.

Config Method (CargoTranslator Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

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.

LoadSchema Method (CargoTranslator Component)

Loads a schema file describing a Message type.

Syntax

public void LoadSchema(string fileName);

Async Version
public async Task LoadSchema(string fileName);
public async Task LoadSchema(string fileName, CancellationToken cancellationToken);
Public Sub LoadSchema(ByVal FileName As String)

Async Version
Public Sub LoadSchema(ByVal FileName As String) As Task
Public Sub LoadSchema(ByVal FileName As String, cancellationToken As CancellationToken) As Task

Remarks

This method parses the File and loads it into an internal schema list.

If the schema file does not exist or cannot be parsed as an Cargo-IMP schema, the component throws an exception.

Schemas are written in JSON format: { "name": "FSU", "desc": "FSU MESSAGE", "children": { "1": { "desc": "Standard Message Identification", "children": { "1.1": { "desc": "Standard Message Identifier", "value": "FSU" }, "1.2": { "value": "/" }, "1.3": { "desc": "Message Type Version Number", "format": "n[...3]" }, "1.4": { "value": "\r\n" } } }, "2": { ... For example schemas and questions, please contact support@nsoftware.com.

Reset Method (CargoTranslator Component)

Resets the component.

Syntax

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

When called, the component initializes itself to its default state.

SetInputStream Method (CargoTranslator Component)

Sets the stream from which the component will read the data to parse.

Syntax

public void SetInputStream(System.IO.Stream inputStream);

Async Version
public async Task SetInputStream(System.IO.Stream inputStream);
public async Task SetInputStream(System.IO.Stream inputStream, CancellationToken cancellationToken);
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream)

Async Version
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream) As Task
Public Sub SetInputStream(ByVal InputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method sets the stream from which the component will read the data to parse.

Input Properties

The component will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops.

SetOutputStream Method (CargoTranslator Component)

The stream to which the component will write the translated data.

Syntax

public void SetOutputStream(System.IO.Stream outputStream);

Async Version
public async Task SetOutputStream(System.IO.Stream outputStream);
public async Task SetOutputStream(System.IO.Stream outputStream, CancellationToken cancellationToken);
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream)

Async Version
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream) As Task
Public Sub SetOutputStream(ByVal OutputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method sets the stream to which the component will write the translated data.

Output Properties

The component will determine the source of the output based on which properties are set.

The order in which the output properties are checked is as follows:

When a valid source is found the search stops.

Translate Method (CargoTranslator Component)

Translates the specified data.

Syntax

public void Translate();

Async Version
public async Task Translate();
public async Task Translate(CancellationToken cancellationToken);
Public Sub Translate()

Async Version
Public Sub Translate() As Task
Public Sub Translate(cancellationToken As CancellationToken) As Task

Remarks

This method translates the specified data.

The component will convert a document from the format specified by InputFormat to the format specified by OutputFormat. In practice this allows for converting to XML or JSON from Cargo-IMP and vice versa.

Before translating from Cargo-IMP to XML or JSON it is recommended to load a schema using the LoadSchema method. This ensures additional information can be included in the XML or JSON document. If a schema is specified the XML or JSON will include types and descriptions as element attributes which are useful for interpreting the data.

After calling Translate the resulting output will contain the Cargo-IMP, XML or JSON data as defined by OutputFormat.

Input and Output Properties

The component will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

Schemas are written in JSON format: { "name": "FSU", "desc": "FSU MESSAGE", "children": { "1": { "desc": "Standard Message Identification", "children": { "1.1": { "desc": "Standard Message Identifier", "value": "FSU" }, "1.2": { "value": "/" }, "1.3": { "desc": "Message Type Version Number", "format": "n[...3]" }, "1.4": { "value": "\r\n" } } }, "2": { ... For example schemas and questions, please contact support@nsoftware.com.

Error Event (CargoTranslator Component)

Information about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, CargotranslatorErrorEventArgs e);

public class CargotranslatorErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As CargotranslatorErrorEventArgs)

Public Class CargotranslatorErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws 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.

ResolveSchema Event (CargoTranslator Component)

Fires whenever a new Cargo-Imp message is encountered and no schema is found for it.

Syntax

public event OnResolveSchemaHandler OnResolveSchema;

public delegate void OnResolveSchemaHandler(object sender, CargotranslatorResolveSchemaEventArgs e);

public class CargotranslatorResolveSchemaEventArgs : EventArgs {
  public string MessageIdentifier { get; }
  public string Version { get; }
}
Public Event OnResolveSchema As OnResolveSchemaHandler

Public Delegate Sub OnResolveSchemaHandler(sender As Object, e As CargotranslatorResolveSchemaEventArgs)

Public Class CargotranslatorResolveSchemaEventArgs Inherits EventArgs
  Public ReadOnly Property MessageIdentifier As String
  Public ReadOnly Property Version As String
End Class

Remarks

The ResolveSchema event will fire when a the component encounters a new Cargo-IMP message, but it finds no schema corresponding to it already loaded.

MessageIdentifier contains the message type, such as "FWB" or "FSU".

Version contains the version of the schema used by the message.

When processing this event, the caller can use LoadSchema() to load a new schema into the component that can be used to parse the transaction.

CargoError Type

This type contains the details of an error that occurred while parsing a Cargo-IMP message.

Remarks

The fields below provide information about the error.

Fields

Description
string (read-only)

Default Value: "0"

The description of current error.

Line
int (read-only)

Default Value: 0

The text line where the error occurred.

Offset
int (read-only)

Default Value: 0

The text offset where the error occurred.

Position
int (read-only)

Default Value: 0

The text position where the error occurred.

Config Settings (CargoTranslator 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

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseFIPSCompliantAPI:   Tells the component whether or not to use FIPS certified APIs.

When set to true, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (CargoTranslator Component)

CargoTranslator Errors

304   Could not write to file.
1000   Invalid schema file.
1001   No schema found.
1002   Schema format error.
1003   Line or message was too long.
1004   Failed to parse the message version.
1005   Element is not in the schema file or is not a simple element.
1006   Could not find the element.