Opcenterx Interop
Visualize and explore your Siemens Opcenter X integration topology directly inside VS Code — see RICs, connectors, topics, and services at a glance, and query live NATS JetStream data without leaving the editor.
Features
- Integration Explorer — interactive graph view of your Opcenter X integration landscape: Remote Interop Connectors (RICs), their connectors, topics, and downstream services.
- Live NATS topic query — click any topic node to query JetStream stream and consumer details in real time.
- Two NATS connection modes — connect via a local leaf node (TCP) or directly to the cloud hub over WebSocket with
.creds-based authentication.
- Secure credential storage — the OAuth2 client secret is stored in VS Code's encrypted Secret Storage and never written to
settings.json.
Getting Started
- Install the extension from the VS Code Marketplace.
- Open the Command Palette (
Ctrl+Shift+P) and run Opcenterx Interop: Open Integration Explorer.
- If prompted, open Settings and fill in the connection details (see Settings below).
- The topology graph will load. Click any topic node to query NATS JetStream details.
Commands
All commands are available via the Command Palette (Ctrl+Shift+P). Type Opcenterx Interop to filter.
| Command |
Description |
| Open Integration Explorer |
Opens the integration topology graph webview. |
| Refresh Integration Explorer |
Reloads topology data from the API. |
| Open Settings |
Opens the Opcenterx Interop settings page directly. |
| Set Client Secret |
Stores the OAuth2 client secret in VS Code's encrypted Secret Storage. |
Settings
Configure these via File → Preferences → Settings and search for Opcenterx Interop, or use the Open Settings command.
API Connection
| Setting |
Default |
Description |
opcenterxInterop.apiEndpoint |
(empty) |
Full URL to the Integration Explorer service /Execute endpoint. |
opcenterxInterop.tokenEndpoint |
(empty) |
OAuth2 client-credentials token URL for your tenant. |
opcenterxInterop.clientId |
(empty) |
OAuth2 client_id for your tenant. |
opcenterxInterop.clientSecret |
(secure) |
OAuth2 client secret — stored in VS Code encrypted Secret Storage. Use the Set Client Secret command to set this value. It is never written to settings.json. |
NATS Connection
| Setting |
Default |
Description |
opcenterxInterop.natsConnectionMode |
leafNode |
How to connect to NATS for topic queries. leafNode connects to a local NATS leaf node over TCP (nats://). direct connects to the cloud NATS hub directly over WebSocket (wss://). |
opcenterxInterop.natsUrl |
nats://localhost:4224 |
NATS leaf node URL. Used when natsConnectionMode is leafNode. |
opcenterxInterop.natsWsUrl |
(empty) |
Base WebSocket URL for direct cloud NATS connection. The extension automatically appends /leafnode. Used when natsConnectionMode is direct. Example: wss://<host>:443/<tenant-path> |
opcenterxInterop.natsCredsFile |
(empty) |
Absolute path to the .creds file for authenticating the direct NATS connection. Used when natsConnectionMode is direct. |
opcenterxInterop.natsJetstreamDomain |
modmom |
JetStream domain name. Used by both connection modes. |
Connection Mode Details
Leaf Node (default)
Suitable for local development or when you have a NATS leaf node running on your machine that connects to the Opcenter X cloud hub.
nats://localhost:4224 ← your local nats-server leaf node → cloud hub
Set natsConnectionMode to leafNode and configure natsUrl to point to your local leaf node.
Direct (cloud WebSocket)
Connects directly to the Opcenter X cloud NATS hub over a secure WebSocket without requiring a local NATS server. Requires a .creds file for authentication.
VS Code extension → wss://<host>/<tenant-path>/leafnode (cloud hub)
Set natsConnectionMode to direct, set natsWsUrl to your tenant's WebSocket base URL, and set natsCredsFile to the absolute path of your .creds file.
Requirements
- VS Code 1.85 or later.
- An accessible Opcenter X environment with the Integration Explorer service running.
- For NATS topic queries: either a local NATS leaf node (leaf node mode) or a
.creds file and direct WebSocket access to the NATS hub (direct mode).