IPWorks EDIFACT 2020 Node.js Edition

Questions / Feedback?

ElementComponentSchemaName Property

The name of the class as taken from the schema.

Syntax

 edifactreader.getElementComponentSchemaName(index, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getElementComponentSchemaName([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setElementComponentSchemaName([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The name of the component as taken from the schema.

ElementComponentName holds positional (ref) value like "DTM0101". ElementComponentSchemaName holds the Id taken from the schema.

For instance:

reader.XPath = "/IX/TX/DTM";
for (int i = 0; i < reader.XElements[0].ComponentCount; i++)
{ 
  reader.XElements[0].ComponentIndex = i;
  Console.WriteLine(reader.XElements[i].ComponentSchemaName + ": " + reader.XElements[i].ComponentValue);
}

When ElementComponentSchemaName is used this will use the name from the schema and will output values like:

2005: 137
2005: 137
2380: 201612151441

In contrast, if ElementComponentName was used the output would look like:


DTM0101: 137
DTM0101: 137
DTM0102: 201612151441

Note: This property is only applicable when a ArcESB JSON schema is loaded.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the ElementCount property.

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

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDIFACT 2020 Node.js Edition - Version 20.0 [Build 8162]