Connecting a Software Item with a Connector

You can create a connection between a software item and a data repository to view and download the data.


Before you begin:
  • You must have created a connector.
  • You must have created a software item.
See Also
Creating a Software Item
In Other Guides
About Connectors
Undefined Repository Version Type
  1. View the properties of the software item by opening a software item version and selecting

    .
    You see the detailed information tabs for the software item version.
  2. Select the Connection tab and click Edit.

    This allows you to enter information for the connection.
  3. Enter the details for the connector.

    Field Name Description
    Connector List of defined Connectors.
    Repository Root Path This displays the path or SyncURL to the data respository.
    Repository The Connected Software repository path or name. This value, when concatenated to Repository Root Path identifies the full path to the external data source. You can:
    • select the repository from the list of repositories registered for the connector of the software item.
    • enter a string to filter the available choices in the list to the repositories that contain the string.
    • or enter the entire path to the data repository.
    Repository Version The specific version of data managed within your repository. This can be a branch name, tag, commit ID, or module version ID. The usual default values are: main for Git repositories or Trunk for DesignSync repositories. Both of these indicate a dynamic identifier, meaning that the data contents of the version referenced may change as the identifier moves. You can:
    • select the version from a list of available branches and tagged versions in your repository. The list is displayed in alphabetical order with branches first, followed by tags.
    • enter a string to filter the available choices in the list to the tags or branches that contain that string.
    • or enter the entire version identifier.

    If you are specifying a DesignSync branch, use the form <branch>:, or <branch>:Latest, unless the branch is the default Trunk, in which case, it does not need a trailing colon. DesignSync branch names are displayed as branch:Latest.

    Notes:
    • For some maturity states, the version address must refer to a static version, one that cannot change. If the software item moves into one of those states, the static version is automatically captured and associated with the object.
    • Connected Software does not support use the use of the slash character (/) in branch or tag names.
    Create new branch from: VersionAddress If this option is enabled, create a new branch with the name specified by Repository Version. The new branch uses the previous repository version as the branch point.

    If the specified branch name already exists, the software item is updated to the new address with a message explaining that the branch already exists.

    If you do not have permission to create a branch, or the new branch name is invalid (containing invalid characters, for example) the update fails, with an appropriate error message.

  4. Press OK to save.
    Create the connection between the repository and the software item.

The software item is connected to a repository and the data is available through the software item.