Properties

Overview

Properties are the workflow or asset type level properties that control things like

The name and icon of the workflow
The name of the work items created within the workflow
etc

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)
name	Internal name of the flow. Auto generated. Not recommended to change.	any string
displayName	Label of the flow. This will be displayed in the UI.	any string
icon	Icon of the flow	sample json below color = #fffff or divider or $.data shape = 🙌🏼 or AccessAlarmOutlined	color = (https://htmlcolorcodes.com/) any hex colour (e.g. #000000). This can also be “divider” or a dataPath or data path (target should be of hex colour value) shape = https://mui.com/material-ui/material-icons/?theme=Outlined or any emojis
entityType	Used for asset. entityType of the asset	Flow = Entity Asset = myecosystem-mything	Flow = Entity Asset = <ecosystem name>-<entity name>
imageUrl	Default image for the flow	https://cdn.rise-x.com/diana/icons/FlowIcon.svg or data:image/png;base64,……	Icon takes higher precedence than imageUrl this means; If Icon is not set or null, this will be used as Icon of the flow. it should be either base64 image or the default https://cdn.rise-x.com/diana/icons/FlowIcon.svg
description	Rough description of what the actual flow does	any string
displayNameTemplate	Label of the breadcrumbs in work page. (i.e. name of the work item) Work / WF 1 / <configured string would go here> (RSX-WORKCODE)	any string
workCodeTemplate	formats the work code	object with these properties key = {$.now:yyyy} e.g. (2023/2024) template = {$.shortCode}-{$.now:yyyy}-{$.next:000} e.g. RSX-2023-009 shortCode = from company collection next:000 = existing work count of this flow
defaultData	Default data for the flow	object with these properties data = free form object dataPath = dataPath string stepName = string
flowType	flow type	FLOW = <ecosystem>/<entityType>/<workflow> ASSET = <ecosystem>/entityType>/<entity>
PublishMode	Determines if, when you publish the workflow or asset type, changes are made to existing work items/assets or only to new work items/assets	“Default” or ”UpdateOpenItems” or ”DoNotUpdateOpenItems”

Advanced Editor example of this set up

icon

{
	"icon": {
		"color": "#ffffff",
		"shape": "😀"
	}
}

defaultData

{
  "defaultData": [
    {
      "dataPath": "$.asset",
      "stepName": "step 1"
      "data": {
        "some": null,
        "raw": "rsx",
        "data": true
      },
    },
    {
      "dataPath": "$.thing",
      "stepName": "step 2"
      "data": {
	      "raw": "data"
      },
    }
  ]
}

displayNameTemplate

{
	"displayNameTemplate": "THIS IS THE DISPLAY NAME TEPLATE",
}

workCodeTemplate

{
  "workCodeTemplate": {
    "key": "{$.now:yyyy}",
    "template": "UAV-{$.shortCode}-{$.now:yyyy}-{$.next:000}"
  }
}