Category Module

Documentation for managing categories in the system.

Published:

1. Module Overview

The Category module allows you to organize and manage different categories for your items or products. By defining categories, you can easily classify items, assign standard unit types, and track average rates.

2. How to Access (Navigation)

Navigate to the Category module from the left side menu, or search for Category using the global search bar.

3. Adding a New Record (Create)

  1. Click the Add Category button with the plus icon at the top of the page.
  2. A form modal will appear.
  3. Fill in the required details.
  4. Save the form. The new category will immediately appear in the table.

Form Fields:

  • Category Name: The name of the category.
  • Description: Additional details about what the category represents.
  • Unit Type: The standard unit of measurement associated with this category.
  • Remarks: Any extra notes or comments.
  • Avg Rate: The average rate associated with items in this category.
  • Sort No: Choose whether it belongs to ‘sales’ or ‘purchase’.

4. Viewing and Searching (Read)

Upon accessing the module, the page displays a table containing all existing categories.

Table Fields:

  • Id: The unique identifier for the category.
  • Category Name: The name of the category.
  • Description: Additional details about what the category represents.
  • Unit Type: The standard unit of measurement associated with this category.
  • Remarks: Any extra notes or comments.
  • Avg Rate: The average rate associated with items in this category.
  • UserName: The user who created or last modified the category.
  • Action: Buttons to edit or delete the specific category row.

Search Functionality:

  • Column Search: At the bottom of each column, there is a search box. Type in any box to filter the table based on that specific column (e.g., search for a specific “Unit Type” or “Category Name”).
  • Exact Match Search: By default, searching will return partial matches (e.g., searching “box” will return “boxes”). If you want to find an exact match only, toggle on the Enable Exact Match Search switch located below the table.

5. Editing a Record (Update)

  1. Locate the category you wish to update in the table.
  2. Click the green Edit button (pencil icon) in the Action column for that category.
  3. The category details will load into a form.
  4. Update the necessary fields and save your changes. (Note: The form fields are the same as in Create).

6. Deleting a Record (Delete)

  1. Locate the category you want to remove.
  2. Click the red Delete button (trash can icon) in the Action column.
  3. Confirm the deletion when prompted. The category will be permanently removed from the system.