Rightmove blm to XML convertor documentation

Available to buy now

https://fullworks.net/products/rightmove-blm-to-xml-converter/

What does plugin this do?

This plugin takes a Rightmove formatted .blm file and associated images files that you place on your server and converts it into a .xml file for onward processing (normally via the plugin WP All Import Pro ). The process runs automatically under wp-cron (see https://developer.wordpress.org/plugins/cron/ ) at the specified frequency and if the files are in place when the process runs it will process the files.

Install

Install the plugin in the normal way as plugin. Plugins > add Plugin > Upload and upload the rightmove-feed.zip, then activate the plugin.

 

Configure the plugin

There are not very many settings. However, you may want to set up your XML import process in WP All Import Pro first as you will need  the trigger URL.

 

1. Provide the file name  of your .blm file

2. Set the frequency that the plugin will check for a new file, this needs to be in WordPress cron format, e.g. hourly, twicedaily, daily

3. Wait time is the time to wait after the file has first been seen. This is because a copy of all the images to your server may take a long time, so it is best to wait a while before processing.

4. If you want to trigger an import via All Import Pro then you should enter the trigger url from your All Import Pro import cron scheduling page.

Then save your settings.

Transfer Files to your server

The plugin will have created a directory in your wp-content/uploads directory (assuming your permissions are correct).

Arrange for your .blm files and your associated image files to be transferred into the top level directory.

Important Note:   You need to ensure that all images associated with the blm file are on the local service in the rightmove directory.  If they are not, conversion will stop and not create an xml file.  The purpose of the ‘wait’ parameter is ensure that there is a long enough time that all your images are copied onto the server, just in case the blm file arrives right at a scheduled time and all the images are still being ftp’d. Set the time to the longest copy time plus more.

1. rightmove directory is where you place the incoming files

2. processed directory is where the files go to after the xml file is created. This enables you to copy the files back to ‘rightmove’ if for some reason you need to re-run the job.

Once the job has run the xml file is created as property.xml within the ‘processed’ directory.

 

 

Debug Mode

The plugin has extensive debugging built in.  This can be turned on by the normal WordPress debug settings. Adding the following to your wp-config.php

// Turns WordPress debugging on
define('WP_DEBUG', true);

// Tells WordPress to log everything to the /wp-content/debug.log file
define('WP_DEBUG_LOG', true);

// Doesn't force the PHP 'display_errors' variable to be on
define('WP_DEBUG_DISPLAY', false);

will result in output being written to /wp-content/debug.log  with output at a detailed level such as

[03-Mar-2015 11:18:20 UTC] Array
(
    [msg] => >>> Right Move options
    [0] => Array
        (
            [blm_filename] => 1234.blm
            [poll_time] => daily
            [wait_time] => 0
            [trigger_url] => http://wsl.locally.uk/wp-cron.php?import_key=vu-hU3x&import_id=1&action=trigger
        )

)

[03-Mar-2015 11:18:20 UTC] Array
(
    [msg] => >>> Right Move feed started path
    [uploadpath] => /home/dev/domains/wsl.locally.uk/public_html/wp-content/uploads
    [Filename] => 1234.blm
    [Wait seconds] => 0
)

[03-Mar-2015 11:18:20 UTC] Array
(
    [msg] => >>> file found
    [modtime] => 1423134416
    [now] => 1425381500
)

[03-Mar-2015 11:18:20 UTC] >>>>> Processing File
[03-Mar-2015 11:18:20 UTC] Array
(
    [Properties] => Array
        (
            [property] => Array
                (
                    [0] => Array
                        (
                            [AGENT_REF] => 1234_9
                            [ADDRESS_1] => 14 St John's Waterside
                            [ADDRESS_2] => Copse Road
                            [POSTCODE1] => GU21
                            [POSTCODE2] => 8EG
                            [FEATURE1] => Modern two bedroom flat
                            [FEATURE2] => Well appointed kitchen
                            [FEATURE3] => Family bathroom + en-suite
                            [FEATURE4] => Lounge with Juliet balcony
                            [FEATURE5] => Private location close to village
                            [FEATURE6] => Close to Basingtoke canal
                            [FEATURE7] => Allocated parking

 

 Triggering manually during development

Whilst the plugin is designed to run automatically, during development it may be convenient to request a manual run. The plugin doesn’t have this option, but this can easily be achieved by the WP Crontrol plugin (see https://wordpress.org/plugins/wp-crontrol/ ) and requesting the ‘process_rightmove_hook’ is ‘Run Now’.