Shortcode for prepared e-mails

vvucic · April 11, 2016, 2:55pm

Hello,

is there any table/list of short codes for prepared e-mails ie. journal title, author name, author salutation, article id, date of submission so we can add to prepared e-mails.

Thanks

asmecher · April 13, 2016, 8:43pm

Hi @vvucic,

There are some common variables shared by all email templates, and then each template adds some of its own more specific ones. For example, the site-wide variables are defined here…

github.com

pkp/ojs/blob/ojs-stable-2_4_8/classes/mail/MailTemplate.inc.php#L116


	/**
	 * Assigns values to e-mail parameters.
	 * @param $paramArray array
	 * @return void
	 */
	function assignParams($paramArray = array()) {
		// Add commonly-used variables to the list
		if (isset($this->journal)) {
			// FIXME Include affiliation, title, etc. in signature?
			$paramArray['journalName'] = $this->journal->getLocalizedTitle();
			$paramArray['principalContactSignature'] = $this->journal->getSetting('contactName');
		} else {
			$site =& Request::getSite();
			$paramArray['principalContactSignature'] = $site->getLocalizedContactName();
		}
		if (!isset($paramArray['journalUrl'])) $paramArray['journalUrl'] = Request::url(Request::getRequestedJournalPath());

		return parent::assignParams($paramArray);
	}

	/**

…and more are added for emails referring to a particular article over here…

github.com

pkp/ojs/blob/ojs-stable-2_4_8/classes/mail/ArticleMailTemplate.inc.php#L52


	 */
	function ArticleMailTemplate($article, $emailKey = null, $locale = null, $enableAttachments = null, $journal = null, $includeSignature = true, $ignorePostedData = false) {
		parent::MailTemplate($emailKey, $locale, $enableAttachments, $journal, $includeSignature, $ignorePostedData);
		$this->article = $article;
	}

	function assignParams($paramArray = array()) {
		$article =& $this->article;
		$journal = isset($this->journal)?$this->journal:Request::getJournal();

		$paramArray['articleTitle'] = strip_tags($article->getLocalizedTitle());
		$paramArray['articleId'] = $article->getId();
		$paramArray['journalName'] = strip_tags($journal->getLocalizedTitle());
		$paramArray['sectionName'] = strip_tags($article->getSectionTitle());
		$paramArray['articleAbstract'] = PKPString::html2text($article->getLocalizedAbstract());
		$paramArray['authorString'] = strip_tags($article->getAuthorString());

		parent::assignParams($paramArray);
	}

	/**

…and then specific mail templates add their own, e.g. this for the REVIEW_REQUEST set of emails:

github.com

pkp/ojs/blob/ojs-stable-2_4_8/classes/submission/sectionEditor/SectionEditorAction.inc.php#L265



					if ($reviewAssignment->getDateDue() != null) {
						$reviewDueDate = strftime(Config::getVar('general', 'date_format_short'), strtotime($reviewAssignment->getDateDue()));
					} else {
						$numWeeks = max((int) $journal->getSetting('numWeeksPerReview'), 2);
						$reviewDueDate = strftime(Config::getVar('general', 'date_format_short'), strtotime('+' . $numWeeks . ' week'));
					}

					$submissionUrl = $request->url(null, 'reviewer', 'submission', $reviewId, $reviewerAccessKeysEnabled?array('key' => 'ACCESS_KEY'):array());

					$paramArray = array(
						'reviewerName' => $reviewer->getFullName(),
						'weekLaterDate' => $weekLaterDate,
						'reviewDueDate' => $reviewDueDate,
						'reviewerUsername' => $reviewer->getUsername(),
						'reviewerPassword' => $reviewer->getPassword(),
						'editorialContactSignature' => $user->getContactSignature(),
						'reviewGuidelines' => PKPString::html2text($journal->getLocalizedSetting('reviewGuidelines')),
						'submissionReviewUrl' => $submissionUrl,
						'abstractTermIfEnabled' => ($sectionEditorSubmission->getLocalizedAbstract() == ''?'':__('article.abstract')),
						'passwordResetUrl' => $request->url(null, 'login', 'resetPassword', $reviewer->getUsername(), array('confirm' => Validation::generatePasswordResetHash($reviewer->getId())))

Regards,
Alec Smecher
Public Knowledge Project Team

budhi · April 27, 2016, 2:47am

Dear @asmecher, I’m beginner in OJS. Based on your explanation there are very limited variable for Prepared Email, but we can customized new variable. Is that correct? Please CMIIW.

So if I want to make a new variable, i.e. Address of the reviewer after reviewer name, I have to write some codes so the system recognize my new parameter (like {$reviewerAddress})

View on prepared email :
Dear {$reviewerName},
{$reviewerAddress}

View on composed email :
Dear Jhon Doe
Dept of Engineering, University of ABCD

Thank you
Budhi

ctgraham · April 27, 2016, 1:07pm

Yes, you are correct. This code would probably live in SectionEditorAction.inc.php (as above).

budhi · April 28, 2016, 2:35am

Dear @ctgraham, thank you for the confirmation and the link.
May I ask, on which part or variable that I can pull information of the Reviewer biodata and Manuscript metada?
Thank you.

ctgraham · April 28, 2016, 12:07pm

Are you comfortable with PHP code?

In the SectionEditorAction.inc.php snippet above, $reviewer is a User is a PKPUser. This instanciation and inheritance will give you access to the (for example) PKPUser::getMailingAddress() method.

In the ArticleMailTemplate.inc.php, $article is an Article is a Submission.

budhi · May 10, 2016, 7:07am

I’m not familiar with PHP code, I only can operate OJS and customize the flow of this publication system for my daily work. I’ll have our programmer coded.

Thank you for your help.

bog · July 5, 2018, 12:45pm

Dear @asmecher,

We use the latest version, 3.1.1.2, but we have similar problem. If an editor invite a new referee, the REVIEWER_REGISTER template is sent by the editor, but at the end of the letter the principal contact name appears. I tried to change it to ${editorialContactName} without success. Also, I cannot put a Dear “NAME” to the beginning, because neither ${reviewerName} nor ${userFullName} works. but I don’t see why. Do you have a similar link to see what variables work there?

asmecher · July 12, 2018, 7:21pm

Hi @bog,

Are you using ${variableName} syntax rather than {$variableName}? It should always be {$variableName}.

Regards,
Alec Smecher
Public Knowledge Project Team

bog · July 13, 2018, 12:01am

Yes, that’s right, I use that syntax but here I made a mistake in the message, sorry.

asmecher · July 13, 2018, 2:55pm

Hi @bog,

In the REVIEWER_REGISTER email template, you should be able to use {$userFullName} for the reviewer’s name.

Are you sure the primary contact’s name is not included in the journal’s email signature?

Regards,
Alec Smecher
Public Knowledge Project Team

bog · July 16, 2018, 9:52am

Hi @asmecher,

The primary contact’s name IS included. But the sender of that email is the editor, who invite the reviewer, so I wanted to change the “signer” of the email to be the editor as well. Or we could change the sender to be the primary contact as well, but that looks even harder to achieve. For the moment none of them looks possible.

I’m trying to recheck that the {$userFullName} works or not, but in my last tests, no email was sent about the registering (or at least I did not obtained them), which is strange. I will check that with the administrator.

Thanks,
Bogi

bog · July 16, 2018, 2:19pm

Hi @asmecher,
finally the email has arrived. Now, the {$userFullName} does work, although its style is different (not so important), but the editor does not appear. See the screenshot from the email, I’ve got. (I’ve changed the password). The Signature of the editor still does not appear.

ojs-email

fgnievinski · October 20, 2019, 5:09am

Here’s a related question:

FGN

lsteele · October 20, 2019, 9:34am

HI Felipe,

I created a list and will forward it to you tomorrow when I will be in the office.

Ciao

Lucia

lsteele · October 21, 2019, 7:42am

Hello Felipe,

Here is a list of variables I created when I configured our site. It is not complete and it is an ongoing project. I found – but I am not totally sure – that the same variable pulls in different information depending on where in the workflow you use it, so pay attention.

It would be very useful if there were a more detailed list.

Regards,

Lucia

=== email variables OJS

{$siteTitle}: corresponds to journal full title

{$submissionId}: Article sequential number

{$submissionTitle}: Ms title

{$contextName}: journal full name

{$contextUrl}: Journal URL

{$submissionUrl}: Submission URL

{$participantUsername}: username of recipient

{$editorialContactSignature}: (varies with sender)

{$principalContactSignature}: as registered as Principal contact in Settings/Journal/Masthead

{$editorialContactName}: recipient

{$notificationContents}: adds text including discussion subject line and ms title

{$url}: add a link to a ms from a discussion

{$reviewerName}: pulls in name and surname of invited reviewer

{$responseDueDate}: pulls in the date as configured in settings/workflow/review

{$submissionReviewUrl}: direct link to submission, works after acceptance (?)

{$reviewDueDate}: add a date of review due

{$submissionAbstract}:

{$userFullName}: ??

{$username}: ??

{$password}: ??

{$submitterName}: ?? when is this used?

{$rawCitation}:

{$itemName}:

{$itemCost} ({$itemCurrencyCode}):

{$authorString}: pulls in author full name (?)

Submission title: {$submissionTitle}

Submission ID: {$contextName}-2018-00{$submissionId}

Notes:

SUBMISSION_ACK and SUBMISSION_ACK_NOT_USER (you can review the text of these in the emails list in setup).

The SUBMISSION_ACK message goes to the sending user, and is blind-copied to anyone identified in Settings > Workflow > Submissions.

The SUBMISSION_ACK_NOT_USER message goes to any authors (besides the submitting user).

Muhammad_Khoiruddin · November 30, 2022, 1:35am

thank you for this description.

is it possible to display the URL after publish (publish url) and also the volume and issue number of the article?

Miguel_Oliveira_Jr · September 27, 2023, 11:53am

Hello!
The shortcake for SECTION {$sectionName} is not working on e-mail templates. It does not get any information that is associated to the section of the referred article.

trobb49 · October 26, 2023, 1:19am

I am having trouble with one variable not showing up in the “Review Confirm” template. Is this a local problem with my own installation or are others using 3.4.0.3 experiencing the same problem. All of the other variables are inserted, including the name of the reviewer after the one that fails.

Here is what we receive as a response from a reviewer:

. . … Thank you for thinking of me, and I plan to have the review completed by its due date, 2023-11-20, if not before.

The URL: {$contextUrl}

Seymour Tahmati [Name altered by me]