Changes

Custom Field Type: Special - Web Page View

23,009 bytes added, 15:58, 26 November 2018

no edit summary

~~~~==General Description==A '''~~Field Display~~Web Page View'''~~~~ field is used to create a “document” based on underlying [[Entity|entity]] data. The field type has a wide variety of document management options associated including the conversion to '''PDF'''.

~~'''~~==Field ~~View'''~~Illustrated====Field Options==All common options: [[Custom Fields - General Information#General_Settings|General Settings]] [[Custom Fields - General Information#Permissions & Availability|Permissions & Availability]] [[Custom Fields - General Information#Classic Options|Classic Options]] For further information, please refer to [[Custom Fields – General Information]]. Options listed below are specific to this particular field type (if applicable).

~~[[Image:Cf19.png]]~~ * '''~~Document Window – all Options enabled~~HTML Template''' ~~[[Image:Cf20.png]]~~ ~~'''General Description'''~~ ~~A '''Web Page View''' field is used to create a “document” based on~~ – the body of the document combined with variables from the underlying [[Entity|entity]] ~~data~~. The ~~field type has a wide variety~~ content of ~~document management options associated including the conversion to '''PDF''' or '''XML'''.~~ ~~'''Field Options''' ~~ * '''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 should conform to ~~reference the user's input~~* '''any [[~~Caption~~Accessibility legislation]]~~''': The leading question or prologue before the field~~.* '''~~Button Label~~SmartFields Sample Template'''~~: Text~~ - this link adds the SmartFields HTML template. This template renders custom fields in a format that can be easily reviewed, converted to ~~be displayed on the field's button~~ ~~'''Special Options for Field'''~~ PDF and printed. * '''HTML Template''' – the body of the document combined with variables from the underlying [[Entity|entity]]{{CustomFieldIDs}}

===Document Options=======General Options====* '''Open in Modal Window''' - displays the document in a Modal Window.* '''Enable Printing''' – adds a print button that uses your browser's built-in print functionality to print the screen. Instead of using this setting, we suggest you use the SmartFields HTML template and enable '''Export as PDF''', followed by printing from the PDF.* '''Enable Editing''' – adds an edit button that allows the user to temporarily edit the HTML of the web page view. Any changes made are not saved.* '''~~Value Stores To~~Enable Switching Language''' - adds a Language dropdown to the modal window which allows the user to switch the language of your web page view. Language translations for custom fields will display when you change the drop down. The languages that appear in the drop down are dependent on the translations you have entered for the web page view field: [[Image:Cf-wpv-3.png|link=|150px]]* '''Render As XML Document''' – indicates that the document is to be prepared as an [[XML]] output.* '''Default User ID as File Name''' - when using the PDF or HTML '''Save to Multiple File Field''' options (explained below) ~~allows you to specify~~ the ~~default~~ filename of the file stored within the [[Multiple Files]] ~~folder to which the PDF or HTML document~~ field will be ~~stored on~~ named with the [[userid]] of the current ~~record, parent record or grandparent record~~user. See also the '''File Name''' PDF option below.* : '''~~Enforce Selection~~Note:''' ~~- makes~~ if a file with that name already exists in the [[Multiple Files]] ~~custom~~ field ~~selected as~~ it will be replaced with the new one, unless the '''Keep Version''' setting is enabled on the Multiple Files field.* '''Enable HCAI''' - See [[HCAI Overview]] for additional information.* '''HCAI Automatically Redirect''' - See [[HCAI Overview]] for additional information.* '''Enable Field Selection for SmartFields''' - select a subset of fields to appear on the Web Page View.* '''~~Value Stores To~~Hide Instructions''' - instructions found in custom field captions as well as the ~~only~~ display - Instructions custom field will not appear in the ~~file can be stored to~~exported PDF if this setting is toggled on.

~~'''General~~ ====PDF Page Options~~'''~~====* '''~~Allow Printing''' – enables the [[User|user]]~~ Fit to ~~print the resultant document.~~* Page'''~~Allow Editing''' – enables~~ - Compresses the ~~[[User|user]]~~content to ~~edit the document with the HTML Editor~~* '''Allow New Window''' – displays the document in a new window so the [[Browser|browser’s]] print function can be usedfit onto one PDF page.* '''~~Is XML''' – indicates that the document is to be prepared as an '''XML''' output.~~* '''Automatically Use User ID as File NameLandscape Mode''' - ~~when using~~ allows the PDF ~~or HTML '''Save~~ to ~~Multiple File Field''' options (explained below) the filename of the file stored within the [[Multiple Files]] field will~~ be ~~named with the [[userid]] of the current user.::'''Note:''' if a file with that name already exists~~ presented in ~~the [[Multiple Files]] field it will be replaced with the new one~~Landscape mode, ~~unless the '''Keep Version''' setting is enabled~~as opposed to Portait mode.* '''HCAI Enabled''' - * '''HCAI Automatically Redirect''' -

~~'''PDF Options'''~~====Paper Size====* '''~~Enable Password Protection~~Letter''' ~~– enables~~ - the ~~[[User|user]] to [[Password|password]] protect the document (generally used when the document is going to be emailed)~~standard 8. ~~See [[Web Page View~~ 5 x 11- ~~Enable Password Protection]]~~* '''Send as Email''' – enables the [[User|user]] to send the PDF as an attachment to an email messageinch size.* '''~~Save to Local Disk~~Legal''' ~~– enables the [[User|user]] to save a local copy of the PDF document~~- 8 x 13 inches.* '''~~Save to Multiple File Field~~Ledger''' ~~– enables the [[User|user]] to save the document as a PDF into any multiple file type fields in the related [[Entity|entity]]~~- 11 x 17 inches.* '''~~Maximum PDF Page Length that can be Saved to Multiple File Field~~A4''' - Specifies the maximum number of pages of the resultant PDF permitted to be stored into a [[Multiple Files]] field if the '''Save to Multiple File Field''' settings is enabled. This includes pages attached using [[ssattach]]. If the PDF document is too long it will not be stored297 millimetres x 210 millimetres.

~~'''HTML Options'''~~====Maximum Page Length====* ~~'''Send as Email''' – enables~~ Specifies the maximum number of pages of the resultant PDF permitted to be stored into a [[~~User|user~~Multiple Files]] ~~to send~~ field if the ~~document as the body of an email message.~~* '''[[Save to ~~Local Disk''' – enables the [[User|user~~Server]] ~~to save a local copy of the HTML document~~setting is enabled.* '''Save to Multiple File Field''' – enables the This includes pages attached using [[~~User|user~~ssattach]] ~~to save~~ . If the PDF document ~~as a HTML document into any multiple file type fields in the related [[Entity|entity]]~~is too long it will not be stored. {{HTMLOptions}}

~~'''Services'''~~ {{WordOptions}}

====Exported File Name====* ~~'''Enable Map Service''': displays the map icon next to the field name that will launch the user’s selected map service and display~~ Specify a ~~map of the content of the field~~* '''Enable People Search Service''': displays the search Internet icon next filename to be used if the ~~field name that will launch a variety of search services and display the contact details from those services~~* '''Enable Organization Search Service''': displays the search Internet icon next user chooses to ~~the field name that will launch a variety of search services and display the organisations details from those services~~export.

==Value Storage==

* '''Enforce Selection''' - makes the [[Multiple Files]] custom field selected as the '''Value Storage''' field the only field the file can be stored to.

~~'''[[Role Field Permissions|Role - Field Permissions]]'''~~

~~These [[Role Field Permissions|fields]] allow you to control by [[Role]] who is allowed to view and~~

~~'''[[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.~~

==Notes==

~~===~~'''sslogic~~===~~'''Web Page View fields can use a unique SmartSimple logic interpreter. Web page logic gives you the ability to display certain content or perform certain actions only when specified conditions are met.

SmartSimple logic follows the following template:

The content to be displayed when condition is true

</nowiki>

See [[sslogic|~~here~~SSLogic]] for further details.

~~===~~'''Hyperlink to Web Page View~~===~~'''

You can create a link to a web page view field using the following syntax:

Where '''wpv''' is the name of the Web Page View field.

==Multi-Line Text==

To include Multi-Line Text fields in a {{WPV}} you need use the following syntax to ensure that line breaks are displayed correctly when the page is converted to PDF format.

<div style="display: block; pd4ml-display: none; white-space: pre-wrap;">~Narrative~</div>

<div style="display: none; pd4ml-display: block; white-space: pre; word-wrap: break-word;">~Narrative~</div>

The first div displays correctly in the {{WPV}} and the second div displays correctly in the PDF version

==See Also==

* [[SmartField View]]

* [[Accessibility legislation]]

* [[Web Page View Field]]

* [[Web Page View Field Variables]]

* [[Using Special Characters in Web Page View]]

~~[[Category:Custom Fields]]~~{{CustomFieldPageFooter}}

← Older edit

Nancy Sabo

Smartstaff, administrator

421

edits

Changes

Custom Field Type: Special - Web Page View

SmartWiki