DeliveryFunction

DeliveryFunction

is an option that specifies how material such as documents generated by DocumentGenerator should be delivered.

Details

  • Possible settings for DeliveryFunction include:
  • Nonedo not deliver anything
    Automaticdeliver by email to the owner with links only
    "format"deliver by email to the owner in the specified format
    {user1,user2,}deliver by email to a list of users, giving links only
    {user1,}"format"deliver by email to specified users in the specified format
    {{user1,}"fmt1",}deliver to different users in different formats
    "chan"Automaticdeliver to the owner using the specified channel
    "chan""format"deliver in the specified format
    fdeliver by applying an arbitrary function
  • Except with DeliveryFunctionf, standard material is added to messages sent.
  • Possible channels "chan" are as used by SendMessage.
  • Typical delivery formats include:
  • "CDF"attached CDF document
    "NB"attached notebook
    "PDF"attached PDF document
    "PNG","GIF",etc.attached in other export formats
    Automaticno attachment (links only)
  • With DeliveryFunctionf, the function f is applied to an association containing the following elements:
  • "Recipients"users to be notified
    "DocumentCloudObject"cloud object containing the generated document
    "DocumentLink"link to this generated document
    "DocumentOutputType"output type of the generated document
    "DocumentPermalink"permalink to the latest document from this generator
    "GeneratorDescription"description of the document generator
    "GeneratorCloudObject"cloud object for the document generator
    "GeneratorFilename"file name for the document generator
    "GeneratorLink"link to the document generator
    "GeneratorLogLink"link to the log produced by the document generator
    "GeneratorOwner"WolframID of the document generator owner
    "StartTime"start time for generating the document
    "EndTime"end time for generating the document
    "Timing"CPU time used for generating the document
    "AbsoluteTiming"wall-clock time used for generating the document
    "NextRunTime"time of the next scheduled run
    "RemainingRuns"number of remaining runs specified
  • If the document generator is unnamed, "GeneratorFilename" is None.

Examples

Basic Examples  (1)

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

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

Trigger the generator to run asynchronously:

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

Redeploy the generator with a custom notification function:

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

Trigger the generator to run again:

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

Delete the generator:

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

See Also

NotificationFunction  SendMail  SendMessage  StringTemplate  NotebookTemplate

Introduced in 2015
(10.1)