Help me understand how to use ConvertWebMapToArcGISProject!

Arne_Gelfert

In a separate post a while back, I was hoping to solicit some guidance on how to use the geoprocessing widget.  After some distractions, I'm now returning to this effort.

I have built a few functioning Python tool(boxe)s with ArcGIS Pro now. I understand how to interact with the map layout in Pro to programmatically create PDF of my map and modify the map for conversion to PDF. I am not completely sure how that related to what ESRI calls a "staged layout template." But that has to be similar to what I'm doing. First, I want to replace my aprx reference to a project file with one to a web map.

Memorable ESRI Quote #1

For advanced printing scenarios, you ...  can use the ConvertWebMapToMapDocument (for ArcMap) or ConvertWebMapToArcGISProject (for ArcGIS Pro) functions in the Python arcpy module.

So I am trying to leverage

arcpy<SPAN class="punctuation token">.</SPAN>mp<SPAN class="punctuation token">.</SPAN>ConvertWebMapToArcGISProject<SPAN class="punctuation token">(</SPAN><SPAN class="operator token"><</SPAN>webmap_as_json<SPAN class="operator token">></SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="operator token"><</SPAN>some_wonderful_pdf<SPAN class="operator token">></SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN></SPAN>

There is no simple way of generating some sample JSON describing your web map that you could use to test your script. So after publishing a script as a geoprocessing service that takes <webmap_as_json> as an argument, how do I pass the json ?

I can hook Web AppBuilder's Geoprocessing widget into my geoprocessing services but it's needing that JSON to feed on.

So I'm inclined to think I'm headed down the wrong path.

Questions:

1. Which widget, if any, can call geoprocessing services and pass along the JSON?
2. Is a "staged layout template" just a PAGX file sitting in a folder registered with my hosting server?

Arne_Gelfert

Doing a post-mortem on this before I forget....So I dropped my efforts to use the OTB GP widget, instead, I created a GP tool in ArcGIS Pro (using Python) and 

ConvertWebMapToArcGISProject

which allows you to create an in-memory APRX and then massage it to your heart's delight - iterate over maps or layers, choose a pre-configured template, and export that to PDF.

To consume that, I created a custom widget and in it, I did something like this:

 printFromJSON <SPAN class="punctuation token">:</SPAN> <SPAN class="keyword token">function</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">{</SPAN>
            
            <SPAN class="keyword token">var</SPAN> currentMap <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">this</SPAN><SPAN class="punctuation token">.</SPAN>map<SPAN class="punctuation token">;</SPAN>
            
            <SPAN class="keyword token">var</SPAN> printTask <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">PrintTask</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
            <SPAN class="keyword token">var</SPAN> params <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">PrintParameters</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
            params<SPAN class="punctuation token">.</SPAN>map <SPAN class="operator token">=</SPAN> currentMap<SPAN class="punctuation token">;</SPAN>
            
            <SPAN class="keyword token">var</SPAN> webMapAsJSON <SPAN class="operator token">=</SPAN> printTask<SPAN class="punctuation token">.</SPAN><SPAN class="token function">_getPrintDefinition</SPAN><SPAN class="punctuation token">(</SPAN>currentMap<SPAN class="punctuation token">,</SPAN> params<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
            <SPAN class="keyword token">var</SPAN> webMapAsJSONasString <SPAN class="operator token">=</SPAN> JSON<SPAN class="punctuation token">.</SPAN><SPAN class="token function">stringify</SPAN><SPAN class="punctuation token">(</SPAN>webMapAsJSON<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
            <SPAN class="keyword token">var</SPAN> file<SPAN class="punctuation token">;</SPAN>
            <SPAN class="keyword token">var</SPAN> gpParams <SPAN class="operator token">=</SPAN> <SPAN class="punctuation token">{</SPAN><SPAN class="string token">"Web_Map_as_JSON"</SPAN> <SPAN class="punctuation token">:</SPAN> webMapAsJSONasString<SPAN class="punctuation token">,</SPAN>
                             <SPAN class="string token">"PDFOutputFile"</SPAN> <SPAN class="punctuation token">:</SPAN> file<SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">;</SPAN>
            gp<SPAN class="punctuation token">.</SPAN><SPAN class="token function">submitJob</SPAN><SPAN class="punctuation token">(</SPAN>gpParams<SPAN class="punctuation token">,</SPAN> <SPAN class="keyword token">this</SPAN><SPAN class="punctuation token">.</SPAN>completeCallback<SPAN class="punctuation token">,</SPAN> <SPAN class="keyword token">this</SPAN><SPAN class="punctuation token">.</SPAN>statusCallback<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
            <SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">,</SPAN>

<SPAN class="comment token">//Note the "var file" in there‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍. It has to match any output parameters you've configured in your GP tool.‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>