<u>'''Field Display'''</u> ==General Description==Stores a single file into a single field. This field type is used to store a single uploaded document.
==Field Illustrated==[[Image:Cf27Cf_sf_ex2.png]] <u>'''General Description'''</u>
Stores a single file into a single field. This field type is used to store a single uploaded document. ==Field Options== All common options:<br />[[Custom Fields - General Information #General_Settings|General Settings]]<ubr />'''[[Custom Fields - General Information #Role Field Permissions and Status Field Permissions|Permissions & Availability]]<br />[[Custom Fields - General Information #Classic Options'''|Classic Options]]<br /u> For further information, please refer to [[Custom Fields – General Information]].<br /><br />Options listed below are specific to this particular field type.
* '''Allow Empty''': N/A* '''Default Text''': N/A* '''Options''': N/A* '''Track Changes''': Yes* '''Store To Value''': Yes <u>'''Special Options for Field'''</u> {{SecurityOptions}}
'''File Index''' – enables file indexing and full text searching using the Lucene full text search engine that is built into [[SmartSimple]]. <u>'''Field Validation'''</u> {{EnableOnlineEditing}}
* '''Type''': N/A* '''JavaScript Validation''': N/A* '''Message''': N/A{{RealTimeVirusScan}}* '''HTML Tag''': N/A <u>'''Field Formatting Other Options'''</u>
* '''HeightFile Indexing''' – enable file indexing and full text searching using the Lucene full text search engine, which is built into [[SmartSimple]].* '''Create Optimized Image Version''': N/A 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.* '''MeasureEnable Annotation''': – allows users to add [[PDF Annotation|annotations]] to uploaded PDF documents from within the SmartSimple system.* '''DefaultDisable Email Button''':- Removes the ability of users to e-mail the file directly from within [[SmartSimple]].* '''WidthDisable Delete''': N/A – 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'Measure''* ': ''Enable Excel Parsing'Default''- parse an uploaded Excel file and populate mapped fields based on the file':s content.* {{FileTypeRestriction}}* '''Number FormatFile Name Restriction''': N/A- Allows you to enforce a file naming convention on files uploaded to SmartSimple. See the [[File Name Restriction]] page for more information.* '''StyleMaximum File Size''': Yes- drop-down with options to allow a limit on the file upload size* '''Tool TipWorkflow on Upload''': Yes - Allows you to define a [[Workflow]] that will be triggered whenever a file is uploaded to this field.
<u!--<span class="mceNonEditable template" id="bs_template:@@@TPL17@@@" data-bs-name="FileSizeUpload" data-bs-type="template" data-bs-id="17"><span class="mceNonEditable template" id="bs_template:@@@TPL12@@@" data-bs-name=" FileSizeUpload" data-bs-type="template" data-bs-id="12">'''<span class="mceNonEditable template" id="bs_template:@@@TPL7@@@" data-bs-name=" FileSizeUpload" data-bs-type="template" data-bs-id="7">{{ FileSizeUpload }}</span></span></span>-->==Special Field Options=====[[Indexing Multiple and Single File Fields]]'''</u> ===
The '''Link Multiple File Field''' and the '''Link Single File Field''' 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:
1. Locate and edit the [[Custom Field]].
2* The '''indexing''' function takes place when the file is first uploaded so if you decide to index a 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 '''Save''' button.# Click the '''File Index''' button in the action bar. # 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 '''Save''' button.# Click the '''File Index''' button in the action bar.# Click the option button '''Remove index from all files in this field now!'''# Click the '''Save''' button. ===[[Display Additional File Attributes for PDF Documents]]===* If the '''Single File''' field is going to store a PDF file, you can also create a [[Custom Field Type: Read Only – System Variables|Read Only - System Variables]] field to display additional attributes about the file (called Meta Data).* The additional attributes that can be extracted and displayed are: author, creator, producer, keywords, subject, title, number of pages, creation date and modified date.* See [[Display Additional File Attributes for PDF Documents]] for details on how this is accomplished. <!--===[[Online File Editing|Online Editing]]===* When enabled an '''edit''' button will appear next to the document stored in this field that will allow users to edit the document online. When the changes are saved the updated document will automatically be saved back into this field. (''Note: documents with special characters such as apostrophes in the file name may not be editable'') * If a file is being edited by one user it will be shown as checked out to prevent other users from trying to edit it at the same time.* With online editing enabled::[[Image:SFFEdit.png]]* File checked out by another user::[[Image:SFFOut.png]]* Global Administrators also have the ability to force a document to be checked back in, in case a user does not check it back in.:[[Image:SFFUndo.png]]See also: [[Online File Editing]].-->===Emailing Document===* The document stored within this file can be E-mailed from within [[SmartSimple]] by clicking the '''Lookup...''' button (which may have been re-labelled with the Button Label option described above) and then clicking '''Email'''. ==Variables==The following extensions can be used with Single File fields: * '''.value''': the path (URL) of the file* '''.filename''': lists the name of the file (including extension such as .pdf, .doc etc)* '''.numOfpages''': if a PDF file is stored in the field the number of pages in the PDF document will be displayed.* '''.uploadlink''': the URL that can be used to upload a file to the field.
3. Click the '''Save''' button.===Examples===Show number of pages:
4. Click the '''File Index''' tab @Contract Document.numOfpages@
5. Click the option button '''Re-index all files in this field now!'''Upload file function using hyperlink:
6. Click the '''Save''' button. <ua href="@Additional Files.uploadlink@" target="_blank">'''Disabling a File Index'''Click Here to upload</ua> If you wish to disable the '''File Index''' Upload file function and no longer make attached files searchable use the following stepsas a button: 1. Locate and edit the [[Custom Field]].<input class="Button" type="button" value="Upload File" />
2. DeCalculate the length of the uploaded filename (for use in validation, will work for non-select the '''File Index''' check boxPDF file types, will return 0 if no file uploaded).
3. Click the '''Save''' button<pre><!--@sscalculation(length("@Budget Upload.filename@"))--></pre>
4. Click the '''File Index''' tab.
5. Click ==Notes==* Commas in the option button '''Remove index from all file names of uploaded files in this field now!'''will be replaced automatically with underscore characters ("_"). This is to prevent errors with JavaScript execution.
6. Click the '''Save''' button.
'''[[Display Additional File Attributes for PDF Documents]]'''
* If the '''Single File''' field is going to store a PDF file, you can also create a [[Custom Field Type (109): Read Only – System Variables|Read Only - System Variables]] field to display additional attributes about the file (called Meta Data).
* See [[Display Additional File Attributes for PDF Documents]] for details on how this is accomplished.
==See Also==
* [[:Category:PDF]]
* [[Indexing Multiple and Single File Fields]]
* [[Validating File Attributes]]
* [[Custom Field Type: Link – Multiple Files]]
{{CustomFieldPageFooter}}[[Category:Custom FieldsFiles]]
