Skip to main content

Properties

Properties are customizable data fields of blueprints, used to save and display information from external data sources.

Configure properties in Port​

To edit an existing property:

  1. Go to your Builder page.
  2. Expand the blueprint you want to edit by double-clicking on it.
  3. Under the Properties tab, click on the property you want to edit.
  4. Make your desired changes to the form, then click Save.

To create a new property:

  1. Go to your Builder page.
  2. Expand the blueprint you want to edit by double-clicking on it.
  3. Click on the + New property button in the bottom of the tab:


  1. Fill in the form with the desired property details, including the property type, then click Create.

Structure​

Each blueprint has a properties section under its schema. Each property is defined as an object with the following structure:

{
  "myProp": {
    "title": "My property",
    "icon": "My icon",
    "description": "My property",
    "type": "property_type"
  }
}

The different components that make up a basic property definition are listed in the following table:

FieldDescription
titleProperty title
typeMandatory field. The data type of the property.
iconIcon for the property

See the full icon list.
descriptionDescription of the property.
This value is visible to users when hovering on the info icon in the UI. It provides detailed information about the use of a specific property.
defaultDefault value for this property in case an entity is created without explicitly providing a value.
Property name

The name of the property is the key of the property object. For example, in the code block above, the name of the property is myProp.

Supported properties​