--- title: "Connections" slug: "connections" updated: 2024-10-07T17:07:10Z published: 2024-10-07T17:07:10Z canonical: "help.csgi.com/connections" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.csgi.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Connections In order to be able to see a particular project or create connections in a project, you need to be a project owner. Contact your organization owner to change your project role. Xponent has connections that define the base level of connectivity (supported connection types include database, message queue, web service etc). Connections are used to communicate with external systems. An [adaptor](/v1/docs/adaptors) uses a connection to do a particular operation. > **For Example**: A single connection may have many adaptors. > > - Database Read, Write, Delete, and Listener etc. > - Message Queue Read, Write, and Listener etc. For all connectors using AWS keys requiring rotation, this process must occur at the predetermined frequency. From now onwards updating connection and credential details in the Hub will automatically propagate the changes to all deployed graphs using that connector. There's no need to stop and redeploy graphs; the application detects all affected graphs and applies the changes accordingly. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-09-30_16-26-05(2).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) ## Creating a New Connection To create a connection in a project, navigate to the project admin page, choose Projects from the left-hand side menu, and then choose the desired project from the list. Depending on your role, you may see many projects in this list. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-03_16-36-34.png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-03_16-46-22.png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) 1. Go to **Project Settings** and select the **Connections** tab. 2. Click the **Create Connection** button. The **Create Connection** window is displayed. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-04_16-21-15.png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) 3. Choose the required connection **Type** from the dropdown menu. 4. Create the **Connection Name** in the pop-up window. Provide a functional name rather than a development stage name > **For Example**: > CustomerDB rather than DevelopmentDB. It makes easier to propagate the connection through multiple environments. Depending on the connection type, you will see different parameters to complete before the connection is ready: ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-04_16-28-12(1).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) Once the connection is configured with new information, the **Save Edits** button will appear. To enable the **Test Connection**, it is mandatory to save the changes. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-04_16-34-51(1).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) Once the modified configuration is saved, the button changes to **No** **Unsaved Changes** and the **Test Connection** buttons gets appears. ### Testing a Connection ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-04_16-34-51%20copy(1).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D)Once the connection details have been saved, the Test Connection button appears below the connection details. - Click the **Test Connection** button to test the connection. It will confirm whether we can reach the service or not. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-04_16-45-44.png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) After successfully testing the connection, the button name changes to **Connection Verified**. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-04_17-19-11%20copy.png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) ### Publishing a Connection Once you have successfully tested the connection, the **Publish Connection** button will be enabled. Publishing connections will propagate the updated connection details to all deployed graphs using that connection without the need to stop and restart the graphs. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-04_17-19-11(1).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) The **Publish** button will initially appear greyed out. It will be activated and turn green only after meeting the following criteria: - The connection must be used in a deployed graph. - The connection must have had edits made to it since the graph was deployed. - The connection has been tested and passed. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-04_17-19-11%20copy%20(1).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) - Click the **Publish Connection** button to publish the configured connection. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-07_17-50-24(1).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) A pop-up will display the total number of deployed graphs that will be impacted. Before publishing, it will inform you that the engine will temporarily stop the graphs while acquiring the new connection details, after which the graphs will be automatically restarted. The number displayed in the pop-up will change based on the impacted deployed graphs - Click **Yes** to publish the connection credentials. Afterward, all deployed graphs will immediately start using the new connection credentials. - Click **Cancel** if you are not sure or ready to make this change. Cancelling means that the connection details will not be published; however, the connection details that you updated in the Hub will be saved in the Hub, and you'll see a status of **Unpublished Edits**. The feature will not be enabled **for old graphs** that have already been deployed. To enable this feature, **restarting the graphs is mandatory**. Encountering issues while publishing connection details is common, often due to factors like invalid credentials or network problems. The initial troubleshooting step involves attempting the process again and carefully verifying the connection details. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-07_17-57-50(1).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) Now all connection statuses can be identified using the following indicators: - **Published**: Indicates that the connection is published to the engine, and all impacted deployed graphs are using the current connection and credentials details. - **Unpublished Edits**: Indicates connection details have been changed and saved to the hub but not yet published to the engine. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-07_17-49-00(1).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) --- ## Expand or Collapse the Connection The selection of the **Expand** icon will expand the list of the same type of connections. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-07_17-49-00(2).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) Selection of the **Collapse** icon will collapse the list of the same type of connections. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-07_17-49-00%20copy(1).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) ## Deleting a Connection The selection of the **Delete** icon will delete the related connection. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-07_17-49-00%20copy%20(1).png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) ## Changing a Connection Name Selection of the required connection allows you to modify the name. - Click **Save Edits** to save the modified name. ![](https://cdn.document360.io/c578bb14-e570-4b6e-93ed-f6c5b8a2d8a1/Images/Documentation/2024-10-04_17-51-38.png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A21%3A09Z&se=2026-10-26T14%3A21%3A09Z&sr=c&sp=r&sig=E6JP9DdFhqBDRqx0dX%2BtexoHZvvb47Efeiq%2BAkpsQOk%3D) --- ### Related Pages - [Database Connection](/v1/docs/database-connection) - [Email Connection](/v1/docs/email-connection) - [File Connection](/v1/docs/file-connection) - [Kafka Connection](/v1/docs/kafka-connection) - [Message Queue Connection](/v1/docs/message-queue-connection) - [SOAP Web Service Connection](/v1/docs/soap-web-service-connection) - [Batch Connection](/v1/docs/batch-connection) - [REST Web Service Connection](/v1/docs/rest-web-service-connection) - [Environments](/v1/docs/environments) - [Creating a Project](/v1/docs/creating-a-project) - [Deploying a Project](/v1/docs/deployment)