topic Re: ERROR 001242 when calling arcpy.CreateGPSDDraft with result from .pyt toolbox in ArcGIS Enterprise Questions

ERROR 001242 when calling arcpy.CreateGPSDDraft with result from .pyt toolbox

CharlesArnold — Wed, 19 Feb 2014 20:47:02 GMT

I am unable to successfully call arcpy.CreateGPSDDraft with a result object from a tool that's defined in a python toolbox.

I always get the following error:

rl = [tool() for tool in tools] # calls each tool and stores the result objects in "rl"
    arcpy.CreateGPSDDraft(rl, r'S:\source\git\testpyt\test_gp_create.sddraft', 'test_gp')
    Out[4]:
    {'errors': {(u'ERROR 001242: Tool test1 is missing item description summary',
       80): [],
      (u'ERROR 001242: Tool test2 is missing item description summary', 80): [],
      (u'ERROR 001242: Tool test3 is missing item description summary',
       80): [], ..

Anyone had any success with this?

Re: ERROR 001242 when calling arcpy.CreateGPSDDraft with result from .pyt toolbox

NidhinKarthikeyan — Thu, 20 Feb 2014 10:06:19 GMT

Tool Error: 001242 states that, the task is missing the required summary in the Item Description. Provide a summary in Item Description.

Re: ERROR 001242 when calling arcpy.CreateGPSDDraft with result from .pyt toolbox

CharlesArnold — Thu, 20 Feb 2014 17:18:46 GMT

Tool Error: 001242 states that, the task is missing the required summary in the Item Description. Provide a summary in Item Description.

I understand the error message; when I'm publishing from within ArcMap, I can simply double click the error message and provide the description. I want to create a script that will create the .sd file from the .pyt file without me having to do a bunch of repetitive clicking around in the UI. I assume that's what the arcpy.CreateGPSDDraft function is for, but I haven't been able to get it to work with a .pyt toolbox.

Re: ERROR 001242 when calling arcpy.CreateGPSDDraft with result from .pyt toolbox

KevinHibma — Mon, 24 Feb 2014 13:23:45 GMT

These values must be filled in on the Item Description page from within ArcMap or ArcCatalog:
http://resources.arcgis.com/en/help/main/10.1/index.html#/Documenting_a_tool_in_a_Python_toolbox/00150000003n000000/

We haven't got much push or request to implement a 100% python solution for doc'ing Python Toolboxes. You could post an idea on http://ideas.arcgis.com if you'd like to see this considered.

Re: ERROR 001242 when calling arcpy.CreateGPSDDraft with result from .pyt toolbox

CharlesArnold — Mon, 24 Feb 2014 14:26:45 GMT

These values must be filled in on the Item Description page from within ArcMap or ArcCatalog:
http://resources.arcgis.com/en/help/main/10.1/index.html#/Documenting_a_tool_in_a_Python_toolbox/00150000003n000000/

We haven't got much push or request to implement a 100% python solution for doc'ing Python Toolboxes. You could post an idea on http://ideas.arcgis.com if you'd like to see this considered.

Maybe ESRI can add a note in the documentation for the arcpy.CreateGPSDDraft function (http://resources.arcgis.com/en/help/main/10.1/index.html#//018v0000008z000000) that it only works with .tbx toolboxes, and there's no way to get it to work with python toolboxes? Would have saved me some time digging thru documentation to find what I was missing, only to end up empty.

Or maybe the descriptions can just be made optional? A warning would be great, but making it an error to not have parameter descriptions is treating your users like children.

Editing the XML files that contain the "descriptions" from the script that calls arcpy.CreateGPSDDraft is easy enough, but the format of those files doesn't appear to be documented anywhere. It's human readable XML tho, so I was able to figure it out without documentation; a simple script that works for me is at https://gist.github.com/cwa-/9191377 ..

Re: ERROR 001242 when calling arcpy.CreateGPSDDraft with result from .pyt toolbox

AlanStewart — Fri, 04 Sep 2015 18:46:19 GMT

I have exactly the same problem, but the provided link does not work for me.

Re: ERROR 001242 when calling arcpy.CreateGPSDDraft with result from .pyt toolbox

OttarValvåg — Thu, 16 Nov 2023 12:03:26 GMT

Edit the ToolboxName.ToolName.pyt.xml file

Format the xml

Locate the <tool name="ToolName" displayname="ToolName" toolboxalias=""> tag

add a child tag <summary>My summary</summary>.