topic Re: Running the Map to KML tool in Python Questions

Running the Map to KML tool

CoyPotts1 — Thu, 14 May 2015 19:00:46 GMT

I am trying to create a script that will apply a symbology layer to the current map, save the map, export the map to KML, and then reapply the original symbology from a layer file.

Apply symbology from layer file:

# Import system modules import arcpy from arcpy import env # Set the current workspace env.workspace = "file path where layer files are saved" # Set layer to apply symbology to inputLayer = "layer file name" # Set layer that output symbology will be based on symbologyLayer = "feature class within map" # Apply the symbology from the symbology layer to the input layer arcpy.ApplySymbologyFromLayer_management (inputLayer, symbologyLayer)

This part works fine.

Save the map:

# Set up map variable

import arcpy.mapping as map

# Set map variable to current mxd mxd = map.MapDocument("CURRENT")

# Save the map document mxd.save()

This part works fine.

Map to KML:

# Set environment settings

arcpy.env.workspace = "haven't figured this part out yet"

# Set Local Variables

dataFrame = 'Layers'

# Sets the KMZ name to be equal to the mxd

outKML = mxd+'.kmz'

#Execute MapToKML

arcpy.MapToKML_conversion(mxd, dataFrame, outKML)

This is the part that I'm having trouble with. I'm not entirely sure how to correctly construct the Map to KML portion. This script will be run on many different maps and the workspace for each map will be identical to each other with the exception of the map name. I tried to set the workspace to the following path, with no luck:

arcpy.env.workspace = "folder1\folder2\folder3\" + mxd + "\folder4\folder5"

But this results in this error "Parsing error SyntaxError: unexpected character after line continuation character (line 1)

Apply symbology from layer file:

Simply a repeat of the previous iteration of the tool with a different layer file.

Re: Running the Map to KML tool

CarlSunderman — Fri, 10 Dec 2021 23:24:13 GMT

You want the output set like that, not the workspace, i think?

and the mxd name should be passed as a string

output = "folder1/folder2/folder3/"
mxdname = "mystring"
arcpy.<whatever>(output + mxdname + "/folder4/folder5/";

Re: Running the Map to KML tool

CoyPotts1 — Thu, 14 May 2015 20:19:44 GMT

Okay, I sort of understand that. And yes, I was playing with other variations and I was getting the error saying that I couldn't mix a string and a map document, but I couldn't figure out how to translate my map document into a string like ymou do in your exaple.

I'm very green when it comes to Python scripting, so I'm not sure how to correctly answer your question regarding the workspace vs. output. The tool needs to have a workspace in order to know where to save the KML, correct? An alternative, and I think it's what you are showing above, is that you simply create the variables as you show, and then set outKML to equal the concatenation of those variables. So instead of saying save this output in this workspace, you're saying that the output KML equals the entire file path. Am I understanding that correctly?

In regards to the mxdname = "mystring", can you say mxdname = mxd? Or would that still have it be referencing a map document instead of turning it into a string. I'm just a little unclear on how to take my map document's name and add it into the whole folder path.

Re: Running the Map to KML tool

CoyPotts1 — Thu, 14 May 2015 20:25:32 GMT

An additional question...what IDLE do you use to get the numbered structure next to each line of your code? I have been using the python window within ArcMap just because that's all I know to use, but I don't really like it all that much.

And thank you so much for the response!

Re: Running the Map to KML tool

DarrenWiens2 — Fri, 10 Dec 2021 23:24:16 GMT

As far as I can tell, your main problem with:

arcpy.env.workspace = "folder1\folder2\folder3\" + mxd + "\folder4\folder5"

is ending your string with \" which translates to an escaped quotation mark, or literally the symbol ". That part of the string never closes. For paths, you should use r"path\path", or "path/path" or "path\\path".

Furthermore, the easy way to concatenate paths is by using os.path.join, which uses the system path separator to join path strings:

>>> import os.path
... first_concat = os.path.join(r"C:\folder1\folder2\folder3","someMapName")
... print first_concat
... second_concat = os.path.join(first_concat,r"folder4\folder5")
... print second_concat
... 
C:\folder1\folder2\folder3\someMapName
C:\folder1\folder2\folder3\someMapName\folder4\folder5

Re: Running the Map to KML tool

JeffWard — Thu, 14 May 2015 21:13:16 GMT

Here's how to post code snippets in GeoNet.

Re: Running the Map to KML tool

CoyPotts1 — Thu, 14 May 2015 21:33:18 GMT

Okay, that is also helpful. I'll go a little deeper into explanation. A sample file path is listed below (renaming the actual folder names for proprietary purposes):

\\company.local\dfs\dept_name\gis_folder\projects\region\region-state-name-carrier\deliverables

That is the full file path that I would be working with. We name the maps identically to the "region-state-name-carrier" naming convention (e.g. "NC-IL-MYHOUSE-VZW"). The mxd is saved at this stage of the file path. Once we create a KML output from the mxd, it is saved in the deliverables stage of the file path.

I thought that since all file paths are identical with the exception of the "region\region-state-name-carrier" portion, I could just make static variables for "\\company.local\dfs\dept_name\gis_folder\projects\" and "\deliverables", and use the map name as the dynamic variable that will change from project to project. Essentially I need to take the map name and convert it to a string. I would take that string and strip out only the first two characters to uses as my "region", and then I would use the whole string as my "region-state-name-carrier" portion. I'll list the potential variables below for a better understanding.

mapname = mxd

- I haven't figured out how to do this yet. This is where I want to turn my map name into a string.

region = mapname[:2]

- I haven't figured this part out either, but through google I found that this is one way to strip parts of a string apart, I but it wasn't working when tried.

filePath1 = r"\\company.local\dfs\dept_name\gis_folder\projects\"

filePath2 = r"\deliverables"

arcpy.env.workspace = filePath1 + region + mapname + filePath2

if that doesn't work I am brainstorming and thinking this might work for the workspace:

workspace = filePath1 + region + mapname + filePath2

arcpy.env.workspace = workspace

I'm only thinking of this because the arcpy.env.workspace function might not like concatenating the multiple variables...but I really don't know :/.

Thanks for your input so far!

Re: Running the Map to KML tool

CoyPotts1 — Thu, 14 May 2015 21:34:50 GMT

Thank you Jeff, I will note that for future reference.

Re: Running the Map to KML tool

JeffWard — Thu, 14 May 2015 21:57:43 GMT

How about:

mapname = str(mxd.filepath).split('\\')[-1:]

This gets the path of the map document, converts it to a string, splits it by the double backslash and puts the last element in mapname.

Edited to fix my hasty slicing error.

Re: Running the Map to KML tool

JeffWard — Thu, 14 May 2015 22:00:43 GMT

filePath1 = r"\\company.local\dfs\dept_name\gis_folder\projects\"

You need to take out the double backslash at the beginning of this if you are going to preface it with r.

Re: Running the Map to KML tool

CarlSunderman — Fri, 10 Dec 2021 23:24:19 GMT

As far as getting the file name, i'm not sure of a real elegant way, but i'm sure there is.

Perhaps you could use

import os

#os.path.split(path)
head, tail = os.path.split("C:/tmp/myfile.mxd")
#head, tail = os.path.split("//tmp/myfile.mxd)

>>>print tail
myfile.mxd

or something along those lines. then strip off the mxd.

this would work for "/" as well as "\"

Re: Running the Map to KML tool

JeffWard — Thu, 14 May 2015 22:11:57 GMT

After looking at this, this comes back as a single element list.

This might be better:

mapname = str(mxd.filepath).split('\\')[-1:][0][:-4]

Re: Running the Map to KML tool

CoyPotts1 — Fri, 10 Dec 2021 23:24:21 GMT

I haven't had much of an opportunity to test out the suggestions for pulling out the mxd name, but I have a script that runs all the way up to the MapToKML portion.

# Name:  Map To KML
# Description:  This script is used within a model to export the map to a KMZ file for distribution.
# Author:  Coy Potts
# Parts: (1) Apply Symbology Layer File, (2) Save mxd, (3) MapToKML tool, (4) Apply Symbology Layer File

# Import system modules
import arcpy
from arcpy import env
import arcpy.mapping as map

# Part 1:
# Apply Symbology Layer File

# Set current workspace
env.workspace = r'\\company.local\dfs\dept_name\1)folder\folder\layerFiles folder'

# Set layer to apply symbology to
inputLayer = r'\\company.local\dfs\dept_name\1)folder\folder\folder\layerFile.lyr'

# Set layer that output symbology will be based on
symbologyLayer = r'DataFrame\FeatureClass'

# Apply the symbology from the symbology layer to the input layer
arcpy.ApplySymbologyFromLayer_management (inputLayer, symbologyLayer)

# Part 2:
# Save the map

# Set the map document to the current map
mxd = map.MapDocument("CURRENT")

# Save the map
mxd.save()

# Part 3:
# Map to KML tool

# Set current workspace
env.workspace = '%saveKML%'

# Set local MapToKML tool variables
inputMap = mxd
outputKML = '%outputKML%' + '.kmz'

# Execute MapToKML
arcpy.MapToKML_converstion(inputMap, outputKML)

I went ahead and set the script up to grab two variables that are within a model builder model. The saveKML is the file path to be input by the user, and the outputKML is the name of the KML file, also input by the user.

Originally I set this script up in NotePad, saved as a .txt file, loaded into the ArcMap python window, saved as a .py script. From there I loaded it into a script inside my toolbox and then inserted that script within the model with the two variables. When doing it this way I got an error that said syntax error on line 2, but I couldn't figure out why. So I went and manually entered the entire script into the ArcMap python window piece by piece, and it was all working up to the point executing the MapToKML tool. Once I pressed enter after that line, it kicked back the following error:

"Runtime error

Traceback (most recent call last):

File "<string>", line 1, in <module>

File "c:\program files (x86)\arcgis\desktop10.3\arcpy\arcpy\conversion.py", line 2278, in MapToKML

raise e

RuntimeError: Object: Error in executing tool"

Everything up to that point ran just fine.

Re: Running the Map to KML tool

DarrenWiens2 — Fri, 15 May 2015 05:31:34 GMT

Don't know if this is the whole problem, but "conversion" is spelled wrong.

Re: Running the Map to KML tool

CoyPotts1 — Fri, 15 May 2015 05:59:22 GMT

Heh, I do have a t in there . I'll see tomorrow what I get when I take that out.

I think it's about time to give this a rest for tonight.

Re: Running the Map to KML tool

CoyPotts1 — Fri, 10 Dec 2021 23:24:24 GMT

arcpy.MapToKML_conversion(inputMap, outputKML)    
Runtime error 
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "c:\program files (x86)\arcgis\desktop10.3\arcpy\arcpy\conversion.py", line 2278, in MapToKML
    raise e
RuntimeError: Object: Error in executing tool

The "t" was only in the version that I had written in NotePad. The code above is what I had typed into the actual ArcMap Python window.

Re: Running the Map to KML tool

CarlSunderman — Fri, 15 May 2015 14:20:51 GMT

I normally hardcode values like inputs and outputs until i get everything working, then start adding the variables.

I would skip using model builder since you have all the python in the above comments to get it working. I personally have never used it

Re: Running the Map to KML tool

JeffWard — Fri, 15 May 2015 14:27:41 GMT

Unless it's a network path - doh!

Re: Running the Map to KML tool

JeffWard — Fri, 10 Dec 2021 23:24:27 GMT

Try using GetParameterAsText for your model variables inside your script. Python is interpreting '%saveKML%' as strings.

env.workspace = arcpy.GetParameterAsText('0')
outputKML = arcpy.GetParameterAsText('1') + '.kmz'

Re: Running the Map to KML tool

CoyPotts1 — Fri, 10 Dec 2021 23:24:30 GMT

I would like to get away from it, but it was the only way I could think of to add a dynamic variable that the user could change. I'm getting errors with the code suggestions above to try and strip the file path. I get the following error:

>>> import arcpy
>>> import arcpy.mapping as map
>>> mxd = map.MapDocument("CURRENT")
>>> mapname = str(mxd.filepath).split('\\')[-1:]
Runtime error 
Traceback (most recent call last):
  File "<string>", line 1, in <module>
AttributeError: 'MapDocument' object has no attribute 'filepath'
>>>

Just as you have suggested, I went ahead and gave literal values in place of the variables and I get the following:

... # Part 3:
... # Map to KML tool
... 
... # Set current workspace
... # env.workspace = "C:\Users\cpotts\Desktop\Test_Folders"
... 
... # Set local MapToKML variables
... inputMap = mxd
... outputKML = "output_test.kmz"
... 
... # Execute MapToKML
... arcpy.MapToKML_conversion(inputMap, outputKML)
... 
... 
... 
... 
Runtime error 
Traceback (most recent call last):
  File "<string>", line 46, in <module>
  File "c:\program files (x86)\arcgis\desktop10.3\arcpy\arcpy\conversion.py", line 2278, in MapToKML
    raise e
RuntimeError: Object: Error in executing tool

As per this LINK there are 10 conditions that are within the MapToKML tool, and I wonder if they're all required in order for the tool to run. If that is the case, hothw do you configure pyon to simply run with the defaulted value instead of having to set that parameter. When I run the tool manually, the data frame that it selects defaults to the only data frame in our map, which is again named identically to the map document, thus leading to the same issue as stated above where I still need to get the map name into a string so I can use it as a variable.

I suppose I could change our map template to have a static data frame name, which I could then hard code into the script since it would never change, but I don't want to do that unless I have to.

The image below shows the inputs that I use when I manually run the tool. I choose my mxd, it defaults to the only data frame in the map, I name the output file, and then I set the extent properties to match that of one of the feature classes. Every other input I leave as the default value.

Thanks again for all the help guys! I think we're getting closer to a solution . This is the first script that I have ever tried to construct to run ArcMap tools, so I'm definitely at the forefront of the beginners stage lol.