Messaging
RivEX utilises two main methods to provide feedback and advice when running a tool, these are standard dialogue messaging and parameter tool tips.
Dialogue messaging
The python code that powers RivEX uses the standard messaging functions of arcpy which means a message could be either:
- Information - text is coloured black and informing you what RivEX is doing.
- Warning - text is coloured brown and a warning that something has failed a RivEX quality control or a non-fatal error has occurred. You should review the message and act on it!
- Error - text is coloured red and is a fatal error that is stopping RivEX from completing its task. The tool will not complete unless you resolve the error, typically a topological issue.
If an error occurs this stops RivEX carrying out various post tool run tasks such as adding an output to the map or creating a relate between error log table and the input layer. This is functionality by design in ArcPro and cannot be overridden, so it's possible for RivEX to create an error log table then later, encounter a fatal error, and this stops the relate being built. Although an error can stop a layer being symbolized as output in the map, it will exist in its output Geodatabase so its always worth checking the output folder after an error message.
The Author of RivEX encourages you to turn on the messaging window by default so you can follow progress.
Tool tip messaging
Pay attention to the parameter tool tips, these give you important advice about the expected input but is also the location where ArcPro reports trapped errors. An example is shown below, the selected layer has a red cross symbol and hovering your cursor over it explains the reason why the parameter is invalid.
This layer is missing a workspace and RivEX reports this in the tool tip; the tool will not be allowed to run
until a network with a valid RivEX workspace has been provided.