Batch job configuration
Display the actual configuration:
When you create a batch job, a default configuration will be added, this can be changed by the following paramter.
To view the configuration settings for the batch job, you must call the action configure with the a request-Id or batch-job-name:
action=configure
Example:
https://maps1.locr.com/batch-processing/job_v2.php?action=configure&request_id=<RequestId>
Change the configuration:
To change the configuration use the following parameter.
Geocoding:
All addresses will be geocoded and a position (latitude/longitude) will be added to the database. In addition, each position is assigned an accuracy level, which is the quality feature of the addresses, i.e. how exactly the position matches the specified address.
There are 6 levels:
Depending on the given values only those addresses will be used for the project which have a higher quality value than the set one!
The default settings are postal code for customer addresses and house accuracy for destination addresses!
Bsp.:
https://batch.locr.com/job_v2.php?action=configure&request_id=<request_id>&min_customer_accuracy_to_use=<accuracy>&min_shop_accuracy_to_use=<accuracy>
<accuracy>-Werte: 10 (manual), 8 (house), 6 (street), 5 (postal), 4 (city)
Routing
Type of the route:
There are different types of routings that can be setted by routing_type. For example you can choose to use the fastest or the shortest route.
routing_type=<F/E/S/N/A/I/M/P>
Possible parameter:
F (fast) default
E (easy), S (short)
N (no freeways)
A (avoid freeways)
I (ignore pipes)
M (more freeways)
P (pedestrian)
Example:
https://maps1.locr.com/batch-processing/job_v2.php?action=configure&request_id=<RequestId>&routing_type=F
More Routes on NAVImaps (max. 5 routes): (default: 1)
Up to 5 routes can be drawn into NAVImaps.
routing_max_shops_count=<1-5>
Max. Distance: (default: ∞)
Specifying the max. Distance to the destination.
routing_max_shops_distance=<int>
Unit: (default: m)
Unit in which the distance is specified.
routing_max_shops_distance_unit=<m|km|mi|ft>
Design of maps
Size of maps
First the unit for maps must be specified, after that the size for the maps must be defined.
Map size:
map_size_width
map_size_height
Or in one Parameter:
map_size
Example: 21x14.8 (Width + Height)
Map unit:
map_size_unit
Possible parameter: px, cm (default), inch
Border:
map_border_left, map_border_right, map_border_top, map_border_bottom
Figure of the route (Color/width/transparency)
routing_color
Possible parameter: AQ, BK, BL, FU, GN, GR, LI, MR, NA, OL, PU, RD, SI, TE, WH, YE (default: BK)
routing_width
Possible parameter: 0-100 (default: 5)
routing_transparency
Possible parameter: 0,20,40,60,80
Icon selection (start/finish)
customer_icon_name [Icons Selection]
customer_icon_color
Possible parameter: AQ, BK, BL, FU, GN, GR, LI, MR, NA, OL, PU, RD, SI, TE, WH, YE (default: BK)
shop_icon_name [Icons Selection]
Example: pin1
shop_icon_color
Possible parameter: AQ, BK, BL, FU, GN, GR, LI, MR, NA, OL, PU, RD, SI, TE, WH, YE (default: BK)
shop_icon_type
Selects the correct icons, if the definition "shop_type " at the destinations addresses more than one icon has been defined..
Size of an icon (start/finish)
customer_icon_size=<value>
shop_icon_size=<value>
<value> can be an integer value that is adjusted relative to the map size. Default is "0"! Example: -2, 3, 5.
<value> can be a percentage value from 1% to 100%. Default is "100%"!
If a percentage value is passed, the % character must be url-encoded: Example for "90%" =>"90%25".
Bsp.:
https://maps1.locr.com/batch-processing/job_v2.php?request_id=<RequestId>&action=configure&shop_icon_name=flag1&shop_icon_color=BL&shop_icon_type=type2
Sample request for a configuration
<?xml version="1.0" encoding="utf-8"?>
<BatchProcessing>
<Response>
<MetaInfo>
<RequestId>4fec2eb23a16880b77000000</RequestId>
<Name>jobname</Name>
<Created>2012-06-01 12:00:00</Created>
</MetaInfo>
<Configuration>
<Geocoder>
<tolerance>normal</tolerance>
<min_accuracy/>
<postal_accuracy/>
</Geocoder>
<Router>
<type>F</type>
<color>BK</color>
<width>5</width>
</Router>
<Maps>
<config>1</config>
<size_width>14.8</size_width>
<size_height>10.5</size_height>
<size_unit>cm</size_unit>
<icons>
<customer>
<I>pin1</I>
<C>BL</C>
</customer>
<shop>
<I>button1</I>
<C>AQ</C>
</shop>
</icons>
<border>
<top>0.125</top>
<right>0.125</right>
<bottom>0.125</bottom>
<left>0.125</left>
</border>
</Maps>
</Configuration>
</Response>
</BatchProcessing>