Unify and manage your data

Connect to a Reltio tenant

Learn how to connect the integrated development experience to your Reltio tenant and open your business configuration in the editor.

Prerequisites

Before you connect to your Reltio tenant, make sure you have the following requirements:

  • The integrated development experience installed in Cursor or VS Code.

  • A folder open in your editor. The integrated development experience uses the folder as your local workspace for downloading and managing business configurations.

  • 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 connect to your Reltio tenant
  1. Select the Reltio icon in the activity bar or the integrated development experience from the extensions to open the RELTIO IDE view.
  2. Select Connect your Reltio Tenant to start setup.
  3. Select Add Environment, and then enter your environment ID (for example, test-usg.reltio.com).
    Figure 1. Add environment in the integrated development experience
  4. Authenticate using one of the following methods and the credentials that you copied in the prerequisites.
    Figure 2. Reltio environment setup sign-in method
    • Select Sign in with browser (recommended). Enter your Client ID and Client secret, and then enter your SSO routing tenant ID when prompted. The integrated development experience opens your browser to complete single sign-on. Your editor stores these credentials in your operating system's secure credential store.

    • Select Paste a Bearer token, and then paste the token you kept ready and press Enter. The integrated development experience keeps the token in memory for the current session only.

  5. After authentication, select your tenant from the tenant list.
  6. After you select the tenant, open and edit its local business configuration.
To open and navigate your configuration
  1. In the RELTIO IDE view, select your tenant.
  2. Select the Open L3 icon beside the tenant ID to open your configuration file in the editor.
    Figure 3. Connected tenant in RELTIO IDE
    The configuration file is Business Config/BusinessConfig.json in the folder of the tenant, for example dev/TenantDev123.
  3. Expand your tenant to browse its configuration.
  4. 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

    To keep the configuration of the tenant in a Git repository, connect the tenant to Git.

Result

The integrated development experience connects to your Reltio tenant, and your configuration file opens in the editor. Your Reltio tenant appears in the RELTIO IDE view. Expand it to browse its configuration. You are ready to add or modify configuration objects.

Validation

To confirm that the connection was successful:

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