Downloading Generated Documents: Difference between revisions

From 3B Knowledge
Jump to navigation Jump to search
(Created page with "== Intro == Downloading a generated document refers to the action where a document is "Downloaded" once it is generated using the "Download" button. == Action == The action of downloading generated documents is available both within normal mode and preview mode. thumb|Generated Document from template "download" button * Within normal mode (a.k.a. when the template has been distributed), requesting to download the docu...")
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
Downloading a generated document refers to the action where a document is "Downloaded" once it is generated using the "Download" button.
Downloading a generated document refers to the action where a document is "Downloaded" once it is generated using the "Download" button.


== Action ==
== Download Action ==
The action of downloading generated documents is available both within normal mode and [[Template Previews|preview mode]].  
[[File:Download Button.png|thumb|Generated Document from template "download" button]]The action of downloading generated documents is available both within normal mode and [[Template Document Publisher|preview mode]]. [[File:Document Trace flags.png|thumb|Document Trace flags showing that the document has been downloaded successfully]]
[[File:Download Button.png|thumb|Generated Document from template "download" button]]
 
* Within normal mode (a.k.a. when the template has been distributed), requesting to download the document will result in the related session [[Document Traces|document trace]] to be updated with the "Document Downloaded" flag and a copy of what was downloaded will be saved in the Files section of the document trace
* Within normal mode (a.k.a. when the template has been distributed), requesting to download the document will result in the related session [[Document Traces|document trace]] to be updated with the "Document Downloaded" flag and a copy of what was downloaded will be saved in the Files section of the document trace


* Within preview mode, when the document is downloaded, no document trace will be available and the document will not be saved in the system[[File:Document Trace flags.png|thumb|Document Trace flags showing that the document has been downloaded successfully]]
* Within preview mode, when the document is downloaded, no document trace will be available and the document will not be saved in the system


== Important Notes ==
== Considerations ==


* When a document is "Downloaded", we will create two files against the document trace - Document.HTML and Document.PDF. Do not delete these files as they give us important audit information about the downloaded document
* When a document is "Downloaded", we will create two files against the document trace - Document.HTML and Document.PDF. Do not delete these files as they give us important audit information about the downloaded document
* A user can select the format in which a document should be downloaded, however we will always retain the HTML version of the generated document against the document trace record
* A downloaded document may not look 1:1 alike with the generated document on screen.
* For pixel perfect PDFs & HTML, please refer to using [[Custom Styling Templates & Documents|Template Styles]] for adding custom CSS


[[Category:3B Docs]]
[[Category:3B Docs]]

Latest revision as of 09:14, 6 October 2022

Intro

Downloading a generated document refers to the action where a document is "Downloaded" once it is generated using the "Download" button.

Download Action

Generated Document from template "download" button

The action of downloading generated documents is available both within normal mode and preview mode.

Document Trace flags showing that the document has been downloaded successfully
  • Within normal mode (a.k.a. when the template has been distributed), requesting to download the document will result in the related session document trace to be updated with the "Document Downloaded" flag and a copy of what was downloaded will be saved in the Files section of the document trace
  • Within preview mode, when the document is downloaded, no document trace will be available and the document will not be saved in the system

Considerations

  • When a document is "Downloaded", we will create two files against the document trace - Document.HTML and Document.PDF. Do not delete these files as they give us important audit information about the downloaded document
  • A user can select the format in which a document should be downloaded, however we will always retain the HTML version of the generated document against the document trace record
  • A downloaded document may not look 1:1 alike with the generated document on screen.
  • For pixel perfect PDFs & HTML, please refer to using Template Styles for adding custom CSS