Attach a PDF to a Web Page View

From SmartWiki
Revision as of 15:13, 17 May 2010 by Cameron (talk | contribs)

Jump to: navigation, search

You can use the ssattach function to append one or more PDF documents stored in either a Single File Field or Smart Folder to a Web Page View Field.


Note: The attached PDF file(s) will not be visible when viewing the web page in HTML mode, but will be appended when exported as a PDF, saved as a PDF, emailed as PDF or created by a Workflow as attachment.

Syntax

To attach a PDF file to the beginning or the end of the Web Page View:

<!--@ssattach(position;pdf file location)-->


To attach a PDF file to a defined page location within the Web Page View:

<!--@ssattach(insert;pdf file location;page number)-->


To control the format settings of the PDF generated by the Web Page View use the following syntax:

<!--@ssattach(setting;pdf file location)-->


Where:

  • position is either before, after or insert.
  • page number is the page at which the file should be inserted into the PDF document.
Note: The page number is only specified when using insert as the position.
  • pdf file location is:
File Source Syntax Comments
Smart Folder /files/folder1/folder2/File_Name.pdf To obtain select View URL from the File Options combo box next to the relevant file in the Smart Folder.

The first part of the URL should be omitted: the location specified should begin with "/files/..." as in the examples below.

Single File Custom Field @Custom Field Name.value@
Multiple Files Custom Field @Custom Field Name.files@ All PDF files stored in field will be attached.


Notes:

  • Single or Multiple file fields on parent/grandparent levels can also be included using:
  • @parent.Custom Field Name.value@, @parent.parent.Custom Field Name.files@, etc.
  • The page number is only specified when using insert as the position.
  • When using setting the PDF file will not be attached. The PDF file referenced should be a blank one-page pdf file which has the format settings you wish your PDF document to have. These are normally stored in a Smart Folder.

Examples

<!--@ssattach(before;/files/1234/123/myfile.pdf )-->



<!--@ssattach(after;/files/1234/123/myfile.pdf )-->



<!--@ssattach(before;@AttachPDFFile.value@)-->
  • Note: Don't forget to include .value


<!--@ssattach(insert;@AttachManyPDFFiles.files@;4)-->
  • Note: Don't forget to include .files


[#(?object=contact;)<!--@ssattach(after;$?opr_123456.value$)-->#]

Where 123456 is the Custom Field ID


  • You can also control the format settings of the PDF that is output by using the following syntax. The PDF file referenced should be a blank one-page pdf file which has the format settings you wish your PDF document to have. The Web Page View will be inserted onto this template:
<!--@ssattach(setting;/files/1234/123/myfile.pdf)-->


Additional Information

  • The ssattach function can be placed anywhere inside the Web Page View Field
  • All PDF page settings will driven by the first PDF document file, whether it is a static file or one generated by SmartSimple
  • Multiple PDF files can be attached from different sources by using multiple ssattach statements:
<!--@ssattach(before;/files/1234/123/myfileheader.pdf )-->
<!--@ssattach(after;/files/1234/123/myfilefooter.pdf )-->
<!--@ssattach(after;/files/1234/123/myfileappendix.pdf )-->
<html><body>
  My Pdf file
</body></html>
  • sslogic can be used if the PDF file(s) to be attached needs to be varied using conditional statements:
<!--@sslogic('@type@'='contact')-->
       <!--@ssattach(after;@parent.contract.value@)-->
<!--@else-->
     <!--@ssattach(after;@parent.othercontract.value@)-->
<!--@end-->


See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Attach_a_PDF_to_a_Web_Page_View&oldid=9777’