diff options
| author | ddunne | 2008-12-30 20:21:38 +0000 |
|---|---|---|
| committer | ddunne | 2008-12-30 20:21:38 +0000 |
| commit | 60837dcdfb048d907e1a9a6e0e67574760182b31 (patch) | |
| tree | 18ec3b88139a9753d8b662e25908c8664c5e52fb | |
| parent | 3b982fd9e68eaee464defd5c26faa126cc59e0b6 (diff) | |
| download | org.eclipse.osee-60837dcdfb048d907e1a9a6e0e67574760182b31.tar.gz org.eclipse.osee-60837dcdfb048d907e1a9a6e0e67574760182b31.tar.xz org.eclipse.osee-60837dcdfb048d907e1a9a6e0e67574760182b31.zip | |
9 files changed, 167 insertions, 62 deletions
diff --git a/org.eclipse.osee.ats/reference/configure/configure_ats_for_help.html b/org.eclipse.osee.ats/reference/configure/configure_ats_for_help.html index b43276fa6a8..9354ec9930c 100644 --- a/org.eclipse.osee.ats/reference/configure/configure_ats_for_help.html +++ b/org.eclipse.osee.ats/reference/configure/configure_ats_for_help.html @@ -16,7 +16,8 @@ <body>
<h1>Configure ATS for Help</h1>
<h2>Purpose</h2>
- To configure ATS workflows to use the integrated help system. ATS help useds a combination of widget tooltip, static help pages, dynamic help content configured through extended plugins and built into the VUE workflow diagrams.
+ To configure ATS workflows to use the integrated help system. ATS help useds a combination of widget
+ tooltip, static help pages and dynamic help content configured through extended plugins.
<h2>How to do it</h2>
<ul>
<li>Workflow Page Help</li>
@@ -28,12 +29,7 @@ <li>Top down order of obtaining help content</li>
<ul>
<li>Setting tooltip in IStateItem interface</li>
- <li>VUE Diagram</li>
- <ul>
- <li>in xWidget def: tooltip="put help here"</li>
- <li>in xWidget def: helpPluginId="osee.ats" helpContextId="atsPriority" help is obtained from Eclipse context.xml declaration within plugin using given context id</li>
- <li>NOTE: Context Ids can not have . notation.</li>
- </ul>
+ <li>Work Widget Definitions in Work Data attribute value of XWidget=...tooltip="put help here"</li>
<li>ATSAttributes.java declarations</li>
</ul>
</ul>
diff --git a/org.eclipse.osee.ats/reference/configure/configure_ats_for_tracking.html b/org.eclipse.osee.ats/reference/configure/configure_ats_for_tracking.html index dd16b0b6536..a457d34c449 100644 --- a/org.eclipse.osee.ats/reference/configure/configure_ats_for_tracking.html +++ b/org.eclipse.osee.ats/reference/configure/configure_ats_for_tracking.html @@ -9,13 +9,13 @@ Boeing - initial API and implementation
-->
<head>
-<title>Configure ATS for Tracking</title>
+<title>Configure ATS for Change Tracking</title>
<LINK rel="stylesheet" type="text/css"
href="../../osee.help/html/style.css">
</head>
<body>
-<h1>Configure ATS for Tracking</h1>
+<h1>Configure ATS for Change Tracking</h1>
<h2>Purpose</h2>
ATS is used to track any type of change throughout the lifecycle of a
project. Below are the steps to configure ATS for tracking something
@@ -82,8 +82,8 @@ new. <ul>
<li>TeamActionableItem: relation to all AIs that this team is
responsible for.</li>
- <li>TeamDefinitionToWorkflowDiagram: WorkflowDiagram
- (GeneralDocument) artifact that configures the state machine that
+ <li>Work Item.Child: WorkFlowDefinition artifact
+ configures the state machine that
this team works under. NOTE: If this relation is not set, ATS will
walk up the Default Hierarchy to find the first AI with this
relation.</li>
@@ -96,9 +96,10 @@ new. to privileged edit a Team Workflow for the team they belong to.</li>
</ul>
</ul>
- <li>Choose existing Workflow Diagram or create new Workflow
- Diagram to be used by the team and relate it to Team Definition (as
- above).</li>
+ <li>Choose existing WorkFlowDefinition or create new WorkFlowDefinition
+ to be used by the team and relate it to Team Definition (as
+ above). This can be done through File->New->Workflow Configuration. Enter a namespace
+ and a default workflow will be created and can be edited.</li>
<li>Create version artifacts necessary (if using versions) and
relate them to Team Definition (as above)</li>
<ul>
diff --git a/org.eclipse.osee.ats/reference/configure/create_new_actionable_items.html b/org.eclipse.osee.ats/reference/configure/create_new_actionable_items.html index 7c710ff7e99..caf4260e421 100644 --- a/org.eclipse.osee.ats/reference/configure/create_new_actionable_items.html +++ b/org.eclipse.osee.ats/reference/configure/create_new_actionable_items.html @@ -14,13 +14,16 @@ </head>
<body>
- <h1>Create Actionable Items</h1>
+ <h1>Create Actionable Items (AI)</h1>
<h2>Purpose</h2>
To create Actionable Items which provide the end user with a selection of things impacted by this Action.
<h2>How to do it</h2>
<ul>
<li>Create Actionable Items</li>
<ul>
+ <li>NOTE: AIs should not be deleted once used. Instead, use the ats.Active attribute to deactivate the AI.
+ If an AI must be deleted, search for all "ats.Actionable Item" attributes that have the value of the AI's guid.
+ These must be changed to another AI before deletion.</li>
<li>Actionable Item tree can be created to the level at which actions are to be written. Usually a component decomposition. In the case of UIs, create one for each view or window.</li>
<li>Attributes</li>
<ul>
diff --git a/org.eclipse.osee.ats/reference/configure/create_new_team_definition.html b/org.eclipse.osee.ats/reference/configure/create_new_team_definition.html index 84dc23d7d5f..18a5477f45a 100644 --- a/org.eclipse.osee.ats/reference/configure/create_new_team_definition.html +++ b/org.eclipse.osee.ats/reference/configure/create_new_team_definition.html @@ -27,9 +27,6 @@ <li>ats.Description:[desc]</li>
<li>ats.Active:[yes]</li>
<li>ats.Team Uses Version:[yes if want to use release/build planning]</li>
- <li></li>
- <li>Endorse state must have Title, Description, Priority, Deadline, Change Type, Validation</li>
- <li>Each state must have a unique identifier as the state id</li>
</ul>
<li>Relations</li>
<ul>
@@ -37,6 +34,8 @@ <li>TeamDefinitionToVersion: Relate to current and future VersionArtifacts</li>
<li>TeamLead: Relate to one or more team leads. These individuals will have priviledged edit and perform the Endorse state by default.</li>
<li>TeamMember: Relate to one or more team members. These individuals will have ability to priviledged edit Workflows created by themselves against the team they belong to.</li>
+ <li>Work Item.Child: Relate to a single "Work Flow Definition" artifact that defines the workflow
+ that will be used for this team.</li>
</ul>
</ul>
</body>
diff --git a/org.eclipse.osee.ats/reference/configure/create_vue_workflow_diagram.html b/org.eclipse.osee.ats/reference/configure/create_vue_workflow_diagram.html deleted file mode 100644 index f9b39240b7d..00000000000 --- a/org.eclipse.osee.ats/reference/configure/create_vue_workflow_diagram.html +++ /dev/null @@ -1,29 +0,0 @@ -<html>
-<!--
- Copyright (c) 2004, 2007 Boeing.
- All rights reserved. This program and the accompanying materials
- are made available under the terms of the Eclipse Public License v1.0
- which accompanies this distribution, and is available at
- http://www.eclipse.org/legal/epl-v10.html
- Contributors:
- Boeing - initial API and implementation
--->
- <head>
- <title>Create new VUE workflow diagram</title>
- <LINK rel="stylesheet" type="text/css" href="../../osee.help/html/style.css">
- </head>
-
-<body>
- <h1>Create new VUE workflow diagram</h1>
- <h2>Purpose</h2>
- To create a new VUE diagram that ATS uses to move an Action through it's specific workflow.
- <h2>How to do it</h2>
- <ul>
- <li>Diagram must have Endorse and Completed</li>
- <li>Endorse state must have Title, Description, Priority, Deadline, Change Type, Validation</li>
- <li>Each state must have a unique identifier as the state id</li>
- <li>Use "-DAtsUseWorkflowFiles" flag to instruct ATS to use a specified file in the workspace to use (versus a skynet artifact). This helps speed the development of the workflow.</li>
- <li>If using "-DAtsUseWorkflowFiles" flag, put file path resolution info in AtsWorkFlowFactory.java</li>
- </ul>
-</body>
-</html>
diff --git a/org.eclipse.osee.ats/reference/configure/create_workflow_configuration.html b/org.eclipse.osee.ats/reference/configure/create_workflow_configuration.html new file mode 100644 index 00000000000..af951ab70f4 --- /dev/null +++ b/org.eclipse.osee.ats/reference/configure/create_workflow_configuration.html @@ -0,0 +1,51 @@ +<html>
+<!--
+ Copyright (c) 2004, 2007 Boeing.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+ Contributors:
+ Boeing - initial API and implementation
+-->
+ <head>
+ <title>Create new workflow configuration</title>
+ <LINK rel="stylesheet" type="text/css" href="../../osee.help/html/style.css">
+ </head>
+
+<body>
+ <h1>Create new workflow configuration</h1>
+ <h2>Purpose</h2>
+ To create a new workflow configuration that ATS uses to move an Action through it's specific workflow.
+ This is done using four different artifact types.
+ <ul>
+ <li><a href="create_workflowdefinition_artifact.html">Work Flow Definition<a> specifies
+ the states, their transitions and the state that represents the beginning of the
+ workflow.</li>
+ <li><a href="create_workpagedefinition_artifact.html">Work Page Definition<a> defines
+ the a single state of the Work Flow Definition.</li>
+ <li><a href="create_workwidgetdefinition_artifact.html">Work Widget Definition<a> defines
+ a single field and its corresponding attribute that the value will be stored in. It
+ also provides some layout capabilities for that widget.</li>
+ <li><a href="create_workruledefinition_artifact.html">Work Rule Definition<a> defines
+ certain rules that can be applied to Work Pages and Team Definitions.</li>
+ </ul>
+ <h2>How to do it</h2>
+ <ul>
+ <li>Workflows can be created using the workflow configuration editor (0.6.0 release). Using
+ New -> Other -> OSEE ATS -> Workflow Configuraiton will generate a simple starting
+ point for a new workflow. States and their transitions can be edited through this
+ interface. Other modifications will need to be edited through
+ <a href="create_workflowdefinition_artifact.html">Work Flow Definition<a> attributes
+ and relations.</li>
+ <li>Work Pages, Widgets and Rules are currently edited through the
+ attributes and relations using the default Artifact Editor. See links above to
+ set the proper values.</li>
+ <li>Configurations can also be created through the java. An example of this can
+ be seen by looking at the org.eclipse.osee.ats.config.demo plugin. This plugin, and the
+ DemoDatabaseConfig.java class, shows how to programatically generate work flows, pages,
+ rules and widgets to configure ATS. This configuration will be generated during a database
+ initialization.</li>
+ </ul>
+</body>
+</html>
diff --git a/org.eclipse.osee.ats/reference/configure/create_workflowdefinition_artifact.html b/org.eclipse.osee.ats/reference/configure/create_workflowdefinition_artifact.html new file mode 100644 index 00000000000..23ed709f9ad --- /dev/null +++ b/org.eclipse.osee.ats/reference/configure/create_workflowdefinition_artifact.html @@ -0,0 +1,78 @@ +<html>
+<!--
+ Copyright (c) 2004, 2007 Boeing.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+ Contributors:
+ Boeing - initial API and implementation
+-->
+ <head>
+ <title>Work Flow Definition</title>
+ <LINK rel="stylesheet" type="text/css" href="../../osee.help/html/style.css">
+ </head>
+
+<body>
+ <h1>Create/Modify Work Flow Definition</h1>
+ <h2>Purpose</h2>
+ The Work Flow Definition artifact specifies the workflow that a team moves through to complete
+ an Action. This artifact specifies the states, their transitions and the start state of the
+ workflow. Creation/Editing of this artifact can either be done through the Artifact Editor
+ or using the Workflow Configuration Editor (OSEE 0.6.0 Release and beyond).
+ <h2>How to do it - Configuration Editor</h2>
+ <ul>
+ <li>File -> New -> Other -> OSEE ATS -> Workflow Configuration; Enter unique namespace for
+ this workflow configuration. (eg: org.<company>.code). This creates a simple workflow
+ to use as a starting place.</li>
+ <li>Add necessary states to diagram to represent workflow. Note: Only one state
+ is the entry point and the workflow must end at the "Completed" state. The "Cancelled"
+ state is optional, but should be used in most cases.</li>
+ <li>For each state, a single "Default Transition" must be specified. This will
+ be the default state specified as the "next" state in the workflow. Optional transitions
+ to other states can be specified by the "Transition" arrow. The user will have the
+ option of selecting one of these states instead.</li>
+ <li>The "Return Transition" can be specified for valid jumps "back" to previous states.
+ (eg: The user may need to transition back to the "Analyze" state from the "Authorize"
+ state if authorization failed and more analysis is needed.</li>
+ <li>Select a single state and set it's "Start State" property to "true" for the state
+ specified to start the workflow</li>
+ <li>Select Save to persist the changes and link the created "Work Flow Definition" artifact
+ to its corresponding "Team Definition" artifact.</li>
+ </ul>
+
+ <h2>How to do it - Artifact Editor</h2>
+ On the Common branch in the Artifact Editor, Expand "Action Tracking System" and right-click
+ on "Work Flows", select New Child -> Work Flow Definition. Enter a unique namespace name
+ for this workflow (eg: org.<company>.code). In the Artifact Editor, add and set the attributes
+ and relations as below.
+
+ <li>Attributes</li>
+ <ul>
+ <li>Name:[unique namespace, usually the same as the Work Id specified below]</li>
+ <li>osee.wi.Work Id:[unique workflow namespace] - this will preceed each state name
+ specified in the workflow.</li>
+ <li>osee.wi.Parent Work Id:[Work Id of Parent Work Flow Definition] - this will allow
+ this workflow to inherit it's transitions and start state from another workflow. This
+ can not be used with other attributes below</li>
+ <li>osee.wi.Start Page:[namespace.state name] - this specifies the name of the
+ initial state in the workflow</li>
+ <li>osee.wi.Transition:[[from state name];[transition type];[to state name]] - specifies
+ the transition from state to state where</li>
+ <ul>
+ <li>[from state name]/[to state name]- unique Work Page Definition Work Id comprised of [namespace].[State Name]</li>
+ <li>[transition type] - one of the following:</li>
+ <ul>
+ <li>ToPageAsDefault - Transition is "Default Transition" state</li>
+ <li>ToPage - Transition is optional transition to state</li>
+ <li>ToPageAsReturn - Optional transition to a previously visited state</li>
+ </ul>
+ </ul>
+ <li>osee.wi.Description:Optional attribute to add description of workflow</li>
+ </ul>
+ <li>Relations</li>
+ <ul>
+ <li>Work Item.Parent: Relate to any Team Definition configured to use this workflow.</li>
+ </ul>
+</body>
+</html>
diff --git a/org.eclipse.osee.ats/reference/toc.xml b/org.eclipse.osee.ats/reference/toc.xml index 39f4c816890..161845a3ddf 100644 --- a/org.eclipse.osee.ats/reference/toc.xml +++ b/org.eclipse.osee.ats/reference/toc.xml @@ -31,16 +31,18 @@ href="reference/decision_review_workflow/decisionReview.html" />
</topic>
<topic label="ATS Configuration">
- <topic label="Create VUE Workflow Diagram"
- href="reference/configure/create_vue_workflow_diagram.html" />
- <topic label="Create New Team Definition"
- href="reference/configure/create_new_team_definition.html" />
- <topic label="Create New Actionable Item(s)"
- href="reference/configure/create_new_actionable_items.html" />
- <topic label="Configure ATS for Tracking"
- href="reference/configure/configure_ats_for_tracking.html" />
- <topic label="Configure ATS for Help"
- href="reference/configure/configure_ats_for_help.html" />
+ <topic href="reference/configure/configure_ats_for_tracking.html" label="Configure ATS for Change Tracking">
+ </topic>
+ <topic href="reference/configure/create_new_team_definition.html" label="Create New Team Definition">
+ </topic>
+ <topic href="reference/configure/create_new_actionable_items.html" label="Create New Actionable Item(s)">
+ </topic>
+ <topic href="reference/configure/create_workflow_configuration.html" label="Create Workflow Configuration">
+ <topic href="reference/configure/create_workflowdefintion_artifact.html" label="Work Flow Definition">
+ </topic>
+ </topic>
+ <topic href="reference/configure/configure_ats_for_help.html" label="Configure ATS for Help">
+ </topic>
</topic>
<link toc="PLUGINS_ROOT/org.eclipse.osee.framework.ui.skynet/reference/skynet_toc.xml"/>
</toc>
diff --git a/org.eclipse.osee.ats/src/org/eclipse/osee/ats/workflow/editor/wizard/AtsWorkflowConfigCreationWizard.java b/org.eclipse.osee.ats/src/org/eclipse/osee/ats/workflow/editor/wizard/AtsWorkflowConfigCreationWizard.java index d1017e6826b..665789b8c1a 100644 --- a/org.eclipse.osee.ats/src/org/eclipse/osee/ats/workflow/editor/wizard/AtsWorkflowConfigCreationWizard.java +++ b/org.eclipse.osee.ats/src/org/eclipse/osee/ats/workflow/editor/wizard/AtsWorkflowConfigCreationWizard.java @@ -15,12 +15,13 @@ import java.util.List; import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.wizard.Wizard;
import org.eclipse.osee.ats.AtsPlugin;
+import org.eclipse.osee.ats.artifact.ATSAttributes;
import org.eclipse.osee.ats.workflow.editor.AtsWorkflowConfigEditor;
import org.eclipse.osee.ats.workflow.item.AtsWorkDefinitions;
+import org.eclipse.osee.ats.workflow.item.AtsWorkDefinitions.RuleWorkItemId;
import org.eclipse.osee.ats.workflow.page.AtsCancelledWorkPageDefinition;
import org.eclipse.osee.ats.workflow.page.AtsCompletedWorkPageDefinition;
import org.eclipse.osee.ats.workflow.page.AtsEndorseWorkPageDefinition;
-import org.eclipse.osee.ats.workflow.page.AtsImplementWorkPageDefinition;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
import org.eclipse.osee.framework.skynet.core.transaction.SkynetTransaction;
import org.eclipse.osee.framework.ui.plugin.util.AWorkbench;
@@ -77,8 +78,10 @@ public class AtsWorkflowConfigCreationWizard extends Wizard implements INewWizar workflow.setStartPageId(endorsePage.getId());
- WorkPageDefinition implementPage =
- new WorkPageDefinition("Implement", namespace + ".Implement", AtsImplementWorkPageDefinition.ID);
+ WorkPageDefinition implementPage = new WorkPageDefinition("Implement", namespace + ".Implement", null);
+ implementPage.addWorkItem(RuleWorkItemId.atsRequireStateHourSpentPrompt.name());
+ implementPage.addWorkItem(ATSAttributes.WORK_PACKAGE_ATTRIBUTE.getStoreName());
+ implementPage.addWorkItem(ATSAttributes.RESOLUTION_ATTRIBUTE.getStoreName());
WorkPageDefinition completedPage =
new WorkPageDefinition("Complete", namespace + ".Completed", AtsCompletedWorkPageDefinition.ID);
@@ -88,6 +91,7 @@ public class AtsWorkflowConfigCreationWizard extends Wizard implements INewWizar workflow.addPageTransition(endorsePage.getId(), implementPage.getId(), TransitionType.ToPageAsDefault);
workflow.addPageTransition(implementPage.getId(), endorsePage.getId(), TransitionType.ToPageAsReturn);
+ workflow.addPageTransition(cancelledPage.getId(), endorsePage.getId(), TransitionType.ToPageAsReturn);
workflow.addPageTransition(implementPage.getId(), completedPage.getId(), TransitionType.ToPageAsDefault);
workflow.addPageTransition(endorsePage.getId(), cancelledPage.getId(), TransitionType.ToPage);
@@ -97,16 +101,16 @@ public class AtsWorkflowConfigCreationWizard extends Wizard implements INewWizar artifacts.add(completedPage.toArtifact(WriteType.New));
artifacts.add(cancelledPage.toArtifact(WriteType.New));
artifacts.add(workflow.toArtifact(WriteType.New));
+ workflow.loadPageData(true);
SkynetTransaction transaction = new SkynetTransaction(AtsPlugin.getAtsBranch());
for (Artifact artifact : artifacts) {
- artifact.persistAttributesAndRelations(transaction);
AtsWorkDefinitions.addUpdateWorkItemToDefaultHeirarchy(artifact, transaction);
+ artifact.persistAttributesAndRelations(transaction);
}
transaction.execute();
AtsWorkflowConfigEditor.editWorkflow(workflow);
- workflow.loadPageData(true);
} catch (Exception ex) {
OSEELog.logException(AtsPlugin.class, ex, true);
|