IPWorks EDIFACT 2020 Node.js Edition

Questions / Feedback?

AddRenamingRule Method

This method adds a renaming rule to define how an EDI element is renamed when translating to XML.

Syntax

edifacttranslator.addRenamingRule(rule, [callback])

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

This method adds a renaming rule. The rule defining how EDI elements are renamed when translating to XML. Renaming rules are optional.

The renaming rule defines how EDI elements are renamed when translating to XML or JSON. The format is:

ediname:xmlanme
For instance: "UNH1:MsgRefNumber".

Note: Renaming rules are not required when converting from XML or JSON to EDI.

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