Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,7 @@ Unpublished/
MAC: `./run/bash_run.sh`
- If you haven't run the setup script before, don't worry; it will run automatically when you execute this command.
- You will be prompted to select the rule you wish to run, as well as the test case(s).
- You will also be prompted with what logs you would like to see and if you want them captured in a txt file for each test case (these are useful attachments to issues created for CORE Rules Engine Bug Reports)

**Verify Results.**

Expand Down
12 changes: 5 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the mention of intellisense still valid as their is no rules editor anymore? Please let me know if I am misunderstanding something?


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)

Expand Down
2 changes: 1 addition & 1 deletion docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
370 changes: 188 additions & 182 deletions docs/dev/doc.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/dev/doc.yuml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think the name in the bracket also change? as I guess it is not an editor anymore.


// API
[API]-.->[cdisc-rules-engine]
Expand Down
11 changes: 0 additions & 11 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

</details>
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This belongs to previous tag is removed. Should we restore it?


<details><summary>
My test data dates are being treated as numbers or the engine is returning errors indicating that my dates cannot be parsed.
</summary>

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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This FAQ is still valid as excel dataset is supported with rules engine. Maybe we can just remove the mention of editor instead of the whole FAQ?


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).

</details>
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
<div id="app"></div>
<script>
window.$docsify = {
name: "Conformance Rules Editor",
repo: "https://github.com/cdisc-org/conformance-rules-editor",
name: "CDISC Open Rules",
repo: "https://github.com/cdisc-org/cdisc-open-rules",
loadSidebar: true,
subMaxLevel: 3,
};
Expand Down