IPWorks EDIFACT 2020 Node.js Edition

Questions / Feedback?

ElementSchemaName Property

The name of the element as taken from the schema.

Syntax

 edifactreader.getElementSchemaName(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 getElementSchemaName([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 setElementSchemaName([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 element as taken from the schema.

ElementName holds positional (ref) value like "N101". ElementSchemaName holds the Id taken from the schema.

For instance:

reader.XPath = "/IX/FG/TX/N1Loop1[1]/N1";
for (int i = 0; i < reader.XElements.Count; i++)
{ 
  Console.WriteLine(reader.XElements[i].SchemaName + ": " + reader.XElements[i].Value);
}

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

98: ST
93: BUYSNACKS PORT
66: 9
67: 1223334445

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


N101: ST
N102: BUYSNACKS PORT
N103: 9
N104: 1223334445

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]