From 2755a1e141ee5a90a54a1a72165a2815b1a36acb Mon Sep 17 00:00:00 2001 From: Samuel Johnson Date: Mon, 1 Jun 2026 12:00:52 -0400 Subject: [PATCH 1/2] remove editor --- docs/README.md | 12 +- docs/_sidebar.md | 2 +- docs/dev/doc.svg | 370 +++++++++++++++++++++++----------------------- docs/dev/doc.yuml | 2 +- docs/faq.md | 11 -- docs/index.html | 4 +- 6 files changed, 197 insertions(+), 204 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8fc71f263..46d25a3d1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,20 +5,18 @@ 1. Rules are written to flag violations, i.e., triggered on a negative case. 1. A conformance rule can be either a data rule or a business rule. A data rule is computable with elements to be checked for conformance are anchored to data, CORE-2 OPEN metadata, as well as elements and attributes in an ODM document. When a data rule is outside of the rule engine's capability, then it is not executable. -## Rule Editor +## Rule Editing with CDISC Open Rules -Production URL: https://rule-editor.cdisc.org -Training URL: https://training-rule-editor.cdisc.org - -Access to CDISC Library account is required. +Production URL: https://github.com/cdisc-org/cdisc-open-rules +Training URL: https://github.com/cdisc-org/cdisc-open-rules-training ### Schema for Rule Schematic -Intellisense is informed by a schema in JSON format. The editor also uses it to provide suggestions. +Intellisense is informed by a schema in JSON format. Links to the schema: -- Base Schema: https://github.com/cdisc-org/cdisc-rules-engine/blob/main/resources/schema/rule/CORE-base.json +- Base Schema: https://github.com/cdisc-org/cdisc-rules-engine/blob/main/resources/schema/rule-merged/CORE-base.json Reference: [JSON schema as a standard](https://json-schema.org) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 990524a0d..2f5bc76a0 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -12,7 +12,7 @@ - [Metadata Variables](metadata_variables.md) - [Test Data](test_data.md) - [Test Results](test_results.md) -- [Custom Editor Columns & Rules](customrules.md) +- [Custom Rules](customrules.md) - [JSONata Functions](jsonata_functions.md) - [Ticket Submission](ticket_submission.md) - [FAQ](faq.md) diff --git a/docs/dev/doc.svg b/docs/dev/doc.svg index 4602cb419..65daab532 100644 --- a/docs/dev/doc.svg +++ b/docs/dev/doc.svg @@ -4,347 +4,353 @@ - - + + G - + A0 - - -UI - -React -Node.js -TS + + +UI + +React +Node.js +TS A1 - - -Rule List - -Add-Rule() -Save-Rule() -Revert-Changes() -Delete-Rule() -Publish-Rule() -Sort() -Field-Search() -Global-Search() + + +Rule List + +Add-Rule() +Save-Rule() +Revert-Changes() +Delete-Rule() +Publish-Rule() +Sort() +Field-Search() +Global-Search() A0->A1 - - + + A2 - - -Rule YAML Editor - -VS-Code-Monaco - -JSON-Schema-AutoComplete() -JSON-Schema-Validate() -JSON-Schema-Autosuggest() -Code-Editor() + + +Rule YAML Editor + +VS-Code-Monaco + +JSON-Schema-AutoComplete() +JSON-Schema-Validate() +JSON-Schema-Autosuggest() +Code-Editor() A0->A2 - - + + A3 - - -Rule Test - -Validate-YAML-Syntax() -Validate-against-Schema() -Convert-Rule-to-JSON() -Load-Test-Data() -Exceute-Rule() + + +Rule Test + +Validate-YAML-Syntax() +Validate-against-Schema() +Convert-Rule-to-JSON() +Load-Test-Data() +Exceute-Rule() A0->A3 - - + + A15 - -Query - -limit -offset -orderBy -order -select -filters + +Query + +limit +offset +orderBy +order +select +filters A1->A15 - - + + - - -A6 - - -cdisc-rules-engine-repo - -Get-Schema() + + +A19 + +cdisc-open-rules-repo - + -A2->A6 - - - +A2->A19 + + + A13 - -Payload - -Rule -Test-Datasets + +Payload + +Rule +Test-Datasets A3->A13 - - + + A4 - - -API - -Node.js -TS - -Azure Function Apps + + +API + +Node.js +TS + +Azure Function Apps A5 - - -cdisc-rules-engine - -Execute-Rule() + + +cdisc-rules-engine + +Execute-Rule() A4->A5 - - + + + + + +A6 + + +cdisc-rules-engine-repo + +Get-Schema() A4->A6 - - + + A7 - - -Base Storage -Provider - -Get-Rules() -Get-Rule() -Post-Rule() -Patch-Rule() -Delete-Rule() -Max-CoreId() + + +Base Storage +Provider + +Get-Rules() +Get-Rule() +Post-Rule() +Patch-Rule() +Delete-Rule() +Max-CoreId() A4->A7 - - + + A14 - -Result - -Errors -Postives -Negatives -Absent-Variable-Skips + +Result + +Errors +Postives +Negatives +Absent-Variable-Skips A5->A14 - - + + A8 - -Cosmos SQL Storage + +Cosmos SQL Storage A7->A8 - - + + A16 - -Rule - -content -created -creator -id -history -status -json + +Rule + +content +created +creator +id +history +status +json A7->A16 - - + + A17 - -Users - -id + +Users + +id A7->A17 - - + + A9 - - -Base Users Provider - -Get-Users-By-Ids() -Get-Users-By-Name() -Get-User-Permissions() + + +Base Users Provider + +Get-Users-By-Ids() +Get-Users-By-Name() +Get-User-Permissions() A10 - -MS Graph Users + +MS Graph Users A9->A10 - - + + A18 - -User - -id -name -company -write_allowed + +User + +id +name +company +write_allowed A9->A18 - - + + A11 - -Azure SWA / -Emulator + +Azure SWA / +Emulator A12 - - -Auth - -Azure B2C + + +Auth + +Azure B2C A11->A12 - - + + A13->A5 - - + + A14->A3 - - + + A15->A7 - - + + A16->A1 - - + + A17->A9 - - + + A18->A7 - - + + diff --git a/docs/dev/doc.yuml b/docs/dev/doc.yuml index e1c306401..db7cfcdd8 100644 --- a/docs/dev/doc.yuml +++ b/docs/dev/doc.yuml @@ -43,7 +43,7 @@ [UI]-.->[Rule List] [UI]-.->[Rule YAML Editor] [UI]-.->[Rule Test] -[Rule YAML Editor]<->[cdisc-rules-engine-repo] +[Rule YAML Editor]<->[cdisc-open-rules-repo] // API [API]-.->[cdisc-rules-engine] diff --git a/docs/faq.md b/docs/faq.md index 9056ef65f..02e608978 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -240,14 +240,3 @@ any: If you provide a dataset AE where both AESEV and AESHOSP have empty values in a record, this rule will only flag a single error for that record, but it will display the empty values for both variables. - - -
-My test data dates are being treated as numbers or the engine is returning errors indicating that my dates cannot be parsed. - - -When using Excel for data, one of the tradeoffs is that it tries to autoformat. If Excel recognizes a date, it will convert it to a numeric representation of the date and display it formatted. When the Rule Editor loads the date cell, it loads the number instead of the original text string date. You can confirm this by viewing the loaded test data section in the “Load Datasets” panel of the Rule Editor and checking if the date values are numbers instead of character strings. - -To fix this issue, you can force transparency by [formatting the cells in your spreadsheet as "text"](https://support.microsoft.com/en-us/office/format-numbers-as-text-583160db-936b-4e52-bdff-6f1863518ba4). - -
diff --git a/docs/index.html b/docs/index.html index 0efd5db62..ff2c89a70 100644 --- a/docs/index.html +++ b/docs/index.html @@ -18,8 +18,8 @@