Difference between revisions of "Custom Field Type: Special - Web Page View"

Revision as of 14:16, 4 May 2009

Field Display

Field View

Document Window – all Options enabled

General Description

A Web Page View field is used to create a “document” based on underlying entity data. The field type has a wide variety 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 to reference the user's input
• Caption: The leading question or prologue before the field
• Button Label: Text to be displayed on the field's button

Special Options for Field

• HTML Template – the body of the document combined with variables from the underlying entity

General Options

• Allow Printing – enables the user to print the resultant document.
• Allow Editing – enables the userto edit the document with the HTML Editor
• Allow New Window – displays the document in a new window so the browser’s print function can be used.
• Is XML – indicates that the document is to be prepared as an XML output.

PDF Options

• Enable Password Protection – enables the user to password protect the document (generally used when the document is going to be emailed).
• Send as Email – enables the user to send the PDF as an attachment to an email message.
• Save to Multiple File Field – enables the user to save the document as a PDF into any multiple file type fields in the related entity.
• Save to Local Disk – enables the user to save a local copy of the PDF document.

HTML Options

• Send as Email – enables the user to send the document as the body of an email message.
• Save to Multiple File Field – enables the user to save the document as a HTML document into any multiple file type fields in the related entity.
• Save to Local Disk – enables the user to save a local copy of the HTML document.

Services

• Enable Map Service: displays the map icon next to the field name that will launch the user’s selected map service and display a map of the content of the field
• Enable People Search Service: displays the search Internet icon next to 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 to the field name that will launch a variety of search services and display the organisations details from those services

Value Stores To

• Custom Field: Enables linking two different custom fields to the same user data

Role - Field Permissions

These fields allow you to control who is allowed and who is denied viewing and/or modifying the field.

Logic

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:
<!--@sslogic(CONDITION)-->
The content to be displayed when condition is true
<!--@end-->

Condition is replaced with the logical condition that your case calls for. The following code sample will display a Christmas tree image if and only if it is currently December:
<!--@sslogic(month(now())=12)-->
<img src='images/xmasstree.jpg'>
<!--@end-->

Note that the content to be displayed (the middle line) can either be in plaintext or in HTML.

Often, you will want to display one of two texts--one text in the case that a condition is met and another in the case that the condition is not met. This is achieved through the use of an "else" operator. The following sample code will display one message if a user is male and another if the user is female:
<!--@sslogic('@sex@'='M')-->
You are a guy.
<!--@else-->
You are a girl.
<!--@end-->

SEE ALSO
Web Page View Field
Web Page View Field Variables