Was this helpful?
Editing Document Schema File
You can do the following for an existing document schema file:
Editing Values for Node Properties
Inserting Node
Deleting Node
Undo/Redo Insert or Delete Node
Copying/Pasting Node
Editing Values for Node Properties
To edit the values for nodes such as segments, elements, composites, loops, and fields:
1. In the tree view, click the node for which you want to specify the values.
The Name and Value columns are displayed on the right pane.
2. In the Value column, type the value for the required property. For information about the properties for each node type, see Nodes and Properties.
3. Click Save to save the file.
Nodes and Properties
This section provides the properties for each type of node in the HIPAA, X12, EDIFACT, HL7, and SWIFT file types.
Record names now include sequence ID when connecting to a 4030 Schema file. For example, [L.N1]N1.0700 [L.N1]N2.0800 and so on.Version 5010 Schemas do not include the sequence ID in record name. Schema property StdVersion determines the naming convention to be used Value of V5010 specifies no sequence IDs are used. Value of V4030 specifies the use of sequence IDs.
HIPAA, X12, or EDIFACT File Type
Type of Node
Property Name
Description
Root Node
ID
ID for the root node.
Name
Name for the root node.
Standard
This value cannot be edited.
GroupID
File type group identifier.
StdVersion
File type version.
Segment
ID
ID for the segment node.
Name
Name for the segment.
Sequence
This value cannot be edited. The sequence is the position number of the segment. The sequence value will automatically change if you insert or delete a segment before a specific segment. For instance, if a segment sequence is 03, and you insert an segment just above it, the original sequence number will become 04, and the new segment will automatically take the 03 value.
StdRequirement
Select any of the following options:
O - Optional
M - Mandatory
C - Conditional (if this option is used, it will be explained)
X - Cannot be used
MaxUse
Maximum number of times this segment can be used.
Loop
ID
ID for the loop node.
Name
Name for the loop node.
Sequence
This value cannot be edited. The sequence is the position number of your loop. The sequence value will automatically change if you insert or delete a loop before a specific loop. For instance, if a loop sequence is 03, and you insert an loop just above it, the original sequence number will become 04, and the new loop will automatically take the 03 value.
StdRequirement
Select any of the following options:
O - Optional
M - Mandatory
C - Conditional (if this option is used, it will be explained)
X - Cannot be used
Count
Maximum number of loops.
Element
ID
ID for the element node.
 
Name
Name for the element node.
 
Sequence
This value cannot be edited. The sequence is the position number of your element. The sequence value will automatically change if you insert or delete an element before a specific element. For instance, if an element sequence is 03, and you insert an element just above it, the original sequence number will become 04, and the new element will automatically take the 03 value.
 
StdRequirement
Select any of the following options:
O - Optional
M - Mandatory
C - Conditional (if used, these will be explained)
X - Cannot be used
N - Not Advised (this item may be present in a data transaction. Ideally, it must not be present. It is used to indicate the data that is not required in most uses of the transaction set)
 
DataType
Select any of the following X12 element data types:
ID - Identifier, a unique coded value from a predefined list of codes.
AN - String, a sequence of basic or extended character sets
DT - Date, a standard date in the format YYMMDD
TM - Time in the format HHMMSSd...d
R - Decimal, numeric with an explicit decimal place
B - Binary, numeric sequence of binary octets
N0-N20 - Numeric value with a predefined implied decimal point.
A numeric data element is represented by one or more digits with an optional leading sign representing a value in the normal base of 10. The value of a numeric data element includes an implied decimal point. It is used when the position of the decimal point within the data is permanently fixed and is not to be transmitted with the data.
 
MiniSize
Minimum size of the element
 
MaxSize
Maximum size of the element
 
Operator
Used to compare the contents of element to either the contents of another element or a constant value. Select any of the following options:
= (Default)
<>
<
<=
>
>=
like
 
Value
Default value of the element.
 
Datamask
Format of Date (DT) and time (TM) such as yyyymmdd, yyyymmdd-yyyymmdd, yyyymmddH24MM, H24MMSS, HHMMSSTT1.
Date masks must be eight or six characters. Time masks may be either six or four characters long.
 
Description
Description of the element.
 
ExtraRule
Helps Document Schema Designer to distinguish between segments/loops of the same type at the same hierarchical level.
Two kinds of segments that need extract rules:
A group of similar segments (REF_A, REF_B, REF_C)
The first segment of a group of similar loops with the same sequence value
Select any of the following options:
No (Default)
Yes
 
Repeat
Maximum number of element.
Composite
ID
ID for the composite node.
Name
Name for the composite node.
Sequence
This value cannot be edited. The sequence is the position number of your composite. The sequence value will automatically change if you insert or delete a composite before a specific segment. For instance, if a composite sequence is 03, and you insert a composite just above it, the original sequence number will become 04, and the new composite will automatically take the 03 value.
StdRequirement
Select any of the following options:
O - Optional
M - Mandatory
C - Conditional (if this option is used, it will be explained)
X - Cannot be used
Repeat
Maximum number of composite.
StdRequirement
You may set each std requirement with one of the following options:
O - Optional.
In this designation, there is no requirement for a simple data element or composite data structure to be present in the segment. The presence of a value for a simple data element or the presence of value for any of the component data elements of a composite data structure is at the option of the sender.
M - Mandatory
In this condition, there is no dependency on other data elements. This designation may apply to either simple data elements or composite data structures. If it applies to a composite data structure, then at least one value of a component data element in that composite data structure shall be included in the data segment. Any simple data element that is indicated as mandatory must not be empty if the segment is used. If you try to change a default Mandatory user requirement, you will receive a warning message (since this changes the required setting of the transaction set standard).
C - Conditional (if this option is used, it will be explained)
If the first element specified in the condition is present, then all other elements must be present. However, any or all of the elements not specified as the first element in the condition may appear without requiring that the first element be present. The order of the elements in the condition does not have to be the same as the order of the data elements in the data segment.
X - Cannot be used
Not more than one of the elements specified in the condition must be present.
N - Not Advised
The element is designated as not used, and it does not have any dependencies on other elements.
HL7 File Type - Nodes and its Properties
 
Type of Node
Property Name
Description
Segment
ID
Type a value to specify the ID.
Field
ITEM
Select a value from the drop-down menu.
You can also type a value. If it is not available in the field library, it appears in red color.
NAME
Type a name for the field.
DT
Select the data-type from the drop-down menu.
SEQ
You can edit the value for this property.
OPT
Select the operator value from the drop-down menu:
O - Optional
R - Required
C - Conditional (if used, these will be explained)
X - Cannot be used
B - Included for backward compatibility for previous versions
LEN
Type a numeric value to specify the length.
REPEAT
Select Y to repeat. Else, select N
SWIFT File Type - Nodes and its Properties
The following table provides information about the nodes and properties for SWIFT file type.
 
Type of Node
Property Name
Description
Root Node
ID
ID for the root node.
Name
Name for the root node.
Standard
This value cannot be edited.
StdVersion
File type version.
Block
ID
ID for the block node.
Status
Select the operator value from the drop-down menu:
O - Optional
M- Mandatory
Sub Field
Format
Syntax to describe data format such as 6*35x, 13!c.
Name
Name for the sub field
Seq
This value cannot be edited. The sequence is the position number of the sub field. The sequence value will automatically change if you insert or delete a sub field before a specific sub field. For instance, if a sub field sequence is 03, and you insert a sub field above it, the original sequence number will become 04, and the new sub field will automatically take the 03 value.
Status
Select the operator value from the drop-down menu:
O - Optional
M- Mandatory
The following table provides the nodes and properties when a Block node has the ID value as 4
Type of Node
Property Name
Description
Root Node
ID
ID for the root node as 4.
Name
Name for the root node.
Standard
This value cannot be edited.
StdVersion
File type version.
Block
ID
ID for the block node is 4.
Status
Select the operator value from the drop-down menu:
O - Optional
M- Mandatory
Field
Tag
Field ID.
Name
Name of the field.
Seq
Order number in block.
Choice
ID
ID of the choice node.
Status
Select the operator value from the drop-down menu:
O - Optional
M- Mandatory
Repeat
ID
ID of the repeat node.
Status
Select the operator value from the drop-down menu:
O - Optional
M- Mandatory
Option
Option
List of optional subfields.
Sub Field
Format
Syntax to describe data format such as 6*35x, 13!c.
Name
Name of the sub field.
Sequence
Order number in the field.
Delimiter
Format
Delimiter to separate data string such as / , CrLf.
Sequence
Order number in the field.
Qualifier
ID
ID of the qualifier node.
Sequence
Order number in the field.
Total Number of Records in Log File
In an EDI transformation log file, the number of records differs from the known number of records in your source file. The total number of records in the log file is equal to the total EDI Loops plus the total EDI Segments:
Total Records in Log File = Loops + Segments
Inserting Node
You can insert a child node or insert a node after an existing node. The inserting options are based on the selected node type.
To insert a node:
1. In Project Explorer, double-click to open the .ds.xml file for which you want to insert a node.
The file opens in a separate tab (Schema Viewer).
2. Right-click on the node where you want to insert another node or a child node and select the required option based on the type of node that you want to insert.
The selected node is inserted. You can modify the properties for the inserted node. For information about the properties, see Editing Values for Node Properties.
The following table provides the right-click menu options that are available for the nodes in X12, EDIFACT, HIPAA, and HL7 file types.
Note:  
Loop node is applicable only for X12 and EDIFACT file types.
Element and Composite nodes are applicable only for HIPAA, X12, and EDIFACT file types. Field node is applicable only for HL7 file type
 
Type of Node
Context Menu Options for Inserting Node
Description
Root Node
Insert Loop
Inserts a loop within the root node.
Insert Segment
Inserts a segment within the root node
Insert Block
Inserts a block within the root node (for SWIFT file type only)
Segment
Insert Loop
Inserts a loop after an existing segment.
Insert Segment
Inserts a segment after an existing segment
Insert Composite
Inserts a composite within a segment.
Insert Element
Inserts an element within a segment.
Insert Field
Inserts a field within a segment.
Loop
Insert Loop
Inserts a loop after an existing loop.
Insert Subloop
Inserts a subloop within a loop.
Insert Segment
Inserts a segment after the existing loop.
Insert SubSegment
Inserts a subsegment within a loop
SubSegment
Insert Element
Inserts element within a subsegment
Insert Composite
Inserts composite within a subsegment
SubLoop
Insert SubLoop
Inserts subloop within a subloop
Insert SubSegment
Inserts subsegment within a subloop
Insert Segment
Inserts Segment after an existing subloop
Insert Loop
Inserts loop after an existing subloop
Composite
Insert Composite
Inserts composite after an existing composite
Insert Element
Inserts element after an exisiting composite
Insert SubElement
Inserts subelement within the composite
Element
Insert Composite
Inserts composite after an existing element
Insert Element
Inserts the element after an existing element
SubElement
Insert Element
Inserts the element after an existing subelement
Field
Insert Field
Inserts a field after the last field.
The following table provides information about the right-click menu options that are available for the nodes in the SWIFT file type.
Type of Node
Context Menu Options for Inserting Node
Description
Root Node
Insert Block
Inserts a block within the root node.
Block
Insert Block
Inserts a block after the current block (SWIFT file type)
Insert SubBlock
Inserts a block within the block (SWIFT file type)
Insert SubField
Inserts a subfield within a block.
SubField
Insert Block
Inserts a block after the current sub field.
Insert Sub Field
Inserts a sub field after current sub field.
Block within a block
Insert Block
.Inserts a block after the current block.
Insert SubBlock
Inserts a block within the block node
Insert Sub Field
Inserts a sub field within the block node
Insert SubsubField
Inserts sub field within a block node.
Note:  Not applicable for a block after the root node.
The following table provides the right-click menu options that are available for a block node with ID value as 4 within a SWIFT file.
 
Type of Node
Context Menu Options for Inserting Node
Description
Root Node
Insert Block
Inserts a block within the root node.
Block node with ID value as 4
Insert Block
Inserts a block node after the current block.
Insert Repeat
Inserts a repeat node within the block node.
Insert Choice
Inserts a choice node within the block node.
Insert Field
Inserts a field node within the block node.
Field
Insert Repeat
Inserts a Repeat node after the Field node.
Insert Choice
Inserts a Choice node after the Field node.
Insert Field
Inserts another Field node after the current Field Node.
Insert Option
Inserts an Option node within the Field node.
Insert Sub Field
Inserts a Sub Field node within the Field node.
Insert Delimiter
Inserts a Delimiter node within the Field node.
Insert Qualifier
Inserts a Qualifier node within the Field node.
Choice
Insert Field
Inserts a Field node within the Choice node.
Repeat
Insert Repeat
Inserts another Repeat node after the current Repeat node.
Insert SubRepeat
Inserts a Repeat node within the current Repeat node.
Insert Choice
Inserts a Choice node after the current Repeat node.
Insert SubChoice
Inserts a Choice node within the Repeat node.
Insert Field
Inserts a Field node after the current Repeat node.
Insert Repeat-Field
Inserts a Field node within the Repeat node.
Qualifier, Delimiter, or Sub Field nodes
Insert Option
Inserts an option node after the current node.
Insert SubField
Inserts a Sub Field after the current node.
Insert Delimiter
Inserts a Delimiter node after the current node.
Insert Qualifier
Inserts a Qualifier node after the current node.
Option
Insert Option
Inserts another Option node after the current Option node.
Insert Sub Option
Inserts an Option node within the current Option node.
Insert Sub Field
Inserts a Sub Field node after the current Option node.
Insert Opt-Sub Field
Inserts a Sub Field node within the current Option node.
Insert Delimiter
Inserts a Delimiter node after the current Option node.
Insert Opt-Delimiter
Inserts a Delimiter node within the current Option node.
Insert Qualifier
Inserts a Qualifier node after the current Option node.
Insert Opt-Qualifier
Inserts a Qualifier node within the current Option node.
Deleting Node
To delete a node:
1. In Project Explorer, double-click to open the .ds.xml file for which you want to delete a node.
The file opens in a separate tab (Schema Viewer).
2. Right-click on the node that you want to delete and click Delete.
A message is displayed to confirm the deletion.
3. Click OK.
The node is deleted.
Note:  The root node cannot be deleted.
Undo/Redo Insert or Delete Node
After inserting or deleting a node, you can undo the action. To do this, right-click in the tree view, and click the required Undo option. Similarly, to redo, right-click in the tree view and click the required Redo option.
Copying/Pasting Node
You can copy and paste nodes in the tree view. To do this, right-click on any node and click Copy. Place your cursor at the required location, right-click and click Paste <node name>. The node is pasted in the selected location. You can then modify the required property values.
Last modified date: 06/13/2022