Priority | Description | MIL-STD-498 Description |
---|---|---|
1 | Prevents end users from performing an essential task that results in work stoppages. The impact to project cost/schedule requires an immediate resolution and a special release may be necessary. | a. Prevent the accomplishment of an operational or mission essential capability b. Jeopardize safety, security, or other requirement designated "critical" |
2 | Adversely affects end users from performing an essential task. Significant impact to project cost/schedule with resolution needed within 3 weeks. | a. Adversely affect the accomplishment of an operational or mission essential capability and no work-around solution is known. b. Adversely affect technical, cost, or schedule risks to the project or to life cycle support of the system, and no work-around solution is known |
3 | Hinders end users from performing an essential task or a capability is behind schedule. Impact to project cost/schedule with resolution needed within 6 weeks. | a. Adversely affect the accomplishment of an operational or mission essential capability but a work-around solution is known. b. Adversely affect technical, cost, or schedule risks to the project or to life cycle support of the system, but a work-around solution is known |
4 | Minor impact to end users or is a capability being developed per schedule. Can be resolved per normal release schedule. | a.
Result in user/operator inconvenience or annoyance but does not affect
a required operational or mission essential capability. b. Result in inconvenience or annoyance for development or support personnel, but does not prevent the accomplishment of those responsibilities. |
5 | An inconvenience or annoyance. Can be resolved as schedule and budget permits. | Any other effect |
Field | Description |
---|---|
Title | Enter a descriptive title for this review. |
Review Roles | Add roles and select the appropriate user. This review type requires at least one Author and one Reviewer. |
Location of review materials | Either enter in a description of review materials or simply drag in files from workspace to be reviewed. If files are dropped in this box, the java package name (if appropriate), filename and a space to enter in the repository version will be provided. |
Description | Information necessary to make an informed decision. |
Blocking Review | if NOT a stand-alone review, this field will be enabled for entry. select yes if this review must be completed before the parent workflow can transition |
Need By | Date the review should be completed. |
Field | Description |
---|---|
Review Roles | Add or remove participants as needed. See Prepare State description for more information. |
Review Defect | Defects are not REQUIRED, but can be entered. Defects must be dispositioned and closed before review can be completed |
Resolution | Any notes or further information can be entered here. |
Field | Description |
---|---|
Title | Enter the question that is to be answered by the reviewers. Example: Do you think we should buy this software? |
Decision Review Options | Enter in all the options that are available for selection. Each line is a single decision option in the format: answer;state;<userId> Where answer = Yes, No, Mabye, etc... state = Followup or Completed - this will be the state to transition to if the answer is choosen <userId> = userId of the user to assign to the state to transition to. Note: Multiple users can be specified by <userId1><userId2> Note:UserIds are only valid for Followup state. Completed state has no assignees. |
Description | Information necessary to make an informed decision. |
Blocking Review | yes if this review must be completed before the parent workflow can transition |
Need By | Date the decision must be made. |
Field | Description |
---|---|
Question | The question to be answered as part of this review. |
Decision | The decision made by the user. |
Resolution | Any notes or information as to why the decision was made. |
Resolution | Any notes or information as to why the decision was made. |
The Branch Manager View is used to display all of the branches in Skynet, as well as details for the transactions on each branch.
Branches and transactions can be sorted by clicking on the column heading for the column to sort by. Initially, the data will be sorted in ascending order. Clicking the same column multiple times will toggle the sorting between ascending and descending.
Locating branches can also be aided by filtering or using favorites.
The Change Report View is used to summarize the changes that have been made on a branch or series of transactions.
A Change Report can be performed for a branch two ways. The first way is by selecting right-clicking a branch from the Branch Manager then choosing the "Show Change Report" menu item. The second way is to select "Show Change Report" from the Aspect view of an ATS Action that is still in work; this will do a Change Report for the working branch of the Aspect.
This type of Change Report will display all of the artifacts on the branch that have had an attribute or relation link modified. It will also do conflict detection on these artifacts against the parent branch. All changes done on the current artifact will appear with a grey right arrow, while all changes from the parent branch will be shown with a blue left arrow. Attributes and relation links with multiple changes will provide a summarized node that shows the final effect of the changes and can be expanded to view all of the minor changes that were made. If an attribute or relation link was modified on both branches then the summary will show a red conflict mark to signify that a commit will cause an override to occur.
The Quick Search view allows users to perform searches for information that is contained inside artifacts in a selected branch.
To find all artifacts that contain a particular set of keywords:
Type your search string in the Enter Search String combo box, or use the
pull-down list to select a previously entered search expression.
Special characters such as (' '
,
!
, "
, #
, $
,
%
, (
, )
, *
, +
,
,
, -
, .
, /
, :
,
;
, <
, >
, ?
, @
,
[
, \
, ]
, ^
, {
,
|
, }
, ~
, _
) are assumed to be word separators unless By Id option is selected.
When By Id option is selected, (,
and ' '
) are treated as separators.
For example:
hello.world
will be translated to hello
and world
. The search will match attributes with hello
and world
keywords.A+ABG7jFm+0BKaVZIxfqOQ,AFABG7jFm+0BKaVZIxfqOQ PX1FH
) will be interpreted as 2 GUID(s) and 1 HRID. The search will match artifacts containing A+ABG7jFm+0BKaVZIxfqOQ
and AFABG7jFm+0BKaVZIxfqOQ
as its GUID or PX1FH
as its HRID.
Attribute Type Filter Search Option
By Id Search Option
Include Deleted Search Option
Word Order Match Search Option
An option to include artifacts that have been deleted as part of a quick search on the default branch.
Type in the desired words. Make sure the Include Deleted option is selected under Options, then press the Search button.
Pressing enter in the text entry box is equivalent to pressing the Search button.
When an artifact is saved, each attribute contained in the artifact is analyzed to produce a list of tags that are then associated with the artifact. Quick search is a form of keyword based searching which uses tags to perform contextual artifact searches.
For an attribute to be tagged by the system, it must meet the following criteria:
To produce tags, modified attributes are sent to the OSEE application server where the tagging system processes each attribute using an Attribute Tagger specified by the attribute's type. The Attribute Tagger knows how to interpret the attribute's data and how to extract words from the content. At this point, a word is defined as a sequential set of alphanumeric characters delimited by one or more spaces. As words are parsed, they are sent to the tagging system's word encoder where the following processing takes place:
' '
,
!
, "
, #
, $
,
%
, (
, )
, *
, +
,
,
, -
, .
, /
, :
,
;
, <
, >
, ?
, @
,
[
, \
, ]
, ^
, {
,
|
, }
, ~
, _
) as delimiters.When encoding words into tags, the tag encoder uses an algorithm which transforms the word's characters into a bit-packed tag that will fit in a 64-bit integer. The tag will represent up to 12 characters (all that can fit into 64-bits). Longer words will be turned into consecutive tags.
Original | Keywords | Encoding | ||||
---|---|---|---|---|---|---|
appendeces | appendix | -220858502 | ||||
battery(ies) | battery | 529513131 | ||||
alternate/backup |
|
|
The Mass Artifact Editor allows the easy view of multiple artifact along with their attributes. This editor can be viewed from right-click off Artifact Explorer, Search Results page, or via ATS action. Single cells can be edited via Alt-Left-Mouse-Click. After editing any number of artifacts shown, the save button persists this data.
Note: This editor will close upon switch of default branch unless the editor is tied to the common branch.
The Merge Manager is used to resolve conflicts that arise when doing development on parallel branches. The Merge Manager makes conflicts that arise easily identifiable and then provides the means for resolving the conflicts, so that the working branch can be committed.
The Merge Manager is in place to find conflicts and help users resolve these conflicts. A conflict exists if the value of an attribute/artifact has changed on both the Destination and Source Branches. For reference the Source Branch is the users working branch. It is the branch that the user has been making changes to and would like to then add back into the Destination Branch or Baseline Branch. Both branches are identified by name in the header of the Merge Manager.
Depending upon the conflict found, the user may have several choices for resolution. These include
Committing of Branches is blocked until all conflicts are resolved.
The GUI is organized to provide the user with an ability to quickly identify conflicts.
For Word Formatted Content conflicts see the section below. This section addresses all other conflicts.
Informational conflicts are identified by the icon in the conflict resolution column in the GUI. Informational conflicts require no action by the user, and no actions are provided in the GUI other than the ability to use the right click menu to examine the artifact using the tools provided there. An informational conflict is generated when the Source branch deletes an Artifact or an Attribute and that same Artifact or Attribute was modified on the Destination Branch. This is to allow the user the opportunity to review a change that was made on the Destination Branch that might make them want to take some action in regards to their deletion.
Un-resolvable Conflicts are identified by the icon in the conflict resolution column of the GUI. This conflicts require the user to revert the Artifact or Attribute that caused the conflict on the Source Branch. An Un-resolvable conflict is caused when the Destination Branch deletes an Artifact or Attribute while the Source Branch modifies that same Artifact, Attribute. The reason the user must revert their changes is that committing in their changes would essentially undo that deletion and bring that item back into existence. If the deletion should not have happened the user needs to talk with the committer of the deletion to resolve the issue.
Attribute Conflicts occur when both the Destination and Source branch modify an attribute. This section will cover all attributes except Word Formatted Content Attributes. The resolution of these Attribute values provide three options. Use the Source attribute value, use the destination attribute value, use a modified value that is some combination of the source and destination values. In order to use the Source Value the user may left click on the icon in the Source Value column. This will copy the icon and the value displayed in the Source Value column into the Merged Value Column. In order to use the Destination Value the user may left click on the icon in the Destination Value column. This will copy the icon and the value displayed in the Source Value column into the Merged Value Column. Both of these options are also available from the Merge Wizard (Left click on the icon in the Merge Value column) with the "Load Source Data" and "Load Destination Value" buttons. In order to modify the value to some combination the user must bring up the Merge Wizard which has an embedded editor specific to the attribute that needs to be modified. Once the value is accurately entered in the editor the user may than select "Finish" This will place a icon in the Merged Value column along with the new value. The user then right clicks on the in the Conflict Status Column so that the icon is displayed. The conflict is resolved and will allow the Source Branch to be committed.
The Merge Wizard
Resolution of conflicts is provided in two different ways. They can either copy and paste the changes into their Merge Artifact document or they can generate a Three Way Merge and accept the changes that show up in the generated document. Both approaches have their advantages and disadvantages and are best suited for different situations. They can also be combined where the situation warrants it, however the three way merge must always be done first if this is the case.
Manual Merging is the process of combining the Source Branch changes and the destination branch changes manually by copying and pasting them into the Merge Artifact document. The Merge Artifact is a separate version of the artifact that will preserve the details of the Merge, and will be reviewable in the Merge Manager after an artifact is committed. IMPORTANT: If the user makes the changes to their Source Branch instead of on the Merge Artifact the Merge Manager will incorrectly represent the merge in future reviews.
The following procedure illustrates the functionality available to facilitate a manual merge.The user will first either launch the Merge Wizard by left clicking on the icon in the Merge Value column of the GUI or they may select the functionality from the right click menu for the conflict in question. The first thing to do is to bring up a word document comparison of both the Source Branch Version and the Destination Branch Version. These documents will show all of the changes that have been made to these two artifacts since the Source Branch was created. To launch these difference's the user either select "Show Source Diff" and "Show Destination Diff" from the wizard or "Differences"->"Show Source Branch Differences" and "Differences"->"Show Destination Branch Differences" from the right click menu. These will bring up the two difference's in different Word instances with window labels to allow the user to differentiate the files. The intention of bringing up these difference's is twofold. Firstly, it allows the user to identify the file that has the most changes. Secondly, it will come in use later when the user copy's and paste's changes into the Merge document.
Upon identifying the branch that has the most changes the user should then set the Merge Artifact to contain that branches value. This is done by either selecting "Populate with Source Data" or "Populate with Destination Data" from the Merge Wizard or left clicking on the icon or the icon in the Source and Destination Value columns in the Merge Manager GUI. The user can then bring up the Merge Artifact for editing by clicking on "Edit Merge Artifact" in the Merge Wizard or in the right click menu. The Document that comes up contains the Merge Artifact and any changes made to it will be reflected when the Source Branch is committed. The user can than begin to copy the changes from the diff report that showed the fewest changes (opposite of the one chosen as the baseline). After all changes have been migrated into the Merge Artifact document the user than saves the document, which will preserve the Merge Artifact value. The user should be aware that any changes they do not wish to preserve from either the Source or Destination version of the Artifact need to be omitted on the Merge Artifact.
The user then right clicks on the in the Conflict Status Column so that the icon is displayed. The conflict is resolved and will allow the Source Branch to be committed.
Usage
When both versions have many changes or both versions have few changes.
When only one file has formatting changes (Must be combined with Manual Merging in this case)
When three way merging generates an understandable document
Three Way Merging leverages Microsoft Words ability to merge documents. At the beginning of any Word Formatted Content merge it is recommended that user generate a Three Way Merge and check the complexity of the document. In most cases Three Way Merging is a quicker way to merge two documents, however in some cases the Three Way Merge will generate a document that is difficult to use and understand. This usually arises when the Source and Destination branches have edited the same text or if one of the branches has touched a large percentage of the file. As it runs fairly quickly it is always a good idea to run it at the beginning of a Merge to check if it is useful. Three Way Merging only allows the user to maintain format changes from one of the documents. If format changes are made on both documents the Three Way Merge will prompt the user as to which format changes they would like to maintain, the user will then need to copy the format changes from the other document into the Merge Artifact document manually.
A Three Way Merge is generated by selecting Generate Three Way Merge from either the Merge Wizard or the right click menu. IMPORTANT: Generating a Three Way Merge will discard any changes made to the Merge Artifact, therefore a prompt will make sure this is the intended operation. If a user had started a Three Way Merge previously but had not completed the Merge the user is also given the option of continuing the previous Merge in the prompt (Selecting Edit Merge Artifact will also have this effect). The following is an example of a Three Way Merge in Word.
A Three Way Merge
The changes made by the Source Branch and Destination Branch are shown in different colors in the Word Document. In this particular case the changes made in Red were done by the Source Branch and the changes made in Blue were done on the Destination Branch. The color scheme is not consistent and the user needs to verify which color equates to which changes by hovering there mouse over one of the changes. A popup will be shown which will identify the author. The following Guide will explain how to resolve the changes in the document. IMPORTANT: All changes must be either accepted or rejected before the conflict can be marked as resolved. After the user has resolved all the changes it is a good idea to do generate a difference document between the Source Artifact and the Merge Artifact, and the Destination Artifact and the Merge Artifact by selecting "Show Source/Merge Diff" and "Show Destination/Merge Diff" from the merge Wizard or "Differences"->"Show Source/Merge Differences" and "Differences"->"Show Destination/Merge Differences" from the right click menu. These views will show the differences between the branch artifact and the merge artifact. For the Source/Merge difference this will show everything that is different between the source document and the Merge document. In the case where the user accepts all changes from the source and destination branches this diff will highlight all of the changes that occurred on the destination branch. In the Destination/Merge diff it will highlight all of the changes that happened on the source branch. It is always possible to use Manual Merging techniques in conjunction with Three Way Merging.
The user then right clicks on the in the Conflict Status Column so that the icon is displayed. The conflict is resolved and will allow the Source Branch to be committed.
Word Formatted Content Merge Wizard
The Merge Wizard contains a "Clear the Merge Artifact" that is not available from the right click menu and only available for Word Formatted Content. This will empty out the Merge artifact and allow the user to start with an empty document for editing. It will also place a icon in the merge value column for that conflict.
Customize the table to show desired columns, widths with specified sorting and filters. Enables loading of both personal and global customizations and provides the ability to select a customization as the default customization to be loaded upon startup.
Lists current personal and global customizations to be selected from. Double-click to automatically load selected customizationa and close dialog.
Allows for the selected customization to be configured, loaded and saved.