1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
/*******************************************************************************
* 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
*******************************************************************************/
package org.eclipse.osee.ats.operation;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.osee.ats.api.data.AtsArtifactTypes;
import org.eclipse.osee.ats.api.data.AtsAttributeTypes;
import org.eclipse.osee.ats.api.data.AtsRelationTypes;
import org.eclipse.osee.ats.api.notify.AtsNotificationEventFactory;
import org.eclipse.osee.ats.api.notify.AtsNotifyType;
import org.eclipse.osee.ats.api.team.CreateTeamOption;
import org.eclipse.osee.ats.api.team.IAtsTeamDefinition;
import org.eclipse.osee.ats.api.team.ITeamWorkflowProvider;
import org.eclipse.osee.ats.api.user.IAtsUser;
import org.eclipse.osee.ats.api.util.IAtsUtilService;
import org.eclipse.osee.ats.api.util.ISequenceProvider;
import org.eclipse.osee.ats.api.workflow.log.LogType;
import org.eclipse.osee.ats.core.client.IAtsClient;
import org.eclipse.osee.ats.core.client.action.ActionManager;
import org.eclipse.osee.ats.core.client.task.AbstractTaskableArtifact;
import org.eclipse.osee.ats.core.client.task.TaskArtifact;
import org.eclipse.osee.ats.core.client.team.TeamWorkFlowArtifact;
import org.eclipse.osee.ats.core.client.util.AtsChangeSet;
import org.eclipse.osee.ats.core.client.util.AtsUtilClient;
import org.eclipse.osee.ats.core.util.AtsUtilCore;
import org.eclipse.osee.ats.core.workflow.TeamWorkflowProviders;
import org.eclipse.osee.ats.editor.SMAEditor;
import org.eclipse.osee.ats.internal.Activator;
import org.eclipse.osee.ats.internal.AtsClientService;
import org.eclipse.osee.framework.jdk.core.type.OseeCoreException;
import org.eclipse.osee.framework.jdk.core.util.AXml;
import org.eclipse.osee.framework.jdk.core.util.Collections;
import org.eclipse.osee.framework.jdk.core.util.Strings;
import org.eclipse.osee.framework.logging.OseeLevel;
import org.eclipse.osee.framework.logging.OseeLog;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
import org.eclipse.osee.framework.ui.plugin.util.AWorkbench;
import org.eclipse.osee.framework.ui.skynet.blam.AbstractBlam;
import org.eclipse.osee.framework.ui.skynet.blam.VariableMap;
import org.eclipse.osee.framework.ui.skynet.widgets.XListDropViewer;
import org.eclipse.osee.framework.ui.skynet.widgets.XModifiedListener;
import org.eclipse.osee.framework.ui.skynet.widgets.XWidget;
import org.eclipse.osee.framework.ui.skynet.widgets.util.SwtXWidgetRenderer;
import org.eclipse.osee.framework.ui.swt.Displays;
import org.eclipse.ui.forms.widgets.FormToolkit;
/**
* @author Donald G. Dunne
*/
public class DuplicateWorkflowBlam extends AbstractBlam {
private final static String TEAM_WORKFLOW = "Team Workflow (drop here)";
private final static String DUPLICATE_WORKFLOW =
"Duplicate Workflow - creates carbon copy with all fields and assignees intact.";
private final static String CREATE_NEW_WORFLOW_IN_START_STATE =
"Create new Workflow - creates new workflow in start state with current assignees.";
private final static String DUPLICATE_TASKS = "Duplicate Tasks - only valid for Duplicate Workflow";
private final static String DUPLICATE_METHOD = "Duplicate Method";
private final static String TITLE = "New Title (blank for same title)";
private Collection<? extends TeamWorkFlowArtifact> defaultTeamWorkflows;
public DuplicateWorkflowBlam() {
// do nothing
}
@Override
public void runOperation(final VariableMap variableMap, IProgressMonitor monitor) {
Displays.ensureInDisplayThread(new Runnable() {
@Override
public void run() {
try {
List<Artifact> artifacts = variableMap.getArtifacts(TEAM_WORKFLOW);
boolean duplicateTasks = variableMap.getBoolean(DUPLICATE_TASKS);
boolean createNewWorkflow =
variableMap.getString(DUPLICATE_METHOD).equals(CREATE_NEW_WORFLOW_IN_START_STATE);
boolean duplicateWorkflow = variableMap.getString(DUPLICATE_METHOD).equals(DUPLICATE_WORKFLOW);
String title = variableMap.getString(TITLE);
if (artifacts.isEmpty()) {
AWorkbench.popup("ERROR", "Must drag in Team Workflow to duplicate.");
return;
}
if (!createNewWorkflow && !duplicateWorkflow) {
AWorkbench.popup("ERROR", "Please select \"Duplicate Method\".");
return;
}
if (duplicateTasks && createNewWorkflow) {
AWorkbench.popup("ERROR", "Can not create workflow as new and duplicate tasks.");
return;
}
Artifact artifact = artifacts.iterator().next();
if (!(artifact.isOfType(AtsArtifactTypes.TeamWorkflow))) {
AWorkbench.popup("ERROR", "Artifact MUST be Team Workflow");
return;
}
try {
Collection<TeamWorkFlowArtifact> teamArts = Collections.castAll(artifacts);
if (createNewWorkflow) {
handleCreateNewWorkflow(teamArts, title);
} else {
handleCreateDuplicate(teamArts, duplicateTasks, title);
}
} catch (Exception ex) {
log(ex);
} finally {
AtsUtilClient.setEmailEnabled(true);
}
} catch (Exception ex) {
OseeLog.log(Activator.class, OseeLevel.SEVERE_POPUP, ex);
}
};
});
}
private void handleCreateNewWorkflow(Collection<TeamWorkFlowArtifact> teamArts, String title) throws OseeCoreException {
Set<TeamWorkFlowArtifact> newTeamArts = new HashSet<TeamWorkFlowArtifact>();
AtsChangeSet changes = new AtsChangeSet("Duplicate Workflow");
Date createdDate = new Date();
IAtsUser createdBy = AtsClientService.get().getUserService().getCurrentUser();
for (TeamWorkFlowArtifact teamArt : teamArts) {
// assignees == add in existing assignees, leads and originator (current user)
List<IAtsUser> assignees = new LinkedList<IAtsUser>();
assignees.addAll(teamArt.getStateMgr().getAssignees());
IAtsTeamDefinition teamDef = teamArt.getTeamDefinition();
assignees.addAll(teamDef.getLeads());
IAtsUser user = AtsClientService.get().getUserService().getCurrentUser();
if (!assignees.contains(user)) {
assignees.add(user);
}
TeamWorkFlowArtifact newTeamArt =
ActionManager.createTeamWorkflow(teamArt.getParentActionArtifact(), teamDef,
teamArt.getActionableItemsDam().getActionableItems(), assignees, changes, createdDate, createdBy, null,
CreateTeamOption.Duplicate_If_Exists);
if (Strings.isValid(title)) {
newTeamArt.setName(title);
}
changes.add(newTeamArt);
newTeamArts.add(newTeamArt);
}
changes.execute();
for (TeamWorkFlowArtifact newTeamArt : newTeamArts) {
SMAEditor.editArtifact(newTeamArt);
}
}
private void handleCreateDuplicate(Collection<TeamWorkFlowArtifact> teamArts, boolean duplicateTasks, String title) throws OseeCoreException {
Set<TeamWorkFlowArtifact> newTeamArts = new HashSet<TeamWorkFlowArtifact>();
AtsChangeSet changes = new AtsChangeSet("Duplicate Workflow");
IAtsUser user = AtsClientService.get().getUserService().getCurrentUser();
for (TeamWorkFlowArtifact teamArt : teamArts) {
TeamWorkFlowArtifact dupArt =
(TeamWorkFlowArtifact) teamArt.duplicate(AtsUtilCore.getAtsBranch(), Arrays.asList(AtsAttributeTypes.AtsId));
if (Strings.isValid(title)) {
dupArt.setName(title);
}
dupArt.setSoleAttributeFromString(AtsAttributeTypes.AtsId, getNexAtsId(teamArt));
dupArt.addRelation(AtsRelationTypes.ActionToWorkflow_Action, teamArt.getParentActionArtifact());
dupArt.getLog().addLog(LogType.Note, null, "Workflow duplicated from " + teamArt.getAtsId(), user.getUserId());
// assignees == add in existing assignees, leads and originator (current user)
List<IAtsUser> assignees = new LinkedList<IAtsUser>();
assignees.addAll(teamArt.getStateMgr().getAssignees());
assignees.addAll(teamArt.getTeamDefinition().getLeads());
if (!assignees.contains(user)) {
assignees.add(AtsClientService.get().getUserService().getCurrentUser());
}
dupArt.initializeNewStateMachine(assignees, new Date(), user, changes);
changes.add(dupArt);
// add notification for originator, assigned and subscribed
changes.getNotifications().addWorkItemNotificationEvent(
AtsNotificationEventFactory.getWorkItemNotificationEvent(user, dupArt, AtsNotifyType.Originator,
AtsNotifyType.Assigned, AtsNotifyType.SubscribedTeamOrAi));
if (duplicateTasks) {
for (TaskArtifact taskArt : teamArt.getTaskArtifacts()) {
TaskArtifact dupTaskArt = (TaskArtifact) taskArt.duplicate(AtsUtilCore.getAtsBranch());
dupTaskArt.getLog().addLog(LogType.Note, null, "Task duplicated from " + taskArt.getAtsId(),
AtsClientService.get().getUserService().getCurrentUser().getUserId());
dupArt.addRelation(AtsRelationTypes.TeamWfToTask_Task, dupTaskArt);
// for tasks, add notification for subscribed only
changes.getNotifications().addWorkItemNotificationEvent(
AtsNotificationEventFactory.getWorkItemNotificationEvent(user, dupTaskArt,
AtsNotifyType.SubscribedTeamOrAi));
changes.add(dupTaskArt);
}
}
// Auto-add actions to configured goals
AtsClientService.get().getActionFactory().addActionToConfiguredGoal(dupArt.getTeamDefinition(), dupArt,
dupArt.getActionableItems(), changes);
newTeamArts.add(dupArt);
// Notify all extension points that workflow is being duplicated in case they need to add, remove
// attributes or relations
for (ITeamWorkflowProvider teamExtension : TeamWorkflowProviders.getTeamWorkflowProviders()) {
teamExtension.teamWorkflowDuplicating(teamArt, dupArt);
}
}
changes.execute();
for (TeamWorkFlowArtifact newTeamArt : newTeamArts) {
SMAEditor.editArtifact(newTeamArt);
}
}
private String getNexAtsId(TeamWorkFlowArtifact teamArt) {
IAtsClient iAtsClient = AtsClientService.get();
IAtsUtilService utilService = iAtsClient.getUtilService();
ISequenceProvider sequenceProvider = AtsClientService.get().getSequenceProvider();
IAtsTeamDefinition teamDefinition = teamArt.getTeamDefinition();
String nextAtsId = utilService.getNextAtsId(sequenceProvider, null, teamDefinition);
return nextAtsId;
}
@Override
public void widgetCreated(XWidget xWidget, FormToolkit toolkit, Artifact art, SwtXWidgetRenderer dynamicXWidgetLayout, XModifiedListener modListener, boolean isEditable) throws OseeCoreException {
super.widgetCreated(xWidget, toolkit, art, dynamicXWidgetLayout, modListener, isEditable);
if (xWidget.getLabel().equals(TEAM_WORKFLOW) && defaultTeamWorkflows != null) {
XListDropViewer viewer = (XListDropViewer) xWidget;
viewer.setInput(defaultTeamWorkflows);
}
}
@Override
public String getXWidgetsXml() {
return "<xWidgets><XWidget xwidgetType=\"XListDropViewer\" displayName=\"" + TEAM_WORKFLOW + "\" />" +
//
"<XWidget xwidgetType=\"XCombo(" + CREATE_NEW_WORFLOW_IN_START_STATE + "," + DUPLICATE_WORKFLOW + ")\" required=\"true\" displayName=\"" + DUPLICATE_METHOD + "\" horizontalLabel=\"true\" defaultValue=\"false\"/>" +
//
"<XWidget xwidgetType=\"XCheckBox\" displayName=\"" + DUPLICATE_TASKS + "\" horizontalLabel=\"true\" defaultValue=\"false\"/>" +
//
"<XWidget xwidgetType=\"XText\" displayName=\"" + TITLE + "\" horizontalLabel=\"true\" defaultValue=\"" + getDefaultTitle() + "\"/>" +
//
"</xWidgets>";
}
/**
* Return "Copy of"-title if all titles of workflows are the same, else ""
*/
private String getDefaultTitle() {
String title = "";
if (defaultTeamWorkflows != null) {
for (TeamWorkFlowArtifact teamArt : defaultTeamWorkflows) {
if (title.equals("")) {
title = teamArt.getName();
} else if (!title.equals(teamArt.getName())) {
return "";
}
}
}
return AXml.textToXml("Copy of " + title);
}
@Override
public String getDescriptionUsage() {
return "Duplicate team workflow(s) as a carbon copy (all fields/states/assignees will be exactly as they are) or as new workflows in start state.";
}
/**
* @return the defaultTeamWorkflows
*/
public Collection<? extends AbstractTaskableArtifact> getDefaultTeamWorkflows() {
return defaultTeamWorkflows;
}
/**
* @param defaultTeamWorkflows the defaultTeamWorkflows to set
*/
public void setDefaultTeamWorkflows(Collection<? extends TeamWorkFlowArtifact> defaultTeamWorkflows) {
this.defaultTeamWorkflows = defaultTeamWorkflows;
}
@Override
public String getName() {
return "Duplicate Workflow";
}
@Override
public Collection<String> getCategories() {
return Arrays.asList("ATS");
}
}
|
