You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by rc...@apache.org on 2020/05/20 01:58:16 UTC

[james-project] 07/11: JAMES-3184 Documentation

This is an automated email from the ASF dual-hosted git repository.

rcordier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit b1a8f984cdbe333b248d4a4f41c40f3f2dd48357
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Wed May 13 17:25:21 2020 +0700

    JAMES-3184 Documentation
---
 src/site/markdown/server/manage-webadmin.md | 32 +++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)

diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md
index c480748..3cfd77e 100644
--- a/src/site/markdown/server/manage-webadmin.md
+++ b/src/site/markdown/server/manage-webadmin.md
@@ -520,6 +520,17 @@ Will schedule a task for recomputing the fast message view projection for all ma
 
 [More details about endpoints returning a task](#Endpoints_returning_a_task).
 
+An admin can specify the concurrency that should be used when running the task:
+
+ - `messageRatePerSecond` rate at which messages should be processed, per second. Defaults to 10.
+ 
+This optional parameter must have a strictly positive integer as a value and be passed as query parameters.
+
+Example:
+
+```
+curl -XPOST /mailboxes?task=recomputeFastViewProjectionItems&messageRatePerSecond=20
+```
 
 The scheduled task will have the following type `RecomputeAllPreviewsTask` and the following `additionalInformation`:
 
@@ -529,7 +540,10 @@ The scheduled task will have the following type `RecomputeAllPreviewsTask` and t
   "processedUserCount": 3,
   "processedMessageCount": 3,
   "failedUserCount": 2,
-  "failedMessageCount": 1
+  "failedMessageCount": 1,
+  "runningOptions": {
+    "messageRatePerSecond":20
+  }
 }
 ```
 
@@ -955,6 +969,17 @@ Will schedule a task for recomputing the fast message view projection for all ma
 
 [More details about endpoints returning a task](#Endpoints_returning_a_task).
 
+An admin can specify the concurrency that should be used when running the task:
+
+ - `messageRatePerSecond` rate at which messages should be processed, per second. Defaults to 10.
+ 
+This optional parameter must have a strictly positive integer as a value and be passed as query parameters.
+
+Example:
+
+```
+curl -XPOST /mailboxes?task=recomputeFastViewProjectionItems&messageRatePerSecond=20
+```
 
 The scheduled task will have the following type `RecomputeAllPreviewsTask` and the following `additionalInformation`:
 
@@ -963,7 +988,10 @@ The scheduled task will have the following type `RecomputeAllPreviewsTask` and t
   "type":"RecomputeAllPreviewsTask",
   "username": "{usernameToBeUsed}",
   "processedMessageCount": 3,
-  "failedMessageCount": 1
+  "failedMessageCount": 1,
+  "runningOptions": {
+    "messageRatePerSecond":20
+  }
 }
 ```
 


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org