SE Real Estate Documentation

Table of Contents

1. Requirements
2. Installation
3. Initial Setup
4. Configuration Reference
5. Managing Properties
6. Managing Agents
7. Managing Amenities
8. Import & Export
9. Saved Search Alerts
10. AI Property Chat
11. Featured Properties Module
12. Menu Items & Routing
13. Permissions
14. Uninstalling

1. Requirements

Note: SE Real Estate will refuse to install and display an error message if either the PHP or Joomla minimum version is not met.

2. Installation

1. Log in to your Joomla administrator panel.
2. Go to System → Install → Extensions.
3. Under the Upload Package File tab, drag and drop pkg_serealestate_v1_3_4_final.zip onto the upload area, or click Browse to select it.
4. Click Upload & Install.

Joomla will install the main component (com_serealestate) and the Featured Properties module (mod_serealestate_featured) in a single operation. A success message will confirm both are installed.

3. Initial Setup

After installation, navigate to Components → SE Real Estate. You will land on the Dashboard.

Load Demo Data

If you want to explore the component with sample content before entering your own listings, click Install Demo Data on the Dashboard. This populates the database with example properties, agents, and amenities so you can see how everything looks immediately. When you are ready to go live, click Remove Demo Data to delete it all cleanly.

Recommended first steps

1. Go to Components → SE Real Estate → Configuration and complete the Component tab (admin email, currency, map provider).
2. Create your agents under Agents before adding properties, so you can assign them at listing time.
3. Create your amenities under Amenities (pool, parking, gym, etc.) so they are available when editing properties.
4. Add your first property under Properties → New.
5. Create a Joomla menu item pointing to the Properties list view (see Menu Items & Routing).

4. Configuration Reference

Go to Components → SE Real Estate → Configuration (or via the top-right Options button in any SE Real Estate list view).

License tab

Component tab

Colours tab

Seven colour pickers let you match the component's front-end appearance to your site's design — primary, primary light, accent, accent hover, background, card background, text, muted text, and border. Changes take effect immediately without any CSS editing.

Listings tab

Emails tab

AI Chat tab

See Section 10 — AI Property Chat for full setup details.

5. Managing Properties

Go to Components → SE Real Estate → Properties.

Creating a property

Click New. The property edit form is split into tabs:

Details tab

Location tab

Media tab

Agent tab

Either select an existing agent from the dropdown (which auto-fills their name, email, and phone), or manually enter agent details for a one-off contact.

Filtering and sorting

The Properties list view includes filter dropdowns for Status, Type, City, and Agent, plus a search box for the title. Use the column headers to sort by title, price, status, city, or creation date.

Bulk actions

Tick the checkboxes next to multiple properties and use the Actions dropdown to publish, unpublish, or delete them in bulk.

6. Managing Agents

Go to Components → SE Real Estate → Agents.

Click New to create an agent. Fields: Name, Email, Phone, Photo (media picker), and Bio (rich text). Set Published to Yes for the agent to appear in the assignment dropdown when editing properties.

Agents can be reordered by dragging the ordering handle in the list view.

7. Managing Amenities

Go to Components → SE Real Estate → Amenities.

Amenities are labels attached to properties — e.g. Swimming Pool, Parking, Gym, Garden, Pet Friendly. Click New, enter a name, and save. Amenities appear as a multi-select checklist on the property edit form and are displayed as tags on the property detail page.

8. Import & Export

Go to Components → SE Real Estate → Import/Export.

Exporting properties

Click Export CSV to download all current properties as a spreadsheet-compatible CSV file. Useful for backups or bulk editing.

Downloading the template

Click Download Template to get a blank CSV with the correct column headers. Use this as the starting point for a bulk import.

Importing properties

1. Prepare your CSV using the template as a guide. Required columns include title, price, status, property_type. All other columns are optional.
2. Click Choose File, select your CSV, then click Import.
3. The importer will process each row and report how many records were created or skipped.

Tip: If you are migrating from another system, export your existing data into a spreadsheet, map the columns to match the template headers, save as CSV, and import.

9. Saved Search Alerts

Registered front-end users can save their search criteria (type, status, price range, location) and receive email notifications when new matching properties are published or when a saved property's price changes.

How it works

1. A logged-in visitor performs a search on the front end and clicks Save This Search, giving it a name.
2. When the cron job runs, it checks for new matching properties or price changes since the last run and sends an alert email to each subscriber.

Setting up the cron job

The alert system requires a scheduled task to run regularly. There are two methods:

Method 1 — Joomla CLI (recommended)

php /path/to/joomla/cli/joomla.php serealestate:alerts

Method 2 — Direct PHP

php /path/to/joomla/components/com_serealestate/cli/serealestate_alerts.php

Add whichever command suits your host to your server's cron tab. A frequency of every 15–60 minutes is typical. In cPanel, go to Cron Jobs and add a new entry. In a VPS/root environment, run crontab -e and add:

/30 * php /path/to/joomla/cli/joomla.php serealestate:alerts > /dev/null 2>&1

Replace /path/to/joomla with the absolute path to your Joomla installation root.

Customising alert emails

The subject line, greeting, and footer of alert emails are configurable under Configuration → Emails tab. See Section 4 for placeholder reference.

10. AI Property Chat

The AI chat widget places a conversational assistant on each property detail page. Visitors can ask questions in plain language — "Does this property have parking?", "What's the nearest school?" — and receive instant answers based on the property data and, optionally, local area information.

Setup

1. Go to Configuration → AI Chat tab.
2. Set AI Chat Enabled to Yes.
3. Choose your AI Provider: Anthropic (Claude), OpenAI (ChatGPT), Google Gemini, or DeepSeek.
4. Enter your API Key for the chosen provider. This key is stored in your Joomla configuration and is never exposed to front-end visitors.
5. Optionally specify a Model name if you want to use a specific version (e.g. claude-sonnet-4-20250514). Leave blank to use the provider's default.
6. Set the Chat Position (bottom-left or bottom-right of the property page).
7. Save.

Getting API keys

Testing

After saving your configuration, open any published property on the front end. A chat button should appear in the configured corner. Type a question to confirm the API connection is working. If there is an error, re-check the API key and ensure your server can make outbound HTTPS requests.

11. Featured Properties Module

mod_serealestate_featured displays a grid of featured listings and can be placed in any Joomla module position.

Publishing the module

1. Go to System → Site Modules.
2. Find SE Real Estate — Featured Properties in the list (or click New and select it from the type list).
3. Set a Title, choose a Position, and set Status to Published.
4. Configure the parameters (see below).
5. Under the Menu Assignment tab, choose which pages the module appears on.
6. Save.

Module parameters

12. Menu Items & Routing

To expose SE Real Estate on your site you need at least one Joomla menu item.

1. Go to Menus → [your menu] → Add New Menu Item.
2. Click Select next to Menu Item Type and choose SE Real Estate from the list.

Available menu item types:

For clean SEF URLs, ensure System → Global Configuration → SEO Settings → Search Engine Friendly URLs is set to Yes.

13. Permissions

SE Real Estate respects Joomla's standard ACL. Go to Configuration → Permissions tab to configure per-user-group access.

14. Uninstalling

1. Go to System → Manage → Extensions.
2. Search for serealestate.
3. Tick the checkbox next to SE Real Estate Package (pkg_serealestate).
4. Click Uninstall.

Joomla will remove the component, the module, all language files, and all database tables created by SE Real Estate. This action is irreversible — back up your database first if you want to preserve your property data.

SE Real Estate v1.3.4 — © 2026 SE Real Estate — GNU General Public License v2 or later