diff --git a/docs/8.0/ayanova/docs/adm-attachments.md b/docs/8.0/ayanova/docs/adm-attachments.md index b6679d28..7e2bda8b 100644 --- a/docs/8.0/ayanova/docs/adm-attachments.md +++ b/docs/8.0/ayanova/docs/adm-attachments.md @@ -1,4 +1,68 @@ -# ATTACHMENTS Placeholder +# Attached files table + +The attached files data table is used to view and validate all [attachments](ay-start-form-attachments.md) known to AyaNova that Users have placed on objects. + +## 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 + +- Business administration - restricted + +## How to access attached files table + +Attached files are accessed in the following ways: + +- From the `Administration` navigation pane `Attached files` item + +## How attachments are stored + +When a User uploads an attachment using the [attachments control](ay-start-form-attachments.md), AyaNova first creates a unique digital signature of the file and then stores it on disk in the attachments folder specified by the [AYANOVA_ATTACHMENT_FILES_PATH](ops-config-folder-user-files.md) server configuration setting. + +The files are _not_ stored under their original name but rather re-named according to their digital signature. The special folder structure in attachments and the renaming are required for three reasons: + +1. ensure that there are never more files in a single folder than are permitted under the operating system requirements +2. save disk space by ensuring that identical files are only stored once +3. secure the file names themeselves which may contain sensitive information + +## Menu options + +#### Start attachment maintenance job + +It is a possibility however unlikely that over time a file could become separated from it's business object. This menu option starts a job that verifies every object and file are present and connected to each other. If an object is found to link to an attachment that does not exist that link will be removed from the database. + +If a file is found to be physically present that does not have an object in the database linked to it, it will be linked to a special "nothing" object that will appear in this attachments list as the host object for that file so that the administrator can either re-attach it or delete it (or leave it unattached, there's no harm in doing so if that is useful). + +#### Move selected items + +This option will "move" one or more [selected](ay-start-form-data-tables.md#checkbox-record-selection-column) attachments to a different object. + +This option is useful for situations where you want to delete an object but keep the attached files elsewhere or in cases where unattached "orphan" files are found in the maintenance job and need to be re-attached to the correct object. + +#### Delete selected items + +This option will permanently delete one or more [selected](ay-start-form-data-tables.md#checkbox-record-selection-column) attachments from the file system and permanently remove their links to objects in the database. + +This option is useful to free up space when there are a large number of files that are no longer required to be stored. + +## Data table columns + +The data table shows all the attachments that are known to AyaNova, that is, attachments that Users have made to object, _not_ a list of files on disk. + +#### Attachment +CONTINUE HERE +#### Object + +#### Size + +#### Notes + +#### File exists [UNDER CONSTRUCTION] @@ -6,6 +70,6 @@ todo: insert note in docs (ops?) if upload won't work from a device and error not evident check in the AyaNova client error log under help-About and see if there is an error 413 related to the recent file (camera image) upload, as it's likely not AyaNova restricting but a intermediary front end setting, e.g. NGinX te about nginx somewhere or any front end when receive error 413 when attempt to upload a large attachment. - AyaNova allows up to 10gb in the upload but if there is a front end ahead of it like nginx then a setting - will need to be made to allow larger as default (for nginx) is 1m which is too small for direct from smartphone camera photo upload - setting for nginx is client_max_body_size and a value of 0 is infinite but should not be used, instead set to reasonable limit to avoid issues. +AyaNova allows up to 10gb in the upload but if there is a front end ahead of it like nginx then a setting +will need to be made to allow larger as default (for nginx) is 1m which is too small for direct from smartphone camera photo upload +setting for nginx is client_max_body_size and a value of 0 is infinite but should not be used, instead set to reasonable limit to avoid issues. diff --git a/docs/8.0/ayanova/docs/ay-start-edit-forms.md b/docs/8.0/ayanova/docs/ay-start-edit-forms.md index 41498509..55704b91 100644 --- a/docs/8.0/ayanova/docs/ay-start-edit-forms.md +++ b/docs/8.0/ayanova/docs/ay-start-edit-forms.md @@ -2,9 +2,40 @@ [Under construction] #b4beta + +#### Save + +#### Delete + +#### Report + +This menu option opens a list of [reports](ay-report.md) available to be rendered for this object type. + +#### Last report + +This menu item shows the name of the last report rendered in this form to save time in selection when the same report is regularly used. + +#### New + +#### Duplicate + +#### View on map + +(sometimes) + +#### Review + +#### History + +#### Customize + +(sometimes) + +#### Search + +#### Help + +000000000000000000000000000000000000000000000 todo: all common features of edit forms here todo: all common edit form menu options detailed here todo: all common edit form controls like wiki, attached files, etc in depth here so can link to it from each form - - - diff --git a/docs/8.0/ayanova/docs/ay-start-form-attachments.md b/docs/8.0/ayanova/docs/ay-start-form-attachments.md index dadab4b5..5d651798 100644 --- a/docs/8.0/ayanova/docs/ay-start-form-attachments.md +++ b/docs/8.0/ayanova/docs/ay-start-form-attachments.md @@ -1,7 +1,17 @@ # ATTACHMENTS -#b4beta (check if this is the user's view or the admin view, if users view it must be completed before beta) +#b4beta (this is the user's view not the admin view) + +#b4beta + +todo: insert note in docs (ops?) if upload won't work from a device and error not evident check in the AyaNova client error log under help-About and see if there is an error 413 related to the recent file (camera image) upload, as it's likely not AyaNova restricting but a intermediary front end setting, e.g. NGinX +te about nginx somewhere or any front end when receive error 413 when attempt to upload a large attachment. + AyaNova allows up to 10gb in the upload but if there is a front end ahead of it like nginx then a setting + will need to be made to allow larger as default (for nginx) is 1m which is too small for direct from smartphone camera photo upload + setting for nginx is client_max_body_size and a value of 0 is infinite but should not be used, instead set to reasonable limit to avoid issues. + + ## OVERVIEW TODO: this, see TAGS for layout \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/ay-start-form-overview.md b/docs/8.0/ayanova/docs/ay-start-form-overview.md index a0521949..6e58037b 100644 --- a/docs/8.0/ayanova/docs/ay-start-form-overview.md +++ b/docs/8.0/ayanova/docs/ay-start-form-overview.md @@ -1,4 +1,5 @@ # FORMS + [UNDER CONSTRUCTION] #b4beta (clear this for release, probably just needs a read over and remove these tags unless there really are missing items or ss would help) @@ -32,19 +33,17 @@ A blue app bar indicates the current view is in a main area of AyaNova, either a ![App bar](img/form-appbar.png) - A green app bar indicates a specific record is being edited in an edit form. ![App bar](img/form-appbar.png) - -The far left side of the App bar shows the navigation drawer "hamburger" icon which looks like three horizontal bars stacked on top of each other and is used to show or hide the [navigation drawer](#navigation-drawer) +The far left side of the App bar shows the navigation drawer "hamburger" icon which looks like three horizontal bars stacked on top of each other and is used to show or hide the [navigation drawer](#navigation-drawer) The center part of the navigation bar shows an icon and information pertaining to which record are area of AyaNova is currently open. The right side shows a bell icon which indicates if any unviewed notifications have arrived and is also a shortcut to open the user's [notifications](home-notifications.md) form to view notifications. -Finally, to the far right is the [context menu](#context-menu) which appears as three dots stacked on top of each other. On wider screen devices some commonly used context menu items will be "surfaced" between the notifcation bell icon and the context menu icon to save a click. +Finally, to the far right is the [context menu](#context-menu) which appears as three dots stacked on top of each other. On wider screen devices some commonly used context menu items will be "surfaced" between the notifcation bell icon and the context menu icon to save a click. ### Navigation drawer @@ -59,7 +58,6 @@ On larger screens the navigation drawer is displayed by default. The main View area is where the currently selected form is displayed and worked with. - ## Form context menu The context menu is located in the app bar above every form in AyaNova and looks like 3 dots stacked vertically. It is called the "context" menu because the options in it will change based on the particular form in use, the rights the currently logged in user has to make changes or the state of an object being edited. @@ -70,10 +68,11 @@ While the top options in the context menu will change depending on the context, - [Search](home-search.md) option for searching the AyaNova database - Help option for viewing help about the specific form being displayed (this manual) + +Main forms that are not related to editing a single object also have the following options: + - [About](ay-about.md) option for viewing version information and technical support information. -- [Logout]() ## Form controls AyaNova forms consist of a common set of controls which are documented in detail in the [common controls](ay-start-common-controls.md) documentation page. - diff --git a/docs/8.0/ayanova/docs/ops-config-folder-user-files.md b/docs/8.0/ayanova/docs/ops-config-folder-user-files.md index c993a925..f7e4a3b4 100644 --- a/docs/8.0/ayanova/docs/ops-config-folder-user-files.md +++ b/docs/8.0/ayanova/docs/ops-config-folder-user-files.md @@ -1,7 +1,7 @@ # ATTACHMENTS FOLDER SETTING This setting controls where AyaNova stores user uploaded files used by features that allow file attachment or uploads. -AyaNova stores these files with random names in the folder specified. +AyaNova stores these files with special names calculated from their digital signature (checksum) in a subdirectory in the folder specified. Warning: this folder MUST NOT be the same location set for [AYANOVA_BACKUP_FILES_PATH](ops-config-folder-backup-files.md) or [AYANOVA_TEMP_FILES_PATH](ops-config-folder-temporary-files.md) or AyaNova will not start.