|
|
|
|
@@ -1,6 +1,66 @@
|
|
|
|
|
# Customize form
|
|
|
|
|
#b4beta
|
|
|
|
|
[UNDER CONSTRUCTION]
|
|
|
|
|
# Customize form
|
|
|
|
|
|
|
|
|
|
todo: customize form menu option and link to custom fields detailed [form](ay-start-form-custom-fields.md)here
|
|
|
|
|
how to customize, required etc.
|
|
|
|
|
The Customize form is provided to show or hide unused fields on an edit form and also to set individual fields to require data be entered in them.
|
|
|
|
|
Custom fields can also be enabled on this form to provide additional fields unique to your business.
|
|
|
|
|
|
|
|
|
|
## Authorization Roles required
|
|
|
|
|
|
|
|
|
|
This form is available to User's with the following [roles](ay-biz-admin-roles.md):
|
|
|
|
|
|
|
|
|
|
Full access
|
|
|
|
|
|
|
|
|
|
- Business administration
|
|
|
|
|
|
|
|
|
|
Read only access
|
|
|
|
|
|
|
|
|
|
none
|
|
|
|
|
|
|
|
|
|
## How to access Customize form
|
|
|
|
|
|
|
|
|
|
From any business object editing form (green banner) select the `Customize` menu option to customize _that_ form's fields.
|
|
|
|
|
|
|
|
|
|
## How form customization works
|
|
|
|
|
|
|
|
|
|
Form field customization is saved to the database and applies to _all_ users of AyaNova, when changes are made the other users will see them the next time they open the customized form.
|
|
|
|
|
|
|
|
|
|
The form field customization form shows each field that is customizable in a box in a grid list. If a field is not shown, it is not customizable. A good example of this is the Name field which is always required to be filled in so it's not possible to hide it and there is no need to make it required so it doesn't show in the list of fields.
|
|
|
|
|
|
|
|
|
|
AyaNova comes with a _lot_ of fields available to each type of business object and not all shops require all those fields. Removing un-needed fields simplifies the forms making them quicker for data entry.
|
|
|
|
|
|
|
|
|
|
In addition some entire features may not be required, such as Tags or Attachments or the Wiki field and these features can be removed entirely on a form by form basis by setting them to invisible.
|
|
|
|
|
|
|
|
|
|
### Hiding / showing fields
|
|
|
|
|
|
|
|
|
|
To hide a field uncheck it's "Visible" checkbox and checkmark it to show on the form.
|
|
|
|
|
|
|
|
|
|
### Requiring fields
|
|
|
|
|
|
|
|
|
|
To enforce a rule that a field **must** have data entered into it, put a checkmark in the "Required" checkbox. AyaNova will display an error to the User if they leave the required field empty.
|
|
|
|
|
|
|
|
|
|
### Custom fields
|
|
|
|
|
|
|
|
|
|
Up to 16 custom fields can be enabled on most AyaNova business objects to track information that is specific to your business and not provided in the default AyaNova fields for each object. Custom field data is stored with the business object's record in the database.
|
|
|
|
|
|
|
|
|
|
There are three steps to enabling a Custom field:
|
|
|
|
|
|
|
|
|
|
1. make the custom field visible
|
|
|
|
|
2. choose the data type that will be tracked in this field. Note: if you change the data type after data has been entered AyaNova will do it's best to work with that change but it's not recommended. It's better to simply hide the former custom control and show a new one with the new data type. There are 8 choices available and they will show on the form as:
|
|
|
|
|
|
|
|
|
|
- `Date / Time` date _and_ time picker control
|
|
|
|
|
- `Date` date only picker control
|
|
|
|
|
- `Time` time only picker control
|
|
|
|
|
- `Text` multiline text box for small or large amounts of text (Unicode and Emojis 🌡️ supported as with all AyaNova text fields)
|
|
|
|
|
- `True / False` checkbox control
|
|
|
|
|
- `Integer` integer whole number input control, no fractions
|
|
|
|
|
- `Decimal` decimal number input control, fractional
|
|
|
|
|
- `Money` currency control with currency symbol
|
|
|
|
|
|
|
|
|
|
3. Change the User's translation(s) to show the desired title above the control: Make a note of the translation key for the custom field. It will be shown just beneath the current translation for that field, for example "Custom5" in the Customer form has an internal translation key of "CustomerCustom5". Save your changes here and then use the translation key to [find and edit the translation](adm-translations.md) so that the desired title shows with the Custom field. There is a `Translation` menu item on the Customize form to save a click.
|
|
|
|
|
|
|
|
|
|
### Changing the title of fields
|
|
|
|
|
|
|
|
|
|
To change the text displayed to the User above a field, edit any [translations](adm-translations.md) in use for that field's translation key. The internal Translation Key for each field is displayed in the Customize form beneath the current translation of that field's title to simplify finding which translation item needs to be changed. For example on the Customer's Customize form the "Account number" field shows that the translation key is "AccountNumber".
|
|
|
|
|
|
|
|
|
|
Many translations are re-used when the field contains the same type of data, so, for example an Address field will be used in many forms where and Address is required, not just the Customer form. Keep this in mind when editing translations.
|
|
|
|
|
|
|
|
|
|
Radically changing a fields name to something completely different may be a sign that a Custom field should be used instead as in many cases AyaNova expects a certain kind of data to be in a field. For example a phone number field presents a dialer icon beside it to allow a user with a device that can make a phone call to simply click on the dialer icon to call that number. If you change that field to something that isn't a phone number it will break existing functionality.
|
|
|
|
|
|
