topic Re: Add warning note at the top of a custom geoprocessing tool in ArcGIS Pro in Python Questions

Add warning note at the top of a custom geoprocessing tool in ArcGIS Pro

Clubdebambos — Mon, 07 Oct 2024 13:54:37 GMT

Is it possible to add notes at the top of custom tools, either with Python or the Toolbox GUI, similar to what I see here for the Append tool where it says "This tool modifies the Target Dataset"

I want to add a customised note of my own at the top of a custom tool.

Re: Add warning note at the top of a custom geoprocessing tool in ArcGIS Pro

DuncanHornby — Tue, 15 Oct 2024 11:24:23 GMT

I don't believe that blue message area is exposed to arcpy. Or if it is, it is an undocumented capability. May be in some future release ESRI will allow developers to put a piece of text into it?

What you can do is validate on each parameter of a python script tool you are building. So you could for example check if an input layer has a specific field, if it does not then you return an error message and the tool will not be allow to run. This ensures all parameters are valid for the code they are about to feed into.

Re: Add warning note at the top of a custom geoprocessing tool in ArcGIS Pro

HaydenWelch — Thu, 17 Oct 2024 17:27:01 GMT

As @DuncanHornby said, you can put the message on parameters:

you can do this in the updateMessages function of a pyt tool:

... def updateMessages(self, parameters: list[arcpy.Parameter]) -> None: parameters[0].setWarningMessage("Warning message") ...

Re: Add warning note at the top of a custom geoprocessing tool in ArcGIS Pro

Clubdebambos — Mon, 21 Oct 2024 07:12:00 GMT

Thanks @DuncanHornby and @HaydenWelch,

Its not what I want to do. It would be nice to be able to add that blue tip at the top that states a tool will modify the input/target dataset in place without an Add Warning workaround.

Cheers

Re: Add warning note at the top of a custom geoprocessing tool in ArcGIS Pro

HaydenWelch — Mon, 21 Oct 2024 17:23:09 GMT

In that case definitely put something in the Ideas board. Because that isn't currently possible with Arcpy, having that specific behavior would need to be added in a new release. For now you'd just have to use the workaround for similar functionality.

Re: Add warning note at the top of a custom geoprocessing tool in ArcGIS Pro

BenWoodward — Fri, 03 Oct 2025 19:30:47 GMT

I am not sure when this feature is added, but now, under the "General" tool properties, there is a checkbox that allows you to show a message like this at the top of the tool.