step

name
string (Step unique name)

It can be used in URL, so use URL-safe letters

object (labelTranslations)

Object with custom translations with structure. It tries to pick label according to your language, otherwise it pick label from "" key. After that translationKey is used.

additionalProperties
string
""
required
string
fr
string
en
string
translationKey
string (Key used to find build-in translation for Step name)

If such key exist, the translation will be used. Otherwise this string will show up on the screen.

userGroupViewDetails
string (User group view permissions)

List of user groups names (separated by comma), which can view the step

userGroupEdit
string (User group edit permissions)

List of user groups names (separated by comma), which can edit the step

group (object) or rule (object) (filter)

Filter can be a rule or a group of rules with a combining operator.

One of:

Filter Group for hiding or disabling steps or tabs.

criteria
required
Array of any (filter)
operator
required
string
Possible values: "and" "or" "not"
_constructor
string
Value: "AdvancedCriteria"
group (object) or rule (object) (filter)

Filter can be a rule or a group of rules with a combining operator.

One of:

Filter Group for hiding or disabling steps or tabs.

criteria
required
Array of any (filter)
operator
required
string
Possible values: "and" "or" "not"
_constructor
string
Value: "AdvancedCriteria"
icon
string (icon)

The icon is provided by DynamicIcon component, so the icon has to be defined there

Possible values: "angle-double-left" "angle-down" "angle-down-b" "angle-right" "arrow-down" "arrow-right" "arrow-up" "bars" "bell" "blue" "brackets-curly" "calculator" "calculator-alt" "calendar-alt" "chart-line" "check" "check-circle" "circle" "clipboard-notes" "cog" … 67 more
Array of objects (tab)
Array
name
required
string (Tab unique name)

Tab unique name. It can be used in URL, use URL-safe letters.

object (labelTranslations)

Object with custom translations with structure. It tries to pick label according to your language, otherwise it pick label from "" key. After that translationKey is used.

additionalProperties
string
""
required
string
fr
string
en
string
translationKey
string (Key used to find build-in translation for Tab name)

Key used to find build-in translation for Tab name. If such key exist, the translation will be used. Otherwise this string will show up on the screen.

userGroupViewDetails
string (User group view permissions)

User group view permissions. The list of user groups which can view the tab.

userGroupEdit
string (User group edit permissions)

User group edit permissions. The list of user groups which can edit the tab.

icon
string (icon)

The icon is provided by DynamicIcon component, so the icon has to be defined there

Possible values: "angle-double-left" "angle-down" "angle-down-b" "angle-right" "arrow-down" "arrow-right" "arrow-up" "bars" "bell" "blue" "brackets-curly" "calculator" "calculator-alt" "calendar-alt" "chart-line" "check" "check-circle" "circle" "clipboard-notes" "cog" … 67 more
type
required
string (Component specifier)

Name of the widget you would like to see on the tab. In case of dashboard, if you can specify the dashboard name via typeReference attribute.

Possible values: "header" "items" "attachments" "actions" "notes" "customForms" "workflow" "workflowHistory" "messages" "dashboard" "details" "documents" "configurationWizards" "dealPlanDrivers" "dealPlanNegotiationRounds" "dealPlanSummary" "externalApp"
typeReference
string (Unique identifier for dashboard or logic.)

Unique identifier for dashboard or logic. The value here depends on the widget used on the Tab.

group (object) or rule (object) (filter)

Filter can be a rule or a group of rules with a combining operator.

One of:

Filter Group for hiding or disabling steps or tabs.

criteria
required
Array of any (filter)
operator
required
string
Possible values: "and" "or" "not"
_constructor
string
Value: "AdvancedCriteria"
group (object) or rule (object) (filter)

Filter can be a rule or a group of rules with a combining operator.

One of:

Filter Group for hiding or disabling steps or tabs.

criteria
required
Array of any (filter)
operator
required
string
Possible values: "and" "or" "not"
_constructor
string
Value: "AdvancedCriteria"
parameters
object (Static parameters for the tab.)

Static parameters for the tab. Will be passed to the tab logic (e.g. dashboard) without any changes. They can be extracted by DynamicTabs.getParameters(tab, entity) in TabComponent.

object
additionalProperties
string

Dynamic parameters for the tab. Will be passed to the logic. Values will be obtained from the entity. Key value mapping of the entity fields to the dashboard logic inputs. The value is path to value in the underlying entity.

property name*
additional property
string (Dynamic parameters for the tab)

Will be passed to the logic. Values will be obtained from the entity. Key value mapping of the entity fields to the dashboard logic inputs. The key is name of parameter for tab logic. The value is path to value in underlying entity.

{
  • "name": "string",
  • "labelTranslations": {
    • "additionalProperties": "string",
    • """": "string",
    • "fr": "string",
    • "en": "string"
    },
  • "translationKey": "string",
  • "userGroupViewDetails": "string",
  • "userGroupEdit": "string",
  • "disableCheck": {
    • "criteria": [
      • null
      ],
    • "operator": "and",
    • "_constructor": "AdvancedCriteria"
    },
  • "hiddenCheck": {
    • "criteria": [
      • null
      ],
    • "operator": "and",
    • "_constructor": "AdvancedCriteria"
    },
  • "icon": "angle-double-left",
  • "tabs": [
    • {
      • "name": "string",
      • "labelTranslations": {
        • "additionalProperties": "string",
        • """": "string",
        • "fr": "string",
        • "en": "string"
        },
      • "translationKey": "sfdc_quotes_tabs_header",
      • "userGroupViewDetails": "admins",
      • "userGroupEdit": "string",
      • "icon": "angle-double-left",
      • "type": "header",
      • "typeReference": "string",
      • "disableCheck": {
        • "criteria": [
          ],
        • "operator": "and",
        • "_constructor": "AdvancedCriteria"
        },
      • "hiddenCheck": {
        • "criteria": [
          ],
        • "operator": "and",
        • "_constructor": "AdvancedCriteria"
        },
      • "parameters": { },
      • "parameterMapping": {
        • "additionalProperties": "Year: inputs.Year.value",
        • "property1": "string",
        • "property2": "string"
        }
      }
    ]
}