Creating a Client Connection Bundle

As a publisher, you can create client bundles to add subscribers to your publisher instance.  You can only create connection bundles for subscribers - a publisher cannot connect to another publisher instance.        

Once a connection bundle has been created, you can send the bundle to the subscriber instance to connect - see the Connecting to a Publisher for more details on how a subscriber uploads the connection bundle. 

The steps for creating your initial connection bundle when you setup your publisher instance and adding additional connections to functioning instance differ slightly.  

Creating an Initial Client Bundle

Creating your first connection bundle can be performed from the Data Exchange initial landing page.  This page will automatically load upon selecting the OpenDXL Set Up Server option.  

1. Click on the Data Exchange menu option and select the OpenDXL Set Up Server option.
   
   The Data Exchange setup landing page will load. 
   
   
2. Click on the Setup Data Exchange button.
3. Enter the name that will be used to identify your instance in the TQX node view. 

   This name will appear as your instance for the subscriber.

   
4. Click on Next.
5. Enter the name for the Data Transport. 

   This will be the local name you will see when managing your data transport.  You can also leave the default value: OpenDXL Broker.

   
6. Click on Next.
7. Enter a Client Name for the subscriber. 

   This name will be used to identify the subscriber in the TQX node view.

   
8. Click on the Create Credentials button.
9. Repeat steps 7 and 8 to create additional bundles.
10. Download the connection bundles that you have created using the links provided.
    
    
11. Click on Finish Setup when you have finished creating your bundles and transfer the downloaded connection bundles to the subscriber instances.   
     

    In the event that you clicked on Finished Setup before downloading the bundle(s), you can download the connection bundles from the node view by clicking on the transport node.  Connection bundles will be located under the Credential Management heading.  

    The node view will load with nodes for your instance and broker displayed.  Once the subscriber has uploaded the connection bundle, created in steps 7-10, that node will also appear in the node view.   
    
     

Creating Additional Client Bundles

Once you have created a client bundle, the getting started wizard is no longer available.  You can create additional bundles from the Connections node view.  

1. Click on the Data Exchange navigation option and select Connections.  
   
   The OpenDXL Connections node view will load. 
   
   
2. Click on the blue transport node to load its details in the right pane.
   
   
3. Click on the Create Credentials button located under the Credential Management heading.
   
   The New Client window will open.
   
   
4. Enter the new Subscriber’s name in the Client Name field.

   This name will be used to identify the subscriber in your node view.

5. Optional - The Hostname field displays the name of your current TQX instance, however you have the option to update this name.
6. Click the Create Credentials button.
   
   The new subscriber will be displayed in the Credential Management section.
   
   
7. Click on the Connection Bundle link next to the new connection to download the connection bundle.  Send this file to the Subscriber to upload via their TQX instance.