eddy 0.1.0 → 0.3.0

data/data/schema/element_summary.json

@@ -0,0 +1,60 @@
+{
+  "$id": "https://raw.githubusercontent.com/tcd/eddy/master/data/schema/element_summary.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Element Summary",
+  "description": "An individual EDI Data Element. Used in Companion Guides to define requirements for a Segment.",
+  "required": [
+    "ref",
+    "id",
+    "req"
+  ],
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "default": {
+      "description": "Default value for the Element",
+      "type": ["string", "integer", "number"]
+    },
+    "description": {
+      "description": "Description of the Element.",
+      "type": "string"
+    },
+    "id": {
+      "description": "Short string used to identify the Element.",
+      "type": "string"
+    },
+    "max": {
+      "description": "Maximum length for a valid Element value. Used for validation.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "min": {
+      "description": "Minimum length for a valid Element value. Used for validation.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "name": {
+      "description": "Full name of the Element.",
+      "type": "string"
+    },
+    "ref": {
+      "description": "Indicates the order in which Elements should appear in their Segment.",
+      "type": "string"
+    },
+    "req": {
+      "description": "Defines if/how the Element is required.",
+      "type": "string",
+      "enum": ["M", "O", "X", "Z"]
+    },
+    "type": {
+      "description": "The kind of value the Element will contain.",
+      "type": "string",
+      "enum": [ "AN", "B", "DT", "TM", "ID", "R", "N", "N0", "N1", "N2", "N3", "N4", "N5", "N6", "N7", "N8" ]
+    },
+    "valid_values": {
+      "description": "A list of valid values for the Element.",
+      "type": "array",
+      "items": {"type": "string"}
+    }
+  }
+}

data/data/schema/loop_summary.json

@@ -0,0 +1,49 @@
+{
+  "$id": "https://raw.githubusercontent.com/tcd/eddy/master/data/schema/loop_summary.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Loop Summary",
+  "description": "A repeated collection of Segments and/or other Loops. Used in Companion Guides.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "loop_id",
+    "repeat",
+    "components"
+  ],
+  "properties": {
+    "loop_id": {
+      "description": "A unique string used to identify the Loop within its Transaction Set.",
+      "type": "string"
+    },
+    "repeat": {
+      "description": "Number of times a particular Loop may be repeated.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "notes": {
+      "description": "*Syntax*, *Semantic*, or *Comment* notes on a Loop.",
+      "type": "string"
+    },
+    "loop": {
+      "description": "Loop in which the Loop appears.",
+      "type": "string"
+    },
+    "level": {
+      "description": "Indicates where the Loop is located in the Transaction Set.",
+      "type": "string",
+      "enum": ["Heading", "Detail", "Summary", "Not Defined"]
+    },
+    "req": {
+      "description": "Defines if/how the Loop is required.",
+      "type": "string",
+      "enum": ["M", "O", "X", "Z"]
+    },
+    "components": {
+      "description": "An array of Segments and/or Loops that comprise the Loop.",
+      "type" : "array", "items": { "anyOf": [
+        { "$ref": "https://raw.githubusercontent.com/tcd/eddy/master/data/schema/loop_summary.json" },
+        { "$ref": "https://raw.githubusercontent.com/tcd/eddy/master/data/schema/segment_summary.json" }
+      ]}
+    }
+  }
+}

data/data/schema/segment_summary.json

@@ -0,0 +1,66 @@
+{
+  "$id": "https://raw.githubusercontent.com/tcd/eddy/master/data/schema/segment_summary.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Segment Summary",
+  "description": "A collection of Data Elements. Used in Companion Guides to define a Transaction Set.",
+  "required": [
+    "id"
+  ],
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "pos": {
+      "description": "Indicates the order in which Segments should appear in their Level of the Transaction Set.",
+      "type": "string"
+    },
+    "id": {
+      "description": "Short string identifying the Segment.",
+      "type": "string"
+    },
+    "name": {
+      "description": "Full name of the Segment.",
+      "type": "string"
+    },
+    "purpose": {
+      "description": "Documents the purpose of a Segment.",
+      "type": "string"
+    },
+    "max_use": {
+      "description": "Number of times a particular Segment may be repeated at its location in the Transaction Set.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "notes": {
+      "description": "*Syntax*, *Semantic*, or *Comment* notes on a Segment.",
+      "type": "string"
+    },
+    "usage": {
+      "description": " Indicates whether or not the Segment must be used; Somewhat redundant due to `Req`.",
+      "type": "string"
+    },
+    "loop": {
+      "description": "Loop in which the Segment appears.",
+      "type": "string"
+    },
+    "element_count": {
+      "description": "Number of Data Elements included in the Segment. Used for comparison against standard segment definitions.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "req": {
+      "description": "Defines if/how the Segment is required.",
+      "type": "string",
+      "enum": ["M", "O", "X", "Z"]
+    },
+    "level": {
+      "description": "Indicates where the Segment is located in the Transaction Set.",
+      "type": "string",
+      "enum": ["Heading", "Detail", "Summary", "Not Defined"]
+    },
+    "elements": {
+      "description": "Data Elements that comprise the Segment.",
+      "type" : "array",
+      "items": {"$ref": "https://raw.githubusercontent.com/tcd/eddy/master/data/schema/element_summary.json"}
+    }
+  }
+}

data/data/schema/src/element_summary.schema.yml

@@ -0,0 +1,73 @@
+---
+"$id": https://raw.githubusercontent.com/tcd/eddy/master/data/schema/element_summary.json
+"$schema": http://json-schema.org/draft-07/schema#
+title: Element Summary
+description: An individual EDI Data Element. Used in Companion Guides to define requirements for a Segment.
+required:
+- ref
+- id
+- req
+type: object
+additionalProperties: false
+properties:
+  default:
+    description: Default value for the Element
+    type:
+    - string
+    - integer
+    - number
+  description:
+    description: Description of the Element.
+    type: string
+  id:
+    description: Short string used to identify the Element.
+    type: string
+  max:
+    description: Maximum length for a valid Element value. Used for validation.
+    type: integer
+    minimum: 1
+  min:
+    description: Minimum length for a valid Element value. Used for validation.
+    type: integer
+    minimum: 1
+  name:
+    description: Full name of the Element.
+    type: string
+  ref:
+    description: Indicates the order in which Elements should appear in their Segment.
+    type: string
+  req:
+    description: Defines if/how the Element is required.
+    type: string
+    enum: [M, O, X, Z]
+  type:
+    description: The kind of value the Element will contain.
+    type: string
+    enum:
+    - AN
+    - B
+    - DT
+    - TM
+    - ID
+    - R
+    - N
+    - N0
+    - N1
+    - N2
+    - N3
+    - N4
+    - N5
+    - N6
+    - N7
+    - N8
+  usage:
+    description: Indicates whether or not the Segment is required by a specific business partner. This value takes precedence over `req` for validation.
+    type: string
+    enum:
+    - Must Use
+    - Used
+  valid_values:
+    description: A list of valid values for the Element.
+    type: array
+    items:
+      type: string

data/data/schema/src/loop_summary.schema.yml

@@ -0,0 +1,50 @@
+---
+"$id": https://raw.githubusercontent.com/tcd/eddy/master/data/schema/loop_summary.json
+"$schema": http://json-schema.org/draft-07/schema#
+title: Loop Summary
+description: A repeated collection of Segments and/or other Loops. Used in Companion Guides.
+type: object
+additionalProperties: false
+required:
+- loop_id
+- repeat
+- components
+properties:
+  loop_id:
+    description: A unique string used to identify the Loop within its Transaction Set.
+    type: string
+  repeat:
+    description: Number of times a particular Loop may be repeated.
+    type: integer
+    minimum: 1
+  notes:
+    description: "*Syntax*, *Semantic*, or *Comment* notes on a Loop."
+    type: string
+  loop:
+    description: Loop in which the Loop appears.
+    type: string
+  level:
+    description: Indicates where the Loop is located in the Transaction Set.
+    type: string
+    enum:
+    - Heading
+    - Detail
+    - Summary
+    - Not Defined
+  req:
+    description: Defines if/how the Loop is required.
+    type: string
+    enum: [M, O, X, Z]
+  usage:
+    description: Indicates whether or not the Segment is required by a specific business partner. This value takes precedence over `req` for validation.
+    type: string
+    enum:
+    - Must Use
+    - Used
+  components:
+    description: An array of Segments and/or Loops that comprise the Loop.
+    type: array
+    items:
+      anyOf:
+      - "$ref": https://raw.githubusercontent.com/tcd/eddy/master/data/schema/loop_summary.json
+      - "$ref": https://raw.githubusercontent.com/tcd/eddy/master/data/schema/segment_summary.json

data/data/schema/src/segment_summary.schema.yml

@@ -0,0 +1,59 @@
+---
+"$id": https://raw.githubusercontent.com/tcd/eddy/master/data/schema/segment_summary.json
+"$schema": http://json-schema.org/draft-07/schema#
+title: Segment Summary
+description: A collection of Data Elements. Used in Companion Guides to define a Transaction Set.
+required:
+- id
+type: object
+additionalProperties: false
+properties:
+  pos:
+    description: Specifies the order (usually in multiples of ten) in which the Segment appears in the Transaction Set.
+    type: string
+  id:
+    description: Short string identifying the Segment.
+    type: string
+  name:
+    description: Full name of the Segment.
+    type: string
+  purpose:
+    description: Documents the purpose of a Segment.
+    type: string
+  max_use:
+    description: Number of times a particular Segment may be repeated at its location in the Transaction Set.
+    type: integer
+    minimum: 1
+  notes:
+    description: "*Syntax*, *Semantic*, or *Comment* notes on a Segment."
+    type: string
+  loop:
+    description: Loop in which the Segment appears.
+    type: string
+  element_count:
+    description: Number of Data Elements included in the Segment. Used for comparison against standard segment definitions.
+    type: integer
+    minimum: 1
+  req:
+    description: Defines if/how the Segment is required.
+    type: string
+    enum: [M, O, X, Z]
+  level:
+    description: Indicates where the Segment is located in the Transaction Set.
+    type: string
+    enum:
+    - Heading
+    - Detail
+    - Summary
+    - Not Defined
+  usage:
+    description: Indicates whether or not the Segment is required by a specific business partner. This value takes precedence over `req` for validation.
+    type: string
+    enum:
+    - Must Use
+    - Used
+  elements:
+    description: Data Elements that comprise the Segment.
+    type: array
+    items:
+      "$ref": https://raw.githubusercontent.com/tcd/eddy/master/data/schema/element_summary.json

data/data/schema/src/transaction_set_summary.schema.yml

@@ -0,0 +1,27 @@
+---
+"$id": https://raw.githubusercontent.com/tcd/eddy/master/data/schema/transaction_set_summary.json
+"$schema": http://json-schema.org/draft-07/schema#
+title: Transaction Set Summary
+description: An outline of all required components for an EDI transaction set implementation.
+required:
+- id
+- functional_group
+- components
+type: object
+properties:
+  id:
+    description: A short code identifying the Transaction Set.
+    type: number
+  name:
+    description: A descriptive name for the Transaction Set.
+    type: string
+  functional_group:
+    description: A short string used to group related Transaction Sets.
+    type: string
+  components:
+    description: The components that make up the Transaction Set.
+    type: array
+    items:
+      anyOf:
+      - "$ref": https://raw.githubusercontent.com/tcd/eddy/master/data/schema/loop_summary.json
+      - "$ref": https://raw.githubusercontent.com/tcd/eddy/master/data/schema/segment_summary.json

data/data/schema/transaction_set_summary.json

@@ -0,0 +1,33 @@
+{
+  "$id": "https://raw.githubusercontent.com/tcd/eddy/master/data/schema/transaction_set_summary.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Transaction Set Summary",
+  "description": "An outline of all required components for an EDI transaction set implementation.",
+  "required": [
+    "id",
+    "functional_group",
+    "components"
+  ],
+  "type": "object",
+  "properties": {
+    "id": {
+      "description": "A short code identifying the Transaction Set.",
+      "type": "number"
+    },
+    "name": {
+      "description": "A descriptive name for the Transaction Set.",
+      "type": "string"
+    },
+    "functional_group": {
+      "description": "A short string used to group related Transaction Sets.",
+      "type": "string"
+    },
+    "components": {
+      "description": "The components that make up the Transaction Set.",
+      "type" : "array", "items": { "anyOf": [
+        {"$ref": "https://raw.githubusercontent.com/tcd/eddy/master/data/schema/loop_summary.json"},
+        {"$ref": "https://raw.githubusercontent.com/tcd/eddy/master/data/schema/segment_summary.json"}
+      ]}
+    }
+  }
+}

data/data/sources.md

@@ -1,43 +1,3 @@
-# Notes
-
-## EDI
-
-- Document/Interchange/Envelope/File
-    - Sections:
-        - Heading
-        - Detail
-        - Summary
-    - Transaction Sets
-- Transaction Set
-    - Segments
-- Segment
-    - Segment Data
-        - Section
-        - Position
-        - Loop
-        - Usage
-        - Purpose (description)
-        - Max Use
-        - Syntax Notes
-        - Semantic Notes
-        - Comments
-    - Data Elements
-- Data Element
-    - Ref
-    - Id
-    - Name
-    - Type
-    - Req
-    - Min
-    - Max
-    - Usage
-
-
-## Segment Id Codes
-
-- 143
-    - List of the transaction sets (100-998)
-
 # Sources
 
 ## Transaction Sets
@@ -60,11 +20,6 @@
 - https://www.jobisez.com/edi/documents/segments-elements.aspx?set-id={100-999}
 - https://www.edifactory.de/x12/transaction-sets
 
-### Missing
-
-- 218
-- 980
-
 ## Data Element Definitions
 
 - http://ecomgx17.ecomtoday.com/edi/EDI_4009/
@@ -72,103 +27,117 @@
 
 ### Missing
 
-- Missing Code List
-    - 4
-    - 5
-    - 24
-    - 26
-    - 35
-    - 100
-    - 116
-    - 140
-    - 141
-    - 154
-    - 156
-    - 168
-    - 177
-    - 196
-    - 215
-    - 218
-    - 222
-    - 230
-    - 254
-    - 264
-    - 265
-    - 268
-    - 269
-    - 277
-    - 296
-    - 298
-    - 301
-    - 333
-    - 348
-    - 464
-    - 498
-    - 540
-    - 541
-    - 556
-    - 573
-    - 581
-    - 597
-    - 638
-    - 702
-    - 712
-    - 721
-    - 746
-    - 758
-    - 781
-    - 806
-    - 807
-    - 819
-    - 833
-    - 860
-    - 874
-    - 876
-    - 899
-    - 930
-    - 1003
-    - 1011
-    - 1014
-    - 1034
-    - 1049
-    - 1072
-    - 1096
-    - 1126
-    - 1148
-    - 1149
-    - 1155
-    - 1158
-    - 1245
-    - 1252
-    - 1253
-    - 1255
-    - 1256
-    - 1276
-    - 1314
-    - 1315
-    - 1318
-    - 1325
-    - 1334
-    - 1352
-    - 1354
-    - 1397
-    - 1415
-    - 1460
-    - 1482
-    - 1490
-    - 1494
-    - 1654
-    - 1655
-    - 1661
-    - 1684
-    - 1688
-    - I38
-- Missing:
-    - 333
-    - 373
-    - 427
-    - 475
-    - 484
-- Complicated:
-    - 1434
-    - 347
+#### Missing Element Definitions:
+
+- 427 - Unit Price Difference
+- 475
+- 484
+- 706	Entity Relationship Code	ID	2	2	
+- 749	Supplementary Information Qualifier	
+
+#### Incomplete Element Definitions:
+
+- 167
+
+#### Complicated Elements:
+
+- 1434
+- 347
+
+#### Missing Code Lists:
+
+- 4 (Air Carrier Code)
+    - https://en.wikipedia.org/wiki/List_of_airline_codes
+- 5 (Airport Code)
+    - https://en.wikipedia.org/wiki/List_of_airports_by_IATA_and_ICAO_code
+- 24 (Equipment Type)
+- 35 (Disposition Code)
+- 116 (Postal Code)
+    - http://download.geonames.org/export/zip/
+    - https://github.com/ankane/postjoy
+    - https://github.com/monterail/zip-codes
+- 140 (Standard Carrier Alpha Code)
+- 141 (Schedule B Code)
+- 154 (Standard Point Location Code)
+- 168 (Tariff Agency Code)
+- 177 (Intermodal Service Code)
+- 196 (Mortgagor Response Code)
+- 215 (Hazardous Classification)
+- 218 (Hazardous Placard Notation)
+- 222 (Hazardous Endorsement)
+- 230 (Subsidiary Classification)
+- 254 (Packing Group Code)
+- 264 (Census Merchandise Type Code)
+- 265 (Census Export License Identifier Code)
+- 268 (Census Container Code)
+- 269 (Census Special Identifier Code)
+- 277 (UN/NA Identification Code)
+- 296 (Intermediate Switch Carrier)
+- 298 (Origin EDI Carrier Code)
+- 301 (Car Type Code)
+- 333 (Terms Basis Date Code)
+- 348 (Jurisdiction Code)
+- 464 (Container Terms Code)
+- 498 (Condition Code)
+- 540 (Damage Type Code)
+- 541 (Damage Severity Code)
+- 556 (Damage Area Code)
+- 573 (Freight Station Accounting Code)
+- 581 (Customs Entry Type Code)
+- 597 (Vessel Code)
+- 638 (Rule 260 Junction Code)
+- 702 (Financial Transaction Code)
+- 712 (Category Reference Code)
+- 721 (Segment ID Code)
+- 746 (Protective Service Rule Code)
+- 758 (Hazardous Mnemonic Code)
+- 781 (Statement Format Code)
+- 806 (EPA Waste Stream Number Code)
+- 807 (Waste Characteristics Code)
+- 819 (Language Code)
+- 833 (Automotive Manufacturers Code)
+- 860 (D-U-N-S Number)
+- 874 (Space Management Reference Code)
+- 876 (Alternate Tiers per Pallet)
+- 899 (Unload Terminal Elevator Code)
+- 930 (Regulatory Agency Code)
+- 1003 (Account Type Code)
+- 1011 (Association of American Railroads (AAR) Pool Code)
+- 1014 (Car Type Group Code)
+- 1034 (Claim Adjustment Reason Code)
+- 1049 (Tax Payment Type Code)
+- 1072 (Rounding System Code)
+- 1096 (County Designator)
+- 1126 (Academic Degree Code)
+- 1148 (Academic Grade Qualifier)
+- 1149 (Occupation Code)
+- 1155 (Educational Test or Requirement Code)
+- 1158 (Subtest Code)
+- 1245 (Vehicle Identification Number (VIN) Plant Code)
+- 1252 (Health Screening Type Code)
+- 1253 (Immunization Type Code)
+- 1255 (Disease Condition Type Code)
+- 1256 (Medical Treatment Type Code)
+- 1276 (Machine Separable Indicator Code)
+- 1314 (Admission Source Code)
+- 1315 (Admission Type Code)
+- 1318 (Approval Code)
+- 1325 (Claim Frequency Type Code)
+- 1334 (Health Care Professional Shortage Area Code)
+- 1352 (Patient Status Code)
+- 1354 (Diagnosis Related Group (DRG) Code)
+- 1397 (Inquiry Response Code)
+- 1415 (Specimen Kit Type Code)
+- 1460 (Part of Body Code)
+- 1482 (Mechanical Car Code)
+- 1490 (Association of American Railroads Car Grade Code)
+- 1494 (Transportation Condition Code)
+- 1654 (Longitude Code)
+- 1655 (Latitude Code)
+- 1661 (Source Code)
+- 1684 (Attendance Type Code)
+- 1688 (Deduction Type Code)
+- I38 (Service Request Handler ID Qualifier)
+
+- Hazmat
+  - http://www.unece.org/trans/danger/publi/unrec/rev14/14files_e.html