This document contains a step by step guide that will walk you through the process of configuring a new database, creating charts, dashboards, configuring automated alerts & reports, listing users, and assigning them roles in Tathya.

• Database Configuration

• Charts Creation

• Understanding Dashboards

• Configuring Alerts & Reports

• Creating Roles

• Creating User

Now that you’ve configured a data source, you can create specific charts or slices that you want exposed in Tathya for querying.

Prerequisites:

Ensure you have access to Tathya and the necessary permissions to use SQL Lab.

Tathya is a data exploration and visualization platform that lets users connect to various data sources, explore data, and create interactive dashboards.

Tathya itself doesn't have a storage layer to store your data but instead pairs with your existing SQL-speaking database or data store. So, to be able to query and visualize data from Tathya, you first need to add the connection credentials of your database.

Setup your database

Login into Tathya with your credentials, now on the homepage go to the top right corner, go to settings and click on the "Data" menu to access the data source configuration.

In the "Data" menu, select "Databases" to manage your database connections. Click on the "+" button to initiate the setup process.

From the resulting modal “connect a database”, select the type of database you are connecting to (e.g., MySQL, PostgreSQL, SQLite).

We usually use the MySQL database type, once selected in the next step you have to enter the essential connection details and credentials to establish a connection with the MySQL server.

The required MySQL credentials includes the following fields:

Host

The "host" refers to the network address or hostname of the MySQL server where your database or data source is located. It is the address that Tathya will use to reach the database.

Port

The "port" is a specific endpoint on the host machine. The port number is essential for Tathya to know where to communicate with the database service.

Database Name

The “database name” is the name of the specific MySQL database you want to connect to.

Username and Password

The “username and password” are associated with the account you want to use for the connection.

Display Name

The “display name” is how the database will display in Tathya.

Choose a descriptive name for the connection. For example, if a project were named Wasatch Ski, the display name should be “Wasatch Ski OMS”

Once you have established the connection, you can check the “Advance” tab to access additional settings. These allow you to fine-tune various aspects of the database connection.

The two important configurations here are SQL Lab and Performance:

SQL lab

Enable “Expose database in SQL Lab” to make the database available in SQL Lab and Enable “Allow this database to be explored” to allow database exploration and interaction.

Performance

Set the CHART CACHE TIMEOUT. This is a configuration parameter related to how Tathya caches (stores temporarily) the results of chart queries. Caching is a technique used to improve performance by storing and reusing previously fetched data.

Save the configured settings to establish the connection between Tathya and your MySQL database.

Now, proceed to click on the "Test Connection" button to ensure that Tathya can successfully connect to your MySQL database. Address any issues that arise.

Once the test is successful, click "Save" to confirm the configuration and finalize the setup.

Now, you can use the configured MySQL database for data exploration in Tathya.

To effectively navigate through the SQL Lab interface in Tathya and execute SQL queries, follow these steps for selecting the database and schema.

Navigation in SQL Lab

In the top navigation menu, locate and click on the SQL Lab option. This action will direct you to the SQL Lab interface designed for crafting and executing SQL queries.

In SQL Lab, Tathya provides dropdown menus where you can choose the desired database and schema before writing and executing your SQL queries. This step is crucial for accurately pinpointing the location of your data and ensuring that your queries fetch information from the correct database and schema.

Executing SQL Queries

Utilize various clauses such as SELECT, FROM, WHERE, GROUP BY, and others to shape the logic of your SQL query.

Based on the output you desire, insert the query here and click the Run Query button to execute the query.

How SQL Queries Create a Dataset

Upon executing the SQL query, Tathya sends the query to the connected database. The database parses the query, breaking it down into its structural components, checking for syntax errors, and understanding the logical flow.

Result Set Interpretation

Post successful parsing, the database retrieves a result set—a table of data that matches the specified criteria. Tathya then automatically interprets the structure of this result set, analyzing the columns and their data types.

Dynamic Dataset Creation

​​Leveraging the information obtained from the parsed result set, Tathya dynamically generates a dataset. This dataset mirrors the structure of the result set, capturing the columns and their data types.

Column Mapping

Each column in the result set is mapped to a corresponding field in the dataset. This mapping ensures that the dataset accurately represents the data retrieved by the SQL query.

Dataset Validation

Ensure the dataset returned aligns with your expectations. This is the dataset that will be used to create the chart.

Now, navigate to Save and then select “Save dataset” from the dropdown menu, so that you can use the same dataset to create multiple charts in future.

Creating a Chart

Once satisfied with the derived output, click on Create Chart.

Scenarios for Chart Creation

1. Creating Chart for Specific Queries

The ability to create charts based on specific queries within Tathya empowers users to derive actionable insights from their data. By allowing users to visualize specific subsets of data, this feature enhances decision-making processes and enables users to identify trends, patterns, and anomalies efficiently.

Step-by-Step Usage Instructions:

1. Access SQL Lab: Log in to Tathya and navigate to the SQL Lab feature.

2. Craft SQL Query: Select the database for which you want to create the Query. Write an SQL query with a WHERE clause specifying the desired criteria. For example, to create a chart showing orders created in the past hour:

   Copy

   SELECT *
   FROM order_header oh
   WHERE oh.ENTRY_DATE >= NOW() - INTERVAL 1 HOUR;

3. Execute Query: Click the Run Query button to execute the SQL query and generate the dataset.

4. Save Dataset: Once the dataset is generated, save it by following the prompted steps. This will open a new page with options to customize the dataset.

5. Add Chart Details: Enter a descriptive name for the chart, select the desired chart type, and configure additional settings as needed.

6. Create Chart: Click on the Create Chart button to generate the chart based on the dataset created from the specific query.

2. Creating Chart When Specific Subset is Not Available

Creating charts in Tathya without specific queries is essential for flexible data analysis. This feature allows users to prepare for future data scenarios by initially including all available data, even when subsets may not exist at the time of dataset creation.

Step-by-Step Usage Instructions:

1. Access SQL Lab: Navigate to the SQL Lab within Tathya.

2. Craft General SQL Query: Select the database and write a general SQL query to retrieve all available data without specific conditions. For example:

   Copy

   SELECT *
   FROM order_header oh;

3. Execute Query: Click the Run Query button to execute the SQL query and generate the dataset containing all available data.

4. Save Dataset: Once the dataset is generated, save it by clicking on the save button. This will open a new page with options to customize the dataset.

5. Create Chart: Proceed to create a chart from the dataset to visualize the overall data trends.

6. Unlock Dataset: Click on the options icon against the dataset's name to open a new form. Unlock the dataset by clicking on the lock icon to make changes.

7. Add WHERE Clause: If necessary, add a WHERE clause to the SQL query to filter the dataset based on specific criteria whenever there is data that follows the WHERE clause. For example:

   Copy

   WHERE oh.ENTRY_DATE >= NOW() - INTERVAL 1 HOUR;

8. Save Dataset: Save the dataset by clicking on the save button to retain the modifications made.

9. Update Chart: After saving the dataset, update the chart to reflect the changes made to the dataset and visualize the updated insights.

3. Creating Chart with Empty Dataset

Creating datasets with empty data is crucial in Tathya. It prepares charts for future data arrivals, enabling users to proactively set up their analytics. By allowing users to create charts with empty datasets, this feature fosters adaptability to changing data conditions.

Step-by-Step Usage Instructions:

1. Create Empty Dataset: Open SQL Lab and create an SQL query that returns no data.

2. Save Dataset: Once the query is selected or created, click on the Save Dataset button to save the empty dataset.

3. Redirect to Chart: After saving the dataset, you will be redirected to the chart creation page automatically.

4. Name the Chart: Provide a descriptive name for the chart to identify its purpose or intended data source.

5. Custom SQL: Under Custom SQL, paste the names of columns one by one to define the dataset structure accurately.

6. Save Chart: Click on the save chart button to save the chart configuration for future use.

View your Created Chart

You will now be redirected to the “Main Chart Panel” where your chart is ready to view.

Data Visualization

Navigate to the "data" tab. This is where you can transform the query results into a visual representation.

Here you will encounter two options under the "Data" tab, specifically under the "QUERY MODE" section: "Aggregate" and "Raw Records." These options determine how the data is processed and presented in the resulting chart. Let's delve into each option:

Aggregate Mode Aggregate mode is used when you want to perform aggregate functions (e.g., COUNT, SUM, AVG) on your dataset. It is suitable for summarizing and visualizing data at a higher level.

• Aggregation Functions Allows you to apply aggregation functions to your selected columns. For example, you can count the number of records, calculate the sum of a numeric column, or find the average.

Aggregate mode is commonly used when creating charts like bar charts, pie charts, or line charts where you want to visualize summarized information.

Raw Records Mode Raw Records mode is used when you want to retrieve individual, unaggregated records from your dataset. It provides a detailed view of each record.

• No Aggregation Functions Does not require the use of aggregation functions. The query retrieves raw, unprocessed records from the specified columns.

Raw Records mode is useful when you need a detailed, record-level view of the data. It's suitable for creating charts that display individual data points without summarization.

How the Raw Mode works:

• Column Names The column names in your SQL query result set become the headers or fields in the table. Each column in the result set is mapped to a corresponding column in the visualization.

• Data Types Tathya attempts to infer the data types of each column based on the values in the result set. This helps in appropriately formatting and displaying the data.

• Automatic Table Creation When you execute the query in "Raw Records" mode, Tathya automatically creates a table or chart with the mapped columns, displaying the individual records retrieved by the query.

• Dynamic Mapping The mapping is dynamic, meaning that if your SQL query result set structure changes (e.g., adding or removing columns), Tathya adjusts the mapping accordingly when you execute the query.

• No Aggregation Since "Raw Records" mode is focused on displaying individual records without aggregation, each row in the result set is treated as a separate data point.

Configure Additional Chart Settings

You also have additional configurable options such as Filters, Ordering, and Row Limit.

• Filters Filters allow you to narrow down the rows displayed in your result set based on specific conditions. You can filter the data to show only rows that meet certain criteria.

• Ordering Ordering allows you to sort the result set based on one or more columns. You can specify the order (ascending or descending) for each column.

• Row Limit Row Limit allows you to control the number of rows displayed in the result set. This is particularly useful when dealing with large datasets, allowing you to view a manageable subset of the data.

Optimizing Queries for Specific Results

In your SQL queries, you can write specific details and conditions to retrieve data that matches your requirements without the need for additional filters in the chart.

For example, you can use the WHERE clause in your SQL queries to filter data at the database level before it even reaches Tathya. This can be more efficient as it reduces the amount of data transferred between the database and Tathya.

Similarly, you can use ORDER BY in your SQL queries to specify the sorting order of the results, and LIMIT to control the number of rows returned.

Writing precise and optimized SQL queries can streamline the data retrieval process, ensuring that the results align with your expectations without relying heavily on post-processing in the visualization chart.

Adjust other settings such as colors, labels, and tooltips as needed from the “Customize” option, present right next to the data tab.

For example, if you choose a Line Chart, specify the columns you want on the x-axis and y-axis. the date might be on the x-axis, and total sales on the y-axis.

Once you have made the required modifications, click on “Update chart”.

Save and Share your Chart

In the top-left corner, give your chart a descriptive name for easy identification within Tathya.

Navigate to the top-right corner and click on the "SAVE" button. A Save Chart panel will appear with the Chart Name field auto-populated.

After saving, find your chart in the Charts tab for quick access.

Save Chart to an Existing Dashboard Or Create a New Dashboard

While in the process of saving a chart, you have the option to directly add it to a dashboard.

In the "Add to Dashboard" field, you can specify whether you want to add the chart to an existing dashboard or create a new one.

• If you would like to save the chart to an existing dashboard, then select the dashboard from the drop-down list.

• If your new chart does not align with the existing dashboards, go ahead and enter the dashboard name and create a new dashboard.

• Select Save or, to browse directly to the defined dashboard, select Save & Go To Dashboard.

The added chart becomes easily shareable. Options include downloading data or a PNG file, copying the chart link, or setting up regular email reports for automated sharing.

Add Charts to a New Dashboard

Locate and click on the "Dashboards" option in the top navigation menu. This will take you to the dashboard management page.

• Click on the "+ Dashboard" button to initiate the creation of a new dashboard.

• Provide a meaningful and descriptive name for your dashboard. Add any relevant tags or categories.

• A list of existing charts will be displayed. Choose the charts you want to include in your dashboard. These could be charts, graphs, or any visualizations you've previously created.

• Use the drag-and-drop functionality to arrange the selected charts on your dashboard. This allows you to create a customized layout that visually communicates your insights effectively.

• Fine-tune the layout by adjusting the size and position of each slice using the drag-and-drop feature. Customize the dashboard title, description, and other settings. Consider adding annotations for clarity.

• Publish your dashboard once satisfied with the layout and content.

Add Charts When Editing a Dashboard

Navigate to the Dashboards screen and go to the dashboard to which you want to add charts.

• Select the Edit dashboard icon.

• Select the Charts tab.

• The Charts tab contains a list of all charts that you have access to (i.e., charts that you have created or a team member has shared ownership access).

• To add a chart, just drag & drop the chart card into a space on the dashboard.

• Publish your dashboard once you have added all the required charts.

Creating a New Chart from an Empty Dashboard

Navigate to the Dashboards screen and select + Dashboard.

• In the Content panel, select + Create a new chart.

At this stage, you can proceed with the process of creating a new chart by following the steps discussed under the section “creating a new chart”.

Removing Charts from a Dashboard

To remove a chart from the Dashboards screen, select the Edit dashboard icon.

• While your cursor is hovering over a chart, select the trash icon in the upper-right corner of the chart.

• To delete an entire row of charts, select the trash icon on the far left side of the row.

Deleting a Dashboard

A dashboard can be deleted from the Dashboards screen by clicking on the delete icon in the Actions column header.

• On clicking the delete icon, you will see a popup that confirms the deletion of a dashboard. Type 'DELETE' to delete the dashboard.

When you create charts using SQL queries, Tathya lets you use the generated dataset to create new charts. (Dataset serves as the primary source of your data. It contains the information you want to visualize)

This way you can create multiple charts to represent the same dataset in different ways. This is especially beneficial when you want to represent different facets of the data or tailor visuals for specific user groups.

Navigate to the "Charts" section in Tathya.

Choose the Saved Dataset

When creating a new chart, you'll have the option to choose an existing dataset. Look for the option "Datasets" and select the dataset you saved earlier.

Select the Chart Type

Choose the chart type that best suits the insights you want to convey.

Configure the New Chart

Configure the new chart using the selected dataset. You can define metrics, dimensions, and customize the chart settings.

Save the New Chart

Once satisfied with the new chart configuration, save it.

HotWax Commerce facilitates the exchange of data between systems, but errors can occur during import/export processes, potentially leading to inaccuracies. To address this, the platform provides LogInsights reports, which are stored in Solr-index core. By leveraging the powerful indexing capabilities of Solr, HotWax Commerce enables efficient data retrieval and analysis, supporting performance monitoring, troubleshooting, and reporting activities. These reports offer insights derived from system logs, allowing users to easily identify any data transfer failures.

LogInSight charts can be set with the following steps:

LogInsights Core Creation for a Specific Instance

The logInsights core within HotWax Commerce provides users with valuable insights derived from system logs, facilitating the generation of superset reports. This feature is crucial for users who need to analyze system performance, troubleshoot issues, and make informed decisions based on data-driven insights.

Steps to set LogInsight Core:

1. Accessing the Search Admin Page:

   • Navigate to the hamburger menu in the HotWax Commerce interface for the specific instance.

   • Click on Search Admin to access the page for managing Solr indexing.

2. Managing Solr Cores with Core Operations:

   • Within the Search Admin page, locate the Core Operations section.

   • This feature allows users to effectively manage Solr cores, ensuring optimal performance and organization of indexed data.

3. Refreshing the logInsights Core:

   • Identify the logInsights core within the list of Solr cores.

   • Click on the Refresh Core button associated with the logInsights core.

   • This action updates the Solr index with the latest data from system logs, ensuring synchronization with any recent changes or updates.

NiFi Flow Setup

NiFi, an open-source data integration tool, is utilized to automate data flow between systems in real time. A flow is to be configured in NiFi to filter out failed JSON files from SFTP locations and redirect error-prone data to logInsights core for logging purposes.

After the flow setup, it is imperative to insert dummy data. This step is crucial for querying as fields are dynamically indexed in the Solr core based on the dummy data. The dummy data should be inserted with a docType of TEST to ensure exclusion from Superset charts.

Solr Database Creation in Tathya

System administrators can utilize the Solr database creation feature to set up and manage databases for log data, facilitating effective monitoring and troubleshooting of system performance.

Step-by-Step Usage Instructions

1. Access Settings:

   • Navigate to the Settings section within the HotWax Commerce interface.

2. Select Database Connections:

   • Within Settings, locate and select the Database Connections option.

3. Add a New Database:

   • Click on Add a New Database located in the top right corner of the interface.

4. Choose Database Type:

   • Under the supported dashboard search bar, select the Others option.

5. Name the Database:

   • Provide a descriptive name for the database under the Display Name category to easily identify it.

6. Construct URL:

   • Create the database URL in the following format: solr://test-oms.hotwax.io:443/search/logInsights?&use_ssl=true&token=<JWT_token>

7. Generate JWT Token:

   • Generate a JWT token from the OMS using an integration user. Refer to this document to know how to generate the JWT token.

8. Replace Token Placeholder:

   • Replace <JWT_token> in the URL with the generated token.

9. Specify Instance Name:

   • Write the instance name of the brand for which you are creating the dashboard. For example, if the instance name is test-oms, input it accordingly.

10. Test Connection:

    • Paste the constructed URL as a SQLAlchemy URL and test the connection.

11. Set Chart Cache Timeout:

    • In the advanced tab -> performance, set the CHART CACHE TIMEOUT property to a desired value, such as 10000, to manage cached data effectively.

12. Connect:

    • If the connection test is successful, click on the Connect button to finalize the database creation process.

Create Solr Queries

Creating Solr queries within Tathya requires a different syntax compared to traditional SQL queries used in Tathya dashboards. Here's how you can create Solr Queries:

Step-by-Step Guide to Creating Solr Queries:

1. Define Time Range:

   • Use the appropriate time syntax to specify the desired time range for the query. For example:

     Copy

     createdDate_dt = '[NOW/DAY-1DAY TO NOW/DAY]'

2. Specify Fields:

   • List each field required in the query's result set. Provide aliases if necessary. For example:

     Copy

     `field_name_with_special_chars` AS field_alias

3. Handle Special Characters:

   • If any field name contains special characters, enclose it within back-quotes (`).

4. Order Results (Optional):

   • If sorting is needed, include the attribute in the select clause and specify the desired sorting order. For example:

     Copy

     field_name ASC

5. Limit Results:

   • Ensure to include the limit method to restrict the number of returned records, especially for large result sets.

Create Solr Charts

Solr Dashboard Creation is a crucial feature within the HotWax Commerce platform, providing users with the capability to visualize data from Solr databases through intuitive charts. This feature significantly enhances users' ability to analyze and interpret data, empowering them to make informed decisions and optimizations within their business operations.

Step-by-Step Usage Instructions:

1. Navigate to SQL Lab: From the home page, access the SQL Lab section within the HotWax Commerce interface.

2. Select Solr Database: Choose the Solr database you have created to run the query from. This ensures that the query retrieves data from the correct source.

3. Write Solr Query: Write the Solr query in the SQL Lab editor to fetch the desired data from the selected Solr database.

4. Retrieve Data: Once you have formulated the query and retrieved the desired data, proceed to the next step.

5. Create Chart: Click on the Create chart button to initiate the chart creation process.

6. Name and Save Chart: Give the chart a descriptive name that reflects its content or purpose, and save it for future reference.

7. Add to Dashboard: Optionally, add the created chart to the dashboard of your choice for easy access and visibility alongside other relevant data visualizations.

Dashboards in Tathya are practical spaces where you can organize and interpret your data. They have the unique capability to tell a story by combining different types of charts to form a narrative.

If you're starting from scratch, you can craft a new dashboard with a set of charts to visualize your information. Alternatively, if you already have charts that tell a story, you can assemble them into a dashboard for a consolidated view.

Prerequisites:

Ensure that you have access to the necessary data sources and have individual slices (charts or visualizations) already created in Tathya.

Configuration Options for Dashboards

• Save Chart to an Existing Dashboard Or Create a New Dashboard

• Add Charts to a New Dashboard

• Add Charts When Editing a Dashboard

• Creating a New Chart from an Empty Dashboard

In Tathya, it's essential to grant access to charts to other users to facilitate seamless collaboration and editing processes. Moreover, granting access allows users to add the chart to dashboards without encountering visibility issues. Here's how to grant access:

1. Navigate to the charts section within Tathya.

2. Find the specific chart you wish to grant access to.

3. Go to the chart and locate the "Actions" section, located on the right-hand side.

4. Click on the "Edit" option within the actions menu.

5. A popup window will appear, providing various options for chart management. Navigate to the "Access" tab within this popup.

6. In the "Access" tab, you'll find a section where you can add relevant users who are allowed to alter the chart.

7. Enter the names or usernames of the users you wish to grant access to. This list should include individuals who may need to edit the chart or add it to dashboards.

8. Once you've added the relevant users, save your changes. This ensures that the specified users have the necessary permissions to edit the chart and include it in dashboards.

Editing Mode

Select the ellipsis icon (3 dots) while in editing mode to view the following options:

• Edit dashboard properties

  • Title: The title of the dashboard.

  • URL Slug: Customize the end of the URL (slug) to a more memorable name.

  • Owners: Assign/remove access to the dashboard.

  • JSON Metadata: By expanding the Advanced header, the JSON Metadata panel appears. This area is for power users who may wish to alter specific dashboard parameters.

• Edit CSS

  • Loads the Live CSS Editor, which can be used to make ad hoc stylesheet changes in a live editing environment (i.e., changes applied in real time).

• Save as

  • Duplicate a dashboard, this dashboard will contain all of the same charts as the existing dashboard. This is useful to allow you to create a dashboard from an existing dashboard.

• Share

  • Copy permalink to clipboard: Copies a shareable dashboard link to the system's clipboard.

  • Share by email: Launches the system's default email client and composes a new message featuring your dashboard URL.

• Set auto-refresh interval

  • Select to specify an automatic refresh rate for the dashboard. Options include seconds (10 or 30), minutes (1, 5, or 30), or hours (1, 6, 12, or 24). Note that this will be only applied to the current session.

• Setting a permanent auto-refresh

  • If you would like to set a permanent auto-refresh instead, you would need to modify the JSON metadata in the Dashboard Properties. For that, set a value (in seconds) to the "refresh_frequency" parameter (default value is 0). For example, to set a 1-hour refresh rate, set the parameter value as 3600.

View Mode

• Refresh dashboard

  • Select to refresh the chart's data. The time duration since the last cache is also provided.

• Enter fullscreen

  • View the chart in full-screen mode (i.e., just the chart occupies the entire screen).

• Download as an image, CSV, or Excel

  • Download the entire chart in jpeg, CSV, or xlsx format.

• Share

  • Copy permalink to clipboard: Copies a shareable chart link to the system's clipboard.

  • Share permalink by email: Launches the system's default email client and composes a new message featuring your chart URL.

• Set auto-refresh interval

  • Select to specify an automatic refresh rate for the dashboard. Options include seconds (10 or 30), minutes (1, 5, or 30), or hours (1, 6, 12, or 24). Note that this will be only applied to the current session.

In Tathya, it's essential to grant access to dashboards to other users so that they can add their charts to them without encountering visibility issues. Here's how to grant access:

1. Navigate to the Dashboards section within Tathya.

2. Find the specific dashboard you wish to grant access to.

3. Go to the dashboard and locate the "Actions" section, located on the right-hand side.

4. Click on the "Edit" option within the actions menu.

5. A popup window will appear, providing various options for dashboard management. Navigate to the "Access" tab within this popup.

6. In the "Access" tab, you'll find a section where you can add relevant users who are allowed to alter the dashboard.

7. Enter the names or usernames of the users you wish to grant access to. This list should include individuals who may need to edit the dashboard.

8. Once you've added the relevant users, save your changes. This ensures that the specified users have the necessary permissions to edit the dashboard and add charts to it.

The Multi-day Filter feature in Tathya provides retailers with flexible options to view reports on various frequencies beyond daily reports. This functionality is pivotal for retailers who must analyze their operations on different time scales, such as weekly or monthly data.

By allowing users to set custom date filters, Tathya enhances their ability to derive insights from the platform's reports for their decision-making processes. Whether it's monitoring performance over specific periods, identifying trends, or making strategic adjustments based on historical data, this feature streamlines users' workflows and amplifies efficiency in data analysis.

Step-by-Step Usage Instructions:

1. Access the chart you wish to apply filters to within the Tathya Dashboard.

2. For existing charts, the date filter should be removed from the SQL query to ensure that when the user sets the filter view, the data is fetched dynamically for the chart.

3. To remove the date filter, click on the options overflow menu, and select the edit chart option. This will open a new page to edit the chart.

4. Click on the options menu in the Chart Source column located on the left and select Edit dataset from the options.

5. This will open a new form, click on the lock icon to make changes, edit the query to remove the date filter, and save the changes. Finally, save the chart by clicking the save icon available at the top right.

6. Once the SQL query is updated, Look for the Filter icon positioned on the left side of the page. Click on it to open a sidebar, presenting options for filter configuration.

7. In the sidebar, click the + Add/Edit Filters button. This action will open a new form where you can manage filters.

8. In the filter form, designate the filter type as Time Range and provide a descriptive name, such as Date Filter, to distinguish it.

9. Add relevant details such as a description for clarity and set the default filter value. For example, you can choose Last Day as the default value to automatically display data from the previous day when users access the chart.

10. Once all necessary details are configured, save the filter. The filter will now be available in the sidebar for selection.

11. With the filter created, choose the desired time range from the available options in the sidebar. This action will adjust the displayed data accordingly, enabling users to analyze information within the specified timeframe.

Set Email Frequency

Setting email frequency in Tathya provides retailers with tailored email reports at their desired frequency, enabling them to efficiently monitor their daily or weekly performance and address any issues promptly. While Tsthys offers various date filters for on-screen data viewing, this feature ensures that the time range for email reports remains independent.

Step-by-Step Usage Instructions:

1. Navigate to the dashboard and choose the chart you wish to adjust. Click on the options icon at the top right corner of the chart.

2. From the options menu, select Edit Chart. This action will take you to a new page where you can modify the chart data.

3. Locate the filter section in the editing interface's data column.

4. From the dropdown menu within the filter section, pick the Error Date column. This choice ensures that the email report focuses on error and discrepancy-related data.

5. Within the filter options, choose the time range filter and set it to display data for the desired frequency such as Last Day. This setting ensures the email report provides insights into the previous day's performance.

6. After configuring the filter settings, click on the Update Chart button to apply the changes to the chart.

7. Save your changes by clicking on the save icon. This action ensures that the configured time range for email reports is saved and applied consistently for future email communications.

The Link Configuration feature in Tathya offers users the ability to embed clickable links within charts generated in Superset, facilitating seamless redirection from the Dashboard page. Users can navigate to relevant pages within the HotWax Commerce platform directly from the Superset Dashboard, eliminating the need to switch between multiple tabs or applications. This saves time and improves overall productivity. Users can set up link configuration in two ways:

Method 1: Using the Raw Records Section in Charts

1. Locate and Edit the Chart:

   • Locate the chart in which you want to configure the links. Click on the ellipses on the right of the chart and select Edit chart.

2. Set Query Modes and Configure Columns:

   • Select the Query Modes as Raw Record in the Data section. Navigate to the Columns Section to configure the columns of your chart in Superset.

3. Add a New Column:

   • Click on the Add Column option to initiate the creation of a new column.

4. Customize Link with Custom SQL:

   • Upon clicking, you'll encounter a model with three sections: saved-columns, Simple columns, and Custom SQL. Click on Custom SQL and paste the link specifying the targeted link and the source column. For example, if you want to create a link for facility ID, you need to create the link similar to this:

   Copy

   CONCAT('<a href="',
          CONCAT("https://{Instance-name}.hotwax.io/commerce/control/Page ", facility_id)
          ,'" target="_blank">', facility_id, '</a>')

   • The CONCAT Function is used to generate HTML code for creating a hyperlink dynamically based on the facility_id for the above example. The concat function follows the following pattern:

     • <a href=": Static part of the anchor tag indicating the start of a hyperlink.

     • CONCAT("https://{{instance_name}}/commerce/control/ViewFacility?facilityId=", facility_id): Dynamically generates a URL by concatenating a static URL template with the facility_id. here facility_id is a column name which is included in link.

     • '" target="_blank">: Static part of the anchor tag specifying that the link should open in a new tab or window.

     • facility_id: Value inserted into the anchor tag as visible text.

     • </a>: Static part of the anchor tag indicating the end of the hyperlink.

5. Edit Column Header:

   • Afterward, you can edit the header, which serves as the label for your column.

Method 2: Using Aggregates Section in Charts

1. Set Query Mode and Configure Columns:

   • Select the Query Mode as Aggregate in the Data section. Navigate to the Columns Section to configure the columns of your chart in Superset.

2. Add a New Column:

   • Navigate to the Metrics Section and Click on the Add Column option to initiate the creation of a new column.

3. Customize Link with Custom SQL:

   • Upon clicking, you'll encounter a model with three sections: Saved-columns, Simple columns, and Custom SQL. Click on Custom SQL and paste the SQL specifying the targeted link and the source column.

4. Edit Column Header:

   • Edit the header, which serves as the label for your column in the chart.

By following these steps, users can effectively configure the Link Configuration feature within Tathya, enhancing their data visualization capabilities and workflow efficiency.

A report can also be scheduled via a dashboard or via a chart.

Via a Dashboard

• View a dashboard and, in the top right corner, select the ellipsis icon and then Manage email report > Set up an email report.

Via a Chart

• View a chart and, in the top right corner, select the ellipsis icon and then Manage email report > Set up an email report.

Configure the Scheduled Report

• Report Name (required): Enter a memorable name for the new report and, in the Description field, enter a brief description of the report.

Scheduling a New Report

• After the word Every, select the frequency of the report. Options include:

  • Year

  • Month

  • Week

  • Day

  • Hour

  • Minute

  After you select one of the above, the scheduler will present options that are relevant to your choice.

Define Message Content

• For dashboards, only Image (PNG) is supported so this is automatically selected. For charts, choose between:

  • Image (PNG) embedded in the email field to receive the chart as an image that is directly embedded within the email message body.

  • Formatted CSV attached in the email field to receive the chart's raw data as a comma-separated value file that is attached to the email.

Your schedule has now been created. To verify, select Settings → Alerts & Reports → Reports tab.

Why Create Roles?

Roles serve as a way to organize and control access to dashboards within Tathya. By associating charts with specific roles, you can manage who sees what, providing a personalized and secure data visualization experience.

After successfully setting up alerts, you may also want to generate regular reports to keep track of important metrics. Tathya allows you to automate the process of creating and sending reports at specified intervals.

Follow the steps below to create and schedule reports:

1. Navigate to the Alerts & Reports screen. By default, you'll land on the Alerts interface. To access the Reports screen, click on the Reports tab.

2. On the Reports interface, select + Report to create a new report. The "Add Report" window appears.

Basic Details

1. Report Name field (required), enter a descriptive name for your report. This will also serve as the subject of the email.

2. Owner(s) field (required), select one or more owners for the report. Owners have the ability to edit the report and are notified in case of any execution failures.

3. Description (optional), provide a brief and meaningful description of the report.

The "Active" toggle switch is enabled by default.

Defining the Report Schedule:

This panel is used to define how frequently the report will be sent to a defined notification channel(s).

1. Specify Time: The first schedule option enables you to specify a highly granular schedule based on your specific requirements. Data can be checked every minute, hour, day, week, month, or year. The day, week, month, and year options all allow you to define a schedule down to the hour & minute granularity.

2. Check or Enter CRON: After setting a schedule, the subsequent CRON field will automatically populate with an equivalent CRON expression that represents your defined schedule.

3. Alternatively, you can also directly enter a CRON expression by selecting the secondary radio button and entering the expression in the CRON Schedule field.

   (To learn more about CRON expressions, please refer to the alerts section)

Select Timezone

In the Timezone field, select the drop-down menu and choose your timezone.

Define Schedule Settings

1. Log Retention (required): Enter the number of days the report will be stored in the execution log (default is 90 days).

2. Working Timeout (required): Set the maximum duration for the report job to run before an automatic timeout (default is 3600 seconds).

Message Content

In the Message Content section, select either the Dashboard or Chart radio button. Then, in the drop-down field, select the relevant dashboard or chart — a screenshot of the dashboard or chart will be sent along with a link.

When sending a chart, be sure to indicate whether a screenshot will be sent (in PNG format) or as a CSV file. For Table and Pivot Tables, you can also choose to include the chart on the email text (rather than as an attachment).

• Screenshot Width: This is an optional parameter that allows you to customize the width (in pixels) for your dashboard / chart screenshot.

Your custom width can be between 600 and 2400 pixels. The format is the plain number (e.g., 2000). Utilizing the custom screenshot width may allow you to show more columns in a wide table chart which would normally be cut off by the typical screenshot width; please note that tables wider than the maximum limit of 2400 pixels will be cut off.

* **Ignore Cache:** Check this box to generate real-time data and invalidate cache.

Notification Method:

In the Notification Method section, select Add notification method. The Select delivery method drop-down field appears. Select either Email or Slack, as needed. On selection, you will be prompted to enter an email address or the channel name. You can also configure it to be sent to both recipient types.

To finalize and save your report, select Add.

By following these steps, you can easily create and schedule reports in Tathya, ensuring that the relevant users receive timely and accurate information.

List Roles

Click on "Settings" located in the top-right corner of the Tathya interface. Under the "Security" section within Settings, select "List Roles."

On the List Roles page, you'll find an overview of existing roles. To add a new role, click on the “+” icon.

In the role creation interface, you'll encounter two key fields: "Name" and "Permissions."

Name: Begin by giving the role a descriptive and easily identifiable name. Consider using a camel case convention for clarity. For example, if your project is named "Wasatch-Ski," you might name the role "Wasatch-SkiProd-DatabasePermission."

Choose a name that clearly indicates the purpose or project associated with the role, making it easy to understand at a glance.

Permissions: In Tathya, permissions play a crucial role in determining access levels to dashboards and charts.

Start by searching for and listing all the charts created for your project. This ensures that users with this role can access dashboards containing these specific charts.

Once you've filled in the necessary details, click "Save" to create the new role.

Modifying Permissions for Existing Roles

If there's a need to revise permissions for an existing role, for example, when new charts are added to an existing project, follow these straightforward steps:

1. Identify and select the role for which you want to modify permissions.

2. Once you've located the role, click on the edit icon associated with that role.

3. Inside the role editing interface, navigate to the "Permissions" field. Here, you can add new charts or remove existing ones to adjust access levels.

4. To include new charts in the permissions, start typing the names of the additional charts. They will be automatically suggested for selection.

5. After making the necessary modifications, click "Save" to update the permissions for the existing role.

Now that you've successfully created charts and added them to dashboards, the next crucial step is to set up Alerts and Reports. The Alerts & Reports feature in Tathya enables creating event-triggered notifications (Alerts) or scheduled notifications (Reports).

What is an Alert?

An alert provides a custom link to a chart or an entire dashboard and is triggered when a predefined event occurs. This event is a logical condition within your data.

What is a Report?

A report offers a snapshot of a chart or an entire dashboard, accompanied by a link for further exploration and slicing & dicing of the query. Unlike alerts, reports run on a defined schedule (e.g., daily at 7 pm, weekly, etc.).

Navigating to Alerts & Reports

1. In the Toolbar, hover over Settings.

2. From the drop-down menu, select Alerts & Reports.

Upon reaching the Alerts & Reports screen, the Alerts interface is displayed by default. You can easily toggle between the Alerts and Reports tabs to control the content they wish to view.

Below the Alerts and Reports tabs is “Last Updated” information, this simply conveys when the screen was last updated with data. You can force refresh the page by selecting the circular “Refresh” icon.

The filters and search features enable you to quickly find the alert or report that you're looking for, which is invaluable when there are many entries.

Filters and Search Features

• Created By:

  • Select a user to display alerts or reports created by that individual.

• Status:

  • Select an option to display alerts or reports that match the selected status. Available status options include:

  • Default: Displays all entries regardless of status.

  • Success: Displays entries that ran successfully.

  • Working: Displays entries that are currently being processed.

  • Error: Displays entries that did not successfully run.

  • Not Triggered: Displays entries with a trigger that has not yet been activated.

  • On Grace: Displays entries that are currently in a defined grace period.

• Search:

  • To use the Search feature, simply enter a term in the text-entry field and hit or select the magnifying glass icon. A list of entries that include your search criteria will appear in the table.

Table Column Headers

The Alerts and Reports tables include the following column headers:

• Last Run:

  • Displays the date, time, and UTC hour difference when the entry last ran.

• Name:

  • Represents the name of the alert or report, as defined when adding or editing the entry.

• Schedule:

  • Indicates the defined schedule of the alert or report (e.g., every hour, every minute, etc.).

• Notification Method:

  • Displays an icon indicating that notifications will be sent via email.

• Owners:

  • Icons indicating the owner(s) of the alert or report.

• Active:

  • A toggle switch indicating whether the alert or report is currently enabled or not.

• Actions (visible on cursor hover):

  • Icons that enable you to access the execution log, edit the entry, or delete the entry.

To initiate this process, it is essential to first “list” the user on the Tathya platform.

Prerequisites

User access to Tathya requires prior registration on LDAP (Lightweight Directory Access Protocol).

After successfully creating an LDAP user account, log in to Tathya using the generated credentials.

Tathya forwards the authentication request to the LDAP server, which verifies the user's credentials against its directory and responds to Tathya with the authentication status.

Access to Tathya

To complete the setup, proceed by logging into Tathya with your credentials.

Prerequisites

Ensure that you have the necessary permissions and administrative privileges to manage users in Tathya.

After logging into Tathya, in the Toolbar, hover your cursor over Settings and locate the "Security" menu. Within the Security section, look for an option like "List Users." This option will take you to the page where you can view, add, and update all the users.

Updating User Record

Now to update the user, locate the newly listed user that you created in the previous step and click on the edit button. You will be redirected to the “Edit user” page, here verify and update user details such as, First Name, Last Name, Username, Is Active, Email, Roles.

First Name and Last Name: The "First Name" and "Last Name" fields contain the user's name. These columns provide information about the user's identity so that you can quickly recognize who each user is.

Username: The "Username" is the same LDAP-generated ID that will be used to log into Tathya (firstn.lastn). Ensure that the provided username matches the user's LDAP identifier.

Is Active?: The "Is Active?" field determines whether the user account is currently active or inactive. If set to "True," the user can log in and access Tathya.

Email: The "Email" is the email address associated with each user's account.

Roles: The "Roles" column indicates the roles assigned to each user. Select the default role “HotwaxBasicPermissionUser” for the user.

Here are key details about this role:

• The HotWax Basic Permissions role restricts access to specific areas in Tathya.

• Users with the HotWax Basic Permissions role will only have access to the "Dashboard" panel. Users cannot view any charts here until and unless they are assigned to them in the form of a role.

• In the "Settings," users with this role will see a limited set of options. The displayed options include user profile details, general information, and the logout function.

• This role ensures a high level of security by preventing users from accessing areas beyond the designated dashboard and settings sections.

Once all the fields that are required to add a user have been filled, click on “Save.”

Now, you have successfully listed the new user on Tathya and provided the roles and permissions necessary to manage their project’s charts and dashboards.

Periodic Review and Update of User Roles

Regularly review and update user roles as needed, especially when new charts are introduced. This will ensure that the users get access to the latest dashboards that have been created for them.

Why OU?

OUs allow for the logical grouping and organization of users within the LDAP directory. Each OU typically represents a specific category, department, or project.

Organizational Unit (OU) Creation

1. Login into the LDAP directory with your credentials. On the phpLDAPadmin default dashboard page, locate the domain components on the left corner and click on the "+" icon. Now, select "Create new entry here".

2. Choose "Generic: Organizational Unit" as the template for creating the object.

1. In the main pane, provide the name of the organizational unit, typically representing the entire project.

1. Click on the "Create Object" button and confirm the creation of the entry by clicking on "Commit".

User Account Creation

1. In the LDAP directory, navigate to the newly created Organizational Unit ("tathya-wasatch-ski" in our example). Below the OU, click on “Create new entry here” to add a user.

2. In the main pane, click on "Create a child entry" and then select "Generic User Account" as the template for creating the user account.

3. Input user details such as First and Last Name, Common Name, UserID, Password, UID Number, GID Number, and Login Shell.

First and Last Name: The first and last name of the user that you want to log in to on Tathya.

Common Name: Common Name (CN) is the full name of the user.

UserID: UserID is an auto-generated unique identifier for the user. It serves as a key attribute for identifying and distinguishing each user within the LDAP directory.

Password: The Password is a secure string of characters chosen by the user to authenticate and access the LDAP.

GID Number: The GID number defines a search space where administrators or developers can perform LDAP searches specifically targeted to retrieve information related to various accounts.

Login Shell: The Login shell is the shell or program the user interacts with after login. It influences the user's experience after logging in, defining the command-line environment.

1. Once you enter all the details, click on the "Create Object" button and confirm the creation of the entry by clicking on "Commit".

User permissions in Tathya determine the level of access and actions granted to individual users within the system. These permissions are categorized into various roles, each with specific functionalities and access levels.

1. Client Users

Clients have access to multiple predefined dashboards to review their performance on a daily, weekly, or monthly basis. They are granted HotwaxBasicPermission with their specific Dashboard permission to view their designated dashboard but are restricted from editing or creating any dashboards. All data within the dashboard is interlinked, so any discrepancies will be promptly reflected in the dashboard. If a client wishes to make changes to the dashboard, they can communicate with Hotwax Support.

2. Internal Users

For internal users, we generally provide two types of permissions:

• Basic Business Analyst Permission: Grants access to create their chart dashboards and view any existing ones. However, users with this permission do not have default access to the SQL lab, nor can they view any draft dashboards or charts, nor edit other owners' charts. If we add SQL permission to the Basic Business Analyst permission, users gain access to the SQL lab that allows them to save queries and view query history.

• SuperBusinessAnalyst Permission: Grants access to more advanced users familiar with dashboard reporting. Users with this permission can access the SQL lab by default but cannot edit dashboards or reports owned by others without explicit permission. If they wish to edit another user's chart, they must request the admin or creator to include them in the owners' section of the chart/dashboard.

  • Note: SuperBusinessAnalyst users can request Admin Permission, which grants them access to all permissions except for creating and managing users and their roles. This permission allows them to edit dashboards or reports owned by others.

3. Admin-Main Users

Admin users in Tathya hold the highest level of access, responsible for system management and administration. Admin users have all the SuperBusinessAnalyst permissions along with access to view and edit charts owned by others. Furthermore, they have authority over various aspects, including managing user registrations, handling access requests, and organizing data through tagging for efficient categorization. Additionally, admins oversee role management, which involves editing, deleting, adding, and listing dashboards, charts, and reports of other users and their draft dashboards.

Here is the list of Permission

Tabs

Tabs in Tathya act as a handy way to organize and structure your dashboard. They serve as separate sections, allowing you to group related charts or information together, making navigation a breeze.

• Click the "+" button to add a new tab.

• Rename tabs to provide clarity and relevance.

• Easily switch between different sections of the dashboard using tabs.

Rows and Columns

Rows and columns are the building blocks of your dashboard layout. They define how charts and elements are arranged on the canvas, giving you control over the visual structure.

• Create a row by dragging the "Row" element onto the canvas.

• Adjust the width and height of rows and columns to control the layout.

• Place charts, headers, or other elements within rows and columns for an organized dashboard.

Header

Headers provide a descriptive title or label for a specific section of your dashboard. They enhance the visual hierarchy and help users quickly understand the content.

• Drag the "Header" element onto the canvas.

• Customize the header text to convey the purpose or theme of the section.

• Headers can be placed within rows or columns to introduce or label groups of charts.

Markdown

Markdown elements enable you to add formatted text, images, or hyperlinks to your dashboard. They enhance communication by providing context, instructions, or additional information.

• Drag the "Markdown" element onto the canvas.

• Use Markdown syntax to format text, insert images, or create hyperlinks.

• Position Markdown elements within rows or columns to complement charts and visualizations.

Divider

Dividers act as visual separators, creating a clear distinction between different sections of your dashboard. They contribute to a clean and organized layout.

• Drag the "Divider" element onto the canvas.

• Place dividers between rows or columns to visually separate content.

• Adjust the divider style to match the aesthetics of your dashboard.

Color Palettes

As part of the chart creation process, creators specify a color palette for it. On the dashboard level, it is possible to specify a single categorical color palette that would be used by all charts on your dashboard.

To set up a dashboard-level color palette:

1. Access your dashboard.

2. Click on EDIT DASHBOARD, on the top right corner.

3. Click on the three ellipses on the top right corner > Edit properties.

4. Choose a palette under the COLOR SCHEME drop-down.

5. Save changes.

For more control over the columns that are applied to each dimension, you can manually specify the colors using hexadecimal or RGBA code on the dashboard JSON metadata.

To do so:

1. Access the dashboard.

2. Click on EDIT DASHBOARD, on the top right corner.

3. Click on the three ellipses (...) > Edit properties.

4. Expand the ADVANCED section.

5. Create a new section inside the JSON METADATA named label_colors, specifying the desired colors for each metric/dimension.

By understanding and utilizing these dashboard layout elements, you'll be able to craft visually appealing and well-organized dashboards in Tathya.

Objective

To address and resolve discrepancies in data within Tathya reports, ensuring accurate and reliable information for users.

Context

Occasionally, discrepancies in data may arise in Tathya, impacting the visibility or accuracy of reports generated for clients. These issues typically stem from SQL query issues, dataset misconfigurations, or user-specific requirements not being met.

Scenarios

1. Field Not Found

Issue: Users do not see expected fields or results in Tathya reports. Cause: Missing fields in SQL queries or dataset configurations.

2. Duplicated Data

Issue: Users encounter repeated fields or data in reports. Cause: SQL queries fetching duplicate records or incorrect joins.

3. Mismatched Data

Issue: Expected data does not match what is displayed in reports. Cause: Incorrect filters or conditions in SQL queries.

4. New Feature Request

Issue: Clients request additional data fields not currently available. Cause: Queries need modification to incorporate new data requirements.

Troubleshooting Steps

1. Initial Checks

Verify Issue Existence

• Log in to Tathya using credentials.

• Navigate to the specific report or dashboard where the issue is observed.

• Confirm discrepancies reported by users.

2. Investigate and Diagnose

Identify Scenario

• Determine if the issue falls under Field Not Found, Duplicated Data, Mismatched Data, or New Feature Request.

Check Tathya Configuration

• Navigate to the report or chart where the problem occurs.

• Click on the chart title or navigate to the Charts option in the navigation bar.

Edit Dataset

• Click the three dots on the chart and select Edit dataset.

• In the Edit dataset dialog, go to the Source section.

• Edit the SQL query in the SQL field as necessary to address the issue.

• Click on Save button.

Sync Columns

• Inside the Edit dataset dialog, navigate to the Columns section.

• Click on SYNC COLUMNS FROM SOURCE to ensure all necessary columns are included from the updated SQL query.

• Click Save to apply changes.

3. Verification and Resolution

Cross-check Results

• Return to the dashboard or report and verify if the issue is resolved.

• Ensure the changes do not adversely affect other charts relying on the same dataset.

Additional Considerations

Dependency Check

• Before making changes, review dependencies to understand impacts on other reports or charts.

• Ensure changes are implemented in a way that maintains data integrity across all relevant areas.

In Tathya, user roles and permissions are managed to control what actions users can perform and what data they can access.

Alpha Role Overview

The Alpha role in Tathya is a predefined role designed to provide broad access while limiting certain sensitive administrative capabilities.

Below is an overview of the Alpha role and steps to create client-specific database access to the Alpha role.

Use Cases for Alpha Users

• Ideal for power users who need the ability to create and manage dashboards and charts but do not need full administrative control.

• Suitable for team leads or analysts who work extensively in querying and visualizing data.

Steps to Create an Alpha Role with Client-Specific Database Access :

1. Copy the Existing Alpha Role:

   • Go to the settings in the top-right corner.

   • Click on List Roles.

   • Select the existing Alpha role.

   • Click the Action button to create a new role based on the Alpha role.

2. Rename the New Role:

   • Name the copied role according to the client. For example:

     • Example-Alpha if the client is Example.

   • This ensures the role is uniquely identifiable.

3. Modify Database Permissions:

   • Remove alldatabaseaccess Permission:

     • Navigate to the permissions section of the newly created role.

     • Remove the alldatabaseaccess permission to restrict access to all databases.

     • Remove the alldatasourceaccess permission to restrict access to all datasources.

   • Add Permission for the Client Database:

     • Add permissions to the specific database associated with the client, e.g., Example Database.

4. Assign the Role to the Client User:

   • Navigate to the client user in the List user.

   • Add the newly created role (e.g. Example-Alpha) to the client user.

Final Check:

• Verify that the client user now has access only to the designated database Example Database and cannot access any other databases.

• Perform a quick test by logging in as the client user to confirm the role's functionality.

Permissions for Alpha Users

1. Dashboard Management:

   • Can create, and delete dashboards.

   • Can view and modify filters in dashboards they have access to.

2. Chart Management:

   • Can create, edit, and delete charts.

   • Can view all charts they have permission to access.

3. Database Access:

   • Can access databases, schemas, and tables that are explicitly granted to them.

4. Dashboard Filters:

   • Can use advanced filters and cross-filtering in dashboards.

Limitations of Alpha Users

1. Restricted Administrative Actions:

   • Cannot manage roles or permissions for other users.

   • Cannot access or modify system settings or configurations.

   • Cannot assign or modify roles for other users.

   • Cannot change their role to Admin.

2. No Database Configuration:

   • Cannot add, edit, or delete database connections.

3. Limited Access Control:

   • Can only access datasets, databases, and schemas granted to them by an Admin or through specific role permissions.

   • Cannot edit or overwrite dashboards unless they are the owner of the dashboard.

   • Cannot view others' draft status dashboards.

4. Restricted Plugin and Feature Control:

   • Cannot enable or disable plugins.

5. Does not have access to SQL Lab and creating datasets

6. Security Management:

   • Cannot create or modify roles.

   • Cannot edit global security policies.

On the Alerts interface, select + Alert to create a new alert.

The Add Alert window appears.

Basic Details

1. In the Alert Name field (required), enter a name for your new alert.This will also serve as the subject of the email.

2. In the Owner's field (required), select one or more owners for the alert. Owners have the ability to edit an alert and are notified in case of any execution failures.

3. In the Description (optional) field, enter a short but meaningful description of the alert, to be included in the alert message.

The Active toggle switch is automatically enabled.

Alert Condition Panel

Move to the Alert Condition panel. This area is used to define the event that triggers the activation and notification of the alert.

1. In the Database field (required), select the database in which the SQL query should be executed.

2. In the SQL Query field (required), enter a SQL statement that defines the nature of the alert (the metric you want to monitor).

3. In the Trigger Alert If... field (required), define the condition, and in the Value field (required), enter the associated value of the condition.

Alert Condition Schedule

This panel is used to define the frequency at which the data is checked to see if the defined condition has been met.

Specify Time

The first schedule option enables you to specify a highly granular schedule based on your specific requirements. Data can be checked every minute, hour, day, week, month, or year.

After setting a schedule, the subsequent CRON field will automatically populate with an equivalent CRON expression that represents your defined schedule.

Alternatively, you can also directly enter a CRON expression by selecting the secondary radio button and entering the expression in the CRON Schedule field.

The basic structure of a CRON expression consists of five fields, representing minute, hour, day of the month, month, and day of the week. Each field can have a specific value or a wildcard (*) to represent any possible value. Here's the general format:

| | | | | | | | | +----- Day of the week (0 - 6) (Sunday is both 0 and 7) | | | +------- Month (1 - 12) | | +--------- Day of the month (1 - 31) | +----------- Hour (0 - 23) +------------- Minute (0 - 59)

For example:

• 0 0 * * *: Check data at midnight every day.

• */15 * * * *: Check data every 15 minutes.

• 0 2 * * 1-5: Check data at 2:00 AM every weekday (Monday to Friday).

Select Timezone

In the Timezone field, select the drop-down menu and choose your timezone.

Define Schedule Settings

1. In the Log Retention field (required), enter the number of days that the alert will be stored in the execution log. By default, this is set to 90 days.

2. In the Working Timeout field (required), enter the number of seconds that the alert job is allowed to run before it results in an automatic timeout. By default, this is set to 3600 seconds.

3. In the Grace Period field, enter the number of seconds that should pass before the alert can trigger relative to when a previous alert was triggered. If an alert triggers within this period, its status will be On Grace, and the alert's evaluation will commence when this period concludes. By default, this is set to 14400 seconds.

Message Content

In the Message Content section, select either the Dashboard or Chart radio button. Then, in the drop-down field, select the relevant dashboard or chart, a custom link will be prepared and sent based on the defined notification method.

• Screenshot Width: An optional parameter that allows you to customize the width (in pixels) for your alert dashboard/chart screenshot.

• Ignore cache when generating screenshot: Checkbox to produce real-time data (invalidating cache).

Notification Method

In the Notification Method section, select Add notification method. The Select delivery method drop-down field appears. Select either Email or Slack, as needed. On selection, you will be prompted to enter an email address or the channel name. You can also configure it to be sent to both recipient types.

To finalize your alert, select Add.

Let's take a look at an example

You can create an alert for whenever the count of unfillable orders in a day exceeds the defined threshold of 20.

Set conditions for the count of unfillable orders in a day to be greater than 20 and choose the daily time granularity for the evaluation. Specify the email addresses of the operations and customer support teams so that they receive immediate email notifications when facing a higher volume of unfillable orders.

Outcome

Clients at Hotwax Commerce request reports through Jira or Slack. We gather requirements, create a task in ClickUp, and assign it to the appropriate team member. The final report is then delivered to the client, ensuring a smooth and efficient process.

Approach

Client Request

• Clients initiate report requests through Jira or Slack. This step begins the process of obtaining a customized report, ensuring the client's request is logged and tracked.

Client Communication

• Interact with the client to clarify their requirements, ensuring that the report meets the client's specific needs. Collect all necessary details related to the requested report. This ensures all relevant data is considered in the report creation process.

Ticket Creation

• Log in to ClickUp and open the Hotwax Commerce Workspace.

• Select the Project Management Space.

• Navigate to the OMS Folder and then to the Report list.

• Create a ticket in the Report list section in ClickUp.

Assigning the Task

• Assign the tickets to the appropriate team member with all gathered requirements and add the relevant details in the description.

Creating Charts and Reports

Response

• Attach the URL of the report or chart to the ticket in ClickUp and close the ticket.

• Deliver the desired result to the client via Jira or Slack. This completes the request process and ensures the client receives the required report.

Scenario

If a client requests you to create a user on Tathya, the process begins by gathering the user's first name, last name, and email ID. These details are essential for setting up the user's account.

Steps to Create a User in Tathya

1. Gather Information: Obtain the user's first name, last name, and email ID from the client.

2. LDAP User Creation:

   • First, create a user in the LDAP (Lightweight Directory Access Protocol) system. LDAP serves as the central repository for user authentication and authorization information.

   • to learn how to create a user in LDAP

3. Tathya User Creation:

   • Once the user is successfully created in LDAP, proceed to create their account in Tathya.

   • Configure permissions and access levels based on their role and responsibilities within Hotwax Commerce.

   • to learn how to create a user in Tathya

4. Verification:

   • Log in with the credentials in our system to verify that all reports are visible to us.

   • Ensure that the user has the appropriate access and permissions.

5. Notification:

   • Notify the client once the user account has been set up in Tathya.

   • Provide them with login credentials and any additional instructions or information they may need.

   • For example, to view the dashboard, instruct them to click on the Dashboard menu.

This process ensures that user accounts are securely and efficiently established in both LDAP and Tathya, adhering to organizational security and access protocols.

Tathya users sometimes face login issues due to forgotten credentials, which can be resolved by verifying or updating their credentials in our records. This guide helps you troubleshoot by detailing how to set up and manage LDAP accounts, including updating user credentials in phpLDAPadmin.

Scenario 1: Checking Existing User Record

Verify Existing Credentials:

• Search for the user's record in your record.

• Use the credentials on record to attempt a login.

Successful Login:

• If the login is successful, share the same old credentials with the user.

Scenario 2: Updating the Password via LDAP

Log into the LDAP Directory:

• Use your administrator credentials to log into the phpLDAPadmin interface.

• Select the appropriate instance (e.g., SM, UCG, Krewe, etc.).

Access User Information:

• From the left-hand side of the phpLDAPadmin dashboard, navigate to and select the user experiencing login issues.

Update Password:

• In the user's details, locate the password field.

• Enter a new password, ensuring it meets security standards.

• Choose the encryption method (typically MD5 for Hotwax Commerce).

Confirm New Password:

• Click on Check password to verify the new password.

• Once confirmed, click on the Update Object button to save the changes.

Communicate New Credentials:

• Share the new credentials with the user.