The Paging toolbar appears in the list view window in SmartPlant Foundation following a search or query.
To display the Paging toolbar, set the Paged Query Size argument on any Query or QFind method. You must log out and log in to SmartPlant Foundation after you modify a method.
The Paging toolbar allows you to navigate information retrieved after running a query or search. When a search is completed, only the first page of the results appears in the list view window. As you navigate to additional pages of your search results, SmartPlant Foundation retrieves the information for that page only, stores it in the cache, and presents it in the list view window. The software does a count to see how many rows exist, and the size of the page is determined by the method argument that is driving the query.
Because the information is returned in one-page increments, the Warning dialog number user setting is ignored when paged queries are used. The Maximum query limit set on Change User Preferences is also ignored, unless you set the argument Honor Query Limits for Paged to True. When that argument is set to True, the Maximum query limit is honored, and a dialog box warns you if your query results exceed that limit.
Standard list view functionality is available, but only for the page currently displayed. For example, an export to the Microsoft Excel software allows you to export the items currently displayed in the list view window to a spreadsheet, as well as for the print and other export functions.
-
The paging query is not available for relationship expansion, any master/details forms, or any ad-hoc reports.
-
Sort and Filter commands only work on the displayed pages.
-
You can modify the sort order by either clicking a column heading or using the Multiple Column Sort dialog box.
-
Only the displayed page can be printed or exported.
-
If the query is smaller than the page limit, the Paging toolbar does not appear.
-
The Refresh Interval set on Change User Preferences dialog box is ignored.
-
A non-numeric value cannot be entered in the Displaying page box.
-
Any number outside the range entered in the Displaying page box does not affect the query.
Performance
Paging queries provide the ability to run complex searches, and then retrieve and show the information from the search results based on the number of objects you want to see per page. The software retrieves objects from the database only when you navigate to a page, when it then presents the information for that page. After you have viewed a page, the information is stored in a cache.
The Paging toolbar has a Show All button, which is disabled by default. To use the button, configure the Enables Show All button for page query argument on the method.
The following items explain what to expect regarding query performance when using paged queries.
-
Each page of information in the Desktop Client is cached, so if you scroll back and forth between the pages, no additional searching occurs.
-
Click Show All to retrieve and display the whole set of query results, and then change the sort order or filter the whole set.
-
Clicking Show All retrieves only the data that has not already been cached. A message appears when you click Show All indicating the number of objects being retrieved and allowing you to continue or cancel the operation.
-
Sorting and filtering commands work only on the displayed page.
Multiple window displays
Running paging queries is unaffected by multiple window setup or by multiple windows left open for an unspecified duration. However, to view any updated changes, you must click Refresh or re-run the query.
Create or delete an item with multiple query pages open
If an item is created or deleted after the original query is run, you can click Refresh or re-run the query by clicking Edit Query on the toolbar to see the new or updated information.
The following list shows some considerations when working with paging query:
-
There is no delay in the time between when a new document is created and when it appears; however, you must re-run the query to see the new document on the query page.
-
A new document can appear on a page not currently being viewed, and it appears in a list that is sorted alphabetically by name. A query must be re-run or refreshed for the creator, or any other user, to view the new document.
-
If a document is deleted, the user who deleted it needs to click Refresh to remove the document from the query. If another user had the document in a query displaying in the list view window, the user needs to click Refresh to remove the document.
-
If one user views a page of the query and a second user is currently viewing the same query on a subsequent page (for example, page 5 of a 10-page query) and the second user deletes a document, the user viewing the second page does not see the deleted document when that user reaches page 5.
-
There is no time lag between when the document is deleted and when the query can be refreshed, but you must click Refresh to view the latest information.
-
A deleted document disappears immediately for the user who deleted if it is deleted from the page query list. However, all other users must click Refresh to see that the document is removed.