Smartstaff, administrator
3,321
edits
Changes
→Field Options
__TOC__
==General Description==
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:
==Field Illustrated==
View Mode:
: [[Image:View-mode_cft.png]]
Edit Mode:
{{SecurityOptions}}
{{EnableOnlineEditing}}
''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 documemntsdocuments-->* Deprecated - '''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 DeletionDisable Delete''' – suppress the [[User|user’s]] ability to delete any files stored in the field. The '''Allow Delete Multiple Files Fields''' [[Manager Permissions|manager permission]] is required by the [[User|user]] to bypass this restriction.
* '''Enable 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]].
* '''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.
* '''Enable Excel Parsing''' - parse an uploaded Excel files and populate mapped fields based on the files' content see [[Excel_Parser|Excel Parser]].
* {{FileTypeRestriction}}
* '''Maximum File Size''' - drop-down with options to allow a limit on the file upload size
* '''File Name Restriction''' - Allows you to 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 [[Workflow]] that will be triggered whenever a file is uploaded to this field.
{{Media Library Field Options}}
{{CFPermissionsTabFileSizeUpload}}
==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.
===PDF Document Options===
<u>'''Allow Merging ([[:Category:PDF|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:MergefilesMergefile.png]]
* 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.
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>'''
* 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:
* '''.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''
Example:
Upload file function using hyperlink:
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; 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: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><input type="button" class="Button" onclicktype="cs=window.open('@Additional Files.uploadlink@','cs_window','toolbar=0,width=600,height=400,directories=no,status=no,scrollbars=yes,resizable=yes,menubar=no,alwaysRaised=no');cs_window.focus();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]]:
* Chrome [http://www.google.com/chrome/ download] <br />
[[Image:HTML5UploadHTML5UploadNew.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 />
* [[PDF Annotation]]
* [[Validating File Attributes]]
* [[Custom Field Type: Link – Upload - Single FileStorage]]
{{CustomFieldPageFooter}}[[Category:Files]]
