Controlling Connectors

This task shows you how to:

Control Document Scans

In the Administration Console, the Home > Connectors section provides status information and the following actions for the managed connectors.

Action

Description

Scan

Performs the scan for this connector, full or incremental, depending on connector configuration and previous scan operations.

Scan requests are processed one after the other. When a scan request is launched while another scan is already being processed, it is added to a queue persisted to disk. It will start once the current scan is finished.

Abort scan

Stops the scan for a specific connector.

Note: It does not delete the documents already processed.

Clear documents

Deletes all connector documents from the system and resets the connector state.
More actions Most connectors include more actions than Scan, Abort scan and Clear documents. For example, you can have actions such as Force rescan.
Note: These actions can also be found under Index > Connectors > YOUR CONNECTOR > Operation.

Schedule Update Frequency

As you do not want to start scans manually in production mode, it is important to schedule the scan frequency of your connector.

You can choose to add multiple schedules when your connector supports different scan modes. For example, a schedule to execute a full heavy scan each night at 00:00 when employees are not at the office, and another schedule to execute incremental scans every hour during working hours. See your connector documentation to know which scan modes are supported.

  1. In Administration Console Home page, click the connector name.
  2. Go to the Operation tab of the connector.
  3. Click Add schedule, and define:

    Action

    to specify...

    Scan mode

    The scan mode to schedule, for example Full scan.

    Schedule type

    The schedule frequency. It can be Once, Monthly, Weekly, Periodic or Cron.

    For Cron, you must use a Quartz cron expression (not a Linux cron expression). These expressions are supported by both Windows and Linux OS. It must include 6 required fields for: seconds, minutes, hours, day of month, month, day of week; and optionally, a year field separated by a white space. For more information, see http://www.quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger.

    Starts and Select execution time

    The start date and time.

  4. Click Apply.