REST API

The Lucity REST API must be installed at the server on which the application will reside. Installation instructions may vary slightly depending on the type of database an agency uses (Oracle or SQL Server).

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

General Requirements

• General hardware and software requirements
• The Server installation must be completed before the REST API is installed.

Specific Requirements

• .NET Framework 4.5.2 (Full)
• ASP.NET 4.5 should be installed and enabled in IIS.
• When using Windows Server 2008 sp2, WCF Activation must be installed.
• When using IIS 7 or higher, the following Role Services are required:
  • IIS 6 Metabase Compatibility
  • IIS 6 WMI Compatibility
• When using IIS 8 or higher, the WCF HTTP Activation feature must be installed. This feature can be installed through Server Manager and is located under .NET Framework 4.5 Features > WCF Services.

  Note: The Lucity REST API uses basic authentication. Lucity recommends that agencies deploy this application under SSL.

Getting Started

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

    

2. Select the REST API option on the menu. The following window appears:

   

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

   

4. Select the appropriate Database Type (Oracle or SQL Server).
5. Enter the database Connection Information based on the database type. The databases must already exist. The installation will not create them.
   • SQL Server Users: Enter the Instance Name and User Database Name (GBAUser). The latter must be the user database; change the name if using something other than GBAUser.
   • Oracle Users: Enter the Instance Name, Host Name, and Port.
6. Click to continue. The Existing Site dialog appears:

   

   Note: This screen appears only if more than one site is defined in IIS.

7. Select an existing web site where the virtual directory for the Lucity REST API is located.
8. 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.

   

9. Click to continue. The SSL Option dialog appears:

   

10. Check the Use SSL option to use the REST API over SSL. An administrator must configure the site to support SSL 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 configuration process in IIS, the REST API will not run properly.

11. Click to continue. The Web Gateway User dialog appears:

    

12. The dialog informs the reader that the Username and Password provided will be used to create a new database user. The Lucity REST API 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.

    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 2005 or higher enforces an agency's local or domain password policy when evaluating passwords for database users. If you are using SQL Server 2005 or higher, please ensure that the password you choose meets your organization's password policy.

13. Click to continue. The Database Administrator Login dialog appears:

    

    DBA credentials are required to create or update the specified user account. Enter the following information according to your database type:

    • SQL Server Users: Provide system administrator credentials or those of some other database administrator.
    • Oracle Users: Enter the gba_admin account or another database administrator account.

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

14. Click to continue. The Ready dialog appears:

    

    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 >>

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

    

16. Click Finish to close the install.

    Note: This installation creates a WebTaskRunner process that handles various background tasks for the application.