Internet DRAFT - draft-mcpherson-sattler-report-structure
draft-mcpherson-sattler-report-structure
Internet Engineering Task Force N. McPherson
Internet-Draft 1&1 IONOS SE
Intended status: Best Current Practice T. Sattler, Editor
Expires: April 15, 2020 October 15, 2019
Report Structure
draft-mcpherson-sattler-report-structure-03
Abstract
This document describes the default Report Structure for Reports
which can be provide via the Reporting Repository.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress".
This Internet-Draft will expire on April 15, 2020.
Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
McPherson & Sattler Expires April 15, 2020 [Page 1]
Internet-Draft Report Structure October 2019
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Terminology and Definitions . . . . . . . . . . . . . . . . . 3
2.1. Internationalized Domain Names . . . . . . . . . . . . . 3
2.2. Dates and Times . . . . . . . . . . . . . . . . . . . . . 3
2.3. Character Encoding . . . . . . . . . . . . . . . . . . . 3
2.4. Currency . . . . . . . . . . . . . . . . . . . . . . . . 3
3. File Names . . . . . . . . . . . . . . . . . . . . . . . . . 4
4. File Types . . . . . . . . . . . . . . . . . . . . . . . . . 4
5. Delimiter . . . . . . . . . . . . . . . . . . . . . . . . . . 4
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4
7. Security Considerations . . . . . . . . . . . . . . . . . . . 4
8. Implementation Status . . . . . . . . . . . . . . . . . . . . 4
8.1. united-domains Reselling . . . . . . . . . . . . . . . . 5
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 5
9.1. Normative References . . . . . . . . . . . . . . . . . . 5
9.2. Informative References . . . . . . . . . . . . . . . . . 6
Appendix A. Change History . . . . . . . . . . . . . . . . . . . 6
A.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 6
A.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 6
A.3. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 6
A.4. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 6
A.5. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 6
A.6. Change from 05 to 06 . . . . . . . . . . . . . . . . . . 7
A.7. Change from 06 to 07 . . . . . . . . . . . . . . . . . . 7
A.8. Change from 07 to REPORT 00 . . . . . . . . . . . . . . . 7
A.9. Change from REPORT 00 to REPORT 01 . . . . . . . . . . . 7
A.10. Change from REPORT 01 to REPORT 02 . . . . . . . . . . . 7
A.11. Change from REPORT 02 to REPORT 03 . . . . . . . . . . . 7
Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 7
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7
1. Introduction
Modern top-level domain registries provide many detailed reports and
documents that their registrars require on a daily, weekly and
monthly basis. These most commonly include transaction reports, as
well as lists containing currently unavailable domains and current
premium domain fees. These reports are critical for registrars'
businesses and play an important role in accounting and operations
processes as well as in sales and marketing activities. In the
current set-up, registrars must download these reports from each
registry's intranet differently according to each registry's document
management set up.
This document describes the default Report Structure for Reports
which can be provide via the
[I-D.mcpherson-sattler-reporting-repository].
McPherson & Sattler Expires April 15, 2020 [Page 2]
Internet-Draft Report Structure October 2019
2. Terminology and Definitions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119] when
specified in their uppercase forms.
2.1. Internationalized Domain Names
Top-level domains and domain names contained in a file name or file
MUST be written as A-LABEL according to [RFC5890].
2.2. Dates and Times
All dates and times attribute values MUST be expressed in Universal
Coordinated Time (UTC) using the Gregorian calendar. The extended
date-time form using upper case "T" and "Z" characters defined in ISO
8601 [RFC3339] MUST be used to represent date-time values.
One day is defined as one day in UTC+0. Therefore, months and years
will also be calculated on this basis.
2.3. Character Encoding
Files and their content MUST be encoded in UTF-8 according to
[RFC3629].
2.4. Currency
Currencies MUST be listed with the relevant three letter currency
alphabetic code according to ISO 4217 (https://www.iso.org/iso-4217-
currency-codes.html).
McPherson & Sattler Expires April 15, 2020 [Page 3]
Internet-Draft Report Structure October 2019
3. File Names
Files MUST be lowercase and follow this grammar:
PREFIX '_' TYPE '_' DATE '.' FILESUFFIX
PREFIX indicates if the file is either a report specific for
a TLD or a registry. A report of a registry MAY include
more than one TLD.
TYPE indicates the type of the file, the value MUST be either
'premium-domains', 'unavailable-domains' or
'transactions'.
DATE indicates the date of the file and MUST be
YYYY-MM-DD or YYYY-MM according to ISO 8601 [RFC3339]
FILESUFFIX identifier specified as a suffix to the name of the file
and indicated a characteristic of the file contents or
its intended use. The file suffix MUST be csv.
Example based on the above grammar:
Daily report of premium domain names for the TLD .example effective
on 2018-08-01: example_premium-domains_2018-08-01.csv.gz
Monthly report of transactions for the TLD .example effective on
2018-08: example_transactions_2018-08.csv.gz
Monthly report of premium domain names for the .example registry
effective on 2018-08: example-registry_premium-domains_2018-08.csv.gz
4. File Types
Files MUST be CSV files according to [RFC4180]. It is RECOMMENDED
to compress with gzip according to [RFC1952].
5. Delimiter
The delimiter MUST be a comma.
6. IANA Considerations
This document has no IANA actions.
7. Security Considerations
The registry report structure described in this document does not
provide any security services.
8. Implementation Status
Note to RFC Editor: Please remove this section and the reference to
[RFC7942] before publication.
McPherson & Sattler Expires April 15, 2020 [Page 4]
Internet-Draft Report Structure October 2019
This section records the status of known implementations of the
protocol defined by this specification at the time of posting of this
Internet-Draft, and is based on a proposal described in [RFC7942].
The description of implementations in this section is intended to
assist the IETF in its decision processes in progressing drafts to
RFCs. Please note that the listing of any individual implementation
here does not imply endorsement by the IETF. Furthermore, no effort
has been spent to verify the information presented here that was
supplied by IETF contributors. This is not intended as, and must not
be construed to be, a catalog of available implementations or their
features. Readers are advised to note that other implementations may
exist.
According to [RFC7942], "this will allow reviewers and working groups
to assign due consideration to documents that have the benefit of
running code, which may serve as evidence of valuable experimentation
and feedback that have made the implemented protocols more mature. It
is up to the individual working groups to use this information as
they see fit".
8.1. united-domains Reselling
Organization: united-domains Reselling GmbH
Name: Reseller Reporting System
Description: Domain Reseller Platform
Level of maturity: Deployed in production.
Version compatibility: Version REPO 01 is implemented.
Coverage: All aspects of this document are implemented.
Licensing: Proprietary In-House software
Contact: Tim Ettel <ettel@ud-reselling.com>
URL: https://www.ud-reselling.com/en/
9. References
9.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC5890] Klensin, J., "Internationalized Domain Names for
Applications (IDNA): Definitions and Document Framework",
RFC 5890, August 2010,
<https://www.rfc-editor.org/info/rfc5890>.
McPherson & Sattler Expires April 15, 2020 [Page 5]
Internet-Draft Report Structure October 2019
9.2. Informative References
[I-D.mcpherson-sattler-reporting-repository]
McPherson, N. and Sattler, T., "Reporting Repository",
<https://datatracker.ietf.org/doc/draft-mcpherson-sattler-
reporting-repository/> (work in progress), March 2019
[RFC1952] Deutsch, P., "GZIP file format specification version 4.3",
RFC 1952, May 1996,
<https://www.rfc-editor.org/info/rfc1952>.
[RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the
Internet: Timestamps", RFC 3339, July 2002,
<https://www.rfc-editor.org/info/rfc3339>.
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", RFC 3629, November 2003,
<https://www.rfc-editor.org/info/rfc3629>.
[RFC4180] Shafranovich, Y., "Common Format and MIME Type for
Comma-Separated Values (CSV) Files", RFC 4180,
October 2005
<https://www.rfc-editor.org/info/rfc4180>.
[RFC7942] Sheffer, Y. and Farrel, A., "Improving Awareness of
Running Code: The Implementation Status Section", RFC
7942, July 2016,
<https://www.rfc-editor.org/info/rfc7942>.
Appendix A. Change History
A.1. Change from 00 to 01
Fixed minor typos in section 3. Clarified usage of csv files suffix.
A.2. Change from 01 to 02
Updated Neal's author details.
A.3. Change from 02 to 03
Added definition of currency. Added monthly reports and changed
examples.
A.4. Change from 03 to 04
Added reference to RFC4180 for CSV files, and changed delimiter to
comma accordingly.
A.5. Change from 04 to 05
Added editor flag to author. Minor formatting changes. Changed
security considerations.
McPherson & Sattler Expires April 15, 2020 [Page 6]
Internet-Draft Report Structure October 2019
A.6. Change from 05 to 06
Clarified to compress the csv files with gzip.
A.7. Change from 06 to 07
Added reference to RFC1952 for gzip.
A.8. Change from 07 to REPORT 00
Changed draft name.
A.9. Change from REPORT 00 to REPORT 01
Added implementation reference and acknowledgement. Editorial
changes.
A.10. Change from REPORT 01 to REPORT 02
Changed implementation reference. Editorial changes.
A.11. Change from REPORT 02 to REPORT 03
Editorial changes.
Appendix B. Acknowledgements
The authors wish to thank the following persons for their feedback
and suggestions (sorted alphabetically by company):
o Thomas Keller, 1&1 IONOS
o James Galvin, Afilias
o Tim Ettel, united-domains
o Andreas Huber, united-domains
Authors' Addresses
Neal McPherson
1&1 IONOS SE
Ernst-Frey-Str. 5
76135 Karlsruhe
DE
Email: neal.mcpherson@ionos.com
URI: https://www.ionos.com
Tobias Sattler
Email: tobias.sattler@me.com
URI: https://tobiassattler.com
McPherson & Sattler Expires April 15, 2020 [Page 7]
