Schedule

From Fishbowl

Jump to: navigation, search

Icon.Schedule.png The Schedule module, located in the Setup group, 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.

Contents

Create Scheduled Task
Jump to top of page

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.
    Scheduled Task Type 1.png
    • Accounting Export - This option is only visible if the corresponding module option is enabled. Scheduling an accounting export too frequently may cause issues.
    • 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. For example, if SO*.csv was placed in the Mask field, then all csv files that start with SO would be imported. *SO*.csv would import all csv files that contain the word SO. *.csv would import all csv files in the directory. SO.csv would only import the file named SO.csv.
    • 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 /plugins folder of the Fishbowl installation directory.
    • Report - Most reports in Fishbowl can be scheduled and exported to a directory that is accessible from the Fishbowl Server computer. Reports that include an option to sort by various fields, include product tree filters, or that have a Required tab cannot be scheduled.
    • Currencies - Currencies and their rates can be imported and updated from QuickBooks or Yahoo automatically at a scheduled time. This option is only visible if currency conversion is enabled in the Small.Currency.png Currency module options. Currencies can also be updated manually by clicking the Update button in the Small.Currency.png Currency module, or by clicking the Checked.png Currencies checkbox in the QuickBooks import.
    • Data - Queries that have been saved in the Small.Data.png Data module can be scheduled to run and export the results.
  2. Select the desired type for the scheduled task and click Next. The following example is for exporting a report, but all scheduled tasks will follow a similar format.
  3. Enter a name for the scheduled task and complete any other fields. For example, when scheduling a report, the file type must be set to PDF, CSV, XLSX, or RTF.
    Scheduled Task Settings 2.png
  4. Select whether an email should be sent if the scheduled task fails. Reports can also be automatically emailed. The email options are only enabled when email has been configured.
  5. For reports, click Next to enter the report parameters that will be used when running the scheduled task.
    Scheduled Report Parameters 3.png
  6. Click Next and select the frequency of the scheduled task.
    Scheduled Task Frequency 4.png
  7. Click Next to review the summary step and then click Finish to complete the wizard.

Edit Scheduled Task
Jump to top of page

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, or double-click the task.
  3. Proceed through the wizard and make any desired changes.

Inactivate Scheduled Task
Jump to top of page

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 Unchecked.png Active checkbox.
  4. Complete the wizard.

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

Delete Scheduled Task
Jump to top of page

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
Jump to top of page

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
Jump to top of page

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.

MODULE OPTIONS

Some aspects of the Small.Schedule.png Schedule module can be customized by opening the module, clicking the Tools menu, and then selecting Module Options.

General tab
Jump to top of page
Schedule Module Options General tab.png
This option allows a scheduled task to run the accounting export.
Personal tools
Namespaces
Variants
Actions
Navigation
Other Pages
Toolbox
Print/export
Translate