Wolfram Language & System 11.0 (2016)|Legacy Documentation

This is documentation for an earlier version of the Wolfram Language.View current documentation (Version 11.2)

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 OptionsDetails 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 StopScheduledTask and StartScheduledTask. 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
    DeliveryFunctionNonehow to deliver the generated document
    EpilogFunctionNonefunction evaluated after document generation
    GeneratorDescriptionNonetextual description of the generator
    GeneratorHistoryLengthInfinitynumber of generated documents to archive
    GeneratorOutputType"StaticPage"type of document to generate
    NotificationFunctionAutomatichow 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.

ExamplesExamplesopen allclose all

Basic Examples  (2)Basic Examples  (2)

Create a basic document generator:

In[1]:=
Click for copyable input
Out[1]=

Trigger the generator to run synchronously using EvaluateScheduledTask:

In[2]:=
Click for copyable input
Out[2]=

Trigger the generator to run asynchronously using RunScheduledTask:

In[3]:=
Click for copyable input
Out[3]=

Delete the generator:

In[4]:=
Click for copyable input
Out[4]=

Create a parameterized document generator:

In[1]:=
Click for copyable input
Out[1]=

Trigger the generator to run synchronously:

In[2]:=
Click for copyable input
Out[2]=

Delete the generator:

In[3]:=
Click for copyable input
Out[3]=
Introduced in 2014
(10.0)
| Updated in 2015
(10.1)