Fields, Columns, Total Cells
Reminder:
- Fields belong to the tabs of the quote header. Fields of the tabs “Parameters” and “Change & Control” are pre-defined, the others are fully customizable.
- Columns belong to the quote spreadsheet. They are used to gather the products and pricing information.
- Total cells belong to the bottom of the quote spreadsheet. They are used to aggregate information from the lines contained in the spreadsheet.
The table below details the properties attached to these 3 types of elements. (Column "FCT" stands for "Field, Column or Total Cell"):
| PROPERTY | DESCRIPTION (FCT) | VALUE | EXPLANATION/PARAMETER |
|---|---|---|---|
| Position | Position in the screen (FT) | C <i>L <j> | C(column) starts to 0; L(line) starts to 1 |
| Name | Internal name (FCT) | pre-defined or free input | Names are used in the computation rules. Authorized characters: A...Z; a...z; 0...9; underscore all others. Characters are forbidden |
| Label | Label displayed to the user (FCT) | Free input | In the default language, lables in other language are defined in the translation step. |
| Access Rights | Defines the access rights logic (FCT) | Hidden | The element will never be displayed Open | The element is always displayed restricted | The element is displayed upon decision of the access matrix rights |
| Type-Format-Mapping | Defines the type of fields, the format parameters as well as the mapping with a database field for the storage. | ID | Element of type identifier Possible characters (optional): Regular expression to define the input pattern (refer to Java regular expression) Min size: Minimum number of characters Max size: Maximum number of characters Database field: Mapping with a database field of type TEXT |
| Number | Element of type Numeric with/without decimal digits Number of decimal: From 0 to 5 Min value: Mandatory Max value: Mandatory Negative value presentation: (1234,99) or -1234,99 (red color or black color) Group separator: On/Off Database field: Mapping with a database field of type DECIMAL | ||
| Monetary | Element of type Monetary. The currency is determined via a contextual setting or a parameter stored in the settings tab of the quote header Number of decimal: Refer to Number Min value: Refer to Number Max value: Refer to Number Negative value representation: Refer to Number Currency symbol: On/off Monetary format: Currency After/Currency Before Group separator: On/Off Database field: Mapping with a database field of type DECIMAL | ||
| Boolean | Element of type Boolean (true/false) Database field: Mapping with a database field of type BOOLEAN | ||
| Date | Element of type Date (including or not hours) Date format Time format Calendar pop-up Database field: Mapping with a database field of type DATE | ||
| Phone | Element of type Phone Number. Authorized characters: 0...9; space; +; -; ( ; ) Database field: Mapping with a database field of type TEXT | ||
| Percentage | Element of type Percentage (displayed with the % symbol to the right of the field Number of decimal: From 0 to 5 Database field: Mapping with a database field of type NUMBER | ||
| Text | Element of type Text (text field) Max size: Maximum number of characters Database field: Mapping with a database field of type TEXT NOTE : When there is a need to store a complex XML structure, it is possible to map the column to a BLOB element. In that case, it is recommended to select the CDATA property and set the type to "application/xml". This will allow to embed the XML value of the field or column into a CDATA section in the quote XML export. | ||
| Comments | Element of type Comments (text area) Max size: Maximum number of characters Database field: Mapping with a database field of type TEXT | ||
| URL | Element of type URL. Authorized characters: string respecting the URL pattern Database field: Mapping with a database field of type TEXT | ||
| Image | Element of type Image Height: In pixels Width: In pixels Autosize: On/off Database field: Mapping with a database field of type TEXT | ||
| Score | Element of type Score. The score is an integer from 10 to 100. Up to 5 score thresholds can be defined. Database field: Mapping with a database field of type DECIMAL Level-1: Value of the score above which the score is considered as an expert score Level-2: 2nd threshold Level-3: 3rd threshold Level-4: 4th threshold Level-5: Value of the score below which the score is considered a floor score | ||
| Guidance | Specific column used to handle: Either discount guidance: an amount (i.e. element of type monetary) or a percentage discount (i.e. element of type percentage) can be stored. Or pricing guidance: an amount is stored (i.e. element of type monetary). When an amount is stored, the currency is determined via a contextual setting or a parameter stored in the settings tabe of the quote header. (Refer to Pricing and Discount Guidance Type (of the column): Amount; Percentage Database field: Mapping with a database field of type DECIMAL Guidance type: Pricing; Discount Guidance - Amount Number of Decimal: Refer to Number Currency symbol: On/off Monetary format: Currency After/Currency Before Group separator: On/Off Guidance - Percent Number of Decimal: Refer to Number Coefficient of bottom value (bottom=floor-coefficient * expert-floor): Value of the coefficient (default value = 1.5). If a value lower than the botom value is set by the user, the coefficient is ignored and the bottom value is set to 0. Coefficient of amount pitch (pitch = (expert-floor) / coefficient): Value defining the amount increase / decrease when using the + / - buttons to set the guidance level Max Price column: Name of the column containing the Max price used in the guidance Min Price column: Name of the column containing the Min price used in the guidance Guidance levels (Lists all the quote columns that store the guidance levels) Level-1: Name of the column storing the first threshold of amount or percentage used in the guidance Level-2: 2nd threshold Level-3: 3rd threshold Level-4: 4th threshold Level-5: 5th threshold | ||
| Item Sheet | Specific column used for display purpose only. It corresponds to the columns displayed at the left of the spreadsheet. The cell is made-up with the following information: Rich media image (user type can be specified in the spreadsheet layout) Product ID (can be hidden, property of the spreadsheet layout) Product description Rich media text Links to rich media files (PDF, reports) Links to the detailed views: 2D graphic and manufacturing data. They appear automatically as soon as corresponding information has been generated Warnings: A spreadsheet model should not contain more than 1 column of type ItemSheet To benefit from the behavior explained above, the type of computation for this column must be "Internal" Max size: Not used when column is of type "internal" Database field: Not used when column is of type "internal" | ||
| Cart sticker | Flag - see explanation (C) | Yes/no | Determine if the column is used in the quote sticker (DEPRECATED) |
| Sync Column | Flag - see explanation (C) | Determines if the column corresponds to the Sync column used to re-apply manual user inputs after the configured product has been updated. (Refer to Synchronization column concept) | |
| Empty value | Flag - see explanation (C) | Yes/no | Determines if the empty values are allowed. Yes: the value is optional; No: the value is mandatory |
| Value List | Specifies the possible values displayed in a combo-box @runtime (FCT) | None | No domain is defined |
| Local | The domain is made up with an enum on values directly entered in the property pop-up | ||
| Internal | The domain is made with an internal list of values via a standard connector. Can only be used on following pre-defined fields: LANGUAGE; CURRENCY; pricing type; adv pricing type) | ||
| External | The domain is made with an external list of values built using business rules of type eLink, Javaclass, Macro or SQL Query | ||
| Dynamic | The domain is made with a list of codes computed with XPath requests. The domain is re-computed each time the XML of the item (CP7/SI7/CT7...etc.) is refreshed. Only code of type STRING are supported at this time. NOTE: On the UI side, if the code stored in the quote does not correspond to a code present in the combo box, the quote cell is highlighted in red. | ||
| Default Value | Associates a default value (FCT) | Attribute | Mapping with a contextual attribute injected in the section custom settings of the XML WS file |
| Constant | The default value must be compliant with the element type | ||
| None | No default value is defined | ||
| Sample Value (optional) | Associates a sample value displayed @runtime (on MouseOver) (FCT) | Free input | Warning: sample value cannot be translated |
| Message (optional) | Associates a help message displayed @runtime (FCT) | Free input | In the default language, messages in other language are defined in the translation step |
| Entry Mode | Valuation mode (^1) (FCT) | User Input (^2) | The entry of the element is user free |
| Internal | The entry is computed via a standard mechanism (reserved to certain of type of elements such as ItemSheet) User input (checkbox): In addition the user might be authorized to change the computed value. Not supported on all types of elements. | ||
| Formula | The entry is computed via a formula directly expressed in the formula property pop-up User input (checkbox): In addition, the user might be authorized to change the computed value | ||
| Xpath | The entry is computed via an Xpath request directly expressed in the property pop-up User input (checkbox): In addition, the user might be authorized to the change the computed value Column only: In addition, this column can be used to automate the update of configuration variable Direct configuration update (checkbox): Refer to chapter Updating a Configuration Variable | ||
| Macro | The entry is computed via a macro which name is given in the property pop-up User input (checkbox): In addition, the user might be authorized to change the computed value | ||
| Java Class | The entry is computed via a java class which name is given in the property pop-up User input (checkbox): In addition, the user might be authorized to change the computed value | ||
| Attribute | Mapping with a contextual attribute injected in the section custom settings of the XML WS file User input (checkbox): In addition, the user might be authorized to change the computed value | ||
| Up & Down Propagation rules (column only) | Up & down propagation rules (C) | None | No propagation rule is defined |
| Internal | This choice could not apply on the propagation rules | ||
| Formula | The propagation rule is computed via a formula directly expressed in the property pop-up | ||
| XPath | The propagation rule is computed via a Xpath request directly expressed in the property pop-up | ||
| Macro | The propagation rule is computed via a macro which name is given in the property pop-up | ||
| Java Class | The propagation rule is computed via a java class which name is given in the property pop-up | ||
| Attribute | This choice could not apply on the propagation rules |
information: For « column-type » element, the entry mode and propagation rule properties are looped for each type of line (CP7, SI7, CT7, SP7, etc.) and each type of subline (CP7, SI7, LNK, LNKCT, etc.)
In case of the checkbox « User Input » is checked on element of Types « Column/Text » or « Column/Comments »; another option « Display on several lines » can be checked with the indication of the number of lines (available in Quote UI V2). At runtime, the text field of cell will be turned into a text area with the desired number of lines.