TABLE OF FIGURES... II A - DISCUSSION...1 B - CONFIGURATION...7. B.1 - Setup Dialog... 7 B.2 - Description... 7 B.3 - Controls...

Transcription

1 Radiant Technologies, Inc. 2835D Pan American Freeway NE Albuquerque, NM Tel: Fax: Table of Contents TABLE OF FIGURES... II A - DISCUSSION...1 B - CONFIGURATION...7 B.1 - Setup Dialog... 7 B.2 - Description... 7 B.3 - Controls... 8 C - EXECUTION, ARCHIVE RECALL AND EXPORTING...9 C.1 - Execution... 9 C.2 - Archive Recall... 9 C.3 Admin Info C.4 - Exporting C.5 - Controls C.6 - Discussion D USER VARIABLES...20 E - CHANGE AND VERSION RECORD...21 I

2 Table of Figures Figure A.1 - Branch Looping Conditions Figure A.2 - Branch Abort from the Manual Exit Task Figure A.3 - Manual Branch Abort Task Execution Figure A.4 - Manual Branch Abort Logic Example One Figure A.5 - Manual Branch Abort Logic Example Two Figure A.6 - Manual Branch Abort Logic Example Three Figure A.7 - Manual Branch Abort Logic Example Four Figure B Manual Branch Abort Task Configuration Dialog Figure C Manual Branch Abort Task Execution Dialog Figure C Access the Manual Branch Abort Task in the DataSet Archive Figure C Configuration Dialog for the Task Recalled from the DataSet Archive. 11 Figure C Execution Results for the Recalled Task Figure C.3.1 The Admin Info Subdialog Figure C Export Dialog Figure C Standard Windows File Browser Dialog Figure C Export Configuration Dialog - Printer Option Figure C Standard Windows Printer Configuration Dialog Figure C Sample Manual Branch Abort Task Text Export File Figure C.t.4 - Sample Manual Branch Abort Task Excel Export Output Figure C Sample Manual Branch Abort Task Word Export Output II

3 A - Discussion Radiant Technologies, Inc. 2835D Pan American Freeway NE Albuquerque, NM Tel: Fax: radiant@ferrodevices.com The Manual Branch Abort Task is very similar to the Manual Exit Task. Indeed the function performed by the Manual Branch Abort Task can be performed using the Manual Exit Task, as well as the Pause, Delay and Waveform Tasks, as discussed below. However, the Manual Branch Abort cannot stop execution of the Test Definition. Instead, the Task is always programmed into a Branch Loop. When the Task executes, a dialog appears that allows the user to select a Branch Abort or a Branch Continue condition. Under the Branch Continue condition, the program will continue to execute normally. The Branch Task will Branch to the Branch Target Task unless the Branch Logic Condition is not met. The Branch Abort Task will execute at each iteration of the Branch Loop. If the Branch Abort condition is set, the subsequent Branch Task will not Branch, regardless of the Branch Logic Condition. Figure a.1 shows the situation. Figure A.1 - Branch Looping Conditions. A more detailed description of the process is presented in the Execution page. As mentioned above, the primary function of the Manual Branch Abort Task is also available as a secondary function in all other Tasks that present a dialog during execution. The Manual Exit Task is presented in Figure A.2 as an example. 1

4 Figure A.2 - Branch Abort from the Manual Exit Task. If the Branch Loop Abort control is checked before Continue, the execution will continue to the Branch Task. The Branch Task will not return control to the Branch Target Task regardless of the Branch Logic Condition. Note that in this case, the Manual Exit Task is not performing its primary function, since the Exit button is not clicked and the Test Definition continues to execute. However, the secondary function of aborting the Branch Loop is being accomplished. The Manual Branch Abort Task is devoted solely to controlling the Test Definition Branch Looping. Its execution dialog is shown in Figure A.3. Figure A.3 - Manual Branch Abort Task Execution. It is important to note that if the Manual Branch Abort Task follows other Branch aborting Tasks in the Test Definition (including other Manual Branch Abort Tasks) it will take precedence and overwrite any aborting action taken by previous Tasks. If some previous Task set the Branch Abort condition, but the Manual Branch Abort set the Continue condition, the Branch Task is free to Branch. If the Manual Branch Abort sets 2

5 abort, the Branch will abort unless a subsequent Manual or Automatic Branch Abort Task changes the condition. If a Manual Branch Abort sets an abort, the abort may be cleared by a subsequent Manual or Automatic Branch Abort Task. However, Tasks that have Branch Abort as a secondary function cannot clear a Branch Abort flag. On the other hand, if a Manual Branch Abort Task sets a "Continue" condition, any subsequent Task can set the Branch Abort condition. Consider the figures and the Tables below. Case 1 Figure A.4 - Manual Branch Abort Logic Example One. Manual Branch Pause Task Manual Branch Branch Logic Branch Abort 1 Abort 2 Condition Continue Continue Continue Continue Continue Continue Continue Continue Abort Abort Continue Continue Abort Continue Abort Continue Continue Abort Abort Abort Continue Abort Continue Continue Continue Continue Abort Continue Abort Abort Continue Abort Abort Continue Abort Continue Abort Abort Abort Abort Abort Continue Continue Continue Continue Abort Continue Continue Abort Abort Abort Continue Abort Continue Abort Abort Continue Abort Abort Abort Abort Abort Continue Continue Continue Abort Abort Continue Abort Abort Abort Abort Abort Continue Abort Abort Abort Abort Abort Abort In this example a Manual Branch Abort is followed by a Pause Task, then a second Manual Branch Abort before the Branch Task. This is not meant to be a practical example. The Branch decision is a function of the second Manual Branch Abort Task and the Branch Logic Condition. If either of these indicate an abort, the Branching will cease. If both indicate continued Branching the Branching will continue. As a result the first Manual Branch Abort performs no useful function. The Pause Task may be useful in its primary function, but does not add value as a Branch control. Note that the Manual Branch Abort performs as a secondary function the Pause Task primary function of 3

6 pausing the Test Definition execution and providing the user with a prompt that may include a User Variable. Case 2 Figure A.5 - Manual Branch Abort Logic Example Two. Manual Branch Abort Pause Branch Logic Condition Branch Continue Continue Continue Continue Continue Continue Abort Abort Continue Abort Continue Abort Continue Abort Abort Abort Abort Continue Continue Abort Abort Continue Abort Abort Abort Abort Continue Abort Abort Abort Abort Abort This case simplifies Case 1 by removing the second Manual Branch Abort Task. This makes both the Pause Task and the Manual Branch Abort Task instrumental in controlling the Loop Branching. If any of the Branch control conditions is set to Abort, the Branch will abort. All conditions must be set to "Continue" to continue Branching. Case 3 Figure A.6 - Manual Branch Abort Logic Example Three. 4

7 Pause Manual Branch Abort Branch Logic Condition Branch Continue Continue Continue Continue Continue Continue Abort Abort Continue Abort Continue Abort Continue Abort Abort Abort Abort Continue Continue Continue Abort Continue Abort Abort Abort Abort Continue Abort Abort Abort Abort Abort In this case the order of the Pause Task and the Manual Branch Abort Task is reversed from Case 2. This is also a copy of Case 1 with the initial Manual Branch Abort deleted. The effect of this programming is to render the Pause Task useless as a Branch control Task. Branching is completely controlled by the Manual Branch Abort Task and the Branch Logic Condition. If either aborts the Branching, the Branching will abort. Case 4 Figure A.7 - Manual Branch Abort Logic Example Four. Manual Branch Abort Manual Branch Abort 2 Branch Logic Condition Branch Continue Continue Continue Continue Continue Continue Abort Abort Continue Abort Continue Abort Continue Abort Abort Abort Abort Continue Continue Continue Abort Continue Abort Abort Abort Abort Continue Abort Abort Abort Abort Abort In this case, Case 1 is modified by removing the Pause Task. The conditions remain the same as in Case 1. The initial Manual Branch Abort Task serves no purpose in the Test Definition. Branching depends entirely on the second Manual Branch Abort and the Branch Logic Condition. Changes for Version 4.1.x: Comments field extended to 511 characters. Office/Word/Excel 2000 and later export was added. (Office '97 export was 5

8 eliminated.) Moved to Library->Program Control->Branching. 6

9 B - Configuration Task Name: Manual Branch Abort Version: Last Update: 8 June 2010 In QuikLook Menu: No Folder: Program Control Subfolder: Branching Subsubfolder: None Window Name: Manual Branch Abort Setup Change Record: Change and Version Record Known Bugs: None User Variables Added: User Variables B.1 - Setup Dialog Figure B Manual Branch Abort Task Configuration Dialog. B.2 - Description The setup of the Manual Branch Abort Task is a simple matter. As with all Tasks a name 7

10 is specified. The name should be unique for the Task and should clearly identify the type of Task. A User Self-Prompt can be set to pass a message to the execution dialog to be displayed when the Task executes. The prompt may have a User Variable appended to it (Parameter to Append to Prompt). This variable might be a measurement parameter that would facilitate the decision to abort or continue. Exporting is done from this dialog only on Archive Recall. Changes for Version 4.1.x: Comments field extended to 511 characters. Admin Info button added to access the subdialog. (Not shown in Figure B.1.1. See the discussion under Execution, Archive Recall and Exporting. B.3 - Controls Name Type Default Description Task Name Text BA1:# This serves as a root identifier for this instance of the Manual Branch Abort Task. The Task will be identified with this value in the Editor and the Current Test Definition (CTD). Executed Tasks will be displayed and stored with this name with a. and an execution number appended to it. Each new instance of the Task within the Editor should have a unique Task Name assigned. 30- character limit User Self-Prompt Text "" 60-Characters maximum. A text message that is displayed on Task execution. This allows the user to program a reminder to him/herself. The message may have a User Variable appended to it. The variable might serve as a criterion for deciding whether or not to abort Branching. Parameter to Append to Prompt List <<None> This box is used to select one of the registered User Parameters to Box > append to User Self-Prompt on Task execution. Comments Text A string of up to 511 characters to be written at the user s discretion. Intended to allow a detailed description of the design decision to include the Manual Branch Abort Task. Export Help OK Cancel Button Unpressed Disabled during normal configuration. Enabled only on Archive Recall. This button is used to configure and enable the exporting of Task information. Button Unpressed Read this Help page. Button Unpressed Close the configuration dialog. Accept the configured Task values and add the Task to the Test Definition Button Unpressed Close the configuration dialog. Do not add the Task to the list in the Editor. 8

11 C - Execution, Archive Recall and Exporting C.1 - Execution When the Test Definition execution reaches the Manual Branch Abort Task, a dialog appears as shown in the figure... Figure C Manual Branch Abort Task Execution Dialog. The execution of this Task is very similar to the Pause Task and the Manual Exit Task. The dialog remains visible and the Test Definition remains paused until the user acknowledges the dialog by clicking Abort Branch or Continue Branching. As with both Pause and Manual Exit, a prompt, programmed by the user, appears that may be used to key the Abort or Continue action. The prompt is a one line message that may have any single User Variable appended to it. Clicking Abort Branch will set a flag that tells the subsequent Branch Task to discontinue Branching regardless of the status of the Branch Logic Condition. Clicking Continue Branching will clear that flag. However, the Branch may still terminate based on the results of the Branch Logic Condition comparison. C.2 - Archive Recall As with all Tasks, the Manual Branch Abort Task can be recalled from the DataSet Archive to review the Task configuration and the outcome of its execution. To recall, open the desired DataSet and its Archive. Open the appropriate Executed Test Definition (ETD) and its "Data Folder". Finally, double-click on the desired copy of the Manual Branch Abort Task. 9

12 Figure C Access the Manual Branch Abort Task in the DataSet Archive. First the original configuration dialog appears. The controls show the values as they were configured for the Task execution. Most controls are disabled. The Export and Admin Info controls are active and may be used as described below. Help is also available. 10

13 Cancel will close the dialog. Figure C Configuration Dialog for the Task Recalled from the DataSet Archive. Once the configuration dialog is closed a message box will appear to indicate if the Task allowed Branching to continue or if it was aborted. 11

14 Figure C Execution Results for the Recalled Task. C.3 Admin Info The Admin Info button shown in Figure C.2.2 has been added to all Tasks as of Version 4.2.x. The button opens one of two subdialogs. Program Tasks, such as the Automatic Branch Abort Task present the dialog of Figure C.3.1. Here, the Vision Version and compilation date along with the Task configuration and execution date and time are presented. This information is of minor value to the user. However, Measurement Tasks also present Tester Type, Tester Serial Number and Driver Version. This information can be useful to RTI in helping the customer troubleshoot problems with Vision and/or the tester. Note that the exporting of this information has also been added to the export target applications as described below. Figure C.3.1 The Admin Info Subdialog. 12

15 C.4 - Exporting In order to allow data to be exported from the Task when the Task is recalled from the DataSet Archive, an Export button appears on the recalled configuration dialog. This button is normally disabled, but it is enabled in Archive Regraph as in Figure C.2.2, above. Clicking the button produces the new dialog that appears below. Figure C.4.1 shows the Export configuration dialog in which the "Export Text" option is selected and the browser button enable. Figure C.4.2 shows the browser dialog that opens when the Browse for File Name button is clicked. Figure C Export Dialog. 13

16 Figure C Standard Windows File Browser Dialog. C.5 - Controls Name Type Default Description Select List "Print" Select between the "Print", "Export Text", "Export Word" and "Export Option Box Excel" options. This control enables the Browse for File Name button for Line Spacing Left Margin Tab Spacing Browse for File Name File Name all selections except the "Print" option. Integer 100 This control appears when Select Option is set to "Print". Otherwise it is hidden. Increasing or decreasing this value will increase or decrease the vertical spacing of lines on the printed page. Experimentation will fix the value for any given printer. Integer 100 This control appears when Select Option is set to "Print". Otherwise it is hidden. Increasing or decreasing this value will increase or decrease the left start point of text on the printed page. Experimentation will fix the value for any given printer. Integer 200 This control appears when Select Option is set to "Print". Otherwise it is hidden. Increasing or decreasing this value will increase or decrease the horizontal spacing of tabbed sections of text on the printed page. Experimentation will fix the value for any given printer. Button Unpressed This control is enabled for all export options except "Print". For the remaining options, this control must be selected. The browser dialog will appear where a path and file name must be specified for the export output. Text This control is always disabled and cannot be used to specify the file name or path for Text, Word or Excel export. Once the browser is used to select a path and file name, those will be displayed in this control for review. Note that a path and file name MUST be specified for the "Text" and "Vision" export options and may be specified for "Excel" or "Word". Help Button Unpressed Open this help document for review. OK Button Unpressed Accept the configured export and close the dialog. Exporting will occur when the main data regraph dialog is closed. 14

17 Cancel Button Unpressed Close the export dialog. Do not export. C.6 - Discussion Data can be exported to one of four targets: Printer - Pre-formatted text is sent to the printer when the configuration dialog is closed. Before printing a printer setup dialog will appear (Figure C.6.2), allowing printer options to be adjusted. (The appearance of the dialog will vary from user to user.) With the release of Version 4.1.x, printer text can be formatted from within Vision by adjusting the Line Spacing, Left Margin and Tab Spacing integer values (Figure C.6.1). Experimentation will show the proper settings for all exporting to the attached printer. These controls are hidden unless the printer is specified as the target. Figure C Export Configuration Dialog - Printer Option. 15

18 Figure C Standard Windows Printer Configuration Dialog. Text File - Selecting this option enables the Browse for File Name button. Clicking this button will open a standard browser dialog in which a file name and path must be selected. If the file already exists, the output will be appended to existing text. An output file name must be specified for this export. Figure C.6.3 shows a sample of the Manual Branch Abort Task text export. The information shown in the Admin Info subdialog of Figure C.3.1 has been added to the Text Export output. 16

19 Figure C Sample Manual Branch Abort Task Text Export File. Excel - Selecting this option enables the Browse for File Name button. Clicking this button will open a standard browser dialog in which a file name and path may be selected. Specifying a file name is optional. However, if specified, a unique file name/file path must be created or an overwrite situation will occur. Data are not appended to existing files. When the configuration dialog is closed, the Excel program will be started and a spread sheet created. When Excel is closed, the data will be written to the specified file name, or the user will be prompted to save if the file is not specified. Office/Excel 2000 or later must be loaded for this option. Office/Excel is not provided with the tester or Vision software. Figure C.6.4 shows a partial sample of the Manual Branch Abort Task Excel export. The information shown in the Admin Info subdialog of Figure C.3.1 has been added to the Excel Export output. 17

20 Figure C.t.4 - Sample Manual Branch Abort Task Excel Export Output. Word - Selecting this option enables the Browse for File Name button. Clicking this button will open a standard browser dialog in which a file name and path may be selected. Specifying a file name is optional. The Word program will be opened and written when the regraph dialogs have been closed. If a new file name is specified, the document will be saved immediately. If no file name is specified, the user will be prompted to save the documents when closed. Office/Word 2000 or later must be loaded for this option. Office/Word is not provided with the tester or Vision software. The information shown in the Admin Info subdialog of Figure C.3.1 has been added to the Word Export output. 18

21 Figure C Sample Manual Branch Abort Task Word Export Output. 19

22 D User Variables Manual B.A.: Branch Aborted Boolean Flag indicating the operator's decision on Task execution. 20

23 E - Change and Version Record This page specifically lists changes that are visible to the user. Often the software is changed in ways that are not directly apparent to the user. These changes may adjust the version number, in which case they are listed simply as "Internal Changes". Such changes may be indirectly evident in speed and performance improvements or the change of the Task file size. Version December Moved the Branch Abort flag from the User Variable List to a system list to remove unnecessary clutter. 10 December SPC. 2. Added the Version to the Execution dialog. 24 December SPC. 3. If Abort Branch was selected, the Task exited the Test Definition completely. This is the same as the Exit Task. The Task should only set the Abort Branch flag. SPC - 25 January Version March Set to Version for release. SPC - 14 March Installed initial Word file export - 26 March SPC. Version October Set to Version SPC - 4 October Added Tool Tips - SPC - 12 December Added Word and Excel 2000 Exporting - SPC - 12 February Added printer export text spacing customization - SPC - 11 August Version June Set to Version SPC - 3 June Minor exporting updates - SPC - 28 June Moved to the "Branching" subfolder. 2 July Added Branch and Filter Target Task icons that show the association with the Branch Task by including a blue dot at the icon lower-left corner, or a Filter Task by including a brown rectangle at the lower-right corner. 2 May Version January Set to Version for release. 16 January Removed all references to Office/Word/Excel ' January Eliminated "Excel 2000" and "Word 2000" text from export output. 13 August 21

24 2008. Version January Set to Version to reflect changes. 5 January Added debug logging calls to facilitate troubleshooting. 5 January Version February Set to Version to match Vision framework version update. 26 February Added the Admin Info button and subdialog - SPC - 24 July Added Vision Version and Vision compile date to all exporting - SPC - 24 July Added Test Definition Graphing - SPC - 4 November Version November Set to Version for to match Vision version - SPC - 5 November Version January Set to Version for to match Vision version - SPC - 11 January Version June Set to Version for to match Vision version - SPC - 8 June