Configure light list view paging query - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

You can configure paged queries to display the results in a light list view. With a standard list view, if a column item is configured to follow a relationship or edge definition to another object, the system navigates to that object and returns its name, all its other properties, and the relationships it has with other objects. In cases of documents with revisions, versions, and attached files, this can affect performance.

With the light list view, if a column item for an object is configured to follow a relationship or edge definition to another related object, the system navigates to that related object and returns only the property called specifically by the column item. To view all the other data about the related object, you must specifically select it, and click on it.

When using the light list view, the applicable data from related objects is collected when the query is performed. If that data is updated, you must run the query again to see the changes in your list view.

Using a light list view is more efficient for both the initial paging query and the display of each page using the Show All command. This is because a light list view works with a collection of objects rather than individual objects. The Show All method is disabled by default, but it can be enabled to display results in the light list view.

  • You cannot apply conditions when returning query results in a light list view.

  • You cannot see any relationship changes in the results when using a light list view. For example, if a tag has a column item that is related to an area name, any change to the name of the related area is not displayed in the light list view.

Custom icons

You can customize icons for use in the standard list view, so that each object type can have icon variations. Each object can display different icons depending on its status, such as working, signed off, superseded, and so on. Some objects use custom functionality to display different icons, such as WorkflowStep, SharedObject, ConfigurationStatus, and so on. These icons are not displayed in the light list view. Instead, these objects display different icons using custom code. Any custom code used for these icons needs to be modified to work with light list view. If an InterfaceIcon property is found on the interface definition, that icon is used. If there is no icon on the interface definition, the InterfaceIcon property on the object's class definition is used.

For more information on customizing icons for use with the light list view paging query, see Customizing icons for light list view paging query.

Client APIs

Find and query client APIs provide optional arguments to display query results in the light list view. You can configure the following four client APIs to display query results in a light list view:

  • QFindObject

  • QueryObject

  • QueryClassObj

  • QueryClassObjFromClass

All four client APIs use the following parameters:

Argument

Method

Type

Description

Arg 10

Enable a light list view

String

Enables the query results to display in a light list view when the value LIGHTVIEW is entered.

Arg 11

Enable a paged query

Integer

Enter a value to identify the page size, if no value is specified, then a normal query is used.

Arg 14

Enable light list view for a paged query

Boolean

Enables paged queries to display in a light list view when a value is entered in Arg 11 to trigger a query.

Each client API retrieves the queried objects based on the argument selected on the corresponding method.

Set the following arguments on the QFindObject method using the QFindObject client API to get the following results:

Required result

Arg 10 value

Arg 11 value

Arg 14 value

Paged query

NULL

Value that indicates the number of pages at which page query will be used

FALSE

Paged query

LIGHTVIEW

Value that indicates the number of pages at which page query will be used

FALSE

Normal list view

NULL

NULL

TRUE

Light list view

LIGHTVIEW

NULL

FALSE

Paged query in a light list view

NULL

Value that indicates the number of pages at which page query will be used

TRUE

To get a paged query in a light list view, when you select Argument 14, a page size value must be entered for Argument 11.

SHARED Tip You can configure the FTRSearch client API to display results in a light list view. However, it uses different arguments to enable a paged query or a paged query in a light list view.