| Both sides previous revision Previous revision Next revision | Previous revision |
| 2500_config_apps:0700_add_edit_attributes:0100_common_props [2026/08/13 00:55] – ↷ Page moved from docs:2500_config_apps:0700_add_edit_attributes:0100_common_props to 2500_config_apps:0700_add_edit_attributes:0100_common_props localdev | 2500_config_apps:0700_add_edit_attributes:0100_common_props [2026/08/13 07:20] (current) – external edit 127.0.0.1 |
|---|
| ===== Description ===== | ===== Description ===== |
| |
| Specify any text that describes what the attribute is for, the business concept that it represents, how it is used etc. Any description if defined is included into the generated documentation for the business space version – see [[docs:2500_config_apps:3100_gen_doc|Generating Documentation]]. | Specify any text that describes what the attribute is for, the business concept that it represents, how it is used etc. Any description if defined is included into the generated documentation for the business space version – see [[2500_config_apps:3100_gen_doc|Generating Documentation]]. |
| |
| ===== Type ===== | ===== Type ===== |
| |
| Any attribute must be assigned a type. Choose the required type from the “Type” combo box. The list of types contains //basic types// (''Plain Text'', ''Number'', ''Date'', ''Timestamp'', ''Yes/No'', ''Binary Data'', ''Document'', ''Picture'', ''Shortcut'') and //reference// types. Reference types include the names of all business objects and business object groups defined in the business space version – see [[docs:2000_concepts:0200_basics:0400_reference_attributes|Reference Attributes]]. | Any attribute must be assigned a type. Choose the required type from the “Type” combo box. The list of types contains //basic types// (''Plain Text'', ''Number'', ''Date'', ''Timestamp'', ''Yes/No'', ''Binary Data'', ''Document'', ''Picture'', ''Shortcut'') and //reference// types. Reference types include the names of all business objects and business object groups defined in the business space version – see [[2000_concepts:0200_basics:0400_reference_attributes|Reference Attributes]]. |
| |
| ===== Required ===== | ===== Required ===== |
| |
| - The type and format of the initial value must correspond to the type of the attribute. | - The type and format of the initial value must correspond to the type of the attribute. |
| - Rule expressions are not allowed as initial values (with the exception of expressions that set the current date or time, such as ''CURRENT_DATE''). If the attribute value should be initialised to some expression a rule has to be attached to the business object or notification that owns the attribute – see [[docs:2500_config_apps:0800_add_edit_rules|Adding/Editing Rules]]. | - Rule expressions are not allowed as initial values (with the exception of expressions that set the current date or time, such as ''CURRENT_DATE''). If the attribute value should be initialised to some expression a rule has to be attached to the business object or notification that owns the attribute – see [[2500_config_apps:0800_add_edit_rules|Adding/Editing Rules]]. |
| |
| ===== Choices ===== | ===== Choices ===== |
| - If you want to add more blank entries to the list box press the “More Rows” button. | - If you want to add more blank entries to the list box press the “More Rows” button. |
| |
| <callout type="primary" icon="true" title="note"> The type and format of a choice value must correspond to the type of the attribute.</callout> | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| |
| <callout type="primary" icon="true" title="note"> Choices are not applicable for attributes owned by notifications.</callout> | The type and format of a choice value must correspond to the type of the attribute.</alert> |
| | |
| | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| | |
| | Choices are not applicable for attributes owned by notifications.</alert> |
| |
| ==== Dynamic Choices ==== | ==== Dynamic Choices ==== |
| The initial list of choices seen by end users will be pre-populated with the choices entered by the configurator in the Configuration Tool (if any). | The initial list of choices seen by end users will be pre-populated with the choices entered by the configurator in the Configuration Tool (if any). |
| |
| <callout type="primary" icon="true" title="note"> The option for end users to edit list of choices will not be available if the configurator provides her own list and specifies that “other values are not allowed”.</callout> | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| | |
| | The option for end users to edit list of choices will not be available if the configurator provides her own list and specifies that “other values are not allowed”.</alert> |
| |
| ==== Include empty text==== | ==== Include empty text==== |
| <code>/\\(?\\d{3}\\)? ?\\d{3}[-.]\\d{4}/ </code> | <code>/\\(?\\d{3}\\)? ?\\d{3}[-.]\\d{4}/ </code> |
| |
| The information about format of regular expressions can be found in the [[docs:8000_appendices:0500_regular_expressions|Appendix E]] or on the following site: [[http://www.regular-expressions.info/reference.html|http://www.regular-expressions.info/reference.html]] | The information about format of regular expressions can be found in the [[8000_appendices:0500_regular_expressions|Appendix E]] or on the following site: [[http://www.regular-expressions.info/reference.html|http://www.regular-expressions.info/reference.html]] |
| |
| If you want to re-use the same regular expression in different attributes you can assign a textual name to your expression. To do this you have to modify the UIConfig.props file located in the BIN directory of your //**AwareIM**// installation to add an entry representing your expression. The entry must start with the “TextInputMask” prefix and contain the name of the expression followed by the “#” symbol and then followed by the expression itself, for example: | If you want to re-use the same regular expression in different attributes you can assign a textual name to your expression. To do this you have to modify the UIConfig.props file located in the BIN directory of your //**AwareIM**// installation to add an entry representing your expression. The entry must start with the “TextInputMask” prefix and contain the name of the expression followed by the “#” symbol and then followed by the expression itself, for example: |
| All attribute types allow specifying presentation options for the attribute. These options control how the input control displaying attribute value will be generated on a business object form. | All attribute types allow specifying presentation options for the attribute. These options control how the input control displaying attribute value will be generated on a business object form. |
| |
| <callout type="primary" icon="true" title="note"> Presentation options specified for an attribute will be used by default when the attribute is shown on forms unless a particular form section overrides the default options – see [[docs:2500_config_apps:0500_add_edit_objects:0200_defining_forms:0300_form_add_sections|Adding/Editing Form Sections]].</callout> | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| | |
| | Presentation options specified for an attribute will be used by default when the attribute is shown on forms unless a particular form section overrides the default options – see [[2500_config_apps:0500_add_edit_objects:0200_defining_forms:0300_form_add_sections|Adding/Editing Form Sections]].</alert> |
| |
| The following presentation options are common to many attributes: | The following presentation options are common to many attributes: |
| If the "Show description to the right of input control" radio button is selected the description will be shown to the right of the control – see the "Max Loan Period" attribute. | If the "Show description to the right of input control" radio button is selected the description will be shown to the right of the control – see the "Max Loan Period" attribute. |
| |
| <callout type="primary" icon="true" title="note"> You can enclose attribute description in HTML tags to improve its presentation, for example: <code><p style="color:#ff0000">This description will be displayed in red. </p> </code></callout> | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| | |
| | You can enclose attribute description in HTML tags to improve its presentation, for example: <code><p style="color:#ff0000">This description will be displayed in red. </p> </code></alert> |
| |
| ==== Save form on selection change ==== | ==== Save form on selection change ==== |
| This option is only available for an attribute of the Plain Text type and only if it has choices defined. Selecting this option indicates that the user can choose multiple choices and each choice is represented as a checkbox. Setting details of this option is similar to setting options of radio buttons. | This option is only available for an attribute of the Plain Text type and only if it has choices defined. Selecting this option indicates that the user can choose multiple choices and each choice is represented as a checkbox. Setting details of this option is similar to setting options of radio buttons. |
| |
| <callout type="primary" icon="true" title="note"> //**AwareIM**// represents selected choices as a single delimited string. You must make sure that the length of the attribute is no less than the string formed as a result of concatenation of all possible choices (in case a user selects all checkboxes) plus delimiters.</callout> | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| | |
| | //**AwareIM**// represents selected choices as a single delimited string. You must make sure that the length of the attribute is no less than the string formed as a result of concatenation of all possible choices (in case a user selects all checkboxes) plus delimiters.</alert> |
| |
| ==== Input control style ==== | ==== Input control style ==== |
| |
| ^Setting^Description^ | ^Setting^Description^ |
| |''ICON''|this element type controls how attribute will be displayed in different lists, such as in query results or in reference lists. Instead of displaying a value for the attribute you can display an icon representing the value. For example, you can display different icons for the Balance attribute of the Account object – depending on the value of the balance. You can also display icon only or both icon and value – this is specified when you [[docs:2500_config_apps:1100_add_edit_queries|define a | |''ICON''|this element type controls how attribute will be displayed in different lists, such as in query results or in reference lists. Instead of displaying a value for the attribute you can display an icon representing the value. For example, you can display different icons for the Balance attribute of the Account object – depending on the value of the balance. You can also display icon only or both icon and value – this is specified when you [[2500_config_apps:1100_add_edit_queries|define a |
| query]] or set up [[docs:2500_config_apps:0700_add_edit_attributes:0500_ref_attrib#Presentation_Options_for_References|Presentation Options for References]]. | | query]] or set up [[2500_config_apps:0700_add_edit_attributes:0500_ref_attrib#Presentation_Options_for_References|Presentation Options for References]]. | |
| |''STYLE''|this element type allows you to specify different CSS style options for particular attributes when they are displayed on forms. By default attributes are displayed using predefined colors, fonts and other properties. The “Style” element type allows you to override the default settings. For example, you can display account balance in red if its value is less than 50 or in green if it is more than 50. To do this define two styles with different color settings and specify a condition for the first style as <code aim>Account.Balance<=50 </code> and for the second one as <code aim>Account.Balance>50 </code>| | |''STYLE''|this element type allows you to specify different CSS style options for particular attributes when they are displayed on forms. By default attributes are displayed using predefined colors, fonts and other properties. The “Style” element type allows you to override the default settings. For example, you can display account balance in red if its value is less than 50 or in green if it is more than 50. To do this define two styles with different color settings and specify a condition for the first style as <code aim>Account.Balance<=50 </code> and for the second one as <code aim>Account.Balance>50 </code>| |
| |''DISPLAY FORMAT''|this element type allows you to display attributes on forms or inside query results using a different format than the format defined in the attribute itself. This can be especially useful when displaying numbers – you may want to display numbers in different formats on different forms. You can even store the format in an attribute of some object – in this case you should specify a tag expression as the format value, for example <code aim><<SystemSettings.NumberFormat>> </code>| | |''DISPLAY FORMAT''|this element type allows you to display attributes on forms or inside query results using a different format than the format defined in the attribute itself. This can be especially useful when displaying numbers – you may want to display numbers in different formats on different forms. You can even store the format in an attribute of some object – in this case you should specify a tag expression as the format value, for example <code aim><<SystemSettings.NumberFormat>> </code>| |
| |''INPUT MASK''|this element type allows you to specify an unput mask for entering text attributes on forms, which can be different to the mask defined in the attribute itself. You can even store the input mask in an attribute of some object – in this case you should specify a tag expression as the input mask value, for example <code aim><<SystemSettings.InputMask>> </code>| | |''INPUT MASK''|this element type allows you to specify an unput mask for entering text attributes on forms, which can be different to the mask defined in the attribute itself. You can even store the input mask in an attribute of some object – in this case you should specify a tag expression as the input mask value, for example <code aim><<SystemSettings.InputMask>> </code>| |
| |''CHOICES''|for attributes that have choices it is sometimes necessary to display a subset of all possible choices on a particular form. This element type allows you to specify exactly which choices will be present on the form| | |''CHOICES''|for attributes that have choices it is sometimes necessary to display a subset of all possible choices on a particular form. This element type allows you to specify exactly which choices will be present on the form| |
| |''GOOGLE MAPS MARKER''|this element type should only be used when the attribute holds the address or coordinates of a Google Map marker. This element type allows you to customize the look and feel of the marker and select from a predefined set of available markers or even use a completely customized marker (for this to work you need to define the marker and put it on the server somewhere where it is accessible via a URL. The URL needs to be provided when defing this element type. You can watch a video tutorial about this here: [[docs:5000_videos:770_google_maps_markers]] | | |''GOOGLE MAPS MARKER''|this element type should only be used when the attribute holds the address or coordinates of a Google Map marker. This element type allows you to customize the look and feel of the marker and select from a predefined set of available markers or even use a completely customized marker (for this to work you need to define the marker and put it on the server somewhere where it is accessible via a URL. The URL needs to be provided when defing this element type. You can watch a video tutorial about this here: [[5000_videos:770_google_maps_markers]] | |
| ==== Script ==== | ==== Script ==== |
| |
| For users who are familiar with Javascript this dialog allows specifying additional attribute configuration parameters when attributes are initialized and displayed. See [[docs:3500|Programmers Reference Guide]] for more details. | For users who are familiar with Javascript this dialog allows specifying additional attribute configuration parameters when attributes are initialized and displayed. See [[:3500|Programmers Reference Guide]] for more details. |
| |
| |