CustomFormType

The Type code is CFOT.

typedId
string
object (configuration)

Schema for definition of steps and tabs. This object can contains tabs array with tabs specifications or steps array (categories) with tabs inside.

name
string

Text to describe the configuration.

layout
string

DynamicTabs can have several types of layout. Default is stepper for config with steps and tabs for only tabs.

Possible values: "auto" "stepper" "tabs" "menu" "wizard"
Array of objects (step)
Array
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.

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.

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

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

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 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.

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" "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.

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

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

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
lastUpdateDate
string <date-time>
module
string or null <= 255 characters

A name of application module, in which the user interface will show the menu item, which opens a page with a list of custom forms of this type. This is meaningful only when embedded is false.

Possible values: "PRICESETTING" "QUOTING" "ANALYTICS" "ADMIN" "WORKFLOW" "REBATES" "AGREEMENTSPROMOTIONS" "OPTIMIZATION" "CHANNELMANAGEMENT" "MASTERDATA" "CONFIGURATION" "DASHBOARDS" "PROCESSES" "SALESCOMPENSATION" "CUSTOM_FORM"
label
string <= 255 characters

The name of the type, as displayed to the end users.

version
integer
uniqueName
string <= 255 characters

A unique name of the type.

supportedParentTypeCodes
Array of strings or null or null

List of entities, which are allowed to embed this custom form type (Quote, standalone Custom Form). This is meaningful only when embedded is true.

createdBy
integer
headerFormulaName
string <= 255 characters

A name of the logic which implements the functionality of the Custom Form.

userGroupEdit
string or null <= 255 characters
userGroupViewDetails
string or null <= 255 characters
embedded
boolean

If this custom form type can be embedded - i.e. used inside of another document, like quote.

workflowFormulaName
string or null <= 255 characters

A name of the workflow logic, which will be used to build approval workflow for this Custom Form.

createDate
string <date-time>
lastUpdateBy
integer
{
  • "typedId": "string",
  • "configuration": {
    • "name": "string",
    • "layout": "tabs",
    • "steps": [
      • {
        • "name": "string",
        • "labelTranslations": {
          },
        • "translationKey": "string",
        • "userGroupViewDetails": "string",
        • "userGroupEdit": "string",
        • "disableCheck": {
          },
        • "hiddenCheck": {
          },
        • "icon": "angle-double-left",
        • "tabs": [
          ]
        }
      ],
    • "tabs": [
      • {
        • "name": "string",
        • "labelTranslations": {
          },
        • "translationKey": "sfdc_quotes_tabs_header",
        • "userGroupViewDetails": "admins",
        • "userGroupEdit": "string",
        • "icon": "angle-double-left",
        • "type": "header",
        • "typeReference": "string",
        • "disableCheck": {
          },
        • "hiddenCheck": {
          },
        • "parameters": { },
        • "parameterMapping": {
          }
        }
      ]
    },
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "module": "PRICESETTING",
  • "label": "string",
  • "version": 0,
  • "uniqueName": "string",
  • "supportedParentTypeCodes": [
    • "string"
    ],
  • "createdBy": 0,
  • "headerFormulaName": "string",
  • "userGroupEdit": "string",
  • "userGroupViewDetails": "string",
  • "embedded": true,
  • "workflowFormulaName": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastUpdateBy": 0
}