- 3 minutes to read
EDIMessageTypeParseString - System Parameter
The EDIMessageTypeParseString System Parameter is the pattern the Logging Service uses to build the Message Type name of an EDIFACT message from its UNH (message header) segment. The Message Type name decides which Search Field Expressions apply to the message.
At a Glance
| Property | Value |
|---|---|
| Key | EDIMessageTypeParseString |
| Data type | string (pattern) |
| Default | {MessageType}.{MessageVersionNumber}{MessageReleaseNumber}{ControllingAgencyCoded} |
| Read by | Logging Service |
| Takes effect | Within about 15 seconds, for newly logged messages only; no restart needed |
| Status | ✅ Active |
How It Works
When the Logging Service processes an EDIFACT message, it reads the UNH segment and replaces each variable in the pattern with the matching value. Text outside the braces is kept as written. The result becomes the Message Type name of the message. A Message Type set explicitly with Context Options takes precedence.
Take this UNH segment:
UNH+1+ORDERS:D:96A:UN:EAN008'
With the default pattern, the Message Type name becomes ORDERS.D96AUN.
Pattern Variables
| Variable | UNH data element | Example value | Meaning |
|---|---|---|---|
{MessageReferenceNumber} |
0062 | 1 |
Message reference number, usually sequential |
{MessageType} |
0065 | ORDERS |
Message type, such as ORDERS, DESADV, INVOIC |
{MessageVersionNumber} |
0052 | D |
Message version number |
{MessageReleaseNumber} |
0054 | 96A |
Message release number, such as 96A or 01B |
{ControllingAgencyCoded} |
0051 | UN |
Controlling agency (UN = UN/CEFACT) |
{AssociationAssignedCode} |
0057 | EAN008 |
Association assigned code (optional in the message) |
{CodeListDirectoryVersionNumber} |
0110 | 8 |
Code list directory version number (optional in the message) |
{MessageTypeSubFunctionIdentification} |
0113 | 1 |
Message type sub-function identification (optional in the message) |
Examples
| Pattern | UNH segment | Message Type name |
|---|---|---|
{MessageType}.{MessageVersionNumber}{MessageReleaseNumber}{ControllingAgencyCoded} (default) |
UNH+1+ORDERS:D:96A:UN:EAN008' |
ORDERS.D96AUN |
{MessageType}.{MessageVersionNumber}{MessageReleaseNumber}.{AssociationAssignedCode} |
UNH+1+DESADV:D:01B:UN:EAN008' |
DESADV.D01B.EAN008 |
EDIFACT.{MessageType} |
UNH+1+INVOIC:D:96A:UN' |
EDIFACT.INVOIC |
Impact on Message Types and Search Fields
- A changed pattern applies only to messages logged after the change. Existing Message Types and logged messages keep their names, so for a while the same EDIFACT message can appear under two Message Type names.
- Search Field Expressions are bound to Message Types. After a change, add the new Message Type names to the expressions that should keep extracting Search Field values, and check your Log Views.
- New Message Types get their retention settings when they are created; see Add or manage Message Type.
Choosing a Value
- ✅ Keep the default. It tells versions and releases apart, so each can have its own Search Field Expressions.
- Use a shorter pattern, such as
EDIFACT.{MessageType}, when one set of expressions should apply to all versions of a message type. - Use only variables that all your messages carry. A variable without a value in the UNH segment gives an incomplete name (for example a trailing
.). - Test a new pattern in a test environment with real messages from your trading partners, and check the resulting Message Type name in a Log View, before you change production.