Uploaded image for project: 'OASIS Energy Market Information Exchange (eMIX) TC'
  1. OASIS Energy Market Information Exchange (eMIX) TC
  2. EMIX-312

rationalize table headers, create definitions.

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: wd20
    • Component/s: spec
    • Labels:
      None
    • Proposal:
      Hide

      Proposal:

      Clean up tables to have only 2 columns: Name and Definition.
      If 'Name' by itself seems too generic, could use 'EMIX Name', or 'Element Name', or 'Entity Name'.

      Create formal definitions for all rows ("the formal statement of the meaning or significance of a word, phrase, etc.").
      Align with schema 'documentation'.

      For example, currently the row containing 'PackageDiscount' has no 'Definition' column. There is a 'Note' column stating "There may be market reasons for the price to be different than the Extended Price." and a 'Specification' column that contains info about datatype and optionality/cardinality. We need the formal definitions to reduce uncertainty and time spent discussing what is meant and enable others (end users of the spec) to understand what is meant and to put in the schema 'documentation'.

      Show
      Proposal: Clean up tables to have only 2 columns: Name and Definition. If 'Name' by itself seems too generic, could use 'EMIX Name', or 'Element Name', or 'Entity Name'. Create formal definitions for all rows ("the formal statement of the meaning or significance of a word, phrase, etc."). Align with schema 'documentation'. For example, currently the row containing 'PackageDiscount' has no 'Definition' column. There is a 'Note' column stating "There may be market reasons for the price to be different than the Extended Price." and a 'Specification' column that contains info about datatype and optionality/cardinality. We need the formal definitions to reduce uncertainty and time spent discussing what is meant and enable others (end users of the spec) to understand what is meant and to put in the schema 'documentation'.
    • Resolution:
      Hide

      All tables have two columns, one tied to the purpose of the table, (e.g. Product Element for Product) and one for a defintion.

      Show
      All tables have two columns, one tied to the purpose of the table, (e.g. Product Element for Product) and one for a defintion.

      Description

      Align table columns (and content type) to be consistent and create complete definitions.

      The current table structure describing entities/elements varies significantly from section to section:

      • some tables have 2 columns, some 3, some 4
      • tables have varying combinations of 'type', 'notes', 'definition', 'specification'
      • content of 'type', 'notes', 'definition', 'specification' is often interchanged/intermingled
      • the first column titles vary:
        'name' (most used), 'time segment', 'term', 'intrinsic element', 'extrinsic element', 'warrant element', and 'product element'
      • some table columns are declared 'normative', others 'non-normative', others not stated

      Tables 3-3 and 11-1 contain very, very similar content, although not exactly the same; remove one?

        Attachments

          Activity

            People

            • Assignee:
              william.cox William Cox (Inactive)
              Reporter:
              ahendry Anne Hendry (Inactive)
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: