Importer Add-on
- Sally L (Unlicensed)
REALTYNA - SALES DEPARTMENT
Last update: Dec 5th, 2019
Contents of this Manual are applicable to the WPL Importer Add-On. Details of this Manual may be different based on the customizations you have or your software.
Ā
Introduction
This manual contains information about the Importer add-on, an extension for WPL plugin.
Importer add-on is a powerful extension that enables real estate WordPress websites to import properties, images etc. from a CSV or XML file into their websites.
System Requirements
To use the Importer add-on you will need the following:Ā
WPL PRO. (Don't install any addon on WPL basic)
A CSV or XML file/feed to import.
Installation
If you have the installation package of the Importer add-on, you can easily upload it from the following path: WordPress->WPL dashboard->Install Add-on form.
Glossary
Below are a list of terms used throughout this manual and their meanings.Ā
Source: The XML, CSV etc. file that you want to import to WPL.
Mapping: For importing property data from the source file to WPL, you need to sync the source file data fields to WPL data fields. This is called mapping.
Sample data: Having sample data of the source file fields can help you to understand what the fields are, and you can map them to the correct fields of WPL.
Running Importer Add-on
After the installation, you should configure the Importer Add-on.
Adding Importer Structures
To add Structures please go to WPL->Importer Addon menu and click on "+" icon on top of page.Ā
Basic Options
Name: You can add your desired name.
Type: Select your source file format. You can choose between CSV, XML and Listhub (If you installed Listhub integration addon)
Sample file: Select your source file as a sample file. Importer add-on uses sample file for finding source fields and saving sample data.
Unique Field: Every property on source file must have a unique ID, you should find the name of unique id field in source fields and then place it here. In the CSV file you need to just insert the field name but in the XML or Listhub feeds, you should insert its name with complete path.
Image Count: the number of images for downloading. You can set it to -1 for unlimited images.
Re-download Images: If set to Yes, the property images will be re-downloaded on each update. Otherwise, no images will be updated after each update for the old properties.
Advanced Options
Property Node: Insert the name of property node.
Image Node: Insert the name of image node.
Import Profiles: This is for importing Listhub profiles. It doesn't have any use for XML or CSV source types.
Ā
Sync Options
Sync Status: If your source file is accessible by http(s) protocol and you want to enable the sync function, You can set this option to "enabled".
Sync Period: Period of each sync process.
URL: Insert URL of your feed file.
Username: Insert username of feed file if any.
Password: Insert password of feed file if any.
Paginated feed: some feeds are paginated like Zillow feeds. Set it to "Yes" if your feed is paginated as well.
Page parameter: insert name of page parameter. Generally it is "page".
Purge Status: If you want to purge, removed listings from the feed automatically, you can enable this option. Please be aware, Purge Period must be bigger than Sync Period.
Purge Period: Period of each purge process.
After filling in the form, click on save and refresh the page to see the added Structure.
Note: You can add as many Structures as you wish with different formatsĀ
Map with WPL
Click on the "Map listing fields" or "Map profile fields" (For Listhub integration addon) link or go to the WPL->Importer->Mappings to see the Mapping interface of WPL. Select Structure to see the source fields.
You can map the source fields one by one by clicking on "Map a field" on mapping column.
There is also a mass auto create field in the bottom of the mapping table. You can select some fields and then click on "Create All" button. You can even select type of field.
Important note: The mapping process is very important. Wrong or incomplete mapping can create serious numerous issues on your website.Ā
For example, if you map the source bedrooms field to a wrong field, the properties won't be able to find the bedrooms through WPL search widget. If a visitor looks for 2 bedroom properties, the WPL search widget will search in the WPL bedrooms field. It won't find the information it is looking for because the bedroom information of source properties is on another field.Ā
The same issue will happen for property listing/property show page. Depending on your theme, there are some fixed positions for showing some basic information about the property such as listing, property type, price, bedrooms, rooms, bathrooms, parking spaces, property location etc. So if you mapped the fields wrongly WPL will show 0, null or wrong information on your theme.Ā
So you must do the mapping very carefully. Note the following items during mapping:
Map the source fields to existing WPL fields.
Avoid creating new fields using "Auto Create" button unless there is actually no related field on WPL for those fields.
It's better if you don't map the fields which don't have any data on sample data. It can make your website messy with unnecessary information.
WPL's most important fields are: listing type, property type, price, price unit, price type (for rental properties), listing ID, bedrooms, bathrooms, rooms, view, property description, built up area, lot area, images, location information, property title (if exists). Map these fields with carefully.
Mapping some fields may need to be manually tailored based on customizations you may have on your WPL, other Addons, or the data structure of your source file.Ā
Import
You can click on the "Import" link after creating an import structure for manually importing the properties. After clicking on the "Import" link, you will be redirected to a new page. Fill the form and click on the "Start" link for starting the import process. It may take several minutes based on your server load.Ā
Don't refresh the page or navigate to other pages while it's importing the listings.
After uploading a file, you can see start link next to Structure name. Also you can select the user. All the source file listings will assign to this user as agent.
Auto Sync/Purge
As we mentioned in "Sync Options" section, you can automatically sync your feed with WPL. Your feed must be accessible by http(s) protocols in this case.
After configuring sync and purge options in WPL importer options you need to insert two cronjobs in your server for running sync functions these cronjobs should call index.php file of WordPress by passing ?importer_sync_cron_job=1 for sync and ?importer_purge_cron_job=1 for purge actions.
Sync: index.php?importer_sync_cron_job=1
Purge: index.php?importer_purge_cron_job=1
Note: If you don't like to enable purge option you can make it disable from WPL Importer and simply don't add purge cronjob.
Note: Adding cronjob is mandatory otherwise sync and purge options won't work. You can specify cron times during adding cronjobs as well.
Please note to WPL Sync/Purge periods as well. WPL won't run sync/purge actions if not enough time passed from previous run. For example if you set sync period in WPL to 24 hours but set the cronjob to run each 6 hours, WPL runs sync action only 1 time in each 4 cronjobs so please pay necessary attention to this option.
How purge action works?
You should set purge period time more than sync period time. For example, if your sync period time sets to 24 hours, purge period time should be set to 36 hours. It will purge all listings that were not found during the past 36 hours in the source feed.
Ā