From ac03250303f21ffb69f9c2b70381b416e80f440b Mon Sep 17 00:00:00 2001 From: aen <aen@kereval.com> Date: Fri, 13 Sep 2019 13:50:51 +0200 Subject: [PATCH] User manuals reviewed --- XDS-Toolkit/user.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/XDS-Toolkit/user.md b/XDS-Toolkit/user.md index 03250c7..9720d6e 100644 --- a/XDS-Toolkit/user.md +++ b/XDS-Toolkit/user.md @@ -24,15 +24,17 @@ The Conformance Test tool is organized into three area: testing environment setu ## Testing Environment Setup -The Testing Environment Setup, starts with the selection of the actor type to be tested. Once selected the available profile options that affect the testing of this actor will be displayed. The first tab in this collection is always the Required tests for the selected actor type. +The Testing Environment Setup starts with the selection of the actor type to be tested. Once selected, the available profile options that affect the testing of this actor will be displayed. The first tab in this collection is always the Required tests for the selected actor type. ## Initialization -Before tests are run the Testing Environment must be initialized. Before this can be done we must indicate the system to be tested, the environment (Toolkit environment, not test environment) to be used and the test session where test results will be stored. These selections are made using the Test Context editor found in the upper right corner of the tool. This editor is documented separately [here](#test-context-definition). +Before tests are run, the Testing Environment must be initialized. Before this can be done, we must indicate the system to be tested, the environment (Toolkit environment, not test environment) to be used and the test session where test results will be stored. These selections are made using the Test Context editor found in the upper right corner of the tool. This editor is documented separately [here](#test-context-definition-test-context-def). Once the Test Context is established, the button labeled Initialize Testing Environment can be used to build the testing environment. The initialization that occurs is different for each actor type. -As an example of actor specific initialization, this is what happens for testing a Document Repository. A Document Registry simulator is created. A Patient ID is generated an is sent to the Registry in a Patient Identity Feed message. Instructions are then displayed for the user to configure the Repository under test to forward Register transactions to this Registry simulator. +As an example of actor specific initialization, here is what happens for testing a Document Repository : + +A Document Registry simulator is created. A Patient ID is generated and is sent to the Registry in a Patient Identity Feed message. Instructions are then displayed for the user to configure the Repository under test to forward Register transactions to this Registry simulator. When this initialization is complete, status and details about the initialization is displayed immediately below. @@ -68,7 +70,7 @@ There are times when you want to discard your current test results and start aga Within the initialization section of the tool is a check box labeled _Reset - Initialize will delete all supporting simulators and Patient IDs and recreate them_. If set when you press the _Initialize Testing Environment_ button the current test context (orchestration) will be discarded and recreated. This includes the Patient IDs used. Beware that when this is done the content is really deleted. You must separately delete the test results using the trash can icon. -The other approach is much broader. The above reset affects the initialization and results for a single option on a single actor. If you want to a big delete open the Test Context dialog (blue box on the upper right corner of the display), select a Test Session and press _Clear Test Session_. This will delete the orchestration and test results for all actors tested using this test session. It will even forget which system you were testing. +The other approach is much broader. The above reset affects the initialization and results for a single option on a single actor. If you want to do a broader delete open the Test Context dialog (blue box on the upper right corner of the display), select a Test Session and press _Clear Test Session_. This will delete the orchestration and test results for all actors tested using this test session. It will even forget which system you were testing. ## Color codes @@ -92,9 +94,9 @@ Next is a right-facing arrow which is the run button. Since this run button is o Following the top bar is a table of test statistics. The color codes are documented in this table. -The rest of this section is the list of tests each shown as a horizontal bar. Each is color coded with its status. Tests that have been run (with error or success) show a run date and an eyeball icon which takes you to the test details tab (Toolkit Inspector). +The rest of this section is the list of tests, each shown as a horizontal bar. Each is color coded with its status. Tests that have been run (with error or success) show a run date and an eyeball icon which takes you to the test details tab (Toolkit Inspector). -Clicking on a test bar will open the test showing its details right below the bar. Any number of tests can be open at once. +Clicking on a test bar will open the test, showing its details right below the bar. Any number of tests can be open at once. ### Interaction Sequence Diagram -- GitLab