Wyn Enterprise User Guide

Wyn Enterprise: Create a Scheduled Task to Run a Dashboard

Once you create a scheduled task in Wyn Enterprise, the run result of the dashboard is automatically generated at the specified time or interval. You can share the result to the designated email address in the form of a link.

In Wyn Enterprise, a scheduled task can be set to manual, one-time, or scheduled depending on your requirements. For each execution mode, there is a different set of fields that should be specified for a scheduled task to run successfully. For more details, please have a look at the below sections.

Task Execution Modes

The below section describes the fields available for the different task execution modes supported in Wyn Enterprise - manual, one-time, and scheduled.

Manual Task Execution Mode

For the manual execution mode, you need to specify the following fields in the Info panel.

Property Description
Details Enter a description for the task.
Execution Choose the execution mode for the task. In this case, set it to 'Manual'.
Parameters Input valid parameter value(s) for the dashboard if any.
Delivery Specify the recipient's email address, the reply-to email address where the recipient can respond, the subject line, and the body message for the email.

One-Time Task Execution Mode

For the one-time execution mode, you need to specify the following fields in the Info panel.

Property Description
Details Enter a description for the task.
Execution Choose the execution mode for the task. In this case, set it to 'One-Time'.
Start Set the start date and time for the task. The start time can't be set to any time less than 5 minutes from the current time.
Parameters Input valid parameter value(s) for the dashboard if any.
Delivery Specify the recipient's email address, the reply-to email address where the recipient can respond, the subject line, and the body message for the email.

Scheduled Task Execution Mode

For the scheduled execution mode, you need to specify the following fields in the Info panel.

Property Description
Details Enter a description for the task.
Execution Choose the execution mode for the task. In this case, set it to 'Scheduled'.
Choose Template Select a schedule template for the task. A schedule template is used to define the recurring interval at which to run a dashboard and the email delivery details. See this article for more information on schedule templates.
Parameters Input valid parameter value(s) for the dashboard if any.
Delivery Specify the recipient's email address, the reply-to email address where the recipient can respond, the subject line, and the body message for the email.

To Schedule a Task

Follow the below steps to schedule a task for a dashboard.

Note: For successful task execution, make sure that the dashboard worker service is running in the background, else the scheduled task will fail to execute. To get the status of the dashboard worker service, navigate to the Node Management page on the Admin Portal.

  1. On the Document Portal, select the dashboard you want to schedule.
  2. With the dashboard selected, click the Info button on the top-right corner of the portal.
  3. In the Info panel that appears, navigate to the Tasks tab and click the + Add Task button to create a new scheduled task.
    Create a new scheduled task
  4. Enter the task description in the Details field.
    Navigating to the Tasks tab
  5. By default, tasks are manually scheduled in Wyn Enterprise. To create a task that runs at fixed intervals of time, set the Execution field to 'Scheduled'.
    Navigating to the Tasks tab
  6. From the Choose Template dropdown, select a suitable schedule template that matches your requirements. The list shows both the built-in and custom templates on the server. For more information on how to create a custom schedule template, visit this article. Choose a schedule template
    Choose a schedule template

    The Start and the End fields pick the default values specified in the chosen schedule template. These default values are unchangeable.
    Start and End Dates for Schedule

    Note: If the chosen template has predefined settings for the email delivery, then its corresponding fields like Email To, Reply To, Subject, and Body are set to default values as specified in the template, and hence can't be modified.

  7. In case your dashboard contains any parameter(s), you need to enter valid parameter value(s) or set the value(s) to default. Else, a message saying 'Dashboard has no parameters' will be displayed.
    Empty parameters section
  8. If the delivery method is not specified in the schedule template, then specify the recipient email address, the reply-to email address, the subject line, and the body message for the email in the corresponding fields.

    Choosing delivery type

    Note: Use comma(s) to separate multiple email addresses.

  9. Click the Create Task button to save the settings. Note that the newly created task is listed under the Scheduled Tasks section.
    List of scheduled tasks
  10. Click the Run Task button to execute the scheduled task manually out of the recurring iteration whenever you want, or to check whether a scheduled task runs correctly with the applied settings.
    Run Task Button
    From the Task History tab, you can check whether the scheduled task is completed or failed.

To Manage a Scheduled Task

To manage a scheduled task, click the Actions button Actions Button in the Tasks tab. You can use this button to disable, edit, duplicate, or delete a scheduled task.

Modifying the scheduled task

  • Disable - Deactivates all the future scheduled executions for that task. You can resume the task execution once you enable the scheduled task by clicking the Actions button.
  • Edit - Enables you to modify the existing information for that task like its name, execution type, timings, export format, and so on.
  • Duplicate - Creates a new task with all the settings defined the same as in the originally scheduled task. This way, you can reuse the settings and save your time and effort in re-creating a scheduled task from scratch.
  • Delete - Discards the scheduled task. Note that once you delete a scheduled task, it is gone forever.