OSEE/Users Guide/Tips

Frequently Asked Questions

Do I have to create a new database table for every type of Artifact that I want to use?

Quick Answer: No

The OSEE Architecture Framework uses a common table structure to store all types of artifacts, attributes and relations. This allows the users to dynamically create and start using new objects without major database modification.

Do I have to use the Artifact types that are built into OSEE?

Quick Answer: No

All Artifact Types, Attribute Types and Relation Types (with a few exceptions) are fully customizable. Although OSEE was initially built for capturing all data throughout the lifecycle of a large avionics systems engineering project, it was architected to store any data by simply defining a different data model to use.

In addition, these data models can be dynamically modified. New Artifacts, Attributes and Relations can be specified at anytime (and even by end users if allowed). Modification and deletion of these can be performed with some administrative back-end tools with the understanding that you would need to determine what to do with the removed data.

How do I delete artifact types?

There is a BLAM called "Purge Artifact Type" that is used to permanently remove all traces of an artifact type from the OSEE database. The BLAM allows the user to select one or more artifact types to purge. If any artifact instances of the doomed artifact type exist, a different artifact type can be specified; these artifacts will be converted to the new type. Otherwise, the BLAM will abort upon discovering an artifact that is of a type to be purged; that is, the BLAM will never delete any artifacts.

Can OSEE be used offline and later sync'd up?

Although OSEE does not currently provide the capability to download database artifacts, work offline and then sync up when re-connected, it was certainly a consideration in the design. The most complex part would be resolving conflicts that may occur to artifacts edited in both disconnected OSEE's. Since OSEE already has the capability to run on multiple databases and the capability to export and import artifacts, it would just take some effort to provide the first versions of this feature. This would be a great area for collaboration.

How are MS Word styles and formatting handled?

Whole MS Word documents can be stored and edited as an artifact like any other native file type without any formatting restrictions of any kind. However, to use the more tightly integrated support such as editing many artifacts in a single Word document or the document generation capabilities, then the file format needs to be MS Word 2003 XML. Since OSEE supports user defined Word XML templates for editing, previewing, comparing, and publishing, the user has complete control over the Word styles (and all other formmatting) through the rendering templates. The only formmatting requirements for Word content are that when importing the Word styles "Heading (1...9)" are used to determine the breakout into individual artifacts and their position in the document hierarchy.

Search Tips

Searching for all artifacts of a given type

1. From the pulldown menu, open Search > Search...
2. Select the Artifact Search tab
3. Select the branch you wish to search on
4. Select Artifact Type in the first pulldown under Create a Filter
5. Select the artifact type you wish to search for
6. Select "Add Filter" (make sure no other filters exist from your last search)
7. Press Search

MS Word Tips

Importing Microsoft Word(c) documents into OSEE

Yes. OSEE will import existing Word 2003 XML documents and atomize them by their paragraph sections. The Word styles "Heading (1...9)" are used to determine the breakout into individual artifacts and their position in the document hierarchy.

Stop Word from raising a "Convert File" prompt

1. Open Tools > Options... > General
   1. Uncheck Confirm conversion at Open
   2. Click OK

Stop Word from adding Smart Tags

1. Open Tools > AutoCorrect Options… > Smart Tags
   1. Uncheck Label text with smart tags
   2. Click Save Options...
      1. Uncheck Embed Smart Tags
      2. Click OK
   3. Click Remove Smart Tags if the button is not grayed out
   4. Click OK

Make XML Tags Visible

To toggle viewing of XML tags, press Ctrl+Shift+X. You should enable these unless you have a good reason not to.

Make tracked changes in Word appear inline instead of in balloons

1. Open the Show dropdown menu within the Reviewing Toolbar and select Options....
2. Within the Track Changes window that just appeared change the Insertions and Deletions colors to Blue and Red, respectively.
3. Change the Use Balloons dropdown menu from Always to Only for comments/formatting.
4. Click OK.

Keep MS Word from prompting to save Normal.doc

1. On the Tools menu, click Options.
2. Click the Save tab.
3. Clear the Prompt to save Normal template check box.