topic Re: ExecuteToolAsync not adding resulting layer to map. in ArcGIS Pro SDK Questions

ExecuteToolAsync not adding resulting layer to map.

JamalWest2 — Sun, 12 Dec 2021 09:48:08 GMT

I have created a tool with python that I am running from an add-in using Geoprocessing.ExecuteToolAsync. My code gets the (x,y) center of the current map extent and makes x,y event layer from that point. I then attempt to run arcpy.conversion.LayerToKML tool. What I am finding is that the layer I create never gets added to the map/project even though I have tried specifying "GPExecuteToolFlags.AddOutputsToMap" and "GPExecuteToolFlags.Default ", which both are supposed to add all resulting layers to the map. The LayerToKML tool doesn't work if the layer being used isn't added to the project. I can get the code to run and create the layer that I want and save it using SaveToLayerFile_mangement, but how do I get it to add to the map. I have looked at the documentation extensively and haven't found anything helpful. Also I know the LayerToKML tool works through the ExecuteToolAsync because I can run it by itself (commented out other code and ran on layer added to map after creating with 1st part of script).

var xE = middlePoint.X.ToString();
var yE = middlePoint.Y.ToString();

var parameters = Geoprocessing.MakeValueArray(xE, yE)
string tool_path = @"PATH\Jwtools.tbx\Script";


var progDlg = new ProgressDialog("Running Geoprocessing Tool", "Cancel", 100, true);
var progSrc = new CancelableProgressorSource(progDlg);
progDlg.Show();
var gp_result =  await Geoprocessing.ExecuteToolAsync(tool_path, parameters, null, new CancelableProgressorSource(progDlg).Progressor, GPExecuteToolFlags.AddOutputsToMap); 
Geoprocessing.ShowMessageBox(gp_result.Messages, "GP Messages", gp_result.IsFailed ? GPMessageBoxStyle.Error : GPMessageBoxStyle.Default);
progDlg.Hide();‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: ExecuteToolAsync not adding resulting layer to map.

NobbirAhmed — Wed, 18 Aug 2021 22:01:03 GMT

Could you please check what option is set in Pro App's Project > Options > Geoprocessing and make sure 'Add output datasets to an open map' is checked?

And which version of ArcGIS Pro you are on?

Re: ExecuteToolAsync not adding resulting layer to map.

MatthewDriscoll — Sun, 12 Dec 2021 09:48:11 GMT

"a" is the path to the new layer created from the execution of the tool.

await QueuedTask.Run(() =>
{
Map map = MapView.Active.Map;
LayerFactory.Instance.CreateLayer(new Uri(a), map);
});‍‍‍‍‍‍‍‍‍‍

Re: ExecuteToolAsync not adding resulting layer to map.

JamalWest2 — Fri, 02 Aug 2019 17:57:22 GMT

I shouldn't need to manually add the layer via sdk given that the ExecuteToolAsync is supposed to add the layer when it creates it. Using that means I have to generate the filename on the c#side or return it from my python tool. Do you know how to return it? In python I know how to generate unique file names, not in c# or the arcgis pro sdk.

Re: ExecuteToolAsync not adding resulting layer to map.

JamalWest2 — Fri, 02 Aug 2019 17:58:56 GMT

It also would mean I would have to create 2 separate python tools. One to create the layer, then use sdk code to ad it then execute a 2nd to run the process that I want.

Re: ExecuteToolAsync not adding resulting layer to map.

MatthewDriscoll — Fri, 02 Aug 2019 18:06:26 GMT

Jamal West wrote:
I shouldn't need to manually add the layer via sdk given that the ExecuteToolAsync is supposed to add the layer when it creates it. Using that means I have to generate the filename on the c#side or return it from my python tool. Do you know how to return it? In python I know how to generate unique file names, not in c# or the arcgis pro sdk.

Agreed! Just showing you the way I know how.

Yes I do think you can get the results from a python script over to the .NET, but the only way I personally would know how is if the python script is executed from the .NET solution. I think I have done this, let me take a look and think it over.

Re: ExecuteToolAsync not adding resulting layer to map.

JamalWest2 — Fri, 02 Aug 2019 18:22:52 GMT

I thought I responded to you already, but I guess it didn't post. Yes I am using the SDK to execute the python script. That's what the ExecuteToolAsync() does. I do not know how to get the results from the python script back to the SDK solution though. If you figure it out let me know please .

Re: ExecuteToolAsync not adding resulting layer to map.

MatthewDriscoll — Fri, 02 Aug 2019 18:23:35 GMT

Yes this would work and only be a couple additional lines of code.

Re: ExecuteToolAsync not adding resulting layer to map.

MatthewDriscoll — Fri, 02 Aug 2019 18:27:38 GMT

Do you not specify the path of the xy layer results in the python script or are you using in memory?

Re: ExecuteToolAsync not adding resulting layer to map.

JamalWest2 — Fri, 02 Aug 2019 18:30:13 GMT

I've tried both ways. Neither work. It only will work if that layer is added to the map.

Re: ExecuteToolAsync not adding resulting layer to map.

MatthewDriscoll — Fri, 02 Aug 2019 18:44:52 GMT

If you have the path of the resulting XY layer path you should be able to just get it from the path and not the Map.

From the Code samples:

out_Layer = "firestations_layer"

saved_Layer = r"c:\output\firestations.lyr"

Use arcpy.SaveToLayerFile_management(out_Layer, saved_Layer) when saving the XY layer.

Then use arcpy.env.workspace = r"c:\output\".

Finally use layers = arcpy.ListFiles("*.lyr*") to get the Parameter layer.

Re: ExecuteToolAsync not adding resulting layer to map.

JamalWest2 — Fri, 02 Aug 2019 18:50:16 GMT

Are you saying in order to send it back to .NET or in order to specify the path? I have used it to specify the path and file and it doesn't work. I'm not sure how to send that back to the SDK source and then parse it.

Re: ExecuteToolAsync not adding resulting layer to map.

MatthewDriscoll — Fri, 02 Aug 2019 18:55:23 GMT

You are trying to add multiple outputs from the python script into the map. The first is the XY event tool results, which you need to for the XML tool results. So if you want to do it that way you will need two run to different scritps in two different Tasks probably. The SDK ExecuteTool will wait for the script to completely run before adding any outputs, it probably cannot know to stop python after one tool is ran and add the output and then restart python until the next output of the next tool. So in this case yes you will need two scripts.

Re: ExecuteToolAsync not adding resulting layer to map.

MatthewDriscoll — Fri, 02 Aug 2019 18:58:41 GMT

I am saying execute both tools in the python script using paths. Then add what ever resulting data you want at the end in .NET using the method I gave you. With the SDK ExecuteTool I don't think you can add outputs in the middle of a python script and then start it back up where it left off. The ExecuteTool runs the entire python script and then adds the output.

Re: ExecuteToolAsync not adding resulting layer to map.

JamalWest2 — Fri, 02 Aug 2019 19:14:33 GMT

Might be what I have to do for now.

Re: ExecuteToolAsync not adding resulting layer to map.

MatthewDriscoll — Fri, 02 Aug 2019 19:23:21 GMT

You could also try adding the XY layer to the map with the python script using addLayer and then use the XML tool, if you do not want to use paths or two different scripts. I just don't think the ExecuteTool can add any outputs until the full python script has been executed. Good luck! I might be over thinking things and someone can correct me.

Re: ExecuteToolAsync not adding resulting layer to map.

NobbirAhmed — Wed, 22 Jul 2020 19:34:47 GMT

Before you do anything, first make sure the Geoprocessing options are set properly from Project menu.

From there, select Options > Geoprocessing and make sure to check mark 'Add Output datasets to an open ma' option -

.Net code cannot override if the option is not set.