Variable and Argument Descriptions

I’ve had a search for similar topics and didn’t find anything, but I’m still fully expecting to be pointed to an existing topic on this one as I can’t believe no one else has asked for this: a description field for variables and arguments.

If I make a workflow xaml with arguments, then in order to communicate to other/future users the desired content or purpose of the argument, so they know what value to use in the import/edit arguments windows, I have two options:

  1. I can add an annotation at the top of the XAML workflow and expect the future user to open the workflow in order to read it and know what to enter into the arguments panel.

  2. I can add an annotation to the argument itself and expect the future user to open the workflow file, expand the arguments panel and mouse-over the annotation of the argument

Similarly for variables. I can add an annotation to a variable currently, but I have to mouse-over it in the variables pane in order to read it (I know, I know… first-world problems). It would be nice if there were a ‘description’ column,. then I could just see it all in front of me.

If a description field could be added that also is shown in the ‘import arguments’ and ‘edit arguments’ windows, then it would be simple to see what value needs to be passed.

As an added bonus, the description could also be used to provide the description tooltip that shows on parameters when a workflow is published as an activity.

I think this is especially pertinent for arguments, because I would think the argument description would be displayed in the Orchestrator job arguments panel as well. For me, the main function here is creating string arguments where I want to accept a finite number of valid inputs, for example, an argument that determines whether a process should open apps against our DEV, QA, or PROD databases.

Thank you for your suggestion. I added it to our internal ideas tracker for our team to consider.

1 Like

I was surprised there is only one topic on this. I’ve also come to suggest the same thing. This is incredibly useful when developing internal use libraries, as the person using the library should not have to open the library project as well as their project to see the intended arguments. All inbuilt UiPath activities have argument tooltips when you hover over the properties with a short description, so to have this on custom libraries (and just all workflows because it would be the same solution) makes sense.