Tools to clean old incomplete submissions #4540
Comments
|
A command line tool might not be convenient for editors / journal managers. Maybe add an option where the journal manager can enter a time span (in days), after which incomplete submissions are deleted and include the option to never delete them. |
|
@NateWr, do you recall this change? I don't think showing incomplete submissions was an intentional change. Most likely this came with the move to the API/vue.js toolset for submission lists. |
|
also https://forum.pkp.sfu.ca/t/delete-incomplete-submission/51229 (did not test if that is true) |
|
To clarify, your own incomplete submissions show up in My Queue. Journal Managers and admins see others incomplete submissions in All Active. This was intentional. If I recall, it was done to help cases where authors get stuck during submission and email the editors for help. Editors wanted to be able to "hop into it" to see for themselves how far the author had gotten. The All Active list has always been intended as a master list to be used infrequently. However, in conversations at sprints, it seems that many senior editors use it more like a My Queue without requiring them to be assigned. How and where they should be presented is an open question. I suspect that small journals eager for submissions may want to follow up and encourage the author to complete their submission, but large journals overwhelmed with submissions would probably prefer they are automatically cleaned up and kept out of sight. A separate "incomplete" list might be worth considering down the road. Anyone who would like to change the default behaviour can do so easily by modifying the parameters passed to the active list. Here's a quick sample plugin to do that (not tested). |
|
I think it is a good feature to have those visible in the listing, but like one of our editors said, it would be nice to be able to easily remove the older ones easily. As I mentioned above, I would be happy with a simple command line tool for the site admins to manage. This is not something journals ask for all the time. Basically a tool with two parameters: context_path and timelimit. |
|
It will probably be a while before we get to submission deletion in our CLI tool, but definitely good to have if you're willing to write the |
|
Not probably something I will have time right now, but can you link an example here of a similar endpoint. Are you simply thinking of extending this https://github.com/pkp/ojs/blob/master/api/v1/submissions/SubmissionHandler.inc.php |
|
Oh, looks like we've already got this in https://github.com/pkp/pkp-lib/blob/master/api/v1/_submissions/PKPBackendSubmissionsHandler.inc.php#L43-L52! Deleting from a CLI tool would just involve getting the submissions you want then passing each one to the delete method in the service class: $submissionService = Services::get('submission');
$submissions = $submissionService->getMany(['contextId' => X, 'isIncomplete' => true]);
foreach ($submissions as $submission) {
if (/* submission last modified date or original submission date or something is too old */) {
$submissionService->delete($submission->getId());
}
} |
|
+1 from PKP|PS where we sometimes need to create test/incomplete submissions in client journals and usually delete them right away. In 3.3 it's not possible if created from a JM role (I guess we'll have to be mindful to create them as "author") |
|
+1 from PKP|PS. A journal on 3.3 is looking to clear a significant (25+) number of incomplete submissions done by authors. Logging in as an author for each is rather time-consuming. |
|
We have cases of journals coming from OJS 2 with hundreds of incomplete submissions. OJS 2 hid these submissions from the editor so they ended up piling up. |
|
I had a request from a hosted client for both a tool to clear multiple incomplete submissions at once and a separate list of incomplete submissions, separate from the archive. |
amandastevens
added
the
Hosting
|
+1 from PKP|PS - had a client with multiple completely blank submissions with no record of who initiated them in the log (is this what happens when the Journal Manager creates them?), making them arduous to clean up. |
|
+1 from PKP|PS client that would like to remove incomplete submissions on multiple journals as well |
|
+1 Also the authors themselves should be have the possibility to delete a submission they started. Currently they can only abort it, which will only save it and return. |
NateWr
added
the
Community:2:Priority
|
Dear community, What version of OJS that including this release? Thanks |
|
@polkeskdi this issue is not scheduled against any Milestone, which means it is not planned for any future release. |
|
Thanks @NateWr Has the community solved the problem about to clean incomplete submissions? I lack the issue from PKP's forum Thanks again |
|
@polkeskdi no, this has not been solved yet. |
|
To make it easier for people to find, I'm noting references to this issue. It was covered at the Helsinki 2022 Sprint and the summary can be read at: There is a PR at pkp/ojs#3431 Also, we have this comment related to the issue of incomplete submissions no longer showing to editors by default: #7495 (comment) |
NateWr
added
the
Enhancement:2:Moderate
|
When you solve this problem? When users Journal Manager can delete incomplete submissions or any submissions with simple way! |
|
Any updates on this? How could such submissions be deleted or archived? They appeared after upgrade. |
|
@01Kuzma, I assume you're asking about OJS; what version did you upgrade from, and what version did you upgrade to? |
|
@asmecher , sorry, I supposed this issue is about OJS. |
|
I would really like to have this feature too!!! |
|
We are using |
|
The Delete Incomplete Submission tool is not working for our 3.3.0-15 version, the error thrown is Class 'APP\core\Application' not found. If I compare |
|
@aleskl, that code is written to be used with 3.4.0, not 3.3.0; we've added namespaces and made numerous other changes to our conventions to make them more modern since 3.3.0 was released. |
|
Hello team, @asmecher we are running 3.4.0.3. I downloaded deleteIncompleteSubmissions.php and tried running php tools/deleteIncompleteSubmissions.php 600 --dryrun and ran into two issues.
|
|
We intend to soon create a plugin so that editors themselves can delete incomplete submissions, as we receive this request quite frequently. Our priority is OJS 3.3 at the moment. |
|
Hi! We have a preliminary version of the plugin. If you want to try it out (backup first, please), there's a package available for OJS 3.3: https://github.com/lepidus/deleteIncompleteSubmissions |
|
Hi @diegoabadan We are using OJS-3.4 and I hope soon we will get a plugin for the same. |
|
We are involved in the release of other plugins, and currently we don't have a deadline, but it is in the plans to have it for OJS 3.4 soon. |
|
Who did use this plugin? |
Who did use this plugin? |
|
Hi @cordoba3030 This first version of the plugin is very simple and not very informative. You need to check the journal's dashboard for incomplete submissions:
Then go to the list of plugins, find it and click on the "Delete submissions..." option. Once you've deleted the incomplete submissions using the plugin, go back to the list of submissions and the incomplete ones that meet the chosen time criteria should have disappeared. |
|
Thanks!! It works!.. |
|
Hello @NateWr I followed your comment from #4540 (comment) and since it was 5 years ago, I tried adopting for 3.4, accounting for the deprecated functions. Using the context of this sprint https://pkp.sfu.ca/2022/08/05/helsinki-2022-sprint-notes-released-cleaning-incomplete-submissions/, our perspective is from the journal editor's seeing "incomplete" submissions flooding their Active queue, rather than the sprint's focus on the site managers deleting all incomplete submissions. Your "Hide Incomplete Submissions" plugin seems to be a reasonable workaround, configurable by each journal editor if they want to see incomplete submissions or not. I've gotten this far but got stuck. I'm able to enable the plugin and ensure it's running on the right page, but I don't understand the filtering & template logic enough to determine next steps. <?php
namespace APP\plugins\generic\removeIncompleteFromActiveList;
use PKP\plugins\GenericPlugin;
use PKP\plugins\Hook;
use APP\template\TemplateManager;
class RemoveIncompleteFromActiveListPlugin extends GenericPlugin {
/**
* Register the plugin
*/
public function register($category, $path, $mainContextId = NULL) {
// Register the plugin even when it is not enabled
$success = parent::register($category, $path);
if ($success && $this->getEnabled()) {
// Do something when the plugin is enabled
Hook::add('TemplateManager::display', [$this, 'modifyTemplateData']);
}
return $success;
}
/**
* Provide a name for this plugin
*
* The name will appear in the Plugin Gallery where editors can
* install, enable and disable plugins.
*/
public function getDisplayName() {
return 'Hide Incomplete Submissions';
}
/**
* Provide a description for this plugin
*
* The description will appear in the Plugin Gallery where editors can
* install, enable and disable plugins.
*/
public function getDescription() {
return 'This plugin will hide incomplete submissions from the Active submissions list.';
}
/**
* Fired when the `TemplateManager::display` hook is called.
*
* @param string $hookname
* @param array $args [$templateMgr, $template, $sendContentType, $charset, $output]
*/
public function modifyTemplateData($hookName, $args) {
// Check for the correct template
$template = $args[1];
if ($template != 'dashboard/index.tpl') {
return;
}
// Retrieve the TemplateManager
$templateMgr = $args[0];
// Attach a custom piece of data to the TemplateManager
$activeListData = $templateMgr->getTemplateVars('activeListData');
$activeListData['getParams']['isIncomplete'] = false;
// Something like this to attach a filter?
// $filters = $templateMgr->getTemplateVars('filters');
$templateMgr->assign('activeListData', $activeListData);
}
}How I can adopt the core of this code -- to hide submissions with isIncomplete. Can you/anyone provide additional guidance or point me in the right direction on what to try next? Thank you! |
|
Quick follow up here. As an alternative, our journal editors mentioned flipping the "Incomplete" filter in the Submissions tab. In other words, can we build a filter for "NOT Incomplete" in order to hide the Incomplete submissions in their queue? 
I dug deeper and traced the Submissions API call over to 
I confirmed this is the case, whether putting &isIncomplete=true or &isIncomplete=false has no effect on the Submissions API endpoint. 
I traced this to the source
My one idea/hack that worked was adding the 
While this works, this applies across my entire OJS instance and I don't think my hacking core pkp/lib is a good solution -- my question for the PKP team (tagging @asmecher here) is can this functionality be added via a plugin (see my plugin attempt in the comment above)? I don't have enough PKP core knowledge to know whether the plugin architecture method is feasible or not to achieve this behavior. Thank you! |
|
Hi @wilsonww |
Since a couple of releases ago OJS started to show the incomplete submissions for editors. Some editors have asked whether they can remove these and if there is some automatic way of doing it.
Of course there could be legit incomplete submissions included, but maybe we could have at least a command line tool for removing older incomplete submissions from the database?
The text was updated successfully, but these errors were encountered: