BIN
docs/8.0/ayanova/docs/img/tour-bizadmin-form-remove-fields-1.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
docs/8.0/ayanova/docs/img/tour-bizadmin-form-remove-fields-2.png
Normal file
|
After Width: | Height: | Size: 75 KiB |
BIN
docs/8.0/ayanova/docs/img/tour-bizadmin-form-remove-fields-3.png
Normal file
|
After Width: | Height: | Size: 80 KiB |
BIN
docs/8.0/ayanova/docs/img/tour-bizadmin-form-remove-fields-4.png
Normal file
|
After Width: | Height: | Size: 83 KiB |
BIN
docs/8.0/ayanova/docs/img/tour-bizadmin-form-remove-fields-5.png
Normal file
|
After Width: | Height: | Size: 105 KiB |
BIN
docs/8.0/ayanova/docs/img/tour-bizadmin-form-remove-fields-6.png
Normal file
|
After Width: | Height: | Size: 49 KiB |
BIN
docs/8.0/ayanova/docs/img/tour-bizadmin-login.png
Normal file
|
After Width: | Height: | Size: 64 KiB |
120
docs/8.0/ayanova/docs/tour-bizadmin-form-remove-fields.md
Normal file
@@ -0,0 +1,120 @@
|
||||
# Guided tour: Hide edit form fields
|
||||
|
||||
In this guided tour we'll remove (hide) some fields from a Customer edit form that are not required.
|
||||
|
||||
The same technique you learn here applies to any other type of form in AyaNova.
|
||||
|
||||
AyaNova comes with a _lot_ of fields on forms but only a very small number of them are actually required, the rest are optional and it can be helpful to remove the ones you don't need.
|
||||
|
||||
By default AyaNova will show _all_ the fields available on for a form so that you know what is available to you.
|
||||
|
||||
Hiding or showing form fields applies to _all users_ of AyaNova equally.
|
||||
|
||||
For the Work order type forms AyaNova will automatially hide some sensitive fields such as costs and pricing and also hide entire areas from lower level Roles such as Subcontractors regardless of how they are customized.
|
||||
|
||||
The screen shots will show how AyaNova looks on a PC or tablet, if you are using a narrow screen device such as a smart phone your view will be [slightly different](ay-start-form-overview.md#responsive-display) but the functionality is the same.
|
||||
|
||||
If you don't already have AyaNova available to follow along, everything you need to get started is available here: [Try AyaNova now](ay-evaluate.md).
|
||||
|
||||
## 1\. Login as a user with permission to modify form fields
|
||||
|
||||
In AyaNova a [User](adm-users.md) needs permission to view and make changes to objects, this permission is called an [Authorization role](ay-biz-admin-roles.md) in AyaNova and an administrator [grants permissions](adm-users.md#authorization-roles) to each User as required.
|
||||
|
||||
Only a User with the [Business administration role](ay-biz-admin-roles.md#business-administration) can remove or show form fields.
|
||||
|
||||
For this tutorial you should login as a User with one of those Roles.
|
||||
|
||||
If you are using the AyaNova [sample data](ay-evaluate.md#generating-sample-data), we've provided a sample User for each type of Role so for this tour you should login as the `Business Admin` / `BizAdmin` sample User to follow along:
|
||||
|
||||

|
||||
|
||||
## 2\. Open a Customer edit form
|
||||
|
||||
Edit forms are customized _from_ the type of form you want to edit.
|
||||
|
||||
When you are logged in as a BizAdmin role User a _Customize_ menu option will appear in any form that can be Customized.
|
||||
|
||||
So the first step is to get to a Customer's edit form, it doesn't matter _which_ Customer, any one will do.
|
||||
|
||||
Navigate to an area of AyaNova where Customers are displayed in their data table. There are a few different ways to get there but we'll use the simplest one for this tutorial and open a Customer from the Customers data table list.
|
||||
|
||||
### Click on the "Hamburger" icon
|
||||
|
||||
In AyaNova the main way to navigate around is by using the [navigation drawer](ay-start-form-overview.md#navigation-drawer) which is an area that slides out on screen to choose where you want to go.
|
||||
|
||||
When logged in you can access the navigation drawer from what is commonly known as a "hamburger" icon (highlighted below) because it looks kind of like a hamburger:
|
||||
|
||||

|
||||
|
||||
Click on the hamburger icon to show the navigation drawer.
|
||||
|
||||
### Navigation drawer Customers items
|
||||
|
||||
In the image below you can see the options available to the sample "Business admin" User generated by AyaNova. Users with a different set of Roles will see different options here.
|
||||
|
||||

|
||||
|
||||
The area we want is "Customers" and the sub item also "Customers" so go ahead and click on that to cause AyaNova to navigate to the list of Customers previously entered in AyaNova:
|
||||
|
||||

|
||||
|
||||
This list is known in AyaNova as a ["Data table"](ay-start-form-data-tables.md), data tables are used in many places in AyaNova for different kinds of objects. Data tables have many [features and options](ay-start-form-data-tables.md) to control what is displayed and how it's displayed so you can restrict the view to show only what is important for any given task.
|
||||
|
||||
### Open a Customer record
|
||||
|
||||
Now click on any Customer's name in the list to open their record in the [Customer edit form](customers.md).
|
||||
|
||||

|
||||
|
||||
In the image above we can see the top part of a Customer edit form with all the fields showing by default. We'll stick with the top part so the images are easier to see in this manual but the steps apply to a field _anywhere_ on a form.
|
||||
|
||||
## 3\. Customize
|
||||
|
||||
Our example business doesn't need all those extra phone fields, we really only need the business phone and we don't need the extra Account number field so let's get rid of them.
|
||||
|
||||
Click on the menu button in the top right of the form. We're logged in as a Business Administration role user in [step 1](#1-login-as-a-user-with-permission-to-modify-form-fields) so when we open the menu on a form we see a _Customize_ option:
|
||||
|
||||

|
||||
|
||||
Go ahead and click on _Customize_ now to open the [form customization interface](ay-customize.md):
|
||||
|
||||

|
||||
|
||||
In the image above you can see boxes representing each field that _can be customized_ on this form.
|
||||
|
||||
The title at the top of each box shows how it displays in your current language on the form you just came from. Below that is the [translation key]()
|
||||
|
||||
Fields that can _not_ be customized are not shown on this form. For example the Customer "Name" field is required so it can not be hidden and is not displayed here.
|
||||
|
||||
In this form you can do other things besides hide fields for example making a field required or using Custom fields which we have separate guided tours for each of those concepts.
|
||||
|
||||
For this tour we'll remove the checkmark from the "Visible" checkbox to hide the following fields:
|
||||
|
||||
`Account number`, `Fax`, `Home`, `Mobile`, `Pager`
|
||||
|
||||
And click on the Save button at the top:
|
||||
|
||||

|
||||
|
||||
Now click on your browser's back button to go back to the Customer form and those fields are now removed:
|
||||
|
||||

|
||||
|
||||
AyaNova has a fluid layout system so there are no empty "holes" in the display, other fields just slide up or over to take the place of the hidden ones.
|
||||
|
||||
### Other users
|
||||
|
||||
As soon as you saved the customization changes they took effect for all other Users as soon as they next open the Customer edit form. In other words if they were actively editing a Customer they wouldn't see a change but the moment they opened another Customer for editing the change would take effect.
|
||||
|
||||
### Oops!
|
||||
|
||||
You just realized you made a mistake and don't want to hide the `Fax` field as Faxes are actually used for some of your customers still (and faxes are making a comeback). No problem, no data has been lost, just click on Customize in the menu again and put a checkmark beside the _Visible_ field in the `Fax` customization box, save your changes and faxes are back!
|
||||
|
||||
## What happens to the data of a removed field?
|
||||
|
||||
Removing a field doesn't erase any data that might have been previously entered into that field, it's still there, just not showing in the form.
|
||||
You can show a field again later on if you find you need it when things change and your business grows.
|
||||
|
||||
## Does removing a field from an edit form remove it from everywhere?
|
||||
|
||||
Removing a field from a edit _form_ doesn't remove it from a report so in some cases you may also want to [edit the report template](ay-report-edit.md) to remove the field. Also it doesn't remove it from a data table however data tables are often changed anyway to [show specific columns](ay-start-form-data-tables.md#column-selector) desired.
|
||||
@@ -12,7 +12,7 @@ If you don't already have AyaNova available to follow along, everything you need
|
||||
|
||||
## 1\. Login as a user with permission to make a work order
|
||||
|
||||
In AyaNova a [User](adm-users.md) needs permission to view and make changes to objects, this permission is called an [Authorization role](ay-biz-admin-roles.md) in AyaNova and an administrator grants permissions to each User as required.
|
||||
In AyaNova a [User](adm-users.md) needs permission to view and make changes to objects, this permission is called an [Authorization role](ay-biz-admin-roles.md) in AyaNova and an administrator [grants permissions](adm-users.md#authorization-roles) to each User as required.
|
||||
|
||||
Many User roles can access [Work orders](svc-workorders.md) and change various parts of them but the Roles with the highest level of access to change and view all areas of a work order are a [User](adm-users.md) with the [Business administration Role](ay-biz-admin-roles.md#business-administration) or a User with the [Service manager Role](ay-biz-admin-roles.md#service-manager).
|
||||
|
||||
@@ -74,11 +74,11 @@ You can't see it in the image but when the form is in an invalid state the save
|
||||
|
||||
### If you needed to create a new customer
|
||||
|
||||
In this tour we're going to select an existing Customer but you *could* also create a new Customer right here by clicking on the open record button
|
||||
In this tour we're going to select an existing Customer but you _could_ also create a new Customer right here by clicking on the open record button
|
||||

|
||||
to the left of the Customer selection list.
|
||||
|
||||
When you click on the open record button on any list but there is no item selected (indicated by the no selection item `-`), this triggers the creation of a _new_ record of that type.
|
||||
When you click on the open record button on any list but there is no item selected (indicated by the no selection item `-`), this triggers the creation of a _new_ record of that type.
|
||||
|
||||
So if you started this work order without a Customer you can use the open record button to go and create a new Customer, then use the back button in your browser to return to this work order and select that Customer for this work order.
|
||||
|
||||
@@ -164,32 +164,53 @@ Next up is to create a new Work order item to specify the equipment to be servic
|
||||
|
||||
## 7\. Add a work order item
|
||||
|
||||
Currently our work order only has a Header, there are no work order items so let's add one now. Work order items are added from the Items context menu:
|
||||
Currently our work order only has a Header, there are no work order items so let's add one now.
|
||||
|
||||
Work order items are added from the Items context menu:
|
||||
|
||||

|
||||
|
||||
Because there are no existing items and no item is selected there is only one option:
|
||||
> NOTE: this context menu button highlighted in red above is very important, it will have extra options once a work order item is _selected_ and you will use it again later to add sub-items such as labor or scheduled users to a particular Work order item.
|
||||
|
||||
Because there are no existing items **and no work order item is selected** there is currently only one option available:
|
||||
|
||||

|
||||
|
||||
Click on it to create the new work order item:
|
||||
Click on _New_ to create the new work order item:
|
||||
|
||||

|
||||
|
||||
In the image above, the form has changed to display the work order items table and the current (only) work order item's edit fields are displayed under the table.
|
||||
In the image above, the form has changed to display the work order items table and the current (only) work order item's edit fields are displayed beneath the table.
|
||||
|
||||
If there was more than one work order item they would also display in the table and clicking on the row would change the edit form fields to _that_ work order item record.
|
||||
|
||||
Here we can see that the Summary field is required and needs to be filled in. Unlike the header summary field this one applies to this work order item only and it _does_ display on stock reports intended for Customers such as the Customer Invoice and Customer Work order reports.
|
||||
Here we can see that the Summary field is required and needs to be filled in because it displays in red with a message displayed beneath the field.
|
||||
|
||||
If this was a larger work order with multiple work order items then each separate aspect of service would be documented on each work order item independently. For such a simple work order there isn't much need to enter more than the same duplicate information from the header summary.
|
||||
Unlike the work order _header's_ Summary field, this one applies to this work order item only and it _does_ display on stock reports intended for Customers such as the Customer Invoice and Customer Work order reports.
|
||||
|
||||
This is a required field and something must be entered here.
|
||||
|
||||
> Larger and more complex service jobs with multiple work order items often require a more detailed Summary of what each particular work order item is _about_ so that each separate aspect of service is documented on each work order item independently and makes sense to the Customer and the technicians doing the work.
|
||||
|
||||
> For example a more complex work order might have several work order items on it because multiple different areas, stages or Units of Customer equipment are being serviced on-site and keeping them in separate work order items helps to cleanly organize all the aspects of service for each item.
|
||||
|
||||
> In many cases it's also useful to enter information here with **future** service calls in mind as all the text entered on a work order is searchable and it can be very useful to have a reference during service to past examples of some specfic type of work that was done before. Using AyaNova in this way turns all past service into a valuable knowledgebase resource and saves time "re-inventing the wheel".
|
||||
|
||||
> There are no rules as to how the work order is used and you can enter as much or as little information as required to provide service and track information.
|
||||
|
||||
For a simple work order like this example, there isn't much need to enter more than the same duplicate information from the header summary.
|
||||
|
||||
Next up is to select the exact Customer [Unit](svc-units.md) that requires service as this particular work is to repair an item of equipment that we track in AyaNova:
|
||||
|
||||
## 8\. Select a Work order item Unit
|
||||
|
||||
Now that we have a work order item the Work order item context menu will be able to offer all the different types of objects that can be added to this item.
|
||||
Clicking on it again reveals a much larger set of items:
|
||||
Now that we have a work order item the Work order item context menu you used above to make a work order item:
|
||||
|
||||

|
||||
|
||||
will be able to offer all the different types of objects that can be added to this item.
|
||||
|
||||
Clicking on the work order item context menu button again reveals a much larger set of items:
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ theme:
|
||||
site_name: AyaNova manual
|
||||
site_dir: '../../../server/AyaNova/wwwroot/docs'
|
||||
strict: true
|
||||
copyright: Copyright © 2022 Ground Zero Tech-Works Inc. REV-2022-10-20
|
||||
copyright: Copyright © 2022 Ground Zero Tech-Works Inc. REV-2022-10-21
|
||||
extra:
|
||||
generator: false
|
||||
# Extensions
|
||||
@@ -24,7 +24,9 @@ nav:
|
||||
- 'Try AyaNova now': 'ay-evaluate.md'
|
||||
- Guided tours:
|
||||
- 'Introduction': 'tour-intro.md'
|
||||
- Service tasks:
|
||||
- Business admin:
|
||||
- 'Hide form fields': 'tour-bizadmin-form-remove-fields.md'
|
||||
- Service:
|
||||
- 'Create a work order': 'tour-service-wo.md'
|
||||
- 'Changes from AyaNova 7': 'ay-start-changes-from-v7.md'
|
||||
- User interface:
|
||||
|
||||