topic Re: How do you document a process in model builder for ArcGIS 10? in Geoprocessing Questions

How do you document a process in model builder for ArcGIS 10?

DuncanHornby — Mon, 19 Jul 2010 10:06:56 GMT

All,

We have just accquired the new ArcGIS 10 and I have been experimenting with model builder. I'm a big fan in documenting such tools as I never remember why, when & how I did things 6 months ago!

In 9.3 when you were in model builder you could right-click on a process (the yellow box) and "edit documentation". This does not exist any more in ArcGIS 10, or does it and you have to access it via some other route?

In ArcCatalog 10 you can add documentation to a parameter through Item description but I have yet to find a way how to document the process. Has this been dropped?

Duncan

Re: How do you document a process in model builder for ArcGIS 10?

DaleHoneycutt — Mon, 26 Jul 2010 18:16:13 GMT

This functionality was removed in 10.0 (due to the new Item Description framework)

Re: How do you document a process in model builder for ArcGIS 10?

RandyMcGregor — Tue, 26 Oct 2010 17:34:07 GMT

Is there any way for me to update, edit, or otherwise revise the substantial documentation I created before version 10?

I will miss the parameter by parameter documentation option.

Re: How do you document a process in model builder for ArcGIS 10?

RandyMcGregor — Thu, 11 Nov 2010 18:13:24 GMT

This functionality was removed in 10.0 (due to the new Item Description framework)

For models created in 9.3, I can still see the parameter-by-parameter documentation.

When I select "help" for models I created in 10.0, I see the good old template, with each parameter listed, "usage." all that stuff.

But I have not figured out how to update the documentation for these parameters as I was able to do in 9.3. It seems to be there, but I don't know how to get at it.

Is this possible in 10.0?

The "Item Description" is just basically a summary page, as far as I can tell so far.

Thank you

Re: How do you document a process in model builder for ArcGIS 10?

TylerBragg — Wed, 22 Dec 2010 11:00:24 GMT

Randy,

I am having the same problem. Did you ever find a solution? You are right--when you right-click on the model in ArcCatalog, you can select "Help" and see the process-by-process description, but I have found no way to edit that description. Removing this functionality was a bad idea; a general model "Item Description" does not pay the bills for documenting model processing. We need to be able to create an explanation for each tool. Hopefully someone has found a way to edit/create this documentation, especially since you CAN see it when you open the Help. Doesn't make sense if it's there in the "help" but you can't input that information. Thanks.

Tyler

Re: How do you document a process in model builder for ArcGIS 10?

ChristopherMorneau — Thu, 23 Dec 2010 22:49:26 GMT

I have models that I created in 9.3.1 & earlier that contain VBA code. As I upgrade them to Python-based code & make other modifications per Release 10, I have a need to revise existing documentation. I, too, am frustrated at not being able to do this in the new release. Thus far, I have found nothing in ArcGIS 10 Help or the ArcGIS Resource Center to assist me in resolving this issue (but I'll keep looking).

Meanwhile, I have a related issue. I recently created a simple model containing only two processes & I wanted to add documentation, specifically for the parameters. In "A quick tour of documenting tools and toolboxes" in ArcGIS 10 Help, it says to right-click the tool & click Item Description, which displays the Description page. Fine, except when I do so, the title bar on the window refers to something completely different than my model. For example, it will show the name of the currently highlighted directory in ArcCatalog. Therein, the Item Description window is providing the wrong template - not the one I should be getting for my newly created tool, but rather for an existing file directory. In the Item Description window after Summary, I should see fields for Usage, Syntax, Code Samples, & Credits. I see none of that. Instead, after Summary, I see Description, Credits, & Use Limitation. What gives? Am I missing something here?

Chris Morneau
L.A. County Dept. of Regional Planning

Re: How do you document a process in model builder for ArcGIS 10?

ChristopherMorneau — Mon, 27 Dec 2010 14:34:12 GMT

In following up on these issues, I have discovered the following:

In ArcCatalog, select (highlight) the tool in the Catalog Tree window first, then right-click the tool in the ArcToolbox window. Click on Item Description & click on the Edit button in the Item Description window. Make edits as needed (e.g., Dialog Reference, etc.) & click save. Now, when the tool is re-opened, its dialog will show the documentation revisions.

So, yes, I found what I was missing, & I hope this helps others. But I feel that ESRI should clarify their Help documentation on this topic. In "A quick tour of documenting tools and toolboxes" in ArcGIS 10 Help, it should state upfront that the tool needs to be selected in the Catalog Tree window before doing anything.

Chris Morneau
L.A. County Dept. of Regional Planning

Re: How do you document a process in model builder for ArcGIS 10?

RandyMcGregor — Fri, 21 Jan 2011 11:36:37 GMT

Randy,

I am having the same problem. Did you ever find a solution? You are right--when you right-click on the model in ArcCatalog, you can select "Help" and see the process-by-process description, but I have found no way to edit that description. Removing this functionality was a bad idea; a general model "Item Description" does not pay the bills for documenting model processing. We need to be able to create an explanation for each tool. Hopefully someone has found a way to edit/create this documentation, especially since you CAN see it when you open the Help. Doesn't make sense if it's there in the "help" but you can't input that information. Thanks.

Tyler

Looks like this has been answered. I'll just chime in to say that yes, detailed documentation must be entered in ArcCatalog.

Still, there are issues....

I don't like having to fire up ArcCatalog. It is slow to come up, and takes up resources, so I have to close it down afterwords.

Graphics added to the documentation display so inconsistently that I have quit adding them in. I have no idea what the pattern is. Some show, some don't. Some show when you hit "Item Description," but not when you hit "Help." Some show when you hit "Item Description" in ArcCatalog, but not in ArcMap. Exasperating.

Also, I have one script in particular that has some old, out-of-date text that appears when the script is run. I need to update it, but I cannot find it. My users are getting an eyeful of erroneous information when they fire up the tool.

I'm sure there is a "workaround," but there shouldn't need to be. The old script tool documentation worked beautifully ... without a hitch. Never had a single problem with it. This new thing has been a pain and has reduced the amount of documentation I can provide.

Re: How do you document a process in model builder for ArcGIS 10?

ValCannon — Fri, 18 Mar 2011 15:59:25 GMT

I agree that this is a big problem. Until I heard of the work-around, I wanted to keep a 9.3.1 machine around just for documenting models.

Re: How do you document a process in model builder for ArcGIS 10?

EmelineRenz — Tue, 22 Mar 2011 20:37:48 GMT

Does this article help?

HowTo: Add descriptive text in the model dialog
http://resources.arcgis.com/content/kbase?fa=articleShow&d=38595

Please let me know if you have any feedback on this process!

Re: How do you document a process in model builder for ArcGIS 10?

JustinPreikschas — Tue, 10 May 2011 15:38:32 GMT

Does this article help?

HowTo: Add descriptive text in the model dialog
http://resources.arcgis.com/content/kbase?fa=articleShow&d=38595

Please let me know if you have any feedback on this process!

Yes, this article helps, but we shouldn't have to search the forum to find this information. There should be a way to right-click on the model in ArcMap to add this information (if there is already, I couldn't figure it out). I do like the new system once I found it though, it is pretty clean and easy to use.

Thanks,
Justin

Re: How do you document a process in model builder for ArcGIS 10?

TylerBragg — Tue, 31 May 2011 10:57:43 GMT

Does this article help?

HowTo: Add descriptive text in the model dialog
http://resources.arcgis.com/content/kbase?fa=articleShow&d=38595

Please let me know if you have any feedback on this process!

Yes, the article helps to a point, but there is still functionality missing. I will say that I had not found the "Description" tab in ArcCatalog. However, after looking at it with some of my models, it still does not replace the older, "tool-by-tool" description. This only allows you to add descriptions for the tools you set as "model parameters." What about the other tools? Can I not document what they do as well? Maybe I missed that also - if I have, please correct me. If not, then ESRI seriously needs to consider allowing documentation on ALL tools again, like in previous versions. In many of my models, I will only set 4 or 5 tools out of a total of 30 or 40 in the model to parameters, so I can just double click on the model and run from the GUI, only having to change a few things. I still need to document the "behind the scenes" processes so that 1) I can look back and understand the rationale behind what I created and 2) so that others can understand what I have done if they have to follow behind me. Am I missing something? Thanks.

Tyler

Re: How do you document a process in model builder for ArcGIS 10?

CelinaThom — Wed, 01 Jun 2011 04:39:28 GMT

I have no problems accessing the "edit item description" window through the toolbox in arcmap, I don't need to go through arccatalog as previous posters have suggested. Perhaps this was changed in SP2?

But what I do find is that when I first click EDIT not all of the fields are available. But if I click SAVE, leave the editing environment and then click EDIT again to return, new fields pop up (like syntax). See the attached screen dumps of the first and second time I open the EDIT ITEM DESCRIPTION window.

I assume this is a bug, because I don't otherwise understand the purpose... or? Can someone enlighten me?

Re: How do you document a process in model builder for ArcGIS 10?

FrancoisFord — Thu, 30 Jun 2011 12:05:21 GMT

Thanks so much for this, I've been searching for ages. This has to be one of the top disasters in ESRI's interface. I really don't see how they can justify the fact that some of the metadata are editable in ArcToolbox, but once you highlight it in Catalog all the parameters magically appear. In my opinion this is extremely poor design and very confusing to users!

In following up on these issues, I have discovered the following:

In ArcCatalog, select (highlight) the tool in the Catalog Tree window first, then right-click the tool in the ArcToolbox window. Click on Item Description & click on the Edit button in the Item Description window. Make edits as needed (e.g., Dialog Reference, etc.) & click save. Now, when the tool is re-opened, its dialog will show the documentation revisions.

So, yes, I found what I was missing, & I hope this helps others. But I feel that ESRI should clarify their Help documentation on this topic. In "A quick tour of documenting tools and toolboxes" in ArcGIS 10 Help, it should state upfront that the tool needs to be selected in the Catalog Tree window before doing anything.

Chris Morneau
L.A. County Dept. of Regional Planning

Re: How do you document a process in model builder for ArcGIS 10?

DorothyMortenson — Mon, 24 Oct 2011 17:21:27 GMT

I'm afraid I dont see the "Item Description" option at all. I am using ArcGIS 10, full version. (Build 2800)

When I right click on my model, I get:
Open...
Batch...
Edit...
Debug...
Copy
Delete
Rename
Set Password...
Export Script (grayed)
Import Script (grayed)
Help
Properties

I don't see any Item Description.

Re: How do you document a process in model builder for ArcGIS 10?

KevinHibma — Mon, 24 Oct 2011 20:00:12 GMT

Within ArcCatalog there is no Item Description on the right click menu. The "Description" is a tab, part of the main window. If you just click on the model, you should have 3 tabs - description being one of them.
Within ArcMap's Catalog Window, you get a Item Description off the right click context menu and from there it opens a new Item Description window.

Hope this helps

I'm afraid I dont see the "Item Description" option at all. I am using ArcGIS 10, full version. (Build 2800)

When I right click on my model, I get:
Open...
Batch...
Edit...
Debug...
Copy
Delete
Rename
Set Password...
Export Script (grayed)
Import Script (grayed)
Help
Properties

I don't see any Item Description.

Re: How do you document a process in model builder for ArcGIS 10?

DorothyMortenson — Mon, 24 Oct 2011 20:04:26 GMT

Yes, thank you.

Re: How do you document a process in model builder for ArcGIS 10?

NobbirAhmed — Tue, 25 Oct 2011 18:02:15 GMT

The Item Description issue is fixed with 10 sp2.

Re: How do you document a process in model builder for ArcGIS 10?

C_Lang — Wed, 24 Jul 2013 09:05:17 GMT

I'm using ArcGIS 10.0, SP 5,
but opening the Item Description Window from ArcMap doesn't show the syntax section and won't let me edit the description for the Model Parameters.
As mentioned above it works from ArcCatalog via Description Tab.

Re: How do you document a process in model builder for ArcGIS 10?

deleted-user-FYWnb7WVNuhY — Tue, 23 Sep 2014 14:57:48 GMT

Whenever I create a new model or process I also create a Word doc with directions on how to use it in addition to filling out the pertinent metadata. I have found what works best for me is that we have a FTP site, but I assume a DropBox would work also, where I put my documents and I simply hyperlink them to the metadata. Works well for adding those extra steps.