REST API

The REST API Installation must be performed at the server where the application will reside. Installation instructions may vary slightly depending on which database you are using (Oracle or SQL Server). We recommend that you close all Windows applications before running the Lucity software setup.

General Requirements

• For a list of general hardware and software requirements go here.
• The Server Install must be completed prior to the REST API Install.

Specific Requirements

• .NET Framework 4.5.1 (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 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. It is recommended that you deploy this application under SSL.

Getting Started

1. Open the Lucity install media and run Setup.exe, the following screen will appear:

    

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

   

3. Read the Welcome screen.
4. Click to continue. The Database Connection Information dialog will appear:

   

   Note: Depending on which database you are using (Oracle or SQL Server), select the appropriate radio button. Then, enter the appropriate DB connection information based on your database type. Note that these need to be existing databases as the installation will not be creating databases for you.

   • SQL Server Users: Enter the Instance Name and User Database Name (GBAUser). The latter must be the user database; change the name if you are using something other than GBAUser.
   • Oracle Users: Enter the Instance Name, Host Name, and Port.
5. Click to continue. The Existing Site dialog will appear:
   • Select an existing web site where the virtual directory for the Lucity REST API is located.

   

   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.

6. Click to continue. The Virtual Directory dialog will appear:
   • We recommend using the default settings. The Physical Directory defaults to the root of the existing web site.

   

7. Click to continue. The SSL Option window will appear:

   

8. To use the REST API over SSL, check this option. You are responsible for configuring the site to support SSL by installing a valid certificate and creating an https binding if they do not already exist.

   Note: If you enable this option but do not perform the required SSL configuration steps in IIS, REST API will not run properly.

9. Click to continue. The Web Gateway User dialog will appear:

   

10. Read the information on the screen. It informs you that the username and password you provide will be used to create a new database user. REST API will utilize this user to query application configuration information. This user will be granted minimal database privileges and access to several Lucity stored procedures.

    Consider the following when creating a username:

    • We recommend using the default username provided.
    • If you choose to type in a different username, it should not be an administrative user or any existing Lucity user names. These user names are disallowed. 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 you enter already exists, the installation will verify the password by attempting to connect to the database ase this user.
    • For new accounts, we recommend a password at least 8 characters in length.

      Note: By default, SQL Server 2005 or higher enforces your 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.

11. Click to continue. The DBA Admin Login dialog will appear:

    

    DBA Credentials are required to create or update the specified user account. Depending on the type of database you are using (SQL Server or Oracle), enter the following:

    • SQL Server Users: Provide sa credentials or some other DB admin.
    • Oracle Users: Provide the gba_admin account or another DB admin account.

      Note: If the credentials you enter aren't sufficient, an error message will appear informing you of the possible problems.

12. Click to continue. The Ready window will appear:

    

    Note: IIS will be restarted during the installation.

    Note: The Virtual Directory creation may take up to 1 minute depending on the speed of the web server. Please wait while this process completes.

    More Information about out Data Collection Policy

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

    

    Note: This installation creates a WebTaskRunner process. The Web Task Runner handles various background tasks for the application.