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.

OutputDataContains the output data.
OutputFileSpecifies the name of the file to write to.
OverwriteWhether to overwrite the file.

Method List


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

ConfigSets or retrieves a configuration setting.
FinishCompletes the current message.
LoadSchemaLoads a schema file describing a Message type.
ResetResets the class.
WriteWrites a value to the Cargo-IMP message.

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.

ErrorInformation about errors during data delivery.
OutputFires whenever a segment is complete.
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 class with short descriptions. Click on the links for further details.

CloseStreamAfterProcessingSpecifies whether or not the OutputStream should be closed after processing.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

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

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

ErrorCode contains an error code and Description 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

CloseStreamAfterProcessing:   Specifies whether or not the OutputStream should be closed after processing.

By default this is True. Setting this to False keeps the stream open for further use.

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.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class 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 classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

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

This setting is set to false by default on all platforms.

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.