SetTemplateParams

Description

The SetTemplateParams activity allows template parameters to be set automatically on a page.

  • Templates are accessed by the order of appearance on the page.
  • Non-existing templates are counted as links, so they do not count in this list.
  • Params inside the template can be specified by their name, or the index in case of non-named params. Index for non-named params starts at 1 (not 0!), as to be consistent with how template params are accessed in the template itself.
  • Nested templates are not supported as of now.
Short profile
Name SetTemplateParams
Async Yes
BPMN type bpmn:Task
BPMN Extension Element "wf:type" set_template_param

Properties

Input properties

Name of property Source Description Possible values Type
title - Name of the wiki page that includes the template(s). "Main_page" string
user - Name of user that will be shown as revision user. "WikiSysop" string
template-index - Index of the template on page (starting from 0). "2" int
template-param - Param to modify. Can be a string in case of named params, or a number, in case of non-named params (starting from 1, accessor for the param) "comment" OR "1" int, string
value - New parameter value to set. "New value of parameter"
minor - The edit will be marked as major or minor revision. default="0"
  • 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. timestamp

Example

<bpmn:task id="EditTemplate" name="Edit template">
	<bpmn:extensionElements>
		<wf:type>set_template_param</wf:type>
	</bpmn:extensionElements>
	<bpmn:property name="title" default="DummyPage" validation="required,existing-title"/>
	<bpmn:property name="user" default="WikiSysop" validation="existing-user"/>
	<!-- Index of the template on page (starting from 0) -->
	<bpmn:property name="template-index" default="2"/>
	<!-- Param to modify. Can be a string in case of named params, or a number, in case of non-named params (starting from 1, accessor for the param) -->
	<bpmn:property name="template-param" default="1"/>
	<!-- New value to set -->
	<bpmn:property name="value" default="Super edited param"/>
	<bpmn:property name="minor" default="0"/>

	<!-- Output properties -->
	<bpmn:property name="revisionId"/>
	<bpmn:property name="timestamp"/>
  <bpmn:incoming>Flow_1qh6vpl</bpmn:incoming>
  <bpmn:outgoing>Flow_0if1kyp</bpmn:outgoing>

</bpmn:task>




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

No categories assignedEdit

Discussions