Managing Connectors in v5.0

Installing and Configuring DocuNECT v5.0


The Connectors option in the Administration menu allows for web based administration and execution of ContentConnectors.


What is a ContentConnector?

ContentConnectors are plug-ins that perform that perform specific tasks within the DocuNECT platform. The primary use for ContentConnectors are for managing the scheduling and execution of CaptureLifecycles and other system related activities. However, there a range of other connectors that perform useful tasks. Access the ContentConnector Library for available connectors.


System Connectors and Standard Connectors

Some connectors are delivered with the product on installation, however, they are not installed by default. These are called System Connectors. Standard Connectors are not necessarily used in every environment and can be imported into the system via the DocuNECT Web and are distributed in a ZIP package.

The following screenshot shows the System Connector library in DocuNECT Web:

ImportConnector.png

Connector Execution

Connectors can either be scheduled to run at a specific time or poll on a frequency, or the connector can be executed when a specific event happens against a document or a batch status change.

This provides a powerful mechanism for enhancing document lifecycles. For specific documents, connectors can be run once an "out of the box" or custom document action has been selected.


Managing Connectors

Connectors are managed using DocuNECT web in the Connectors sub-menu in the Administration menu. in v5.0 each connector has a version number as well as build to allow you to keep better track of the different versions of connectors.


Importing a Connector

Your DocuNECT license provides the option of installing/executing a certain number of connectors, which can be found by looking at the license certificate in the station properties. A majority of connectors have an open license which means that they can be downloaded and installed as long as you have a valid DocuNECT station license. However, there are some connector that require individual connector licensing. The connectors listed in the connector library indicate which ones are Open (require a station license only) or Licensed (require a individual connector license).

1) Download the connector package from the ContentConnector Library.
2) Click on the New button and then browse for the connector package you downloaded and then click on the Upload button. The following screenshot shows the Capture Lifecycle connector information after import.

ConnectorInfo.png

Connector Properties

Click on the connector name in the main connector view to displayed the properties of a connector.

General Properties

GeneralProperties.png

The general properties display the name and description of the connector, which can be changed if required. The station refers to the station where the connector is executed. Logging can be enabled is disabled to assist with troubleshooting, but even if the logging is not enabled any execution errors errors will be displayed. The active flag indicates that the connector will be executed by the station on the assigned schedule. Making the connector inactive means that this connector can only be executed manually.

Execution Schedule

Schedule.png

The connector scheduling has changed in v4.3 onwards to allow a schedule to be set by each day of the week. The connector can either be run daily at a specified time, or on a frequency (minutes/seconds) between certain times of the day. This allows for the schedule to be set to avoid other processes running on the server such as backup or maintenance operations.

Parameters

The following screen shows the parameters for the Document Lifecycle Connector. Each connector will have their parameters which are explains in their help section in the ContentConnector library.

Parameters.png

The connector parameters will vary for each connector and in v4.3 onwards the actual parameter name is display. If the parameter contains sensitive information then the Lock button will hide the information.


Upgrading a Connector

To upgrade a connector click on the connector name in the main connector view and click on the Upgrade button. Browse to the connection package and then press the Continue button. Confirm the connector information and then press the Finish button. Note, the connector parameters entered in the previous version will be carried forward to the upgraded version.


Executing a Connector

On the main connector view the icon on the left indicates whether the connector is currently running. You can either Start/Stop the connector from the main connector view of in the connector details page. Note, stopping a connector mid-way through execution may cause an incomplete process. Make sure the impact of stopping a connector mid-way through execution is clearly understood.

The following screenshot shows the connector execution page with logging not enabled. If logging was enabled then the log entries would also be displayed.

ConnectorExecute.png

Connector Logs

The connector logs can either be access from the main connector view or the connector details page. The following screenshot shows the connector logs page which is broken down by listing the connector runs on the top with the detail log of the selected run in the bottom half of the page. The run summary provides statistics about the connector execution including the number of errors found (if any). If required the run detail log can be exported to a text file.

Deleting Logs

If a connector is running frequently and logging is enabled then the logs can quickly fill up. It is recommended to regular clear the logs by selected the Clear Logs button in the connector detail page. You can either delete all logs, or logs that are older than a specified number of days.

LogCleaner.png