Pthon to Tollbox User dialog box

2197
6
11-22-2011 04:49 AM
MehmetErcan
New Contributor
Hello all,

I have written a python code that uses some GIS tolls. I have brought this code into GIS (ArcGIS 10) environment by adding the python script to a tollbox. I had 3 model parameters that user needs to define. I was able to do this by the code "arcpy.GetParameterAsText(0)" and defining model parameters during bringing the script into GIS environment. The problem is that I do not know how to put help text that appears on dialog box (when an user uses the python script tool) for each model parameters.

Is there anybody who can help me with this?

Thanks,
Mehmet.
Tags (2)
0 Kudos
6 Replies
JeffBarrette
Esri Regular Contributor
Via the Catalog Window (in ArcMap) right-click on the script tool and choose Item Description from the context window.  The choose edit.

Jeff
0 Kudos
MehmetErcan
New Contributor
"Item Description" does not have any part to edit "Model Parameters". Therefore, this is not the solution to the problem I have (or I am missing something).

P.S. : One thing I discovered with "Item Description" is that it does not save your edits when you do not close ArcGIS after edits. When it saves your edits, it will show up for all scripts such as the built up tool "Spatial Statistic Tool ---> Analyzing Patterns ----> Average Nearest Neighbor" (which is python script)

Mehmet.

Via the Catalog Window (in ArcMap) right-click on the script tool and choose Item Description from the context window.  The choose edit.

Jeff
0 Kudos
CaglarKoylu
New Contributor
Hi Mehmet,

I have never done this before but I think the solution is:

1-  create a compiled help system for your tool:
http://support.esri.com/en/knowledgebase/techarticles/detail/27681

2 - embed it into the properties of the script

http://support.esri.com/en/knowledgebase/techarticles/detail/27690

I wish the solution was more straightforward for a simple task like this. Let me know, if you have further questions.

Caglar
0 Kudos
MikeMacRae
Occasional Contributor III
Go to Catalogue. In the Catalogue tree, scroll to the bottom to Arctoolbox. Add your tool there like you did in the Arctoolbox window. When you have added it, highlight it and then choose the "Description" tab in the display window and then click on "edit". You will see the parameters in there. Click the drop down and add your tool description in the "Dialogue Explanation" box. You can also add a script explanation and many other metedata items.

Mike
0 Kudos
MehmetErcan
New Contributor
This was exactly what I wanted. It worked. I appreciate your help Mike.

Mehmet.

Go to Catalogue. In the Catalogue tree, scroll to the bottom to Arctoolbox. Add your tool there like you did in the Arctoolbox window. When you have added it, highlight it and then choose the "Description" tab in the display window and then click on "edit". You will see the parameters in there. Click the drop down and add your tool description in the "Dialogue Explanation" box. You can also add a script explanation and many other metedata items.

Mike
0 Kudos
MehmetErcan
New Contributor
Hi Caglar,

Thanks for your help. I had an example of MODIS tool (at http://data.crwr.utexas.edu/blog/news/historical-evapotranspiration-data/) that did not used chm file. Therefore, I did not tried this way. Mike wrote the solution for my problem.

Thanks,
Mehmet.


Hi Mehmet,

I have never done this before but I think the solution is:

1-  create a compiled help system for your tool:
http://support.esri.com/en/knowledgebase/techarticles/detail/27681

2 - embed it into the properties of the script

http://support.esri.com/en/knowledgebase/techarticles/detail/27690

I wish the solution was more straightforward for a simple task like this. Let me know, if you have further questions.

Caglar
0 Kudos