This commit is contained in:
@@ -15,4 +15,4 @@ Large logo is not used on login form.
|
||||
|
||||
## Reporting
|
||||
|
||||
Logos are also available to the reporting system and can be added using the [report editor](form-ay-report-edit.md)
|
||||
Logos are also available to the reporting system and can be added using the [report editor](ay-report-edit.md)
|
||||
@@ -5,4 +5,4 @@ This form is used to set the fields displayed and searched in select lists on fo
|
||||
|
||||
|
||||
This is a placeholder page for sections that are not written yet
|
||||
This setting is *required* and controls which [translation](form-adm-translation.md) of AyaNova is used to display program text to the current logged in user.
|
||||
This setting is *required* and controls which [translation](adm-translation.md) of AyaNova is used to display program text to the current logged in user.
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
AyaNova report templates are listed here.
|
||||
|
||||
You can edit report templates in the [Report template editor](form-ay-report-edit.md)
|
||||
You can edit report templates in the [Report template editor](ay-report-edit.md)
|
||||
|
||||
@@ -276,7 +276,7 @@ Will display as text and url: [AyaNova website](https://www.ayanova.com)
|
||||
|
||||
### ayLogo
|
||||
|
||||
Used to display your business logo that was previusly uploaded via the [Global settings logo page](form-adm-global-logo.md)
|
||||
Used to display your business logo that was previusly uploaded via the [Global settings logo page](adm-global-logo.md)
|
||||
This helper takes a parameter indicating which size of logo is desired and must be one of the following values: `small`, `medium`, `large`
|
||||
|
||||
For example:
|
||||
@@ -291,7 +291,7 @@ Translates an AyaNova translation key into the language indicated by the current
|
||||
|
||||
```{{ ayT 'Customer' }}```
|
||||
|
||||
You can view all the translations keys available in the [Translations](form-adm-translations.md) form.
|
||||
You can view all the translations keys available in the [Translations](adm-translations.md) form.
|
||||
|
||||
|
||||
### ayTime
|
||||
|
||||
@@ -50,8 +50,8 @@ On larger screens the most commonly used options will move from inside the conte
|
||||
|
||||
While the top options in the context menu will change depending on the context, all context menus will have the following options at the bottom:
|
||||
|
||||
- [Search](form-home-search.md) option for searching the AyaNova database
|
||||
- [Search](home-search.md) option for searching the AyaNova database
|
||||
- Help option for viewing help about the specific form being displayed (this manual)
|
||||
- [About](form-ay-about.md) option for viewing version information and technical support information.
|
||||
- [About](ay-about.md) option for viewing version information and technical support information.
|
||||
- [Logout]()
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
## Overview
|
||||
|
||||
Select lists are used to select and / or search for a value on forms. For example a Part on a Workorder form.
|
||||
Select lists can be [customized](form-adm-global-select-templates.md) for each object type so that they will display one or multiple fields from that object type.
|
||||
Select lists can be [customized](adm-global-select-templates.md) for each object type so that they will display one or multiple fields from that object type.
|
||||
|
||||
By default the Name of an object will *always* be present in that object type's select list template in addition to any other fields selected for that object type's select list template.
|
||||
|
||||
@@ -32,7 +32,7 @@ A single string of text with no spaces can be entered into the control to bring
|
||||
Multiple separate text queries are *not* supported, so for example this search `paul pero` is not valid.
|
||||
|
||||
The server will search all the fields that are specified in the select list template for that type of object.
|
||||
By default searches are *not* case sensitive however that can be adjusted via [Global settings](form-adm-global-settings.md) if required.
|
||||
By default searches are *not* case sensitive however that can be adjusted via [Global settings](adm-global-settings.md) if required.
|
||||
|
||||
For example if you want to quickly select a Customer named "Paul's Perogies" you could type `pau` and up to 100 of the Customers with "pau" anywhere in their select list template would be returned for selection. You could also type `per` which would also match to "Paul's Perogies" and any other Customers with "per" anywhere in their template.
|
||||
|
||||
@@ -56,4 +56,4 @@ If the selection list is displaying objects that you are able to open for editin
|
||||
The select list has a clear button that can be used to quickly erase the contents of the select list to save a step when you want to enter a new search.
|
||||
|
||||
## Customizing pick list template
|
||||
The choice of fields displayed and searched in the select list can be [customized](form-adm-global-select-templates.md).
|
||||
The choice of fields displayed and searched in the select list can be [customized](adm-global-select-templates.md).
|
||||
|
||||
@@ -9,14 +9,14 @@ For example a property management company may prefer the term "Apartment" rather
|
||||
AyaNova comes with predefined Translations for `English`, `French`, `Spanish` and `German`
|
||||
|
||||
## Custom Translations
|
||||
A new custom Translation can be made in the AyaNova [Translation editor](form-adm-translation.md).
|
||||
A new custom Translation can be made in the AyaNova [Translation editor](adm-translation.md).
|
||||
|
||||
## Setting the Translation
|
||||
There are two places with settings related to Translations used:
|
||||
|
||||
*Server Default* [AYANOVA_DEFAULT_TRANSLATION](ops-config-default-translation.md) setting used to control the default Translation used. This is used to set new users default Translation, in scenarios where the AyaNova server needs to display or log a message not tied to a specific user or in cases where a User has an in-valid Translation selected.
|
||||
|
||||
*User default* In the AyaNova [User settings form](form-home-user-settings.md) you can select a default Translation for the logged in user.
|
||||
*User default* In the AyaNova [User settings form](home-user-settings.md) you can select a default Translation for the logged in user.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
# OPS-METRICS Placeholder
|
||||
|
||||
make a quick note in help document how to use chart as it's not all obvious
|
||||
i.e. can hover, can hide line by clicking on legend etc
|
||||
//NOTE: CPU percentage is *our* process cpu percentage over timeframe of last captured avg
|
||||
//So it does *not* show the entire server cpu load, only for RAVEN.
|
||||
//Overall, server stats need to be captured / viewed independently (digital ocean control panel for example or windows task manager)
|
||||
|
||||
What each stat means and how it's to be interpreted
|
||||
|
||||
Frequency of stat gathering
|
||||
Auto deleted after 365 days
|
||||
|
||||
Used to provide trend monitoring over time so can know if need to upgrade the server it's hosted on or to anticipate running out of disk space, overwhelmed cpu pegging at 100% etc etc
|
||||
|
||||
Basic shit
|
||||
|
||||
@@ -35,12 +35,12 @@ Some events are related to monetary or other numeric amounts or thresholds, for
|
||||
In the case of an event that can have a report associated with it, you can select a report to be automatically sent with the event (in the case of email delivery) or linked to (in the case of in application delivery).
|
||||
|
||||
### Delivery method
|
||||
Currently you can choose between In application which will deliver to the [notifications](form-home-notifications.md) form and alert via the bell icon at the top of the AyaNova application window and email / SMS delivery via SMTP.
|
||||
Currently you can choose between In application which will deliver to the [notifications](home-notifications.md) form and alert via the bell icon at the top of the AyaNova application window and email / SMS delivery via SMTP.
|
||||
|
||||
### Deliver to Address
|
||||
If email / SMS delivery method is chosen this field is where you enter the address for delivery. If it is to your SMS / MMS device then you must set the address provided by your cellular provider for their [SMS / MMS gateway](https://www.wikihow.com/Send-a-Text-from-Email)
|
||||
|
||||
By default AyaNova will fill this field in with your email address set in your [User settings](form-home-user-settings.md) form however you can change it to any value you wish.
|
||||
By default AyaNova will fill this field in with your email address set in your [User settings](home-user-settings.md) form however you can change it to any value you wish.
|
||||
|
||||
### Tags
|
||||
Here you can select one or more [Tags](ay-start-form-tags.md) (if the event is related to a taggable object) to act as a filter to include or exclude specific objects. For example, you could create a subscription to the Object Created event, select the type as Customer and the Tag as "residential". That way any Customer created and saved with the Tag "residential" will trigger a notification to you but if a Customer is created without the tag "residential" you will not be alerted.
|
||||
|
||||
@@ -6,7 +6,7 @@ This form controls various settings for the currently logged in User.
|
||||
This setting controls the alternative dark theme for UI display. Note that unlike the other settings on this page, this is a local device setting only to allow for different themes when working with different devices in different settings.
|
||||
|
||||
## Translation
|
||||
This setting is *required* and controls which [translation](form-adm-translation.md) of AyaNova is used to display program text to the current logged in user.
|
||||
This setting is *required* and controls which [translation](adm-translation.md) of AyaNova is used to display program text to the current logged in user.
|
||||
The default value is "en" for English.
|
||||
If you change the language setting here you must logout and back in for the changes to take effect.
|
||||
|
||||
|
||||
@@ -11,4 +11,17 @@ When the AyaNova server is booted it starts gathering snapshots of statistical d
|
||||
|
||||
|
||||
todo: how to view metrics, what they mean what to use them for
|
||||
todo: more details
|
||||
how to use chart
|
||||
i.e. can hover, can hide line by clicking on legend etc
|
||||
//NOTE: CPU percentage is *our* process cpu percentage over timeframe of last captured avg
|
||||
//So it does *not* show the entire server cpu load, only for AyaNova.
|
||||
//Overall server stats need to be captured / viewed independently (digital ocean control panel for example or windows task manager)
|
||||
|
||||
What each stat means and how it's to be interpreted
|
||||
|
||||
Frequency of stat gathering
|
||||
Auto deleted after 365 days
|
||||
|
||||
Used to provide trend monitoring over time so can know if need to upgrade the server it's hosted on or to anticipate running out of disk space, overwhelmed cpu pegging at 100% etc etc
|
||||
|
||||
|
||||
@@ -7,15 +7,15 @@ AyaNova has a built in notification system that alerts users to events of intere
|
||||
AyaNova has a default in application "General" type notification (used for internal system alerts and direct notification messages between users) to which all users are automtically subscribed by default.
|
||||
(Users can also optionally add email delivery for General notifications)
|
||||
|
||||
Beyond General notifications, Users can [optionally subscribe](form-home-notify-subscriptions.md) to dozens of other types of built in notifications for specific events such as a particular type of object being created or a Work order status changing.
|
||||
Beyond General notifications, Users can [optionally subscribe](home-notify-subscriptions.md) to dozens of other types of built in notifications for specific events such as a particular type of object being created or a Work order status changing.
|
||||
|
||||
## Notification delivery methods
|
||||
There are two methods of delivering notifications:
|
||||
* In the AyaNova application in the [Notifications](form-home-notifications.md) form
|
||||
* In the AyaNova application in the [Notifications](home-notifications.md) form
|
||||
* Email via SMTP server which includes delivery to regular email programs as well as to devices via [SMS / MMS gateways](https://www.wikihow.com/Send-a-Text-from-Email) provided by Cellular providers.
|
||||
|
||||
## Email delivery configuration
|
||||
The in application delivery does not require any configuration however the SMTP delivery is required to be set up in the [Ops Notification settings](form-ops-notification-settings.md) form.
|
||||
The in application delivery does not require any configuration however the SMTP delivery is required to be set up in the [Ops Notification settings](ops-notification-settings.md) form.
|
||||
|
||||
## Operations specific notification events
|
||||
Operations users should subscribe to several key notifications related directly to system operations:
|
||||
@@ -23,7 +23,7 @@ Operations users should subscribe to several key notifications related directly
|
||||
* BackupStatus - results of last backup operation
|
||||
* ServerOperationsProblem - sent whenever the server encounters any unusual condition or error that could be critical for the continuing operation of the AyaNova server
|
||||
|
||||
These are in addition to the normal operations methods of monitoring the health and status of the server such as [server logs](form-ops-log.md), [metrics](form-ops-metrics.md), [job queue](form-ops-jobs.md) etc.
|
||||
These are in addition to the normal operations methods of monitoring the health and status of the server such as [server logs](ops-log.md), [metrics](ops-metrics.md), [job queue](ops-jobs.md) etc.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -32,95 +32,95 @@ nav:
|
||||
- 'Attachments': 'ay-start-form-attachments.md'
|
||||
- 'Event log': 'ay-start-event-log.md'
|
||||
- Home:
|
||||
- 'Dashboard': 'form-home-dashboard.md'
|
||||
- 'Search': 'form-home-search.md'
|
||||
- 'Schedule': 'form-home-schedule.md'
|
||||
- 'Memos': 'form-home-memos.md'
|
||||
- 'Reminders': 'form-home-reminders.md'
|
||||
- 'User settings': 'form-home-user-settings.md'
|
||||
- 'Translation': 'form-home-translation.md'
|
||||
- 'Set password': 'form-home-password.md'
|
||||
- 'Notification subscriptions': 'form-home-notify-subscriptions.md'
|
||||
- 'Notifications list': 'form-home-notifications.md'
|
||||
- 'Dashboard': 'home-dashboard.md'
|
||||
- 'Search': 'home-search.md'
|
||||
- 'Schedule': 'home-schedule.md'
|
||||
- 'Memos': 'home-memos.md'
|
||||
- 'Reminders': 'home-reminders.md'
|
||||
- 'User settings': 'home-user-settings.md'
|
||||
- 'Translation': 'home-translation.md'
|
||||
- 'Set password': 'home-password.md'
|
||||
- 'Notification subscriptions': 'home-notify-subscriptions.md'
|
||||
- 'Notifications list': 'home-notifications.md'
|
||||
- Customers:
|
||||
- 'Customers': 'form-customers.md'
|
||||
- 'Head offices': 'form-head-offices.md'
|
||||
- 'Customers': 'customers.md'
|
||||
- 'Head offices': 'head-offices.md'
|
||||
- Service:
|
||||
- 'Schedule': 'form-svc-schedule.md'
|
||||
- 'Workorders': 'form-svc-workorders.md'
|
||||
- 'Workorder templates': 'form-svc-workorder-templates.md'
|
||||
- 'Quotes': 'form-svc-quotes.md'
|
||||
- 'Quote templates': 'form-svc-quote-templates.md'
|
||||
- 'Preventive maintenance': 'form-svc-pm-list.md'
|
||||
- 'Preventive maintenance templates': 'form-svc-pm-templates.md'
|
||||
- 'Customer units': 'form-svc-units.md'
|
||||
- 'Unit models': 'form-svc-unit-models.md'
|
||||
- 'Loan items': 'form-svc-loaners.md'
|
||||
- 'Contracts': 'form-svc-contracts.md'
|
||||
- 'Customer service requests': 'form-svc-csr.md'
|
||||
- 'Schedule': 'svc-schedule.md'
|
||||
- 'Workorders': 'svc-workorders.md'
|
||||
- 'Workorder templates': 'svc-workorder-templates.md'
|
||||
- 'Quotes': 'svc-quotes.md'
|
||||
- 'Quote templates': 'svc-quote-templates.md'
|
||||
- 'Preventive maintenance': 'svc-pm-list.md'
|
||||
- 'Preventive maintenance templates': 'svc-pm-templates.md'
|
||||
- 'Customer units': 'svc-units.md'
|
||||
- 'Unit models': 'svc-unit-models.md'
|
||||
- 'Loan items': 'svc-loaners.md'
|
||||
- 'Contracts': 'svc-contracts.md'
|
||||
- 'Customer service requests': 'svc-csr.md'
|
||||
- Inventory:
|
||||
- 'Parts': 'form-inv-parts.md'
|
||||
- 'Part warehouses': 'form-inv-part-warehouses.md'
|
||||
- 'Part serial numbers': 'form-inv-part-serials.md'
|
||||
- 'Part stock levels': 'form-inv-part-stock-levels.md'
|
||||
- 'Part assemblies': 'form-inv-part-assemblies.md'
|
||||
- 'Part inventory': 'form-inv-part-inventory.md'
|
||||
- 'Part requests': 'form-inv-part-requests.md'
|
||||
- 'Purchase orders': 'form-inv-purchase-orders.md'
|
||||
- 'Purchase order receipts': 'form-inv-purchase-order-receipts.md'
|
||||
- 'Adjustments': 'form-inv-adjustments.md'
|
||||
- 'Parts': 'inv-parts.md'
|
||||
- 'Part warehouses': 'inv-part-warehouses.md'
|
||||
- 'Part serial numbers': 'inv-part-serials.md'
|
||||
- 'Part stock levels': 'inv-part-stock-levels.md'
|
||||
- 'Part assemblies': 'inv-part-assemblies.md'
|
||||
- 'Part inventory': 'inv-part-inventory.md'
|
||||
- 'Part requests': 'inv-part-requests.md'
|
||||
- 'Purchase orders': 'inv-purchase-orders.md'
|
||||
- 'Purchase order receipts': 'inv-purchase-order-receipts.md'
|
||||
- 'Adjustments / transactions': 'inv-part-inventory-transactions.md'
|
||||
- Accounting:
|
||||
- 'Service rates': 'form-acc-service-rates.md'
|
||||
- 'Travel rates': 'form-acc-travel-rates.md'
|
||||
- 'Tax codes': 'form-acc-tax-codes.md'
|
||||
- 'Service rates': 'acc-service-rates.md'
|
||||
- 'Travel rates': 'acc-travel-rates.md'
|
||||
- 'Tax codes': 'acc-tax-codes.md'
|
||||
- Administration:
|
||||
- 'Global settings': 'form-adm-global-settings.md'
|
||||
- 'License': 'form-adm-license.md'
|
||||
- 'Users': 'form-adm-users.md'
|
||||
- 'Translations': 'form-adm-translations.md'
|
||||
- 'Report templates': 'form-adm-report-templates.md'
|
||||
- 'Attached files': 'form-adm-attachments.md'
|
||||
- 'History': 'form-adm-history.md'
|
||||
- 'Import': 'form-adm-import.md'
|
||||
- 'Vendors': 'form-vendors.md'
|
||||
- 'Global settings': 'adm-global-settings.md'
|
||||
- 'License': 'adm-license.md'
|
||||
- 'Users': 'adm-users.md'
|
||||
- 'Translations': 'adm-translations.md'
|
||||
- 'Report templates': 'adm-report-templates.md'
|
||||
- 'Attached files': 'adm-attachments.md'
|
||||
- 'History': 'adm-history.md'
|
||||
- 'Import': 'adm-import.md'
|
||||
- 'Vendors': 'vendors.md'
|
||||
- Misc:
|
||||
- 'About': 'form-ay-about.md'
|
||||
- 'Report': 'form-ay-report.md'
|
||||
- 'Review': 'form-ay-review.md'
|
||||
- 'History': 'form-ay-history.md'
|
||||
- 'Customize': 'form-ay-customize.md'
|
||||
- 'Data list view': 'form-ay-data-list-view.md'
|
||||
- 'Log': 'form-ay-log.md'
|
||||
- 'Report editor': 'form-ay-report-edit.md'
|
||||
- 'About': 'ay-about.md'
|
||||
- 'Report': 'ay-report.md'
|
||||
- 'Review': 'ay-review.md'
|
||||
- 'History': 'ay-history.md'
|
||||
- 'Customize': 'ay-customize.md'
|
||||
- 'Data list view': 'ay-data-list-view.md'
|
||||
- 'Log': 'ay-log.md'
|
||||
- 'Report editor': 'ay-report-edit.md'
|
||||
- Extensions:
|
||||
- 'Tags extension': 'ay-ex-tags.md'
|
||||
- 'Export extension': 'ay-ex-export.md'
|
||||
- 'Delete extension': 'ay-ex-delete.md'
|
||||
- Customer:
|
||||
- 'Workorders': 'form-customer-workorders.md'
|
||||
- 'Customer service requests': 'form-customer-csr-list.md'
|
||||
- 'Widgets (testing)': 'form-widgets.md'
|
||||
- 'Workorders': 'customer-workorders.md'
|
||||
- 'Customer service requests': 'customer-csr-list.md'
|
||||
- 'Widgets (testing)': 'widgets.md'
|
||||
- Features:
|
||||
- 'Translation': 'ay-translation.md'
|
||||
- 'Notification': 'ay-notification.md'
|
||||
- Business administration and Customization:
|
||||
- 'Start here': 'ay-biz-admin-intro.md'
|
||||
- 'Authorization roles': 'ay-biz-admin-roles.md'
|
||||
- 'Select list templates': 'form-adm-global-select-templates.md'
|
||||
- 'Business logos': 'form-adm-global-logo.md'
|
||||
- 'Select list templates': 'adm-global-select-templates.md'
|
||||
- 'Business logos': 'adm-global-logo.md'
|
||||
- 'Importing from v7': 'ay-biz-admin-import-v7.md'
|
||||
- Trying out AyaNova:
|
||||
- 'Evaluate': 'ay-evaluate.md'
|
||||
- Server operations guide:
|
||||
- Forms:
|
||||
- 'Introduction': 'ops-intro.md'
|
||||
- 'Server state': 'form-ops-server-state.md'
|
||||
- 'Backup': 'form-ops-backup.md'
|
||||
- 'Job queue': 'form-ops-jobs.md'
|
||||
- 'Server log': 'form-ops-log.md'
|
||||
- 'Server metrics': 'form-ops-metrics.md'
|
||||
- 'Profile': 'form-ops-profile.md'
|
||||
- 'Notification settings': 'form-ops-notification-settings.md'
|
||||
- 'Server state': 'ops-server-state.md'
|
||||
- 'Backup': 'ops-backup.md'
|
||||
- 'Job queue': 'ops-jobs.md'
|
||||
- 'Server log': 'ops-log.md'
|
||||
- 'Server metrics': 'ops-metrics.md'
|
||||
- 'Profile': 'ops-profile.md'
|
||||
- 'Notification settings': 'ops-notification-settings.md'
|
||||
- 'Backup': 'ops-form-backup.md'
|
||||
- Technical:
|
||||
- 'Installation': '_placeholder.md'
|
||||
|
||||
Reference in New Issue
Block a user