plugins/org.eclipse.sirius.doc/doc/specifier/workflows/Workflows.html - sirius/org.eclipse.sirius - Git at Google

 <?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 	<head>
 		<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
 		<title>Workflows</title>
 		<link type="text/css" rel="stylesheet" href="../../resources/bootstrap.css"/>
 		<link type="text/css" rel="stylesheet" href="../../resources/custom.css"/>
 	</head>
 	<body>
 		<h1 id="SpecifyingWorkflows">Specifying Workflows</h1>
 		<ol class="toc" style="list-style: disc;">
 			<li>
 				<a href="#SpecifyingWorkflows">Specifying Workflows</a>
 				<ol style="list-style: disc;">
 					<li>
 						<a href="#introduction">Introduction</a>
 					</li>
 					<li>
 						<a href="#specification">Customizing the workflow tile</a>
 						<ol style="list-style: disc;">
 							<li>
 								<a href="#workflow">Workflow</a>
 							</li>
 							<li>
 								<a href="#page">Page</a>
 							</li>
 							<li>
 								<a href="#section">Section</a>
 							</li>
 							<li>
 								<a href="#activity">Activity</a>
 							</li>
 							<li>
 								<a href="#context">Interpreted Expressions context</a>
 							</li>
 						</ol>
 					</li>
 					<li>
 						<a href="#usage">Usage</a>
 					</li>
 				</ol>
 			</li>
 		</ol>
 		<p>
 			<span style="color:red">WARNING:</span> This feature is
 			<b>experimental</b> in Sirius 6.0.x. Adopters are encouraged to test it and give
 			<a href="https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Sirius">feedback</a>, but this sould not be deployed in production. In particular, workflows defined using Sirius 6.0.x may not work at all in Sirius 6.1 and later.
 		</p>
 		<h2 id="introduction">Introduction</h2>
 		<p>The
 			<em>Workflow</em> section is a new tab included in the aird editor (to open it, double click on the file with
 			<em>aird</em> extension).
 		</p>
 		<p>
 			<img border="0" src="images/aird_editor.png"/>
 		</p>
 		<p>The new workflow tab displays both fixed information and information that can be defined in the VSM. The fixed information are the following:</p>
 		<ul>
 			<li>The name of the project and its description.</li>
 			<li>A list of all semantic resources known by the Sirius session</li>
 			<li>A list of all representations (diagrams, tables and trees) in the Sirius session</li>
 			<li>A workflow tile, empty by default, that can be customized by the specifier in the
 				<a href="../../Glossary.html#VSM">
 					<em>VSM</em>
 				</a> to display actions that should be available more directly to users.
 			</li>
 		</ul>
 		<p>
 			<img border="0" src="images/workflow_page.png"/>
 		</p>
 		<h2 id="specification">Customizing the workflow tile</h2>
 		<p>The workflow tile customization can be done by describing its content directly in the VSM.</p>
 		<p>Workflows are defined around four main concepts:
 			<em>Workflow</em>,
 			<em>Page</em>,
 			<em>Section</em> and
 			<em>Activity</em>.
 			<br/>Once defined in the VSM, the result will be visible in the workflow tile of the aird editor.
 		</p>
 		<h3 id="workflow">Workflow</h3>
 		<p>The
 			<em>Workflow Description</em> element can be created under the root element of the odesign from the specific menu item.
 		</p>
 		<p>
 			<img style="width:60%" border="0" src="images/new_workflow.png"/>
 		</p>
 		<p>This action creates a blank new
 			<em>workflow</em> element. Like many elements inside a
 			<a href="../../Glossary.html#VSM">
 				<em>VSM</em>
 			</a>,
 			<em>Workflow Description</em> has a mandatory
 			<em>Identifier</em> property (which should be unique), and an optional
 			<em>Name</em> property that has the same value as the
 			<em>Identifer</em> if the user doesn&#8217;t customize it.
 		</p>
 		<p>Inside a
 			<em>Workflow Description</em> element, you can create
 			<em>Page</em> elements.
 		</p>
 		<h3 id="page">Page</h3>
 		<p>For each
 			<em>page</em> element, a tab will be created in the workflow tile of the aird editor. The following screenshot shows an example where three pages have been defined:
 			<em>Capture</em>,
 			<em>Review</em>, and
 			<em>Help</em>.
 		</p>
 		<p>
 			<img border="0" src="images/pages.png"/>
 		</p>
 		<p>The
 			<em>Page Description</em> element can be created under the
 			<em>Workflow Description</em> element from the specific menu item.
 			<br/>This action creates a blank new
 			<em>page</em> element. Like the
 			<em>Workflow Description</em>, the
 			<em>Page Description</em> element has an
 			<em>Identifier</em> and a
 			<em>Name</em> property. It also has a
 			<em>Title Expression</em> element, which will be used to get the label that will be displayed to the user. This field is an
 			<a href="../general/Specifying_Viewpoints.html#interpreted_expressions">
 				<em>Interpreted Expression</em>
 			</a>.
 		</p>
 		<p>
 			<span style="color:red">WARNING:</span> in the current Sirius version, the
 			<em>Title Expression</em> is not interpreted correctly so you will only be able to use a string directly. This string will be used as the title.
 		</p>
 		<p>Inside a
 			<em>Page Description</em> element, you can create
 			<em>Section</em> elements.
 		</p>
 		<h3 id="section">Section</h3>
 		<p>A
 			<em>section</em> element will create a new subpart in the
 			<em>page</em>. The following screenshot shows two sections
 			<em>Hierarchy</em> and
 			<em>Diagram</em> in the
 			<em>Capture</em> page.
 		</p>
 		<p>
 			<img border="0" src="images/sections.png"/>
 		</p>
 		<p>The
 			<em>Section Description</em> element can be created under the
 			<em>Page Description</em> element from the specific menu item.
 			<br/>The action creates a blank new
 			<em>section</em> element. The
 			<em>section</em> element is similar to the
 			<em>page</em> element: it has an
 			<em>Identifier</em>, a
 			<em>Name</em> and a
 			<em>Title Expression</em> properties, which all behave like the
 			<em>page</em> ones.
 		</p>
 		<p>
 			<span style="color:red">WARNING:</span> in the current Sirius version, the
 			<em>Title Expression</em> is not interpreted correctly so you will only be able to use a string directly. This string will be used as the title.
 		</p>
 		<p>Inside a
 			<em>Section Description</em> element, you can create
 			<em>Activity</em> elements.
 		</p>
 		<h3 id="activity">Activity</h3>
 		<p>
 			<em>Activity</em> elements allow specifiers to describe actions. It contains the same properties as
 			<em>section</em> and
 			<em>page</em> elements (i.e.
 			<em>Identifier</em>,
 			<em>Name</em> and
 			<em>Label Expression</em>).
 		</p>
 		<p>
 			<span style="color:red">WARNING:</span> in the current Sirius version, the
 			<em>Title Expression</em> is not interpreted correctly so you will only be able to use a string directly. This string will be used as the title.
 		</p>
 		<p>An
 			<em>activity</em> contains a
 			<em>begin</em> element that allows user to specify a
 			<a href="../general/Model_Operations.html#introduction">
 				<em>Model Operation</em>
 			</a>.
 		</p>
 		<p>Once created, the
 			<em>activities</em> will appear in the workflow tile and the user will be able to click on these, and trigger the associated
 			<em>Model Operation</em>.
 		</p>
 		<h3 id="context">Interpreted Expressions context</h3>
 		<p>When writing an
 			<a href="../general/Specifying_Viewpoints.html#interpreted_expressions">
 				<em>Interpreted Expression</em>
 			</a>, the user must think of the context on which the expression will be applied. For workflows related element (for instance in the Title Expressions of Pages, Sections and Activities), only one context is available,
 			<em>self</em>. In this case,
 			<em>self</em> will be the
 			<code>DAnalysis</code> of the Sirius session, which is a representation of the odesign file.
 		</p>
 		<h2 id="usage">Usage</h2>
 		<p>
 			<em>Workflow</em> elements are associated automatically with the
 			<em>viewpoints</em> defined in the same odesign file. It means that to display the defined workflows in the correct section of the aird editor, the user will have to activate at least one of the viewpoints defined in the VSM.
 		</p>
 		<p>If several
 			<em>workflows</em> are activated and shown in the workflow tile, they are all merged in the same workflow tile.
 		</p>
 	</body>
 </html>
	<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
	<title>Workflows</title>
	<link type="text/css" rel="stylesheet" href="../../resources/bootstrap.css"/>
	<link type="text/css" rel="stylesheet" href="../../resources/custom.css"/>
	</head>
	<body>
	<h1 id="SpecifyingWorkflows">Specifying Workflows</h1>
	<ol class="toc" style="list-style: disc;">
	<li>
	<a href="#SpecifyingWorkflows">Specifying Workflows</a>
	<ol style="list-style: disc;">
	<li>
	<a href="#introduction">Introduction</a>
	</li>
	<li>
	<a href="#specification">Customizing the workflow tile</a>
	<ol style="list-style: disc;">
	<li>
	<a href="#workflow">Workflow</a>
	</li>
	<li>
	<a href="#page">Page</a>
	</li>
	<li>
	<a href="#section">Section</a>
	</li>
	<li>
	<a href="#activity">Activity</a>
	</li>
	<li>
	<a href="#context">Interpreted Expressions context</a>
	</li>
	</ol>
	</li>
	<li>
	<a href="#usage">Usage</a>
	</li>
	</ol>
	</li>
	</ol>
	<p>
	<span style="color:red">WARNING:</span> This feature is
	<b>experimental</b> in Sirius 6.0.x. Adopters are encouraged to test it and give
	<a href="https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Sirius">feedback</a>, but this sould not be deployed in production. In particular, workflows defined using Sirius 6.0.x may not work at all in Sirius 6.1 and later.
	</p>
	<h2 id="introduction">Introduction</h2>
	<p>The
	<em>Workflow</em> section is a new tab included in the aird editor (to open it, double click on the file with
	<em>aird</em> extension).
	</p>
	<p>
	<img border="0" src="images/aird_editor.png"/>
	</p>
	<p>The new workflow tab displays both fixed information and information that can be defined in the VSM. The fixed information are the following:</p>
	<ul>
	<li>The name of the project and its description.</li>
	<li>A list of all semantic resources known by the Sirius session</li>
	<li>A list of all representations (diagrams, tables and trees) in the Sirius session</li>
	<li>A workflow tile, empty by default, that can be customized by the specifier in the
	<a href="../../Glossary.html#VSM">
	<em>VSM</em>
	</a> to display actions that should be available more directly to users.
	</li>
	</ul>
	<p>
	<img border="0" src="images/workflow_page.png"/>
	</p>
	<h2 id="specification">Customizing the workflow tile</h2>
	<p>The workflow tile customization can be done by describing its content directly in the VSM.</p>
	<p>Workflows are defined around four main concepts:
	<em>Workflow</em>,
	<em>Page</em>,
	<em>Section</em> and
	<em>Activity</em>.
	<br/>Once defined in the VSM, the result will be visible in the workflow tile of the aird editor.
	</p>
	<h3 id="workflow">Workflow</h3>
	<p>The
	<em>Workflow Description</em> element can be created under the root element of the odesign from the specific menu item.
	</p>
	<p>
	<img style="width:60%" border="0" src="images/new_workflow.png"/>
	</p>
	<p>This action creates a blank new
	<em>workflow</em> element. Like many elements inside a
	<a href="../../Glossary.html#VSM">
	<em>VSM</em>
	</a>,
	<em>Workflow Description</em> has a mandatory
	<em>Identifier</em> property (which should be unique), and an optional
	<em>Name</em> property that has the same value as the
	<em>Identifer</em> if the user doesn’t customize it.
	</p>
	<p>Inside a
	<em>Workflow Description</em> element, you can create
	<em>Page</em> elements.
	</p>
	<h3 id="page">Page</h3>
	<p>For each
	<em>page</em> element, a tab will be created in the workflow tile of the aird editor. The following screenshot shows an example where three pages have been defined:
	<em>Capture</em>,
	<em>Review</em>, and
	<em>Help</em>.
	</p>
	<p>
	<img border="0" src="images/pages.png"/>
	</p>
	<p>The
	<em>Page Description</em> element can be created under the
	<em>Workflow Description</em> element from the specific menu item.
	<br/>This action creates a blank new
	<em>page</em> element. Like the
	<em>Workflow Description</em>, the
	<em>Page Description</em> element has an
	<em>Identifier</em> and a
	<em>Name</em> property. It also has a
	<em>Title Expression</em> element, which will be used to get the label that will be displayed to the user. This field is an
	<a href="../general/Specifying_Viewpoints.html#interpreted_expressions">
	<em>Interpreted Expression</em>
	</a>.
	</p>
	<p>
	<span style="color:red">WARNING:</span> in the current Sirius version, the
	<em>Title Expression</em> is not interpreted correctly so you will only be able to use a string directly. This string will be used as the title.
	</p>
	<p>Inside a
	<em>Page Description</em> element, you can create
	<em>Section</em> elements.
	</p>
	<h3 id="section">Section</h3>
	<p>A
	<em>section</em> element will create a new subpart in the
	<em>page</em>. The following screenshot shows two sections
	<em>Hierarchy</em> and
	<em>Diagram</em> in the
	<em>Capture</em> page.
	</p>
	<p>
	<img border="0" src="images/sections.png"/>
	</p>
	<p>The
	<em>Section Description</em> element can be created under the
	<em>Page Description</em> element from the specific menu item.
	<br/>The action creates a blank new
	<em>section</em> element. The
	<em>section</em> element is similar to the
	<em>page</em> element: it has an
	<em>Identifier</em>, a
	<em>Name</em> and a
	<em>Title Expression</em> properties, which all behave like the
	<em>page</em> ones.
	</p>
	<p>
	<span style="color:red">WARNING:</span> in the current Sirius version, the
	<em>Title Expression</em> is not interpreted correctly so you will only be able to use a string directly. This string will be used as the title.
	</p>
	<p>Inside a
	<em>Section Description</em> element, you can create
	<em>Activity</em> elements.
	</p>
	<h3 id="activity">Activity</h3>
	<p>
	<em>Activity</em> elements allow specifiers to describe actions. It contains the same properties as
	<em>section</em> and
	<em>page</em> elements (i.e.
	<em>Identifier</em>,
	<em>Name</em> and
	<em>Label Expression</em>).
	</p>
	<p>
	<span style="color:red">WARNING:</span> in the current Sirius version, the
	<em>Title Expression</em> is not interpreted correctly so you will only be able to use a string directly. This string will be used as the title.
	</p>
	<p>An
	<em>activity</em> contains a
	<em>begin</em> element that allows user to specify a
	<a href="../general/Model_Operations.html#introduction">
	<em>Model Operation</em>
	</a>.
	</p>
	<p>Once created, the
	<em>activities</em> will appear in the workflow tile and the user will be able to click on these, and trigger the associated
	<em>Model Operation</em>.
	</p>
	<h3 id="context">Interpreted Expressions context</h3>
	<p>When writing an
	<a href="../general/Specifying_Viewpoints.html#interpreted_expressions">
	<em>Interpreted Expression</em>
	</a>, the user must think of the context on which the expression will be applied. For workflows related element (for instance in the Title Expressions of Pages, Sections and Activities), only one context is available,
	<em>self</em>. In this case,
	<em>self</em> will be the
	<code>DAnalysis</code> of the Sirius session, which is a representation of the odesign file.
	</p>
	<h2 id="usage">Usage</h2>
	<p>
	<em>Workflow</em> elements are associated automatically with the
	<em>viewpoints</em> defined in the same odesign file. It means that to display the defined workflows in the correct section of the aird editor, the user will have to activate at least one of the viewpoints defined in the VSM.
	</p>
	<p>If several
	<em>workflows</em> are activated and shown in the workflow tile, they are all merged in the same workflow tile.
	</p>
	</body>
	</html>