Custom Form Type (CFOT)

Custom Form Type is used by Configuration Engineers to predefine possible types of Custom Forms which can then be used by end users from within the Pricefx UI.

Configuration

Custom Form Types are managed in Administration › Custom Form Types.

Fields

  • uniqueName (String) – Unique name of the type.

  • label (String) – Name of the type, as displayed to the end users.

  • translations (Strings) – Label translations for multiple languages. They can be defined in singular and plural forms. The singular is used for button labels like Create New or Save. The plural is used in menu items, label/title of the list page and in breadcrumb navigation. You must enter at least the singular for the default locale (null value in the Locale column).

  • embedded (Boolean) – Determines whether a customer form of this type is used as embedded or standalone.

    • True – Custom Form is embedded – used inside another document, such as Quote.

    • False – Custom Form is used standalone as a separate small app.

  • headerFormulaName (String) – Name of the logic which implements the functionality of the Custom Form. See Custom Form Logic.

  • configuration (JSON) – Layout definition of the Custom Form detail page. See Dynamic Tabs Configuration for details. Used only for standalone forms.

  • module (ApplicationModule) – Name of the 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. Either moduleCategoryUN or module field is set up, not both. Only for standalone forms.

  • moduleCategoryUN – Unique name of a Module Category which should display a list of Custom Forms based on this Custom Form Type. Either moduleCategoryUN or module field is set up, not both. Only for standalone forms.

  • workflowFormulaName (String) – Name of the workflow logic which will be used to build approval workflow for this Custom Form. Used only for standalone forms.

  • supportedParentTypeCodes (Form Type) (String) – List of entities which are allowed to embed this custom form type (Quote, standalone Custom Form, Rebates, Sales Compensation, Promotions). Used only for embedded forms.

Found an issue in documentation? Write to us.

Â