Use General Parameters

Introduction

For the time being general Parameters are used with two kinds of operators

The Formula operator, see also General Parameters in the "Formula Operator v04"
The Import SQL Operator, see also General Parameters in the "Import data from SQL sources v03" Operator

Prepare in TIS Editor

Prepare the data and calculations in a TIS Editor data node
Select the project in the left pane. Then you will see a tab "Parameter"
Go to the tab "General Parameters"

Enter the information

Give the Parameter a unique name that allows to distinguish this Parameter from others in the same project
Define the caption and description that will be used in TIS Board.
Select the kind of value the Parameter should have
Enter the value
Add this Parameter to the list of Parameters

The result looks like this

Note

If you select DateTime as Data Type you get an interface shown below with a calendar to select from.

Update the Parameter

After changing a value, do not forget to update the Parameter.

Text

Parameters with data type Text provide automatic removing of spaces when text is entered by a user on a controller portlet.

Note: XIH.SetParam does not consider any trim settings of the parameter.

Date and Time only

As of version 5.7 parameters can be defined as date or time only.

This allows the user in the TIS Board to choose dates or times only. Be aware that the values in the calculations in TIS Editor are always in a DateTime format, so that wildcards are used for times (00:00:00) and dates (01.01.1970).

Time Zones

As of version 5.8.2, DateTime, Date and Time parameters can be selected without respect to the time zone of the server.

Relative Date

As of version 5.10 Relative Date has been introduced as a new type.

Visualization shows the current mapping with "R"-prefix, e.g. "R31/12/2016".

XIH.GetParamValue() with result data type DateTime returns the relative date as a local time in relation to the actual time DateTime.Now.

Note: XIH.GetParam() with result data type Text returns the internally serialized definition as an XML string. Moreover note that XML strings are not properly displayed in the Editor's details-view of a data node, see column C below.

Item	first day
	last day
	secondlast day
	current day
	previous day
	next day
Base	secondlast = -2
	previous = -1
	current = 0
	next = 1
BaseType	week	first day of week is Monday
	month
	year
Offset	integer	number of units of OffsetType
OffsetType	days
	weeks
	months
	years

Examples:

Item	Base	BaseType	Offset	OffsetType	Now	Result
first	current	month	3	days	06.04.2016	04.04.2016
last	previous	month	0	days	06.04.2016	31.03.2016
last	current	year	0	days	06.04.2016	31.12.2016