Manual:Extension/Workflows/Activity/EditPage: Difference between revisions

(Created page with "==<span class="mw-headline">Description</span>== The ApprovePage activity will set the status of a page from ''draft'' to ''approved'' status. Flagging will be done with a spe...")
 
No edit summary
Line 1: Line 1:
==<span class="mw-headline">Description</span>==
==<span class="mw-headline">Description</span>==
The ApprovePage activity will set the status of a page from ''draft'' to ''approved'' status. Flagging will be done with a special user-context to avoid permission errors. This activity can ony be used with pages that have the approval feature ([[Reference:FlaggedRevs|FlaggedRevs]]) enabled.
The ''EditWikiPage'' activity appends content to an existing wiki page.  
{| class="wikitable"
{| class="wikitable" style=""
|+
! colspan="2" style="background-color:rgb(234, 236, 240);text-align:center;" |'''Short profile'''
! colspan="2" style="background-color:rgb(234, 236, 240);text-align:center;" |'''Short profile'''
|-
|-
| style="" |Name
| style="" |Name
| style="" |ApprovePage
| style="" |EditWikiPage
|-
|-
| style="" |Async
| style="" |Async
Line 15: Line 14:
|-
|-
|BPMN Extension Element "wf:type"
|BPMN Extension Element "wf:type"
|<code>approve_revision</code>
|<code>edit_page</code>
|}
|}


==<span class="mw-headline">Properties</span>==
==<span class="mw-headline">Properties</span>==


=== Input properties ===
Each input property can provide a default value if no other value is set by the workflow.
{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
! style="background-color:rgb(234, 236, 240);text-align:center;" |'''Name of property'''
! style="background-color:rgb(234, 236, 240);text-align:center;" |Name of property
!Source
!Source
! style="background-color:rgb(234, 236, 240);text-align:center;" |'''Description'''
! style="background-color:rgb(234, 236, 240);text-align:center;" |Description
! style="background-color:rgb(234, 236, 240);text-align:center;" |'''Type'''
!Possible values
! style="background-color:rgb(234, 236, 240);text-align:center;" |Type
|-
|-
| style="" |<code>comment</code>
| style="" |<code>title</code>
|<nowiki>-</nowiki>
|<nowiki>-</nowiki>
| style="" |The comment to be saved with the approval
| style="" |Name of the wiki page that will be edited by this activity.
|
| style="" |string
| style="" |string
|-
|-
|<code>revision</code>
|<code>user</code>
|  -
|Name of user that will be shown as making the edit.
|Default value: ''MediaWiki default''
|string
|-
|<code>content</code>
|  -
|Content that will be added to the wiki page.
|
|string
|-
|<code>mode</code>
|  -
|How the content is added to the wiki page.
|
* ''append:'' Content is added at the end of the page.
* ''replace:'' Content replaces all existing page content.
* ''prepend:'' Content is added at the beginning of the page.
|string
|-
|<code>minor</code>
|  -
|The edit will be marked as ''major'' or ''minor'' revision.
|
* ''1'' (=minor revision)
* ''0'' (=major revision)
|int
|}
 
=== Output properties ===
{| class="wikitable" style="width:100%;"
! style="background-color:rgb(234, 236, 240);text-align:center;" |Name of property
!Source
! style="background-color:rgb(234, 236, 240);text-align:center;" |Description
! style="background-color:rgb(234, 236, 240);text-align:center;" |Type
|-
|<code>revisionId</code>
| -
|The revision ID of the edited page.
|string
|-
|<code>timestamp</code>
| -
| -
|The revision ID to approve. If not provided explicitly, the page revision of the workflow context will be used, which may be outdated.
|The revision time of the edited page.
|int
|int
|}
|}
== Usage ==
<syntaxhighlight lang="xml">
<bpmn:task id="Activity_18egh9o" name="Edit page">
    <bpmn:extensionElements>
<wf:type>edit_page</wf:type>
</bpmn:extensionElements>
<bpmn:property name="title" default="Some page" validation="required"/>
<bpmn:property name="user" default="Mediawiki default" validation="existing-user"/>
<bpmn:property name="content" default="This is my test at editing"/>
<bpmn:property name="mode" default="append"/> <!-- ALlowed: append, replace, prepend -->
<bpmn:property name="minor" default="1"/>
<!-- Output properties -->
<bpmn:property name="revisionId"/>
<bpmn:property name="timestamp"/>
</bpmn:task>
</syntaxhighlight>

Revision as of 09:16, 18 January 2023

Description

The EditWikiPage activity appends content to an existing wiki page.

Short profile
Name EditWikiPage
Async Yes
BPMN type bpmn:Task
BPMN Extension Element "wf:type" edit_page

Properties

Input properties

Each input property can provide a default value if no other value is set by the workflow.

Name of property Source Description Possible values Type
title - Name of the wiki page that will be edited by this activity. string
user - Name of user that will be shown as making the edit. Default value: MediaWiki default string
content - Content that will be added to the wiki page. string
mode - How the content is added to the wiki page.
  • append: Content is added at the end of the page.
  • replace: Content replaces all existing page content.
  • prepend: Content is added at the beginning of the page.
string
minor - The edit will be marked as major or minor revision.
  • 1 (=minor revision)
  • 0 (=major revision)
int

Output properties

Name of property Source Description Type
revisionId - The revision ID of the edited page. string
timestamp - The revision time of the edited page. int

Usage

<bpmn:task id="Activity_18egh9o" name="Edit page">
    <bpmn:extensionElements>
		<wf:type>edit_page</wf:type>
	</bpmn:extensionElements>
	<bpmn:property name="title" default="Some page" validation="required"/>
	<bpmn:property name="user" default="Mediawiki default" validation="existing-user"/>
	<bpmn:property name="content" default="This is my test at editing"/>
	<bpmn:property name="mode" default="append"/> <!-- ALlowed: append, replace, prepend -->
	<bpmn:property name="minor" default="1"/>
	<!-- Output properties -->
	<bpmn:property name="revisionId"/>
	<bpmn:property name="timestamp"/>
</bpmn:task>




To submit feedback about this documentation, visit our community forum.

No categories assignedEdit

Discussions