Skip to content

Latest commit

 

History

History
97 lines (75 loc) · 4.25 KB

README_userguide.md

File metadata and controls

97 lines (75 loc) · 4.25 KB

Webex Contact Center DB Connector - User Guide

Welcome to the Webex Contact Center DB Connector. This application provides a secure and manageable way to expose database queries as API endpoints for use within Webex Contact Center flows.

Table of Contents

  1. Getting Started
  2. Dashboard
  3. Managing Connections
  4. Managing SQL Statements
  5. Testing Queries
  6. Deployment

1. Getting Started

Login Page

  • Access: Navigate to the root URL (e.g., http://localhost:8080/).
  • Action: Click the "Login with Webex" button.
  • Process: You will be redirected to the Webex sign-in page. Enter your credentials. Upon successful authentication, you will be redirected to the Dashboard.

2. Dashboard

Home Page

  • Access: Automatically redirected here after login, or click "Dashboard" in the navigation menu.
  • Overview: Provides a high-level view of the system's health and usage.
  • Key Features:
    • Environment Stats: Cards displaying the total number of API hits and failures for PROD, UAT, and DEV environments.
    • Detailed Activity: Expandable lists for each environment showing specific endpoint usage.
      • Endpoint Name: The name of the query being accessed.
      • Count: How many times it has been executed.
      • Last Accessed: Timestamp of the last execution.
    • User Profile: Displays your Webex display name and email.

3. Managing Connections

Connections Page

  • Access: Click "Connections" in the navigation menu.
  • Purpose: Manage the database credentials and connection details.
  • Actions:
    • View List: See all configured database connections.
    • Add Connection: Click the "Add Connection" button to register a new database.
      • Fields: Name, Host, Port, Database Name, Username, Password, Type (MySQL, Postgres, etc.).
    • Test Connection: Click the "Test" button next to a connection to verify the application can reach the database.
    • Edit/Delete: Update credentials or remove obsolete connections.

4. Managing SQL Statements

SQL Statements Page

  • Access: Click "SQL Statements" in the navigation menu.
  • Purpose: Define the SQL queries that will be exposed as APIs.
  • Actions:
    • View List: See all defined queries, their associated environment, and connection.
    • Create Query: Click "Add SQL Statement".
      • Name: A unique identifier (e.g., getCustomerById). This will be part of the API URL.
      • Environment: Select DEV, UAT, or PROD.
      • Connection: Choose which database this query runs against.
      • SQL: Enter the SQL query. Use named parameters with colons (e.g., SELECT * FROM users WHERE id = :userId).
    • Edit: Modify the SQL or connection details.

5. Testing Queries

Test Page

  • Access: Click "Test SQL" in the navigation menu.
  • Purpose: Verify that your SQL queries return the expected data before using them in a contact center flow.
  • How to Use:
    1. Select Environment: Choose the environment (e.g., DEV).
    2. Select Query: Choose the SQL statement name from the dropdown.
    3. Enter Parameters: If your SQL uses parameters (like :userId), input fields will appear for you to provide values.
    4. Run: Click "Execute".
    5. Results: The JSON response from the database will be displayed below.

6. Deployment

Deployment Page

  • Access: Often accessed via a "Deploy" action on the SQL Statements page.
  • Purpose: Promote a tested SQL statement from one environment to another (e.g., from DEV to PROD).
  • Process:
    1. Select the source SQL statement.
    2. Choose the target environment.
    3. The system will create a copy of the SQL statement in the new environment, allowing you to map it to the appropriate production database connection.

7. About

  • Access: Click "About" in the navigation menu.
  • Content: Displays application version, build information, and support contacts.