> For the complete documentation index, see [llms.txt](https://help.rbsgo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.rbsgo.com/dineplan/front-desk/report/general-reports.md).

# General Reports

## **Overview** <a href="#general-reports" id="general-reports"></a>

The General category provides access to reports related to products, menu synchronization, till transactions, system logs, promotions, and employee attendance. These reports help users review operational data, verify system configurations, and monitor daily restaurant activities.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-2acf5c4f3f5ba7e4747223e187ed5890604a8833%2Fimage%20(160).png?alt=media" alt=""><figcaption></figcaption></figure>

## **Reports Available** <a href="#available-reports" id="available-reports"></a>

The General category includes the following reports:

* Product List Report
* Menu Items Sync Report
* Till Transactions Report
* Log Report
* Active Promotions Report
* Time Attendance Report

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-bcf98b3d4ade14d7fd71852214e50969df20d47f%2Fatt_4_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Screen Elements** <a href="#screen-elements.1" id="screen-elements.1"></a>

**Report Actions**

The report actions become available after selecting a report. The available actions may vary depending on the selected report.

**View**

* Select the preferred report view.
* Available options include:
  * **Compact** – Displays the report in a condensed layout.
  * **Full** – Displays the complete report with all available details.
  * **Free** – Displays the report in a free-form layout, where applicable.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-3ffbe80ca95881f25384f59995ed605b1c29aeec%2Fatt_5_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

**Filter by Condition**

* Apply the available filters to refine the report results based on the selected criteria.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-1ae032c75033d79e3f7a2798042038aae9d550cf%2Fatt_6_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

**Export to PDF**

* Export the generated report as a PDF file.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-8b495dcb107ceee64fefb8f62f51ffe72ac72a8a%2Fatt_7_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

**Export to Excel**

* Export the generated report as a Microsoft Excel (.xlsx) file.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-16f9e67d5e087142ac4d5c15b483e08663573f6c%2Fatt_8_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

**Print**

* Print the generated report.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-3b90df43d1b8b53cecf4757774aae7df421d4532%2Fatt_9_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

### **Product List Report** <a href="#product-list-report" id="product-list-report"></a>

* The Product List Report displays all products configured in the DinePlan POS system. It provides information such as the product category, alias code, product name, alias name, portion, and price.
* This report helps users verify product configurations and review product information available in the POS.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-c193453b0f7d84ba7e96cc6017f3fcfbdee446b9%2Fatt_10_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields" id="report-fields"></a>

The report includes information such as:

| **Field**      | **Description**                                                         |
| -------------- | ----------------------------------------------------------------------- |
| **Category**   | Displays the category to which the product belongs.                     |
| **Alias Code** | Displays the unique alias code assigned to the product.                 |
| **Product**    | Displays the name of the product.                                       |
| **Alias Name** | Displays the alternate or localized name of the product, if configured. |
| **Portion**    | Displays the portion or serving size configured for the product.        |
| **Price**      | Displays the selling price of the product.                              |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*

#### **Use Case** <a href="#use-case" id="use-case"></a>

Use the Product List Report to:

* Verify that products are configured correctly in the POS.
* Review product categories, portions, and pricing.
* Validate product information after menu updates or synchronization.
* Cross-check product details before restaurant operations.

### **Menu Items Sync Report** <a href="#menu-items-sync-report" id="menu-items-sync-report"></a>

The Menu Items Sync Report displays the menu items that have been synchronized from the backend system to the DinePlan POS. It allows users to verify that the latest menu items and their details are available in the POS after synchronization.

This report helps ensure that menu updates, such as newly added items or modifications to existing items, have been successfully synchronized before restaurant operations begin.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-ddd5c1b31fe34a0d0db4cb77da99da2f2df06906%2Fatt_11_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields.1" id="report-fields.1"></a>

The report includes information such as:

| **Field**      | **Description**                                                           |
| -------------- | ------------------------------------------------------------------------- |
| **Category**   | Displays the category to which the menu item belongs.                     |
| **Alias Code** | Displays the unique alias code assigned to the menu item.                 |
| **Product**    | Displays the name of the synchronized menu item.                          |
| **Alias Name** | Displays the alternate or localized name of the menu item, if configured. |
| **Portion**    | Displays the configured portion or serving size of the menu item.         |
| **Price**      | Displays the selling price of the menu item.                              |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*

#### **Use Case** <a href="#use-case.1" id="use-case.1"></a>

Use the Menu Items Sync Report to:

* Verify that menu items have been successfully synchronized to the POS.
* Confirm that newly added or updated menu items are available for billing.
* Review menu item details after performing a menu synchronization.
* Validate menu information before starting restaurant operations.

### **Log Report** <a href="#log-report" id="log-report"></a>

The Log Report displays a record of user activities and system events performed in the DinePlan POS. It captures details such as the event performed, the time of the event, the associated transaction, and the user who performed the action.

This report helps administrators and supervisors monitor system activities, review user actions, and troubleshoot operational issues.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-38978f426008422d7ed4ce0d5cdffa48e500e195%2Fatt_12_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields.2" id="report-fields.2"></a>

The report includes information such as:

| **Field**      | **Description**                                                                                                            |
| -------------- | -------------------------------------------------------------------------------------------------------------------------- |
| **Ticket No**  | Displays the ticket number associated with the recorded event, if applicable.                                              |
| **Amount**     | Displays the transaction amount associated with the event.                                                                 |
| **Event**      | Displays the type of activity or action performed in the POS, such as Module Clicked, New Order, or Ticket Entity Changed. |
| **Event Time** | Displays the date and time when the event occurred.                                                                        |
| **Log**        | Displays detailed information about the recorded event, including the affected module, item, or operation.                 |
| **User**       | Displays the name of the user who performed the recorded action.                                                           |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*

#### **Use Case** <a href="#use-case.2" id="use-case.2"></a>

Use the Log Report to:

* Review user activities performed in the POS.
* Audit operational events and transaction history.
* Investigate unexpected system or billing activities.
* Troubleshoot issues by reviewing the sequence of recorded events.
* Verify who performed a specific action and when it occurred.

### **Active Promotions Report** <a href="#active-promotions-report" id="active-promotions-report"></a>

The Active Promotions Report displays all promotions that are currently configured and active in the DinePlan POS system. It provides details such as the promotion name, validity period, promotion type, conditions, and description.

This report helps users verify active promotional offers and ensure they are available for customers during the specified period.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-8ecc8a993eb9a3dc8d0fb75a8951e5b9791e4eb5%2Fatt_13_for_3350265859.jpeg?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields.3" id="report-fields.3"></a>

The report includes information such as:

| **Field**       | **Description**                                                                                                                       |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| **Name**        | Displays the name of the active promotion.                                                                                            |
| **Alias Code**  | Displays the unique alias code assigned to the promotion, if configured.                                                              |
| **From**        | Displays the date from which the promotion becomes active.                                                                            |
| **To**          | Displays the date until the promotion remains active.                                                                                 |
| **Type**        | Displays the type of promotion configured in the POS, such as Ticket Discount Promotion, Item Discount Promotion, or Combo Promotion. |
| **Condition**   | Displays the conditions or rules that must be met for the promotion to be applied.                                                    |
| **Description** | Displays additional information about the promotion, such as the discount percentage, offer details, or promotional description.      |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*

#### **Use Case** <a href="#use-case.3" id="use-case.3"></a>

Use the Active Promotions Report to:

* Verify the promotions currently available in the POS.
* Review the validity period of active promotions.
* Confirm that promotion rules and conditions are configured correctly.
* Validate promotional offers before restaurant operations or marketing campaigns.
* Troubleshoot promotion-related issues during billing.

### **Time Attendance Report** <a href="#time-attendance-report" id="time-attendance-report"></a>

The Time Attendance Report displays employee attendance records, including clock-in and clock-out times, working hours, and total hours worked during the selected period. It helps restaurant managers and administrators monitor employee attendance and review work hours.

<figure><img src="https://3400173661-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0EE0WqKESoD8hlEpFQQL%2Fuploads%2Fgit-blob-ef90dfd1565db95836decccc059d639e5fda589c%2Fatt_14_for_3350265859.png?alt=media" alt=""><figcaption></figcaption></figure>

#### **Report Fields** <a href="#report-fields.4" id="report-fields.4"></a>

The report includes information such as:

| **Field**                 | **Description**                                                                    |
| ------------------------- | ---------------------------------------------------------------------------------- |
| **Employee ID**           | Displays the unique ID assigned to the employee.                                   |
| **Employee Name**         | Displays the name of the employee.                                                 |
| **POS No**                | Displays the POS terminal associated with the employee's attendance record.        |
| **Designation**           | Displays the employee's job designation.                                           |
| **Date**                  | Displays the date recorded for the employee's attendance.                          |
| **Clock In**              | Displays the time when the employee started their shift.                           |
| **Clock Out**             | Displays the time when the employee ended their shift.                             |
| **Working Hours**         | Displays the total number of hours worked by the employee for the day.             |
| **Summary Working Hours** | Displays the total working hours accumulated during the selected reporting period. |

*Note - The information displayed may vary depending on restaurant configuration and available transaction data.*

#### **Use Case** <a href="#use-case.4" id="use-case.4"></a>

Use the Time Attendance Report to:

* Review employee attendance records.
* Verify employee clock-in and clock-out times.
* Monitor daily and total working hours.
* Track attendance for payroll and shift management.
* Identify missing or incomplete attendance records.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.rbsgo.com/dineplan/front-desk/report/general-reports.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
