Changes

Jump to: navigation, search

Custom Field Type: Upload - Multiple Files Storage

3,393 bytes added, 14:43, 4 May 2020
Field Options
<u>'''Field Display'''</u>__TOC__
[[Image:Cf25.png]] <u>'''==General Description'''</u> == Stores This custom field type stores multiple files into a single field. Files can be uploaded individually or in groups.
This field type is used to store:
* Uploaded documents.
* Documents that are created using the '''Web Page View''' type field using the '''Store to Server''' option.
 
==Field Options==
===General===
* '''Display Order''': The order (relative to other fields) in which this field is displayed
* '''Tab Name''': Displays the field under a given tab
* '''Field Name''': The name of the field, used internally to reference the user's input
* '''[[Caption]]''': The leading question or prologue before the field
* '''Track Changes''': Keeps track of changes made to this field
* Uploaded documents
* Uploaded media
* Documents that are created using the [[Web Page View]] type field using the '''Store to Server''' option.
==Field Illustrated=File Options===* '''Allow External Access''' - if there is an externally enabled report that includes files in this Multiple Files field, anyone viewing the report will be able to click on the file names listed on the report for this Multiple Files field and view the underlying files. * '''File Indexing''' – enabled file indexing and full text searching using the Lucene full text search engine, which is built into [[SmartSimple]].* '''Enable Online Editing''' - when enabled an '''edit''' button will appear next to the documents in this field that will allow you to edit the documents online. When the changes are saved the updated document will automatically be saved back into the appropriate Multiple Files field. (''NoteView Mode: documents with special characters such as apostrophes in the file name may not be editable'') See [[Online File Editing]].* '''Keep Version''' – provides for version control over documents added. When a second document with the same name is added the name will be appended with V_# (where # is the version number starting at 1). Similarly if you have enabled Online Editing above the updated version will not overwrite the original but will add one with the next appropriate version number.* '''No Deletion''' – suppress the [[User|user’s]] ability to delete any files stored in the field, and manager permission is required by the [[User|user]] to delete an '''Allow Delete Multiple Files Fields'''.* '''Allow Merging''' - allows the user to select any or all pdf documents in the field to be merged into a single document. Described [[#PDF Document Options|below]].* '''Workflow on Upload''' -
: [[Image:View-mode_cft.png]]
Edit Mode:
=: [[Image:Edit_mode_MultiFile.png]]==Field Formatting Options===* '''Sort Order''': Lists several All common options for ordering the files* '''Style''': '''Bold''', <ubr />Underline[[Custom Fields – General Information#General_Settings|General Settings]]<br /u>, ''Italic'', <font color="red">Highlight[[Custom Fields – General Information#Permissions & Availability|Permissions & Availability]]<br /font> * '''[[Tool TipCustom Fields – General Information#Classic Options|Classic Options]]''': Enter help text to be shown on mouse-over<br />* '''Read Only''': Checkbox* '''HTML Tag''': Additional attributes For further information, please refer to the field HTML tag* '''[[Visibility ConditionCustom Fields – General Information]]''': Conditions upon which the .<br /><br />Options listed below are specific to this particular field is visibletype.<br />{{SecurityOptions}}{{EnableOnlineEditing}}{{RealTimeVirusScan}}
''Other Options''
===* '''File Index''' – enabled file indexing and full text searching using the Lucene full text search engine, which is built into [[SmartSimple]].* '''Create Optimized Image Version''': If checked, a small version (thumbnail) will be created when the user uploads an image. The thumbnail image will be compressed and restricted to 1024 pixels wide. The thumbnail can be called using the syntax @fieldname.compressedlink@. This feature is intended to improve the load time of pages displaying many high resolution images.* '''Enable Annotation''' – allows users to add [[PDF Annotation|annotations]] to uploaded PDF documents from within the SmartSimple system.<!--* '''Disable Email Button''' - removes the option to email uploaded documents-->* '''Keep Version''' – provides for version control over documents added. When a second document with the same name is added the name will be appended with V_# (where # is the version number starting at 1). Similarly if you have enabled Online Editing above the updated version will not overwrite the original but will add one with the next appropriate version number.* '''Disable Delete''' – suppress the [[User|user’s]] ability to delete any files stored in the field. The '''Allow Delete Multiple Files Fields''' [[Role Field Manager Permissions|Role manager permission]] is required by the [[User|user]] to bypass this restriction.* '''Enable Merging''' - Field Permissionsallows the user to select any or all pdf documents in the field to be merged into a single document. Described [[#PDF Document Options|below]].* '''Document Console''' - Enabling the [[Document Console]]allows the user to easily preview and print the documents contained in the Multiple File field. [[File:Documentconsolefin.jpg|thumb|right|link=== |300px|Example of [[Document Console]]]]* '''Auto Convert Documents to PDF on Upload''' - Automatically converts Word Documents into PDF versions of the same document asynchronously.These * '''Enable Excel Parsing''' - parse an uploaded Excel files and populate mapped fields based on the files' content see [[Role Field PermissionsExcel_Parser|fieldsExcel Parser]] .* {{FileTypeRestriction}}* '''Maximum File Size''' - drop-down with options to allow a limit on the file upload size* '''File Name Restriction''' - Allows you to control by enforce a file naming convention to files uploaded to SmartSimple. See the [[File Name Restriction]] page for more information.* '''Workflow on Upload''' - Allows you to define a [[RoleWorkflow]] who that will be triggered whenever a file is allowed uploaded to view and/or modify the this field.{{Media Library Field Options}}
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;">The ability to delete files from Multiple File fields is granted to roles using the Allow Delete on MultiFile Fields Manager Permission.</pre>
===[[Status Field Permissions|Status - Field Permissions]]===* ''Only present within the [[Universal Tracking Application]]''These [[Status Field Permissions|fields]] allow you to control by the [[Status]] of the record whether or not the field can be viewed and/or modified.{{FileSizeUpload}}
==Special Field Options==
===[[Indexing Multiple and Single File Fields]]===
The '''Link Upload - Multiple File FieldFiles Storage''' and the '''Link Upload - Single File FieldStorage''' both support a file index feature. Using this feature provides the ability to search documents attached to the field (subject to the [[User|user]] having permission to access the field).
<u>'''File Types Supported'''</u>
 * When you add a document to this file you must make sure that the document can be indexed for searching. The following types of documents are supported: Microsoft Word and Excel, Adobe PDF, HTML and RTF files.
<u>'''Ensuring that PDF Files are searchable'''</u>
 * If using PDF you must ensure that the files are text-searchable. You can test for this functionality by opening the file with Adobe Acrobat Reader and ensuring that the '''Select Text''' tool can be used to select text from the file.
<u>'''Indexing after uploading'''</u>
 *The '''indexing''' function takes place when the file is first uploaded so if you decide to index a file file after the file is uploaded you must re-index the field. Use the following steps to index the field: 
# Locate and edit the [[Custom Field]].
# Click the '''File Index''' check box.
# Click the option button '''Re-index all files in this field now!'''
# Click the '''Save''' button.
<u>'''Disabling a File Index'''</u>
 
* If you wish to disable the '''File Index''' function and no longer make attached files searchable use the following steps:
 
# Locate and edit the [[Custom Field]].
# De-select the '''File Index''' check box.
# Click the '''File Index''' tab.
# Click the option button '''Remove index from all files in this field now!'''
# Click the '''Save''' button. <u>'''Notes'''</u> * Files can be uploaded individually or in groups.* When in '''Edit''' Mode, the following buttons will be displayed::[[Image:Cf26.png]]* To use the '''Multiple File''' feature requires the use of a Java Applet. If the [[User|user’s]] computer is not permissioned to run Java applets, then the '''Single file''' upload should be used.
===PDF Document Options===
<u>'''Allow Merging ([[:Category:PDF|PDF]] files only)'''</u>
===PDF Document Options===
<u>'''Allow Merging (PDF files only)</u>'''
* If you are using a Multiple File field to store PDF documents then you can enable a '''Merge''' button:
* When editing a record with a Multiple File field that has "Allow Merging" enabled, the '''Merge files''' button will be present:
[[Image:PDFMerge2Mergefile.PNGpng]]* Clicking the '''Merge files''' button will allow you to select which PDF documents that are already stored in the field you wish to merge into a single PDF document, as well as the sequence in which they are merged.
* The resultant document will also be stored in the Multiple File field. The original documents will not be changed.
* The order the pdf files are included in the resultant document cannot be controlled.
* This feature will provide for easier printing of "sets" of documents.
* The resultant file cannot have a space in the file name.
'''Note about Merging:''' Any PDF files that have the '''Content Copying''' or '''Content Copying or Extraction'''
security restriction in place '''cannot''' be merged.
* The settings can be viewed by opening the PDF and clicking
File > Document Properties > Security (steps may vary depending on the version of your PDF reader)
See also: [[Display Additional File Attributes for PDF Documents]]
 
<u>'''[[Display Additional File Attributes for PDF Documents|Display Additional File Attributes (PDF files only)]]'''</u>
<u>'''[[Display Additional File Attributes for PDF Documents|Display Additional File Attributes (PDF files only)]]</u>'''
* This feature allows you to display extra information (also called Meta Data) extracted from each PDF into the list view of the files stored in this field.
* This is done using the '''Extra Columns''' section:
* Please see [[Display Additional File Attributes for PDF Documents]] for details.
==Variables==
The following extensions can be used with Multiple File fields:
 
* '''.numOfPages''': the total [[PDF Page Count|number of pages in all PDF files]] stored in the field.
* '''.numOfFiles''': the number of files in the field.
 
: Example: To validate if the custom field has any uploaded files:
: ''"@level1.Link-Multiple Files custom field name.numOfFiles@">0''
* '''.uploadlink''': the URL that can be used to upload a file to the field.
* '''.value''': the filenames of the files separated by pipes (|) with file identifiers.
* '''.filenames(''separator'')''': the filenames of the files separated by the ''separator'' entered between the parentheses.
* '''.files''': the URL/path to each of the files separated by pipes (|).
 
'''NOTE''': To display a list of files in a table format with hyperlinks to the files just reference the fieldname. e.g @Annual Financial Documents@
 
Example:
Upload file function using hyperlink:
 
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;"><a href="@Additional Files.uploadlink@" target="_blank">Click Here to upload</a></pre>
 
Upload file function as a button:
 
<pre style="white-space: -o-pre-wrap; word-wrap: break-word;"><input class="Button" type="button" value="Upload Files" /></pre>
 
==HTML 5 Upload feature==
A new HTML 5 format for the file upload feature on [[Custom Field Type: Upload - Multiple Files Storage|multiple file]] fields has been implemented as of May 2013. The new uploader obviates the need for a Java applet plug-in; end users are no longer required to install anything in order to upload multiple files. Note that HTML 5 is available on the following [[browsers]]:
 
* Internet Explorer [http://windows.microsoft.com/en-IE/internet-explorer/download-ie download]: version 10.0 and higher
* Firefox [http://www.mozilla.org/ download]
* Chrome [http://www.google.com/chrome/ download] <br />
[[Image:HTML5UploadNew.png|500px]]
 
Any user that is not using one of these browsers will continue to use the file upload applet, which will require installing the Java applet plug-in.<br />
[[Image:JavaAppletUpload.png|500px]]
 
==Notes==
<!--* Use of the '''Multiple Files...''' button requires the use of a Java Applet that will be automatically installed on your PC. If the [[User|user’s]] computer does not allow installation or execution of Java applets then the '''Single file''' upload should be used.-->
* Commas in the file names of uploaded files will be replaced automatically with underscore characters ("_"). This is to prevent errors with JavaScript execution.
 
==See Also==
* [[What is the Spool Folder Setting in the Global Settings?]]
* [[Indexing Multiple and Single File Fields]]
* [[:Category:PDF]]
* [[PDF Annotation]]
* [[Validating File Attributes]]
* [[Custom Field Type: Upload - Single File Storage]]
{{CustomFieldPageFooter}}[[Category:Custom FieldsFiles]]
Smartstaff, administrator
3,370
edits

Navigation menu