Asset Search

Overview

The asset search component allows people to select an asset from an asset type

No Code set up options using the side panel

Example of the No Code set up side panel

No Code side panel

General

Property	Description
Title	Name of the component.
Placeholder	The placeholder text can prompt users on how to interact with the component while it's empty.
Asset Type	The asset type to select from. You can see more details about specific asset types by going into the asset tab on platform.
Required	When enabled, a red asterisk will appear next to the component name, indicating that the user must enter a value before submitting the task.

Advanced

Property	Description
Default data	Automatically populate the component data from a variety of sources. For more information about the default data options available, please refer to the sections 'From this Workflow,' 'Asset Property,' 'Custom Data,' and 'Calculation' below.
From this Workflow	Note: this is a default data option Choose a component that, when its value is entered, will populate this component. You can only select components that are in the current or previous tasks. You can also only select components that are the same type as this component. When the linked component has data entered into it, the data will also populate this component.
Asset property	Note: this is a default data option Choose an asset search component that, when an asset is selected, the relevant asset property will populate this component. You can only link to asset search components that are in the current or previous tasks. You can only select properties from the selected asset type that are the same type as this component. When the linked asset search component has an asset selected, the data from the relevant property within the selected asset will populate this component.
Custom data	Note: this is a default data option Custom data allows you to set your own custom value. After selecting the custom data option, you can enter a value into the component within the workflow builder interface.
Create New Assets	When enabled, end users are able to add new assets to the connected asset type if the desired asset is not present in the Asset Search suggestions.
Read only	When enabled, users can’t edit with this component from within a work item.

Advanced Editor set up options

Properties shared between components

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
`label`	The title or label to be displayed	“My Component”
`dataPath`	The data path where to save the value. ex.: “$.hello.world” would result to: `{ hello: { world: [] } }`	“$.task.section.myComponent”	A string that starts with `$` for the root, and each step is separated by a dot `.`. A step is a string without any space.
`isRequired`	A flag if component is required to be filled before complete	true
`isReadOnly`	A flag if component is read-only or not editable	false
`isHidden`	A flag if component is hidden	false
`condition`	Hides component if condition not met	"’{$.order.product[0].qty}’ > 10000” or ”’{$.task.section.componentName}’ == ‘value’”	Can either be <, >, or == A calculation expression that can use arithmetic operators, but this time, prefix `=` is not necessary
`onChange`	url to be called when component value changed	`"/api/v3/flow/execute/activity/{$.id}?refreshLayout=true"`	Use the exact value in the example here. Any Diana API url path in swagger that are `GET` methods. a variable can be used by wrapping it with `{}` in the example case it has `{$.id}` it resolves to the id of work
`width`	The with size of component	“col-1” “col-2” “col-3” “col-4” “col-5” “col-6” “col-7” “col-8” “col-9” “col-10” “col-11” “col-12”	A string that starts with “col-” followed by a number from 1 to 12. e.g. 12 means it takes up 100% of the horizontal space, and 6 means it takes up half the horizontal space, etc)
`defaultValue`	The default value of the component	“$.something.otherComponent” ”Hello World” ”={$.num1}+{$.num2}”	- Can be a literal string value like for text input component. For example, putting “Hello World”, will make it as default value of the text input - Can be a data path from other components, with this setup it will copy the value of other component. - Can be a calculation using arithmetic operators. The data path of other components like number input can be used as variable, but they need to be wrapped by `{}` for example, to add 10 to the value of a data path, it would be `={$.num1}+10`. to activate calculation, it should start with `=` - Can be any math.js function. See https://mathjs.org/ for a list of functions
`validation`	A list of validation rules	`[ { "type": "error", "message": "This field is required", "rules": "required", "alwaysTrigger": false } ]`	See the “Validation property set up” drop down below this table
`dataKey`	To which the value of datapath will be resolved.	“data” ”layoutComponent"	“data” - means the data path will be resolved from `work.data` ”layoutComponent” - means the data path will be resolved from the layout component config. Ex. `$.properties.label` will result to the label of component
`defaultValueDataKey`	Same with `DataKey`, but this time it’s for the default value of component	“data” ”layoutComponent"	Check `DataKey` above
`recalculateDefaultValueWhenDataPathChange`	recalculates component value using `defaultData` whenever a value changed in the list	`[ "={$.num1}+{$.num2}" ]`	The values can either be a data path or calculation, like the values that being set in default value
`sidePanelShowHide`	Sometimes a work is being rendered in a side panel, but this is mostly common for the assets. This serves as a flag if the component should be shown in case work or asset is rendered in side panel	`false`
`name`	A unique name that is used by the backend; Not displayed in component but it needs to have a value and must be unique	“my-component”
`description`	Description for the component

https://www.notion.so/rise-x/Rise-X-Knowledge-Base-d7a7f457ef2449498a2fd4ce6f47bd4a?pvs=4

‣

Validation property set up

Properties unique to this component

All of these unique properties sit within a “properties” object e.g.

Property	What does the property do (in plain english)	Possible values	How to find these values (in plain english)
`tooltip`	tool tip is a small icon that shows up at the top of the component name, tooltip can be hovered and you can put hints or guidelines for users for the specific component that uses the tool tip.	tooltip = “tooltip can be hovered to display a sentence or paragraph descriptive of the specific usage of a component”	Create a helpful sentence or short paragraph explaining the component's use. This text will appear when users hover over the tooltip icon.
`placeholder`	The text that appears before any value is put on a component. This can be a hint or guide on what to put on the component. this will disappear once you enter a value in component.	Simple description on what value you should put on the component, can be a hint or a guide text phrase.	Think of a short text that helps users understand what to enter in the component. This is usually a brief instruction or example.
`thingType`	Determines which asset type to search for assets in	“ecosystem-AssetType”	Taken from the “entityType” property in the “Properties” page on the asset type
`searchBy`	Determines what keyword the search will be driven by.	A specific attribute or field to search by, e.g., “vessel”, “displayName”, “$.dataPath”	Identify the keyword or attribute that you will use for the search. This should be a field or property that is unique or highly relevant to the assets you are searching for.
`multiSelect`	If this is set to “multi” you can select multiple users to be invited; if this is set to “single” you can invite only one user at a time.	multiSelect = “multi”; multiSelect = “single”	Decide if you need to invite multiple users simultaneously. If yes, set to "multi"; if you need to invite one user at a time, set to "single".
`addNewItem`	this is by default set to false - but if this is set to true a user can add/create a new asset item in the system.	addNewItem = true; addNewItem = false;	Decide if users should have the ability to add or create new asset items in the system. If yes, set to true; if not, set to false.

{
	"property one shared between components": "",
	"property two shared between components": "",
	"property etc shared between components": "",
	"properties": {
		"Tooltip": "",
		"Placeholder": "",
		"etc": "",
	}
}

Advanced Editor example of a set up asset search component

{
  "name": "testTask1TestSection2Ff1Fb13413B5488D8B89E95Fa6000581",
  "label": "Test Asset",
  "description": "",
  "defaultValue": "",
  "dataPath": "$.testTask1.testSection2.ff1Fb13413B5488D8B89E95Fa6000581",
  "isRequired": false,
  "isReadOnly": false,
  "isHidden": false,
  "width": "col-6",
  "validation": [],
  "sidePanelShowHide": {
    "showDataType": ["Asset"],
    "hideDataType": ["Work"]
  },
  "properties": {
    "multiSelect": "multi",
    "thingType": "Joel-Test-Env-Asset1",
    "tooltip": "test tooltip asset",
    "searchBy": "$.displayName",
    "placeholder": "test asset placeholder",
    "addNewItem": false
  }
}