Management Console Summary

Overview

iService is designed as a multi-tenant application in which a Landlord operates the system for many customers, referred to as Tenants. Each of these tenants has its own tenant database that contains configuration information, contact information, and interaction details. Although they are sharing various aspects of the iService system, the tenant is unaware of this fact and has complete control over customizing and using their iService system. Tenants have the ability to configure their iService system any way they choose, without regard to how other tenants configure and use their systems.

The Management Console is used by technical services staff that are responsible for the systems administration of the iService system. It is used to create new tenants, apply upgrades to the system, change certain configuration settings for tenants, and includes a broadcast message feature for sending notices to users logged into tenants. It is a Windows application that can be run from any Windows machine that can connect to the iService database server. By default, it's executable is located in the same directory as the iService Mail Popper service and iService Mail Monitor (the default location is C:\Program Files\1To1Service\iService).

Running the Management Console

To run the Management Console application, find it's location and execute the file named iServiceManagementConsole.exe. Running the application will launch the Master tab, where you must enter your connection details.

The application supports the following optional parameters.

iServiceManagementConsole [-nogui "server_name" "master_db_name" "sql_user_name" "sql_password"]

Use the -nogui parameter and the login details to run the management console from the command line. Once launched in the -nogui mode, the application will connect to your master data and run any database updates defined for it's version. The -nogui command line version is designed to be used for automated scripts, or when applying version updates that don't require tenant changes. The full GUI version is required to make changes, such as updating license counts or broadcast messages.

The program will return an exit code upon completion. When the application connects and performs the database updates successfully, a return code of 0 is provided. If an error occurs during execution, a return code of 1 is provided. To determine the nature of the error, run the management console with the full GUI to observe the errors.

For iService installation and upgrade instructions, please see the iService Installation Guide.