Microsoft SQL Database

The Microsoft SQL Database component allows you to interact with Microsoft SQL Server databases within your workflow. This component enables you to perform various operations such as querying data, executing SQL statements, and managing database connections.

Steps to use Microsoft SQL Database

1. Add Microsoft SQL Database Component to Canvas:

   To add the Microsoft SQL Database components to the canvas, you have two options:

   1. Navigate through the components menu in the side panel, and drag the Microsoft SQL Database component onto the canvas of your workflow.

   2. Click the plus icon, which opens a window allowing you to search for various components and connectors. Search for the Microsoft SQL Database component and select it.

   Each component will be labeled with a unique identifier (e.g., microsoft_sql_database_1) for easy reference if multiple Microsoft SQL Database components are used.

2. Access Microsoft SQL Database Component Settings:

   Click on the Microsoft SQL Database component to open its settings.

3. Select Credentials for Database Connection:

   • Choose an available Database credential stored in your CXFabric tenant from the dropdown list.

   • Click the ellipsis menu next to the credential selection dropdown to manage credentials (add, edit, view, delete). Click "Manage" to access the full list in the Credential Management page.

     

4. Test Connection:

   After selecting a credential, click the "Test Connection" button to verify connectivity. Note that the "Test Connection" button will only be enabled when a credential is selected. The connection output panel will display the result:

   • If successful, it will show "COMPLETE," and the result panel will display data retrieved by the test query.

     
   • If unsuccessful, an error message will indicate the nature of the failure.

     

5. Enter SQL Statement:

   Enter the SQL statement to be executed, such as a SELECT query, INSERT statement, etc.

6. Test Query:

   Click the "Test Query" button to execute the SQL statement. Note that the "Test Query" button will only be enabled when the editor contains a valid SQL statement. The query output panel will display the result:

   • If successful, it will show "COMPLETE," and the result panel will display data retrieved by the query.

     

     Successful query
   • If unsuccessful, an error message will indicate the nature of the failure.

     

     Unsuccessful query

7. View Query Output: When testing a query, you can view the query output within the Microsoft SQL Database component settings panel. You can choose your preferred view by clicking the JSON or Table tab in the output section. The "JSON" output displays the query results in JSON format, while the "Table" output displays the results in a tabular format.

   

   Query Output in Table format

   Additionally, you can resize the editor vertically, ensuring that you can view and edit your statement and query output more comfortably. This flexibility enhances your ability to work with complex queries and large datasets efficiently.

   

   Resizing the editor vertically

8. Submit:

   After configuring the database connection and testing your SQL queries, click "Submit" to save your configuration.

9. Hover for Information:

   Hover over the Microsoft SQL Database component on the canvas to view tooltips with additional information.

10. Execute the Microsoft SQL Database Component:

    Hover your mouse over the Microsoft SQL Database Component to display the action buttons then click the play button to execute the step. The execution result can be viewed in the logs panel.

NOTE:

• The Microsoft SQL Database component provides seamless integration with SQL Server databases, allowing you to perform database operations directly within your workflow.

• Ensure you have the correct credentials selected before testing or executing queries to avoid connectivity issues.

• Use the "Test Connection" feature to verify database connectivity before proceeding with SQL queries.

• Review error messages carefully to troubleshoot any query execution issues effectively.

• Utilize tooltips for quick reference and additional guidance while configuring the Microsoft SQL Database component.