Difference between revisions of "Schedule"

From Fishbowl
Jump to navigation Jump to search
(Added module buttons)
(2013 Release)
Line 1: Line 1:
[[File:Icon.Schedule.png]] The Schedule Module is where you set Fishbowl to automatically backup your database as well as import or export information such as exporting to QuickBooks, or importing orders from an internet shopping cart such as Yahoo Shopping Cart. You can schedule tasks as close together as seconds or as far apart as years.
+
[[File:Icon.Schedule.png]] The Schedule module allows Fishbowl to perform scheduled tasks such as a database backups, QuickBooks exports, CSV Imports or Exports, etc. Tasks will run according to their specified schedule and can also be run manually at any time.
  
The following functions are available through the Schedule Module:
+
== Create Scheduled Task {{top}} ==
  
* Create a new scheduled task
+
Follow the steps below to create a new scheduled task.
* Edit or delete an existing scheduled task
 
* Activate or inactivate a scheduled task
 
* View a history of scheduled tasks
 
  
== Module Buttons {{top}} ==
+
# Open the '''Schedule''' module and click the {{Button|New}} in the module toolbar to open the scheduled task wizard.{{Vertical Spacer}}[[File:Scheduled Task Type.png]]
 +
#* '''QuickBooks Export''' - Exports data to the QuickBooks database selected in the [[Accounting#The_Accounting_Configuration_Wizard|Accounting Configuration Wizard]].
 +
#* '''Database Backup''' - Creates a backup of the Fishbowl database that can be used to [[FAQs#How do I restore a backup database?|restore the database]]. The backup directory must be accessible from the Fishbowl Server computer.
 +
#* '''Export''' - Any of the [[CSV_Imports_and_Exports|CSV Exports]] can be scheduled and exported to a directory that is accessible from the Fishbowl Server computer.
 +
#* '''Import''' - Any of the [[CSV_Imports_and_Exports|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.
 +
# Select the desired type for the scheduled task and click '''Next'''.<br>[[File:Scheduled Task Settings.png]]
 +
# Enter a name for the scheduled task.
 +
# 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#Email|Company]] module.
 +
# Complete any other required settings and click '''Next'''.<br>[[File:Scheduled Task Frequency.png]]
 +
# Select the frequency of the scheduled task and click '''Next'''.
 +
# Click '''Finish''' to complete the wizard.
  
{{Module Button|New}} [[#Create a New Schedule Task|creates a new Scheduled Task]].
+
== Edit Scheduled Task {{top}} ==
  
{{Module Button|Save}} saves any changes made to the Scheduled Task.
+
Follow the steps below to edit a scheduled task.
  
{{Module Button|Delete}} [[#Edit or Delete a Scheduled Task|deletes the Scheduled Task]].
+
# Highlight the task in the '''Scheduled Tasks''' pane.
 +
# Click the {{Icon Button|Edit}} in the component toolbar to the right.
 +
# Proceed through the wizard and make any desired changes.
  
{{Module Button|Run}} runs the scheduled task that is currently open.
+
== Inactivate Scheduled Task {{top}} ==
  
{{Module Button Help}}
+
Follow the steps below to inactivate a scheduled task.
  
== Create a New Schedule Task {{top}} ==
+
# Highlight the task in the '''Scheduled Tasks''' pane.
 +
# Click the {{Icon Button|Edit}} in the component toolbar to the right.
 +
# At the bottom of the first wizard step, uncheck the [[File:Active.png|alt='''Active''']] checkbox.
 +
# Complete the wizard.
  
In the '''Setup Module Group | Schedule Module''' click the {{Button|New}} located on the module toolbar. Choose a '''Name''' and '''Description''' for the type of Schedule you wish to create.
+
Inactive tasks will not run automatically but can still be run manually. To view inactive tasks, check the [[File:Show Inactive.png|alt='''Show Inactive''']] checkbox at the bottom of the module.  
  
Next choose the frequency for which you would like the task to run. You may select every Second, Minute, Hour, Day, Week, Month, Year, or upon Event. Most of the schedules will also ask a time for the task to run. If you chose to run upon an event, select from the drop down list which event to run after.
+
== Delete Scheduled Task {{top}} ==
  
[[File:Database_backup_task.png]]
+
Follow the steps below to delete a scheduled task.
  
After you have scheduled your date and/or time, specify the type of task you would like whether it be an import, export, javaclass, QuickBooks export, or database backup.
+
# Highlight the task in the '''Scheduled Tasks''' pane.
* '''Import''': The schedule module can be used to run any [[CSV Imports and Exports|CSV import]]. This may be especially useful to customers who need to bring in EDI or website data such as Sales Orders, Purchase Orders, etc. The '''Directory''' filed specifies where the CSV files are located. The '''Import Type''' field specifies which type of CSV will be imported. 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:
+
# Click the {{Icon Button|Delete}} in the component toolbar to the right.
** '''SO.csv''' - The file SO.csv will be imported.
+
# In the popup dialog, confirm that the scheduled task should be deleted.
** '''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.
 
* '''Export''': First you will need to browse to the directory of where you would like to export to. You can then enter in the file name and the type of file to be exported.
 
* '''Java Class''': A Java Class can be scheduled to run either at a scheduled time or during an event. The file to be run must implement the com.fbi.TimerTask.IFBRunnable interface. Once the file is compiled it can be added to the class path where the server will be able to load it and run. It can be added to the class path by placing it in the /server/lib directory.
 
* '''QuickBooks Export''': You may schedule an export to QuickBooks by selecting the type '''QuickBooks Export'''. In order to export through the scheduler Fishbowl and QuickBooks need to have been synced through the [[Accounting#The_Accounting_Configuration_Wizard|Accounting Configuration Wizard]]. [Note: the directory settings on import and export are for the directories on the Server. If somebody is using a Client rather than the Server, they must make sure they are mapping to a directory on the Server. Mapping to a directory on the Client and not the Server will cause the import/export to fail.]
 
* '''Database Backup:''' Simply select the Database backup type and then browse to the directory of where you would like Fishbowl to create a backup. [Note: The selected directory must be accessible from computer where the Fishbowl Server is installed.] For information on how to restore a backup database see [[FAQs#How do I restore a backup database?|How do I restore a backup database?]]
 
  
Once you have created your task click '''Save''' in the module toolbar to finalize your settings.
+
== Manually Run Task {{top}} ==
  
== View Schedule History {{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 {{Icon Button|Run}}. The task will then appear in the '''Queued Tasks''' pane at the top of the module.
  
You may view any Scheduled Task's '''history''' by double clicking on the task in the search panel then clicking the History subtab on the main screen. The History will inform you of the date, time, and result of the task.
+
== View Task History {{top}} ==
  
[[File:Schedule history.png]]
+
To view the history of a task, select the task in the '''Scheduled Tasks''' pane and then click the {{Icon Button|History}}.
 
 
== Edit or Delete a Scheduled Task {{top}} ==
 
 
 
A scheduled task may be edited or deleted by going to the Setup Module Group | Schedule Module. Double Click the desired task from the Search column and wait until the information for the task is displayed on the main screen. If the task is being edited, simply change any of the allowed information shown on the main screen. After the correct changes have been made, make sure to choose the '''Save''' icon from the Module Toolbar to save your changes.
 
 
 
If you wish to delete a scheduled task, simply double click the desired task from the Search column and wait until the information is displayed on the main screen. Next, choose the '''Delete''' icon from the Module Toolbar. The task will be deleted; however it may be re-created again at any time using the '''Create a new schedule task''' instructions.
 

Revision as of 19:38, 6 December 2012

Icon.Schedule.png The Schedule module allows Fishbowl to perform scheduled tasks such as a database backups, QuickBooks exports, 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
    • QuickBooks Export - Exports data to the QuickBooks database selected in the Accounting Configuration Wizard.
    • 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.