Reportable Fields

Reportable Fields

Overview

This lets you set up which components show by default in the table view of a workflow or asset type

Steps to set this up

Coming soon…

Advanced Editor properties and what they do

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
key	unique identifier of the field. should be unique across all reportable field. This is also used as the property name in the work json to be shown in the table.	can be any string
displayName	label of the property this will be also used	string
description	some description of this property. it is not being used in the frontend	string
isQuickFilter		true or false
isDefaultProperty	if set to false this will ensure valuePaths to start with “$.data”	true or false
valuePaths	list of dataPath strings that looks up into the work. whatever values that are extracted will be used as values when filtering in the work board page	array of strings
filterType (deprecated)	0 = Enum 1 = DateRange 2 = Single
colPosition	determines the order of this field in the work table. lower number means it will be positioned in the left-hand side	any number
quickFiltersPosition	determines the order of this field in the quick filters tab. lower number means it will be positioned in the left-hand side
defaultFilter		true or false
defaultOn	defaults this field to be shown in the table (column)	true or false
filters
type	type of filter	DATE_RANGE ENUM SINGLE
isExpandedProperty	set this to true if this field is expanded feature	true or false
aggregations
state
taskKeys
cellConfig	See below

CellConfig

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
type	type of cell	date text number currency status people date-color boolean icon multiple-value tags alert
dataPath	dataPath of where the config is located (target dataPath value should have iconType and iconText properties)

CellConfig - date

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
format	specify formatting	string	https://moment.github.io/luxon/#/formatting
displayDateTimeOptions	additional options	{ ”zone”: “” }	https://timezonedb.com/time-zones

CellConfig - number/currency

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
decimals	number of decimals to show (if there are any)	number
noFormat	no format	“true” or “false” note: should be a string
currency	specifies the currency	“USD”	https://www.iban.com/currency-codes
format	not used

CellConfig - status (options)

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
statusColour	colour of the status
bgColour	background colour of the status
colour	colour of the text
status	actual status
statusColourPath	dataPath of the statusColour
bgColourPath	datapath of the bgColour
colourPath	dataPath of the colour
statusPath	dataPath of the status

CellConfig - status (rules)

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
options	CellConfig - status (options)
expression	custom expression

CellConfig - date-color

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
format	the same with cellconfig date
displayDateTimeOptions	the same with cellconfig date

CellConfig - boolean

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
trueLabel	label when the value is true	any string
falseLabel	label when the value is false

CellConfig - icon

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
IconType	—
IconText	—
DataPath	data path of where the config is in	data path string

CellConfig - multiple-value

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
format
sortBy
aggregationBy
values.type		number string date
values.name
values.dataPath
values.decimals
values.format
displayDateTimeOptions	the same with cellconfig date

CellConfig - alert

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
dataPath	dataPath of where the config is located (target dataPath value should have iconType and iconText properties)

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
key	unique identifier of the property. should be unique across all properties.	can be any string
displayName	label of the property this will be also used	string
description	some description of this property. it is not being used in the frontend	string
defaultOn		true or false

Advanced Editor example of this set up

Coming soon…