Schedules

The Schedules tab lets you create and manage schedules in Quick Fields Agent. These schedules indicate which sessions to run at which times. You can view a list of all the schedules configured, per connection, as well as information about them. You must be logged in as a System Manager to create schedules.

Note: You must register a Quick Fields Agent Server to be able to work with schedules.

Note: Schedules will not run via Quick Fields Agent if the associated sessions are opened by some other user at the scheduled time.

To add a schedule

• Click Add Schedule.

To run a scheduled session immediately

• Select the checkbox next to the schedule you want to run and click Run Now.

  

To modify and view the properties of a schedule and a scheduled session

• Click on the schedule's name.

  

To analyze run instances of a scheduled session

• Click on the schedule's name on the Instance History page.

  

To view a list of service errors that have occurred

• Hover over the server name in the left pane and click View Events.

  

To display additional information or hide information

• Click Columns on the Schedules page or Instance History page to add or hide information.

  

To refresh information

• Click Refresh.

  

To deactivate/activate a schedule

• Select the checkbox next to the schedule you want to deactivate/activate and click either Deactivate or Activate.

  

  

  Note: Deactivating a schedule does not delete it. It temporarily turns the schedule off until you activate it again.

To delete a schedule

• Select the checkbox next to the schedule you want to delete and click Delete.

  

Adding a Schedule

You can create schedules in Quick Fields Agent to indicate which sessions to run at which times.

To add a schedule

1. Click Add Schedule under the Schedules tab.
2. The Add Schedule dialog box will open.

   

3. Specify settings in the following tabs.

• General
• Advanced

These same settings can be modified on the Instance History page for a specific schedule. Once you click the name of the schedule under Schedules, you will see a Configuration section at the top of the page. Expand it and configure the settings for the selected schedule.

General

In the General tab of the Add Schedule dialog box, you can select a session to run and designate the start time and repetition interval.

Name

Under Name, specify a name that will help you remember the purpose of the schedule.

Session Used

Under Session used, the drop-down menu will list session references already added in Quick Fields Agent. Choose one of these, or to add a new session, click the Browse button to open the Add Session dialog box.

When to Run the Session

Specify a date and time for the session to start. You can click inside the Start on boxes to open a calendar or adjust the time.

Repeating: Choose a repetition option for the session from the drop-down menu:

• Never: The session will run only once, at the scheduled date and time.

  

• Daily: Select which days the session should run:

  

  • Every day
  • Monday - Friday
  • Every __ day(s) (specify a whole number)
• Weekly: Select how often in a week the session should run

  

  • Every day or specify the days of the week
  • Every __ week(s) (specify a whole number)
• Monthly: Select how often in a month the session should run:

  

• Every month or specify the which months
• Specify a day of the month by numeric day
• Select the first, second, third, fourth, or last day of a week per month

Recurring: You can select Recurring and specify an interval. This can help ensure that you have captured all the desired documents, even if a few new items have been added to the retrieval source after the designated time.

Stop schedule on: By default, schedules configured in Quick Fields Agent will recur at the designated intervals unless they are disabled. To set your schedule to recur until a designated date and then stop, select Stop schedule on and specify a date.

Enable the Schedule: By default, the Enabled check box will be selected and the session will run at the scheduled start time. If you want to keep a schedule configuration available but not run it, you can clear the Enabled box.

Advanced

In the Advanced tab of the Add Schedule dialog box, you can configure additional options for how your scheduled sessions will perform.

Priority

The schedule priority setting determines what will happen with queued sessions when multiple sessions get delayed past their scheduled start times.

In normal operation, Quick Fields Agent runs one session at a time in the order of their scheduled start times—unless it is still running another session. By default, when a session continues to run past the scheduled times for other sessions, the next sessions will run in order as soon as Quick Fields Agent is available. In the schedule priority setting, you can create settings that will allow a particular session to jump to the top or the bottom of the queue when multiple sessions become delayed. This can help prevent an important session from being delayed too long if an earlier session runs longer than expected.

The options are:

• Low: If more than one session gets delayed, a session with low priority will move down in the queue.
• Normal: Sessions will always run in the order of their scheduled times.
• High: If more than one session gets delayed, a session with high priority will move up in the queue.

Example: The Wonderland School Board has three sessions scheduled to run each night: Schedule A at 7:00 p.m., Schedule B at 8:15 p.m., and Schedule C at 10:00 p.m. Schedule C is very important, but cannot run earlier in the evening because it involves reports that are generated at 9:00 p.m. They set the priority for Schedule C to High and leave the other two set at Normal. If Schedule A has finished running by 10:00 p.m., the sessions will run in the order A,B,C. However, if on a particular day Schedule A is still running past 10:00 p.m., the sessions will run in the order A,C,B.

Action

You can determine what actions Quick Fields Agent will perform on a session. By default, it will process and store documents, but you can set it to do only one or the other.

Note: If the Quick Fields session you are scheduling has the Document Sending Schedule configured (as configured in the session in Quick Fields in Tools, Options, Current Session, Send Documents), the settings in the session and the settings in Quick Fields Agent will both be applied. Documents will initially be stored at whatever scheduled time comes first.

You can select:

• Process and store documents: Quick Fields Agent will scan documents and store them in the specified locations in your Laserfiche repository.
• Process documents: Quick Fields will scan the documents, but they will remain in Quick Fields. Select this option if you want Quick Fields Agent to run the session but you want to review the documents before they are stored.
• Store existing documents (includes post-processing): Quick Fields will store documents that are already in Quick Fields. You can use this option if someone will process and review the documents during the day, and you want Quick Fields to automatically store them at night (which will initiate any processes configured in the Post-Processing stage within Quick Fields).

Instance History

For a given schedule, you can open an Instance History page that will show you a summary of the results of each time the session was run, as well as any information or error messages from each run.

To open the Instance History page

1. Click the name of the schedule whose instance history you want to view.

   

2. Under Instance History, choose a session instance that was run by Quick Fields Agent.

   

3. The Summary page will display various pieces of information about what happened in that particular time the session ran.

   

Summary

The Summary section displays overview information about the particular instance of running the selected session, including the start and end times, time it took to run, pages per minute, numbers of documents and pages created and stored, etc.

Events

The Events button for the selected instance displays information about important events in the Quick Fields session, such as when the schedule begins running and any errors encountered during the course of running the session.

You can select the buttons at the top of the page to display each kind of information:

• Errors: Error messages reported within the Quick Fields session.
• Information: Information about how the session is running according to the schedule specified in Quick Fields Agent.
• Diagnostic: Additional information for troubleshooting.

Errors

The Errors button for the selected instance displays a record of errors in the session in XML format for troubleshooting purposes.

Log

The Log button for the selected instance displays a text record of documents stored through the specified instance of the session, as well as errors or messages encountered during processing. It contains separate summaries for documents that were identified and processed and unidentified documents. The amount of information in the log is determined by the logging settings for Quick Fields Agent. This information can be copied and pasted into another application such as Notepad or Word.

Viewing a New Instance

If you want to display information about different runs of the same session on the same page, click the name of the other instance you want to view. The page will be expanded to see the additional instance summary.

Viewing Instances of a Different Session

To see instances of a different session, click the name of the server where the desired session is located in the left pane. Click the schedule you want to view under Schedules in the contents pane.

Note: You can also access the Instance History page by selecting History from the drop-down menu next to the server in the left pane.

Event Viewer

The Event Viewer displays a list of all errors and other messages that were generated by any of your schedules during a designated time period.

Note: The data available in the Event Viewer is from the Windows Event log. The Log Retention settings control how long past the completion date the instances will be available in the Instance History. For example, if Quick Fields Agent is set to delete session logs older than five days, the data available to you in the Event Viewer will be from within the past five days.

To open the Event Viewer

• Click the down arrow next to the server in the left pane and select View Events.

Filter Settings

The Event Viewer lists the schedules that had errors and the error messages within a designated period. The initial setting is twenty-four hours for all schedules. You can filter the results to show events within a period of your choice for the schedules of your choice. The filter settings will be retained, even when you exit the Event Viewer, until you change them again.

To change the filter settings

1. The filter settings are at the top of the Event Viewer.
2. Select the server from the Server drop-down menu.
3. Select Quick Fields Agent from the Source drop-down menu. Since Quick Fields Agent is part of the Laserfiche Web Administration Console, you will see other sources to choose from.
4. Next to Date, select if you want to filter the events that happened today, in the last 7 days, or in the last 30 days.
5. Select the type of events you want to view: Information, Warning, and/or Error.
6. At the bottom of the Event Viewer, you can click Customize Columns to add or remove specific columns.

When you click on an event type, the details of that event will be displayed at the bottom of the page under Event Properties. You can view the event type, event source, event category, event ID, date, user, computer where the event happened, and the actual message about the event that occurred.