Browse behavior
WinCC Unified Open Pipe provides several Browse commands in the simple syntax and in the expert syntax. The following behavior is common to all commands:
-
Initial request
In an initial request, you define the request using optional parameters.
-
Page size
To get the result faster, you can use a parameter to specify a page size in the initial request. If the result exceeds the specified page size, the response is distributed over several pages.
Without this parameter the configured page size is used. You can read the configured page size via the commands "ReadConfig" and set it via "WriteConfig".
-
Next request
You get the next results page via the following requests. Next requests only have the parameter "Next".
-
A Browse command is complete when a Next request returns an empty response.
-
A Browse command that has not yet reached the last page of results is canceled in the following cases:
-
When the configured time limit for inactivity is exceeded.
You can read the time limit via the commands ReadConfig and set it via WriteConfig.
-
When a new browse request is started.
-
Configurable settings
The following settings control the browse behavior:
|
Setting |
Default value |
Value range |
Description |
|---|---|---|---|
|
DefaultPageSize |
1000 |
0 ... Uint32_Max |
If a browse request was called without the PageSize parameter and the number of hits is greater than the value of DefaultPageSize, the response is distributed over several pages. Value 0: No pagination |
|
BrowseTimeOut |
300 s |
0 ... Uint32_Max |
For requests with pagination, defines after how many seconds without activity the request is canceled. After that a Next request returns an error. Value 0: No timeout |
With the command "ReadConfig" you request the settings, with the command "WriteConfig" you set them. Changes apply to the current pipe session.