Create a Connection
  • 29 Mar 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Create a Connection

  • Dark
    Light

Article Summary

A connection provides the connection properties or string required to connect to the related system for specific usages. You must be an administrator to add or edit connections.

To create a connection:

  1. Verify you’re in the Catalog module of the Syniti Knowledge Platform.
    Or
    Select Catalog from the Home menu to navigate to the Catalog module of the Syniti Knowledge Platform.

  2. Create a system.
    Or
    Search for an existing system.

  3. Click the Connections tab.

  4. Click Create connection.

Note

Syniti recommends creating a connection by using the connection forms. If you need to use connection properties that are not on the form, provide a connection string. Refer to Connection String Formats for more information.

For details about a specific field, hover over the Help icon.

For more information about creating connections, click the Page help icon on the Site menu.

Test a Connection

Testing the connection verifies each selected usage with a test specific to each usage.

To test a connection:

  1. Verify you’re in the Catalog module of the Syniti Knowledge Platform.
    Or
    Select Catalog from the Home menu to navigate to the Catalog module of the Syniti Knowledge Platform.

  2. Search for an existing system.

  3. Click the Connections tab.

  4. Click the down caret to view details about the connection.

  5. Click Test connection.

For details about a specific field, hover over the Help icon.

For more information about testing connections, click the Page help icon on the Site menu.

Delete a Connection

Delete a connection with great caution. A connection could be used across many scheduled jobs within the system. Be sure to check with your team to ensure there aren’t any jobs or tasks that rely on the connection that are in progress.

To delete a connection:

  1. Verify you’re in the Catalog module of the Syniti Knowledge Platform.
    Or
    Select Catalog from the Home menu to navigate to the Catalog module of the Syniti Knowledge Platform.

  2. Search for an existing system.

  3. Click the Connections tab.

  4. Click the Name link to open the connection detail page.

  5. Click the More actions ellipsis.

  6. Select Delete.

For details about a specific field, hover over the Help icon.

For more information about deleting connections, click the Page help icon on the Site menu.


Was this article helpful?