RWS IDX Plugin Settings Print

  • 1

Preliminary WordPress Setup:

It is necessary to create five pages within WordPress to fully integrate the plugin. The pages will require a plugin specific shortcode in order to render the RWS API data within WordPress.


5 Required Pages:

  1. Listing Page: Required for displaying IDX listings.

  • Insert the [query_listing] shortcode

  1. Search Page: Required for displaying the search page.

  • Insert the [search_listings] shortcode or new [search_idx] shortcode

  1. Signup Page: Required for displaying the signup page.

  • Insert the [signupform] shortcode

  1. Login Page: Required for displaying the login page.

  • Insert the [loginform] shortcode

  1. Dashboard Page: Required for displaying the dashboard page.

  • Insert the [dashboard] shortcode


Enable “Post name” Permalinks:

After creating the new pages, it is necessary to enable Permalinks in the WordPress settings. Under Permalink Settings, select the “Post name”. It is impossible to use the RWS IDX Plugin with the Default Permalinks enabled (Example: http://yourdomain.com/?p=123). Other Permalink settings have not been tested.


It is recommended to review and save the plugin settings after the initial installation.


Main Setting Tab:

  1. Agent Id: Your agent MLS id is required in order to access your listings.  Agent Id provided after purchase

  2. RWS API KEY: Please enter your RWS API KEY. RWS API KEY provided after purchase

  3. RWS API SERVER: Enter the RWS API server address. RWS API server provided after purchase

  4. Listing Page: Enter the slug of the WordPress page for displaying IDX listings.

  5. Search Page: Enter the slug of the WordPress page for displaying the search page.

  6. Signup Page: Enter the slug of the WordPress page for displaying the signup page.

  7. Login Page: Enter the slug of the WordPress page for displaying the login page.

  8. Prospect Dashboard Page: Enter the slug of the WordPress page for displaying the prospect dashboard page.

  9. Enable Lead Capture: Enable the lead capture feature.

  10. Alternate Lead Capture Link: If lead capture is disabled, you can enter the url for your own lead capture page.

  11. MLS Disclaimer: This text will appear at the bottom of MLS Listings.

  12. Company Name: Enter the company name. Displayed on search page disclaimer.

  13. MLS Name: Enter the MLS name. Displayed on search page disclaimer.

  14. Listings Per Page: Enter the the number of listings per page. Numbers only.

  15. Sort Listings: Select default sort field. Leave blank to sort by most recent.

  16. Sort Order: Select default sort order.

  17. Filter Rentals: Choose to not display rentals from search results.

  18. Contact Form Spam Protection: Enable security image on contact form for added spam protection.

  19. Success Message: This text will appear after visitor successfully submits contact form.


Registration Setting Tab:

  1. Registration Form Spam Protection: Enable security image on registration form for added spam protection.

  2. Enable User Registration Prompt for Listing Detail Page: User will be prompted to register in order to view the listing details.

  3. Enable Custom Fields on Signup Page: Include custom fields on registration form.

  4. Redirect To Dashboard After Registration: Choose to redirect user to dashboard after submitting registration form.

  5. Listing Views Before Registration Prompt:Enter the number of listing views before registration prompt. Zero will display registration prompt on the first listing viewed.

  6. Reset Listing Views After Prompt: Reset the number of listing views after displaying registration prompt.



Map Setting Tab:

  1. Display Map with Search Results: Enable a map to display on the search results page.

  2. Display Map on Listing Detail Page: Enable a map to display on the listing detail page.

  3. Include Google Maps API Script: Include a Google Maps API Script. Disabling this may fix Google Maps compatibility with themes or plugins that already include Google Maps.

  4. Display Map Marker with Price: Enable a price label to display on each map marker.

  5. Map View:Choose to display Roadmap view or Satellite view.

  6. Map Zoom: Choose to zoom level for map view. Hint: A higher value will zoom closer.

  7. Map Width: Enter the map width in pixels or percent.

  8. Map Height: Enter the map height in pixels or percent.

  9. Custom Map Icon Directory: Enter the directory for your custom map icons. Example: http://yourdomain.com/wp-content/themes/themename/images/mapicons/

  10. Listing Map Info: Enter the template tags for the map info.

MAP INFO TEMPLATE TAG OPTIONS

1- {listing_title}

2- {listing_property_type_code}

3- {listing_prop_type_description}

4- {listing_county}

5- {listing_mls_area}

6- {listing_community}

7- {listing_subdivision}

8- {listing_unit_number}

9- {listing_street_type}

10- {listing_street_direction}

11- {listing_street_number}

12- {listing_street_name}

13- {listing_city}

14- {listing_state}

15- {listing_zip_code}

16- {listing_price}

17- {listing_mlsnum}


Tracking Setting Tab:

  1. Tracking API Server:Enter the website tracking id.

  2. Site Tracking ID:Enter the website tracking id.

  3. Tracking Token:Enter the tracking token.


Debug Setting Tab:

  1. Debug Mode: Enable Debug Mode.

  2. Debug mode must be first enabled in the rws_idx.php file located in the /rws_idx-lite/ directory. Change line 46 to define("rws_idx_DEBUG", true);



Cache Setting Tab:

  1. Cache Mode: Enable Cache Mode. Stores cached API queries within the plugin directory.

  2. Cache Time: Choose how long to keep local cache files. Default is daily.

  3. Clear Cache: Delete the local cache files.

  4. Enable Image Cache: Enable the plugin to use API Server cached images. This will improve listing's image loading. Most images are able to hotlinked to the IDX server. Caching the images on the api server will result in smaller images and reduce the webpage loading time. Some RETS servers do not allow hotlinking, therefore this setting must be enabled in order to access the listing images.

  5. Disable Resource Caching: Remove query string from resource URLs.


Advanced Setting Tab:

  1. Enable jQuery Legacy: Yes No

  2. Enable the jQuery Legacy plugin to add compatibility with older WordPress plugins and themes.

  3. Disable Plugin CSS: Disable the default plugin CSS file.

  4. Disable IP check for forms: Disable the security IP check on form submissions.

  5. Disable security token check for forms: Disable the security token check on form submissions. This will fix form submission compatibility with some themes.

  6. Enable custom filters: Yes No Enable custom filters for search results page.

  7. Disable sticky controls for search results page: Disable the sticky controls for search results page. This will fix controls for search results with some themes.

  8. Enable User Cookies: Enable user cookies for keeping visitors logged in beyond end of session.

  9. Cookie Expiration in Days: Enter the the number days before the user cookie will expire. Default is 120 days.

  10. Listing Title: Enter the template tags for the listing title. Listing title is also used for listing url rewrite.

LISTING TITLE TEMPLATE TAG OPTIONS

1- {listing_title}

2- {listing_property_type_code}

3- {listing_prop_type_description}

4- {listing_county}

5- {listing_mls_area}

6- {listing_community}

7- {listing_subdivision}

8- {listing_unit_number}

9- {listing_street_type}

10- {listing_street_direction}

11- {listing_street_number}

12- {listing_street_name}

13- {listing_city}

14- {listing_state}

15- {listi


Was this answer helpful?

« Back