Getting Started

This topic provides a brief tutorial to help you get started with InformixHQ.

Prerequisites

The following table lists the software prerequisites for InformixHQ.
Software Required Version
Informix Database Server 12.10 or higher
Java 1.8

Starting InformixHQ

InformixHQ Server or Agent can be started using any of following methods:
  • Java Command
  • Script

Using Java Command

For more information about using Java Command, see Starting the InformixHQ Server and Starting the InformixHQ Agent.

Using the Script:

The script to start the server or agent is in the form of InformixHQ.bat (Windows), InformixHQ.sh (Bash Shell for Linux) and InformixHQ.ksh (Korn shell for AIX) file on various operating system as per the requirement of the user.
Note: This script is indicative and users are free to modify/tune the scripts as per their requirements/environments.
Script Prerequisites
  • Server and Agent jar file names should end with .jar and also must contain keyword “informixhq" in its name
  • If using default filename option with scripts, jar and properties files with default names should be present in same folder as that of script
  • User running the script must have read and write access to informixhq-server.log and informixhq-agent.log files
  • If log files don’t exist in the same folder from where HQ jar is running, HQ will create these files, so user running the script should have permissions to be able to create these files.
  • Environment variable JAVA_HOME should be set correctly to JAVA 1.8 and should be included in PATH variable.

This script support BASH shell on linux (.sh), KORN shell on AIX (.ksh) and command prompt on windows (.bat). This command starts/stops InformixHQ Server and Agent.

Syntax:
InformixHQ [startserver|startagent] [encoding=<value>] [jvmmemx=<value>] [jarfile=<value>] [propfile=<value>]
InformixHQ [stop <processid>]
InformixHQ [stopserver]
InformixHQ [stopagent] [<properties filename search string>]
InformixHQ [list] [<filename search string>]
    startserver              : Starts InformixHQ Server service
    startagent               : Starts InformixHQ Agent service
    stop                     : Stops InformixHQ Server/Agent with specified processid
    stopserver               : Stops InformiHQ Server process
    stopagent                : Stops InformixQ Agent process (default all processes or filtered list if matching filename search string found)
    list                     : Lists InformixHQ running processes (default all processes, filtered list if matching filename search string found)
    encoding (Optional)      : Default value is utf-8
    jvmmemx (Optional)       : JVM's default value will be used, if not specified
    jarfile (Optional)       : Default is informixhq-server.jar for startServer option and informixhq-agent.jar for startAgent option
                               For user provided filename, it must contain keyword 'informixhq' and it should end with .jar"
    propfile (Optional)      : Default is informixhq-server.properties for startServer option and informixhq-agent.properties for startAgent option
                               User can provide any custom name to properties file

For more information about using the script, see Starting the InformixHQ Server and the Agent on Windows and Starting the InformixHQ Server and the Agent on Linux/AIX.