Tooltips and fill checks

This article describes the standards that apply to writing tooltips and using the fill check option. All of the listed recommendations are mandatory unless noted otherwise.

1.1. Tooltip property. Each typed metadata object (object attribute, tabular section attribute, dimension, or register resource) must have a tooltip explaining the object purpose to end users.

Standard attributes Code, Description, Parent, Owner, and Period (for periodic information registers) also must have tooltips. The remaining standard attributes usually do not require tooltips.

Keep tooltips clean from "trash" messages such as copies of metadata object or attribute synonyms. Tooltips are not required in the following cases:

  • The object or attribute synonym clearly explains its purpose. For example, the synonym of the FullName attribute of the Currencies catalog clearly explains that the attribute stores the full currency name.
  • The attribute value will never be viewed or edited from the user interface (in particular, it is never available in form fields). Therefore, no one will see the tooltip.

2.1. Fill check property. For all typed metadata objects, standard attributes, and tabular sections that need to be filled according to the object logic, set their "Fill check" properties to "Display error".

In some cases posting a document with empty attributes or tabular sections does not make sense for accounting. For example, a Customer order document represents a customer's request for purchasing a certain number of items. An order with no customers or empty Items tabular section does not make sense, therefore the Customer field and the Items tabular section must have their "Fill check" properties set to "Display error".

2.2. When specifying "Fill check" value, remember that all limitations and checks must be described as completely as possible in configuration metadata. Therefore, if at least one scenario requires filling the attribute, set "Fill check" to "Display error". If other scenarios do not require filling the attribute, reflect this in the event handler of the FillCheckProcessing object module.

Do not use the reverse method when "Fill check" is set to "No check" and the FillCheckProcessing handler includes additional fill checks. This hinders the analysis of configuration logic.

2.3. If the fill check is conditional, we recommend that you use conditional form appearance to toggle the "AutoMarkIncomplete" property. Turn it off if the current object state does not require performing fill checks.

See also

Add comment