Quick Start Guide

Get started with iDempiere in minutes - from first login to your first business transaction

This guide will get you from zero to your first business transaction in iDempiere quickly. Choose the path that works best for you.

Option 1: Try the Cloud Test Site (Fastest)

The fastest way to experience iDempiere is through our live cloud test sites - no installation required!

1. Access the Test Site

   Visit the iDempiere Test Sites and select a server.

   Test sites are reset regularly and come pre-loaded with GardenWorld demo data.

2. Log In

   Use these default credentials:

   • Username: GardenAdmin
   • Password: GardenAdmin
   • Client: GardenWorld
   • Organization: HQ
   • Warehouse: HQ Warehouse
   • Language: English

   Click OK to proceed to the dashboard.

3. Explore the Dashboard

   After login, you’ll see the iDempiere dashboard with:

   • Menu - Access all business functions
   • Activities - Recent and favorite items
   • Performance Indicators - Key business metrics
   • Running Jobs - Background processes
   • Calendar - Scheduled activities

   Use the search box in the menu to quickly find any window or process.

Option 2: Local Installation

For a persistent environment with full control, install iDempiere locally.

You’ll need Java 17+ and PostgreSQL 12+ (or Oracle 19c+) installed first.

1. Download iDempiere

   Get the latest stable release:

   # Download from the official repository
   wget https://sourceforge.net/projects/idempiere/files/latest/download
   

   Or visit iDempiere Downloads for the latest version.

2. Extract and Setup

   # Extract the archive
   unzip idempiere-server-*.zip
   cd idempiere-server
   
   # Make setup script executable
   chmod +x setup.sh
   
   # Run setup wizard
   ./setup.sh
   
3. Configure Database Connection

   The setup wizard will prompt for:

   • Database Type: PostgreSQL or Oracle
   • Database Host: localhost (or your database server)
   • Database Port: 5432 (PostgreSQL) or 1521 (Oracle)
   • Database Name: Name of your database
   • Database User: Username with appropriate permissions
   • Database Password: Database user password
   • System Password: Admin password for iDempiere
4. Initialize the Database

   Import the seed database with GardenWorld demo data:

   # For PostgreSQL
   cd utils.unix
   ./RUN_ImportIdempiere.sh
   

   This creates the database schema and loads sample data.

5. Start iDempiere

   # Return to main directory
   cd ..
   
   # Start the server
   ./idempiere-server.sh
   

   Wait for the message: iDempiere Server started successfully

6. Access the Web Interface

   Open your browser and navigate to:

   http://localhost:8080/webui
   

   Login with the same credentials as the cloud test site.

For detailed installation instructions, including Windows setup and advanced configuration, see the Installation Guide.

Your First Business Workflow

Once logged in, try creating your first sales order to understand the core workflow.

1. Navigate to Sales Order

   • Click the Menu button (hamburger icon)
   • Search for “Sales Order” or navigate to:
     • Sales Order Management → Sales Order
   • Click to open the Sales Order window
2. Create a New Order

   Click the New Record button (document icon with plus sign)

   The system will:

   • Auto-generate a document number
   • Set today’s date as order date
   • Default to your organization
3. Select a Customer

   In the Business Partner field:

   1. Click the magnifying glass icon to search
   2. Select a customer (e.g., “C&W Construction”)
   3. The system auto-fills:
      • Bill-to and Ship-to addresses
      • Price list
      • Payment terms
      • Salesperson
4. Add Order Lines

   Switch to the Order Line tab at the bottom:

   1. Click New Record to add a line
   2. Select a Product (e.g., “Azalea Bush”)
   3. Enter Quantity (e.g., 10)
   4. The system automatically:
      • Fills in the unit price from the price list
      • Calculates line total
      • Checks inventory availability

   Add more lines as needed.

5. Review and Complete

   Return to the Order tab (header):

   1. Review the Grand Total (includes taxes)
   2. Click the Process button (gear icon)
   3. Select Complete from the Document Action dropdown
   4. Click OK

   Completing the order:

   • Locks the document from editing
   • Reserves inventory
   • Updates accounting
   • Enables shipment and invoice creation
6. View the Completed Order

   The order status changes to Completed. You can now:

   • Generate Shipment: Create a material shipment
   • Create Invoice: Generate a customer invoice
   • Print: Generate PDF of the order
   • Copy: Create a new order from this one

Essential Navigation Tips

Master these shortcuts to navigate iDempiere efficiently:

Keyboard Shortcuts

Shortcut	Action
Alt + N	New record
Alt + S	Save record
Alt + D	Delete record
Alt + F	Find/Search
Alt + P	Process/Complete document
Alt + R	Refresh
F1	Help for current field

Window Navigation

• Tabs: Use tabs at the bottom to navigate between header and detail records (e.g., Order → Order Lines)
• Navigation buttons: First, Previous, Next, Last, Parent records
• Search: Magnifying glass icon opens lookup windows
• Multi-tab: Hold Ctrl while clicking menu items to open multiple windows

Common Patterns

Master-Detail Pattern

Most transaction windows use a master-detail pattern:

• Header Tab: Main document (Order, Invoice, Payment)
• Line Tabs: Detail items (Order Lines, Invoice Lines)
• Info Tabs: Additional information (Taxes, Confirmations)

Always save the header before adding lines.

Document Processing

Business documents follow a standard lifecycle:

1. Drafted - In progress, can be edited
2. Completed - Finalized, posted to accounting
3. Closed - Fully processed (shipped, invoiced, paid)
4. Voided - Cancelled with reversal

Use the Process button (gear icon) to change document status.

Field Context Help

Hover over any field label to see a tooltip. Press F1 for detailed help about:

• Field purpose and usage
• Valid values and constraints
• Related fields and dependencies

Next Steps

Now that you’ve completed your first order, explore these areas:

Complete the Order-to-Cash Cycle

Create a shipment from your order, then generate an invoice, and finally record payment.

Set Up Your Organization

Configure your company information, warehouses, users, and roles in System Admin.

Explore Reporting

Run reports to analyze sales, inventory levels, and financial performance.

Configure Business Rules

Set up price lists, payment terms, tax categories, and workflow automation.

Getting Help

As you explore iDempiere:

• In-app Help: Press F1 on any field for context-sensitive help
• Wiki: Browse wiki.idempiere.org for detailed guides
• Forum: Ask questions at Google Groups
• Chat: Join real-time discussions on Mattermost

The GardenWorld demo data includes complete examples of customers, products, vendors, and transactions - perfect for learning!