CargoReader Component

Properties   Methods   Events   Config Settings   Errors  

The CargoReader component is optimized for Cargo-IMP documents, providing a simple way to parse Cargo-IMP documents.

Syntax

nsoftware.IPWorksEDITranslator.Cargoreader

Remarks

The component allows you to parse a Cargo-IMP message. Below are example steps:

1. First, use LoadSchema to load a schema file into the component. (Only necessary when preserving document structure).
2. Open a Cargo-IMP message or stream by setting input via SetInputStream, InputFile or InputData.
3. Call the Parse method to parse the message.
4. When parsing is complete, you can retrieve the parsed values from the Values collection.

During parsing, the component performs basic validation of the incoming document. If validation fails, a warning is generated (fired as an event).

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.

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.

Errors Property (CargoReader Component)

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

Syntax

• C#
• VB.NET

public CargoErrorList Errors { get; }

Public ReadOnly Property Errors As CargoErrorList

Remarks

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

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

InputData Property (CargoReader Component)

The data to parse.

Syntax

• C#
• VB.NET

public string InputData { get; set; }

Public Property InputData As String

Default Value

""

Remarks

This property specifies the data to be parsed.

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:

• SetInputStream
• InputFile
• InputData

InputFile Property (CargoReader Component)

The file to parse.

Syntax

• C#
• VB.NET

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.

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:

• SetInputStream
• InputFile
• InputData

This property is not available at design time.

Values Property (CargoReader Component)

Collection of values after parsing the Cargo-Imp messages.

Syntax

• C#
• VB.NET

public CargoValueList Values { get; }

Public ReadOnly Property Values As CargoValueList

Remarks

This property will be populated with the values from the Cargo-IMP message after parsing is complete.

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

Config Method (CargoReader Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

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 (CargoReader Component)

Loads a schema file describing a Message type.

Syntax

• C#
• VB.NET

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.

Parse Method (CargoReader Component)

Parse the specified input data.

Syntax

• C#
• VB.NET

public void Parse();

Async Version
public async Task Parse();
public async Task Parse(CancellationToken cancellationToken);

Public Sub Parse()

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

Remarks

This method parses the input data specified by SetOutputStream, InputFile or InputData.

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:

• SetInputStream
• InputFile
• InputData

Reset Method (CargoReader Component)

Resets the component.

Syntax

• C#
• VB.NET

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 (CargoReader Component)

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

Syntax

• C#
• VB.NET

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:

• SetInputStream
• InputFile
• InputData

Error Event (CargoReader Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

public class CargoreaderErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

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

Public Class CargoreaderErrorEventArgs 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 (CargoReader Component)

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

Syntax

• C#
• VB.NET

public event OnResolveSchemaHandler OnResolveSchema;

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

public class CargoreaderResolveSchemaEventArgs : EventArgs {
  public string MessageIdentifier { get; }
  public string Version { get; }
}

Public Event OnResolveSchema As OnResolveSchemaHandler

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

Public Class CargoreaderResolveSchemaEventArgs 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

CargoValue Type

A value parsed from a Cargo-Imp message.

Remarks

The fields below provide information about the value.

Fields

Config Settings (CargoReader Component)

CARGOREADER Config Settings

Base Config Settings

Trappable Errors (CargoReader Component)

CargoReader Errors