Changes

Custom Field Type: Special - Web Page View

23,317 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).

* '''HTML Template''' – the body of the document combined with variables from the underlying [[~~Image:Cf19~~Entity|entity]].~~png~~The content of this field should conform to any [[Accessibility legislation]]. * '''~~Document Window – all Options enabled~~SmartFields Sample Template'''- this link adds the SmartFields HTML template. This template renders custom fields in a format that can be easily reviewed, converted to PDF and printed.{{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.* '''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:~~Cf20~~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) the filename of the file stored within the [[Multiple Files]] field will be named with the [[userid]] of the current user. See also the '''File Name''' PDF option below.~~~~*: '''Note:''' if a file with that name already exists in the [[Multiple Files]] field 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.* '''~~General Description~~Hide Instructions'''~~~~ - instructions found in custom field captions as well as the display - Instructions custom field will not appear in the exported PDF if this setting is toggled on.

A '''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''' or '''XML'''. ~~'''Field Options''' ~~{{PDFOptions}}

====PDF Page Options====* '''~~Display Order''': The order (relative~~ Fit to ~~other fields) in which this field is displayed~~* ''Page'~~Tab Name~~''~~': Displays~~ - Compresses the ~~field under a given tab~~* '''Field Name''': The name of the field, used internally content to ~~reference the user's input~~fit onto one PDF page.* '''~~[[Caption]]~~Landscape Mode'''~~: The leading question or prologue before~~ - allows the ~~field~~* '''Button Label''': Text PDF to be ~~displayed on the field's button~~ ~~'''Special Options for Field'''~~ presented in Landscape mode, as opposed to Portait mode.

====Paper Size====* '''~~HTML Template~~Letter''' – - the ~~body of the document combined with variables from the underlying [[Entity|entity]]~~standard 8.5 x 11-inch size.* '''Legal''' - 8 x 13 inches.* '''Ledger''' - 11 x 17 inches.* '''A4''' - 297 millimetres x 210 millimetres.

====Maximum Page Length====* ~~'''Value Stores To''' - when using~~ Specifies the maximum number of pages of the resultant PDF ~~or HTML '''Save~~ permitted to ~~Multiple File Field''' options (explained below) allows you to specify the default~~ be stored into a [[Multiple Files]] ~~folder~~ field if the [[Save to ~~which the PDF or HTML document will be stored on the current record, parent record or grandparent record~~Server]] setting is enabled.* '''Enforce Selection''' - makes the This includes pages attached using [[~~Multiple Files~~ssattach]] ~~custom field selected as~~ . If the ~~'''Value Stores To''' field the only field the file can~~ PDF document is too long it will not be stored to.{{HTMLOptions}}

~~'''General Options'''~~====Exported File Name====* ~~'''Allow Printing''' – enables the [[User|user]] to print the resultant document.~~* '''Allow Editing''' – enables the [[User|user]]Specify a filename 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 used.* '''Is XML''' – indicates that if the ~~document is to be prepared as an '''XML''' output.~~* '''Automatically Use User ID as File Name''' - when using the PDF or HTML '''Save user chooses 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~~export.~~::'''Note:''' if a file with that name already exists in the [[Multiple Files]] field it will be replaced with the new one, unless the '''Keep Version''' setting is enabled.~~* '''HCAI Enabled''' - * '''HCAI Automatically Redirect''' -

~~'''PDF Options'''~~==Value Storage==* '''Enable Password Protection''' – enables the [[User|user]] to [[Password|password]] protect the document (generally used when the document is going to be emailed). See [[Web Page View - Enable Password Protection]]* '''Send as Email''' – enables the [[User|user]] to send the PDF as an attachment to an email message.* '''Save to Local Disk''' – enables the [[User|user]] to save a local copy of the PDF document.* '''Save to Multiple File Field''' – enables the [[User|user]] to save the document as a PDF into any multiple file type fields in the related [[Entity|entity]].* '''Maximum PDF Page Length that can be Saved to Multiple File Field''' - 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 stored.{{ValueStoresTo}}

~~'''HTML Options'''~~* '''~~Send as Email~~Enforce Selection''' ~~– enables~~ - makes the [[~~User|user~~Multiple Files]] ~~to send the document~~ custom field selected as the ~~body of an email message.~~* '''~~Save to Local Disk~~Value Storage''' ~~– enables~~ field the ~~[[User|user]] to save a local copy of~~ only field the ~~HTML document.~~* '''Save to Multiple File Field''' – enables the [[User|user]] file can be stored to ~~save the document as a HTML document into any multiple file type fields in the related [[Entity|entity]]~~.

~~'''Services'''~~

* '''Enable Map Service'''

==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:

<unowiki>~~'''[[Role Field Permissions|Role~~ ~~'''[[Status Field Permissions|Status - Field Permissions]]'''~~</unowiki> * ''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.~~

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

~~~~'''~~Logic~~Hyperlink to Web Page View'''~~~~You can create a link to a web page view field using the following syntax:

~~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~~href="@''wpv''.~~SmartSimple logic follows the following template:  ~~the name of the Web Page View field.

~~See [[SSlogic|here]] for further details~~==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''' ~~==See Also==* [[SmartField View]]* [[Accessibility legislation]]

* [[Web Page View Field]]

* [[Web Page View Field Variables]]

* [[Updateable Web Page View Fields]]

* [[Changing the Status from a Web Page View]]

* [[~~SSlogic~~sslogic]]

* [[sscalculation]]

* [[:Category:PDF|PDFCategory]]* [[PDF Writer Custom Tags]]* [[Adding JavaScript JS files to Web Page View Pages]]* [[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

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools