IPWorks EDIFACT 2020 C++ Edition

Questions / Feedback?

UseSchemaName Property

Whether the output XML uses element names based on name defined in the schema.

Syntax

ANSI (Cross Platform)
int GetUseSchemaName();
int SetUseSchemaName(int bUseSchemaName); Unicode (Windows) BOOL GetUseSchemaName();
INT SetUseSchemaName(BOOL bUseSchemaName);
@property (nonatomic,readwrite,assign,getter=useSchemaName,setter=setUseSchemaName:) BOOL useSchemaName;
- (BOOL)useSchemaName;
- (void)setUseSchemaName:(BOOL)newUseSchemaName;
#define PID_EDIFACTTRANSLATOR_USESCHEMANAME 13

IPWORKSEDIFACT_EXTERNAL void* IPWORKSEDIFACT_CALL IPWorksEDIFACT_EDIFACTTranslator_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSEDIFACT_EXTERNAL int IPWORKSEDIFACT_CALL IPWorksEDIFACT_EDIFACTTranslator_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

FALSE

Remarks

This setting specifies whether the XML element name written to output is taken from the Id of the element defined in the schema. It is only applicable to ArcESB JSON schemas. For instance, given an EDIFACT document with the segment:

BGM+380:::TAX INVOICE

When this setting is True the XML generated may look like:

<BGM type="Segment">
<C002 type="Composite" desc="DOCUMENT/MESSAGE NAME">
<_1001 desc="Document/message name, coded">380</_1001>
<_1131 desc="Code list qualifier"></_1131>
<_3055 desc="Code list responsible agency, coded"></_3055>
<_1000 desc="Document/message name">TAX INVOICE</_1000>
</C002>

Where the elements "_1001", "C002", etc. are taken from the Id values of the EDI elements in the schema files.

Note: In order to produce valid XML, elements that would begin with a digit are prefixed with the "_" character.

In contrast if False (default) the XML generated may look like:

<BGM type="Segment">
<BGM01 type="Composite" desc="DOCUMENT/MESSAGE NAME">
<BGM0101 desc="Document/message name, coded">380</BGM0101>
<BGM0102 desc="Code list qualifier"></BGM0102>
<BGM0103 desc="Code list responsible agency, coded"></BGM0103>
<BGM0104 desc="Document/message name">TAX INVOICE</BGM0104>
</BGM01>
The default value is False. This setting is only applicable when using ArcESB JSON schemas.

Data Type

Boolean

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDIFACT 2020 C++ Edition - Version 20.0 [Build 8209]