Difference between revisions of "TestIT:Guide"
NolekAdmin (talk | contribs) |
NolekAdmin (talk | contribs) |
||
| Line 19: | Line 19: | ||
The figure below shows the general guide workflow. | The figure below shows the general guide workflow. | ||
| − | |||
| − | + | <gallery> | |
| − | | START | Starting a guide can be done in two ways; | + | File:testit_guide_workflow_pic1.png| Workflow |
| − | | GUIDE STEP | There are different types of [[testit:9guide:9.5_guide_steps|guide steps]] | | + | </gallery> |
| − | | OK | The OK step can be any step in the guide. | + | |
| − | | NOK | The NOK step can be any step in the guide. | + | |
| − | | BACK | The back step can be any step in the guide. The action will be a Back button pressed. | | + | '''Explanation of the steps:''' |
| − | | GUIDE STEP (last) | The OK of the last guide step, depends on which guide is running. | + | |
| + | {| class="wikitable" | ||
| + | !colspan="2"|Steps | ||
| + | |- | ||
| + | |START | ||
| + | |Starting a guide can be done in two ways; <br> - [[testit:9guide:9.4_how_to_run_a_guide#9.4.1_Internal|Internal]] <br> - [[testit:9guide:9.4_how_to_run_a_guide#9.4.2_External|External]] | ||
| + | |- | ||
| + | |GUIDE STEP | ||
| + | |There are different types of [[testit:9guide:9.5_guide_steps|guide steps]] | ||
| + | |- | ||
| + | |OK | ||
| + | |The OK step can be any step in the guide. <br> The action can be: <br> - OK button pressed <br> - OK I/O set | ||
| + | |- | ||
| + | |NOK | ||
| + | |The NOK step can be any step in the guide. <br> The action can be: <br> - NOK button pressed <br> - NOK I/O set <br> - Next validation fails | ||
| + | |- | ||
| + | |BACK | ||
| + | |The back step can be any step in the guide. The action will be a Back button pressed. | ||
| + | |- | ||
| + | |GUIDE STEP (last) | ||
| + | |The OK of the last guide step, depends on which guide is running. <br> - Internal is going to close after the last step. Set the OK step to a guide number, NOT in the guide. <br> - External is going to start over after the last step. Set the OK step to the appropriate guide step. <br> - External is going to close after the last step. Set the OK step to a guide which tells the user to close the guide. | ||
| + | |- | ||
| + | |} | ||
==== 9.1.1 Guide step flow ==== | ==== 9.1.1 Guide step flow ==== | ||
Revision as of 14:19, 19 August 2019
Contents
9. Guide
The guide service allows you to see the guide in setup. In the first section, a guide workflow is shown.
An overview of the guide:
Options:
Home - go back to the home page
Add guide - add a new guide
9.1 Guide workflow
The figure below shows the general guide workflow.
Workflow
Explanation of the steps:
| Steps | |
|---|---|
| START | Starting a guide can be done in two ways; - Internal - External |
| GUIDE STEP | There are different types of guide steps |
| OK | The OK step can be any step in the guide. The action can be: - OK button pressed - OK I/O set |
| NOK | The NOK step can be any step in the guide. The action can be: - NOK button pressed - NOK I/O set - Next validation fails |
| BACK | The back step can be any step in the guide. The action will be a Back button pressed. |
| GUIDE STEP (last) | The OK of the last guide step, depends on which guide is running. - Internal is going to close after the last step. Set the OK step to a guide number, NOT in the guide. - External is going to start over after the last step. Set the OK step to the appropriate guide step. - External is going to close after the last step. Set the OK step to a guide which tells the user to close the guide. |
9.1.1 Guide step flow
The figure shows an overview of a guide step flow, like where the validation of the workflow is: TestIT:9guide:930.png?direct&300
__Explanation of the flow:__ | INIT VALIDATION | Before opening the guide step, the init validation is running. \\ - If the validation is OK, the guide step will open \\ - If the validation is not ok, the init validation NOK step will be opened | | GUIDE STEP | The actual guide step is opened | | RELEASE VALIDATION | The release validation is running while the step is open. \\ - If the validation is OK, the OK button will be released \\ - If a next release I/O is selected, it will be set on validation OK \\ - If a validation success message is set, this will be shown on validation OK | | NEXT VALIDATION | If OK button is pressed or OK I/O set, the next validation will be running \\ - If a timer is set, it will start \\ \\ - If the validation is OK, the next guide step will open \\ - If not, the validation will keep running for the timeout period \\ \\ - If the timeout runs out, the timeout message will be shown or the timeout step will be opened |
