Custom Description Popup Text for Interoperability Production Business Hosts
I seem to remember making this work before, but I'm not having any luck digging up examples.
I've defined some custom properties for a business operation that could definitely benefit from having popup descriptions available in the Production Configuration. I have triple-slash comments before each property that do just that in the source. I thought those provided the text for the popup descriptions when clicking on the property name, but apparently not.
Any thoughts?
Comments
I'm doing the same with the triple-slash, it's working fine on iris 2024.3 and 2025.1 with firefox.
.png)
Odd ... I'm doing the same. This is with Health Connect 2023.1 on Windows.
.png){kind=small}
.png)
OK, so ... mysteriously, it's now working.
A few of my comments were on multiple "///" prefixed lines, and I edited them to put them on a single comment line. Recompiled, and now the popup is popupulated ...
.png)
This comment had been previously marked as Correct, but it's not the solution to the issue.
I continue to have issues with this functionality. While I did get my comments to show up as popup help text, I cannot edit them in the source and have those changes reflected in the popups.
I'll mention that I've been using VS Code for the development of this custom operation ...
Digging a bit deeper, I used IRIS Studio to open the class and look at the generated INT code. Interestingly, even though the code was compiled before opening it in Studio, the INT code did not reflect the change to the comment. When I recompiled in IRIS Studio, the INT code's popup text was updated as it should have been.
This appears to be a VS Code issue ... ?
How does the INT code in VSCode look?
In VS Code, if I make a change to a comment in the class, compile, then look at the INT code via View Other, the change is not reflected in the INT code. It doesn't matter whether the text is added to the same comment line or a new line.
Source:
.png)
INT:
.png)
Interestingly, I can force the comment to update the popup if I remove the property from the class SETTINGS parameter, compile, re-add it, and compile again.
Ah, maybe VSCode-ObjectScript "thinks" that comments do not deserve to be recompiled? if you change anything in a "real code" space?
OK, I'm pretty sure I found the problem.
Studio's default compiler flags are "cbk" and VS Code's were set to "cuk." I changed VS Code to match and it appears the issue is resolved.
EDIT: Weirdly, the tooltip text is not updated ...
EDIT 2: If the first line of the comment in the source contains HTML tags, the tooltip reverts to some earlier iteration of the comment (no idea where it's finding that). However, the popup is correct. Removing the tag(s) from the first line causes the tooltip to display the specified comment.
So ... if you want your tooltip to match the first comment line, make sure it has no HTML tags!
Glad you solved it! Thanks for the update!
💡 This question is considered a Key Question. More details here.