Configuration

Guide to all available configuration settings.

Introduction

Project settings are always configured by using a JSON configuration file in the project->public directory named build.json. This file contains a JSON object.

build.json example for Hotel

• For Hotel

{
  "name": "Hotel",
  "version": "1.0.0",
  "dependencies": {
    "online_booking_engine" : "1.0.0",
    "advance_deposit_report" : "1.0.0"
  },
  "settings": {
      "unit_name":{
         "singular": "room", 
         "plural" : "rooms" 
         },
      "unit_type_name" :  {
         "singular":"room type",
         "plural": "room types"
         },
         "hourly_booking_enabled" : true,
         "display_tooltip" : true
   }
}

build.json example Hostel

{
   "name": "Hostel",
   "version": "1.0.0",
   "dependencies": {
      "online_booking_engine" : "1.0.0",
      "todays_panel" : "1.0.0",
      "invoice_email" : "1.0.0"      
   },
   "settings": {
      "unit_name":{ 
         "singular": "bed", 
         "plural" : "beds" 
         },
      "unit_type_name" : {
         "singular":"room type",
         "plural": "room types"
         },
      "display_tooltip" : true,
      "hourly_booking_enabled" : true,
      "allow_free_bookings" : true,
      "force_room_selection" : true      
   }
}

build.json example for Vacation Rental

{
   "name": "Vacation Rental",
   "version": "1.0.0",
   "dependencies": {
      "online_booking_engine" : "1.0.0",
      "todays_panel" : "1.0.0",
      "invoice_email" : "1.0.0"      
   },
   "settings": {
      "unit_name":{ 
         "singular": "room",
         "plural" : "rooms" 
        },
      "unit_type_name" :  {
         "singular":"room type",
         "plural": "room types"
      },   
      "display_tooltip" : true,
      "hourly_booking_enabled" : true,
      "allow_free_bookings" : true,
      "force_room_selection" : true      
   }
}

build.json example for Apartment

{
   "name": "Apartment",
   "version": "1.0.0",
   "dependencies": {
      "todays_panel" : "1.0.0",
      "advance_deposit_report" : "1.0.0",
      "invoice_email" : "1.0.0"
   },
   "settings": {
      "unit_name":{ 
         "singular": "unit", 
         "plural" : "units" 
         },
      "unit_type_name" :  {
         "singular":"unit type",
         "plural": "unit types"
      },
      "send_invoice_email_automatically" : true,
      "display_tooltip" : true,
      "is_total_balance_include_forecast" : true
   }
}

build.json example for Car Rental

{
   "name": "Car Rental",
   "version": "1.0.0",
   "description": "",
   "dependencies": {
     "online_booking_engine" : "1.0.0",
   },
   "settings": {
      "unit_name":{ 
         "singular": "vehicle", 
         "plural" : "vehicles" 
         },
      "unit_type_name" :  {
         "singular":"vehicle type",
         "plural": "vehicle types"
         }
      },
      "allow_free_bookings" : false,
      "force_room_selection" : true,
      "is_total_balance_include_forecast" : true,
      "hourly_booking_enabled" : true      
   }   
}

build.json for exmaple Office Space

{
   "name": "Office Space",
   "version": "1.0.0",
   "dependencies": {
      "online_booking_engine" : "1.0.0",
      "advance_deposit_report" : "1.0.0",
      "automated_night_audit" : "1.0.0"
   },
   "settings": {
      "unit_name":{
         "singular": "room", 
         "plural" : "rooms" 
         },
      "unit_type_name" :  {
         "singular":"room type",
         "plural": "room types"
         },
         "hourly_booking_enabled" : true,
         "display_tooltip" : true
    }
  }

Here is the detailed description of each key.

Name

The name key holds the value of the property type. your business type will be the property type.

name: "hotel"

Version

The version is broken down into 4 points e.g 1.2.3.4 We use MAJOR.MINOR.FEATURE.PATCH to describe the version numbers.

version: "1.0.0"

Dependencies

This key has a JSON array of extensions that comes with this particular package. This JSON array has an extension name as a key and it's the version as value.

"dependencies": {
"online_booking_engine": "1.0.0"
}

Settings

This key has a JSON array of feature settings. This JSON array has feature name as key and true or false as value for activating or deactivating a particular feature, handles this application's default features settings. below we have provided a table of feature settings attribute.

"settings": {
      "unit_name":{
         "singular": "room", 
         "plural" : "rooms" 
         },
      "unit_type_name" :  {
         "singular":"room type",
         "plural": "room types"
         },
         "hourly_booking_enabled" : true,
         "display_tooltip" : true
   }

Attribute	Description	Type	Accepeted Values	Default
automatic_email_confirmation	Send a booking confirmation email to the customer automatically.	boolean	'true','false'	false
automatic_email_cancellation	Send a booking cancellation email to the customer automatically.	boolean	'true','false'	false
send_booking_notes	Send booking notes with a confirmation email.	boolean	'true','false'	false
additional_emails	Send a copy of the confirmation email and invoice email to the given mail address.	json array	{"send_copy_to_additional_emails" : true,"additional_company_emails" : "demo.minical@gmail.com"}, {"send_copy_to_additional_emails" : false ,"additional_company_emails" : "demo.minical@gmail.com"}	{"send_copy_to_additional_emails" : false ,"additional_company_emails" : "demo.minical@gmail.com"}
send_invoice_email_automatically	Send email to the customer automatically on checkout.	boolean	'true','false'	false
hide_room_name	Hide room name in email invoice.	boolean	'true','false'	false
display_tooltip	Show booking information on mouse hovers on a booking.	boolean	'true','false'	false
allow_guest_field_mandatory	Make the guest field required while creating new bookings.	boolean	'true','false'	false
include_cancelled_noshow_bookings	Show 'Total' with Cancelled/No show booking's charges/payments in Ledger summary report.	boolean	'true','false'	false
hourly_booking_enabled	Enable hourly booking system	boolean	'true','false'	false
allow_free_bookings	Allow room free bookings (If charge type is not set).	boolean	'true','false'	false
allow_booking_cancelled_with_balance	Allow bookings to be canceled with an outstanding balance.	boolean	'true','false'	false
restrict_booking_dates_modification	Restrict booking dates modification once customer checkout.	boolean	'true','false'	false
restrict_checkout_with_balance	Restrict bookings to checkout with balance.	boolean	'true','false'	false
auto_no_show	Set booking type to 'No show' automatically.	boolean	'true','false'	false
force_room_selection	Make room selection mandatory when creating bookings.	boolean	'true','false'	false
hide_forecast_charges	Hide forecast charges from invoice.	boolean	'true','false'	false
is_total_balance_include_forecast	Includes forecast charges on invioce.	boolean	'true','false'	false
show_guest_group_invoice	Show all guests on group invoice.	boolean	'true','false'	false
enable_new_calendar	Enable new calendar UI (with hourly calendar support).	boolean	'true','false'	false
unit_name	Unit name.	json array	{ "singular": "unit name singular such as room or bed", "plural" : "unit name plural such as rooms or beds" }	{ "singular": "room", "plural" : "rooms" }
unit_type_name	Unit type name.	json array	{ "singular": "unit type name singular such as room type or bed type", "plural" : "unit type name plural such as room types or bed types" }	{ "singular":"room type", "plural": "room types" }