nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Geoprocessing service to return a file

vtey_esriau

Hi,

How can I get a geoprocessing service to return a file?

I published a GP

<SPAN class="keyword token">if</SPAN> __name__ <SPAN class="operator token">==</SPAN> <SPAN class="string token">'__main__'</SPAN><SPAN class="punctuation token">:</SPAN>

    file <SPAN class="operator token">=</SPAN> open<SPAN class="punctuation token">(</SPAN>arcpy<SPAN class="punctuation token">.</SPAN>env<SPAN class="punctuation token">.</SPAN>scratchWorkspace<SPAN class="operator token">+</SPAN> <SPAN class="string token">"/"</SPAN> <SPAN class="operator token">+</SPAN> <SPAN class="string token">"test.txt"</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="string token">"w"</SPAN><SPAN class="punctuation token">)</SPAN>
    file<SPAN class="punctuation token">.</SPAN>write<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"why"</SPAN><SPAN class="punctuation token">)</SPAN>
    file<SPAN class="punctuation token">.</SPAN>close<SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
    arcpy<SPAN class="punctuation token">.</SPAN>SetParameter<SPAN class="punctuation token">(</SPAN><SPAN class="number token">0</SPAN><SPAN class="punctuation token">,</SPAN> file<SPAN class="punctuation token">.</SPAN>name<SPAN class="punctuation token">)</SPAN>‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

however i kept receiving the

 "value": "d:\\arcgisserver\\directories\\arcgisjobs\\script_gpserver\\j94a7e5b06f3342deb0ebcb65467f63fe\\scratch/test.txt"

I can see the file in the scratch folder but i need to return the file some how.

I did try to access the file via different permutation of

https://example.com/arcgis/rest/services/Script/GPServer/Script/jobs/j94a7e5b06f3342deb0ebcb65467f63fe/scratch/text.txt to no avail

Can someone kindly assist.

Vind meer berichten getagd met

Accepted answers

bharold

Victor, the team here notice your output data type is GPString, please change it to GPFile. it should then work.

All comments

bharold

H Doug, can you please open a support call. I know that sounds like a canned response but in this case we'll have to rope in geoprocessing team and they need something to track for their work. Thanks for reaching out.

dougbrowning

I know this is old @BruceHarold but on server 11.3 Scratch Workspace is not giving back the job dir from arcgisjobs dir. Instead it is giving and writing to AppData under the user name. This dir is not part of the cleanup schedule and it growing over time.

arcpy.AddMessage("Scratch Workspace " + arcpy.env.scratchWorkspace)

Scratch Workspace C:\Users\serveruser~1\AppData\Local\Temp\aim\speedtest_gpserver\j9b2d66b7a00d4a8696d2fe7973da3ba4\scratch

The post in here shows it should be my arcgisjobs dir right?

I am even seeing it create the jobs dir with a scratch folder in the arcgisjobs folder and even a scratch GDB but it does not use it. I can find no way in script to find this jobs dir either.

Why is it not using arcgisjobs as configured both in the GP tool and in the server settings?

thanks

LukasHoupt

This is super helpful. I couldn't for the life of me find documentation or other support indicating how to write a layer package or other file to an output parameter and how the server could send that back to the client. Even my ESRI support wasn't aware of this option and was suggesting my server save my output to a network folder. Thanks so much!

Marc_Alx

For further reader, here's a sample geoprocessing toolbox with a tool that returns a file.

Some notes

- Your parameter file must have a "direction" of "Output" and a "parameterType" of "Derived"

- The file type for geoprocessing parameter is "DEFile", for some reason "GPDataFile" results in no file being accessible to end user. Once published it appears as "GPDatafile"

- Result must be set via arcpy.setParameterAsText whereas setting "value" of a saved parameter does nothing.

- In order to be accessible you file must be wrote/saved to "arcpy.env.scratchFolder". Arcpy rewrite this path once published to an accessible URL.

- If you wish to backup your file outside of "arcpy.env.scratchFolder" you have to register the save location, from ArcGIS Pro: add any folder you need via: Share→Manage→Data stores, here add a new `folder` with `Publish folder path` set to the path you want to expose. Keep in mind that any hard coded path will be consolidated (to a sandbox path) on publish by ArcGIS.

Some useful links

- Authoring web tools with Python scripts (to understand path consolidation)

- Publish web tool

The code

# -*- coding: utf-8 -*-

import arcpy
from os.path import join

class Toolbox(object):
    def __init__(self):
        """Sample file toolbox"""
        self.label = "Sample file toolbox"
        self.alias = "File toolbox"

        # List of tool classes associated with this toolbox
        self.tools = [GetFileTool]

class GetFileTool(object):

    def __init__(self):
        """Define the tool (tool name is the name of the class)."""
        self.label = "Get file tool"
        self.description = "A tool to get a file"
        self.canRunInBackground = False

    def getParameterInfo(self):
        """Define parameter definitions"""
        return [arcpy.Parameter(displayName="Output_File",
                                name='Output_File',
                                datatype=['DEFile'],
                                parameterType='Derived',
                                direction='Output')]

    def isLicensed(self):
        """Set whether tool is licensed to execute."""
        return True

    def updateParameters(self, parameters):
        """Modify the values and properties of parameters before internal
        validation is performed.  This method is called whenever a parameter
        has been changed."""
        return

    def updateMessages(self, parameters):
        """Modify the messages created by internal validation for each tool
        parameter.  This method is called after internal validation."""
        return
    
    def exitWithError(self,msg):
        """
            exit geoprocessing with a given error msg
            under the hood it raise an exception, msg is logged as error
        """
        raise ValueError(msg)

    def execute(self, parameters, messages):
        """The source code of the tool."""
        p = join(arcpy.env.scratchFolder, "test.txt")
        with open(p, 'w') as f:
            f.write('hello')
        #set result with SetParameterAsText, setting result via 'value' parameter of objects inside parameters does nothing
        arcpy.SetParameterAsText(0,p)

vtey_esriau

Spot on, thank you so much , this is my first attempt working with publishing GP and trying to piece together how everything works together

bharold

Victor, the team here notice your output data type is GPString, please change it to GPFile. it should then work.

vtey_esriau

Thank you all for your help. It turns out I have been really silly.

I kept attempting to access the file via "arcgis/rest/services/

arcgis/rest/services/Script5/GPServer/Script/jobs/j24670b8fb4944b60993fa840472bc2f8/results/URL

where else the output of the directory is actually on arcgis/rest/directories/arcgisjobs

arcgis/rest/directories/arcgisjobs/script5_gpserver/j05515f60833c4e15a8d461f40acb1484

bharold

Superseded by my comment above but still useful! To answer your original question, to return your output file parameter (in Pro) wrap the web tool in a model and add the Copy geoprocessing tool to copy it into your project. The file has to be a supported type. Here is an example where the web tool is a Spatial ETL tool which I featured in my recent UC technical workshop on Data Interoperability extension. The experience of a web tool output going to a rather obscure profile directory is under review by geoprocessing team. Note: The intermediate scratchfile will be deleted when you exit Pro, this is also under review.

vtey_esriau

My apologies, I had so many tabs opened and I must have copy and paste from the wrong tab

txtFile <SPAN class="operator token">=</SPAN> os<SPAN class="punctuation token">.</SPAN>path<SPAN class="punctuation token">.</SPAN>join<SPAN class="punctuation token">(</SPAN>arcpy<SPAN class="punctuation token">.</SPAN>env<SPAN class="punctuation token">.</SPAN>scratchFolder<SPAN class="punctuation token">,</SPAN> <SPAN class="string token">"myTxt.txt"</SPAN><SPAN class="punctuation token">)</SPAN>
    f <SPAN class="operator token">=</SPAN> open<SPAN class="punctuation token">(</SPAN>txtFile<SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'w'</SPAN><SPAN class="punctuation token">)</SPAN>
    f<SPAN class="punctuation token">.</SPAN>writelines<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"huh"</SPAN><SPAN class="punctuation token">)</SPAN>
    f<SPAN class="punctuation token">.</SPAN>close
    arcpy<SPAN class="punctuation token">.</SPAN>SetParameterAsText<SPAN class="punctuation token">(</SPAN><SPAN class="number token">0</SPAN><SPAN class="punctuation token">,</SPAN> txtFile<SPAN class="punctuation token">)</SPAN>‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

vtey_esriau

I had rewritten the code several times

txtFile = os.path.join(arcpy.env.scratchFolder, "myTxt.txt")
f = open(txtFile, 'w')
f.writelines("huh")
f.close
arcpy.SetParameterAsText(0, txtFile)

One of them is as shown above, still the same .

I have arcgis enterprise installed locally, would that have made a difference?

danretired

j94a7e5b06f3342deb0ebcb65467f63fe

This number differs from the one in the your image... is that supposed to happen?

Egge-Jan_Pollé

Hi Victor Tey,

Why do you put a forward slash between the path and the file?

What happens if you replace this <SPAN class="">"/"</SPAN> with <SPAN class="">"\\"</SPAN>?

Does this solve your issue?

BR,

Egge-Jan

Doe mee aan het gesprek

Aangemelde leden kunnen berichten plaatsen, updates volgen en meer. Nieuw hier? Registreer een gratis account.

Snelle Links

Community Help
Find useful guides, FAQs, and documents to help you navigate and make the most of Esri Community.