To run scheduled report distribution, you will need to use the Windows Task Scheduler with Velixo.Reports.CommandLine.exe and the command line arguments listed below.
Setting up a task in Windows Task Scheduler
First, from the Start menu, select Administrative Tools and then Task Scheduler.
The main window of Windows Task Scheduler will be opened.
In the Actions panel, click Create Task.
In the Create Task dialog open the General tab, and enter the values for Name and Description:
On the Triggers tab click New and set up the appropriate schedule for your task.
Then click New on the Actions tab and fill in the required fields in New Action dialog:
Program/script: | "C:\Users\{username}\AppData\ Roaming\Velixo\ Velixo Report Pro\ Velixo.Reports.CommandLine.exe"
e.g., "C:\Users\sara\AppData\Roaming\Velixo\Velixo Reports Pro\ Velixo.Reports.CommandLine.exe"
(older versions of Velixo named the last folder: Velixo Reports Pro for Excel and Acumatica) |
Add arguments (optional): | --file "C:\Path\To\Workbook-File.xlsx" --distribution-list "Distribution List Name" |
Click OK and open the General tab of the Create Task dialog. Ensure option "Run only when user is logged on" is selected.
For proper execution Velixo strongly recommends using this option. In case you absolutely need to run the distribution regardless of whether the user is logged in or not, advanced configuration is required. Officially it is not supported by Microsoft. See the "Advanced configuration for non-logged in users" section below for details.
Running the task
If you wish to run the scheduled task right away for testing purposes, right click on it in the list of tasks and select Run from the drop-down menu:
Note: In this example error handling is reporting errors to the command line. No logging is performing. Excel user interface is hidden during the distribution process.
It is also always expected for a command prompt to appear during the execution of the scheduled task. The command prompt closes immediately once the task is finished.
To set up the desirable scenario of a distribution process, you can use the corresponding options.
Options
Option | Required/Optional | Description |
--file | Required | Path to Excel workbook to open |
--distribution-list | Required | The name of distribution list to process |
--log-file | Optional | Path to a log output file |
--xll | Optional | Custom path to Velixo Reports XLL file. Normally you shouldn’t specify this parameter, by default it uses Velixo’s installation path |
--silent | Optional | true (default) - Runs the process silently, returning error messages to the command line false - shows error messages in dialog boxes |
--visible | Optional | true/false indicating whether or not the Excel user-interface should be visible during the process. Default is false |
Advanced configuration for non-logged in users
In the Console Root select Component Services > Computers > My Computer > DCOM Config.
Navigate to the Microsoft Excel Application at the right. Right click Microsoft Excel Application and select the Properties item in the drop-down menu.
In the Microsoft Excel Application dialog, click the Identity tab. Select The interactive user option and click Apply to complete.
