User Manual: TZ Insurance Cover Note

1. Overview

The TZ Insurance Cover Note module in ERPNext enables seamless integration with the TIRA system to fetch and manage motor vehicle insurance cover note data automatically. It streamlines the importation, storage, and update of insurance information for registered vehicles.

2. Key Features

• Automated monthly fetch of cover note details from TIRA.
• Conversion and storage of Unix timestamps into human-readable formats.
• Creation or update of insurance records for vehicles in ERPNext.
• Child table support for motor details, insurance providers, and policy holders.
• Error logging for API failures and data processing issues.

3. Pre-Requisites

• Active ERPNext instance with access to the "Vehicle" DocType.
• Internet connectivity to access TIRA API.
• Python libraries: requests, json, datetime.
• Properly configured hooks.py for scheduled task.

4. Step-by-Step Usage

1. Initial Setup:
   • Ensure the DocType TZ Insurance Cover Note and child tables are created.
   • Confirm permissions for System Manager role.
2. Automatic Execution:
   • On the 1st of every month at 00:00, the function update_covernote_docs executes.
   • It fetches all vehicle records, retrieves cover note data via API, and creates/updates records.
3. Manual Trigger:
   • Optionally, run frappe.call('csf_tz.csf_tz.doctype.tz_insurance_cover_note.tz_insurance_cover_note.update_covernote_docs') manually via console.

5. Script Customizations

• API Endpoint:
  • URL: https://tiramis.tira.go.tz/covernote/api/public/portal/verify
  • Modify if endpoint changes.
• Date Conversion:
  • Unix timestamps are divided by 1000 before conversion.
  • Adjust logic if TIRA changes timestamp format.
• Child Tables:
  • Customize fields or add validations within insurance_motors, insurance_provider, policy_holders.

6. Troubleshooting (Common Errors and Resolutions)

• API Timeout:

  • Error: Request timed out.
  • Resolution: Check network connection; verify API availability.

• Invalid JSON Response:

  • Error: JSON decode error.
  • Resolution: Log full response; validate API output format.

• Permission Error:

  • Error: Save permission denied.
  • Resolution: Ensure script uses ignore_permissions=True when saving.

• Document Exists Error:

  • Error: Duplicate document.
  • Resolution: Confirm unique constraint on covernotenumber.

7. User Roles and Permissions

• System Manager:
  • Full access: create, read, write, delete, submit, cancel, report, export.
• Other Users:
  • Read-only access unless additional permissions are explicitly granted.

8. Key Notes

• Ensure server time is accurate for correct scheduled task execution.
• Use HTTPS and disable certificate verification only in controlled environments.
• Maintain API credentials and access in a secure manner if future authentication is implemented by TIRA.