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 |
action |
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 |
action_style |
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) creationAsc creationDesc |
If more than one item found, will choose under this criteria. Used in combination with:view="user&field" |
|
15.3 |
showmandatory |
(blank) y n |
Indicate mandatory fields with an asterisk (shown by default). |
y |
1 |
newstatus |
(blank) o p c |
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) y n |
Add registration fields such as Username and Password for use in registration
trackers |
n |
6.0 |
showdesc |
(blank) y n |
Show the tracker's description (not shown by default) |
n |
1 |
showfieldsdesc |
(blank) y n |
Show the tracker's field descriptions (shown by default) |
y |
12.1 |
showstatus |
(blank) y n |
Show the status of the items (not shown by default) |
n |
5.0 |
showtitle |
(blank) y n |
Display the title of the tracker at the top of the form (not shown by default) |
n |
1 |
sort |
(blank) y n |
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) _blank _parent _self _top |
Set the target parameter for the url (determines whether target will open in a
new page, etc.) |
|
4.0 |
rules |
(blank) y n |
Set up rules on field definitions to show and hide fields conditionally. |
n |
|
validateusers |
(blank) y n |
Here one can overrule the default validate users by e-mail preference. |
|
15.0 |
view |
(blank) group page user userandfield |
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 |
|
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. |
|
5.0 |
discarditem |
(blank) y n |
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) y n |
If set to Yes (y ), the tracker is contained in a form tag and has action buttons |
y |
6.4 |
embedded |
(blank) y n |
Embedded |
n |
1 |
transactionFinalStep |
(blank) y n |
Indicate whether this is the final transaction step |
|
15.0 |
ignoreRequestItemId |
(blank) y n |
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) y n |
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) y n |
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 |
fields |
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 |
fieldsfill |
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 |