ManageRelatedItems client API - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Web Client Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10

The ManageRelatedItems client API provides the functionality in the Desktop Client to create methods that open a dialog box where you can add or remove relationships of a particular type.

Argument

Description

Parameter 1

RelDef to related items

Parameter 1 default

None

Parameter 1 description

Relationship definition (prefixed +/-) to get from selected object to the related objects that we are managing.

Example: +SPFRelDefAccessGroup to manage access groups on a selected relationship definition.

Parameter 1 type

String

Parameter 2

Column set to present results

Parameter 2 default

None

Parameter 2 description

Column set to display related items in the main table. This at minimum should contain the Name property. It can also contain other properties on the related objects (for example, when managing menu items) and properties and relationships configured on the relationship identified in Parameter 1.

Parameter 2 type

String

Parameter 3

Use related item library

Parameter 3 default

False

Parameter 3 description

Indicates whether and how to show the library. The options are True/False/Tree.

True - Displays the library. This is used when the related items can exist either in their own right (for example, access groups on roles) or attached to more than one parent (for example, column items on the column sets). When the library is used, the Remove selected item button deletes the relationship, and the item remains in the database.

False - The library is not displayed. This is used when the related items cannot exist without their parents such as menu items. When the library is not used, the Remove selected item button deletes the related object, and the item is removed from the database. The Create a new item and relate it button SPF_BTN_CreateANewItemAndRelateIt is displayed above the Remove selected item button.

Tree - This displays the library in the form of a tree view. The tree view is not pre-populated, and the library find option is automatically turned on (see Parameter10).

The library pane is replaced by a tree view to allow navigation to related objects, for example, to browse the Interface Implies tree.

Parameter 3 type

String

Parameter 4

Child ClassDef for library use

Parameter 4 default

None

Parameter 4 description

The class definition of the related items (the relationship definition in Parameter 1 might be between interfaces that are common to many classes and this identifies the specific class for the library). This is also used to control a class of the object to be created when the Create button is used.

Parameter 4 type

String

Parameter 5

Auto sequencing

Parameter 5 default

False

Parameter 5 description

If this is True and an item is selected in the Related Items pane (left), any new items added into the Related Items pane will be placed above the selected item. If False, items will be placed at the bottom of the Related Items pane.

Parameter 5 type

Boolean

Parameter 6

Override library query interface

Parameter 6 default

None

Parameter 6 description

When the library is used, the objects displayed in the library are queried by using the primary interface of the class definition specified in Parameter 4. This parameter allows for the specification of a different interface for the query. For example, when managing checklists for a step, the ISPFWorkflowStepChkLstItemTemplate interface is specified as we only want to present template checklists in the library.

Parameter 6 type

String

Parameter 7

Library query filter configuration

Parameter 7 default

None

Parameter 7 description

This argument is used to restrict the number of objects returned to the library. The format of the comparison is illustrated here:

InterfaceDef~PropertyDef ~operator~value

For example, when managing methods on interfaces, you might want to list only those available in the Desktop Client, so the following criteria is used:

ISPFMethod~SPFAvailableinDesktop~=~True

Special library filtering can also be achieved in code. For example, manage column items would normally present hundreds, if not thousands, of column items in the library, but only a small subset of those column items would be applicable for the column set for a given class definition. The library of column items presented is restricted to those that are configured for properties and relationships on the class definition to which the column set is related.

Another example is managing subscription notification events from an interface where only events that are raised on that interface are presented in the library.

Changing the library behavior is done by writing custom code. You can base your name class on the delivered RelatedItemsLibrary class. When the Manage Related Items control is launched, it will look at Parameter 4 on the method to see if there is a customized class with a similar name. See SmartPlant Foundation Server Customization for more detailed information about this.

Parameter 7 type

String

Parameter 8

Library column set

Parameter 8 default

None

Parameter 8 description

Column set used to display in the library list.

Parameter 8 type

String

Parameter 9

Hide Library buttons

Parameter 9 default

None

Parameter 9 description

Used to hide the Create, Update, and Delete buttons that operate on the library. This would be used when the objects in the library should not be editable by the user, for example, managing relationship definitions from access groups.

Parameter 9 type

Boolean

Parameter 10

Library QFind

Parameter 10 default

None

Parameter 10 description

The default is to provide an Advanced button to enter a filter criteria in the same format as described above for Parameter 7.

When Parameter 10 is set to True, this is replaced by the simple quick find box and button for filtering by name and the library itself is not populated.

This is used when the number of potential related items is very large, for example, managing methods for an access group.

Parameter 10 type

Boolean

SHARED Tip Many methods use this client API, and the list can be viewed in the Web Client. To see the methods in your system that use this client API, find the client API, right-click it, and click Show Methods.

This client API is not supported in the Web Client.