PDS WITSML Studio Desktop Guideline - 7888154 - 01

PDS WITSML Studio Desktop Guideline (WITSML Browser)

Procedure Revision History
Date Document Author Co-Author

Version
17-Sept-2022 1.0 Nurliyana Azlin Anim Mohammed
Mohamad Khairil Ikram
Select the e-mail link below, to suggest improvements to this procedure.

[email protected]
Table of Contents
1. Introduction ……………………………………………………….…………………………. 1
2. Guidelines ………… ……………………………………………………………………….... 2
Introduction
PDS WITSML Studio Desktop is a Windows desktop application that can be used for querying, testing
and evaluating Energistics standards such as WITSML and ETP. This application supports WITSML
1.3.1.1, 1.4.1.1 and 2.00 versions. This user guide contains descriptions and instructions for all
functionality provided by PDS WITSML Studio Desktop.
2. Guidelines
i. The application can be download and installed from

https://witsml.pds.technology/studio/
Figure 1: Logo Image
The following pre-requisites are required:

• Microsoft .NET Framework 4.5.2 (x86 and x64)
1
ii. Launch the application

iii. PDS WITSML Studio Desktop provides the following menu items:
• File>Open>Data Directory: Opens a folder containing the PDS WITSML Studio

Desktop data files
• File>Open>Working Directory: Open a folder containing the PDS WITSML Studio
Desktop application files
• Files>Open>Output Directory: Opens a folder containing the output files of results
saved to disk
• File>Exit: Close the application
• Help>Online Help: Opens the online User Guide in a browser
• Help>About: Opens an About PDS WITSML Studio Desktop dialog with tabs
containing application and license information
iv. WITSML Browser is an application plug-in for PDS WITSML Studio 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.
1) Request Tabs
• 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.
2) Response Tabs
• 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
2
• 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 – Display raw SOAP-encoded WITSML request and response
messages
Connections enable setting up and establishing a connection to a WITSML server. It also enables
querying a server’s supported version.
A) Connect to an Existing Connection
• Click “Select Connection…”

• Select existing connection
3
B) Connect to a New Connection

• Select ‘(Add New Connection”)
• Enter the following
- Name : a unique name for this connection
- URL : Web address of the WITSML server
- Username: Name of user
- Password: Password of user
- Optional to tick “Pre-Authenticate” to send the Authorization header
with every web request
• Click “Test” to test the connection
• Click “OK” to save and connect
C) Add Proxy Authentication
• Click “Proxy” to add a proxy to use for the connection

• Enter the following
• Host - the hostname or IP address of the proxy server
• Port - the port number used by the proxy server for client connections
4
D) Select Security Protocols
• Click “Security” to select security protocols

• Select from the following
• TLS 1.2 - Transport Layer Security protocol defined in RFC 5246 in August 2008
• TLS 1.1 - Transport Layer Security protocol defined in RFC 4346 in April 2006
• TLS 1.0 - Transport Layer Security protocol defined in RFC 2246 in January 1999
• SSL 3.0 - Secure Sockets Layer protocol
• Optionally check “Accept Invalid Certificates” to accept all server certificates regardless of
validity
E) Edit a Connection

• Click “edit” for the connection you would like to edit.
• Update the connection
F) Delete a Connection

• Click “delete” for the connection you would like to delete.
• Click “OK” when prompted “Are you sure you want to delete the connection?”
5
G) Select a Version
After connecting to a WITSML server, all supported versions will be listed with the most
current version selected by default. To select another version, follows these steps.
• Click Version drop-down

• Select a version
H) 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.
1) 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”
• Refresh - query the selected node and refresh the node and its children
• Refresh All - query the server and refresh the hierarchy
6
I) Query : Query tab consists of a free-form editor for WITSML inputs/queries and buttons to
execute API functions.
1) 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
7
2) 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
J) Results: Displays the response output to a WITSML API function request.
8
1) 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
K) Properties: Displays a selected data objects elements and value
9
L) Data: Displays the selected growing data object data in tabular format
M) WITSML and SOAP Messages tabs : Provide a running log of WITSML and WITSML SOAP-
encoded request and response messages. The tabs are provided to assist with diagnosis
issues and viewing the context of messages sent and received between WITSML Browser
and a WITSML server
i) 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.
10
ii) SOAP Messages : Displays the SOAP-encoded WITSML request and response messages
11

PDS WITSML Studio Desktop Guideline - 7888154 - 01

Uploaded by

Copyright:

Available Formats

PDS WITSML Studio Desktop Guideline - 7888154 - 01

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

PDS WITSML Studio Desktop Guideline - 7888154 - 01

Uploaded by

Copyright:

Available Formats

PDS WITSML Studio Desktop Guideline (WITSML Browser)

PDS WITSML Studio Desktop Guideline (WITSML Browser)

Date Document Author Co-Author

Select the e-mail link below, to suggest improvements to this procedure.

i. The application can be download and installed from

Figure 1: Logo Image

The following pre-requisites are required:

ii. Launch the application

• File>Open>Data Directory: Opens a folder containing the PDS WITSML Studio

A) Connect to an Existing Connection

• Click “Select Connection…”

B) Connect to a New Connection

• Click “Select Connection…”

C) Add Proxy Authentication

• Click “Proxy” to add a proxy to use for the connection

D) Select Security Protocols

• Click “Security” to select security protocols

• Click “Select Connection…”

• Click “Select Connection…”

• Click Version drop-down

1) Hierarchy Context Menu

• Get IDs - query the selected data object IDs

1) Query Context Menu

• API Function - list of API Functions (e.g. GetFromStore)

J) Results: Displays the response output to a WITSML API function request.

K) Properties: Displays a selected data objects elements and value

You might also like