Copies of Automatic Reminders to Editor/Section Editors in 3.1.0.1

RickMath · January 10, 2018, 11:27pm

My section editors are giving me great feedback on the new system.

One asked if there is a way to copy the section editor and editor on automatic review reminders. This might serve as a tickler to remind the editor to follow up also.

Thanks

Rick

astevens · January 12, 2018, 1:30pm

Hi @RickMath,

I’m happy to hear you’re enjoying the new release of OJS! You will need to change the code in order to add bcc recipients to automatic review reminders. There are instructions on this post. I hope this is helpful.

Best,
Amanda Stevens
Public Knowledge Project Team

RickMath · January 12, 2018, 2:06pm

Thanks Amanda

In the last post by Alec there is a line for a function. Does this go in the email template?

Rick

astevens · January 13, 2018, 4:37pm

Hi @RickMath,

Hmm, yes, that’s a good question. It doesn’t say where the code change should be made. Let’s ask @asmecher.

Best,
Amanda Stevens
Public Knowledge Project Team

RickMath · January 13, 2018, 5:10pm

Amanda

Thanks

The line in the other post was $mail->ccAssignedEditors($articleId)

I searched around and could not find where the email recipients are defined. Related to this does this send to the journal editor and appropriate section editor.

Rick

RickMath · January 22, 2018, 4:49pm

Amanda

Have we been able to locate where this code needs to be inserted. My main objective is to let editors know that a reminders have been sent.

Thanks so much. 3.1.0.1 seems to be working great!!!

Rick

RickMath · February 1, 2018, 8:25pm

I am still looking for a place to set the cc to section editors for automatic reminders and also now emails in response to submissions, review requests and review completions. We had inserted this in 2.2.4 but I cannot find where it was inserted.

Thanks a this question is aging.

ctgraham · February 2, 2018, 2:43pm

I believe this code would now live in ReviewReminder::sendReminder():

github.com

pkp/pkp-lib/blob/8e16a4fe1b118ecc2d539a2c19926296c26f55c5/classes/task/ReviewReminder.inc.php#L39-L64


	function sendReminder ($reviewAssignment, $submission, $context, $reminderType = REVIEW_REMIND_AUTO) {
		$reviewAssignmentDao = DAORegistry::getDAO('ReviewAssignmentDAO');
		$userDao = DAORegistry::getDAO('UserDAO');
		$reviewId = $reviewAssignment->getId();

		$reviewer = $userDao->getById($reviewAssignment->getReviewerId());
		if (!isset($reviewer)) return false;

		import('lib.pkp.classes.mail.SubmissionMailTemplate');
		$emailKey = $reminderType;
		$reviewerAccessKeysEnabled = $context->getSetting('reviewerAccessKeysEnabled');
		switch (true) {
			case $reviewerAccessKeysEnabled && ($reminderType == REVIEW_REMIND_AUTO):
				$emailKey = 'REVIEW_REMIND_AUTO_ONECLICK';
				break;
			case $reviewerAccessKeysEnabled && ($reminderType == REVIEW_REQUEST_REMIND_AUTO):
				$emailKey = 'REVIEW_REQUEST_REMIND_AUTO_ONECLICK';
				break;
		}
		$email = new SubmissionMailTemplate($submission, $emailKey, $context->getPrimaryLocale(), $context, false);

This file has been truncated. show original

RickMath · February 3, 2018, 2:29am

I guess that makes sense but I have no idea where in the code to place it.

Thanks

ctgraham · February 5, 2018, 1:24pm

Are you familiar with PHP code? If not, you’ll want to involve someone who is comfortable writing and editing PHP.

If you are familiar with PHP but you’re having trouble following the classes or logic use, feel free to ask any particular questions and we’ll be happy to point you in the right direction.

RickMath · February 6, 2018, 11:06pm

Yes I am somewhat familiar with php. Alec suggested the following in another post.

$mail->ccAssignedEditors($articleId)

I am just wondering where to place it.

We have looked at ReviewReminder.inc.php as you suggested but we are not sure if this can be inserted and where. There are places in the file where recipients of the reminders are fetched.

This is where we need help

Thanks

Rick

ctgraham · February 7, 2018, 3:05pm

The method ReviewReminder::sendReminder() is the code which actually constructs and sends the message. The variable $email is a SubmissionMailTemplate and its methods are used to set the properties of the mail, like the Subject, From, etc.

github.com

pkp/pkp-lib/blob/8e16a4fe1b118ecc2d539a2c19926296c26f55c5/classes/task/ReviewReminder.inc.php#L58-L64


		$email = new SubmissionMailTemplate($submission, $emailKey, $context->getPrimaryLocale(), $context, false);
		$email->setContext($context);
		$email->setReplyTo(null);
		$email->addRecipient($reviewer->getEmail(), $reviewer->getFullName());
		$email->setSubject($email->getSubject($context->getPrimaryLocale()));
		$email->setBody($email->getBody($context->getPrimaryLocale()));
		$email->setFrom($context->getSetting('contactEmail'), $context->getSetting('contactName'));

You’ll find methods ccAssignedSubEditors() and bccAssignedSubEditors() in SubmissionMailTemplate:

github.com

pkp/pkp-lib/blob/8e16a4fe1b118ecc2d539a2c19926296c26f55c5/classes/mail/SubmissionMailTemplate.inc.php#L156-L164


	/**
	 *  CC this email to all assigned sub editors in the given stage
	 * @param $submissionId int
	 * @param $stageId int
	 * @return array of Users
	 */
	function ccAssignedSubEditors($submissionId, $stageId) {
		return $this->_addUsers($submissionId, ROLE_ID_SUB_EDITOR, $stageId, 'addCc');
	}

I’m not immediately familiar with what it means to be a “Sub Editor” in OJS 3. If this role is what you want to target, these functions are for you.

These methods require a $submissionId and a $stageId as parameters.

An example of getting the appropriate submission id is in the same calling method:

github.com

pkp/pkp-lib/blob/8e16a4fe1b118ecc2d539a2c19926296c26f55c5/classes/task/ReviewReminder.inc.php#L66


				break;
		}
		$email = new SubmissionMailTemplate($submission, $emailKey, $context->getPrimaryLocale(), $context, false);
		$email->setContext($context);
		$email->setReplyTo(null);
		$email->addRecipient($reviewer->getEmail(), $reviewer->getFullName());
		$email->setSubject($email->getSubject($context->getPrimaryLocale()));
		$email->setBody($email->getBody($context->getPrimaryLocale()));
		$email->setFrom($context->getSetting('contactEmail'), $context->getSetting('contactName'));

		$reviewUrlArgs = array('submissionId' => $reviewAssignment->getSubmissionId());
		if ($reviewerAccessKeysEnabled) {
			import('lib.pkp.classes.security.AccessKeyManager');
			$accessKeyManager = new AccessKeyManager();

			// Key lifetime is the typical review period plus four weeks
			$keyLifetime = ($context->getSetting('numWeeksPerReview') + 4) * 7;
			$accessKey = $accessKeyManager->createKey($context->getId(), $reviewer->getId(), $reviewId, $keyLifetime);
			$reviewUrlArgs = array_merge($reviewUrlArgs, array('reviewId' => $reviewId, 'key' => $accessKey));
		}

But we’ll need to look elsewhere for the value of the $stageId. There are defined in PKPApplication:

github.com

pkp/pkp-lib/blob/8e16a4fe1b118ecc2d539a2c19926296c26f55c5/classes/core/PKPApplication.inc.php#L54-L58


define('WORKFLOW_STAGE_PATH_SUBMISSION', 'submission');
define('WORKFLOW_STAGE_PATH_INTERNAL_REVIEW', 'internalReview');
define('WORKFLOW_STAGE_PATH_EXTERNAL_REVIEW', 'externalReview');
define('WORKFLOW_STAGE_PATH_EDITING', 'editorial');
define('WORKFLOW_STAGE_PATH_PRODUCTION', 'production');

The submission itself can return its current stage via Submission::getStageId():

github.com

pkp/pkp-lib/blob/8e16a4fe1b118ecc2d539a2c19926296c26f55c5/classes/submission/Submission.inc.php#L956-L962


	/**
	 * Get the submission's current publication stage ID
	 * @return int
	 */
	function getStageId() {
		return $this->getData('stageId');
	}

RickMath · April 20, 2018, 3:29pm

Yes I see all these. I am still not sure what to change to get the cc’s sent to the section editor and the journal editor.

Some more guidance may help me.

Thanks

Rick

ctgraham · June 13, 2018, 12:55pm

I have not tested the code, but something like

$email->ccAssignedSubEditors($submission->getId(), $submission->getStageId());

in ReviewReminder::sendReminder() might be what you are looking for. Again, I’m not familiar with what makes for a “Sub Editor” in OJS 3.x.

asmecher · June 13, 2018, 4:53pm

Hi all,

“Sub editor” is the Section Editor in OJS, and the Series Editor in OMP. It’s application-agnostic language used in the common library that both OJS and OMP build on.

Regards,
Alec Smecher
Public Knowledge Project Team

bog · January 13, 2021, 10:06am

Dear All,

we would need the same feature, but it is not clear where to include and what exactly. Could you help us out?

Thanks,
Bogi