Wyn Enterprise: Schedule Template

As an admin at Wyn Enterprise portal, you can manage Schedule Templates. A schedule template allows you to specify a recurring interval at which to run a report. Each schedule has a name, an optional description, and a list of roles that defines which users have permission to assign reports to it.

Once you add a shared schedule, all users in each role that is granted permission to the schedule can assign reports to run on it.

To add a new template

  1. On the Admin Portal, navigate to Schedule Templates.
  2. Click Add Template.
  3. Fill out the Template properties: Template Name, Document Type - Dashboard, Report, Datasource, or Dataset, and Template Description.
  4. Click Create Template. A new template is created and displayed on the Schedule Templates page where you can edit and save its security and delivery options.

To edit a schedule template

  1. On the Admin Portal, navigate to Schedule Templates.
  2. Select a schedule template that you would like to edit. The template editor will open to the right of the page.
  3. Under Basic Information, modify the following properties of the schedule template’s basic information.
    Assign Permission - next to each role, select the checkbox for each role whose users you want to allow to schedule reports.
    Note: If you set the schedule template’s Document Type to Dataset, there is no Assign Permission option.
  4. Under Recurrence, modify the following properties of the schedule template’s recurrence options.
  5. Under Delivery, modify the following properties of the schedule template’s delivery options.
    • Delivery: select from the drop-down list one of the following options – Email, Local Storage, or File Share.
    • Export Format: select from the drop-down list one of the following options – PDF, Excel, Word, CSV, HTML, Image, or JSON.

      Note : If you set the schedule template’s Document Type to Dataset, there is no Delivery tab. If you set the schedule template’s Document Type to Dashboard, you can only use the Email delivery type option.

  6. Under Referenced Documents, modify the following properties of the schedule template’s referenced documents.
  7. When finished, click Save at the bottom of the page.

Recurrence

Set up the recurrence options as follows.

Option Description
Repeat Daily or Monthly
At Set the time for the task to start.
Every Enter the number of Hours to set the frequency of the report or dashboard execution.
Start Set the date and time for the task to start.
End Set the date and time for the task to start.
No End Date Select this if you never want your task to end.

Delivery

For Dashboard Template

Option Description
Email To Enter one or more e-mail addresses where the report is to be sent. Separate multiple e-mail addresses with commas.
Reply To Enter one or more e-mail addresses where the reply is to be sent. Separate multiple e-mail addresses with commas.
Subject Enter the text to use for the e-mail's subject line. You can use the following syntax in the subject:
  • ?ParameterName: To specify parameter values for the report in the subject. Replace ParameterName with the actual name of the parameter.
  • &ReportName: To specify the report name.
  • &ExecutionTime: To specify the execution date and time of the report.
  • Body Enter text to use in the body of the e-mail. You can use the following syntax in the e-mail body:
  • ?ParameterName: To specify parameter values for the report in the subject. Replace ParameterName with the actual name of the parameter.
  • &ReportName: To specify the report name.
  • &ExecutionTime: To specify the execution date and time of the report.
  • For Report Template

    Option Description
    Delivery Select a delivery method from Allow user to choose, Email, Local Storage, or File Share.
    (Email) Email To Enter one or more e-mail addresses where the report is to be sent. Separate multiple e-mail addresses with commas.
    (Email) Reply To Enter one or more e-mail addresses where the reply is to be sent. Separate multiple e-mail addresses with commas.
    (Email) Subject Enter the text to use for the e-mail's subject line. You can use the following syntax in the subject:
  • ?ParameterName: To specify parameter values for the report in the subject. Replace ParameterName with the actual name of the parameter.
  • &ReportName: To specify the report name.
  • &ExecutionTime: To specify the execution date and time of the report.
  • (Email) Body Enter text to use in the body of the e-mail. You can use the following syntax in the e-mail body:
  • ?ParameterName: To specify parameter values for the report in the subject. Replace ParameterName with the actual name of the parameter.
  • &ReportName: To specify the report name.
  • &ExecutionTime: To specify the execution date and time of the report.
  • (Email) Attachment Type Select from File Attachment or Download Link.
    (Email) Store forever Select from Store forever, Store until..., or Expiry Duration... to specify the storage period.
    (Email) Export Format Select Allow User to Choose to attach the report to the message in the format specified above.
    (Local Storage) Store forever Select from Store forever, Store until..., or Expiry Duration... to specify the storage period.
    (File Share) File Name Enter the name of the report file.
    (File Share) Path Enter the fully qualified UNC path of the location at which to share the report.
    Export Format Select the format to which you want to export the report. You can choose from Allow user to choose, PDF, Excel, Word, CSV, HTML, Image, JSON, or TXT.