not sure this is the right stream .. does anyone know if there is a way to change the link to the dataverse guide that comes to the user in the email that is sent when a new dataset is created? Currently, it sends a link to the default dataverse guide, and if you add a :GuideBaseURL you can change the domain, but I believe that is only if you've made your own copy of that default guide .. we actually would like to send a completely different link in the email to our own custom guide .. is that possible?
@Deirdre Kirmis can you please copy and paste here what the new dataset email looks like? I can't seem to find one.
We have this setting :
:GuidesBaseUrl http://uvalib.github.io/dataverse-docs
Nevermind, I found one:
Hello,
Your new dataset named no files (view at https://demo.dataverse.org/dataset.xhtml?persistentId=doi:10.70122/FK2/7JAQ6R ) was created in Philip Durbin Dataverse (view at https://demo.dataverse.org/dataverse/pdurbin ). To learn more about what you can do with a dataset, check out the Dataset Management - User Guide at https://guides.dataverse.org/en/6.0/user/dataset-management.html .
You may contact us for support at support@dataverse.org.
Thank you,
Demo Dataverse Support
So the problem is the "check out the guides" link, I guess.
src/main/java/propertyFiles/Bundle.properties
782:notification.email.createDataset=Your new dataset named {0} (view at {1} ) was created in {2} (view at {3} ). To learn more about what you can do with a dataset, check out the Dataset Management - User Guide at {4}/{5}/user/dataset-management.html .
@Sherry Lake it seems to be dynamic so I assume your users get emails linking to your custom guides.
Here is what UVA's email looks like:
Hello,
Your new dataset named Need new dataset (view at https://dataverse.lib.virginia.edu/dataset.xhtml?persistentId=doi:10.18130/V3/RNY6XS ) was created in LibraData: UVa's Scholarly Research (view at https://dataverse.lib.virginia.edu/dataverse/libradata ). To learn more about what you can do with a dataset, check out the Dataset Management - User Guide at http://uvalib.github.io/dataverse-docs/en/current/user/dataset-management.html .
But.... you need to have the "path" at that "GuideBaseURL".... the path after the base URL cannot be changed, unless you modify the Bundle.properties file?.... So that is a problem. We have done some re-directing to get the UserGuide URL to go where we want to:
So that link really is re-directed here: https://guides.lib.virginia.edu/LibraDataUserGuide/DatasetManagement
ah okay i see .. we need to add our domain in the GudeBaseURL and then redirect via DNS .. got it .. i think
Should work. Let us know if it doesn't!
thanks so much!
Oh, this isnโt the only guide link sent in emails or are in the notifications. Tomorrow Iโll get the list of URLs we have re-directing.
We donโt redirect via DNS, since we are using โgithubโ, I have a re-direct in the HTML files. Iโll send the github link tomorrow too.
@Deirdre Kirmis here is out github pages site: https://github.com/uvalib/dataverse-docs/
I added a readme file that lists the files I re-directed and info on why and how.
This is amazing .. thank you @Sherry Lake !
Sooooo helpful! :heart:
Really interesting. Thanks, Sherry.
@Sherry Lake do you have to make those edits every time you upgrade the code?
[Edits, updates to the original comment....]
No, the guideBaseURL is in the settings and as long as I donโt change our GuidesVersion setting https://guides.dataverse.org/en/latest/installation/config.html#guidesversion
This is what I have: :GuidesVersion = current
The rest of the URL stays the same - UVa has set โcurrentโ as :GuidesVersion, so that is why that is in our guide path. I do not know what the default is.
http://uvalib.github.io/dataverse-docs/en/**current**/user/dataset-management.html
I'm surprised it's "current" instead of "latest". We have "latest" at https://guides.dataverse.org/en/latest/
OK.... looking back at our settings. I do have GuidesVersion set:
:GuidesVersion = current
So that is why "current" is after "en/" in our PATH.
I see Harvard has the actual version # (this link from the e-mail). I wonder how that is set?
https://guides.dataverse.org/en/6.0/user/dataset-management.html
Here's the code:
String datasetCreatedMessage = BundleUtil.getStringFromBundle("notification.email.createDataset", Arrays.asList(
version.getDataset().getDisplayName(),
getDatasetLink(version.getDataset()),
version.getDataset().getOwner().getDisplayName(),
getDataverseLink(version.getDataset().getOwner()),
systemConfig.getGuidesBaseUrl(),
systemConfig.getGuidesVersion()
));
Long story short, it uses :GuidesVersion if it can. Otherwise it uses the version defined in pom.xml.
version defined in pom.xml
I'm kinda sure it will pick up the version from the dataverse.version JVM option, which is by default originating from what is defined in pom.xml, but can be set to sth else
Yes, a long, long story. :grinning:
sorry just now responding on this .. @Sherry Lake does this actually change the text of the link appearing in the email as well, or just redirect to the correct link (and leave the email as is)? Our DNS redirection is working, but nothing changes in the email (of course) so it is confusing to the user.
@Deirdre Kirmis the link is auto generated by Dataverse (I leave that as is) as this: http://uvalib.github.io/dataverse-docs/en/current/user/dataset-management.html
that URL (and others that appear in various emails) are redirected to our Libguides (which are versions of Dataverse User Guides).
okay i see .. so the link in the email does not match the URL that the redirect points to .. that is our issue too with DNS redirection ..which i know is how redirection works :big_smile: .. but our research team wants the link text to show the actual guide link .. i think i might put a request in to allow the ability to add a completely different URL for guides so that the email link is the actual link to the guides
maybe someday
Sure, please go ahead.
Last updated: Oct 30 2025 at 06:21 UTC