Company Setup

🏢 Technical Specification: Company Setup

 

1. 📋 Feature Overview

Attribute	Detail
Module	⚙️ Settings
Feature Name	Company Setup
Description	Acts as the master data management tool for company entities. Supports creating internal/external companies and manages soft deletes.
User Guide	📄 [Ekajaya Admin User Guide - Setting Module, Page 3]

---

2. 🕹️ Functional Workflow (User Perspective)

• 📍 Navigation: Settings > Company

• 👁️ Listing View: Paginated list with search (filters by name, description, remark).

• ➕ Add Action: Opens the "Add Company" form.

• ✏️ Edit Action: Click the Pencil icon to modify details.

• 🗑️ Delete Action: Click the Trash icon to soft-delete (requires validation).

📝 UI Input Fields

Field Name	Type	Required	Description
Company Name	Text	✅ Yes	Must be unique across active records.
Description	Text	❌ No	Optional details about the company.
Remark	Text	❌ No	Optional internal remarks.
Is Internal?	Checkbox	❌ No	Flag to mark the company as an internal entity.

---

3. 🛠️ Technical Implementation

A. 🔐 Permissions & Access Control

Access is controlled via PermissionGuard and UI directives (*ngIf).

Scope	Permission Code	Description
Menu Visibility	COMPANY.MENU	Sidebar menu item visibility.
Page Access	COMPANY.LISTING	Access to /listing-company.
Create Action	COMPANY.CREATE	Visibility of the + Add button.
View/Edit Access	COMPANY.VIEW	Access to /add-company-manage.
Update Action	COMPANY.UPDATE	Ability to save changes on Edit screen.
Delete Action	COMPANY.DELETE	Visibility of the Delete 🗑️ icon.

B. 🔌 API Interaction

Base URL: ${environment.baseApiUrl}

1. 📥 Retrieve Company List

• Endpoint: /companies/getQuery

• Method: POST

• Purpose: Fetches paginated data for the grid.

• Key Params:

  • filter: isDeleted||$eq||0 (plus dynamic search filters).

  • sort: companyName

2. 🔍 Get Single Company (Edit Mode)

• Endpoint: /companies/getOne

• Method: GET

• Query Params: id (Number)

3. ✨ Create Company

• Endpoint: /companies/create

• Method: POST

• Payload:

  JSON

  
  

  {
    "companyName": "String",
    "description": "String", // Optional
    "remark": "String",      // Optional
    "isInternal": Boolean
  }
  

4. 💾 Update Company

• Endpoint: /companies/update

• Method: POST

• Payload: Same as Create, but includes "id": Number.

5. 🗑️ Delete Company (Soft Delete)

• Endpoint: /companies/update

• Method: POST

• Logic: Updates the record status; does not remove from DB.

• Payload:

  JSON

  
  

  {
    "id": Number,
    "isDeleted": true
  }
  

---

C. ⚠️ Validation & Business Logic

1. 🚫 Unique Name Validation

• Trigger: On Save (Create Mode only).

• Logic: Frontend calls /companies/getQuery.

• Filter: companyName||$eq||{InputName};isDeleted||$eq||0

• Error: If resultCount > 0, display: "Company name already exists".

2. 🛡️ Pre-Delete Dependency Checks

Before deleting, the system verifies the company isn't in use. If any API returns data, the delete is blocked.

Check #	📦 Module	🔗 Endpoint	🔍 Filter Logic
1	Users	/companyUsers/getQuery	`companyId
2	Drivers	/drivers/getQuery	`companyId
3	Movers	/movers/getQuery	`companyId
4	Tankers	/tankers/getQuery	`companyId