Install Reltio IDE on VS Code and connect to your tenant

Learn how to install the Reltio IDE extension in VS Code, connect to your Reltio tenant, and open your configuration.

Prerequisites

Before you install Reltio IDE, make sure you have the following requirements:

The Reltio IDE .vsix file, downloaded from Releases > Assets of the Reltio GitHub repository.
A Reltio tenant and valid credentials, copied and ready to paste: An OAuth Client ID and Client secret (with your SSO routing tenant ID) from your identity provider, or a bearer token from the Reltio authentication API or your tenant administrator.

To install Reltio IDE in VS Code using the Extensions view

Open VS Code.
Select the Extensions icon in the activity bar to open the Extensions view.
Select the ... (More Actions) menu at the top of the Extensions view, then select Install from VSIX....
Browse to the location where you downloaded the .vsix file. Select the .vsix file and click Install.
Open the Extensions view and confirm that Reltio IDE appears in the list of installed extensions.

To install Reltio IDE in VS Code using the Command Palette

Open VS Code.
Press Cmd+Shift+P on macOS, or Ctrl+Shift+P on Windows and Linux to open the Command Palette.
Type Install from VSIX, then select Extensions: Install from VSIX....
Browse to the location where you downloaded the .vsix file. Select the .vsix file and click Install.
Open the Extensions view and confirm that Reltio IDE appears in the list of installed extensions.

To connect to your tenant

Select Reltio in the activity bar or Reltio IDE from the extensions to open the RELTIO IDE view.
Select Connect your Reltio Tenant to start setup.
Select Add Environment, then enter your environment ID (for example, test-usg.reltio.com).
Authenticate using one of the following methods, using the credentials you copied in the prerequisites.
- • Select Sign in with browser (recommended). Enter your Client ID and Client secret, then enter your SSO routing tenant ID when prompted. Reltio IDE opens your browser to complete single sign-on. VS Code stores these credentials in your operating system's secure credential store.
- • Select Paste a Bearer token, then paste your token and press Enter. Reltio IDE keeps the token in memory for the current session only.
After authentication, select your tenant from the tenant list.

To open and navigate your configuration

In the RELTIO IDE view, select your tenant.
Select the Open L3 icon beside the tenant ID to open your configuration file in the editor.
Expand your tenant to browse its configuration.
Use the context menu at the tenant level and on objects in the tree view to perform modeling actions, such as:
- • Adding a new entity type or relationship type
- • Adding a new attribute
- • Viewing the ontology
- • Applying your configuration changes to the tenant

Result

Reltio IDE connects to your tenant, and your configuration file opens in the editor. Your tenant appears in the RELTIO IDE view, and you can expand it to browse its configuration. You are ready to add or modify configuration objects.

Validation

To confirm the connection was successful:

Confirm that your tenant appears in the RELTIO IDE view with no authentication errors.
Select the Open L3 icon beside the tenant ID and confirm that your configuration opens in the editor.
Expand your tenant and confirm that its configuration appears.

Unify and manage your data

Install Reltio IDE on VS Code and connect to your tenant

Footer