221 lines
9.6 KiB
YAML
221 lines
9.6 KiB
YAML
theme:
|
|
name: material
|
|
palette:
|
|
scheme: default
|
|
favicon: 'img/favicon.ico'
|
|
logo: 'img/logo.svg'
|
|
site_name: AyaNova manual
|
|
site_dir: '../../../server/AyaNova/wwwroot/docs'
|
|
strict: true
|
|
copyright: Copyright © 2023 Ground Zero Tech-Works Inc. REV-2023-01-25
|
|
extra:
|
|
generator: false
|
|
# Extensions
|
|
markdown_extensions:
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.superfences
|
|
- toc:
|
|
permalink: true
|
|
|
|
nav:
|
|
- Home: 'index.md'
|
|
- User guide:
|
|
- 'Try AyaNova now': 'ay-evaluate.md'
|
|
- Guided tours:
|
|
- 'Introduction': 'tour-intro.md'
|
|
- Start here:
|
|
- 'Steps to production use': 'tour-bootstrap-intro.md'
|
|
- 'Evaluation': 'tour-bootstrap-evaluate.md'
|
|
- 'Acquisition': 'tour-bootstrap-acquire.md'
|
|
- 'Configuration and going live': 'tour-bootstrap-configure.md'
|
|
- 'Advanced features': 'tour-bootstrap-advanced.md'
|
|
- Business admin:
|
|
- 'Hide form fields': 'tour-bizadmin-form-remove-fields.md'
|
|
- 'Require field entry': 'tour-bizadmin-form-require-fields.md'
|
|
- 'Customize text': 'tour-bizadmin-form-custom-translation.md'
|
|
- 'Custom fields': 'tour-bizadmin-form-custom-fields.md'
|
|
- Service:
|
|
- 'Create a Customer': 'tour-service-create-customer.md'
|
|
- 'Create a work order': 'tour-service-wo.md'
|
|
- 'Changes from AyaNova 7': 'ay-start-changes-from-v7.md'
|
|
- User interface:
|
|
- Introduction:
|
|
- 'Forms': 'ay-start-form-overview.md'
|
|
- 'Login': 'ay-start-login.md'
|
|
- 'Edit forms': 'ay-start-edit-forms.md'
|
|
- 'Form controls': 'ay-start-common-controls.md'
|
|
- 'Data tables': 'ay-start-form-data-tables.md'
|
|
- 'Autocomplete lists': 'ay-start-form-autocomplete.md'
|
|
- 'Tags': 'ay-start-form-tags.md'
|
|
- 'Wiki': 'ay-start-form-wiki.md'
|
|
- 'Custom fields': 'ay-customize.md'
|
|
- 'Attachments': 'ay-start-form-attachments.md'
|
|
- Home:
|
|
- 'Dashboard': 'home-dashboard.md'
|
|
- 'Search': 'home-search.md'
|
|
- 'Schedule': 'home-schedule.md'
|
|
- 'Memos': 'home-memos.md'
|
|
- 'Reminders': 'home-reminders.md'
|
|
- 'Reviews': 'home-reviews.md'
|
|
- 'User settings': 'home-user-settings.md'
|
|
- 'Set password': 'home-password.md'
|
|
- 'Two factor authentication': 'home-tfa.md'
|
|
- 'Notification subscriptions': 'home-notify-subscriptions.md'
|
|
- 'Notifications list': 'home-notifications.md'
|
|
- 'Direct notification': 'home-notify-direct.md'
|
|
- 'History': 'ay-history.md'
|
|
- Customers:
|
|
- 'Customers': 'customers.md'
|
|
- 'Customer contacts': 'cust-contacts.md'
|
|
- 'Customer notes': 'customer-notes.md'
|
|
- 'Head offices': 'head-offices.md'
|
|
- 'Customer notifications': 'customer-notify-subscriptions.md'
|
|
- Service:
|
|
- 'Schedule': 'svc-schedule.md'
|
|
- 'Work orders': 'svc-workorders.md'
|
|
- 'Work order task group': 'svc-task-groups.md'
|
|
- 'Work order status': 'svc-work-order-status.md'
|
|
- 'Work order item status': 'svc-work-order-item-status.md'
|
|
- 'Work order item priority': 'svc-work-order-item-priority.md'
|
|
- 'Quotes': 'svc-quotes.md'
|
|
- 'Quote status': 'svc-quote-status.md'
|
|
- 'Preventive maintenance': 'svc-pms.md'
|
|
- 'Customer units': 'svc-units.md'
|
|
- 'Unit models': 'svc-unit-models.md'
|
|
- 'Loan items': 'svc-loaners.md'
|
|
- 'Contracts': 'svc-contracts.md'
|
|
- 'Projects': 'svc-projects.md'
|
|
- 'Customer service requests': 'svc-csr.md'
|
|
- 'Meter readings': 'svc-meter-readings.md'
|
|
- Inventory:
|
|
- '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'
|
|
- 'Adjustments / transactions': 'inv-part-inventory-transactions.md'
|
|
- Accounting:
|
|
- 'Service rates': 'acc-service-rates.md'
|
|
- 'Travel rates': 'acc-travel-rates.md'
|
|
- 'Tax codes': 'acc-tax-codes.md'
|
|
- Administration:
|
|
- 'Getting started guided tour': 'tour-bootstrap-configure.md'
|
|
- 'Global settings': 'adm-global-settings.md'
|
|
- 'Seed numbers': 'adm-global-seeds.md'
|
|
- 'License': 'adm-license.md'
|
|
- 'Users': 'adm-users.md'
|
|
- 'Translations': 'adm-translations.md'
|
|
- 'Localization': 'ay-start-localization.md'
|
|
- 'Report templates': 'adm-report-templates.md'
|
|
- 'adm-attachments.md'
|
|
- 'Global history': 'adm-history.md'
|
|
- 'Import': 'adm-import.md'
|
|
- 'Import Customers': 'adm-import-customer.md'
|
|
- 'Import Head offices': 'adm-import-headoffice.md'
|
|
- 'Import Inventory': 'adm-import-inventory.md'
|
|
- 'Import Part assemblies': 'adm-import-part-assembly.md'
|
|
- 'Import Parts': 'adm-import-part.md'
|
|
- 'Import Projects': 'adm-import-project.md'
|
|
- 'Import Service rates': 'adm-import-service-rate.md'
|
|
- 'Import Task groups': 'adm-import-task-group.md'
|
|
- 'Import Travel rates': 'adm-import-travel-rate.md'
|
|
- 'Import Unit models': 'adm-import-unit-model.md'
|
|
- 'Import Units': 'adm-import-unit.md'
|
|
- 'Import Vendors': 'adm-import-vendor.md'
|
|
- 'Import Warehouses': 'adm-import-warehouse.md'
|
|
- 'Integrated applications': 'adm-integrations.md'
|
|
- 'Vendors': 'vendors.md'
|
|
- Extensions:
|
|
- 'Extensions': 'ay-extensions.md'
|
|
- 'Tags extension': 'ay-ex-tags.md'
|
|
- 'Export extension': 'ay-ex-export.md'
|
|
- 'Delete extension': 'ay-ex-delete.md'
|
|
- Misc:
|
|
- 'About': 'ay-about.md'
|
|
- 'Authorization roles': 'ay-biz-admin-roles.md'
|
|
- 'Business logos': 'adm-global-logo.md'
|
|
- 'Customize': 'ay-customize.md'
|
|
- 'Migrating from v7': 'ay-biz-admin-migrate-v7.md'
|
|
- 'Report editor': 'ay-report-edit.md'
|
|
- 'Report picker': 'ay-report.md'
|
|
- 'Report timeout warning': 'ay-report-timeout.md'
|
|
- 'Autocomplete list templates': 'adm-global-autocomplete-templates.md'
|
|
- 'Web app diagnostic log': 'ay-log.md'
|
|
- Integrations:
|
|
- 'QuickBooks desktop': 'integration-qbd.md'
|
|
- Server operations guide:
|
|
- 'Introduction': 'ops-intro.md'
|
|
- Installation:
|
|
- 'Start': 'ops-install.md'
|
|
- 'Windows': 'ops-install-windows.md'
|
|
- 'Windows single user': 'ops-install-windows-single.md'
|
|
- 'Windows local network': 'ops-install-windows-lan.md'
|
|
- 'Windows IIS': 'ops-install-windows-iis.md'
|
|
- 'Linux': 'ops-install-linux.md'
|
|
- 'Linux desktop': 'ops-install-linux-desktop.md'
|
|
- 'Linux server': 'ops-install-linux-server.md'
|
|
- Upgrade:
|
|
- 'Start': 'ops-upgrade.md'
|
|
- 'Windows single user': 'ops-upgrade-windows-single.md'
|
|
- 'Windows local network': 'ops-upgrade-windows-lan.md'
|
|
- 'Windows IIS': 'ops-upgrade-windows-iis.md'
|
|
- 'Linux desktop': 'ops-upgrade-linux-desktop.md'
|
|
- 'Linux server': 'ops-upgrade-linux-server.md'
|
|
- Migration:
|
|
- 'Migrating from AyaNova 7': 'ops-import-v7.md'
|
|
- Backup & Restore:
|
|
- 'Backup': 'ops-form-backup.md'
|
|
- 'Restore': 'ops-restore.md'
|
|
- Operations interface:
|
|
- 'Server state': 'ops-server-state.md'
|
|
- 'Backup': 'ops-form-backup.md'
|
|
- 'Job queue': 'ops-jobs.md'
|
|
- 'Server log': 'ops-log.md'
|
|
- 'Server metrics': 'ops-metrics.md'
|
|
- 'Notification settings': 'ops-notification-system.md'
|
|
- 'Customer notification log': 'ops-customer-notify-log.md'
|
|
- 'User notification log': 'ops-notify-log.md'
|
|
- 'Backup': 'ops-form-backup.md'
|
|
- Technical:
|
|
- 'Maintenance': 'ops-maintenance.md'
|
|
- 'Logging': 'ops-log.md'
|
|
- 'View server settings': 'ops-server-information.md'
|
|
- 'Server locale settings': 'ops-server-locale.md'
|
|
- 'Translation / Language': 'ops-config-default-translation.md'
|
|
- 'Data path': 'ops-config-data-path.md'
|
|
- 'Attachments folder': 'ops-config-folder-user-files.md'
|
|
- 'Server temporary files folder': 'ops-config-folder-temporary-files.md'
|
|
- 'Database configuration': 'ops-config-db.md'
|
|
- 'PORT and URL configuration': 'ops-config-use-urls.md'
|
|
- 'Reporting render API URL override': 'ops-config-report-rendering-api-url-override.md'
|
|
- 'Reporting render browser path': 'ops-config-report-render-browser-path.md'
|
|
- 'Reporting timeout configuration': 'ops-config-report-rendering-timeout.md'
|
|
- 'Environment variable reference': 'ops-config-environment-variables.md'
|
|
- 'Security and JWT web tokens': 'ops-config-jwt-secret.md'
|
|
- 'SuperUser password reset': 'ops-config-set-superuser-pw.md'
|
|
- 'Server error codes': 'ops-error-codes.md'
|
|
- 'Migrating from AyaNova 7': 'ops-import-v7.md'
|
|
- 'Metrics': 'ops-metrics.md'
|
|
- 'Notification system': 'ops-notification-system.md'
|
|
- 'Backup utility PGDUMP path': 'ops-config-backup-pgdump-path.md'
|
|
- 'Backup folder': 'ops-config-folder-backup-files.md'
|
|
- Developer guide:
|
|
- 'Introduction': 'api-intro.md'
|
|
- 'API developers console': 'api-console.md'
|
|
- 'API request format': 'api-request-format.md'
|
|
- 'API response format': 'api-response-format.md'
|
|
- 'API error codes': 'api-error-codes.md'
|
|
- 'API upload routes': 'api-upload-routes.md'
|
|
- 'API Integrated applications': 'api-integrated-applications.md'
|
|
- 'API Data types': 'ay-start-data-types.md'
|
|
- Appendix:
|
|
- 'Change log / release notes': 'changelog.md'
|
|
- 'Data types': 'ay-start-data-types.md'
|
|
- 'Open source credits': 'appendix-os-credits.md'
|
|
- 'Perpetual License agreement': 'license.md'
|
|
- 'Subscription service agreement': 'ayanova-subscription-service-agreement.md'
|