Adding a New Connector

You can create a new connector object that connects to the external SCM system. This connector object provides the connection information for the connector.

Before you begin: You must have installed the connector software on a host with a TomEE+ installation. If you specify a connector that has been installed, but not yet been configured, this procedure configures the connector with the information derived from the 3DEXPERIENCE platform.

For more information on installing the connector, see .Installation

See Also
Connector and 3DSearch URLs Contain Mismatching Domains
In Other Guides
Changing Maturity
  1. Launch the 3DEXPERIENCE platform app and select Manage Connectors.
    Opens the Connectors page. From this page, you can manage your connectors.
  2. Select . If the app is fully maximized to take over the entire 3DEXPERIENCE Dashboard, you can select on the Add menu to create a new connector. The Repository object is an administrative object in the 3DEXPERIENCE database. Not every user can create administrative objects. Typically, the user must use credentials that have an Owner responsibility assigned in order to create an administrative object. Credentials that Connected Software uses are set in the Preferences form for the widget. More details on the Preferences form and setting credentials can be found in the Customizing Preferences topic in your app User's Guide.
    This launches the connector creation form.
  3. Fill out the required information and select Ok.

    Title
    .
    Identifier for the connector (Required). This is a user-friendly name that allows the user to identify the connector. The name accepts any characters valid for business objects.
    Connector URL
    The URL to the connector applet on the TomEE+ server, including communication protocol and port number (Required). The URL can be copied from the Connector Configuration page by clicking Detect Connector URL and copying the URL value into this field. An example of the connector address is: https://host:port /3DSCM
    Type
    Select the appropriate type from the list. (Required) By default, the supported repositories are Git and DesignSync. Additional types may be defined for your system.
    • Git - Indicates that the connector provides access to external GIT repositories. For more information on registering the external Git repositories, see Git Connector Configuration: Add/Edit Repository.
    • DesignSync - Indicates that the connector provides access to external DesignSync repositories. The SyncServer hosting the modules referenced by the DesignSync repository does not need to be running. For more information on registering the external DesignSync repositories, see DesignSync Connector Configuration: Add/Edit Server.
    Repository Path
    Prefix of the path to the registered repositories in the Git or DesignSync Connector. (Required) The Repository Path value, concatenated with the Repository Vield value defined when specifying a Software Item's connection information to the Git or DesignSync repository, is the full path to the external repository. You can select the appropriate Repository Path value from:
    • a list of prefix path values derived from the registered external repositories in the connector,
    • by entering a portion of the Repository path to filter available choices, or
    • by entering the entire Repository path.
    Git Repositories

    The Repository path value of the connector object is a local file system path to the parent directory containing the Git repository. This value, concatenated with the Repository field set in the connection information for the Software Item, is the full path to the Git repository. An example of the Repository Path is:

    /home/user/GitRepositories
    DesignSync Repositories
    The repository path is the SyncURL to the category containing the module or modules for Software Items. This value, concatenated with the Repository field set in the connection information for the software item, is the full path to the DesignSync module. An example of the Repository Path is: 
    sync://serv1.ABCo.com:30126/Modules/ChipDesigns
    Description
    A text description of the connector (Optional).

    Creates the connector and verifies the connector settings. If the connector was not already configured, this operation automatically configures it and validates the settings. If the connector cannot be created or configured, the app displays an appropriate error message.
  4. Open the information sidebar

    to verify the connection status. If the connection is working, the status displays as "Running."
    Verify connection status.

You can now connect software items to data in the external Git or DesignSync connectors using the SCM connector object.

Note: New connector definitions start in the Private maturity state. Promote the connector objects to make them available to other users.

Click the hyperlink of the connected URL to launch a new window to the Connector Configuration page, where you can configure the connector, Register Git Repositories or Register DesignSync Repositories.