Stream: troubleshooting

Topic: Customizing Email Page for New Dataset Notifications


view this post on Zulip Marcos Anjos (Aug 23 2024 at 13:12):

Hi everyone,

I'm looking for a way to customize the email page that is automatically generated whenever a new dataset is deposited. Currently, the page follows a standard format, but I'd like to modify it to better suit the needs of my project (such as changing the layout, adding additional information, etc.).

Could anyone point me to any documentation or tutorials that explain how I can make this customization? It would also be helpful to hear if anyone has faced a similar challenge and has any tips or experiences to share.

I've attached an image below showing what the email page looks like currently.

Thanks in advance for your help!
new-email.png

view this post on Zulip Philip Durbin ๐Ÿš€ (Aug 23 2024 at 13:46):

Hi! Unfortunately, these emails are not easily customizable. @zbenta opened an issue about this already: Notification Customization #9305

You're welcome to give a :thumbs_up: and comment to that issue. Or you can create a new one if it doesn't capture what you want.

view this post on Zulip Marcos Anjos (Aug 23 2024 at 14:45):

Hmm, I'll check that out.

@Philip Durbin is there an alternative solution, like just creating a hyperlink, that could improve the visual aspect of the email? The full customization of the messages seems a bit complex.

view this post on Zulip Philip Durbin ๐Ÿš€ (Aug 23 2024 at 14:46):

Are you in the habit of deploying custom Bundle.properties files? If so, you could probably tweak the message there.

view this post on Zulip Marcos Anjos (Aug 23 2024 at 14:56):

I'm not familiar with this type of file " Bundle.properties "

view this post on Zulip Philip Durbin ๐Ÿš€ (Aug 23 2024 at 15:09):

It's mostly used for translations. For running Dataverse in French or Spanish or whatever. But it's possible to change a lot of the text in the GUI by editing it.

view this post on Zulip Philip Durbin ๐Ÿš€ (Aug 23 2024 at 15:10):

You can find docs at https://guides.dataverse.org/en/6.3/installation/config.html#internationalization but they're a little hard to follow. :sweat_smile:

view this post on Zulip Marcos Anjos (Aug 30 2024 at 14:34):

Hi @Philip Durbin

I found the Bundle.properties file you mentioned, and it seems to contain the message I want to modify. However, I’m not sure what the next steps are to test the changes or resolve the customization issue. Could you guide me on how to proceed from here?

image.png

view this post on Zulip Philip Durbin ๐Ÿš€ (Sep 03 2024 at 17:53):

Sorry, I haven't played with this in a while. You might want to try emailing the google group to see if others can help: https://groups.google.com/g/dataverse-community

view this post on Zulip Philip Durbin ๐Ÿš€ (Sep 03 2024 at 17:53):

Also, it sounds like we need better docs! Please feel free to create an issue about this!

view this post on Zulip Sherry Lake (Sep 03 2024 at 18:43):

I've edited the emails' text by editing the Bundle.properties file.

We have a test server where I test things before updating our production server.

My steps (which I do after each upgrade - because things change or are added in the Bundle.properties file and a new "current" file gets put in the applications' folder for each upgrade):

First find the file. At UVA this is where ours is, our payara version is V6 and we are at version 6.2 of Dataverse software :

/usr/local/payara6/glassfish/domains/domain1/applications/dataverse-6*/WEB-INF/classes/propertyFiles

I make a copy of the Bundle.properties file.

cp Bundle.properties orig.Bundle.properties

I edit the lines in "Bundle.properties". I search for the specific email lines and make my edits. Then save the file.

Then you need to stop and re-start payara (after an update to Bundle.properties file).

I would record all changes you make to the Bundle.properties file, maybe even saving a copy of the file. You will need to edit the Bundle.properties file each time you upgrade your Dataverse software.

view this post on Zulip Oliver Bertuch (Sep 04 2024 at 08:23):

Just a hint: as I outlined here, you might be able to create your own bundles without touching the upstream ones. Might be worth a shot. So far there's a single report that idea wouldn't work, but someone with dev skills might look into it...


Last updated: Oct 30 2025 at 06:21 UTC