Schedule

From Fishbowl
Revision as of 18:59, 14 February 2013 by Ncarter (talk | contribs)
Jump to navigation Jump to search

Icon.Schedule.png The Schedule module allows Fishbowl to perform scheduled tasks such as a database backups, CSV Imports or Exports, etc. Tasks will run according to their specified schedule and can also be run manually at any time.

Create Scheduled Task Template:Top

Follow the steps below to create a new scheduled task.

  1. Open the Schedule module and click the New Button.png New button in the module toolbar to open the scheduled task wizard.Template:Vertical SpacerFile:Scheduled Task Type.png
    • Database Backup - Creates a backup of the Fishbowl database that can be used to restore the database. The backup directory must be accessible from the Fishbowl Server computer.
    • Export - Any of the CSV Exports can be scheduled and exported to a directory that is accessible from the Fishbowl Server computer.
    • Import - Any of the CSV Imports can be scheduled and imported from a directory that is accessible from the Fishbowl Server computer. The files that are imported can be customized by using the * wildcard in the Mask field. Below are some examples of values that could be placed in the mask field, and the resulting files that would be imported:
      • SO.csv - The file SO.csv will be imported.
      • SO*.csv - All csv files that start with SO will be imported.
      • *SO*.csv - All csv files that contain the word SO will be imported.
      • *.csv - All csv files in the directory will be imported.
    • Java Class - A custom Java class that implements the com.fbi.TimerTask.IFBRunnable interface can be scheduled to run. Once the file is compiled it must be added to the classpath where the Fishbowl server will be able to load and run it by placing the file in the /server/lib folder of the Fishbowl installation directory.
  2. Select the desired type for the scheduled task and click Next.
    File:Scheduled Task Settings.png
  3. Enter a name for the scheduled task.
  4. Check whether an email should be sent when the scheduled task fails. This option is only enabled when email is configured on the Email tab of the Company module.
  5. Complete any other required settings and click Next.
    File:Scheduled Task Frequency.png
  6. Select the frequency of the scheduled task and click Next.
  7. Click Finish to complete the wizard.

Edit Scheduled Task Template:Top

Follow the steps below to edit a scheduled task.

  1. Highlight the task in the Scheduled Tasks pane.
  2. Click the Edit Icon Button.png Edit button in the component toolbar to the right.
  3. Proceed through the wizard and make any desired changes.

Inactivate Scheduled Task Template:Top

Follow the steps below to inactivate a scheduled task.

  1. Highlight the task in the Scheduled Tasks pane.
  2. Click the Edit Icon Button.png Edit button in the component toolbar to the right.
  3. At the bottom of the first wizard step, uncheck the File:Active.png checkbox.
  4. Complete the wizard.

Inactive tasks will not run automatically but can still be run manually. To view inactive tasks, check the File:Show Inactive.png checkbox at the bottom of the module.

Delete Scheduled Task Template:Top

Follow the steps below to delete a scheduled task.

  1. Highlight the task in the Scheduled Tasks pane.
  2. Click the Delete Icon Button.png Delete button in the component toolbar to the right.
  3. In the popup dialog, confirm that the scheduled task should be deleted.

Manually Run Task Template:Top

Scheduled tasks will automatically run according to the schedule set when creating the task. A task can also be run manually by selecting the task in the Scheduled Tasks pane and clicking the Run Icon Button.png Run button. The task will then appear in the Queued Tasks pane at the top of the module.

View Task History Template:Top

To view the history of a task, select the task in the Scheduled Tasks pane and then click the History Icon Button.png History button.