Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistency Review: Standardize column specifications for correction charges #547

Closed
ijurica opened this issue Sep 24, 2024 · 2 comments · Fixed by #549
Closed

Consistency Review: Standardize column specifications for correction charges #547

ijurica opened this issue Sep 24, 2024 · 2 comments · Fixed by #549
Assignees
Labels
consistency/review Consistency Review
Milestone

Comments

@ijurica
Copy link
Contributor

ijurica commented Sep 24, 2024

Documents:

Description

Review and align how we specify Corrections across the specification. Address nullability and value ranges of metric columns.

1. Nullability

In the case of CommitmentDiscountQuantity, we specified the following:

… CommitmentDiscountQuantity MAY be negative if ChargeClass is "Correction"….

Meanwhile, for other columns (e.g., costs, quantities, units), we allowed null values for Corrections. For instance:

… It MUST NOT be null when ChargeClass is not "Correction"…

2. Value ranges of metric columns

While we were explicit in CommitmentDiscountQuantity about expecting positive values and allowing negative values for Corrections, we didn’t explicitly address negative values in other metric columns. (We assumed it was understood that quantities and costs can only be negative in the case of Correction charges and must be non-negative for non-Correction charges.)
Briefly discuss whether this should be applied consistently across the specification.

Proposed Approach

Standardize the specifications, i.e. allow nulls in the case of corrections for all columns except cost metrics, and explicitly define value ranges for all metrics, for the following columns:

  • PricingUnit
  • ConsumedUnit
  • CommitmentDiscountUnit
  • PricingQuantity
  • ConsumedQuantity
  • CommitmentDiscountQuantity
  • ListCost
  • ContractedCost
  • ListUnitPrice
  • ContractedUnitPrice

GitHub Issue or Reference

Issue #542

Context

No response

Data Submission for Discussion

No response

@ijurica ijurica added the discussion topic Item or question to be discussed by the community label Sep 24, 2024
@github-project-automation github-project-automation bot moved this to Triage in FOCUS WG Sep 24, 2024
@jpradocueva
Copy link
Contributor

Action items from TF-1 call on Sep 24:

  • [TF1-#547 ] Irena, @ijurica : Prepare a PR addressing corrections in metric columns, including standardizing null value handling, and submit it for review within 30 hours.
  • [TF1-#547 ] Chris, @cnharris10 & Alex, @ahullah: Assist Irena in reviewing the proposed PR before the next members’ meeting.

@jpradocueva jpradocueva added this to the v1.1 milestone Sep 24, 2024
@ijurica ijurica added the consistency/review Consistency Review label Sep 25, 2024
ijurica added a commit that referenced this issue Sep 25, 2024
…c update - Correction handling and value range
ijurica added a commit that referenced this issue Sep 25, 2024
ijurica added a commit that referenced this issue Sep 25, 2024
ijurica added a commit that referenced this issue Sep 26, 2024
…ge fix (non-negative to positive); Switch back to the version 1.0 definition and description considering it's not the resource or service being metered, but the associated SKUs
ijurica added a commit that referenced this issue Sep 26, 2024
ijurica added a commit that referenced this issue Sep 26, 2024
ijurica added a commit that referenced this issue Sep 26, 2024
ijurica added a commit that referenced this issue Sep 26, 2024
ijurica added a commit that referenced this issue Oct 1, 2024
…nal version. These two columns will be addressed in a separate PR.
ijurica added a commit that referenced this issue Oct 1, 2024
…onsumed units and quantities are associated with metered SKUs
@shawnalpay shawnalpay removed the discussion topic Item or question to be discussed by the community label Oct 1, 2024
ijurica added a commit that referenced this issue Oct 2, 2024
ijurica added a commit that referenced this issue Oct 2, 2024
ijurica added a commit that referenced this issue Oct 2, 2024
… 'MUST NOT be null if ... is Used' with 'MUST NOT be null if ... is not Unused'
ijurica added a commit that referenced this issue Oct 2, 2024
… 'MUST NOT be null if ... is Used' with 'MUST NOT be null if ... is not Unused'
jpradocueva added a commit that referenced this issue Oct 3, 2024
…ion charges (#549)

Standardize the column specifications, i.e. allow nulls in the case of
corrections for all columns except cost metrics, and explicitly define
value ranges for all metrics, for the following columns:

- PricingUnit
- ConsumedUnit
- CommitmentDiscountUnit
- PricingQuantity
- ConsumedQuantity
- CommitmentDiscountQuantity
- ListCost
- ContractedCost
- ListUnitPrice
- ContractedUnitPrice

---

### NOTE:

An initial overall analysis of the current correction handling and value
ranges was conducted within this PR.
Due to deadlines, **the scope of this particular PR was limited to
addressing the following two columns**:

- **ConsumedUnit**
- **ConsumedQuantity**

Please use this
[table](https://docs.google.com/spreadsheets/d/1SvaD-PSzxwRKExKYbQXbtEmVPtbhN4HnycOatvLfGPI/edit?gid=1823426118#gid=1823426118)
to verify the normative requirements.

---------

Co-authored-by: Joaquin <[email protected]>
@github-project-automation github-project-automation bot moved this from R&A to Closed in FOCUS WG Oct 3, 2024
@jpradocueva
Copy link
Contributor

Comments from Members' call on Oct 31:

Analysis: Simple editorial adjustments to normative statements, aimed at improving readability.
Agreements: Irena will reintroduce this as part of ongoing editorial work and close #547 once a backup is made.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency/review Consistency Review
Projects
Status: Closed
5 participants