Skip to main content

​
Overview

The Materials module enables you to maintain a comprehensive catalog of materials that are transported in your logistics operations. Each material record includes details like name, description, unit of measurement, and availability status, helping you track what’s being shipped and manage inventory.

​
Key Features

Material Catalog

Maintain a complete directory of all transportable materials

Multiple Units

Support various units of measurement (tons, kg, liters, etc.)

Status Tracking

Monitor material availability (Available, Limited, Unavailable)

Shipment Integration

Link materials to shipments for complete documentation

​
Viewing Materials

​
Materials Table

The main table displays all registered materials:
ColumnDescription
NameMaterial identifier/name
DescriptionAdditional details about the material
UnitUnit of measurement
StatusAvailability status with colored badge
ActionsEdit and delete buttons
The Materials module is accessible to all users for viewing. Edit and delete capabilities depend on your role permissions.

​
Material Status Indicators

Status badges show material availability at a glance:
  • 🟢 Available (Green): In stock and ready for shipment
  • 🟠 Limited (Amber): Low stock or restricted availability
  • 🔴 Unavailable (Red): Out of stock or not currently shippable
Material Status

​
Search Functionality

Quickly find materials:
  • Search by name, description, unit, or status
  • Multi-column search capability
  • Real-time filtering as you type
  • Case-insensitive search
Use partial words to find materials. For example, searching “cement” will find “Portland Cement”, “Cement Mix”, etc.

​
Adding a New Material

1

Open the Add Dialog

Click the + Add Material button in the top-right corner.Add Material Button
2

Enter Material Name

Provide a clear, descriptive name:
  • Required field
  • Use specific, unambiguous names
  • Include grade or type if relevant
  • Examples: “Portland Cement - Grade 53”, “Iron Ore - High Grade”, “Coal - Steam Grade”
3

Add Description (Optional)

Provide additional details:
  • Optional but recommended
  • Include specifications, grades, or special characteristics
  • Useful for distinguishing similar materials
  • Example: “High-grade iron ore with 65% iron content, suitable for steel production”
4

Select Unit of Measurement

Choose how this material is measured:Available Units:
  • Tons: For heavy bulk materials (default)
  • Kilograms: For smaller quantities
  • Cubic Meters: For volume-based materials
  • Liters: For liquids
  • Pieces: For countable items
The unit you select here will be used throughout the system when referencing this material.
5

Set Availability Status

Choose the current availability:
  • Available: Default for new materials, ready for shipment
  • Limited: Use when stock is low or availability is restricted
  • Unavailable: Use when material cannot currently be shipped
6

Submit the Material

Click Add Material to save:
  • All required fields are validated
  • Success message appears
  • New material added to the table
  • Immediately available for use in shipments

​
Editing Material Details

1

Locate the Material

Find the material using the search function or by browsing the table.
2

Click Edit Button

Click the pencil icon in the Actions column.Edit Material Icon
3

Modify Information

The edit dialog opens with current values pre-filled:
  • Update name, description, unit, or status
  • All fields follow same rules as creation
  • Changes take effect immediately
4

Save Changes

Click Update Material to save:
  • Changes are validated
  • Success message confirms update
  • Table refreshes with new information
Changing a material’s unit affects how quantities are interpreted in existing shipments. Use caution when modifying units for materials already in use.

​
Deleting Materials

Deleting a material is permanent and cannot be undone. This action may affect shipment records that reference this material.
1

Find the Material

Locate the material you want to delete in the table.
2

Click Delete Button

Click the red trash icon in the Actions column.Delete Material
3

Confirm Deletion

A confirmation dialog appears:
  • Title: “Are you absolutely sure?”
  • Warning: “This action cannot be undone. This will permanently delete the material and remove it from our servers.”
Click Delete to proceed or Cancel to abort.
4

Material Removed

Upon confirmation:
  • Success message appears
  • Material removed from the table
  • Material no longer available for new shipments
Instead of deleting materials that are no longer used, consider changing their status to “Unavailable”. This preserves historical records while preventing future use.

​
Understanding Material Units

​
When to Use Each Unit

Best For: Heavy bulk materialsExamples:
  • Coal
  • Iron ore
  • Cement
  • Aggregates
  • Steel products
Note: 1 ton = 1,000 kg
Best For: Smaller quantities or precision measurementsExamples:
  • Specialized chemicals
  • Packaged goods
  • High-value materials
  • Samples
Note: More precise than tons for lighter materials
Best For: Volume-based materials where density variesExamples:
  • Soil
  • Sand
  • Gravel
  • Wood chips
  • Bulk agricultural products
Note: Weight can vary based on density and moisture
Best For: Liquid materialsExamples:
  • Fuel
  • Chemicals
  • Oils
  • Water
  • Liquid food products
Note: Temperature can affect volume
Best For: Discrete, countable itemsExamples:
  • Machinery parts
  • Equipment
  • Containers
  • Packaged units
  • Pallets
Note: Best when items are uniform

​
Material Status Management

​
When to Use Each Status

StatusUse CaseImpact on Shipments
AvailableMaterial in stock and readySelectable in shipment creation
LimitedLow stock or restrictedSelectable but indicates caution
UnavailableOut of stock or not shippableNot shown in shipment dropdowns

​
Updating Status Based on Inventory

1

Monitor Inventory Levels

Track how much of each material you have in stock.
2

Update Status Proactively

As inventory decreases:
  • Available → Limited (when stock is low)
  • Limited → Unavailable (when stock is exhausted)
3

Restore Availability

When inventory is replenished:
  • Unavailable → Limited (partial restock)
  • Limited → Available (full restock)
Regular status updates ensure users don’t create shipments for materials that aren’t available, preventing operational issues.

​
Integration with Shipments

​
Linking Materials to Shipments

During shipment creation:
  1. Material Selection Field appears
  2. Only materials with status “Available” are shown
  3. Material name and unit are displayed
  4. Select material or choose “None” if not applicable
  5. Material reference stored with shipment

​
Benefits of Material Tracking

Complete Documentation

Full records of what was transported, when, and where

Compliance

Meet regulatory requirements for certain materials

Analytics

Understand which materials are shipped most frequently

Inventory Insights

Track material movement patterns over time

​
Common Material Categories

​
Construction Materials

  • Cement (tons)
  • Steel bars (tons)
  • Bricks (pieces)
  • Sand (cubic meters)
  • Gravel (cubic meters)

​
Industrial Raw Materials

  • Iron ore (tons)
  • Coal (tons)
  • Limestone (tons)
  • Bauxite (tons)

​
Liquids

  • Fuel oil (liters)
  • Chemicals (liters)
  • Water (cubic meters or liters)

​
Agricultural Products

  • Grain (tons)
  • Fertilizer (tons)
  • Seeds (kg or tons)

​
Common Workflows

​
Adding a New Material Type

1

Determine Material Details

Gather: Exact name, specifications, appropriate unit, initial availability.
2

Check for Duplicates

Search existing materials to ensure you’re not creating a duplicate.
3

Create Material Record

Add the material with complete information and accurate unit.
4

Verify in Shipments

Test by creating a shipment and confirming the material appears in the dropdown.

​
Managing Seasonal Materials

1

Mark as Available (In Season)

When material becomes available seasonally, set status to “Available”.
2

Create Shipments

Use the material in shipments during the available period.
3

Mark as Unavailable (Off Season)

When season ends, set status to “Unavailable” instead of deleting.
4

Reactivate Next Season

When season returns, change status back to “Available”.
This approach maintains historical shipment data while controlling when the material can be selected.

​
Best Practices

  • Include grade, type, or specification in the name
  • “Portland Cement - Grade 53” is better than just “Cement”
  • Makes material selection clearer during shipment creation
  • Reduces errors and confusion
  • Use the same unit for similar materials
  • Don’t mix units for the same material type
  • Document your unit standards
  • Train team on unit conventions
  • Update status regularly based on inventory
  • Don’t leave unavailable materials as “Available”
  • Review status weekly or monthly
  • Automate status updates if possible
  • Include specifications that matter
  • Note special handling requirements
  • Mention regulatory categories
  • Add supplier or source information
  • Change status to “Unavailable” instead of deleting
  • Preserves historical shipment data
  • Allows reactivation if needed
  • Maintains data integrity

​
Material Naming Conventions

Example naming structures: 
[Material Type] - [Grade/Specification]
Examples:
- "Cement - OPC Grade 53"
- "Coal - Steam Grade (GCV 5500)"
- "Iron Ore - 65% Fe Content"

[Material] - [Origin/Brand]
Examples:
- "Cement - UltraTech"
- "Steel - Tata"

[Category] - [Size/Dimension]
Examples:
- "Steel Bars - 12mm TMT"
- "Aggregates - 20mm"
Establish and document your naming convention, then train all team members to follow it consistently.

​
Mobile Responsiveness

The Materials interface works seamlessly across devices:
  • Desktop: Full table with all columns and full descriptions
  • Tablet: Optimized layout with essential columns
  • Mobile: Streamlined view showing Name, Status, and Actions
  • All create/edit functions available on all devices

​
Troubleshooting

​
Material Not Appearing in Shipment Dropdown?

1

Check Material Status

Only materials with status “Available” appear in shipment creation. Verify the status in the Materials table.
2

Verify Material Exists

Confirm the material was created successfully by checking the Materials page.
3

Refresh the Page

Sometimes a browser refresh is needed to update dropdowns with newly added materials.

​
Can’t Delete Material?

  • Material may be referenced by existing shipments
  • Check if the material is in use before deletion
  • Consider changing status to “Unavailable” instead
  • Contact support if deletion is critical

​
Wrong Unit Selected?

Changing the unit on an existing material affects how quantities in historical shipments are interpreted. This should be avoided if possible.
Better Approach:
  1. Create a new material with correct unit
  2. Set old material to “Unavailable” status
  3. Use new material going forward
  4. Keep old material for historical accuracy

​
Empty State

If no materials exist yet:
  • Centered message: “No materials found”
  • Add your first material button appears
  • Clicking the button opens the Add Material dialog
  • Helpful for initial system setup
Materials Empty State

​
Next Steps

Build docs developers (and LLMs) love

Get started for freeTalk to us