There are three ways of finding an item for the first time in SystemWeaver:
- Open a direct link to an item.
- Search among all items in a SystemWeaver database.
- Search for items in a set of items, defined by a view.
Open a Direct Link
A direct link to an object, such as an item or part, can exist in different shapes and forms.
Double-click on object
If you see an object in the UI of swExplorer, for example an item (or node or part) with icon and name, or a Description reference in a description, that object is a true, online representation of a SystemWeaver object*. By double-clicking on that object, you will open the item in an Edit item tab. (Issues are opened in a similar way.)
Use Item name and type
If you have the name of an item (or example) along with the type of the item, you can (probably) find and open the real item if you know the server where the item is stored. You can log in to the server and use the Open item > General Search method to identify and open the item. The problem with this is that there may be many items with the same name, including the version of the item. The item can also get a new name after the "reference" was made (in your head, in a screenshot, or on a paper).
Use Item ID
Sometimes called "hex ID" due to the hexadecimal form, this unique object ID can been viewed in the Properties view. If you have the item id for the object, you can log in to the server (which you need to know) and use the Open item > with ID or Enter SystemWeaver ID options to open the item.
The strongest reference that can exist outside SystemWeaver is a SystemWeaver URL, since it includes all information to locate and open the item. A SystemWeaver URL can be used in links in contexts outside SystemWeaver in applications and formats that support URLs, like email, web pages, or MS Word documents:
When you do Copy on an item in SystemWeaver, the URL is placed into the Clipboard and can be copied into such external applications. If you have SystemWeaver installed on your computer, you can click on the external link and the item will be opened in a tab in the swExplorer client.
However, in order for this to work, you must first have registered (one time) that the SystemWeaver Explorer application is to be used for opening these types of URLs. To register:
- Navigate to the directory that contains the swExplorerLauncher.exe to be used to open the links.
- Find the swExplorerLauncherRegister.bat file in the same directory, right-click on it and select Run as Administrator:
A SystemWeaver installation can also be set up with published references to items of common interest:
Such "links" will technically be full-fledged SystemWeaver objects.
Global Search Using Open Item
There are various search options available via the Open item page and the Open item drop-down menu. The search request is sent to the server which will execute the search and send back a list of matching items on the Open item page.
Select Item Type
This option is used whenever you need to select a specific item type.
- Click on Select item type to open the Select type dialog where you can select among all item types there are in the SystemWeaver database. (Alternatively, you can begin your item type search via the Open item drop-down menu by selecting a frequently opened Type or the Other item type option.
In the Filter box at the top, you can type letters that can be found in the Name or SID values. This option is especially useful in case the list of types is long and includes many sub-types. All item types that contain the entered string will be displayed in the filtered list while the others will be hidden.
In the example here, we can see that all available types that include the "lic" string are available.
The Include Deprecated option should normally not be used since it will also include types that are marked as 'deprecated' and thus not to be used.
The Include Base Item option is normally used only by SystemWeaver administrators to select Config item used for configuring the SystemWeaver environment and the swExplorer.
- Double-click on a type or select the type you are searching for and click OK. A list of matching items will display. You can then sort by any of the fields.
This option is used whenever you need to specify a library, typically when selecting access rights to new items.
- Click on Select library to open the Select library dialog, where you can select among all libraries in the SystemWeaver database.
In the Filter box at the top, you can type letters that can be found in the library name you are looking for. All libraries that contain the entered string will be displayed in the filtered list while the others will be hidden.
The Filter on write access checkbox is usually checked by default in contexts where it is assumed that you will add something to a library.
- To select a library, select it and click OK or double-click on the library name in the list.
This option is used for specifying search criteria when searching the entire server**.
- Click on General Search to open the Find dialog which offers many alternative search criteria options. (Alternatively, you can access the General Search option in the Open item drop-down menu.)
The search options for searching in the server are almost the same as for searching in a view, except that you can only search for items and only search for text in the Name field:
You can also search for item properties and attributes.
- Enter your search criteria and click OK. Your search results will display in a list that you can filter further by any field.
In a database wide search as described above, you cannot search within Descriptions nor do you have the option to search for specific part or node conditions. These options are, however, available via the Find ribbon menu option (shortcut: Ctrl+F) when searching in a view and structure tree, i.e., when you are not doing a global database search. This is described in the next section.
Note: If you enter a specific item type in the Item type field as part of your search criteria, your results will return items of the specified item type as well as items of all item types that inherit from the specified item type. If you only wish to return items of a specified item type and NOT those that are of inherited types, use the Open item drop-down menu and select the Other item type option.
Searching in a View
You can also search for items within a view which is really a set of items as opposed to the entire database. This method does not involve the server*** since the search is done in the client on data available in the client. The most common example of this is probably searching in the Structure tree.
- Select any item in the structure tree view and click the Find button on the Items ribbon (or shortcut: Ctrl+F).
- To search for text, enter text into the Find field and check the desired Search in boxes. You also have options to Match Case and Exact match.
- You can also search for item properties and attributes. In the above example, only items of type 'Design Architecture' will be searched.
- Once you get your results, you can use the Filter on Search Results option to filter the view to only include the items you searched for (along with their parent items to maintain context).
In the above example search for Requirements, 35 items were found as indicated above and they are highlighted green in the structure tree within their context:
Note: Only the items that are actually visible in the tree or view will be searched. This means that you may get different results for different view selection.
If you want to search for an item you had recently found, you may find it in the Recently closed items on the Open item page:
If you find yourself searching for the same item often, consider adding it to your favorites.
* A SystemWeaver object being an Item, Node, Part, Issue etc. Such objects are technically made available in client applications, connected to a SystemWeaver server. In such applications, like the swExplorer, a SystemWeaver object is technically represented by various objects, in the technology of that application. Since each such object is connected to the SystemWeaver server any such representation can be considered to "be" the SystemWeaver object, in all practical aspects.
** Technically, searching among data available in the swExplorer client and searching in the SystemWeaver server are quite different operations. The Find dialog still presents a common interface to these operations.
*** In case the search requires data that has not already been cached into the server, the search may trigger reading of data from the server. For example, the first time you search in description texts you will notice an additional time to load the descriptions and perform the search. The next time you perform a similar search, it will be much quicker.