Difference between revisions of "Scheduling Installation"

(The Service Identity)
(Replaced content with "{{Disambiguation}} Scheduling is available for both the file-based repository and the SQL Repository: * Scheduling Installation with the File-based Repository * [...")
Line 1: Line 1:
When installed, [[Web Edition|XLCubed Web Edition]] installs the [[Scheduling]] component. This is a Windows Service that can be used to automatically deliver reports to users on a schedule, or when certain conditions are met.
From [[Version 9]], when used with the [[SQL Repository]], the Scheduling component can be used without installing the Windows Service, but instead by running the application [[SQL Repository#Running the Scheduler On Demand|on demand or by using Windows Task Scheduler]].
Scheduling is available for both the file-based repository and the [[SQL Repository]]:
* [[Scheduling Installation with the File-based Repository]]
* [[Scheduling Installation with the SQL Repository]]
===Installing the Windows Service===
If the installation hasn't already configured the Windows Service, run the {{Code|InstallService.cmd}} batch file located in the {{Code|Scheduler}} directory of your XLCubed Web Edition installation.
===Feature Permissions===
As in [[XLCubed Web Edition Installation Guide#Functional User Permissions|the Web Edition installation guide]], permissions for access to the Scheduling feature can be set by granting or revoking access to the {{Code|Xml\Security\scheduling.xml}} file in the XLCubed Web installation folder.
===Using the XLCubedWeb Management Console===
You can find this configuration tool in the Start Menu of the server, called {{Code|Configure XLCubed Web Edition}}. On the Scheduling tab, there are several options that can be used to customise your Scheduling installation.
[[File:Web Configuration Scheduling.png]]
; Web address
: The internal web address that the Scheduling service can use to access XLCubed Web Edition.
; Public web address
: The external web address that XLCubed Web users use when accessing the application. This is used to generate report URLs for emailing to users.
; Repository path
: The physical path to the XLCubed Web Edition repository.
; Webservice timeout
: The length of time the scheduling service should wait before giving up when rendering reports, in minutes. The default value is 10 minutes.
; Basic authentication
: The credentials to use to connect to XLCubed Web Edition to render the reports when Basic authentication is being used.
; Clean repository
: Automatically remove previews and unused images.
You may need to restart the XLCubed Scheduling Windows service after changing these properties.
===Configuration Files===
There are two sets of configuration files for the Scheduling Service.
* {{Code|XLCubed.Scheduling.Service.exe.config}} in the {{Code|Scheduler}} directory of your XLCubed Web Edition installation. This should be automatically populated with the correct values, and will only need modification if the website or repository are subsequently manually moved, or if the XLCubed Web Edition server uses a non-default [[#Authentication Mode|Authentication mode]].
* The schedules and other configuration files for the Scheduling Service in the XLCubed Web Repository folder, in the {{Code|__xlcubed__\__scheduling__}} subfolder. It is normal for there to be no files until schedules or other configuration parameters have been set up.
===Authentication Mode===
The Scheduling service is set up to use Windows Integrated authentication by default. To use Basic authentication instead, edit the {{Code|XLCubed.Scheduling.Service.exe.config}} file, changing the {{Code|AuthenticationType}} line to {{Code|Basic}} and fill in the user name and password below it (XLCubed Web Edition v6.5.014 and higher). This account should have permission to access the XLCubed Web Edition instance, as well as any repository folders required for scheduling.
===Using the Role Selector===
When configuring schedules and distribution groups, the Scheduling configuration screens can offer a list of relevant roles available on the server. In order for this to work, Microsoft's Analysis Management Objects must be installed. This can be found here, included in {{Code|Microsoft SQL Server 2005 Management Objects Collection}}:
[http://www.microsoft.com/en-us/download/details.aspx?id=11988 Feature Pack for Microsoft SQL Server 2005 SP4]
==Configuring the Windows Service==
===The Service Identity===
By default, the Scheduling Service runs under the {{Code|Local System}} account. This allows it to have access to the necessary files, webservices and resources it needs to run reports and send emails. However, to use the Roles feature, a new identity must be chosen that is allowed to use all the Analysis Services roles that will be used. For simplicity, this can be an OLAP Administrator. In this case, you must give write access to the service identity user to the Repository folder.
===Starting the Windows Service===
The Scheduling Service can be managed just like any other Windows Service. You can start it by running the {{Code|StartService.cmd}} batch file located in the {{Code|Scheduler}} directory of your XLCubed Web Edition installation or by using the Services control panel.
==Configuration with a [[SQL Repository]]==
See [[SQL Repository#Scheduling]] for detailed instructions on additional required steps.
==Other considerations and Troubleshooting==
See [[Scheduling Troubleshooting]] for help with problems configuring the server.
==See Also==
* [[Scheduling]]
* [[SQL Repository#Scheduling]]
[[Category:Web Edition]]

Revision as of 13:09, 30 January 2018

Scheduling is available for both the file-based repository and the SQL Repository: