List of custom field advanced settings
eazyBI for Jira

The list of advanced settings for custom fields that can be applied to account-specific or global issue custom fields.

changes

This setting enables import value changes for single-choice, number, and date custom field types.

Specify true for the single value string data type separate table dimensions (see separate_table below) if you would like to see the historical custom field value with Issues history measure. Please also select the Import issue change history option when doing the Jira import.

Setting name	changes
Available values	`true` or `false`
Default value	`false`
Example	`changes = true`

check_calculated_value

This setting forces eazyBI to check a custom field in each data import.

Should be used for Jira scripted custom fields (for example, ScriptRunner) which can return a different value even when the updated date and time of the issue have not changed. By default, the incremental import will re-import only those issues that have been created or updated since the last import. If you set this setting to true, then for all issues this custom field value will be checked if it has not changed since the last import and will re-import this field value if it is changed. Enabling this setting for scripted custom fields can make the import slower as during the import the calculation will be performed for all issues.

Setting name	check_calculated_value
Available values	`true` or `false`
Default value	`false`
Example	`check_calculated_value = true`

This parameter check_calculated_value does not work for calculated JavaScript custom fields

csv_dimension

This setting generates additional CSV dimension for a multi-choice custom field to concatenate field values in comma-separated strings.

Can be used with custom fields that have dimension and multiple_values enabled.

For example, if an issue has a custom field with values one and two, then in the multiple values dimension Custom field two separate members (one and two) will be created and the corresponding measure values for this issue will be stored for each of these members. If csv_dimension is enabled, then in the Custom field CSV dimension one member with comma-separated values (one, two) will be created and the corresponding measure values will be stored for this member. You can use this additional CSV dimension if you want to filter measure values for issues that have both values in the custom field.

Setting name	csv_dimension
Available values	`true` or `false`
Default value	`false`
Example	`csv_dimension = true`

data_type

This setting is mandatory for each new global custom field defined from eazyBI settings. For account-specific custom fields, this setting is available as a select list.

Use string for limited length strings (the default limit is 255) or text for large text properties (do not use text when enabling dimension).
Use integer and decimal for numeric values. Specify precision (default 15) and scale (default 2) for decimals, if you want to change the defaults.
Use date for date values without the time and datetime for dates with time.

Setting name	data_type
Available values	`"string"` `"text"` `"integer"` `"decimal"` `"date"`
Default value
Example	`data_type = "string"`

dimension

This setting enables custom field import as a dimension. Use for single-choice, multi-choice, number, and cascading custom fields.

This setting is supported only for data type string, integer, or decimal. For account-specific custom fields, this setting is available as a checkbox.

Setting name	dimension
Available values	`true` or `false`
Default value	`false`
Example	`dimension = true`

get_changelog_string

Some custom fields return numeric ID values as their default values, but you would like to import the corresponding string display value in eazyBI. In these cases, quite often, custom fields also provide string representation, which is stored in the issue changelog (check Jira if you see the string values in the issue history when you change this custom field value). If the changelog string value is available for this custom field, then enable the import of this string value in eazyBI.

Setting name	get_changelog_string
Available values	`true` or `false`
Default value	`false`
Example	`get_changelog_string = true`

intervals

If you want to import ranges of numeric values as an interval dimension, then specify the default intervals (for example, "/10"). This setting requires importing the field as a dimension.

Setting name	intervals
Available values	String with default interval ranges
Default value
Example	`intervals = "/10"`

interval_unit

If the custom field returns a time interval value, then specify the default time unit for the intervals range (for example, if "days" is specified then intervals with the value "/10" means that time intervals for every 10 days should be created).

This setting requires importing the field as dimension with intervals settings.

Setting name	interval_unit
Available values	`"seconds"` `"minutes"` `"hours"` `"days"`
Default value	`"days"`
Example	`interval_unit = "minutes"`

javascript_code

If you create a new global JavaScript calculated custom field, then specify the custom JavaScript code in this setting. For account-specific custom fields, there is a separate area for custom Javascript code.

Setting name	javascript_code
Available values
Default value
Example	javascript_code = ''' // Insert here the Custom JavaScript code '''

json_fields

This line is mandatory if you use Javascript to calculate the field with a reference to another custom field that is not being selected for import itself. Use custom field ID instead of

Setting name	json_fields
Available values	["customfield_NNNNN"] where NNNNN is Jira custom field ID
Default value
Example	`json_fields = ["customfield_NNNNN"]`

levels

If the custom field should be imported as a multi-level dimension, then specify an array with level names (for example, ["Level 1", "Level 2"]). The custom field value should be an array with values for each level. If the custom field value is a concatenated string, then specify split_by setting that should be used to split a string into an array of strings. See also the none_member_all_levels setting.

Setting name	levels
Available values	Array with strings
Default value
Example	`levels = ["Level 1","Level 2"]`

limit

The default length of string field values imported as dimension members is 255 characters; longer values are trimmed automatically. You can increase the length of string datatype by specifying the "limit" setting.

Setting name	limit
Available values	Integer limit value
Default value	255
Example	`limit = 300`

measure

This setting enables custom field import as a measure for integer, decimal, date, or datetime data types. It is not applicable to other data types.

Use this setting for newly calculated custom fields. For account-specific custom fields, this setting is available as a checkbox.

Setting name	dimension
Available values	`true` or `false`
Default value	`false`
Example	`measure = true`

multiple_dates

Enable custom measure import with numeric values for several dates. The custom field should return multiple lines where each line is in the format YYYY-MM-DD,numeric_value.

This setting is mainly used for calculated fields - scripted Jira fields or Javascript calculated custom fields.

Setting name	multiple_dates
Available values	`true` or `false`
Default value	`false`
Example	`multiple_dates = true`

multiple_dimensions

Enable custom measure import with numeric values for several dimension combinations. Specify the list of dimension names that each line will return (for example, ["Time", "Priority"]). Each line of the custom field value should be in the format dimension1_key,...,dimensionN_key,numeric_value (for example, 2024-09-27,Highest,123 for the previous dimension names list example).

If the dimension used as a parameter for this setting is a custom field, make sure it is a single-select field and is imported into a separate table. Multi-level and cascading field dimensions are not supported as parameters for this setting.

This setting is mainly used for calculated fields - scripted Jira fields or Javascript calculated custom fields. See the example with Days in Priority.

Setting name	multiple_dimensions
Available values	Array with dimension names
Default value
Example	`multiple_dimensions = ["Time","Priority"]`

multiple_values

Enable if the custom field returns several values for one issue (an array of values) instead of a single value. If the custom field value is a concatenated string, then also specify a setting split_by that should be used to split a string into an array of strings.

This setting works for custom fields with string data type. For account-specific custom fields, this setting is available as a checkbox.

Setting name	multiple_values
Available values	`true` or `false`
Default value	`false`
Example	`multiple_values = true`

name

Specify the custom field name when defining a new JavaScript calculated custom field, renaming Jira custom field, or importing Jira scripted field. You can rename account-specific custom fields from import options.

Setting name	name
Available values	String with a custom field name
Default value
Example	`name = "Custom dimension name"`

none_member_all_levels

Enable the (none) member creation at all parent levels of a custom dimension with several levels. By default, only one (none) member is created at the first highest level.

Setting name	none_member_all_levels
Available values	`true` or `false`
Default value	`false`
Example	`none_member_all_levels = "true"`

precision

The total number of digits before and after the decimal separator of the decimal data type. For example, this number 1234567890123.4567 has a precision of 18 (14 digits before and 4 digits after decimal). Importing it with a default setting of precision might end with an import error. For account-specific custom fields, this setting is defined from import options.

Setting name	precision
Available values	Integer precision value
Default value	`15`
Example	`precision = 18`

properties_from_dimension

imports all properties from the "Issue" dimension to a field that contains the issue key (for example, single-issue picker field imported in eazyBI as dimension). See example All Links.

Setting name	properties_from_dimension
Available values	`"Issue"`
Default value
Example	`properties_from_dimension = "Issue"`

scale

Max number of digits after the decimal separator for decimal data type fields. For example, to import this number 1.4567 with all 4 digits after decimal, use a scale of 4.

For account-specific custom fields, this setting is defined from import options.

Setting name	scale
Available values	Integer scale value
Default value	`2`
Example	`scale = 4`

separate_table

By default, single-value custom dimensions are stored in the Jira issues table in the eazyBI database. If you want to import additional data for these custom dimensions or use it in the list of multiple_dimensions names, then enable this setting and re-import Jira issues into eazyBI. After that, a separate dimension table with the dimension members' values will be created in the eazyBI database.

This parameter works for single-value custom fields only. It is not supported for custom fields with decimal or integer data.

Setting name	separate_table
Available values	`true` or `false`
Default value	`false`
Example	`separate_table = true`

split_by

When levels or multiple_values settings are enabled, but the custom field returns a concatenated string then specify the separator that should be used to split the string value into an array. For example, if split_by is set to "," then the custom field value "a,b,c" is split into the array ["a","b","c"]. For account-specific custom fields, this setting is available as the input field and only for string fields.

Setting name	split_by
Available values	string separator value
Default value
Example	`split_by = ","`

time_interval

This setting applies to integer or decimal fields representing age or duration. Use it with intervals, interval_unit, and time_unit to complete the configuration for interval dimensions.

If the interval dimension is for a duration, then specify "duration" and the custom field value should be the difference between two dates in time_unit.
If the interval dimension is for an age, then specify "age" and the custom field value should be a Unix timestamp (number of time_unit since January 1, 1970). See an example to calcualte age since updated interval for Jira issues

Setting name	time_interval
Available values	`"age"` `"duration"`
Default value
Example	`time_interval = "duration"`

time_unit

This setting applies to integer or decimal fields representing age or duration. Use it with intervals, interval_unit, and time_interval to complete the configuration for interval dimensions.

If the custom field returns a time interval value, then specify the time unit for this value. This time unit will be used to convert the time value into the corresponding interval_unit and then to find the corresponding intervals range.

See the example of a custom calculated field as an interval dimension.

Setting name	time_unit
Available values	`"seconds"` `"minutes"` `"hours"` `"days"`
Default value
Example	`time_unit = "minutes"`

update_from_issue_key

Specify the field containing a single issue key that should be used to get the custom field value from the related issue (linked issue, parent, epic, single issue picker, etc).

See also an example of importing epic-level custom field values for children's issues.

Setting name	update_from_issue_key
Available values	String, a reference to the field with issue key value
Default value
Example	`update_from_issue_key = "epic_key"`

This setting applies just for single value custom fields only. The reference custom field should also contain only one single issue key for any issue.

List of custom field advanced settings eazyBI for Jira