# Administrator's Guide
# Dashboard
### Overview
Administration dashboard gives you an overview of all the activities you can do using the JomEstate extension. It provides you a view of all the menu items, system configuration checks, license information, and links to the documentation.

**Screen 1: Dashboard screen**
### Menu Items
The following table provides an explanation about different menu items available:
Dashboard
| Home or dashboard for the JomEstate extension
|
Address | Shows the Address administration screen |
Custom Fields
| Shows the Custom Fields administration screen
|
Categories
| Shows the Categories administration screen
|
Price Types | Shows the Price Types administration screen |
Property Types | Shows the Property Types administration screen |
Companies | Shows the Companies administration screen |
Agents | Shows the Agents administration screen |
Membership Plans
| Shows the Membership Plans administration screen
|
Messages
| Shows the messages received
|
Add New | Click to quickly add a listing to the site |
Documentation
| Access the JomEstate documentation.
|
### System Configuration Checks
Any configuration problems or current configuration status is displayed in this area as shown in the following screen:

**Screen 3: System configuration checks area**
# Address
{{@105}}
# Categories
{{@106}}
# Custom Fields
{{@107}}
#### JomEstate custom fields: Beds, Baths, Garage
For custom fields such as Bed, Bath, and Garage, icons are displayed alongside. To change the style css for these icons, edit the jomestate.css file located in the *components/com\_jomestate/assets/css* folder. These icons are only available for the single language. If the site is multilingual than additional suffixes are added, therefore additional styles needs to be created.
```css
.beds .jd-lab-horizontal-float-icon {background: url("../images/beds.png") 0 50% no-repeat;}
.baths .jd-lab-horizontal-float-icon {background: url("../images/baths.png") 0 50% no-repeat;}
.garage .jd-lab-horizontal-float-icon {background: url("../images/car.png") 0 50% no-repeat;}
```
####
# Property Types
### Overview
Property types allow the site owner to categorize property types into appropriate sections. Nested property types (sub-property types) are supported in JomEstate. JomEstate comes with a property type named "**UNCATEGORISED**" which is the default setting. This property type will list properties which are not attached to any property type (same function as the default Joomla categories system).
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/d9dobraz.png)**Screen 1: Property type listing**
### Creating A New Property Type
To add a Property type to JomEstate, click New.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/kDhobraz.png)

**Screen 2: Create a new property**
New Category tab
Provide the values as given in the following table.
**Title**
| Title for the Property Type.
|
**Alias**
| URL alias for “SEF/SEO” URL.
|
**Parent**
| Choose the parent category item.
|
**Text area**
| Provide a description in the text area.
|
**Toggle editor *Button*** | Click to toggle between rich text and plain text editor. |
**Article *Button*** | Click to select a relevant article. If an article is provided, it can be seen under the Details tab in the listing. |
**Image *Button*** | Click to select an image you want to add to the listing. |
**Category Image** | Currently not being used. |
#### Publishing tab
After you have provided the above information, you can provide the publishing information in the Publishing tab.
You can change the values for the given options using the following table.
**Status**
| Based on the status seen here, the visibility changes as follows:
- Published - Entries are visible on the front-end.
- Unpublished – Entries are invisible in the front-end, but can be published later.
- Archived – Older entries that are not ready for deletion yet.
- Trashed – Older entries that should be removed.
|
**Access**
| Access level for site users is as follows:
- Public access grant access to everybody.
- Registered access grants access only to registered and logged in users.
- Special access only grants access to users specified as “Special”.
|
**Language**
| Select the language for the property type.
|
**ID**
| Address ID, which can be used in modules, plugins and menus.
|
**Created by**
| User name who created the entry.
|
**Created Date**
| Date when the entry was created.
|
#### Metadata tab
The metadata tab is used to provide metadata information for a particular address entry.
You can change the values for the given options using the following table.
# Listings
## Overview
Properties are nothing but the product listings that you want to create in the JomEstate. Each listing is attached to a category. They are created in the same manner as Joomla articles, but are not related to Joomla articles in definition.
### Creating A New Listing
The following image shows the Listings screen.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-02/Yuzobraz.png)
**Screen 1: Properties screen**
The following table explains the different options seen on the screen.
New
| Creates a new Address entry. You must create separate entries for each level of depth that you need.
|
Edit
| Provides the edit mode to make changes to the existing level or titles created.
|
Publish
| Publishes the created address entry.
|
Unpublish
| Removes the entry from the list of published address entries
|
Archive
| Archives address entries that are not used anymore.
|
Trash
| Deletes the address entry that is not required anymore.
|
### Edit Listing
If you want to edit existing entries, you can either click the entry from the Listings screen or select the checkbox next to the entry, and then click Edit.
This tab provides options to add title, description, select category, and other options for the Listing as seen in the following image:
[](https://wiki.comdev.eu/uploads/images/gallery/2024-02/6ZDobraz.png)
**Screen 2: Edit Listing screen**
The following table shows the options available:
##### Edit Listing area
| Title
| Title for the Listing.
|
| Alias
| URL alias for “SEF/SEO” URL.
|
| Category
| Category where the listing will be published.
|
Property Type | Select the property type from the drop down. |
| Text Area
| Provide a description for the listing.
You can create a short description as well a long description.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/pv9obraz.png)

In the above image, the red dotted line appears when you click **Read More**. Any content above the red line is the **short description**, while the entire content is the **long description**. Also, note that if there is no content after the **Read More** tag, the event description will be blank when users view the listing. Ensure that you have content after the **Read More** tag. |
| Article *Button*
| Click to select a relevant article. If an article is provided, it can be seen under the Details tab in the listing.
|
| Page Break *Button*
| Insert a page break in the displayed text.
|
| Toggle editor *Button*
| Toggle between plain text and rich text editor
|
##### Address area
| Address
| Address of the listing
|
| Street, House No.
| Street and house number of the listing - If both Address and Full Address specified, map location will position automatically.
|
##### Location area
| Maps latitude
| It utilizes the GEO-location based on Google Maps.
Provide the latitude information for the location mapping.
|
| Maps longitude
| The information provided in this field is used to map the exact location. It utilizes the GEO-location based on Google Maps.
Provide the longitude information for the location mapping.
|
| Maps Search
| Search for a specific location. Type in the location and press Enter to go to the exact location.
|
##### Sidebar
| Featured
| Enable to make the listing appear as featured listing.
|
| Approved
| Enable to approve the listing. Listing will not be published.
|
| Language
| Select the language for which the listing needs to appear for. For [multiple languages](https://wiki.comdev.eu/display/JE/Multilingual+Site), you must create separate entries for each language.
|
| Status
| Select the required status.
- Published
- Unpublished
- Trashed
- Archived
|
| Created by
| Select the user who created the listing.
|
| Access
| Provide the access level for the listing.
- Guest
- Public
- Registered
- Special
|
| Date created
| Select the date when the listing was created. You can select a future date for publishing the listing as well.
|
| Publish Up
| Select a date when you want to publish the listing. Here too, you can schedule to post the listing at a future date.
|
| Publish down
| Select a date when the listing should stop being published.
|
| Modified Date
| Select a date when the listing was modified.
|
| ID
| This is an auto-generated field.
|
#### Understanding the Location area in Edit listing tab
Let us understand how to provide the address and Street/House No for providing the exact locations on the map. When you provide the address, street and House No. in the backend when creating listings, the location position automatically. If the House No. is not provided, additional location fields needs to be used.
##### Mapping using longitudes and latitudes
If you provide the latitudes and longitudes, and the Maps Search setting is left blank, the location mapping is done based on these parameters as shown in the following image.

**Screen 3: Map using longitudes and latitudes values**
##### Mapping with Map Search values
If the Map Search field has a value provided to it, it takes precedence as shown in the following image. If the Map Search field value is given as “New York”, the location will map to this location.


**Screen 4: Map using Map Search Field values**
#### Custom Fields tab
This tab includes all the custom fields created for a particular category. If the custom field is not applied to a specific category, it can be seen for all categories when creating a listing. The following image shows the Custom Fields tab screen.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-02/5O1obraz.png)
**Screen 5: Custom Fields tab**
For more information about creating custom fields, see [Custom Fields](https://wiki.comdev.eu/display/JE/Custom+Fields).
#### Price tab
This tab includes information about the pricing details related to the property listing.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-02/yplobraz.png)
**Screen 6: Price tab**
Provide the information as per the following table.
Add New | Click to add new pricing category. You can provide weekly, monthly, and other offers per listing.
|
Price Netto | Provide the pricing value. |
Price Group | Select from the following options:
- Price
- Price per day
- Price per week
- Price per month
- Auction
- Offers from
After installation, the price types are not defined. You should insert [your own](https://wiki.comdev.eu/display/JE/Price+Types), they will be populated in this drop-down field. When searching, price type always needs to be provided as part of the search criteria. |
#### Images tab
This tab includes information about images and videos attached to the listing. Before you can add images to the listing, you must save your listing at least once. This ensure that all the other data you have filled for the listing does not disappear after the images are added.
The Images tab can be seen as shown in the following image:
[](https://wiki.comdev.eu/uploads/images/gallery/2024-02/esbobraz.png)
**Screen 7: Images tab**
To set the the Order of the images, which one displayed first, drag and drop images to switch positions.
The first image in the gallery is used as the image thumbnail for the listing.
Provide the options as shown in the following table.
##### Images
| **Add file area**
| Add Files
| Click to select the image that needs to be uploaded.
|
| Drag & Drop Files Here
| Drag a bunch of images to this area to upload multiple images.
|
| Upload Into
| Select which category the image falls under:
- Slideshow - detailed view main gallery
- Gallery - in gallery tab
- Logo - displayed in sidebar under custom fields and over the image with transparency in listings page.
|
| Add available images & attachments
| Click to add already uploaded images and attachments to this listing.
|
**Images area**
| Editing an Image

| Click the  Edit icon to edit the image details. The options are as seen in the following image:

Click the  Delete icon to delete the image.
|
**Attachments area**
| | Click the  Edit icon to edit an attachment that is linked to the listing. The screen is as shown here:

Click the  Delete icon to delete the attachment.
Attachments are detected automatically based on file extension that’s are allowed in Configuration .
|
##### YouTube Video
| Provide the YouTube video URL in this field as shown in the following image.

|
---
#### Opeh House Calendar tab
This tab includes an ajax calendar where you can add the date-wise information related to the listing. Based on the services you offer, you can show the availability for that service.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/0ZKobraz.png)**Screen 8: Open House**
To set the availability for a range of dates, drag and click the required range of dates. Provide the information about availability as shown in the following image.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/tNEobraz.png)**Screen 9: Availability information**
Click Save to save the availability information. If you want to delete a particular entry, click the colored band of availability and click OK as shown in the following image.
# Price Types
### Overview
Price types allow the site owner to categorize price types into appropriate sections. Nested price types (sub-price types) are supported in JomEstate. JomEstate comes with a price type named "**UNCATEGORISED**" which is the default setting. This price type will list properties which are not attached to any price type (same function as the default Joomla categories system).
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/wCZobraz.png)**Screen 1: Price type listing**
### Creating A New Price Type
To add a Price type to JomEstate, click New.
Provide the values as given in the following table.
**Title**
| Title for the price type.
|
**Alias**
| URL alias for “SEF/SEO” URL.
|
**Parent**
| Choose the parent category item.
|
**Text area**
| Provide a description in the text area.
|
**Toggle editor *Button*** | Click to toggle between rich text and plain text editor. |
**Image *Button*** | Click to select an image you want to add to the listing. |
**Category Image** | Currently not being used. |
#### Publishing tab
After you have provided the above information, you can provide the publishing information in the Publishing tab
You can change the values for the given options using the following table.
**Status**
| Based on the status seen here, the visibility changes as follows:
- Published - Entries are visible on the front-end.
- Unpublished – Entries are invisible in the front-end, but can be published later.
- Archived – Older entries that are not ready for deletion yet.
- Trashed – Older entries that should be removed.
|
**Access**
| Access level for site users is as follows:
- Public access grant access to everybody.
- Registered access grants access only to registered and logged in users.
- Special access only grants access to users specified as “Special”.
|
**Language**
| Select the language for the price type.
|
**ID**
| Address ID, which can be used in modules, plugins and menus.
|
**Created by**
| User name who created the entry.
|
**Created Date**
| Date when the entry was created.
|
#### Metadata tab
The metadata tab is used to provide metadata information for a particular address entry. The options for this tab can be seen as shown in the following image.

**Screen 4: Metadata tab**
You can change the values for the given options using the following table.
# Companies
### Overview
JomEstate has a built in mechanism to create/control Real Estate Companies and Agents. Each Company can have unlimited Agents, however an Agent can join only one Company. The main difference between Agents and Company is that a Company can control Agents listings and Agents itself by adding or deleting them.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/dzjobraz.png)

**Screen 1: Companies listing**
##### Company Agents
Each Company or Agent needs to have an actual Joomla user-assigned to it:
- This user needs to be unique for each Company or Agent
- When adding an Agent from the Front Admin by the Company, Joomla user account needs to be created for that Agent
- Agent does **NOT** have any membership.The Agent inherits the membership details of the company he belongs to.
There are two user types in JomEstate:
- Public User who can add listings.
- Companies that have Agents.
### Creating a new Company
To add a Company to JomEstate, click New.
### Edit Company tab
This tab includes information such as company logo, address information, contact details and so on.
Provide the values using information given in the following table.
Options | **Usage** |
---|
**Name**
| Title for the Company.
|
---|
**Alias**
| URL alias for “SEF/SEO” URL.
|
---|
**Logo**
| Click to upload the company logo. This logo will be seen on the company tab on listings and item view.
|
---|
**Phone** | Provide the phone number for your company. |
---|
**Website** | Provide the website URL for your company. |
---|
**Background** | Set desired tab background color to match the Company logo. |
---|
**User**
| Select a Joomla user account that will be assigned to the Company. **It has to be unique for each Company**.
|
---|
**Membership**
| Choose a membership plan assigned for the Company.
|
---|
**Address**
| Select the appropriate locations to provide your address.
|
---|
**Street, House no.**
| Detailed address like street and house number. |
---|
**Intro text**
| Provide a short description about the company.
|
---|
**Text area** | Provide a description for the listing.
You can create a short description as well a long description.

|
---|
**Article *Button***
| Click to select a relevant article. If an article is provided, it can be seen under the Details tab in the listing.
|
---|
**Page Break *Button***
| Insert a page break in the displayed text.
|
---|
**Toggle editor *Button***
| Toggle between plain text and rich text editor
|
---|
**Read More** | Click to separate the short description in the text area.
In the above image, the red dotted line appears when you click **Read More**. Any content above the red line is the **short description**, while the entire content is the **long description**. Also, note that if there is no content after the **Read More** tag, the event description will be blank when users view the listing. Ensure that you have content after the **Read More** tag. |
---|
#### Images tab
This tab is used to add images to the company gallery
Provide the options as shown in the following table.
**Add Image** | Click to upload images to the company gallery. |
**Images area** | Click the  Edit icon to edit the image details. The options are as seen in the following image:

Click the  Delete icon to delete the image.
|
These images will be displayed under Company details page as shown in the following image.

# Agents
### Overview
Agents can function only if they are assigned to a Company and can have a different phone number, social contact configured, and so on. An agent inherits the membership plans possessed by the company it belongs to.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/8SIobraz.png)
**Screen 1: Agents listing**
### Creating a new Agent
To add an Agent to JomEstate, click New.
### Edit Agent area
This area includes information such as agent picture, company it belongs to, contact information and so on.
Provide the values using the information given in the following table.
Options | **Usage** |
---|
**First Name**
| First Name
|
---|
**Last Name** | Last Name |
---|
**Status** | Select from the following status:
- Published
- Unpublished
- Archived
- Trashed
|
---|
**Alias**
| URL alias for “SEF/SEO” URL.
|
---|
**Image**
| Upload a photo of the Agent.
|
---|
**Phone** | Provide the phone number of the agent. |
---|
**Website** | Provide the website URL of the company or agent's personalized page.
|
---|
**Fax** | Provide the fax number of the agent. |
---|
**User**
| Select a Joomla user account that will be assigned to the Agent. It has to be unique for each Agent.
|
---|
**Company** | Choose a Company that Agent belongs to. |
---|
**Address**
| Select the required address levels to create the address of the agent.
|
---|
**Street, House no.**
| Detailed address like street and house number. |
---|
**Text area**
| Provide a description for the listing.
You can create a short description as well a long description.

In the above image, the red dotted line appears when you click **Read More**. Any content above the red line is the **short description**, while the entire content is the **long description**. Also, note that if there is no content after the **Read More** tag, the event description will be blank when users view the listing. Ensure that you have content after the **Read More** tag. |
---|
**Article *Button***
| Click to select a relevant article. If an article is provided, it can be seen under the Details tab in the listing.
|
---|
**Page Break *Button***
| Insert a page break in the displayed text.
|
---|
**Toggle editor *Button***
| Toggle between plain text and rich text editor
|
---|
**Read More** | Click to separate the short description in the text area. |
---|
**MSN** | Provide the msn id of the agent. |
---|
**Google Talk** | Provide the google talk id of the agent. |
---|
**Skype** | Provide the skype id of the agent |
---|
**Twitter** | Provide the twitter handle of the agent. |
---|
**ID** | This field is auto-populated. |
---|
### Sorting Agents
To sort Agents, double click on second column and drag/drop to set ordering.
# Membership
{{@109}}
### Creating a new Group for Membership Plans
In order to add users to groups for membership plans, you must create a super group named JomEstate. Then, under it you must create groups for each of your membership plan. These groups are used to provide Group ID when creating a membership plan. Users created using User Manager can be linked to each of these membership plan groups.
To create the JomEstate group and other groups, do the following:
1. Click **Users** > **Groups** > **Add New Group**.
2. Provide a name for the group. We need to create JomEstate group before creating other groups. So, provide the name as **JomEstate**.

3. Repeat steps 1 and 2, but select the parent as JomEstate.

4. Click **Save**.
Name **JomEstate** for the main group is mandatory, however groups for membership under that group can have any names e.g. Lite, Pro or Free, Basic etc...
### User Permissions based on groups
For the users to access Front Admin certain user permissions need to be granted. These settings need to be done in the JomEstate and Comdev Options.
To provide user permissions for JomEstate, do the following:
1. Click **Components** > **JomEstate**
2. Click **Options** from the right-hand side of the screen.
3. Click **Permissions**.
4. Provide the permissions as shown in the following image.

5. Click **Save**.
User permissions also need to be set for Comdev extension as explained here.
1. Click **Components** > **Comdev**.
2. Click **Options** from the right-hand side of the screen.
3. Click **Comdev**.
4. Provide the permissions as shown in the following image.

5. Click **Save**.
Users, which belongs to Joomla group JomEstate, will now have access to Front Admin.
If Permissions for the Comdev component are not set, users would not be able to upload images. A 500 error would show that permissions are denied.
# Messages
{{@111}}
# Configuration
### Overview
The JomEstate extension can be configured using the options provided with it. You can control multiple factors such as SEO, Printing, Security, Image widths, and more using the options provided.
#### General tab
This tab controls the elements for Layout, SEO, Security, Contact, and Print options. The following image shows the options available on the General tab.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/A5Cobraz.png)

**Screen 1: General tab**
The following table explains the different options seen on the screen.
#### Media tab
This tab provides options to control display of media such as images or videos on the listing pages.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/6dAobraz.png)

**Screen 2: Media tab**
The following table explains the options seen on the screen.
#### Currency & Price tab
This tab provides options to control display of currency formats for listings.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/hpXobraz.png)
**Screen 3: Currency & Price tab**
The following table explains options seen on the screen.
#### Integrations tab
This tab provides options to control map integration for listings.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/EdGobraz.png)
**Screen 4: Integrations tab**
The following table explains the options seen on the screen.
#### Front Admin
This tab controls how the menu links are seen on the front admin for JomEstate. It also provides other options related to front admin.
[](https://wiki.comdev.eu/uploads/images/gallery/2024-03/51sobraz.png)
**Screen 5: Front Admin tab**
The following table explains the options seen on the screen.
#### Permissions
This tab provides options to control permissions for different groups.
For more information about how to configure permissions, see the Joomla documentation.