How do I setup Single Report Schedule for Tableau Reports in ATRS?

The Single Schedule is the simplest and easiest way to schedule a Tableau report for delivery. This article will guide you through the steps of setting up a Single Schedule for Tableau Report delivery.

Single report Schedule For Tableau Reports

The Single Schedule simplifies the process of scheduling Tableau Reports for delivery. You start by selecting the specific report you want to schedule, then proceed to set the timing for when the report should be generated. If needed, you can also choose parameters to customize the report further. Finally, you specify the destination(s) where the report should be sent, making the scheduling process straightforward and efficient.

 

Step 1: Navigate to Single Schedule on the Home Screen

This will display the General Tab of the Single Schedule Wizard

Step 2:  You may change the Create In folder or accept the default.  The Create In folder is the Parent folder where you wish the schedule to be stored. These are ATRS specific folders.  To select a different folder click on the (...) button to the right of the window.

Step 3: Select a Tableau Account from the dropdown that will be used to Access the Reports.  The Tableau Account should have already been linked in Integrations.

Step 4: Choose an Item Path from the dropdown, this is the report that is going to be scheduled.

Step 5: The Schedule Name will take its name from the report that has been chosen. However, if you wish to change this, simply over type it.  The Schedule Name must be unique.

Step 6 (Optional): You may enter a Description.  A Description may help others identify the use of the schedule. 

Step 7 (Optional): Enter some keywords which can be used later by Smart Folders to identify this schedule.

Step 8: Click  Next to move to the scheduling Tab of the Wizard.

Schedule

Step 9: Choose when the report will execute. There are a variety of options and if none of them suit you may create your own scheduling frequency using Custom Calendars.  For a full explanation of each of the scheduling options review the Scheduling Article.

Step 10: Click Next to continue to the Settings Tab section of the wizard.

Settings

Step 11 Settings (Optional): If you wish to adjust any of the settings for the report page, you can do so here.

Step 12: Snapshots may be enabled here, you can determine how long you keep the snapshot for.   Snapshots are a feature that allows you to capture a specific state of the report at a particular point in time. This can be useful for referencing a specific version of the report. 

 

Report Parameters

Step 13: Customize the report by entering the Report Parameter Name and Parameter Value here. Make sure the Parameter Type is accurate, then click the Add button to have the Parameter appear in the window at the bottom of the screen.

Once all the parameters have been completed you can Preview the report before moving on to the next step.  

If you need to remove a Parameter that you have already added then highlight a parameter in the bottom window by clicking on it and click Delete.

Step 14: Click Next to continue to the next wizard section.

Destination

Step 15:  In this section, you will decide where your schedule will be delivered. To see a complete list of available destinations click Add.  You may add as many destinations to the schedule as  you like.  

 

The Order that they appear on the screen is the order in which the report will be delivered to them.  You may change this order by clicking on a destination and then clicking on the green up and down arrows to move it.

 

After creating a destination, if you wish to make changes to it, you can simply double-click on it or click on it and then select the "Edit" button to adjust its properties.

If you decide you no longer need a destination after creating it, you can simply select it and then click on the "Delete" button to remove it.

To access default destinations, click on the "Import" button.

• For more information about Type of Destinations, click here.
• For more information about Output Formats, click here.

Step 16: Click Next to continue to the next wizard section.

Exception Handling 

 Step 17: In this section you will determine what should happen should ATRS encounter an exception while executing any of the schedules. For more information about Exception Handling please review the Exception Handling Article

 

• Treat as “error” if not completed in X minutes: If a report takes longer than the specified amount of time to run, this option will treat the schedule as an error and follow the appropriate action. The “Auto-calculate” option instructs CRD to automatically determine how long a schedule should take to run the report. If it takes longer than the calculated amount of time, then it is an error.

• On error, retry executing schedule every: If set to 0, CRD will deem the schedule as "Failed" the first time it encounters an error. The schedule will not run again until its next scheduled time. Change the value to tell CRD how many times you want it to retry running the report before declaring it as "Failed."
• Override error email: Check this option if you want to specify an email address that receives the error alert when it fails. This overrides the default email specified in Options.
• Check if the Report is Blank: If a report is blank because it genuinely returned no data, recipients can misconstrue this as an error with the scheduler. This option allows you to identify genuine empty reports and instruct CRD on what to do with them.
• Ignore the report and subsequent tasks: If the report is blank, do not send the report. The report will not be delivered to the destination. No custom tasks will be run.
• Select an action from the task list. This task will be executed in the event that a schedule is blank.
• For more information about tasks, click here.

 

Step 18: Click Next to continue to the next wizard section.

Custom Tasks 

Step 19: In the section you have the option of setting up custom tasks. Custom tasks are business process automation tools that can be auto-triggered before or after a report runs.

 

Step 20: Custom Tasks is the final step.  Once everything has been added to the Single Report Schedule click finish to complete & save the schedule.

 

Single Report Schedule Context Menu

To Access the context menu of a schedule Right-click on the Schedule to see the following options:

• • Properties: You can make changes to the schedule by editing it here. Alternatively, you can simply double-click on the schedule to access and modify it.
  • Copy: Use this option to duplicate the schedule. Simply right-click in the empty area of the folder where you want to copy it, and then choose the "Paste" option.
  • Paste: Paste a previously copied schedule.
  • Rename: Edit the package name.
  • Enabled: Schedules are enabled when there is a check icon beside this option. To stop a schedule from running, or to "pause" it for a while, select this option to remove the check icon. Disabled schedules will not run until they are enabled again.
  • Move: If you want to relocate a Schedule to another Parent Folder, you can utilize this feature to do so.
  • Preview: Preview the report before it is executed..
  • Execute: When you click this button, the schedule will be executed right away. It's important to note that manually executing the schedule does not change the next run date and time. These will only be updated if the schedule runs automatically as scheduled by one of the schedulers.
  • Delete: Selecting this option will delete the schedule.
  • Execute On: Use to option to execute the schedule to another collaboration server.

Tools: This option gives access to the following options:

• • Tools - Generate Script: This feature generates a SQL script, allowing you to copy a schedule from one instance of the software to another for seamless replication.
  • Tools - Test: Use this option to test the schedule and export it to selected "test" destinations.
  • Tools - Convert To Package: This button will convert this report into a package. The package will have the name of the single schedule report.

• • Tools - Create Shortcut: Use this option to create a shortcut you can save in any location on your PC. Execute the shortcut to execute the schedule in ATRS.