• Home
• Submit a Request
• Check on a Request

• Knowledge Books
• Using LincDoc 3.0
• Using LincDoc 3.1+
• Client Onboarding
• Employee Onboarding
• Admit+

Home → Using LincDoc 3.1+ → Connecting to Other Software Systems → LincDoc Connector for Laserfiche: Installing and Configuring

20.2. LincDoc Connector for Laserfiche: Installing and Configuring

The LincDoc Connector is a Java-based Windows service that allows LincDoc to write documents and data to external systems. In this documentation, Laserfiche connectivity will be discussed in detail. Other connectivity includes file share access, as well as other document management systems. The connector has an auto-update feature which communicates with your LincDoc server to retrieve the most up-to-date version for your software configuration.

Proceed to one of the sections below for more information:

• About the LincDoc Connector
• About the Installation Process
• Installing the Laserfiche Connector Module
• Configuring the LincDoc Server Connector
• Using the Connector to Determine the Connection Status
• Creating and Configuring the Laserfiche Connector Components

About the LincDoc Connector

A connection between LincDoc and Laserfiche allows LincDoc to read and write data and documents both to and from Laserfiche. When setting up this connection, certain connection parameters must be used to make the connection. These parameters are given a collective, descriptive identifier name, which is known as the Connector ID, and is later used when specifying the Laserfiche repository connection.

About the Installation Process

The high level steps to set up Laserfiche communication are:

The following procedure should be used to install the LincDoc Connector.

1. Download the connector_setup.exe from here. Note: this installer will only work for 64-bit environments. Using a 32-bit installer is no longer supported.
2. Double-click the connector_setup.exe file to run it.
   The LincDoc Connector Setup dialog box appears.
3. (optional) Change the path in the Destination Folder text box. The default location is C:\Program Files\LincWare\Connector.
4. Click Next.
   The Service name information appears.
5. (optional) In the Service name text box, change the default Windows service name that the connector will use. It is recommended that you use the default LincDocConnector name.
6. Click Next.
   The component information appears.
7. Use the Start Menu entries check box to determine whether or not you want the connector to be accessible from the Window Start menu.
8. Click Install.
   The connector software is installed, and the Completed screen appears.
9. Click Next.
   The Launch setup utility option appears.
10. Verify that the corresponding check box is selected, and click Close.
    The LincDoc Connect - Service Configuration dialog box appears.
    
    The LincDoc connector - service configuration is a small Java application which allows an administrator to start and stop the third-party Windows service, as well as configure the LincDoc Connector. The first thing to do upon executing the configuration application is to set the URL of your LincDoc VM.
11. Click Test to determine if the URL that you have entered is correct, and that the LincDoc server is running.
12. Verify that the Windows service is registered by examining the Status entry. If the connector is registered, the status will be either Stopped or Running.

    Note: When the connector is installed, it should automatically register the service. However, if it is unregistered for any reason, simply click Register to register the service with windows.

13. Leave the LincDoc Connector - Service Configuration dialog box open. You will need it later in this process.
14. Proceed to Configuring the LincDoc Server Connector below.

Configuring the LincDoc Server Connector

Once you have installed the LincDoc Connector, you need to configure it communicate with Laserfiche.

Proceed to one of the following sections below for more information:

• About LincDoc Connector Components
• Accessing the Connectors Dialog Box

About LincDoc Connector Components

The LincDoc connector has two components to its configuration: a handler and a connector.

A handler defines the configuration of the local system LincDoc needs to write to. In this case, Laserfiche is the local system. The handler defines the server, path locations, and user credentials used to access the Laserfiche system.

The connector defines the configuration parameters for connecting to the LincDoc system. Once both of these components are defined, the handler can be mapped to an individual connector.

Accessing the Connectors Dialog Box

The configuration of the LincDoc Connector is done using the Connectors dialog box, which is accessed from inside of LincDoc. 

1. Verify that you have installed the LincDoc Connector.
2. Log in to LincDoc as an administrator (admin-type user).
3. Verify that you are using the correct client ID using the User Profile button on the LincDoc toolbar.
4. On the LincDoc toolbar, click the system button and select connectors.
   The Connectors dialog box appears.
   
5. In the New Connector ID text box, type an ID for a new connector.
   Important: Connector IDs are case-sensitive.
6. Click Add to create the connector.
   The connect is added to the list on the dialog box.
   
7. Right-click the newly added connector.
   A menu appears.
    
8. Click the View passphrase option to create a new password. The password appears in a separate dialog box.
9. Copy the password (you will need to paste it into the configuration screen for this connector later in this process).
10. Proceed to the next section below.

Using the Connector to Determine the Connection Status

Once the connector is configured, you can use LincDoc to view any sessions using the connection. Additionally, you can set up a monitor to send out an alert if the connector can no longer communicate with the external system. Both of these actions are accomplished through LincDoc's connector menu.

1. Log into LincDoc.
2. Open the Connectors dialog box as described in Accessing the Connectors Dialog Box.
   
3. Click the connector on which you want to set up a monitor or view current sessions.
   The connector is highlighted, and additional tabs (Sessions and Monitors) appear below the connector.
4. Click the Monitors tab. The contents of the tab appear.
   
5. Set up a monitor.
1. Click the Add button to add a monitor recipient.
2. Enter an email address to receive notifications.
3. Specify the amount of time that must elapse, after communication is lost, before the monitor starts to send out alerts using the Timeout (sec) setting.
4. (optional) Specify how long the monitor will wait before attempting to reconnect, and send out a new alert, using the Repeat (sec) setting.
   Note: This setting must first be activated using the check box to the left of the setting.
   Your monitor should appear similar to the following example.
   
6. Close the Connectors dialog box.
7. Proceed to the next section below.

Creating and Configuring the Laserfiche Connector Components

Once you create and configure the Laserfiche connector, you need to define the handler and connector.

Proceed to one of the sections below for more information:

• Defining the Laserfiche Handler
• Defining the Laserfiche Connector

Defining the Laserfiche Handler

The Laserfiche handler is defined using the LincDoc Connector - Configuration dialog box's Handlers tab.

1. From the LincDoc Connector - Service Configuration dialog box, click the Configure Connectors button.
   The LincDoc Connector - Configuration dialog box appears.
   
2. From the dialog box's Configuration menu, point to Add Handler, and click Laserfiche.
   The Handlers tab is populated with various settings.
   
3. Define the following settings:
• • Handler ID. A unique identifier that is used by the connector. This setting is case sensitive.
  • Version. The version of Laserfiche (7.2 and higher is supported).
  • Server. The Laserfiche server name (127.0.0.1 can be used if installing directly on the Laserfiche server).
  • Repository. The Laserfiche repository where the documents will be stored.
  • Username. The Laserfiche username that will be used to write the forms.
  • Password. The password for the Laserfiche username specified in the previous setting.
  • Volume. The Laserfiche volume where the documents will be written.
  • LF Temp Folder. The folder location where the connector will temporarily write forms prior to moving them to the final location.  This setting is used to address any Laserfiche (LF) workflow locking issues.
  • Max Connections. The Maximum number of connections made from the Connector to Laserfiche.
  • Max Wait (sec). The maximum number of seconds the Connector will wait for a connection to Laserfiche to become available.
  • Allow LincDoc to override username. Provides the ability to use the username and password of the current LincDoc user.
4. Proceed to Defining the Laserfiche Connector below.

Defining the Laserfiche Connector

The Laserfiche connector is defined using the LincDoc Connector - Configuration dialog box's Connectors tab.

1. If necessary, click the Configure Connectors button from the LincDoc Connector - Service Configuration dialog box to access the LincDoc Connector - Configuration dialog box.
2. Click the Connectors tab. The contents of the tab appear.
   
3. From the Configuration menu, click Add Connector.
   The Connectors tab is populated with various settings.
   
4. Define the following settings:
• LincDoc URL. The URL of the LincDoc server. Note the full path location (for example: http://<yourservername>/lincdoc).
• Client ID. The unique customer ID for your LincDoc server provided by LincWare.
• Connector ID. The unique ID for this connector. It must be set for each form in LincDoc that will use this connector.
• Password. The passphrase for the connector generated from inside LincDoc. You copied it earlier in this process.
• Handler. The unique identifier created for the Laserfiche handler configuration.
• Description. Description assigned to the connector that will be used for logging purposes.
• Connections. The number of connections the connector will make to the LincDoc server.
• Enabled. This check box allows you to enable the connector. If not enabled, LincDoc will report an error when trying to use the connector.
5. From the dialog box's File menu, click Save Configuration.
6. Close the LincDoc Connector - Configuration dialog box.
7. Return to the LincDoc Connector - Service Configuration dialog box.
8. Click Start.
9. Close the LincDoc Connector - Service Configuration dialog box.