Configure a Custom Universal Connector

This topic describes how to configure a custom universal connector in PVWA.


For connectors downloaded from the CyberArk Marketplace, see Deploy PSM Connectors.

If you run the Import connection component Rest API to upload the package, you only need to run Add the Connection Component to a platform.

  1. Log onto the PVWA as an administrative user.
  2. Create the connector in PVWA

    1. In the System Configuration page, click Options; the Web Access Options are displayed.

    2. Expand Connection Components; the defined connection components are displayed in the properties list.

    3. For shared universal connector deployment on all PSM servers, right-click and copy the PSM-VNCClientSample-AutoDeployed option.

      For a single universal connector deployment on a PSM server, right-click and copy the PSM-VNCClientSample option.

    4. Right-click ConnectionComponents, then from the pop-up menu select Paste Connection Component; a copy of the connection component is added to the list of configured connection components with its original ID (PSM-VNCClientSample).

    5. Configure the new connection component

      • In the list of properties, specify a new ID that reflects the purpose of the connection. This ID will be displayed in the drop-down list of available connections in the Accounts Details page and must be self-explanatory.

      • Expand the connection component, then select Target Settings; the Target Settings properties are displayed.

      • In the ClientDispatcher property, replace PSMRealVNCDispatcher.exe with the name of the .exe file that you compiled previously.


        For a shared universal connector deployment on PSM servers, the file is placed in PSM/Component/Connectors folder.

        For universal connector deployment on a dedicated PSM server, make sure that this file is located in PSM/Components folder.

      • Under Target Settings, select Lock Application Window; the Lock Application Window properties are displayed.

      • In the MainWindowTitle and MainWindowClass properties, set the title and class name provided by the developer in Step 5 above.


        These properties can remain empty if they are not applicable. In this case, PSM will lock the first window created by the application.

      • If your universal connector requires user input during login, you can remove the block that PSM enforces, which blocks any user interaction that may interfere with the login procedure by default. Under Target Settings, right-click Client Specific, then in the pop-up menu select Add Parameter.

        A new parameter is added to the list of client specific parameters.

        In the parameter properties, specify the following:

        Parameter Description

        The name of the client specific parameter. Specify BlockUserInput.


        Specify any of the following values:

        Yes. Block user input is enabled. This is the default value.

        No. Block user input is disabled

    6. Click OK to save the new Connection Component configurations and return to the System Configuration page.

  3. Add the Connection Component to a platform

    1. In Administration > Platform Management, select the platform to configure for the connector, and click Edit. The settings page for the selected platform appears.

    2. Under UI & Workflows, right-click Connection Components and select Add Connection Component. A connector is added to the current list of connectors that are configured for this platform.

      In the new connector, specify the following properties:

      Parameter Description


      The unique ID that identifies your connector


      Indicates whether or not the connector will be enabled for this platform. Specify Yes.

    3. Save the configuration:

      • Click Apply to save the new values and stay in the platform settings page.

      • Click OK to save the new values and return to the System Configuration page.

      The changes are applied after the period of time specified in your PSM's ConfigurationRefreshInterval parameter.