Documentation Index

Fetch the complete documentation index at: https://skthelp.syniti.com/llms.txt

Use this file to discover all available pages before exploring further.

Register an SKP Connector

Prev Next

An SKP connector is the Syniti component that allows the Syniti Knowledge Platform to communicate with systems in your landscape. A single SKP connector can support metadata scanning, profiling and Cloud DQ functionality. One SKP connector can be connected to multiple systems. One system can be related to multiple SKP connectors (e.g., two separate SKP connectors: one for executing Cloud DQ and one for executing Cloud DM).

Note

As of [date], SKP Connector registration has been updated and is no longer based on Wireguard. SKP Connectors registered before this enhancement can be found and managed under the Legacy tab. New SKP Connectors should be registered under the Standard tab as described in the steps below.

Register an SKP Connector

To register a Standard Syniti Knowledge Platform connector:

  1. Download the latest version of the SKP connector. Refer to the Knowledge Platform Connector: Security, Installation, Requirements & Troubleshooting  article for details on how to install and configure the SKP connector.

  2. Log in to the Syniti Knowledge Platform

  3. Verify you’re in the Admin module of the Syniti Knowledge Platform.
    Or
    Select Admin from the Profile menu to navigate to the Admin module of the Syniti Knowledge Platform.

  4. Under Connectivity, click SKP Connectors in the Admin menu.

  5. Click the Standard tab.

  6. Click the Register SKP connector button.

  7. Enter a Name.

  8. Optionally, enter a Description.

  9. Click the Save button. The new SKP connector is created.

  10. Click Copy secret key in the SKP Connector Created dialog that displays.

    Important!

    It is essential to store the secret key in a secure location. This key cannot be regenerated after the dialog box is closed.

    Note

    The secret key is needed during the installation process. Refer to SKP Connector Requirements and Installation for more details.

  11. Click the X to close the dialog box. The connector is saved, and the SKP Connector Details page displays.

Rotate the Key

The secret key can be rotated any time the key needs to be refreshed. This does not cause disruption in service.

To rotate the secret key:

  1. From the SKP Connector Details page, click the More Actions icon.

  2. Select Rotate Key menu item.

  3. Click Confirm on the SKP Connecter Rotate Key dialog box. The key is rotated.

  4. Click Copy secret key in the SKP Connector Key Rotated dialog that displays.

    Note

    Key rotation does not cause interruption in service. The key must be added to the service, which must be restarted before the new key will be used.

  5. The rotated key must be used in the server to apply the rotation. Refer to SKP Connector Requirements and Installation for more details.

Important!

After [date], all new connectors should be registered under the Standard tab.

To register a Legacy Syniti Knowledge Platform connector:

  1. Download the latest version of the SKP connector. Refer to the Knowledge Platform Connector: Security, Installation, Requirements & Troubleshooting knowledge base article for details on how to install and configure the SKP connector.

  2. Log into the Syniti Knowledge Platform

  3. Verify you’re in the Admin module of the Syniti Knowledge Platform.
    Or
    Select Admin from the Profile menu to navigate to the Admin module of the Syniti Knowledge Platform.

  4. Under Connectivity, click SKP Connectors in the Admin menu.

  5. On the Legacy tab, click the Register SKP connector button.

  6. Enter a Name.

  7. Enter the Public Key that was generated by the install process.

  8. Click the Save button.

  9. Click the Test connection button for the SKP Connector. The SKP connector polls the connection every minute so if the initial test fails, wait 1 minute and try again. If the connection continues to fail, refer to the Knowledge Platform Connector: Security, Installation, Requirements & Troubleshooting knowledge base article for next steps.

Update Legacy Connections to the Standard SKP Connectors

As Standard SKP Connectors are registered, connections tied to Legacy SKP Connectors must be updated to be associated with the new Standard SKP Connectors. To update connections:

  1. Under Connectivity, select Connections.

  2. Identify legacy connections by locating connections with legacy denoted in the SKP Connectors column.

  3. Click the Edit icon on the legacy connection.

  4. Select the new standard connector from the SKP Connectors field.

    Note

    When only updating the SKP Connector field, it is not necessary to update connection credentials if credentials have not changed. Leave the Edit Properties toggle to the Off position to only update the SKP Connector and/or Usage. If connection credentials need to be updated, turn the Edit Properties toggle to the On position.

  5. Click Save.

For detailed installation requirements and troubleshooting, refer to SKP Connector Requirements and Installation.

Delete a Legacy SKP Connector

To delete a legacy SKP Connector:

  1. Under Connectivity, select SKP Connectors.

  2. Click the Delete icon in the Actions icon of the SKP Connector to be deleted.

  3. Click Delete on the Delete SKP Connector confirmation window.

Edit an SKP Connector

To edit any SKP Connector:

  1. Under Connectivity, select Connections.

  2. Identify legacy connections by locating connections with legacy denoted in the SKP Connectors column.

  3. Click the Edit icon on the legacy connection.

  4. Optionally, toggle the Edit Properties toggle to the On position to update connection credentials. To only update the Usage and/or SKP Connectors without updating connection credentials, leave the Edit Properties toggle in the Off position.

  5. Make necessary changes to the SKP Connectors or Usage field.

  6. If the Edit Properties toggle is turned on, update any additional properties or the following connection credentials:

    1. Hostname—Server hosting the database

    2. Username—User ID for the database access

    3. Password—Associated password

  7. Click Save.