Wikipedia:Bot activity monitor/Configurations/task/doc
Appearance
This is a documentation subpage for Wikipedia:Bot activity monitor/Configurations/task. It may contain usage information, categories and other content that is not part of the original wikipedia page. |
This template uses Lua: |
Bot task configuration parameters:
bot
: Name of the bot accounttask
: Name of the bot task, used in the alerts and status table.action
: (Default: "edit") Type of action the bot does: "edit" or any log action such as "delete", "move", "patrol", etc. You also specify a sub-action such as "delete/revision" or "block/reblock". The value given must be acceptable to either theletype
orleaction
parameter of mw:API:Logevents (unless the value is "edit").namespace
: Namespace(s) where the bot edits. Specify the namespace numbers (see Help:Namespaces) separated by commas if multiple.- Common namespace numbers: 0 (article), 2 (user), 4 (Wikipedia), 6 (file), 10 (template), 14 (category), 118 (draft). For respective talk namespaces, add 1 to those numbers.
title
: Title of the page where the bot edits. If it's not a single page, use|title_regex=
instead.title_regex
: Regex matching page titles where the bot edits.- This should entirely match the full page title. Use
.*
for "any characters".
- This should entirely match the full page title. Use
summary
: Edit summary (or log summary) used. If this is not fixed, use|summary_regex=
instead.- The exact edit summary. If the edit summary includes templates, please use summary_regex instead to prevent the templates from rendering on this page.
summary_regex
: Regex matching edit summary (or log summary) used by the bot.- This regex must match the task's edit summary in entirety (not partially). You can use
.*
in the starting and end for partial matching. This choice may be revisited in the future. - If it includes templates, use
\{
instead of{
to prevent templates from rendering on this page. - No piped links allowed!
- This regex must match the task's edit summary in entirety (not partially). You can use
min_edits
: (Default: 1) Minimum number of edits or log actions required in the given|duration=
.duration
: (Default: 3 days) The passed time window in which to look for edits.- For example if min_edits=4 and duration=5 days, we expect to find at least 4 edits in the past 5 days.
notify
: Get a talk page notification if the bot task is found to be inactive. Specify a user talk page name here (or just a username).- Notification will be sent once. If/when you've fixed the issue, you can dismiss the notification by removing it or changing its section title, so that the bot can notify you again if problems are found. If a redirect page is given here, the redirect will be followed.
email
: Get an email notification if bot task is inactive. Specify a username or an email address here.- If a username is specified, email will be sent through Wikipedia email system, in plain text format. You can specify an email address directly, for HTML format. Note: if your bot is hosted on Toolforge, you can use
tools.TOOL_NAME@tools.wmflabs.org
to avoid making your personal email public (emails sent to the tool are delivered to the email address linked with the Toolforge account). - Notification will sent once per the duration specified above. That is, if the check is for 1 edit per 3 days – you will receive one email per 3 days at max.
- If a username is specified, email will be sent through Wikipedia email system, in plain text format. You can specify an email address directly, for HTML format. Note: if your bot is hosted on Toolforge, you can use