blob: 5a8bcab545aa4c3a0e53c1a33ce200cd041393de [file] [log] [blame]
<!DOCTYPE html>
<head>
<title>RCPTT Documentation Center</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://www.eclipse.org/rcptt/shared/css/bootstrap.min.css">
<link rel="stylesheet" href="https://www.eclipse.org/rcptt/shared/css/main.css">
<link rel="stylesheet" href="https://www.eclipse.org/rcptt/shared/css/prism.css">
<link rel="icon" href="https://www.eclipse.org/rcptt/shared/img/favicon.ico">
<script src="https://www.eclipse.org/rcptt/shared/js/jquery.min.js"></script>
<script src="https://www.eclipse.org/rcptt/shared/js/bootstrap.min.js"></script>
<script src="https://www.eclipse.org/rcptt/shared/js/prism.js"></script>
<script src="https://www.eclipse.org/rcptt/shared/js/ecl.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-39589807-5', 'eclipse.org');
ga('send', 'pageview');
</script>
</head>
<body>
<div id="before-footer">
<header>
<nav class="navbar navbar-default navbar-static-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">RCPTT Documentation Center</span>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav">
<li class="active" >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/getstarted">User Guide</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/faq/">FAQ</a>
</li>
<li>
<a href="http://eclipse.org/rcptt">Back to RCPTT Main Site</a>
</li>
<li>
<a href="http://eclipse.org">Eclipse.org</a>
</li>
</ul>
</div>
</nav>
</header>
<section class="content">
<div class="container">
<div class="row">
<div class="col-sm-3">
<div class="rcptt-sidebar">
<ul class="nav">
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/getstarted/">Get Started</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/testeditor/">Test Case Editor</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/controlpanel">Control Panel</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/assertions/">Assertions</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/ecl/">Eclipse Command Language</a>
<ul class="nav">
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/ecl/new-command-guide/">New ECL Command Guide</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/ecl/excel-import-export/">ECL commands for Excel import and export</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/ecl/xml-import-export/">ECL commands for XML import and export</a>
</li>
</ul>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/">Contexts</a>
<ul class="nav">
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/workspace/">Workspace</a>
</li>
<li class="active" >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/workbench/">Workbench</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/launch/">Launch</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/preferences/">Preferences</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/parameters/">Parameters</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/group/">Group</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/folder/">Folder</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/default/">Default</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/super/">Super</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/ecl/">ECL Script</a>
</li>
</ul>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/verifications/">Verifications</a>
<ul class="nav">
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/verifications/text/">Text</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/verifications/treetable/">Table/Tree</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/verifications/errorlog/">Error Log</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/verifications/time/">Time</a>
</li>
</ul>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/procedures/">Procedures and Variables</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/runner/">Test Runner</a>
<ul class="nav">
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/runner/arguments/">Arguments</a>
</li>
</ul>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/maven/">Maven plugin</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/">RAP</a>
<ul class="nav">
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/install/">Install instructions</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/recordReplay/">Record and Replay</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/capability/">Capability Contexts</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/rap-commands/">ECL commands</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/rap-maven/">Maven plugin</a>
</li>
</ul>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/integration/test-rail-integration/">Integration with TestRail</a>
</li>
</ul>
</div>
</div>
<div class="col-sm-9">
<h1>Workbench Contexts</h1>
<p></p>
<p>Workbench contexts are used to control perspective, views and open editors of application under test</p>
<p><p>Move a mouse over highlighted areas on a screenshot below to get a documentation regarding UI elements</p>
</p>
<div class="screenshot">
<img src="https://www.eclipse.org/rcptt/shared/img/screenshot-workbench-context-editor.png"></img>
<div class="ann" style="top:93px;left:118px;">
<div class="ann-border" style="width:240px;height:19px;"></div>
<div class="ann-overlay" style="left:0px;;">
All you need to know about context name
</div>
</div>
<div class="ann" style="top:119px;left:118px;">
<div class="ann-border" style="width:100px;height:19px;"></div>
<div class="ann-overlay" style="left:0px;;">
All you need to know about tags
</div>
</div>
<div class="ann" style="top:118px;left:584px;">
<div class="ann-border" style="width:22px;height:22px;"></div>
<div class="ann-overlay" style="left:0px;;">
All you need to know about adding tags
</div>
</div>
<div class="ann" style="top:92px;left:616px;">
<div class="ann-border" style="width:75px;height:22px;"></div>
<div class="ann-overlay" style="left:0px;;">
Make a snapshot of all current AUT perspective, opened views and editors and copy them into this context.
</div>
</div>
<div class="ann" style="top:118px;left:616px;">
<div class="ann-border" style="width:75px;height:22px;"></div>
<div class="ann-overlay" style="left:0px;;">
Opens given perspective, views and editors. If <span class="uiElement">Reset perspective</span>
option is on, resets perspective to its default.
</div>
</div>
<div class="ann" style="top:152px;left:69px;">
<div class="ann-border" style="width:95px;height:20px;"></div>
<div class="ann-overlay" style="left:0px;;">
All you need to know about Description
</div>
</div>
<div class="ann" style="top:154px;left:665px;">
<div class="ann-border" style="width:19px;height:19px;"></div>
<div class="ann-overlay" style="left:0px;;">
Click this button to erase current description contents
</div>
</div>
<div class="ann" style="top:203px;left:73px;">
<div class="ann-border" style="width:290px;height:19px;"></div>
<div class="ann-overlay" style="left:0px;;">
A perspective which should be open in AUT
</div>
</div>
<div class="ann" style="top:202px;left:626px;">
<div class="ann-border" style="width:59px;height:22px;"></div>
<div class="ann-overlay" style="left:0px;;">
Shows a perspective selection dialog populated with list of perspectives available in AUT
</div>
</div>
<div class="ann" style="top:230px;left:74px;">
<div class="ann-border" style="width:120px;height:20px;"></div>
<div class="ann-overlay" style="left:0px;;">
Whether to reset perspective to its defaults after opening
</div>
</div>
<div class="ann" style="top:255px;left:74px;">
<div class="ann-border" style="width:150px;height:20px;"></div>
<div class="ann-overlay" style="left:0px;;">
Close all modal dialogs if any
</div>
</div>
<div class="ann" style="top:280px;left:74px;">
<div class="ann-border" style="width:110px;height:20px;"></div>
<div class="ann-overlay" style="left:0px;;">
Clear clipboard contents
</div>
</div>
<div class="ann" style="top:331px;left:75px;">
<div class="ann-border" style="width:329px;height:120px;"></div>
<div class="ann-overlay" style="left:0px;;">
List of views which should be open. Also workbench context processor clears selection in views listed here.
</div>
</div>
<div class="ann" style="top:306px;left:317px;">
<div class="ann-border" style="width:20px;height:20px;"></div>
<div class="ann-overlay" style="left:0px;;">
Opens a view selection dialog populated with list of views from AUT (so there's no chance to enter an invalid view id)
</div>
</div>
<div class="ann" style="top:356px;left:416px;">
<div class="ann-border" style="width:269px;height:95px;"></div>
<div class="ann-overlay" style="left:0px;;">
List of editors to be open in AUT
</div>
</div>
<div class="ann" style="top:306px;left:598px;">
<div class="ann-border" style="width:20px;height:20px;"></div>
<div class="ann-overlay" style="left:0px;;">
Allows to select a file from current RCPTT Project's workspace contexts to be open in an editor
</div>
</div>
</div>
<h3>Introduction</h3>
<p>The <span class="uiElement"><img src="https://www.eclipse.org/rcptt/shared/img/ui-capture.gif"></img> Capture</span> button in the upper-right corner lets you automatically capture the current workbench state of your AUT. However, your can customize your workbench context using the settings listed below:</p>
<ul>
<li><b>Perspective id</b> - the perspective to be open in AUT before running the test. Use the Browse button to view the user-friendly list of all perspectives available in AUT</li>
<li><b>Reset perspective</b> - when this option is checked, the AUT perspective will be reset to its own defaults</li>
<li><b>Close all modal dialogs</b> - when this option is checked, the workbench context will close any modal dialogs opened in AUT. That is, if your test stops and leaves the New Project wizard opened, the workbench context of your current test will close it</li>
<li><b>Views</b> - the list of all views to be opened before running the test</li>
<li><b>Editors</b> - the list of all editors to be opened before running the test. You can add entries to this list manually (i.e. typing in the file path, such as /my_project/my_file) or browse for existing files in workspace contexts.</li>
<li><b>Close open editors</b> - optionally allows to close all other editors not listed in open editors list</li>
<li><b>Clear clipboard</b> - optionally allows to clear clipboard contents</li>
</ul>
<div class="panel panel-warning">
<div class="panel-heading">
<h3 class="panel-title">Important</h3>
</div>
<div class="panel-body">
While it is not currently tracked by RCPTT, the Workbench context actually can depend on certain Workspace contexts. For example, you specify to open an editor for <i>/my_project/my_file</i>. In case there is no such file in the AUT workspace, applying this Workbench context will fail your test. When you are using <a href = "https://www.eclipse.org/rcptt/documentation/userguide/contexts/workspace">workspace contexts</a> and workbench contexts simultaneously (which is actually the recommended way), make sure that the workspace context goes before the workbench context.
Alternatively, unnecessary editors can be manually removed from the list of editors.
</div>
</div>
</div>
</div>
</div>
</section>
<script src="https://www.eclipse.org/rcptt/shared/js/main.js"></script>
</body>