Batch job

Introduction

With the batch-jobs it is possible to generate a huge number of maps, without a permanent connection to the map server. The geocoding of the addresses, the routing to a target and the creation of the maps is done in parallelisation to speed up the generation process. So the batch jobs are useful for a large number of addresses.
The batch job can generates two types of maps: the locr NAVImaps (route map) and the locr LOCALmaps (surroundings map). To generate LOCALmaps you must have one address-list (customer), while for the NAVImaps you must have 2 address-lists (customer/shops) with the start and target points.


Conditions 

To use the locr batch job,  there must be 2 conditions satisfied.

1. You need a username and a password to get access to the batch-job.
  • The access data you get directly from locr or from your map partner.
  • To connect with the locr map server it is necessary to make an authentification, more information here:
    Authentification
2. And the map server URL, z.B.: http://maps1.locr.com

Start a batch job
To generate maps with a batch-job you have 3 steps to go: 

Create a batch-job and import address data

To generate a new batch-job it is essential to upload the address-files. This will be made by a POST-Request with enctype "multipart/form-data" and the action init
Example:
https://maps1.locr.com/batch-processing/job.php?action=init&name=<jobname>

Every batch-job will be generated with a default configuration, that can be changed later, but so it possible to go to the next step.

Batch-job start:

To start a batch-job use the action start.
https://maps1.locr.com/batch-processing/job.php?action=start&name=<jobname>&to_dos=geocoding,routing
(Mehr)

Batch-job download data:  

After the execution of batch-job the data can be downloaded with the action download.
https://maps1.locr.com/batch-processing/job.php?action=download&request_id=<RequestId>
(Mehr)

More functions:

Batch-job change configuration

To change the configuration of a batch job use the action configure with the required parameter.
https://maps1.locr.com/batch-processing/job.php?action=configure&request_id=<RequestId>
(Mehr)

State of the batch-job:

With the action status it is possible to monitoring the batch-job process:
https://maps1.locr.com/batch-processing/status.php?action=status&name=<jobname>&to_dos=geocoding

Cancel a batch-job:

For canceling a batch-job use the action cancel
https://maps1.locr.com/batch-processing/job.php?action=cancel&name=<jobname>

Reset batch-job:

To restart a batch process from different steps use the action reset, with a parameter for the step.
https://maps1.locr.com/batch-processing/job.php?action=reset&name=<jobname>&to_dos=geocoding,routing,map_creation

Remove batch-job:

With the action remove it is possible to remove the batch-job.
https://maps1.locr.com/batch-processing/job.php?action=remove&name=<jobname>