Domus Organizer - User manual

Davide Tampellini

FabbricaBinaria.it

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found on-line a http://www.gnu.org/licenses/fdl.html.

September 2013

Abstract

This manual explains how to use the extension Domus Organizer for sites developed using Joomla!™.


Table of Contents

1. Preface
2. Installation
Minimum requirements
Download
Professional versions
Automatic updates
Configuration
Data configuration
Google Maps API key
3. Basic usage
Customer Management
Customer list
Single customer
Customer - General description
Customer - Requests
Customer - Properties
Properties management
Property list
Single property
Property - General description
Property - Details
Property - Automatic search
Property - Position
Property - Images
Property - Owners
Public area
Category list
Single category
Single property
Agenda
Monthly view
Weekly view
Daily view
Single appointment
Modules
Search Module
Carousel Module
Properties Module
Map Module
Custom module positions
Plugins
Energy class plugin
APE certification - Certificazione APE
Gestione avanzata e creazione in automatico del codice plugin
Creazione di un nuovo gruppo
Creazione dei nuovi campi aggiuntivi
Creazione di un campo per la visualizzazione dell'immagine
Social share buttons
Property ID generator
XMAP (sitemap generator) plugin
Support for integration plugins
Configuration options
Component params
General options
Gallery
Frontend
Permissions
Utility Functions
System tables
Categories
Types
Property properties
Element groups
Property elements
Element attributes
User profile
Agency profile
Customer groups
Room type
Customer source
Street type
Districts
Towns
Zones
Sub-zones
4. Advanced usage
Template system
Template management
Advanced template usage
Adding property fields
Adding a default value for the token
Refer one or more property fields from another one
Templates for e-mails
Advanced search
Setup multilanguage
Translate properties
Translate the other items
Google Calendar integration
Publish the integration plugin
Link agent profile to Google Calendar service
Share agenda events on Google Calendar
Print property PDF
Public area layout override
CSS and image override
Support for content plugin
Full ACL support
Basic ACL setup
Single agency
Single agency with different permissions
Single agency with different permissions and access levels
Advanced ACL setup
Multiple agencies, agents can only see the other ones records
Multiple agencies, agents can't see the other ones records
Import data
Standard import
CREA integration
Installation and configuration
Configure the access details
Configure the import
Configure property elements
Import data from CREA server
Manual import
Automated import
Custom print templates
Edit a print template
Create a template document (without images)
Create a template document (with images)
5. Developers' information
Token reference
Property tokens
Customer tokens
Agent tokens
Agency tokens
Developing custom plugins
"domusintegration" plugin event
Property events
onDomusIntegrationPropertyRead
onDomusIntegrationPropertyEdit
onDomusIntegrationPropertyBeforeSave
onDomusIntegrationPropertyAfterSave
Customer events
onDomusIntegrationCustomerRead
onDomusIntegrationCustomerEdit
onDomusIntegrationCustomerBeforeSave
onDomusIntegrationCustomerAfterSave
"domusimport" plugin events
onDomusImportGetName
onDomusImportShowform
onDomusImportRestore
onDomusImportExample

List of Figures

2.1. Consistency checks
2.2. Creating a new group for Domus Organizer
2.3. Creating a new access level for Domus Organizer
2.4. Creating a new menu entry for Domus Organizer
2.5. Domus Organizer permissions
2.6. Google Maps API Key: Create new project
2.7. Google Maps API Key: Set a name
2.8. Google Maps API Key: Enable the API
2.9. Google Maps API key: Create new API key
2.10. Google Maps API key: API type
2.11. Google Maps API key: API name
2.12. Google Maps API key: Copy the API key
3.1. Domus Organizer control panel
3.2. Customer list
3.3. Customer sections
3.4. Customer general info
3.5. Customer requests
3.6. Customer properties
3.7. Property list
3.8. Property sections
3.9. Property general info
3.10. Agents assigned to properties
3.11. Property details
3.12. Automatic search
3.13. Automatic search: results
3.14. Property position
3.15. Property images
3.16. Image watermark
3.17. Image beautifying
3.18. Property owners
3.19. Categories list: frontend layout
3.20. Categories view: menu params
3.21. Category view: frontend layout
3.22. Category list: menu params
3.23. Property view: frontend layout
3.24. Property view: menu params
3.25. Agenda
3.26. Agenda: Monthly view
3.27. Agenda: Weekly view
3.28. Agenda: Daily view
3.29. Agenda: Single appointment
3.30. Carousel module params
3.31. Properties module
3.32. Properties module params
3.33. Custom module positions: Categories view
3.34. Custom module positions: Category view
3.35. Custom module positions: Property view
3.36. Custom module positions: Contact view
3.37. Custom module positions: Search
3.38. Energy class plugin: Configuration params
3.39. Energy class plugin: with and without class values
3.40. APE Image
3.41. APE Group details
3.42. APE Field details
3.43. APE Fields in property view
3.44. APE Plugin field
3.45. APE Final result
3.46. Social share plugin: result example
3.47. Social share plugin: configuration options
3.48. Social share plugin: property metadata
3.49. Social share plugin: example of shared property
3.50. Generate ID: Plugin params
3.51. Component params: sections
3.52. Component params: general options
3.53. Component params: gallery options
3.54. Component params: frontend options
3.55. Component params: permissions
3.56. Utility functions
3.57. System tables: Categories
3.58. System tables: Types
3.59. Type details
3.60. Property properties
3.61. System tables: Elements groups
3.62. Element group detail
3.63. System tables: Property elements
3.64. Property element detail
3.65. Hidden elements
3.66. Hidden elements: property form view
3.67. System tables: Element attributes
3.68. System tables: User profile
3.69. System tables: Agency profile
3.70. Multiple agencies
3.71. Multiple agencies: property edit form view
3.72. System tables: Customer groups
3.73. System tables: Room type
3.74. System tables: Customer source
3.75. System tables: Street type
3.76. System tables: Districts
3.77. System tables: Towns
3.78. System tables: Zones
3.79. System tables: Sub-zones
4.1. Template edit page
4.2. Administrative view
4.3. Public view
4.4. Advanced search
4.5. Property translations
4.6. Property translations: edit form
4.7. Item translation
4.8. Google Calendar: Request authentication
4.9. Google Calendar: Permissions request
4.10. Google Calendar: Access and Refresh token fetched
4.11. Google Calendar: Authentication completed
4.12. Google Calendar: Choose user calendar
4.13. Support for content plugin
4.14. Scenario #2: Property form with publishing fields disabled
4.15. Scenario #2: Customers view without any edit permissions
4.16. Scenario #3: Property access level
4.17. Scenario #3: Senior agent property list
4.18. Scenario #3: Junior agent property list
4.19. Scenario #3: Edit access level
4.20. Agency permissions inside Domus Organizer
4.21. ACL Scenario #4: Property list for an agent of the first agency
4.22. ACL Scenario #4: Properties of other agencies are not editable
4.23. ACL Scenario #4: Properties of the same agency are full editable
4.24. Import data