Important note Retirement of icTime and Retirement of biz on December 29th, 2023

Parameter sets

A user page parameter set is a set of populated values saved from a page for later usage. This feature has been introduced with version 5.8.6.0.

 

A page parameter set belongs to the user who has created the set. The set can be made visible be changing the “Shared” type of the entry.

 

Column

Description

Column

Description

Name

the name of the user page parameter set. Can be changed.

Page type

The page type shows the destination (and origin) the parameter set is applicable for. Can not be changed.

Shared

  • * private: the entry will not be shown to other users

  • * shared: the entry will be shown to other users

description

User definable description

link

Clickable link: Will change to the target page (e.g. Reporting). The default action of the page will load the page (or part of the page) with the values belonging to this parameter set.

 

Allowed operations:

  • delete: You can only delete your own parameter sets

  • Update: you can only update your own paramter sets

 

Optional link parameters:

Link parameter

Description

Link parameter

Description

postLoadAction=execute

will execute the default operation on the target page after the parameter set has been loaded. Adding this parameter to the page type “reporting filter parameter set” will execute the “create” action in the reporting page (example: http(s)://yourJiraHost/secure/secure/ICTimeCreateReportAction!default.jspa?loadParameterSetId=5&postLoadAction=execute

overrideParam=xxx

This can be used to override parameters either defined in the parameter set or set parameters which are available on the target page. xxx must be a URI encoded Json Object (see examples below)

 

Page Types

 

Reporting filter parameter set

A parameter set of page type “reporting parameter set” can be created from the reporting (https://interconcept.atlassian.net/wiki/spaces/ICTIME/pages/30048306 ).

 

List of parameters which can be overriden

All values are arrays of strings.

Parameter key

Parameter value description

Parameter key

Parameter value description

filterSelection

The Jira (favorite) filter to apply

issueSelection

Issue key

projectSelection

List of project ids

componentSelection

List of components

versionSelection

List of version Ids

worklogSortType

Sorting to be used

teamSelection

List of team ids

dateRangeType

Period to use. If the period is not CUSTOM, fromPeriod and toPeriod will be overriden.

fromPeriod

Date from

toPeriod

Date to

userSelection

List of user keys (not user names)

activitySelection

List of activity type ids

statusSelection

List of (Jira) Status ids

issueTypeSelection

List of (Jira) Issue Type Ids

 

 

Example

 

The Json String for user selection for users with keys (user_a and user_b) would look like:

"{"userSelection":["user_a","user_b"]}"

Using this as parameter would result in:

ICTimeCreateReportAction!default.jspa?loadParameterSetId=5&postLoadAction=execute&overrideParam=%7B%22userSelection%22:%5B%22user_a%22,%22user_b%22%5D%7D

 

Building override parameter

How to override the “from” and “to” field in reporting from using the overrideParam option:

Assumption:

You date format setting is day.month.year (e.g. 01.11.2019 for November, 1st 2019)

You want the period from 05.11.2019 until 10.11.2019.

  • open Chrome / firefox JavaScript console

  • execute the follwoing statement in the console

    • encodeURI(JSON.stringify({'fromPeriod':["05.11.2019"], 'toPeriod' : ["10.11.2019"]}))

  • this returns

    • "%7B%22fromPeriod%22:%5B%2205.11.2019%22%5D,%22toPeriod%22:%5B%2210.11.2019%22%5D%7D"

  • remove double quotes from the result and append the resulting string as additional parameter to the Base default URL of the reporting page:

    • http(s):/YOUR_JIRA_HOST/YOUR_JIRA_PATH/ICTimeCreateReportAction!default.jspa?loadParameterSetId=2&overrideParam=%7B%22fromPeriod%22:%5B%2205.11.2019%22%5D,%22toPeriod%22:%5B%2210.11.2019%22%5D%7D