Connection is an entity that links a Vendor’s product to a hub with the purpose of deploying this product on the corresponding commerce system and enabling its provisioning and fulfillment functions.
Prerequisites for creating a Connection
In order to be able to create a product connection, the following pre-conditions must be satisfied:
Distributors should have at least one commerce system hub registered via the Hubs module;
Distributors should have a signed distribution contract with a product vendor;
Vendor should have a published Version of a product.
There should be a Listing request for a vendor’s product;
The listing request should be sent to the Distributors for a review .
Creating a Connection
In order to create a new connection in Connect, the following sequence of actions must be followed:
Click on the Top navigation menu.
Navigate to the Inventory module.
Click on the Product name that you want to create a connection for:
Switch to the Connections menu via the left menu panel.
Click the Create Connection button:
Input the required connection parameters as follows:
Environment – can be either Test or Production. This determines what kind of fulfillment requests will be created under this connection;
Choose Hub instance – provides a list of hubs owned by the Distributors. to deploy the product to.
Click Request button to complete the creation process.
Note: You can only create one connection to one hub, either Test or Production. Changing this at a later stage is not possible.
Connection management screen
After at least one connection is created, the following screen becomes available:
The numbered points functions as below:
Create connection button allows the creation of additional connections for the same product.
The Connection ID column shows the Connect IDs of created connections. The ID can be clicked to access the Connection details screen.
The Vendor column shows the account name and ID of the vendor who created and listed the product.
The Environment column shows the environment type (Test or Production) configured during connection creation.
The Hub column shows the name and ID of the hub to which the product is to be deployed.
Connection details screen
Connection details screen can be accessed by clicking on a Connection ID from the Connection management screen and provides the following information:
The Vendor section shows the account ID and name of the Vendor associated with this connection.
The Distributor section shows the account ID and name of the Distributor associated with this connection.
The Product section shows the ID, name, and version of the product associated with this connection.
The Environment section shows the environment type (Test or Production) configured during connection creation and the name and ID of the hub to which the product is to be deployed.
The Individual API credentials section provides the parameters required for product deployment on a commerce system hub. Use the credentials to access the service from your Hub. These credentials will be required on one of the steps of the product installation. The process is described in more details in Connector Frontend Deployment and Update.
The Notes section provides an ability to put down additional details about the connection, which could be seen by all Connect users that are managing the connections for the current Distributor. The field provides basic formatting options and the Save Notes button needs to be pressed to propagate the changes to the system.
Note: Once created, the connection cannot be removed and its properties cannot be modified.