General

This section provides general guidelines and some how-to articles for working with the SystemWeaver API. If you do not find what you are looking for, we suggest that you refer to the SystemWeaverClientAPI.XML for a list of methods.

How to Update Parent Relation to Child
This article provides two examples for how to update a parent's relation (part) so that it points to the latest version of a defining item (child).  ...
Fri, 18 Jan, 2019 at 9:50 AM
How to Retrieve SystemWeaver Icons
For item types, part types and issues, Architects typically select icons to be displayed in the swExplorer client so that users can easily distinguish betwe...
Tue, 28 Jun, 2022 at 7:42 AM
How to Search for All Versions of an Item
This article describes the methods used to collect all versions of a given Item. public static IswItems GetAllVersionsOfItem(IswItem item) { //Store al...
Fri, 16 Aug, 2019 at 8:28 AM
How to Set an Item to Clipboard
Here is an example function that sets a hard-coded item to the clipboard. After this function has executed, the user can then find the item in a structure u...
Tue, 11 Jun, 2019 at 4:10 PM
Optimized Searching for Items with Attribute Value
A common use case when writing API programs and extensions is searching for items with a given attribute value, e.g., get all requirements with a given requ...
Wed, 27 Oct, 2021 at 2:08 PM
How to Set Values for Enumeration Type with Data Dimension Set
This article provides an example of how to set values for an enumeration type attribute that has a data dimension of Set using the API. public void Set...
Wed, 8 Jul, 2020 at 9:35 PM
How to Work with VersionInfo
The VersionInfo property is longer text, usually shown in a change log, describing the changes made to the item since last version. The text is represented ...
Wed, 11 Nov, 2020 at 3:53 PM
Checking User Access to a Library
This article provides an example of the method used for checking user access rights to a library. The Library Handle (or ID) can be found in the Manage Libr...
Wed, 11 Nov, 2020 at 4:02 PM
How to Get and Set User Attribute of Dimension Set
The following code snippet shows how to get and set values for a User type attribute of data type Set using the SystemWeaver API: // Setting value. public...
Fri, 19 Aug, 2022 at 9:56 AM
Using StartEmbeddedServer for Unit Testing
For unit testing, it is possible to run the swDBServer as a commandline with arguments that tell which database it should run against, or you can run StartE...
Tue, 7 Jun, 2022 at 12:56 PM