User Manual for Consignee Management System

1. Overview

The Consignee Management System is a module within Frappe ERPNext designed to manage consignee details efficiently. It allows users to store, track, and manage consignee-related information such as names, TINs, contact details, and addresses. This module is essential for shipment processing and customs clearance. This is a master doctype that is created automatically from manifest after its uploaded and submitted.

2. Key Features

• Consignee Registration: Stores unique consignee names and ensures no duplicates.
• Consignee TIN and Contact Details: Captures tax identification numbers and phone numbers for verification.
• Address Management: Records the consignee’s full address.
• Quick Entry Feature: Allows fast entry of consignee details for streamlined workflows.
• Search and Filtering: Enables users to search based on consignee name, TIN, or contact number.
• Enable/Disable Functionality: Allows deactivation of consignees without deleting them.

3. Pre-Requisites

Before using this module, ensure the following:

• ERPNext and Frappe Installed (v13 or later recommended).
• User Roles Configured (System Manager or Consignee Manager must have necessary permissions).
• Consignee Naming Convention (Set to automatically name records based on consignee names).

4. Step-by-Step Usage

Step 1: Adding a New Consignee Record

1. Navigate to the Consignee list.
2. Click New to add a new record.
3. Enter the required fields:
   • Consignee Name (Unique), TIN, Telephone, and Address.
4. Click Save to store the details.

Step 2: Editing an Existing Consignee Record

1. Navigate to the Consignee list.
2. Click on the record you want to modify.
3. Update the necessary fields and click Save.

Step 3: Searching and Filtering Consignees

1. Use the search bar to find a consignee using fields like Consignee Name, TIN, or Telephone Number.
2. Use filters to narrow down consignees based on status (Enabled/Disabled).

Step 4: Disabling a Consignee Record

1. Open the consignee record you want to disable.
2. Check the Disabled box.
3. Click Save to mark the consignee as inactive.

5. Script Customizations

• Auto-Naming Rule
  • The system automatically assigns names to consignees based on their entered Consignee Name.
  • Defined in doctype.json:

    "autoname": "field:consignee_name"
    

• Quick Entry Feature
  • Allows users to enter consignees quickly without opening a full form.
  • Enabled for fields: Consignee Name, TIN, Telephone, and Address.
• Search Indexing
  • The system enables search for consignees using:

    "search_fields": "consignee_name, consignee_tin, consignee_tel, disabled"
    

6. Troubleshooting (Common Errors and Resolutions)

7. User Roles and Permissions

Roles Available:

• System Manager: Full control (create, edit, delete, and manage consignee records).
• Consignee Manager: Can create and modify consignees but cannot delete them.
• Read-Only Users: Can view consignee details but cannot edit or modify them.

Permissions Matrix

8. Key Notes

• Ensure all required fields are filled before saving a consignee record.
• The search function allows filtering based on Consignee Name, TIN, and Telephone.
• Properly maintain consignee records to ensure accurate shipment tracking.
• Disabling consignees prevents them from being used but retains their records for reference.

This manual serves as a complete guide to managing Consignee records in ERPNext. For further assistance, contact the System Administrator or refer to Frappe Documentation.