Plugin Tracker


Use this wiki plugin to create a form for inputting an item into a tracker. You can specify what fields will be included in the form. Since Tiki6, this plugin can also be used as a simple way to create custom forms which output the result as pre-formatted wiki pages instead of tracker items.


Embed a form to populate a tracker
Introduced in Tiki 1. Required parameters are in bold.
Go to the source code
Preferences required: feature_trackers, wikiplugin_tracker

Parameters Accepted Values Description Default Since
(body of plugin) Confirmation message after posting form
trackerId digits Numeric value representing the tracker ID 1
ajax Use ajax to create and update tracker items instead of form submission via request variables. n
email To send an email once the tracker item has been created. Format: from|to|template For from and to, use an email address (separate multiple addresses with a comma), a username, a fieldId of a field containing either an email address or a username, a fieldId of a UserSelector or GroupSelector field, or "createdBy" or "lastModifBy" for the item creator or modifier. When username is being used, the email will be sent to the email address of the user on file. When sending to several emails using different template, provide the template name for the message body for each email; I.e., the first template will be used for the first to, the second template if exists will be used for the second from (otherwise the last given template will be used). Each template needs two files, one for the subject one for the body. The subject will be named template_subject.tpl. All the templates must be in the templates/mail directory. Example: webmaster@my.com|a@my.com,b@my.com|templatea.tpl,templateb.tpl (templates/mail/tracker_changed_notification.tpl is the default from which you can get inspiration). 2.0
emailformat Choose between values text or html, depending on the syntax in the template file that will be used text 6.1
preview To add a preview button with the label set by this parameter. Default: Preview. Useful to preview the computed fields of an item. Preview 2.0
reset Label for the reset button, to return all fields to their default values. reset 4.2
tpl Name of the template used to display the tracker items. In the template, the smarty variable {$f_id} will be replaced with the appropriate input tag, with id representing the field ID. The form tag and the submit button are generated by Tiki outside the template 2.0
values Colon-separated list of default values corresponding to the fields parameter. First value corresponds to first field, second value to second field, etc. Default values can be set by using autosavefields and autosavevalues as URL parameters. 2.0
separator: :
Colon-separated labels for form submit buttons. Default is Save. When set to NONE, the save button will not appear and values will be saved dynamically. Save 1
separator: :
Sets button style classes for action buttons. If multiple buttons have been set in the action parameter, the same number of colon-separated styles must be set here. Example:btn btn-secondary:btn btn-success:btn btn-primary float-end btn btn-secondary 14.1
rulesparent text JQuery selector for the parent object to show or hide when executing field rules. .tracker-field-group:first
fieldtofilter Field to filter user tracker items to: view="user&field" 15.3
fieldtofiltervalue Value to filter user tracker items to: view="user&field" 15.3
fieldsfilldefaults Colon-separated list of default values for Multiple Fill Fields. 9.0
fieldsfillseparator Choose separator between fields in each line of the Multiple Fill text area. Default is pipe (|). | 9.0
fieldsfilldescription text Explanatory text below the Multiple Fill Fields text area. Default is the list of the fields which should be in each line. Put a space for no visible text below the Multiple Fill Fields text area. 24.4
fieldsfilllabel text Explanatory text on the left of the Multiple Fill Fields text area. Default is "Insert one item per line:". 24.4
chosenGroup text The user enters this group via the registration (only a single group name is supported) Registered 15.0
status Status of the item used in combination with: view="user"orview="user&field" 6.0
userfieldtofilter User field to filter user tracker items to: view="user&field" 15.3
fieldtofiltercriteria (blank)
If more than one item found, will choose under this criteria. Used in combination with:view="user&field" 15.3
showmandatory (blank)
Indicate mandatory fields with an asterisk (shown by default). y 1
newstatus (blank)
Default status applied to newly created or saved items. 2.0
outputwikinamespace pagename Name of namespace that is used for the wiki page that is created when outputting to a wiki page. 13.0
registration (blank)
Add registration fields such as Username and Password for use in registration trackers n 6.0
showdesc (blank)
Show the tracker's description (not shown by default) n 1
showfieldsdesc (blank)
Show the tracker's field descriptions (shown by default) y 12.1
showstatus (blank)
Show the status of the items (not shown by default) n 5.0
showtitle (blank)
Display the title of the tracker at the top of the form (not shown by default) n 1
sort (blank)
Display columns in the order listed in the fields parameter instead of by field ID (field ID order is used by default) n 2.0
transactionStep digits Transaction step number specifying the order of the transaction steps. The first step must be 0. 0 15.0
transactionName alpha The transaction identifier. This identifier connects the various trackers into a single transaction. Must be unique per transaction. The multiple steps in a single transaction must share the same transaction name. 15.0
transactionPreviousURL url The page to go back to when the "previous" button is clicked. 18.4
transactionPreviousLabel text Text for the "previous" button label. 18.4
url url
separator: :
URL the user is sent to after the form is submitted. The string itemId will be replaced with itemId=xx where xx is the new (or current) itemId. This parameter can be used in combination with the TABS plugin using ?cookietab=1&itemId (change the cookietab parameter's value depending on the tab you want the user to be sent to). 1
target (blank)
Set the target parameter for the url (determines whether target will open in a new page, etc.) 4.0
rules (blank)
Set up rules on field definitions to show and hide fields conditionally. n
validateusers (blank)
Here one can overrule the default validate users by e-mail preference. 15.0
view (blank)
Determine which items will be affected byt the form. If set to user and trackerId is not set, then the user tracker associated with the default group will be affected. If trackerId is set, then the item associated with the user in that tracker will be affected. If set to page, the item associated with that page will be affected (trackerId must be set in this case). 1
colwidth ## or ##% Specify the width in pixels or percentage of the first column (the labels) in the tracker form. 3.0
wiki pagename Name of the wiki page containing the template to display the tracker items. This page must have the permission tiki_p_use_as_template assigned to the Anonymous group to be used as a template. 2.0
autosavevalues text
separator: :
Colon-separated values corresponding to autosavefields. Special syntax cases:
categories(x) - selects the first child category under a category with ID x for use in a category field
category(x) - selects a category with this ID x for use in a category field
preference(x) - inserts the value of the preference with x being the preference name.
discarditem (blank)
Used with outputtowiki - whether to discard the tracker item itself once the wiki page is created, so that, in effect, the tracker is just a vehicle to create form fields to facilitate creating wiki pages. 6.0
formtag (blank)
If set to Yes (y), the tracker is contained in a form tag and has action buttons y 6.4
embedded (blank)
Embedded n 1
transactionFinalStep (blank)
Indicate whether this is the final transaction step 15.0
ignoreRequestItemId (blank)
Do not filter on the parameter itemId if in the url (default is to filter) n 6.0
urlparams url
separator: :
Input form parameters (or field IDs) separated by a colon (:) to pass them in the URL after the form is submitted and redirected to the URL specified in the url param. Example: urlparams="1:2:3:trackit". Enter * to keep all the submitted parameters in the URL. 19.0
overwrite (blank)
Overwrite current field values of the item with the input values. Does not overwrite wiki pages and does not work when the discarditem parameter is set to Yes (y). n 6.0
outputwikirelation (blank)
Store tiki.wiki.linkeditem and tiki.wiki.linkedfield relation from the created wiki page when outputting to a wiki page. Optionally, (separate feature to be turned on in admin panel) these relations are used to sync page renames with the field specified in outputtowiki, and also optionally to redirect page viewing to the tracker item instead (where you can then include the page if needed). n 13.0
outputwiki pagename Name of the wiki page containing the template to format the output to wiki page. Must be set for outputtowiki to work. The template can contain variables to represent fields, for example {$f_6} would result in the value of fieldId 6. Also {$f_itemId} can be used for the itemId and if you have set register to yes, you can use {$register_login} and {$register_email}. 6.0
separator: :
Colon-separated list of field IDs to be displayed in the form as input fields. If empty, all fields will be shown. Example: 2:4:5 1
itemId digits ItemId identifying the item to be edited. 3.0
separator: :
Colon-separated list of field IDs to be filled with multiple values, to create multiple items in one save. If empty, only one item will be created. Only for item creation. Example: 2:4:5 9.0
outputtowiki digits Output result to a new wiki page with the name taken from the input for the specified fieldId 6.0
autosavefields digits
separator: :
Colon-separated list of field IDs to be automatically filled with values upon save. 5.0
levelupfields digits
separator: :
Used with the autosavefields and autosavevalues parameters. Colon-separated list of field IDs being auto-saved where the specified auto-save value will not take effect if it is less than or equal to the current value of the field 8.0

The overwrite parameter is only to overwrite tracker items (not wiki pages) - not useful when discarditem="y"
 Note 2
When using outputwiki as template you cannot use Smarty syntax programmatically because the resulting output is static wiki page (not computed against an existing Tracker Item like with Pretty Trackers and TrackerLists) - you can use only {$f_XX} to indicate the fields values or Argument variables.


  • You can limit the tracker fields that can be used in this plugin in the field admin panel of the tracker:
    "Field is public? for use with trackerlist plugin option
    For Tiki 9.x, the User Selector field (the "userId" field in your tracker, perhaps), edit the field, Permissions, Visibility, Visible by All (even though that's counter-intuitive (you want those items private to that use)).
  • If you have a tracker that has only one item per user/IP or if you use the plugin with the param view=user, the plugin will automatically prefill the item if that already exists.
This plugin can not be used on a cached wiki page.


Copy to clipboard
{TRACKER(trackerId="1" fields="1:3:4" action="Send")} Thanks for your contribution! {TRACKER}

How to pre-fill some fields

In some situation you want to go to a TRACKER page (in our example named SubmitOrder) where fields are automatically pre-filled. In this case you can use an URL like this:

When in the page SubmitOrder, you click on Save, and the field 1 will be filled with the value tikiwiki. If the field 1 is multivalue field (ex: category), the value will be added to the potentially additional value the user has selected whatever the user does.

The construction of such URL can use the feature 'Wiki argument variables'
(see Advanced Wiki Syntax usage examples)

You could also use the url parameter "prefills" with the corresponding "values". See more information here:

See also PluginTrackerList to see how to use the parameter url to transfer an itemId to an URL or PluginJQ if you want to use jQuery.

How to fill an item in more than one step

If you want to fill some fields of an item in a page and to fill some other ones in another page, you need to use the param url with the itemId option.
Example (uses SEFUrl enabled links):

Copy to clipboard
{tracker trackerId="1" fields="1:2:3" url="Page2?itemId"}


Copy to clipboard
{tracker trackerId="1" fields="4:5:6" url="Page3?itemId"}

Page3 - the final one that will display the currently submitted itemId:

Copy to clipboard
{trackerlist trackerId="1" fields="1:2:3:4:5:6"}

It is also possible to use tabs and link to each tab using "cookietab".
Note that the tracker item will be saved by sequence so you better check that no mandatory field rules are on the way.

Copy to clipboard
{TABS(tabs="First Tab|Second Tab|Third Tab")} {tracker trackerId="1" fields="1:2:3" action="Next" url="pageName?cookietab=2&itemId"} ///// {tracker trackerId="1" fields="4:5:6" action="Next" url="pageName?cookietab=3&itemId"} ///// {TRACKER(trackerId="1" fields="7:8:9" action="Save")}Saved!{TRACKER} {TABS}

How to put multiple tracker plugins into a single transaction?

New in Tiki15
Plugin tracker's transaction feature enables a sequence of trackers to be chained into a single transaction, which is submitted only after the user submits the last tracker form. Otherwise the transaction is cancelled.
The easiest way to use the feature is to create a wiki page for each of the steps.
Here is an example.

  1. wiki page: Register+Step+1
    Copy to clipboard
    {tracker trackerId="1" fields="2" action="Next" ignoreRequestItemId="y" registration="y" chosenGroup="Registered" transactionName="RegistrationTransaction" transactionStep="0" transactionFinalStep="n" url="Register+Step+2"}
  2. wiki page: Register+Step+2
    Copy to clipboard
    {tracker trackerId="2" fields="4" action="Finish" ignoreRequestItemId="y" transactionName="RegistrationTransaction" transactionStep="1" transactionFinalStep="y"}

The registration and the tracker records of trackerId 1 and 2 will only get saved after the user presses Finish on Register+Step+2.

How to write a template to display the form elements on the wiki page where the plugin is saved

As mentioned, in a template, use the {$f_id} syntax to insert the value of fieldId=id.
It is also possible and nowadays recommended to use the {$f_permanentname} syntax to insert the value of ''permanent name" of the tracker field instead of the id.
It is also recommended to use a specific custom prefix for all fields of a tracker (one prefix per tracker) to allow to reuse and to provide existing trackers easily with a profile. Syntax: {$f__prefix_permanentname}. The prefix can be set in the tracker preference settings.

It is also possible to insert the ItemId itself, which is useful to create new wiki pages with tracker plugins inside. To do this you'll have to add an Auto-Increment Field to your tracker, with the appropriate options to auto-fill it with the itemId. This new field content (itemId value) can then be inserted in the template with the syntax seen above.

Since Tiki 15.1, wiki page templates can be (optionally) used for email notifications using the "wiki:page name tpl" format instead of template_name.tpl files in the templates/mail dir. Tiki will use a page "page name subject tpl" if found.
Please mind, that wiki pages are more for quick and easy use cases, for testing and for proof of concept, whilst .tpl files in the server directory are more reliable and much better to handle in larger projects or for advanced use cases.

Mind: .tpl templates for emails are stored in the folder templates/mail

How to go from TRACKERLIST to TRACKER on this item

Copy to clipboard
{trackerlist trackerId="1" fields="1:2:3:4:5:6" url="Page1?itemId"}


How to send email to a recipient when new tracker item is created

You can use the parameter email to send an email once the tracker item has been created.

From Tiki15 onwards, you need to have:
  • a template:
    • placed in your Tiki files root in the templates/mail directory,
    • specified as a wiki page as "wiki:page name tpl",
  • and you need to set an email address to monitor changes of the Tracker, at the Tracker properties level
    ("Trackers > Edit tracker > Notifications > Copy activity to email"). (This should not be needed; is this a regression? )

The format for the email parameter is: from|to|template.

  • from is the sender email that will be used for the notification. Multiple addresses can be set (separate multiple addresses with a comma)
  • to is the recipient(s) to whom the email address will be sent.
    Multiple addresses can be set (separate multiple addresses with a comma).
    Since Tiki 11 (maybe earlier) you can set a tracker field (same item) being used in the tracker plugin template (required).
  • template is the template(s) to be used for email subject and body. (separate templates can be used)
    Using several emails and several templates it is possible to send different email (different subject & body) to different people. (see examples below)
  • The following values can be used for from and to:
    email(s), username(s), fieldId(s) or createdBy
    createdBy was added in Tiki 17 and might be back-ported to 16.
    username sends to the email of the registered user account and createdBy sends to the email of the currently logged in creator of the item.

Since Tiki 15 .1, Tracker plugin allows Items List fields to be used as the to or from fields in the email parameter. They will be shown in the form as read only labels. This might be useful in cases such as:

  • One tracker defines business shops, with its members to be notified of changes related to that shop. And...
  • A second tracker handles data of products from shops, and they have:
    • one field as Item link to relate the product with their corresponding shop where they sell it.
    • another field from the second tracker is an Items list, to indicate the person to be notified, as user defined in the first tracker for that shop.
  • You use the email parameter in a plugin tracker call to tracker 2, using the field corresponding to the person (as field id in tracker 2) as the recipient or sender of the email.

Since Tiki 16.3, email recipients option allows to set fieldId of a UserSelector (including multiple users selected) and GroupSelector.

Basic plugin usage

single recipient, single template

Copy to clipboard
{TRACKER(trackerId="1" fields="1:2:3" action="Send" email="sender@domain.com|recipient@domain.com|templatename.tpl")}{TRACKER}

single recipient (creator), default site sender, basic default template (for quick proof of concept)

Copy to clipboard
{TRACKER(trackerId="15" action="Send" email="|createdBy|")} Thank you for submitting an issue. We will come back to you as soon as possible. What do you want to do now: ((Issue Tracker|submit another issue)) or ((HomePage|browse the website))? {TRACKER}

single recipient (creator), custom sender, custom template for body, default basic subject

Copy to clipboard
{TRACKER(trackerId="15" action="Send" email="info@example.com|createdBy|mytemplate.tpl")} Thank you for submitting an issue. We will come back to you as soon as possible. What do you want to do now: ((Issue Tracker|submit another issue)) or ((HomePage|browse the website))? {TRACKER}

single recipient (creator), custom sender, custom template for body, custom subject template

Copy to clipboard
{TRACKER(trackerId="15" action="Send" email="info@example.com|createdBy|mytemplate.tpl,mytemplate_subject.tpl")} Thank you for submitting an issue. We will come back to you as soon as possible. What do you want to do now: ((Issue Tracker|submit another issue)) or ((HomePage|browse the website))? {TRACKER}

Advanced plugin usage

multiple recipients, single template

Copy to clipboard
{TRACKER(trackerId="1" fields="1:2:3" action="Send" email="sender@domain.com|recipient_1@domain.com,recipient_2@domain.com,recipient_3@domain.com|templatename.tpl")}{TRACKER}

In this case it will send the same notification to recipient_1, recipient_2 and recipient_3.

multiple recipients, multiple templates

Copy to clipboard
{TRACKER(trackerId="1" fields="1:2:3" action="Send" email="sender@domain.com|recipient_1@domain.com,recipient_2@domain.com,recipient_3@domain.com|templatename_a.tpl,templatename_b.tpl,templatename_c.tpl")}{TRACKER}

In this case each recipient will receive a different notification. The recipient_1 will receive email using template_a, recipient_2 will receive email using template_b and recipient_3 will receive email using template_3.

creator plus second recipient, two different body templates and two different subjects

Copy to clipboard
{TRACKER(trackerId="15" action="Send" email="info@example.com|admin@mysite.com,createdBy|admin-template.tpl,creator-template.tpl,admin-template_subject.tpl,creator-template_subject.tpl")} Thank you for submitting an issue. We well come back to you as soon as possible. What do you want to do now: ((Issue Tracker|submit another issue)) or ((HomePage|browse the website))? {redirect page="Test-Tracker-Creator-Email"} {TRACKER}

single recipient (field), custom sender, custom template to fill the tracker plugin, custom template for body, custom subject template

Wiki page

Copy to clipboard
{TRACKER(trackerId="15" action="Send" email="info@exemple.com|12|mytemplate.tpl" wiki="Template page")}Thank you!{TRACKER}

Template page

Copy to clipboard
{TR()}Name{TR}: {$f_11} {TR()}Email address{TR}: {$f_12}

When filling the form (using the template) the email address from the field 12 will be used as recipient.

Templates (to create the email subject and email body)

Each template needs two files, one for the subject one for the body. All the templates must be in the templates/mail directory or (since Tiki15.1) in wiki pages and specified as "wiki:page name tpl" (you have to include the "tpl" exact word in the name without a dot, and place it, for instance, at the end).

Email body and subject naming conventions

The naming of these files needs to be slightly different depending on whether you use template files on disk or wiki pages as templates.

Template files on disk

If you want to use smarty template files on disk:

  • body: "mytemplate.tpl"
  • subject: "mytemplate_subject.tpl"


Copy to clipboard
{TRACKER(trackerId="1" fields="1:2:3" action="Send" email="sender@domain.com|recipient@domain.com|mytemplate.tpl")}{TRACKER}

Note that you don't specify the subject template in the tracker plugin call, but the subject needs to exist with the corresponding name ("mytemplate_subject.tpl" in this case) if you want to have the subject message customized.

Wiki pages as Smarty templates

If you want to use wiki pages as smarty templates:

  • body: "page name tpl"
  • subject: and "page name subject tpl"
    note that the tpl word (without a dot) needs to be prepended with the word "subject " (subject and a space)


Copy to clipboard
{TRACKER(trackerId="1" fields="1:2:3" action="Send" email="sender@domain.com|recipient@domain.com|wiki:page name tpl")}{TRACKER}

Note that you don't specify the subject template in the tracker plugin call, but the subject needs to exist with the corresponding name ("page name subject tpl" in this case) if you want to have the subject message customized.

Subject template

Copy to clipboard
Hello, the {tr}item{/tr} "{$f_name}" {tr}was modified at{/tr} {$server_name} in {$mail_trackerName}

Where {$f_name} will be the content of the field name, {$server_name} is the domain name and {$mail_trackerName} is the tracker name.

Body template

Copy to clipboard
{tr}Hello,{/tr} {tr}Title:{/tr} {$f_name} {tr}Description:{/tr} {$f_description} {tr}View the tracker item at:{/tr} {$mail_machine_raw}/tiki-view_tracker_item.php?itemId={$mail_itemId}

Template - variable list

Not all wiki variables work (pretty tracker syntax won’t work).

The current timestamp
User login
The tracker itemId
The item "title"
Tracker id
Tracker name
URL of the request (example: https://doc.tiki.org/PluginTracker )
URL of the site root (example: https://doc.tiki.org )
Server name (example: doc.tiki.org )
The item's new status (e.g. Open, Pending or Closed, translated)
$f_123 or $f_permanentName
Values of the fields

See also:


Get Started

Admin Guide User Guide


Keywords serve as "hubs" for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):

Accessibility (WAI and 508)
Articles and Submissions
BigBlueButton audio/video/chat/screensharing
Browser Compatibility
Link Cache
Clean URLs
Communication Center
Compression (gzip)
Contacts (Address Book)
Contact us
Content Templates
Custom Home and Group Home Page
Date and Time
Debugger Console
Directory of hyperlinks
Documentation link from Tiki to doc.tiki.org (Help System)
Dynamic Content
Dynamic Variable
External Authentication
Featured links
File Gallery
Friendship Network (Community)
Gmap Google maps
i18n (Multilingual, l10n)
Image Gallery
Inter-User Messages
Kaltura video management
Live Support
Logs (system & action)
Look and Feel
Map with Mapserver
Meta Elements
Mobile Tiki and Voice Tiki
Performance Speed / Load
Platform independence (Linux-Apache, Windows/IIS, Mac, BSD)
Profile Manager
Search engine optimization
Search and Replace
Semantic links
Shadow Layers
Shopping cart
Social Networks
Spam protection (Anti-bot CATPCHA)
Tell a Friend, alert + Social Bookmarking
Theme CSS & Smarty
Tiki Manager
User Administration including registration and banning
User Files
User Menu
Web Services
Wiki History, page rename, etc
Wiki Syntax
Wiki structure (book and table of content)

Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki