Client Maintenance is an Administrative tool providing users with the ability to manage database and client information for the installation. It is an integral part of the installation and maintenance process, ensuring proper connectivity and licensing. For more information about what Client Maintenance does go here.
When Client Maintenance is launched by the installation or by the user as a stand-alone product, the following window will appear:
In the Config Folder field specify the path to the Lucity Config folder.
In the License File field specify the path to the provided license file.
In the Admin DB Login ID field and Admin DB Password field do the following:
Access users - ignore these fields
SQL Server or Oracle users - fill out these fields with administrative passwords for the databases. If there are multiple SQL Server/Oracle installations with different credentials for each installation, Admin credentials can only be entered for one of the installations at this time. The rest will be prompted for later.
The Use Windows NT Integrated Security checkbox allows users to connect to the database servers via Windows Authentication if the database servers have been properly configured.
Click the Next button. The utility will begin updating the Lucity configuration information.
During multi-client installations if Client Maintenance is unable to determine which licenses are associated to which clients, the following screen will be displayed immediately after login:
This screen allows users to associate existing client installations to the appropriate license in the agency's License File. To determine which license should be associated to the currently installed client, highlight a License in the list. The License Information grid will indicate which products will be enabled by the selected license.
To associate a client to the License, select a Client from the first list and a License from the second list. Then click the Associatebutton.
Note: Any Clients not associated to a License will be removed from the configuration (the databases will not be removed, but they will be inaccessible via Lucity).
Note: Licenses are designated as Production (PRD) or Non-Production (NPR).
Once all installed Clients are associated to the appropriate Licenses and pressed the Next >button.
Client Maintenance will load the empty configuration.
At the top of the screen click the Available Licenses tab.
On the left will be a list of licenses that are in the LicensesCodes.xml but are currently not installed.
Select a license on the left. The right side of the window will display information about that license.
Note: Licenses marked PRD are for production use. Licenses marked NPR are meant to setup Test or Development environments.
To install a license, highlight a licenses in the Available Licenses grid and click the Installbutton. The following window will be displayed:
This window is to specify a user-friendly name for the license, like the name of the agency, or department this license is for. Enter a name and press Ok. The following window will appear:
This displays a form to fill out connection information for a database. After this form is filled out another one will be displayed for the next database.
Database Information - This specifies the location of the database(s)
Database Name - Enter the actual name of the database to be connected to. This could be GBAComm, GBACommPRD, etc...
Database Platform - This is automatically filled out based on the License file. If this is incorrect please contact Lucity Support.
Instance Name - This is only for SQL Server or Oracle databases. Enter the name of the SQL Server or Oracle Server instance.
Path - This is only for Access databases. Enter the Path to where the databases will reside. This should be located in the Lucity Share's Data folder.
General Login Information - The items in this category indicate the Login credentials to use when connecting to the database. It is only required for SQL Server and Oracle server clients.
.NET Login ID - Indicates the Login ID to use when connecting to the database for applications that were developed using Microsoft .NET technologies. This login information is retrieved via the Gateway Login account.
.NET Login Password - Indicates the Login Password to use when connecting to the database for applications that were developed using Microsoft .NET technologies. This login information is retrieved via the Gateway Login account.
Note: The .NET credentials are persisted to the GBAUser database.
Legacy Login - Indicates the Login ID to use when connecting to the database for applications that were developed prior to utilizing .NET technologies.
Legacy Login Password - Indicates the Login Password to use when connecting to the database for applications that were developed prior to utilizing .NET technologies.
Note: The Legacy credentials are persisted to the GBALogin.mdb in the central CONFIG directory.
Web Gateway Login Information - The Web Gateway Login Information section is required for all SQL Server and Oracle clients regardless of whether they use the web applications. It does not pertain to Access installations. Client Maintenance uses the information input into these fields to generate a new account in SQL Server or Oracle and assign permissions for that account. Changing the data in these fields (like updating to a new password) will update the password in SQL Server. If clients are using the Web applications, they must also go to each of their virtual directories and make the password changes there (or re-install the web apps).
Gateway Login ID - Indicates the Login ID used to connect to the GBAUser database and retrieve the connection information for the Lucity databases. If the Integrated Security for Desktop Gateway option is set to False, both the Web and Lucity Desktop applications will use this account.
Gateway Login Password - Indicates the Login Password to use to connect to the GBAUser database and retrieve the connection information for the Lucity databases. If the Integrated Security for Desktop Gateway option is set to False, both the Web and Lucity Desktop applications will use this account.
Note: The Gateway Login Password should be at least 8 characters in length.
After filling out the above click Next >.
The above screen will appear again for the next database. However, only parts of the Database Information and General Login Information sections will appear and these sections will be filled out based on the original values.
Verify the information and click Next >.
Continue until all the databases are configured.
Click the Installed Licenses tab at the top of the tool.
After clicking the Next >button in the Client Configuration screen, the Database Update process will begin. This process will evaluate each database and perform any necessary updates in order to ensure that the databases are at the current software version and are properly linked.
Note: Please read the Database Update screen carefully.
Review the information displayed. As you select different databases from the table, the information pertinent to that database will be displayed at the right of the dialog.
If the information appears to be correct, press the Updatebutton and the Database Update process will begin.
If the information appears to be incorrect, press the < Backbutton. The program will return to the Client Configuration screen where to modify the setup.
After pressing the Updatebutton, several dialogs will appear to indicate the processing of each database. As each database is processed, the "Database Status" will change to "OK" if the database was processed without error. While this processing occurs, the navigation buttons will be disabled and the Stopbutton will be enabled. Pressing Stopwill not terminate processing on the current database; rather, it will prevent any additional database processing after the current database processing is complete.
If an error occurs while processing a database, the error message will be displayed and recorded in the "Error Message" column. An error log file will also be generated. If an error is encountered the "Email Errors to Lucity" option will be enabled, allowing users to generate an email with the error information and configuration information attached. Be aware that no password information will be stored in the configuration information sent to Lucity.
Note: The email with attached error and configuration information is only available after the Update process is complete.
Once the Update process is complete, pressing the Finish >>|button. This will save all of the configuration information and exit Client Maintenance.
Note: The Finish >>|button can be pressed without pressing the Updatebutton first. This will skip all database processing and is not recommended.
The rest of the Server/Database install will be completed.
Login
