Introduction to the SDK

This section explains what a Connector does for Connected Software.

The 3DEXPERIENCE Platform system provides for the modeling of data management components within the 3DEXPERIENCE Platform as part of a complete definition of an engineering product.

Each engineering item can be associated with data (files) being managed in some file storage system. Typically, this system is some kind of Source Code Management (SCM) or Revision Control (RC) system.

The interface between the engineering item in the platform and the data in the file storage system is managed through the connector. The connector is a server that implements a set of standard REST services, common to all types of data storage system supported. This creates a system where the tools that operate on the software item can work in the same way with all similar object types, without having to consider what specific target file storage system is in use on the backend.

Included with the applications that support connections to an SCM are connectors for suported external code management systems . This SDK provides the ability for in-house developers to create their own custom connectors to support additional SCM systems.

This section explains the requirements to fully integrate a custom connector.

Defining the Connector

The implementation of the REST services required of a Connector.

Configuring the Connector

Supplying information for the Repository such as a a server name, and path name and any individual connector properties.When creating a custom connector, the custom connector developer must create a configuration page that links into the Connector Configuration web page.

Integrating the new Connector Type into the 3DEXPERIENCE Platform

The custom connector is available to the user exactly as a standard, included connector, is available to the user. When creating a connector, the creator selects the name of the custom repository as the Connector Type.