Difference between revisions of "Testscenario test"
(→Create a project test) |
(→Introduction) |
||
(31 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
=Introduction= | =Introduction= | ||
− | This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is | + | This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]). |
To execute the scenario, you need at least two user accounts: | To execute the scenario, you need at least two user accounts: | ||
# A DBA user for creating the project | # A DBA user for creating the project | ||
# A Project administrator for populating the project | # A Project administrator for populating the project | ||
+ | # A general author account | ||
=Steps to perform for this scenario= | =Steps to perform for this scenario= | ||
==Start with clean setup== | ==Start with clean setup== | ||
Delete the project if it already exists. | Delete the project if it already exists. | ||
+ | |||
+ | This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test | ||
+ | |||
==Create a project test== | ==Create a project test== | ||
Login as the DBA user. See [[ART_maintenance_manual#Creating_a_project]] for further instructions. | Login as the DBA user. See [[ART_maintenance_manual#Creating_a_project]] for further instructions. | ||
Line 17: | Line 21: | ||
| Name || Test: Vital Signs CDA Document | | Name || Test: Vital Signs CDA Document | ||
|- | |- | ||
− | | id || 2.16.840.1.113883. | + | | id || 2.16.840.1.113883.3.1937.99.99.906 |
|- | |- | ||
| prefix || test- | | prefix || test- | ||
Line 34: | Line 38: | ||
|} | |} | ||
− | == | + | After clicking "Create Project" you return on an empty "new project" screen. No indication is given that the project was created successfully. |
− | General: | + | |
− | Add | + | To verify the project creation, logout as DBA and login as project administrator. You should now see the project in the project's list menu (the round icon to the left of "Terminology"). |
+ | |||
+ | ==Modify base project== | ||
+ | |||
+ | Login as project administrator and open the test project you just created. | ||
+ | |||
+ | All actions in this sections are done on the base project's data, accessible with the row of tabs (General, Copyright, etc.). | ||
+ | |||
+ | ===General tab=== | ||
+ | |||
+ | # Add or change a description | ||
+ | # [TBD] Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references' | ||
+ | |||
+ | ===Copyright tab=== | ||
+ | |||
+ | # Add a Contributer by clicking the +. | ||
+ | # Enter name and contact information. | ||
+ | # Add a logo from your computer by clicking on add and then browse. | ||
+ | # Enter the correct Copyright years. | ||
+ | |||
+ | ===Authors tab=== | ||
+ | # Add an author by clicking on the +. Create authors: projectadmin, author, issuesuser. | ||
+ | # Fill in the name of the author user and give it an email-address. | ||
+ | |||
+ | ===Ids tab=== | ||
+ | |||
+ | For more information: [[ART_Project_Editor#Maintaining_a_local_OID_Registry|Project editor manual]]. | ||
+ | |||
+ | # Add external an external Id by clicking on the +. | ||
+ | # Fill in the Id (e.g. 1.2.3), Designation (en-US) and some Display name | ||
+ | |||
+ | ===Governance Groups tab=== | ||
− | + | For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]]. | |
− | + | # Make the project member of a governance group (e.g. ART-DECOR) by clicking on the + to the left of the governance group name. | |
− | |||
− | |||
− | |||
− | |||
− | == | + | ==Datasets== |
− | + | Login as project author. | |
− | + | For this section, click on the Datasets menu (in the top menu bar). | |
− | == | + | ===Basic dataset changes=== |
− | |||
− | |||
− | |||
− | + | Use the "Datasets" tab. Make some basic changes to the test dataset: | |
− | Make the | ||
− | |||
− | + | # Add a version label. | |
− | Add a version label. | + | # Fill in a dataset description |
− | Fill in a dataset description | + | # Save |
− | |||
− | |||
− | + | ===Add concepts=== | |
− | + | For more information check the [[ART_Dataset_Editor|Dataset editor manual]]. | |
− | |||
− | |||
− | |||
− | |||
− | For more information check the [[ART_Dataset_Editor|Dataset editor manual]] | ||
− | Change the dataset status to final, | + | Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]] |
+ | |||
+ | # Add the Person concept by clicking on the + | ||
+ | # Enter Description, Source, Rationale, Operationalization, Comment. | ||
+ | # For each concept: | ||
+ | ## Select the right kind of type (group or item) | ||
+ | ## Add a name for the concept. | ||
+ | ## At 'Value' select the type | ||
+ | # To add a new Property click on the + next to the word 'Properties'. | ||
+ | # Change the dataset status to: | ||
+ | ## final (green bullet, top right) | ||
+ | ## Deprecated (Blue bullet, top right) | ||
==Scenarios== | ==Scenarios== | ||
− | Add a scenario by clicking the + next to Scenarios. | + | |
− | Fill in a name and description | + | For this section, click on the Datasets menu (in the top menu bar). |
− | + | ||
− | Fill in a name | + | ===Add actors=== |
− | Add templates in the concepts section by clicking on the pencil next to the word Template in Concepts. | + | |
− | Select a template and then choose 'Select dynamic' or 'Select static'. | + | Use the Actors tab. |
+ | |||
+ | # Add two actors by clicking on the + | ||
+ | |||
+ | ===Scenarios tab=== | ||
+ | |||
+ | Use the Scenarios tab. | ||
+ | |||
+ | # Add a scenario by clicking the + next to Scenarios. | ||
+ | ## Fill in a name and description for the new scenario | ||
+ | ## Save | ||
+ | # Open the scenario by clicking on the + left of its name in the tree view on the left. | ||
+ | # Click on the default group "Group" | ||
+ | # Click on the + at the top of the tree view. This will create a new group. | ||
+ | ## Fill in a name and description for the new group | ||
+ | ## Save | ||
+ | # Select (in turn) in the tree view the transactions of the group (called Initial and Response) | ||
+ | ## Edit them (by clicking the pencil in top right) | ||
+ | ## Fill in some data (label, description, change name) | ||
+ | ## [TBD does not work] Add templates in the concepts section by clicking on the pencil next to the word Template in Concepts. Select a template and then choose 'Select dynamic' or 'Select static'. | ||
+ | ## Save | ||
+ | |||
+ | [TBD does not work] | ||
You can add Concepts to the added template by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts. | You can add Concepts to the added template by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts. | ||
To add concepts in the transaction click on the + next to the concepts you want to add. | To add concepts in the transaction click on the + next to the concepts you want to add. | ||
Line 90: | Line 142: | ||
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]] | For more information check the [[ART_Scenario_Editor|Scenario Editor manual]] | ||
− | ==Value Sets in Terminology== | + | ==Value Sets (in Terminology) == |
− | |||
− | + | For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets. | |
− | + | For more information: [[ART_Value_Set_Editor|Value Set Editor manual]] | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | # Create a new valueset. | |
− | + | ## Click on the + above the tree view on the left-hand side. A new window opens. | |
+ | ## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word. | ||
+ | |||
+ | ## Add first value | ||
+ | ### Change the source to ATC, click Select to activate it, this will show a popup which the search window for the codesystem. | ||
+ | ### Enter search term: atc | ||
+ | ### Click button: Add to valueset | ||
+ | ### Click button: Close | ||
+ | ## Add second value | ||
+ | ### Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type (L, A, S, D). Also fill in a code (required) and a Display name (required). | ||
+ | ## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.) | ||
+ | # [TBD does not work] Create a reference | ||
+ | ## Precondition: repository reference to a bbr project is already present | ||
+ | ## Click on the "chain" icon above the tree view on the left-hand side | ||
+ | ## Search for a valueset, and select it to save it to this project | ||
+ | |||
+ | '''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it! | ||
==Templates== | ==Templates== | ||
− | + | ||
− | A new window opens | + | For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry. |
+ | |||
+ | For more information: [[ART_Template_Editor|Template editor manual]] | ||
+ | # Create a template. Click on the + above the tree view on the left-hand side. A new window opens. | ||
+ | ## Select a prototype | ||
+ | |||
+ | [TBD does not work properly now] | ||
+ | For Heart rate choose the CDA Observation template and then click Select. | ||
Now you can fill in a Version label, Display Name and Name. | Now you can fill in a Version label, Display Name and Name. | ||
The display name may hold spaces but the Name has to be one word. | The display name may hold spaces but the Name has to be one word. | ||
Line 118: | Line 186: | ||
You can always edit a template by clicking on it in Templates. Then click on the pencil next to the name of the template to edit. | You can always edit a template by clicking on it in Templates. Then click on the pencil next to the name of the template to edit. | ||
− | + | ==Issues== | |
− | + | For this section, click on the Issues menu (in the top menu bar). | |
− | |||
− | |||
− | |||
− | |||
− | + | For more information: [[ART_Issues|Issue manual]]. | |
− | + | # Add an issue by clicking on the flag to the right | |
+ | ## Select the correct type (incident, change request, for future consideration, request for information/education) | ||
+ | ## Fill in a title. | ||
+ | ## Select the desired priority (Lowest, Low, Normal, High, Highest). | ||
+ | ## Fill in description | ||
+ | ## Assign issue to an author | ||
+ | ## Save |
Latest revision as of 16:37, 24 March 2020
Contents
Introduction
This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[1]] or [[2]]).
To execute the scenario, you need at least two user accounts:
- A DBA user for creating the project
- A Project administrator for populating the project
- A general author account
Steps to perform for this scenario
Start with clean setup
Delete the project if it already exists.
This can be done only by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test
Create a project test
Login as the DBA user. See ART_maintenance_manual#Creating_a_project for further instructions.
Name | Test: Vital Signs CDA Document |
id | 2.16.840.1.113883.3.1937.99.99.906 |
prefix | test- |
language | en-US |
Experimental | yes |
Copyright - Contributor | Add your or a random name |
Description | Test: Vital Signs Report Summary CDA Document |
Authors | Add the project administrator as an author |
Dataset name | Test dataset |
After clicking "Create Project" you return on an empty "new project" screen. No indication is given that the project was created successfully.
To verify the project creation, logout as DBA and login as project administrator. You should now see the project in the project's list menu (the round icon to the left of "Terminology").
Modify base project
Login as project administrator and open the test project you just created.
All actions in this sections are done on the base project's data, accessible with the row of tabs (General, Copyright, etc.).
General tab
- Add or change a description
- [TBD] Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'
Copyright tab
- Add a Contributer by clicking the +.
- Enter name and contact information.
- Add a logo from your computer by clicking on add and then browse.
- Enter the correct Copyright years.
Authors tab
- Add an author by clicking on the +. Create authors: projectadmin, author, issuesuser.
- Fill in the name of the author user and give it an email-address.
Ids tab
For more information: Project editor manual.
- Add external an external Id by clicking on the +.
- Fill in the Id (e.g. 1.2.3), Designation (en-US) and some Display name
Governance Groups tab
For more information: Dealing with governance groups.
- Make the project member of a governance group (e.g. ART-DECOR) by clicking on the + to the left of the governance group name.
Datasets
Login as project author. For this section, click on the Datasets menu (in the top menu bar).
Basic dataset changes
Use the "Datasets" tab. Make some basic changes to the test dataset:
- Add a version label.
- Fill in a dataset description
- Save
Add concepts
For more information check the Dataset editor manual.
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[3]] or [[4]]
- Add the Person concept by clicking on the +
- Enter Description, Source, Rationale, Operationalization, Comment.
- For each concept:
- Select the right kind of type (group or item)
- Add a name for the concept.
- At 'Value' select the type
- To add a new Property click on the + next to the word 'Properties'.
- Change the dataset status to:
- final (green bullet, top right)
- Deprecated (Blue bullet, top right)
Scenarios
For this section, click on the Datasets menu (in the top menu bar).
Add actors
Use the Actors tab.
- Add two actors by clicking on the +
Scenarios tab
Use the Scenarios tab.
- Add a scenario by clicking the + next to Scenarios.
- Fill in a name and description for the new scenario
- Save
- Open the scenario by clicking on the + left of its name in the tree view on the left.
- Click on the default group "Group"
- Click on the + at the top of the tree view. This will create a new group.
- Fill in a name and description for the new group
- Save
- Select (in turn) in the tree view the transactions of the group (called Initial and Response)
- Edit them (by clicking the pencil in top right)
- Fill in some data (label, description, change name)
- [TBD does not work] Add templates in the concepts section by clicking on the pencil next to the word Template in Concepts. Select a template and then choose 'Select dynamic' or 'Select static'.
- Save
[TBD does not work] You can add Concepts to the added template by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts. To add concepts in the transaction click on the + next to the concepts you want to add. Click save and then close the window to go back to the transaction.
You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit. For more information check the Scenario Editor manual
Value Sets (in Terminology)
For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.
For more information: Value Set Editor manual
- Create a new valueset.
- Click on the + above the tree view on the left-hand side. A new window opens.
- Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.
- Add first value
- Change the source to ATC, click Select to activate it, this will show a popup which the search window for the codesystem.
- Enter search term: atc
- Click button: Add to valueset
- Click button: Close
- Add second value
- Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type (L, A, S, D). Also fill in a code (required) and a Display name (required).
- Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)
- Add first value
- [TBD does not work] Create a reference
- Precondition: repository reference to a bbr project is already present
- Click on the "chain" icon above the tree view on the left-hand side
- Search for a valueset, and select it to save it to this project
REMARK: To see the newly created value set in the Value Sets screen you have to refresh it!
Templates
For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.
For more information: Template editor manual
- Create a template. Click on the + above the tree view on the left-hand side. A new window opens.
- Select a prototype
[TBD does not work properly now] For Heart rate choose the CDA Observation template and then click Select. Now you can fill in a Version label, Display Name and Name. The display name may hold spaces but the Name has to be one word. Fill in a description. Add an Example by clicking on the little + next to the word. Then add or delete xml attributes by clicking the little + or 'x' next to the attributes. Click on 'Create template' when you're done. The window will close and you'll be send back to the 'Templates'
You can always edit a template by clicking on it in Templates. Then click on the pencil next to the name of the template to edit.
Issues
For this section, click on the Issues menu (in the top menu bar).
For more information: Issue manual.
- Add an issue by clicking on the flag to the right
- Select the correct type (incident, change request, for future consideration, request for information/education)
- Fill in a title.
- Select the desired priority (Lowest, Low, Normal, High, Highest).
- Fill in description
- Assign issue to an author
- Save