- Home
- WITSMLstudio
- WITSMLstudio Portal
- WITSML Browser User Guide
The WITSML Browser is a client application plug-in for PDS WITSMLstudio Desktop. It enables users to connect to any WITSML store and execute supported WITSML API functions. It consists of two sets of tabs for Request and Response functionality.
Request Tabs (Left pane)
- Settings - manages connections to a WITSML server and configuration of common options needed for performing WITSML API functions
- Hierarchy - displays the WITSML data object hierarchy of existing data in the server
- Query - provides a free-form editor for WITSML inputs/queries and buttons to perform API functions
Response Tabs (Right pane)
- Results - displays the result of a WITSML API function call
- Properties - provides a searchable list of elements and values for the selected data object node in the Hierarchy tab
- Data - provides a tabular view of growing object data for the selected data object node in the Hierarchy tab
- WITSML Messages - displays the WITSML request and response messages
- SOAP Messages - displays raw SOAP-encoded WITSML request and response messages
Settings manages connections to a WITSML server and configuration of common options needed for executing WITSML API functions.
Settings
This tab provides the following functionality:
- Connections
- API Functions
- Query Options
- Output Options
Hierarchy displays the WITSML data object hierarchy of existing data in the server. The hierarchy will be populated with a list of all Wells the first time the Hierarchy tab is navigated to after a server connection.
Hierarchy
Provides a tree view hierarchy of data in a WITSML Store. To expand a node, click on the left arrow or double-click the name.
Hierarchy Context Menu
Right-click a node to display a context menu with the following options:
- Get IDs - query the selected data object IDs
- Get Header - query the selected data object header; applies to growing objects only
- Get Details - query the data object details using options in of “returnElements=all”
The following sub-menu items query data object details using the specified options in parameters whose values have been entered in the Settings tab.
- Return Elements = all - “returnElements=all”
- + Latest n Values - “returnElements=all;requestLatestValues=n”
- + Max Data Rows - “returnElements=all;maxReturnNodes=n”
- All of the Above - includes all options mentioned above
- Custom Options In - custom options entered in Settings tab
- Refresh - query the selected node and refresh the node and it’s children
- Refresh All - query the server and refresh the hierarchy
Query tab consists of a free-form editor for WITSML inputs/queries and buttons to execute API functions.
Query
Provides a free-form editor.
Query Context Menu
Right-click within the tab to display a context menu with the following options.
- Cut - copies selected text to the clipboard and deletes it from the screen
- Copy - copies selected text to the clipboard
- Paste - paste the contents of the clipboard to the highlighted section
- Select All - selects the entire content of the tab
- Copy All - copies the entire content of the tab to the clipboard
- Replace - replaces all text in the tab with the contents of the clipboard
- Clear - removes all content from the tab
- Word Wrap - toggles word wrapping on or off
- Pretty Print - toggles XML pretty printing on or off
Query Buttons
Provides a drop-down list of WITSML API functions, a drop-down list of return elements, a drop-down list WITSML data-object templates that are supported by the server, and a button to execute the function using the XML in the editor as input.
- API Function - list of API Functions (e.g. GetFromStore)
- Return Elements - list of return elements
- Execute - performs selected API function
- Templates - list of WITSML Data Object templates for all data objects implemented by the server
Results is a group of tabs that show a WITSML server’s response, a selected data object’s properties, and a selected growing data objects data.
Results
Displays the response output to a WITSML API function request.
Results Context Menu
Right-click within the tab to display a context menu with the following options.
- Cut - copies selected text to the clipboard and deletes it from the screen
- Copy - copies selected text to the clipboard
- Paste - paste the contents of the clipboard to the highlighted section
- Select All - selects the entire content of the tab
- Copy All - copies the entire content of the tab to the clipboard
- Replace - replaces all text in the tab with the contents of the clipboard
- Clear - removes all content from the tab
- Word Wrap - toggles word wrapping on or off
- Pretty Print - toggles XML pretty printing on or off
Properties
Displays a selected data objects elements and value.
Data
Displays the selected growing data object data in tabular format.
WITSML and SOAP Message tabs provide a running log of WITSML and WITSML SOAP-encoded request and response messages. The tabs are provided to assist with diagnosing issues and viewing the content of messages sent and received between the WITSML Browser and a WITSML server.
WITSML Messages
The WITSML Messages tab displays the WITSML request and response messages. The request message lists the API function call that was made, OptionsIn parameters, and XML input. The response message lists the return code, supplemental message, and XML output.
SOAP Messages
The SOAP Messages tab displays the SOAP-encoded WITSML request and response messages.
