Creating a Repository

You can create a repository that can be accessed across your organization's network. The process of creating a repository can be split into two separate tasks: first, prepare your third-party database application for the creation of a Laserfiche repository, and second, create the Laserfiche repository.

Note: This documentation includes instructions for volume operations in both the Laserfiche Repository Server Administration Tool and the Repository Desktop Administration Console. However, please note that the Repository Desktop Administration Console has been deprecated and we advise using the Server Administration Tool instead. See Deprecated Modules and Features for more information.

Creating a Repository

Repositories are created in the Laserfiche Administration Console. When creating a repository, make sure to specify the full path to the folder where you want to store the repository. This folder must be accessible to the Laserfiche Server service.

To create a repository

  1. Optionally, pre-create your SQL database. If you do not, a database with appropriate access rights will be created for you during repository creation.
  2. As a user with the the system manager role, sign in to either the Repository Server Administration Tool or the Repository Desktop Admin Console
  3. Do one of the following:
    • Server Administration Tool: Select the Repositories tab and then select Create
    • Desktop Administration Console: Select the Repositories node, open the Action menu, and select Create New Repository.
  4. The Laserfiche Repository Creation Wizard will open.
  5. Click Next to begin repository creation with the Connect to a Laserfiche Repository Server step.
  6. Under Laserfiche Server, select the Laserfiche Repository Server that will host the repository to be created.
  7. Under DBMS, select the database management system that this repository will use.
  8. Click Next to continue to the Laserfiche Specific Settings step.
  9. Under the Repository name option, specify the name that will be assigned to your Laserfiche repository and displayed to Laserfiche users.
  10. Note: A repository name may contain letters (including accented letters), numbers, characters (such as Chinese characters), and some symbols, but may not contain spaces. Any name that is a valid domain name according to the IDNA mechanism is also a valid repository name in Laserfiche.

  11. Under the Repository path option, specify the full path (e.g., C:\Repositories\Repository Name) to the location on the computer hosting the Laserfiche Server where repository-related files will be stored. This path also identifies the location that will be used as a starting point for relative volume paths.
  12. Under the Volume name option, specify the name that will be assigned to the first volume that will be created for your repository.
  13. Under Location, specify where the files that will be associated with the default volume will be stored. You can store them in a subfolder of the repository path or you can manually specify a different path. To use a path other than the repository directory, specify a UNC path or a path to a local folder. (If the volume files will be stored in a folder that is not on the same computer as the Laserfiche Server, you should use a UNC path and not a mapped drive path.)
  14. Click Next.
      1. In the Server option, select the name of the SQL Server that will host your Laserfiche database. If you are using an edition with SQL Express, the server name will be Server\LASERFICHE.

        Note: You can override the default port used for communicating with your SQL server by following your SQL server name with a comma and then the port number you wish to use. For example, to use port 1234 to connect to the server "ServerName" on the domain "example.com," you would type the following: ServerName.example.com,1234

      2. Below the Server option, determine how the Laserfiche Server will authenticate to the SQL Server. Do one of the following:
        • To authenticate to SQL Server using Windows Authentication, select the Use Windows Authentication option.
        • To authenticate to SQL Server using a SQL Server login account, select the Use SQL Server Authentication option. In the Username option, specify the name of the desired SQL Server login account. In the Password option, type the password that corresponds to that account.

        Important: The specified Windows or SQL Server login account must have sufficient permissions to SQL Server.

      3. The ODBC Driver Options allow you to supply additional parameters to be appended to the ODBC connection string. If you do not have additional parameters, you can leave this option blank. Refer to Microsoft SQL's official documentation about database connection string options for your ODBC version. Note that different SQL server/ODBC versions may use different formats.
      4. The Database option determines the SQL database that will be associated with the Laserfiche repository being created. If you have not already created an empty database for use with Laserfiche, type the name of the new database to be created. If you have created an empty SQL database, select it from this step.
  15. Click Next to proceed to the Search Engine Specific Settings step.
  16. In the Search Engine Specific Settings step, select Use Default Settings if your full-text search engine is on the same computer as your Laserfiche Server and you want to use the default port and path settings. If it is not, select Use Customized Settings and perform the following steps:
    1. In the Search Engine Host option, type the name of the computer on which the Laserfiche Full-Text Indexing and Search Service is installed.
    2. In the Port option, type the port number you want to use. This must match the port configured for use by the Search Engine; see Server Settings for more information. The default is 5053.
    3. In the Catalog Path option, type the path where you want to store the new catalog on the Search Engine Host computer.
  17. To specify a default search catalog other than English, select another language in the Default Language option.
  18. Click Next to proceed to the Summary of Creation Parameters step.
  19. Verify the settings that will be used to create a Laserfiche repository. If you are satisfied with the current configuration, click Finish to create your Laserfiche repository. If not, click Back until you reach the desired setting and make the appropriate modifications.

To delete a repository

  1. As a user with the the system manager role, sign in to either the Repository Server Administration Tool or the Repository Desktop Admin Console
  2. Do one of the following:
    • Server Administration Tool: Select the Repositories tab.
    • Desktop Administration Console: Select the Repositories node.
  3. Select the repository you want to unregister and then select the Delete button.

Registering a Repository

If a repository has already been created, for example by another administrator or through a previous installation, you can register it instead of creating a new one. Repository registration associates an existing Laserfiche repository folder and database with your Laserfiche Server so that it appears in the Administration Console and can be accessed by users.

When you register a repository, no new repository files or databases are created. The existing repository’s configuration and data are preserved.

To register an existing repository

  1. As a user with the the system manager role, sign in to either the Repository Server Administration Tool or the Repository Desktop Admin Console
  2. Do one of the following:
    • Server Administration Tool: Select the Repositories tab and then select Register
    • Desktop Administration Console: Select the Repositories node, open the Action menu, point to All Tasks, and select Register Repository.
  3. From the menu, select Action > All Tasks > Register Repository. This opens the Repository Registration Wizard. Select Next.
  4. Confirm the Laserfiche Server name and Database connection details displayed in the wizard. Adjust them only if the SQL Server name or authentication method has changed since the repository was last configured.
  5. Give the repository a name and in the Repository path field, specify the full path to the existing repository folder (for example, C:\Repositories\RepositoryName). The folder must contain a valid LFRepo.ini file.
  6. Complete the wizard. The repository will appear under the Repositories node in the Administration Console.

To unregister a repository

  1. As a user with the the system manager role, sign in to either the Repository Server Administration Tool or the Repository Desktop Admin Console
  2. Do one of the following:
    • Server Administration Tool: Select the Repositories tab.
    • Desktop Administration Console: Select the Repositories node.
  3. Select the repository you want to unregister and then select the Unregister Repository button.

When to create vs. register a repository

Task Use this option when...
Create New Repository You are setting up a brand-new repository with its own database and storage folder.
Register Existing Repository You are connecting to a repository that was previously created, moved, or restored from backup.

Notes

  • Repository registration does not modify existing data.
  • The repository folder and SQL database must be accessible to the Laserfiche Server service.
  • If a repository is being restored from another system, ensure that the database connection information in LFRepo.ini matches the current SQL Server before registration.