Once you create a scheduled task in Wyn Enterprise, the run result of the report is automatically generated at the specified time or interval in the chosen file format. You can share the result by sending an email to the designated email address, storing it on the system server, or keeping the result at a shared location.

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. You can also add the saved filters in the report while scheduling. Instead of defining the parameters every time, you can use preset filters to match the filters used in the report preview. For more details, please have a look at the below sections.

• To Schedule a Task

• To Manage a Scheduled Task

• Task Execution Modes

  • Manual Task Execution Mode

  • One-Time Task Execution Mode

  • Scheduled Task Execution Mode

To Schedule a Task

This section describes how to set up a report that automatically generates on a recurring basis, like daily, weekly, monthly, or yearly.

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

1. On the Document Portal, select the report you want to schedule.

2. With the report 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.

   
   

   
   

   
   

4. Enter the task description in the Details field.

   
   

   
   

   
   

5. By default, tasks are manually scheduled in Wyn Enterprise. If the Execution field is set to One-Time, then you can specify the Start date-time and Executing Timezone as per your requirement.

   
   

   
   

   
   

6. To create a task that runs at fixed intervals of time, set the Execution field to 'Scheduled'.

   
   

   
   

   
   

7. 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.

   
   

   
   

   
   

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

   
   

   
   

   
   

   Note: If the chosen template has predefined settings for the export format or delivery method, then their corresponding fields like Export Format and Delivery Method are set to default values as specified in the template, and hence can't be modified.

   Add Execution Time Range option allows to specify time range for daily recurring tasks within which the task should only execute. To select the time range:

• Select Daily for REPEAT and select Every hour(s) for the execution time.

• The Add Execution Time Range check box will appear.

  
  

  
  

  
  

• Select Add Execution Time Range, the Start Time and End Time selectors will appear to select the time range during which the task is executed in a day.

• The default value of Start Time is "12:00 AM".

• The default value of End Time is "11:59 PM"

• After adding the execution time range, the description of the execution time range will be displayed in the task description.

  
  

  
  

  
  

  There are two ways to modify the Start Time and End Time:

  • Selection box

  • Input text

    
    

    
    

    The Start Time and End Time must have a value.

  Please note the following for Add Execution Time Range:

  1. When the start time and end time are set incorrectly, the Create Task button cannot be clicked. Requirements for correct execution time range setting:

  • The start time and end time cannot be empty.

  • The time should be correct, and the format is "hh: mm AM”.

  • The start time must be earlier than the end time.

  2. If there is an Execution Time Range in the task template, when creating the task by this template, the Execution Time Range information of the template will be displayed in the description of the task. The description is the same as the description of the Execution Time Range on the daily schedule task.

  3. When creating tasks for reports, and creating schedule templates, if the user selects REPEAT as Daily, the user is allowed to add the Execution Time Range on the day.

     
     

8. If the export format settings are not defined in the schedule template, then specify how to store or share the report result through the options available in the Export Format dropdown. The supported formats are PDF, Excel, Word, CSV, HTML, Image, JSON, TXT, XML, and Excel Data, or create custom export templates based on your requirements.

   You can check the Advanced Settings option to specify the advanced export properties for the chosen format.

   
   

   
   

   
   

9. In case your report contains any parameter(s) or variant(s), you need to enter valid parameter value(s) or set the report variant. Else, a message saying 'Invalid Parameters' will be displayed.

   
   

   
   

   
   

   Click on the Variants button to select your variant.

   
   

   
   

   
   

   It will auto populate the parameter values. If you want to delete the values you entered, click Set default values.

   
   

   
   

   
   

   Note: If the filter is updated/modified, the new settings of the filter will be displayed for the subsequent scheduled task executions.

   If you have used the Date Range/DateTime Range Editors to set the parameters in the custom parameter view, then you can set the Specific Date/DateTime range and Relative Date/DateTime range for the reports while creating a scheduled task. Refer to the example below for details.

10. If the delivery method is not specified in the schedule template, then select an appropriate method like email, local storage, file share, external storage, and application message from the Delivery dropdown, and set its corresponding fields.

If you choose 'Email' as the delivery method, then specify the recipient email address, the carbon copy (cc), the blind carbon copy (bcc), the reply-to email address, the subject line, and the body message for the email.

Body:

In the Body, you can specify keys added to the Rendered Report Values property of the report from the Info Panel. For a report with Rendered Report Values set, you can view the keys while setting the delivery method (Email) and use them in the email body.

> Note: You can not use the rendered report values if you create a scheduler task for report bursting, multi-document, or document binder.

**Body For Empty Report:**
In the field **Body For Empty Report**, you can specify the email message that will be sent if an empty report is generated by the scheduler task. In the admin portal, if the property, **Don’t deliver the empty document** under [Schedule Settings](gcdocsite__documentlink?toc-item-id=49e74dce-ba11-4a48-9e85-47a544535ee3) is set to **True**, then the email message will not be sent even if the details are provided in the field
**Body For Empty Report**. Also, the field **Body For Empty Report** is not available if you create a scheduler task for multiple documents. You can also control how to share the result on the email by either sending it as a file attachment or providing a link in the email body to download the result.

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

Please note, that if the Administrator sets the Hide Attachment Type Options for Email Delivery Tasks

property to True in the Admin portal, then while creating the scheduled task the Attachment Type options for delivery type as Email will not be displayed and it will use the default Attachment Type value. The default Attachment Type values are as below:

• When not using the Schedule Template: The default Attachment Type is File Attachment and for Multiple Doc (Doc Binder) also, the default Attachment Type is File Attachment.

If you choose 'Local Storage' as the delivery method, then specify how to store the result on the system server - permanently, until a specific date, or once the defined period expires.

If you choose 'File Share' as the delivery method, then specify the file name and the shared location for storing the result.

If you choose 'External Storage' as the delivery method, then specify the storage type and the storage name for storing the result.

If you choose 'Application Message' as the delivery method, then specify the application name, and the subject, body, and recipients for the message. You can also specify how to share the result in the application message, either in the form of an attachment link or a download link.

10. Click the OK button to save the settings. Note that the newly created task is listed under the Scheduled Tasks section.

11. 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.

From the Task History tab, you can check whether the scheduled task is completed or failed. If the scheduled task completes its execution, click the Download link to store the report result on your system.

Example – Setting the Relative Date range when the Date Range editor is used to set the parameters.

In this example, we have used the Date Range editor to set the parameters. On the Add Task screen, we have selected the From relative date and To relative date as shown below.

Once the task is added, you can run the task and view the result. The data will be displayed as per the relative date range set while creating the scheduled task.

To Manage a Scheduled Task

To manage a scheduled task, click the Actions button in the Tasks tab. You can use this button to disable, edit, duplicate, or delete a 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.

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.

Note: MS Teams does not support deployment on public networks due to multi-factor authentication. However, you can use email to send notifications to channels.

Manual Task Execution Mode

For the manual execution mode, you need to specify the following fields in the task dialog.

One-Time Task Execution Mode

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

Scheduled Task Execution Mode

For the scheduled execution mode, you need to specify the following fields in the task dialog.

See Also

Configure Slack Settings

     Configure MS Teams Settings

     Slack Integration

     MS Teams Integration