Project

General

Profile

Actions

Design #114

open

Add a list of standards used for RM metadata, and a simple way for a rule author to list the URLs of standards employed in composed sentence data

Added by Joseph Potvin almost 2 years ago. Updated almost 2 years ago.

Status:
New
Priority:
Normal
Assignee:
Category:
-
Start date:
05/27/2022
Due date:
% Done:

0%

Estimated time:
Actions #1

Updated by Joseph Potvin almost 2 years ago

  • Tracker changed from Bug to Design
Actions #2

Updated by Ted Kim almost 2 years ago

  • Assignee changed from Ted Kim to Joseph Potvin

Maybe this can be dissected and specified using the figma design as a guide.

Is this equivalent to the Categories page where the standards are defined on this?

Or is this equivalent to the Data Sources page?

If neither, should one be modified?

Where does this data fit in the rule schema?

Actions #3

Updated by Joseph Potvin almost 2 years ago

  • Assignee changed from Joseph Potvin to Ted Kim

During the call I (a) did remember that early on circa 2017, I always included reference to the standard whenever a field used a standard; but, (b) I couldn't recall my method of associating the standard with the field. I have now checked a document from 2017, and see that in my data dictionary I just maintained an optional column for the designer to specify a standard if on was being use for a field.

There are two roles that would identify standards: the RuleMaker application developer; and the rulemaker_author . I'll address those separately:

Identification of Standards by the RuleMaker Application Developer

I notice that in my rule.dwd_SAMPLE.json example from the specification (aka "the dissertation") this whole problem is already solved for the application developer. In the excerpt below look at the five locations where (here) I have added the pointer "<<< STANDARD IDENTIFIED" (only for the purpose of this task entry, not as part of the JSON)

{
"dwds": "9d690c33-b52f-400e-938c-16a3017cacc0",
"rulereserve_nodes": "*",
"version_standard_url": "https://semver.org/",
<<STANDARD IDENTIFIED
"DWDS_schema_version": "0.6.1",
"metadata": {
"rule": {
"version": "0.3.1",
"pattern": "",
"pattern_version": "",
"criticality": "Experimental",
"group": "Operational Pattern",
"description": "At least 90% of ECPR workshop participants SHOULD have current or prior affiliation with an ECPR member institution.",
"url": "https://ecpr.eu/Membership/MembershipBenefits.aspx",
"title": "Institutional Relation Criterion for ECPR Workshop Participant Selection",
"rulemaker_entity": [
{
"entity_id": "Yjs73-j&js74jdsi",
"entity_name_eng": "Xalgorithms Foundation",
"entity_url": "https://www.xalgorithms.org"
}
],
"rulemaker_manager": [
{
"manager_id": "K8d77-hdjeys6YHT",
"manager_name": "Joseph Potvin",
"manager_contact": "[email protected]",
"manager_profile": ""
}
],
"rulemaker_author": [
{
"author_id": "K8d77-hdjeys6YHT",
"author_name": "Joseph Potvin",
"author_contact": "[email protected]",
"author_profile": ""
}
],
"rulemaker_maintainer": [
{
"rulemaker_maintainer_id": "K8d77-hdjeys6YHT",
"rulemaker_maintainer_name": "Joseph Potvin",
"rulemaker_maintainer_contact": "[email protected]",
"rulemaker_maintainer_profile": ""
}
]
}
},
"linked_rules_or_lookups": [
{
"dwds": "",
"column": [],
"row": [],
"value": []
}
],
"context_ineffect": [
{
"datetime_standard_url": "https://www.w3.org/TR/NOTE-datetime",
<<STANDARD IDENTIFIED
"datetime_zone": "UTC-00:00",
"datetime_range": {
"start": "1970-01-01 00:00:01",
"end": "2070-12-31 23:59:59"
},
{
"jurisdiction_standard_url": "https://www.iso.org/iso-3166-country-codes.html",
<<STANDARD IDENTIFIED
"jurisdiction_country": "GB",
"jurisdiction_subcountry": "ENG"
}
],
"category_applicable": {
"industry": [
{
"industry_standard_url": "https://unstats.un.org/unsd/classifications/Econ/isic",
<<STANDARD IDENTIFIED
"isic_industry_code": " 8530 ",
"isic_industry_name": " Higher education "
}
],
"good_service_asset": [
{
"good_service_asset_standard_url": "https://www.unspsc.org/",
<<STANDARD IDENTIFIED
"unspsc_code": " 60103500 ",
"unspsc_name": " Political science "
}
]

I notice that there's one use of a standard that's missing the reference:

{
"entity_id": "Yjs73-j&js74jdsi",
"entity_name_eng": "Xalgorithms Foundation",
"entity_url": "https://www.xalgorithms.org"
}

So it should be amended as follows:

{
"entity_id_standard_url": "https://www.rfc-editor.org/rfc/rfc4122",
"entity_id": "Yjs73-j&js74jdsi",
"entity_name_eng": "Xalgorithms Foundation",
"entity_url": "https://www.xalgorithms.org"
}

Please let me know if this method and style seems optimal for the RuleMaker application developer role.


Identification of Standards by the rulemaker_author

If my method above, or something like it, is suitable, then can we create a similar approach for any standard that a rule_author may want to cite because they are using it in one or more fields of one or more sentences? I am not sure, but maybe it could borrow some of the design thinking Don and I did last year on how to do inline calls to lookup tables: https://gitlab.com/-/snippets/2145557

Actions #4

Updated by Ted Kim almost 2 years ago

I'm glad I asked for clarification and this is more or less what I had thought I needed to implement.
To implement the standards, the "Context" and "Categories" tabs will need to be implemented as shown on the figma design.

Actions

Also available in: Atom PDF