Skip to main content

Template Reports

Template Reports: Friendly Guide

Hello! Welcome to the Template Reports screen in OmniQ. This tool shows you a summary of messages sent by your bot using templates, such as greetings or notifications. It's like a record of what your bot has done, with details like dates, recipients, and errors. You don't need to program anything, just know how to navigate and download it!

What do Template Reports do?​

Template Reports allow you to:

  • View a list of messages sent with templates (like "Welcome" or "Your order is ready").
  • Filter by dates to find specific reports.
  • Check details such as who sent it, the status, and if there were any issues.
  • Download the list in a file to save or share it.

You'll find it on a screen with a table, calendars, and a download button.

Step-by-Step Guide to the Screen​

You don't configure this screen directly, but rather use it to review information. Here's how to navigate it:

1. Choose the Date Range​

  • Where: The two calendars in the top right that say "From" and "To".
  • What it does: Filters the reports to show only messages sent between those dates.
  • How to set it up:
    • Click on "From" and select the start date (by default it's today at midnight).
    • Click on "To" and select the end date (by default it's now).
    • The dates must be valid (from 2019 onwards) and "From" cannot be after "To". If you make a mistake, it automatically reverts to the initial values.

Example: Choose "From: 02/01/2025" and "To: 02/26/2025" to see reports from this month.

2. Review the Reports Table​

  • Where: The table below the title "Template Report List", with a green sheet icon on the left.
  • What it does: Shows a list with columns such as:
    • id: Unique report code.
    • Subject: Template name (like "Greeting").
    • Recipients: Who it was sent to (like a phone number).
    • Sent By: Who sent it (like "Bot" or a user).
    • Template: Which template was used.
    • Status: If it was sent successfully (like "Sent") or failed (like "Failed").
    • Date: When it was sent (like "02/26/2025 10:00").
    • Errors: A button to see if there were any issues (explained below).
  • How it works: The table populates itself with data from the dates you selected.

Example: You see a row with "Subject: Welcome", "Recipients: +123456789", "Status: Sent".

3. Check for Errors (Optional)​

  • Where: The round button with an "i" (information icon) in the "Errors" column of each row.
  • What it does: Opens a small window with details if there was an error in that delivery.
  • How to use it: Click on the button. If there's an error, it shows it (like "Invalid number"); if not, it says "There's no error".

Example: Click on a row and read "There's no error" because everything went well.

4. Download the Reports​

  • Where: The green "Download" button with a down arrow icon, next to the calendars.
  • What it does: Saves the entire table in a CSV file (which you can open in Excel or Google Sheets).
  • How to use it: Click on "Download". The file automatically downloads with the data you see.

Example: You download "hsmTemplatesReport.csv" with all the rows from the table.

What Happens When You Use It?​

  1. You open the "Reports" screen in OmniQ (probably from a menu).
  2. You adjust the dates in "From" and "To" if you want to see something specific.
  3. The table shows the reports for those dates (or a message if there's nothing).
  4. You check for errors with the "i" buttons and download with "Download" if needed.

Practical Example​

You want to see messages sent this week:

  1. In "From", you choose "02/20/2025".
  2. In "To", you choose "02/26/2025".
  3. The table shows 5 rows, like "Subject: Offer", "Status: Sent", "Date: 02/25/2025".
  4. You click on an "i" button and see "There's no error".
  5. Click on "Download" and save the file to review it later.

Result: You have a summary of the week's messages and a file to share.

Simplified Special Tricks​

View a Single Day​

  • What it does: Filters reports from one day by setting the same date in "From" and "To".
  • How to set it up: Choose "02/26/2025" in both fields.

Example: You only see today's reports.

Easy Export​

  • What it does: The CSV allows you to analyze the data outside of OmniQ.
  • How to set it up: Click on "Download" and open the file in Excel.

Example: You copy the data to a monthly report.

Troubleshooting Tips​

  • Table not appearing? Check the dates; if they're in the future or invalid, it won't show anything. If it's still empty, it says "There are currently no templates reports".
  • "Download" not doing anything? Make sure there's data in the table; if it's empty, there's nothing to download.
  • Seeing strange errors? Click on the "i" button in the row to understand what happened and notify your team if you need help.

That's it! Now you know how to use Template Reports in OmniQ. Choose your dates, explore the table, check for errors, and download when you want. It's a simple way to keep track of your bot. If something doesn't work, adjust the dates or ask for advice from whoever manages the system. Happy report reviewing!