Installation¶

Requirements¶

System Requirements¶

Odoo 17.0 or later
Python 3.10+
PostgreSQL 13+

Odoo Module Dependencies¶

Required:

project - Base project management
sale - Sales orders (for change orders)
purchase - Purchase order integration
account - Accounting and invoicing

Optional but Recommended:

hr_timesheet - Labor cost tracking
web_gantt - Enhanced Gantt charts (if not in Odoo Enterprise)
stock - Inventory management
portal - Customer portal access

Python Dependencies¶

No additional Python packages required beyond standard Odoo dependencies.

Installation Steps¶

Step 1: Add Module to Addons Path¶

Copy the atlas_construction directory to your Odoo addons path:

cp -r atlas_construction /path/to/odoo/addons/

Or symlink it:

ln -s /path/to/atlas-modules/atlas_construction /path/to/odoo/addons/

Restart the Odoo server:

sudo systemctl restart odoo

Or for development:

./odoo-bin -c /path/to/odoo.conf --stop-after-init
./odoo-bin -c /path/to/odoo.conf

Step 2: Update Apps List¶

Log into Odoo as an administrator
Navigate to Apps
Click Update Apps List
Click Update in the confirmation dialog

Note

You may need to activate Developer Mode to see the Update Apps List option: Settings → Activate Developer Mode

Step 3: Install the Module¶

In the Apps menu, search for “Atlas Construction”
Click Install on the “Atlas Construction Management” module

The installation process will:

Install dependencies automatically
Create database tables for construction models
Load default data (phases, categories)
Configure menu items
Set up security groups

Step 4: Verify Installation¶

Check that the Construction menu appears in the main menu bar
Navigate to Construction → Configuration → Phases
Verify default phases are loaded (Foundation, Framing, etc.)
Navigate to Construction → Configuration → Cost Categories
Verify default categories are loaded (Labor, Materials, etc.)

If you see these items, the module is correctly installed.

Initial Configuration¶

After installation, complete these configuration steps:

1. Security Groups¶

Assign users to appropriate security groups:

Navigate to Settings → Users & Companies → Users
Edit each user who will use the construction module
Assign security groups in the Job Costing section:
- User - Read-only access
- Manager - Full access (can edit budgets)
- Admin - System configuration

See Security & Permissions for detailed permission information.

2. Configure Phases¶

Review and customize construction phases:

Navigate to Construction → Configuration → Phases
Review the default phases
Add company-specific phases if needed
Set sequence numbers to control ordering

Default phases:

Site Work
Foundation
Framing
Rough-In
Insulation & Drywall
Finishes
Final / Punch List

See configuration/phases_categories for details.

3. Configure Cost Categories¶

Review and customize cost categories:

Navigate to Construction → Configuration → Cost Categories
Review the default categories
Add company-specific categories if needed

Default categories:

Labor
Materials
Subcontractors
Equipment
Other

4. Create Budget Templates (Optional)¶

Speed up project setup by creating reusable templates:

Navigate to Construction → Configuration → Budget Templates
Click Create
Define template name (e.g., “Single Family Home”)
Add template lines with percentages or default amounts

See configuration/templates for detailed instructions.

5. Configure Settings (Optional)¶

Navigate to Construction → Configuration → Settings
Configure:
- Mapbox Access Token (for project map view)
- Default Job Type
- Sequence Configuration

See configuration/settings for all available options.

Upgrading¶

From Previous Version¶

To upgrade the module:

Download the latest version of the module
Stop the Odoo server

Replace the module files:

rm -rf /path/to/odoo/addons/atlas_construction
cp -r new_atlas_construction /path/to/odoo/addons/atlas_construction

Restart Odoo in update mode:

./odoo-bin -c /path/to/odoo.conf -u atlas_construction

Verify the upgrade:
- Check Apps to confirm new version number
- Test key functionality
- Review changelog for breaking changes

Warning

Always backup your database before upgrading!

pg_dump your_database > backup_$(date +%Y%m%d).sql

Migration Notes¶

Upgrading from v16 to v17:

View mode changes: tree renamed to list
JavaScript framework updated to OWL
Security model enhancements
No data migration required

Upgrading from v15 to v17:

Major refactoring of cost tracking
Phases and categories now separate models
Budget templates completely rewritten
Data migration required - contact support

Uninstalling¶

Danger

Uninstalling the module will permanently delete all construction data including projects, budgets, change orders, and daily logs!

To uninstall:

Backup your database first!
Navigate to Apps
Search for “Atlas Construction”
Click Uninstall
Confirm the uninstallation

The system will:

Remove all construction-specific data
Keep base projects (converts construction jobs to standard projects)
Remove menu items
Deactivate security groups

Troubleshooting Installation¶

Module Not Appearing in Apps¶

Possible causes:

Module not in addons path
Apps list not updated
Permissions issue

Solutions:

Verify module location:

ls -la /path/to/odoo/addons/atlas_construction

Check Odoo configuration:
```
grep addons_path /path/to/odoo.conf
```
Update apps list:
- Apps → Update Apps List

Check file permissions:

chown -R odoo:odoo /path/to/odoo/addons/atlas_construction

Dependency Installation Fails¶

Error message:: “Could not install modules ‘atlas_construction’: Missing dependency: project”
Solution:: Install the missing dependency first:

Navigate to Apps
Search for the missing module (e.g., “project”)
Install it
Try installing atlas_construction again

Database Error During Installation¶

Error message:: “ProgrammingError: relation ‘atlas_job_cost_line’ already exists”
Cause:: Previous incomplete installation left database tables

Solution:

Uninstall the module completely (if partially installed)

Clean up database manually (if needed):

-- Connect to database
psql your_database

-- Drop module tables
DROP TABLE IF EXISTS atlas_job_cost_line CASCADE;
DROP TABLE IF EXISTS atlas_change_order CASCADE;
-- etc.

Reinstall the module

Post-Installation Checks¶

Verify Functionality¶

Create a test project to verify installation:

Navigate to Construction → Projects
Click Create
Fill in:
- Name: “Test Project”
- Customer: Select or create a customer
- Contract Amount: 100000
- Check Construction Job
Click Save
Navigate to Job Costing tab
Click Generate Budget from Template (if template exists)
Verify budget lines are created

If you can complete these steps successfully, the module is working correctly.

Check Security¶

Create a test user
Assign Job Cost User group (read-only)
Log in as test user
Verify:
- Can view projects
- Cannot edit budget lines
- Cannot delete projects
Assign Job Cost Manager group
Verify:
- Can edit budget lines
- Can create new lines
- Can manage project budgets

Check Integrations¶

Purchase Orders:
- Create a PO
- Link a line to a job cost line
- Verify committed cost updates
Sales Orders:
- Create a change order
- Approve it
- Verify sale order is created
Invoicing:
- Create a billing milestone
- Mark as ready to bill
- Generate invoice
- Verify invoice is created

Getting Help¶

If you encounter issues during installation:

Check this documentation first
Review the Troubleshooting guide
Check Odoo server logs:
```
tail -f /var/log/odoo/odoo.log
```
Enable debug mode for detailed error messages:
- Settings → Activate Developer Mode
- Attempt the failing operation again
- Review error details
Contact support with:
- Odoo version
- Module version
- Error message
- Steps to reproduce
- Server logs

Next Steps¶

After successful installation:

Security & Permissions - Configure user permissions
configuration/phases_categories - Set up phases and categories
configuration/templates - Create budget templates
Project Setup - Create your first construction project