Scheduling Installation with the SQL Repository

Revision as of 14:14, 25 January 2018 by Antonio.remedios (talk | contribs) (Created page with "{{Scheduling Installation Common|Type=SQL}}")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

When installed, 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 on demand or by using Windows Task Scheduler.

Installation

Installing the Windows Service

If the installation hasn't already configured the Windows Service, run the InstallService.cmd batch file located in the Scheduler directory of your XLCubed Web Edition installation.

Feature Permissions

As on the Functional User Permissions for XLCubed Web Edition page, permissions for access to the Scheduling feature can be set by granting or revoking access to the Xml\Security\scheduling.xml file in the XLCubed Web installation folder. In addition, the Management Console can be used to assign finer-grained access permissions.

Using the XLCubedWeb Management Console

You can find this configuration tool in the Start Menu of the server, called Configure XLCubed Web Edition. On the Scheduling tab, there are several options that can be used to customise your Scheduling installation.

MgtConsoleScheduling1.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.
Schedule domain update
Set the frequency in days to run a scheduled domain update

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.

  • XLCubed.Scheduling.Service.exe.config in the 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.
  • A limited number of files in the XLCubed Web Repository folder, in the __xlcubed__\__scheduling__ subfolder. These are in addition to the settings stored in the SQL Repository.

Authentication Mode

The Scheduling service is set up to use Windows Integrated authentication by default. To use Basic authentication instead, use the Management Console to set the Authentication to Basic, then enter the user name and password on the Scheduling tab. Alternatively, you may edit the XLCubed.Scheduling.Service.exe.config file, changing the AuthenticationType line to 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 Microsoft SQL Server 2005 Management Objects Collection: Feature Pack for Microsoft SQL Server 2005 SP4

Configuring the Windows Service

The Service Identity

By default, the Scheduling Service runs under the 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 StartService.cmd batch file located in the Scheduler directory of your XLCubed Web Edition installation or by using the Services control panel.

Configuring the SQL Repository

  1. On SQL Server Management Studio's User Mappings screen, map the scheduling service user to the XLCUBED_SCHEDULER role
  2. In the Configure XLCubed Web Edition application, click the Administration button, then select the Admin > System Settings menu item. Choose the Scheduling user from the list then click the Save toolbar button. If the user doesn't appear, you may need to browse to the website as the user first, then re-open the Configure XLCubed Web Edition application.
  3. Select the Admin > Scheduling > SMTP Servers menu item and add the details of the SMTP server
    • The ID and uniqueid columns will be filled in automatically
    • To use an SSL connection, enter Y in the Use SSL column
    • To allow the scheduler to use the server to send emails, enter Y in the Is Global column
  4. Select the Admin > Users or Admin > Groups menu item, and add the Can schedule reports and the Can edit schedule distribution groups where appropriate.
  5. Schedules must now be set up through the Excel Edition, select the XLCubed ribbon > Publish to Web dropdown > Scheduling... ribbon button. Once you have connected to the server, you can then add new scheduled reports and manage existing ones

Other considerations and Troubleshooting

See Scheduling Troubleshooting for help with problems configuring the server.

See Also