Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
docs:1100_inst_guide:0100_windows [2022/09/02 05:41] – ↷ Links adapted because of a move operation administratordocs:1100_inst_guide:0100_windows [2025/10/30 09:31] (current) – aware_support3
Line 1: Line 1:
 +{{tag>Manuals Installation_Guide}}
 +[<10>]
 +====== Windows Installation ======
 +
 +To install //**AwareIM**// under Windows operating system you need to run the set-up program that guides you through the installation process. Before starting the set-up program check that your computer meets the necessary requirements described below.
 +
 +
 +
 +**Note:**//** AwareIM** //needs Java version 12.0 or later to be installed on your machine. You do not need to install Java for the Windows operating system as //**AwareIM**// already comes with Java as part of its distribution package. The Java version //**AwareIM**// comes with is JDK 12.0 for 64-bit Windows. If you want to upgrade your Java system to the later version or to use 32-bit version of Windows you can set up //**AwareIM**// to work with a custom version of Java. See section [[0500_java]] for more details**.**
 +
 +====== Hardware and software requirements ======
 +
 +
 +To run //**AwareIM**// under the Windows operating system you need the following:\\ 
 +
 +  * IBM PC compatible computer
 +  * 512 Mb of RAM (1 Gb recommended)
 +  * 700 Mb of free disk space
 +  * Windows operating system (any Windows version is supported)
 +  * Internet Explorer (version 8.0 or later), Mozilla Firefox (version 3.0 or later), Google Chrome or Safari web browser
 +
 +======= Using the installation program =======
 +
 +To start installation of the //**AwareIM**// software, run the installation program SETUP.exe which is located on your installation CD or which has been downloaded from the Awaresoft web site. It is a self-extracting executable that will unpack all the required files on your hard disk. 
 +
 +
 +
 +Firstly the software displays the welcome screen and the license page that you must accept in order to proceed with the installation. The next screen shows the default directory where //**AwareIM**// will be installed. You can press the Next button to accept the default directory or specify a different directory. The next screen lets you choose the folder where //**AwareIM**// shortcuts will be installed. You can accept the default choice or select a different folder or choose not to install the shortcuts at all. 
 +
 +
 +
 +After you press the Install button the software will start unpacking the required files on your hard disk.
 +
 +
 +
 +If you want to use the default database system (Apache Derby) with //**AwareIM**// you can start using //**AwareIM**// right away – see section [[0400_deployment_options|AwareIM Deployment Options]]. If you want to use MySQL, MS SQL Server / SQL Server Express/Azure, Oracle, PostgreSQL or Maria DB databases you will need to set up the appropriate database software after the set-up program has finished – see section [[0500_java]].
 +
 +
 +
 +====== Running AwareIM ======
 +
 +**Whether you are running the Configuration Tool or configured applications you need to run the** //**AwareIM**// **Control Panel or start AwareIM Windows services first.**
 +
 +===== Starting AwarIM Control Panel =====
 +
 +To start the //**AwareIM**// Control Panel you can either choose the “Control Panel” shortcut in the Programs menu or you can start it manually by changing to the ''CP/eclipse'' directory of your //**AwareIM**// installation and running the ''CP.exe'' file. It is highly recommended that you run this executable as administrator.
 +
 +The AwareIM Control Panel will start all the required components such as Tomcat server and AwareIM server. On successful startup the green "OK" message will be displayed as System Status.
 +
 +Note that when starting the AwareIM Control Panel for the first time you will be asked to provide the name of your business application. The name of your business application will be used by //**AwareIM**// to create the default business space and the initial business space version (see [[glossary:business_space|business space]] and [[glossary:business_space_version|business space version]]). 
 +
 +===== Starting the Configuration Tool =====
 +
 +
 +To start the Configuration Tool press the “Start Configurator” button on the AwareIM Control Panel (or you can start it from File Explorer by changing to the ConfigTool/eclipse directory of your //**AwareIM**// installation and running the ConfigTool.exe). When you start the Configuration Tool it will ask you to provide the business name you are logging into and password. Enter the business name you specified when you started the //**AwareIM**// Control Panel for the first time. Enter admin” as user name and then enter the default password "password". 
 +
 +===== Changing AwareIM System Settings =====
 +
 +
 +You can change certain system settings by using the Settings menu of the AwareIM Control Panel.
 +
 +
 +AwareIM Control Panel starts up the following components required for AwareIM:
 +
 +  * Tomcat server
 +  * AwareIM server
 +  * Configuration Tool
 +
 +
 +
 +When starting up these components the Control Panel uses default startup options. You can change memory settings allocated to each of the components on startup, ports used, database engine and database configuration. You will need to restart AwareIM after changing most of these settings. You can also change the settings manually by changing AwareIM configuration files – this is especially useful when AwareIM runs as a Windows service or when the operating system does not have a graphical user interface.
 +
 +
 +**To change memory allocation and Java startup options manually:**
 +
 +Normally you will not require changing these options. However, if you need to change the initial Java startup properties for each of those components, you can do so by placing the special property file called ''startupOptions.props'' into the ''BIN'' directory of your AwareIM installation. The sample ''startupOptions.props'' file with the settings equivalent to the default settings is located in the samples directory of your AwareIM installation.
 +
 +
 +For example, you can increase the memory allocated to different AwareIM components on startup. To do so add ''-Xmx96m'' after ''java'' in the corresponding line (where 96m is the amount of memory in Mb allocated to the component, you can increase this number further provided that your machine has enough memory).
 +
 +
 +====== Starting configured applications ======
 +
 +
 +Applications you configure with the Configuration Tool should be run within a web browser. Open your browser and point it to the following URL:
 +
 +[[http://localhost:8080/AwareIM/logonOp.html]]
 +
 +See also [[docs:2000_concepts:0900_prod_feats:0100_access_control:0200_login|login]] describing other entry points to the configured applications.
 +
 +You can also select the Operation shortcut from your Programs menu.
 +
 +====== Un-installation ======
 +
 +
 +To uninstall //**AwareIM**// software select the Uninstall shortcut from the Programs menu or AwareIM programs folder or run Uninstall.exe located in the root directory of your //**AwareIM**// installation.
 +
 +Running AwareIM as a Windows service
 +
 +To install AwareIM as Windows service, do the following:
 +
 +  - Shutdown //**AwareIM**// if it is running
 +  - Run the batch file ''InstallService.bat'' located in the ''AwareIM/bin'' directory where AwareIM is the root directory of your //**AwareIM**// installation.
 +  - Start the services manually or re-boot your machine to make sure that services are automatically started. To start services manually go to the Windows Services manager located in the Administrative Tools folder of the Windows Control Panel. Start Tomcat service first; and then the AwareIM service.
 +
 +<callout type="primary" title="note" icon="true">The ''InstallService.bat'' file installs two services (order of services is important) – Tomcat and AwareIM.</callout>
 +
 +<callout type="primary" title="note" icon="true">When //**AwareIM**// is running as a Windows service you will not be able to run the AwareIM Control Panel. If you want to start the Configuration Tool you need to run the ''ConfigTool.exe'' file located in the ''AwareIM/ConfigTool/eclipse'' directory.</callout>
 +
 +To uninstall AwareIM services run the ''UninstallService.bat'' file located in the ''AwareIM/bin'' directory. This file stops the services automatically if they are running.
 +