- Home
- WITSMLstudio
- WITSMLstudio Portal
- ETP Browser Core Functionalities
Documentation
Connections enable setting up and establishing a connection to an ETP server.
Connect to an Existing Connection
- Click “Select Connection…”
- Select existing connection
Add a Connection using Basic Authentication
- Click “Select Connection…”
- Select “(Add New Connection)”
- Enter the following
- Name - a unique name for this connection
- URL - web address of the WITSML server
- User Name - name of user
- Password - password of user
- Optionally check “Pre-Authenticate” to send the Authorization header with every web request
- Click “Test” to test the connection
- Click “OK” to save and connect
Add a Connection using JSON Web Token (JWT)
- Click “Select Connection…”
- Select “(Add New Connection)”
- Click “Bearer”
- Enter the following
- Name - a unique name for this connection
- URL - web address of the WITSML server
- Optionally click on […] button next to the Bearer authentication option to retrieve a JSON Web Token from a Token Provider Service
- Optionally check “Pre-Authenticate” to send the Authorization header with every web request
- Enter token in JWT box
- Click “Test” to test the connection
- Click “OK” to save and connect
Retrieve a JSON Web Token (JWT) from a Token Provider Service
- Click on […] button next to the Bearer authentication option
- Enter the following
- Name - a unique name for this connection
- URL - web address of the WITSML server
- User Name - name of user
- Password - password of user
- Optionally check “Pre-Authenticate” to send the Authorization header with every web request
- Click “Test” to test the connection
- Click “OK” to save and connect
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
- User Name - name of user
- Password - password of user
- Optionally check “Use Default Credentials” to use the current windows proxy user credentials
- Click “Test” to test the connection
- Click “OK” to save and connect
Select Security Protocols
- Click “Security” to select security protocols
- Select from the following
- TLS 1.2 - the Transport Layer Security protocol defined in RFC 5246 in August 2008
- TLS 1.1 - the Transport Layer Security protocol defined in RFC 4346 in April 2006
- TLS 1.0 - the Transport Layer Security protocol defined in RFC 2246 in January 1999
- SSL 3.0 - the Secure Sockets Layer protocol
- Optionally check “Accept Invalid Certificates” to accept all server certificates regardless of validity
- Click “Test” to test the connection
- Click “OK” to save and connect
Specify WebSocket Sub-Protocol
- Click “WebSocket” to specify the WebSocket sub-protocol
- Enter the following
- Sub-Protocol - the ETP WebSocket sub-protocol; Default is “energistics-tp”
- Encoding - the Encoding type for ETP messages; Default is “binary”
- Click “Test” to test the connection
- Click “OK” to save and connect
Edit a Connection
- Click “Select Connection…”
- Click “edit”
- Update the connection
- Click “Test” to test the connection
- Click “OK” to save and connect
Delete a Connection
- Click “Select Connection…”
- Click “delete”
- Click “OK” when prompted “Are you sure you want to delete the connection?”
ETP Browser connects to the selected ETP server and sends a Request Session message with the configured settings. The connection remains open until disconnected or closed intentionally.
Request Session
By clicking “Request Session”, ETP Browser requests a WebSocket upgrade from the ETP server and will display the response in the Results tab.
Close Session
By clicking “Close Session”, ETP Browser terminates the current connection and any resources associated with it.
ETP Browser can request the selected server’s capabilities via a standard HTTP request based on a well-known URL format. The result of the request will be displayed in the Results tab.
