Document Server

Lucity Document Server must be installed at the server on which the application will reside.

Lucity recommends closing all Windows applications before running the Lucity software setup.

Network Configuration Requirements

The Lucity Document Server is typically installed on an internal server but the following applications must be able to make http requests to the document server.

• Lucity Web
• Lucity Mobile Server
• Lucity Citizen Portal
• Lucity Citizen Portal RESTAPI
• Lucity RESTAPI
• Lucity Services

General Requirements

• General hardware and software requirements >>
• The Server installation must be completed before installing the Document Server.

Specific Requirements

• Microsoft.NET Core Windows Server Hosting Bundle (v3.1) (automatically installed if not found)

How to Install Document Server

1. Open the Lucity install media and run Setup.exe. The following screen appears:

    

2. Select the Lucity Document Server option on the menu. The Welcome screen appears:

   

3. Read the Welcome screen. Click to continue. The Database Connection Information dialog appears:

   

   • Use the Instance Name field to identify the SQL Server instance that hosts the Lucity database.
   • Use the Database Name to identify the database that stores your Lucity data. This is typically called Lucity.

     Note: The databases must already exist. The installation will not create the database for you.

4. Click to continue. The Existing Site dialog appears:

   

   Note: This screen will appear only if more than one site is defined in IIS. If there is only one web site, this screen will not appear.

5. Select an existing web site where the virtual directory for Documents is/will be located.
6. Click to continue. The Virtual Directory dialog appears:
   • Lucity recommends using the default settings. The Physical Directory defaults to the root of the existing web site.

   

7. Click to continue. The Document Server User Information dialog appears:
8. Enter a Domain, Username, and Password. The document server will use this account to add or remove Documents and Custom Web Reports from the agency's document or web report repositories. The location of these repositories are specified in Lucity Web > Admin Portal > Settings > System Settings > Documents.

   

9. Click to continue. The SSL/TLS Option window appears:

   

10. To use the Document Server over SSL/TLS, check the Use SSL/TLS option. Agency administrators are responsible for configuring the site to support SSL/TLS by installing a valid certificate and creating an https binding if these items do not already exist.

    Note: If this option is enabled and an administrator does not complete the required SSL/TLS configuration steps in IIS, the Document Server will not run properly.

11. Click to continue. The Website Hostname dialog appears:

    

12. Enter your server's internal Hostname. (Do not add anything in this field but the Hostname.)
13. Click to continue. The Web Gateway User Information dialog appears:

    

14. The dialog informs the reader that the Username and Password provided will be used to create a new database user. Citizen Portal will use this account to query application configuration information. The designated user will be granted minimal database privileges and access to several Lucity stored procedures.

    Consider the following when creating a Username:

    • Lucity recommends using the default Username provided.
    • If you choose to use a different username, it should not be that of an administrative user or any existing Lucity user. If you enter a Username that is disallowed, you'll be prompted to enter an alternative Username.

      Note: You cannot use Lucity_User for this login.

    Consider the following when creating a Password:

    • If the Username entered already exists, the installation will verify the Password by attempting to connect to the database as this user.
    • Lucity recommends a Password of at least eight characters for new accounts.

      Note: By default, SQL Server enforces an agency's local or domain password policy when evaluating passwords for database users. Please ensure that the password you choose meets your organization's password policy.

15. Click to continue. The Database Administrator Login dialog will appear:

    

    DBA Credentials are required to create or update the specified user account. Provide SQL Server system administrator credentials or some other database administrator account.

    Note: If the credentials entered aren't sufficient, an error message will detail the possible problems.

16. Click to continue. The Ready dialog appears:
17. 

    Note: IIS will be restarted during the installation.

    Note: It may take up to one minute to create the virtual directory, depending on the speed of the web server. Please wait for this process to be completed.

    More Information about Lucity's Data Collection Policy >>

18. Click to begin the installation. This process may take a few minutes.  The following window appears when the installation is complete: