Documentation

Connect

  1. Add New Datasource
    1. Click the Add New Datasource button
    2. You can follow the instructions on the new window to add a file or relational database
    3. You can also manage catalogs through this window.
  2. Datasource table
    1. The Actions column lets you select the datasource
    2. The Datasource column displays the datasource title
    3. The Catalog column lists the catalog name
    4. The Category column indicates whether the datasource is a file (FILE) or a relational database (RDBMS)
    5. The Type column indicates the type of the datasource.
      1. Supported file formats include CSV, JSON, EXCEL, AVRO, and PARQUET
      2. Supported Relational Databases include MySQL, Oracle, MariaDB, Microsoft SQL Server, and PostgreSQL
    6. The Deployed On column show the date and time the datasource was published
    7. The Status column indicates if the datasource is Published or is Awaiting Review.
  3. Actions
    1. The Actions dropdown has two modes
      1. In the first mode when the Status of the datasource is Awaiting Review, the dropdown has two options: Review and Delete
      2. In the second mode when the Status of the datasource is Published, the dropdown has four options: SelectEditSchema and Delete
    2. The Select option lets you select the schema for querying. You move to the Query page.
    3. The Edit option lets you edit the datasource title, description and in case of relational databases, you can change the username and password.
    4. The Review option lets you review the datasource schema and make changes before you publish.
    5. The Schema option lets you view the datasource schema
    6. The Delete option enables you to delete the datasource.
      1. Deleting a datasource will delete all associated queries and cannot be undone.
      2. DELETING DATASOURCES IS NOT RECOMMENDED
  4. Search or Filter datasources
    1. You can search with keywords including the datasource title and the schema.
  5. Reload
    1. Reload button simply refreshes the page with up-to-date information.

You can access and manage catalogs and add data sources to a selected catalog. You may upload files or connect relational databases. Supported file formats include CSV, JSON, EXCEL, AVRO, and PARQUET. Supported Relational Databases include MySQL, Oracle, MariaDB, Microsoft SQL Server, and PostgreSQL.

Please review the following steps:

  1. Select a catalog
    1. Click the Select Catalog button to open the Catalog window
    2. Follow the instructions in the Catalog window to create and/or select a catalog
  2. Review before publishing (Checkbox)
    1. Checkbox is selected by default
    2. You may uncheck this option to skip review.
    3. We recommend you keep the option selected
    4. If the checkbox is selected, you will be able to edit the datasource column names prior to publishing.
    5. Once publised, the column names CANNOT be changed.
  3. You will see two tabs: Add Data Source and Staging
  4. Under the Add Data Source tab:
    1. Upload one or more files
    2. Connect a relational Database
  5. Staging tab tracks the stages of newly added datasources.
    1. Processing
    2. Error
    3. Completed
  6. To upload files: Processing files may take a few minutes to several hours depending on the size and complexity of the file
    1. Select S3 Bucket
    2. Choose a file or several files
    3. Click Submit
  7. To connect a relational database: Processing relational databases may take several seconds.
    1. Choose Database type. You can choose MySQL, Oracle, MariaDB, Microsoft SQL Server, or PostgreSQL
    2. Enter Host name
    3. Enter Port number
    4. Enter Username
    5. Enter Password
    6. Enter Database Name
    7. Click Connect

You can create, select, edit, and delete catalogs. The catalog table lists all the catalogs associated with the Department. Each row of the table contains a radio button, catalog name, number of datasources in the catalog, and the timestamp of the last recorded update.

  1. Add New Catalog
    1. Click the Add New Catalog button
    2. Clicking the button this opens a new dialog window
    3. Enter a unique name. The name should be unique for the Department.
    4. If you enter a non-unique name, then an error is displayed.
    5. The catalog name is NOT case-sensitive. In other words, the term Marketing is same as marketing or mARketing.
  2. Catalog table
    1. Catalog table contains a radio button, name, datasources count and last updated timestamp columns
    2. Select a radio button to activate the Actions button
    3. Click on the Actions button to reveal the dropdown menu
    4. The Actions dropdown menu has three options:
      1. Select option lets you select the catalog.
      2. Edit option lets you edit the catalog name.
      3. Delete option lets you delete the catalog. This option is only available to catalogs with no datasources.
  3. Search or filter catalogs
    1. Type in the full or partial catalog name and press enter
    2. You will see results that are associated with the catalog

Here you can add, select, edit, set as default, or delete an Amazon S3 bucket configuration. Please click here for detailed documentation on how to create and manage S3 buckets on AWS. Please refer to the documentation provided to you to learn how to add a Bucket Policy, IAM Role permission and a CORS configuration to your AWS bucket before adding it here.

  1. Add New Bucket
    1. Please make sure you have added the Bucket Policy, IAM role permissions and CORS configurations before adding the bucket.
    2. Click the Add New Bucket button
    3. Enter the Bucket Name field
    4. Enter the Region field
    5. Enter the folder name to store the Raw uploaded data
    6. Enter the folder name to store the Processed data
    7. Click the Submit button
    8. You have successfully added the S3 Bucket configuration. Please note, this action DOES NOT create a new Bucket in S3. You are only configuring an existing bucket.
  2. Bucket table
    1. Each row has a radio button, bucket name, region, and default indicator.
    2. Select a radio button to activate the Actions button
    3. Click on the Actions button to reveal the dropdown menu
    4. The Actions dropdown menu has four options:
      1. Select option lets you select the bucket.
      2. Edit option lets you change the Raw and Processed data folder names.
      3. Set As Default option lets you set the chosen bucket as Default
      4. Delete option lets you delete the bucket configuration. Please note, this action DOES NOT delete the S3 bucket on your AWS account.
  3. Search or filter buckets
    1. Type in the full or partial bucket name and press enter
    2. You will see the filtered results

Query

  1. The Select Datasource button
    1. Clicking the Select Datasource button opens a new dialog window
    2. Please follow the instructions on the new window to select a datasource
  2. Datasource title
    1. After choosing the datasource, you will the title displayed on the top of the page beside the Select Datasource button
  3. The Schema button
    1. Clicking the Schema button lets you open a side panel
    2. The side panel shows the Schema of the selected datasource
  4. The side panel consists of three sections:
    1. The Header section has a toggle button that lets you fix the side panel
    2. The Table list section (only visible for Relational databases) enables you to navigate through tables through a dropdown list or the Next and the Previous buttons. This section has table names and table aliases.
    3. The Column table section lists the Column Name, Alias, and Data type for each column of the selected table.
  5. Query textbox
    1. The Query Textbox lets you type in and execute natural language queries
    2. The textbox has a autocomplete feature to promote you for faster querying.
  6. Matches
    1. If Seqwa finds multiple matches for words in your query, it will return some matching queries
    2. In each matching query these partially matched words are replaced by column aliases
    3. You can select an appropriate match or execute your original query
    4. In case Seqwa does not find multiple matches then it will run the query regardless of the input
  1. A query or question made of simple, generally used and human-understandable words is a natural language query. In Seqwa, a natural language query can help you retrieve and manipulate data.
  2. Examples of natural language query
    1. What are the total sales for ProductX?
    2. How many cities have Product X?
    3. Find the average marketing budget for each region?
  3. Natural language query to SQL
    1. Seqwa translates a natural language query to SQL code
    2. SQL stands for Structured Query Language. It is a programming language used to retrieve data from a database. SQL is a rich and complex language which is out of reach for most data users. The process of writing SQL code is intensive, tedious, and complicated even for professional programmers.
    3. This natural language query: “Find the total sales for each city” translates to this SQL code:
  1. Listing unique items in a column
    1. List of city
    2. List of country
  2. Plotting numerical columns
    1. Plot the sales
    2. Plot the log sales
  3. Plotting numerical columns VS other numerical columns
    1. Plot the sales VS the marketing spend
    2. Plot the energy consumption VS fuel consumption
  4. Plotting transformed numerical VS other transformed numerical columns
    1. Plot the log sales VS the marketing spend
    2. Plot the log energy consumption VS the log fuel consumption
    3. Plot the tan entry angle VS the tan exit angle
  5. Plotting numerical columns with categorical columns
    1. Plot the sales VS the city
    2. Plot the sales VS the product category
  6. Performing aggregate operations like summation, average, maximum, and minimum on columns
    1. Find the total amount
    2. Average sales
  7. Performing aggregate grouping operations.
    1. Find the total amount by city
    2. Find the average marketing spending by product category
  8. Counting the number of items in a column for each item of another column
    1. How many cities by the state?
    2. How many cities in New York?
  9. Performing aggregate grouping on multiple numerical columns and single categorical column
    1. Find the total sales and total marketing spending by category
    2. Find the average energy consumption and average fuel consumption by vehicle category
  10. Performing aggregate grouping on a single numerical column and multiple categorical columns
    1. Find the total sales by city by region
    2. Find the total sales by product by product category by business unit
  11. Performing aggregation over time
    1. Find the total deals by sale date per year
    2. Find the total sales by sale date per month
    3. Find the total sales by sale date from 2015 to 2019
    4. Find the total sales by sale date for March 2012, March 2013 and March 2014
  12. Performing aggregation on specific values
    1. Find the total sales for New York City per year
    2. Find the total sales for Suffolk and Saratoga by sale date in 2016
    3. Find the total sales for ProductX and ProductY in Hudson and Bronx by sale date from 2012 to 2018
  1. Types of Result
    1. Single – Most queries will return a single result
    2. Multiple – Queries that are not limited to column aliases and involve searching keywords through the data can result in multiple results
  2. Tabs
    1. Chart – A chart displayed if the result is in a table format and if the data allows representation in a two-dimensional plane.
    2. Table – A table displayed when the result is in a table format
    3. Text – A text is displayed when the result is a single value
    4. Code – The code tab displays the SQL code that produced the result
    5. Publish – The Publish tab allows you to publish the result on a Dashboard. In the case of multiple results, you can share the result that you choose.
  3. Results by tabs
    1. Chart + Table – Charts and tables are displayed together when the result is in a table format, and the data allows representation in a two-dimensional plane.
    2. Table only – Only a table is displayed when Seqwa cannot produce a two-dimensional chart for the available chart
    3. Text only – Text only result is displayed when the result is a single value
  4. For detailed information on the modebar aka hover toolbar options on the chart, please click here The following options are available on the charts:
    1. Zoom
    2. Pan
    3. Zoom In
    4. Zoom Out
    5. Autoscale
    6. Reset Axes
    7. Toggle Spike Lines
    8. Show the closest data on hover
    9. Compare data on hover
  5. Types of Charts
    1. Bar
    2. Line
    3. Multiple Line Charts
    4. Box Plot
    5. Scatter Plot
    6. Time series
  6. Table Options
    1. Sort columns
    2. Search or filter table with keywords

Search

Here you can search and execute queries performed on all the datasources of the Department. You can filter the queries based on association: catalog or datasource, querying entity: you, other users or Seqwa, and status: unprocessed, successful or failed.

  1. Filters
    1. Queries associated with
      1. lets you select a catalog
      2. enables you to select a datasource
    2. Querying entity or queries by:
      1.   lets you choose a user to view queries executed by the user.
      2. lets you filter queries generated by Seqwa
    3. Status
      1. lets you filter unprocessed queries
      2.  lets you filter successful queries
      3.  lets you filter failed queries
    4. Search text
      1. type in keywords to filter queries
      2. refreshes table
      3.  removes search text
    5. removes all filters
  2. Execute query
    1. Click on a row to initiate query processing
    2. If the query status is unprocessed, then the query goes through all the processing stages which may take more time
    3. If the query status is successful, then the query executes only the constructed SQL code. Execution is faster than unprocessed queries.
    4. You will see the results in the bottom section.

Dashboard

Here you can select a dashboard to view and edit items on the dashboard. Scrolling over each item reveals four buttons: move, edit, expand, and delete.

  1. Select Dashboard
    1. The Select Dashboard button opens a new dialog window
    2. Follow the instructions in that window to select a dashboard
  2. Adding items to a dashboard
    1. You can access the add items to dashboard feature in three ways:
      1. Query result on Query page
      2. Query result on Search page
      3. Expanding dashboard item
    2. In each of the ways, you will see the publish tab that lets you publish items to a dashboard
  3. Hovering over a dashboard item reveals buttons for each item
    1.  lets you move the item
    2.  lets you edit the item properties
    3. opens a new window to show full query result
    4.  removes the item from the dashboard
  4. Move
    1. You can move items both horizontally and vertically.
    2. We recommend you to place no more than three items in a row.
    3. To move an item, click the move button and hold.
    4. When you begin moving the item, you will observe a grey area enclosed with dotted lines
    5. As you move to a different location, you will see the grey area in those locations.
    6. This grey area is a placeholder for the item.
    7. You can release the button once you have chosen the right spot.
    8. You will have as many rows as the number of items on the dashboard
  5. Edit 
    1. You can manage properties of the item with the edit button
    2. Clicking the edit button opens a new window
    3. You can select appropriate display, change the title and use a checkbox to choose if you want to include the title
  6. Expand 
    1. Clicking expand opens a new window
    2. This new window shows complete results as you saw in the query results on the Query or Search page.
    3. You can also publish this item to a new dashboard through the Publish tab.
  7. Delete
    1. Deletes the dashboard item

You can create, select, edit, and delete dashboards. The dashboard table lists all the dashboards associated with the Department. Each row of the table contains a radio button, dashboard name, number of items in the dashboard, and the timestamp of the last recorded update. less..

  1. Add New dashboard
    1. Click the Add New Dashboard button
    2. Clicking this button opens a new dialog window
    3. Enter a unique name. The name should be unique for the Department.
    4. If you enter a non-unique name, then an error is displayed.
    5. The dashboard name is NOT case-sensitive. In other words, the term Marketing is same as marketing or mARketing.
  2. Dashboard table
    1. Dashboard table contains a radio button, name, items count and last updated timestamp columns
    2. Select a radio button to activate the Actions button
    3. Click on the Actions button to reveal the dropdown menu
    4. The Actions dropdown menu has three options:
      1. Select option lets you select the dashboard.
      2. Edit option lets you edit the dashboard name.
      3. Delete option lets you delete the dashboard. This option is only available to dashboards with no items.
  3. Search or filter dashboards
    1. Type in the full or partial dashboard name and press enter
    2. You will see results that are associated with the dashboard

Users

Here you can manage users, organizations, and departments.

  1. Users table
    1. You will see all the users you have access to:
      1. If you are a Global Admin, then you can see all users
      2. If you are an Organization Admin, you can see all the users in the Organization that you have selected through your profile
      3. If you are a Department Admin or Department Manager, you can see all the users in the Department that you have chosen through your profile
    2. Columns in the table
      1. Actions checkbox activates the Manage User button
      2. Email
      3. First Name
      4. Last Name
  2. Search or filter users:
    1. Type in part or full email address and press enter to filter users
    2. If you are a Global Admin,
      1. You will see that both the Organizations button and the Departments button are active.
      2. You can click on the Organizations or Departments button to select the appropriate Organization or Department filter the users.
    3. If you are an Organization Admin,
      1. You will see that the Departments button is active.
      2. You can click on the Departments button to select the appropriate Department and filter the users.
    4. Clear clear_all button removes selected Organization or Department.
  3. Organizations
    1. Organizations button is active only for Global Admin role
    2. Clicking this button opens a new window dialog
    3. You can manage organizations using this window
  4. Departments
    1. Departments button is active for both Global Admin role and Organization Admin role
    2. Clicking this button opens a new window dialog
    3. You can manage departments using this window
  5. Manage User
    1. Clicking on the Actions checkbox activates the Manage User
    2. Clicking the Manage User button opens a new window dialog
    3. In this new window, you can Assign or Remove roles for the selected user
  6. Reload refresh
    1. Reload button refreshes the Users table

You can add, and delete assigned roles. The assigned role table lists all the assigned roles. Each row of the table contains a delete button, assigned role name, department name and organization name.

  1. Assign Global Role
    1. This button is only accessible to Global Admin
    2. Click the Assign Global Role button
    3. Clicking this button opens a new dialog window
    4. Please follow the instructions on this new window to select the appropriate role
  2. Assign Department Role
    1. This button is only accessible to Organization Admin
    2. Click the Assign Department Role button
    3. Clicking this button opens a new dialog window
    4. Please follow the instructions on this new window to select the appropriate role
  3. Assign Role
    1. This button is only accessible to Department Admin
    2. Click the Assign Role button
    3. Clicking this button opens a new dialog window
    4. Please follow the instructions on this new window to select the appropriate role
  4. Search or filter assigned roles
    1. Type in the keywords that may include partial or full role name, department name or organization name
    2. You will see results that are associated with the assigned role

Here you assign global roles to users. This window has: Select Organization button, and Roles Table.

  1. Select Organization
    1. Click the Select Organization button
    2. Clicking this button opens a new dialog window
    3. Follow the instructions on the dialog to select an organization.
  2. Roles Table
    1. Each row contains an Assign button and role name
    2. Available Global Roles are Global Admin, Organization Admin and Organization User
    3. Selecting an organization enables the Assign button associated with the Organization Admin and Organization User roles
    4. Click the Assign button to assign the global role

Here you assign department roles to users. This window has three buttons: Select Department button, Select Role button, and Assign button.

  1. Select Department
    1. Click the Select Department button
    2. Clicking this button opens a new dialog window
    3. Follow the instructions on the dialog to select a department.
  2. Select Role
    1. Click the Select Role button
    2. Clicking this button opens a new dialog window
    3. Follow the instructions on the dialog to select a department role.
  3. Assign
    1. Assign button is enabled when you have selected both Department and Role
    2. Click the Assign button to assign the department role

Here you assign department roles to users. This window has a Roles Table.

  1. Roles Table
    1. Each row contains an Select button and role name
    2. Available Global Roles are Department Data Admin, Department Admin, Department Manager and Department User
    3. Click the Select button to assign the department role

Here you can create, select, edit, and delete organizations. The organization table lists all the organizations. Each row of the table contains a radio button, organization name, number of departments and number of users in the organization, and the timestamp of the last recorded update.

  1. Add New organization
    1. Click the Add New Organization button
    2. Clicking this button opens a new dialog window
    3. Enter a unique name.
    4. If you enter a non-unique name, then an error is displayed.
    5. The organization name is NOT case-sensitive. In other words, the term Marketing is same as marketing or mARketing.
  2. Organization table
    1. Organization table contains a radio button, name, number of departments, number of users and last updated timestamp columns
    2. Select a radio button to activate the Actions button
    3. Click on the Actions button to reveal the dropdown menu
    4. The Actions dropdown menu has three options:
      1. Select option lets you select the organization.
      2. Edit option lets you edit the organization name.
      3. Delete option lets you delete the organization. This option is only available to organizations with no departments and no users.
  3. Search or filter organizations
    1. Type in the full or partial organization name and press enter
    2. You will see results that are associated with the organization

You can create, select, edit, and delete departments. The department table lists all the departments. Each row of the table contains a radio button, department name, number of users in the department, and the timestamp of the last recorded update.

  1. Select Organization
    1. Select Organization button is only accessible for Global Admin role
    2. Click the Select Organization button
    3. Clicking this opens the Organizations dialog. Follow the instructions on the new dialog window to select an organization
    4. After selection, you will the Department dialog window has been updated to Departments in *name of organization* and a button to remove the option
  2. Departments in Organization
    1. In case you have Organization Admin role, you will see the name of the Organization in the dialog title.
  3. Add New department
    1. Click the Add New Department button
    2. Clicking this button opens a new dialog window
    3. Enter a unique name. The name should be unique for the Organization.
    4. If you enter a non-unique name, then an error is displayed.
    5. The department name is NOT case-sensitive. In other words, the term Marketing is same as marketing or mARketing.
  4. Department table
    1. Department table contains a radio button, name, users count and last updated timestamp columns
    2. Select a radio button to activate the Actions button
    3. Click on the Actions button to reveal the dropdown menu
    4. The Actions dropdown menu has three options:
      1. Select option lets you select the department.
      2. Edit option lets you edit the department name.
      3. Delete option lets you delete the department. This option is only available to departments with no users.
  5. Search or filter departments
    1. Type in the full or partial department name and press enter
    2. You will see results that are associated with the department

Profile

Here you can switch roles, view & change account information, and view session logs.

  1. The Profile page has three tabs:
    1. The Roles tab lets you view and switch roles
    2. The Account tab lets you view and edit user information
    3. The Session Logs tab enables you to see timestamps for login, last activity, and session expiration.
  2. Roles
    1. The Roles tab has a table with four columns
      1. Department column shows the department which the user has access. Department value is NA or Not applicable for Organization Admin, Organization User, or Global Admin roles.
      2. Organization column shows the organization which the user has access. Organization value is NA or Not Applicable for Global Admin role.
      3. The Select radio button for each row that reflects the role-department-organization combination.
    2. The Select radio button
      1. Clicking the Select radio button updates the User role and the window refreshes.
      2. The refreshed window shows the accessible pages depending on the role.
    3. Pages accessible per role
      1. Global Admin – Profile and Users pages.
      2. Organization Admin – Profile and Users pages.
      3. Organization User – Profile page only.
      4. Department Admin – Connect, Query, Search, Dashboard, Users, Track, and Profile pages.
      5. Department Manager – Query, Search, Dashboard, Users, and Profile pages.
      6. Department Data Admin -Connect, Query, Search, Dashboard, Track, and Profile Pages.
      7. Department User – Query, Search, Dashboard, and Profile pages.
  3. Search or filter roles
    1. Type in any keyword to filter the Roles table
    2. You will see results that are associated with the role, department or organization