This commit is contained in:
2
.vscode/launch.json
vendored
2
.vscode/launch.json
vendored
@@ -48,7 +48,7 @@
|
||||
"AYANOVA_DATA_PATH": "c:\\temp\\ravendata",
|
||||
"AYANOVA_USE_URLS": "http://*:7575;",
|
||||
//"AYANOVA_PERMANENTLY_ERASE_DATABASE":"true",
|
||||
"AYANOVA_SERVER_TEST_MODE": "true",
|
||||
"AYANOVA_SERVER_TEST_MODE": "false",
|
||||
//"AYANOVA_REPORT_RENDERING_TIMEOUT":"1",
|
||||
"AYANOVA_SERVER_TEST_MODE_SEEDLEVEL": "small",
|
||||
"AYANOVA_BACKUP_PG_DUMP_PATH": "C:\\data\\code\\postgres_14\\bin\\"
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
# EVENT LOG
|
||||
|
||||
#b4beta
|
||||
|
||||
todo: overview, how to access it, what is tracked and when etc
|
||||
@@ -1,25 +1,89 @@
|
||||
# ATTACHMENTS
|
||||
# Attachments
|
||||
|
||||
The attachments feature of AyaNova allows users to store and retreive files linked to specific AyaNova business objects from their [edit form](ay-start-edit-forms.md)
|
||||
|
||||
#b4beta (this is the user's view not the admin view)
|
||||
This feature can be [turned off](ay-customize.md/#hiding-showing-fields) in each form so if you do not see an Attachments control it may be disabled.
|
||||
|
||||
#b4beta
|
||||
## Authorization Roles required
|
||||
|
||||
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.
|
||||
Attachments are available to User's with rights to edit the business object being edited.
|
||||
|
||||
[UNDER CONSTRUCTION]
|
||||
## How attachments work
|
||||
|
||||
#b4beta
|
||||
Attachments are stored at the AyaNova server in a folder and a database entry is made to link them to the object they are attached to.
|
||||
|
||||
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.
|
||||
An attachment is _not_ a part of the normal [edit form](ay-start-edit-forms.md) saving editing process; it is stored completely separately so modifying attachments has no effect on the state of the object open in the edit form. In other words if you add an attachment you do not need to save the entire form.
|
||||
|
||||
## OVERVIEW
|
||||
TODO: this, see TAGS for layout
|
||||
When a business object with attachments is deleted in AyaNova, **all** it's attachments are also deleted with it. If you want to save attachments before deleting an object they can be either downloaded then re-uploaded or [directly modified](ad-attachments.md) to a different object by someone with administrator level access.
|
||||
|
||||
More information about how attachments are processed at the server can be found in the [administrator attachments guide](ad-attachments.md).
|
||||
|
||||
AyaNova has a hard limit of 10gb per attachment but depending on the device / browser and any intermediate web server software between AyaNova and the user there could be further limitations.
|
||||
|
||||
There are two panes in the attachment control, the left most pane shows the list of attached files (if any) and has a folder icon.
|
||||
|
||||
The right most pane is the upload control and has a paperclip icon.
|
||||
|
||||
## How to access attachments
|
||||
|
||||
Attachments are available from the attachments button near the bottom of [edit forms](ay-start-edit-forms.md):
|
||||

|
||||
|
||||
In the image above the attachments button is showing in "closed" mode and the eye icon indicates clicking on it will open it for viewing:
|
||||
|
||||

|
||||
|
||||
In the above image you can see there are currently two files already attached to this object.
|
||||
|
||||
## How to store an attachment
|
||||
|
||||
### Drag and drop
|
||||
|
||||
One or more files can be dragged and dropped into the file list area of the attachment:
|
||||
|
||||

|
||||
|
||||
When the file is dragged to the correct location a green dashed box will outline the drop area. Dropping a file will immediately upload it to the server and this is the fastest way to attach a file, however if any notes need to be added they have to be done after the file is attached by editing it.
|
||||
|
||||
### Upload
|
||||
|
||||
The upload panel of the attachment control can be used to select a file set notes and upload it by clicking in the upload control to open the file chooser:
|
||||
|
||||

|
||||
|
||||
Clicking in the "Attach file" area above the notes text box will open an operating system file chooser to select a file for attaching. Once a file is selected it's name will appear in the Attach file area and clicking on Upload will store it at the server. Note that multiple files can be selected here.
|
||||
|
||||
You can also enter some notes about the file before uploading it or open the file record for editing later after it's uploaded if the notes need to be changed.
|
||||
|
||||
### Uploading directly from a device camera
|
||||
|
||||
When you click on the Attach file area to open the device file chooser, devices with a camera such as a smart phone may offer options beyond choosing a file to include the camera or video options.
|
||||
|
||||
For example on an Android phone:
|
||||

|
||||
|
||||
If you were to choose "Camera" the device's camera would open and allow you to take a picture and accept it with the checkmark button Android displays beneath the photo; the photo's file name would appear in the AyaNova upload control ready to be uploaded by clicking on the Upload button. Note that each brand, model and operating system level of each device will have it's own particular options depending upon what is available and the camera / video / microphone access rights given to the browser in the device.
|
||||
|
||||
## How to edit and delete attachments
|
||||
|
||||
In the attachment file list to the right side is an edit icon, clicking on it will open the edit dialog for that attachment:
|
||||
|
||||

|
||||
|
||||
Here you can edit the notes, change the file name or delete the attachment permanently.
|
||||
|
||||
## Potential issues
|
||||
|
||||
### Upload appears to do nothing
|
||||
|
||||
#### Permission problem
|
||||
|
||||
Most devices are restrictive about what parts of the hardware they allow applications to access and AyaNova uses the web browser itself so if the web browser has not been given access to the camera you won't see it as an option. In many cases you can see what permissions are allowed for a browser / site from the url bar in many browsers by clicking on the site security icons presented to the side of the URL, however consult your device documentation to determine how to check and set this permission.
|
||||
|
||||
#### (Request Entity Too Large) 413 error
|
||||
|
||||
If an upload won't work from a device and no error is displayed, check in the AyaNova [web app diagnostic log](ay-log.md) and see if there is an error 413 related to the recent upload attempt.
|
||||
|
||||
If you see this error in the log it's likely not AyaNova restricting the upload but intermediary web server software between AyaNova and the User such as nginx or IIS. Check with your IT support to determine if an adjustment needs to be made to allow larger files. Many intermediate servers will have very low file sizes allowed in their default configuration, for nginx the default client_max_body_size setting is 1mb.
|
||||
|
||||
Web browsers are not good at handling and displaying this error which is why the log needs to be checked as internally AyaNova will track and log communication errors.
|
||||
|
||||
BIN
docs/8.0/ayanova/docs/img/control-attachment-android-chooser.png
Normal file
BIN
docs/8.0/ayanova/docs/img/control-attachment-android-chooser.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
BIN
docs/8.0/ayanova/docs/img/control-attachment-closed.png
Normal file
BIN
docs/8.0/ayanova/docs/img/control-attachment-closed.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.0 KiB |
BIN
docs/8.0/ayanova/docs/img/control-attachment-drop.png
Normal file
BIN
docs/8.0/ayanova/docs/img/control-attachment-drop.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 39 KiB |
BIN
docs/8.0/ayanova/docs/img/control-attachment-edit.png
Normal file
BIN
docs/8.0/ayanova/docs/img/control-attachment-edit.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
docs/8.0/ayanova/docs/img/control-attachment-open.png
Normal file
BIN
docs/8.0/ayanova/docs/img/control-attachment-open.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
docs/8.0/ayanova/docs/img/control-attachment-upload.png
Normal file
BIN
docs/8.0/ayanova/docs/img/control-attachment-upload.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.7 KiB |
@@ -34,7 +34,6 @@ nav:
|
||||
- 'Wiki': 'ay-start-form-wiki.md'
|
||||
- 'Custom fields': 'ay-customize#custom-fields'
|
||||
- 'Attachments': 'ay-start-form-attachments.md'
|
||||
- 'Event log': 'ay-start-event-log.md'
|
||||
- Home:
|
||||
- 'Dashboard': 'home-dashboard.md'
|
||||
- 'Search': 'home-search.md'
|
||||
|
||||
Reference in New Issue
Block a user