Monday, December 7, 2015

Scheduling Reports in Cumulus 10

In this example, we will setup a daily report to show the top successful search terms.

STEP 1: Run the Cumulus Scheduler installer. After it is finished, open and edit the "config.xml" file located at /usr/local/Cumulus_Scheduler/config.xml


STEP 2: In the config.xml file, change password="pass" to the actual password for Cumulus. This gives the scheduler access to run.


STEP 3: Run the two scheduler shell scripts from terminal. Start the "CumulusScheduler.sh"

/usr/local/Cumulus_Scheduler/InstallCumulusSchedulerService.sh
/usr/local/Cumulus_Scheduler/CumulusScheduler.sh start


STEP 4: Create your report in Server Console -> Report Manager -> Create... For Report Type, select "Top Successful Search Terms". Also choose your dates and the catalog you want the report to run on. When you are ready, click "OK" to save it.


STEP 5: While still in Server Console, go to Scheduler Manager -> Create... -> Add Task. For Scheduler Action, select "Generate Usage and Statistics Report", and choose your catalog. Click "Configure..." to set your output folder where the reports will be saved. Set your date and time you want the scheduler to run and click "OK".


STEP 6: Activate your new task in Scheduler Manager.


STEP 7: Your task should show a green checkmark. Click "Run Now" to test output. Report will be generated with a datestamp in filename, for example: "ReportTest01_2015-12-07_13-11-49.txt"


STEP 8: Report is tab-separated test file. Screenshot example when opened in Excel:


STEP 9: That's it. If you get any error messages, or don't see your reports being generated, you can check details in the scheduler logs at:

/usr/local/Cumulus_Scheduler/logs/schedulerserver.log
/usr/local/Cumulus_Scheduler/logs/wrapper.log