WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

DocumentGenerator
✖
DocumentGenerator

✖
DocumentGenerator[template,timespec]

represents a document generator with template template to be evaluated on the schedule defined by timespec.

✖
DocumentGenerator[template,driver,timespec]

takes parameters for filling the template from driver.

Details and Options

  • CloudDeploy[DocumentGenerator[…]] sets up a document generator in the cloud. The generator periodically applies template, logs the results of the generation process, archives the generated document, and delivers it to any specified recipients.
  • Document generators can be controlled using functions applicable to scheduled tasks, like TaskSuspend and TaskResume. timespec follows the ScheduledTask specification and may be None.
  • The argument template can be a TemplateObject, notebook or template notebook, or a specification of the form File[…] or CloudObject[…] that contains any of these constructs.
  • The argument driver can be an Association, a pure function or a Wolfram Language script evaluating to an Association, a notebook setting the value of $CurrentBinding, or a CloudObject or File that contains any of these constructs.
  • If template contains template elements, the elements are filled from driver, or from template defaults if driver is not present.
  • Cloud objects and files are copied and bundled with the generator when the generator is deployed, unless the specified resources are qualified as Delayed. Delayed resources are used in place.
  • The following options can be given:
  • AutoRemoveFalseremove generator after last scheduled run
    DeliveryFunction Nonehow to deliver the generated document
    EpilogFunctionNonefunction evaluated after document generation
    GeneratorDescriptionNonetextual description of the generator
    GeneratorHistoryLength3number of generated documents to archive
    GeneratorOutputType"StaticPage"type of document to generate
    NotificationFunction Automatichow to provide status notifications
    PermissionsAutomaticpermissions settings for generated documents
    TimeZoneAutomatictime zone for scheduling
  • EpilogFunction may be a pure function, notebook, CloudObject, or File.
  • Common settings for GeneratorOutputType include:
  • "StaticPage"deployed web page
    "CDF"notebook served for download
    "PDF"PDF document
    "CloudCDF"cloud notebook
  • Note that the choice of output type places no restriction on delivery formats specified in DeliveryFunction.
  • In the cloud, the precise times at which documents are generated are typically determined by load-balancing requirements.
  • The minimum time between generator executions in the cloud is determined by cloud configuration and policies, and will typically be a certain fraction of an hour.

Examples

open allclose all

Basic Examples  (2)Summary of the most common use cases

Create a basic document generator:

In[1]:=1
✖
https://wolfram.com/xid/0pu0fybst6-2a8f14
Out[1]=1

Trigger the generator to run asynchronously using TaskExecute:

In[2]:=2
✖
https://wolfram.com/xid/0pu0fybst6-t8vw15
Out[2]=2

Delete the generator:

In[3]:=3
✖
https://wolfram.com/xid/0pu0fybst6-6frskm
Out[3]=3

Create a parameterized document generator:

In[1]:=1
✖
https://wolfram.com/xid/0pu0fybst6-6vzt84
Out[1]=1

Trigger the generator to run asynchronously:

In[2]:=2
✖
https://wolfram.com/xid/0pu0fybst6-kq6l7u
Out[2]=2

Delete the generator:

In[3]:=3
✖
https://wolfram.com/xid/0pu0fybst6-my2yhk
Out[3]=3

Generalizations & Extensions  (1)Generalized and extended use cases

Use scheduled task functions to control document generator scheduling and execution:

In[1]:=1
✖
https://wolfram.com/xid/0pu0fybst6-x0x6o7
Out[1]=1

Halt scheduled executions:

In[2]:=2
✖
https://wolfram.com/xid/0pu0fybst6-20sbnn
Out[2]=2

Resume scheduled executions:

In[3]:=3
✖
https://wolfram.com/xid/0pu0fybst6-jifdsy
Out[3]=3

Delete the generator:

In[4]:=4
✖
https://wolfram.com/xid/0pu0fybst6-s8c7vn
Out[4]=4

Options  (2)Common values & functionality for each option

DeliveryFunction  (1)

Deploy a generator that emails its creator a PDF of the generated document:

In[1]:=1
✖
https://wolfram.com/xid/0pu0fybst6-05ldma
Out[1]=1

Trigger the generator to run asynchronously:

In[2]:=2
✖
https://wolfram.com/xid/0pu0fybst6-86t7r6
Out[2]=2

Delete the generator:

In[3]:=3
✖
https://wolfram.com/xid/0pu0fybst6-luxrlb
Out[3]=3

NotificationFunction  (1)

Notifications allow indicated parties to receive status messages on task evaluation. Deploy a generator that notifies multiple parties, but has no recipients:

In[1]:=1
✖
https://wolfram.com/xid/0pu0fybst6-3jrt91
Out[1]=1

Trigger the generator to run asynchronously:

In[2]:=2
✖
https://wolfram.com/xid/0pu0fybst6-s105qt
Out[2]=2

Delete the generator:

In[3]:=3
✖
https://wolfram.com/xid/0pu0fybst6-d02hbe
Out[3]=3

Applications  (1)Sample problems that can be solved with this function

Create a daily report of quiz scores. Simulate scores by sampling them from a NormalDistribution:

In[1]:=1
✖
https://wolfram.com/xid/0pu0fybst6-mbc3jc

Deploy a generator that evaluates three times a week at 17:00 and compiles a report on the day's scores:

In[2]:=2
✖
https://wolfram.com/xid/0pu0fybst6-vzhypv
Out[2]=2

Trigger the generator to run synchronously:

In[3]:=3
✖
https://wolfram.com/xid/0pu0fybst6-y6fy0b
Out[3]=3

Delete the generator:

In[4]:=4
✖
https://wolfram.com/xid/0pu0fybst6-b9z5rb
Out[4]=4

Possible Issues  (1)Common pitfalls and unexpected behavior

Qualifying a local File resource as Delayed results in a deployment error, since the resource will not be available in the cloud at evaluation time:

In[1]:=1
✖
https://wolfram.com/xid/0pu0fybst6-le5als
Out[1]=1

Neat Examples  (1)Surprising or curious use cases

Create a document generator that produces a daily report on the performance over the past days of the trucking industry stocks with the highest trading volumes on the previous day:

In[1]:=1
✖
https://wolfram.com/xid/0pu0fybst6-5xvnze
Out[1]=1

The generation time for this report will typically exceed the time limit for synchronous evaluations. Trigger the generator to run asynchronously:

In[2]:=2
✖
https://wolfram.com/xid/0pu0fybst6-8cirfr
Out[2]=2

Once the report is completed, output may be viewed at this cloud object:

In[3]:=3
✖
https://wolfram.com/xid/0pu0fybst6-j8uwd8
Out[3]=3

Delete the generator:

In[4]:=4
✖
https://wolfram.com/xid/0pu0fybst6-1iazvg
Out[4]=4
Wolfram Research (2014), DocumentGenerator, Wolfram Language function, https://reference.wolfram.com/language/ref/DocumentGenerator.html (updated 2017).
✖
Wolfram Research (2014), DocumentGenerator, Wolfram Language function, https://reference.wolfram.com/language/ref/DocumentGenerator.html (updated 2017).

Text

Wolfram Research (2014), DocumentGenerator, Wolfram Language function, https://reference.wolfram.com/language/ref/DocumentGenerator.html (updated 2017).

✖
Wolfram Research (2014), DocumentGenerator, Wolfram Language function, https://reference.wolfram.com/language/ref/DocumentGenerator.html (updated 2017).

CMS

Wolfram Language. 2014. "DocumentGenerator." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2017. https://reference.wolfram.com/language/ref/DocumentGenerator.html.

✖
Wolfram Language. 2014. "DocumentGenerator." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2017. https://reference.wolfram.com/language/ref/DocumentGenerator.html.

APA

Wolfram Language. (2014). DocumentGenerator. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/DocumentGenerator.html

✖
Wolfram Language. (2014). DocumentGenerator. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/DocumentGenerator.html

BibTeX

@misc{reference.wolfram_2025_documentgenerator, author="Wolfram Research", title="{DocumentGenerator}", year="2017", howpublished="\url{https://reference.wolfram.com/language/ref/DocumentGenerator.html}", note=[Accessed: 18-May-2025 ]}

✖
@misc{reference.wolfram_2025_documentgenerator, author="Wolfram Research", title="{DocumentGenerator}", year="2017", howpublished="\url{https://reference.wolfram.com/language/ref/DocumentGenerator.html}", note=[Accessed: 18-May-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_documentgenerator, organization={Wolfram Research}, title={DocumentGenerator}, year={2017}, url={https://reference.wolfram.com/language/ref/DocumentGenerator.html}, note=[Accessed: 18-May-2025 ]}

✖
@online{reference.wolfram_2025_documentgenerator, organization={Wolfram Research}, title={DocumentGenerator}, year={2017}, url={https://reference.wolfram.com/language/ref/DocumentGenerator.html}, note=[Accessed: 18-May-2025 ]}