CargoWriter Class

Properties   Methods   Events   Config Settings   Errors  

The CargoWriter class is optimized for Cargo-IMP documents, providing a simple way to create Cargo-IMP documents.

Syntax

ipworkseditranslator.cargowriter()

Remarks

The class allows you to create a document from scratch by writing one value at a time. Here's how a document would normally be created:

1. Call LoadSchema to load the schema for the message type you want to write.
2. Call Write once per value to add values to the message.
3. Once the message is complete, call Finish.

Example CargoWriter Code:

Cargowriter writer = new Cargowriter(); writer.LoadSchema("C:\\cargoimp_schemas\\FSU.json"); writer.Write("1.1", "FSU"); writer.Write("1.3", "15"); writer.Write("2.1.1", "057"); writer.Write("2.1.3", "12345675"); writer.Write("2.2.1", "YYZ"); writer.Write("2.2.2", "LYS"); writer.Write("2.3.2", "T"); writer.Write("2.3.3", "12"); writer.Write("23.1", "OCI"); writer.Write("23.3", "FR"); writer.Write("23.5", "IMP"); writer.Write("23.7", "M"); writer.Write("23.9", "07FR9876AB88901235"); writer.Write("23.5", "HWB"); writer.Write("23.7", "I"); writer.Write("23.9", "ABCD12345678"); writer.Finish();

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

CargoWriter.OutputData Property

Contains the output data.

Syntax

getOutputData(): string;
setOutputData(outputData: string): void;

Default Value

""

Remarks

This property will be populated with the contents of the Cargo-IMP data as output by the class when no OutputFile has been specified and SetOutputStream has not been called with a valid output stream.

Input and Output Properties

The class 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:

• InputFile
• InputData

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

• OutputFile
• OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

CargoWriter.OutputFile Property

Specifies the name of the file to write to.

Syntax

getOutputFile(): string;
setOutputFile(outputFile: string): void;

Default Value

""

Remarks

This property specifies the file to which the Cargo-IMP message will be written. This may be set to an absolute or relative path. This should be set before calling Write.

Input and Output Properties

The class 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:

• InputFile
• InputData

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

• OutputFile
• OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

CargoWriter.Overwrite Property

Whether to overwrite the file.

Syntax

isOverwrite(): boolean;
setOverwrite(overwrite: boolean): void;

Default Value

FALSE

Remarks

This property specifies whether the existing file will be overwritten when a new message is created. If set to False (default) the class when attempting to write to a file which already exists. If set to True the class will overwrite the existing file.

CargoWriter.config Method

Sets or retrieves a configuration setting.

Syntax

async cargowriter.config(configurationString : string): Promise<string>

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.

CargoWriter.finish Method

Completes the current message.

Syntax

async cargowriter.finish(): Promise<void>

Remarks

When this method is called, the class will finalize the current Cargo-IMP message.

CargoWriter.loadSchema Method

Loads a schema file describing a Message type.

Syntax

async cargowriter.loadSchema(fileName : string): Promise<void>

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

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.

CargoWriter.reset Method

Resets the class.

Syntax

async cargowriter.reset(): Promise<void>

Remarks

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

CargoWriter.write Method

Writes a value to the Cargo-IMP message.

Syntax

async cargowriter.write(name : string, value : string): Promise<void>

Remarks

This method adds a value to the current Cargo-IMP message.

Example CargoWriter Code:

Cargowriter writer = new Cargowriter(); writer.LoadSchema("C:\\cargoimp_schemas\\FSU.json"); writer.Write("1.1", "FSU"); writer.Write("1.3", "15"); writer.Write("2.1.1", "057"); writer.Write("2.1.3", "12345675"); writer.Write("2.2.1", "YYZ"); writer.Write("2.2.2", "LYS"); writer.Write("2.3.2", "T"); writer.Write("2.3.3", "12"); writer.Write("23.1", "OCI"); writer.Write("23.3", "FR"); writer.Write("23.5", "IMP"); writer.Write("23.7", "M"); writer.Write("23.9", "07FR9876AB88901235"); writer.Write("23.5", "HWB"); writer.Write("23.7", "I"); writer.Write("23.9", "ABCD12345678"); writer.Finish();

CargoWriter.Error Event

Fired when information is available about errors during data delivery.

Syntax

cargowriter.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

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

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.

CargoWriter.Output Event

Fires whenever a segment is complete.

Syntax

cargowriter.on('Output', listener: (e: {readonly outputData: string, readonly outputDataB: Uint8Array}) => void )

Remarks

The Output event will fire when the writer completes a new segment and writes data to the output stream or buffer. The OutputData parameter contains the data bytes.

CargoWriter.ResolveSchema Event

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

Syntax

cargowriter.on('ResolveSchema', listener: (e: {readonly messageIdentifier: string, readonly version: string}) => void )

Remarks

The ResolveSchema event will fire when a the class 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 class that can be used to parse the transaction.

Config Settings (class ipworkseditranslator.cargowriter)

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.

CargoWriter Config Settings

Base Config Settings

Trappable Errors (class ipworkseditranslator.cargowriter)

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