Installation

The Cmobilecom Installer will install the Cmobilecom AF on windows or linux, creating tables in a database schema. The installer can optionally install Tomcat 8 as a application server and deploy Cmobilecom AF into the Tomcat instance.

Preparations

Run Installer

  1. Run setup.bat(Windows) or setup.sh(Linux) with administration privilege from the [cmobilecom.af.dir] directory.
  2. Welcome page: select language and install type. The language selected is for installation only. Install type: install.
  3. License: read license carefully. It is required to accept the license for installation.
  4. Installation directory and system password. The installation directory, called "cmobilecom.home", must be empty if exists. If it does not exist, it will be created. The password is required to login into the system instance.
  5. Select database type. The supported databases are listed under [cmobilecom.af.dir]/conf/db with XML descriptors. To support other databases, see the Database Support section.
  6. Database information. Make sure the database is running with transaction enabled and UTF-8 character set. The installer will create a schema for the system instance and create tables within the schema. If the schema exists, the installer will use the schema, but it will not change anything in the schema.

    Database and username consist of letters, digits and underscores. dash(-) is not allowed.

  7. Install application server. If the installation zip does not contain any application server installers, this step will be skipped.

    Select whether to install a new application server and the application server to install. The Cmobilecom AF will be deployed to the selected application server that is to be installed.

    To deploy Cmobilecom AF to a running application server, choose not to install application server. After the installation is completed, Cmobilecom AF needs to be manually deployed to the target application server. see Manual Deployment.

    If the service name is not empty, the application server will be installed as a service. The existing service with the same name(if any) will be removed. You can change HTTP port number and check whether to start the service.

    Select whether to empty existing deployed applications that comes with application server. If yes, Cmobilecom AF will be deployed under root context. Otherwise, it will be deployed under the context cmobilecom-af-[version].

  8. Confirm and Install: confirm everything is correct and start installation.
After installation is completed, open a web browser:
	http://localhost:port/cmobilecom-af-[version]
For example,
	http://localhost:8088/cmobilecom-af-5.12
Login with username "system" and the password that is set at Step 4.

If the application server is installed as a service, its default service name is cmobilecom.

Start/stop on windows:

	net start cmobilecom
	net stop cmobilecom
Start/stop on Linux:
	service cmobilecom start
	service cmobilecom stop

Manual Deployment

Cmobilecom AF can be manually deployed to a running application server.

Application Servers

Suppose cmobilecom.home is E:\cmobilecom_test (Windows), /usr/cmobilecom_test (Linux).

Install License

  1. Obtain evaluation or commercial license files from Cmobilecom license cloud.
  2. Copy Cmobilecom AF license file to [cmobilecom.home]/license/system/license.af.
  3. If any module requires license, copy module license file to [cmobilecom.home]/license/system/license. One license file covers all modules.
  4. Refresh licenses from system module, or restart server.

Database Support

Mysql and Oracle 11g are supported out of box, and they also serve as examples to create XML db descriptors and seed sql files for other databases. Note that other databases are not tested with Cmobilecom AF.

To support a database, xyz for instance, its XML db descriptor xyz-descriptor.xml must be provided and put under [cmobilecom.af.dir]/conf/db. See the Database Descriptors of Cmobilecom AF Developer Guide for detail.

In addition, database seed sql files for all the modules must be provided for creating tables in schema. For installation, seed sql files need to be put under [cmobilecom.af.dir]/seed, and their relative paths are: [moduleName]/db/[dbmsType]/seed.sql. For example,

System/db/xyz/seed.sql
System/db/xyz/seed-sys.sql
Website/db/xyz/seed.sql
ExampleHR/db/xyz/seed.sql
For runtime, seed sql files need to be pacakaged in a jar inside war, and their entry names are the same as the relative paths under [cmobilecom.af.dir]/seed. For example,
System/db/xyz/seed.sql
System/db/xyz/seed-sys.sql
Website/db/xyz/seed.sql
ExampleHR/db/xyz/seed.sql
Note that moduleName and dbmsType are case sensitive.

Silent Install

To intsall Cmobilecom AF silently in text mode, uncomment related lines, for example, on windows:
set "JAVA_OPTS=%JAVA_OPTS% -Dsilent=true -Dtext.mode=true -Dverbose=true"
set "ANSWER_FILE=answer.properties"
or invoke Cmobilecom installer directly:
java -Dsilent=true -Dtext.mode=true -jar installer/cmobilecom-install-3.1.jar answer.properties
An answer.properties file must be provided for silent install in text mode. For example,

MySql database:

cmobilecom.home=C\:\\cmobilecom
system.admin.username=system
system.admin.password=123456

install.new.dbms=false
dbms.type=mysql
dbms.host=localhost
dbms.port=3306
db.sysadmin.username=root
db.sysadmin.password=welcome8
db.name=cmobilecom
db.username=cmobilecom
db.password=welcome
db.user.host=localhost
db.schema.name=cmobilecom
dbms.home=C\:\\mysql

data.backup.enabled=true
data.backup.dir=D\:\\CmobilecomBackup
data.backup.timeOne=12\:30
data.backup.timeTwo=20\:00
data.backup.keepCount=50
data.backup.namePrefix=Backup-

# desktop and mobile themes
theme=dot-luv
#mobile.theme=mobile-theme-1

install.app.server=true
as.name=tomcat
as.http.port=8088
as.service.name=cmobilecom
as.service.display.name=Cmobilecom AF/Tomcat8
as.service.description=Cmobilecom AF/Tomcat8
as.start.service=true
as.empty.apps=true
Oracle 11g XE database:
cmobilecom.home=C\:\\cmobilecom
system.admin.username=system
system.admin.password=123456

install.new.dbms=false
dbms.type=oracle
dbms.host=localhost
dbms.port=1521
db.sysadmin.username=system
db.sysadmin.password=welcome8
db.name=XE
db.username=cmobilecom
db.password=welcome
db.user.host=localhost
db.schema.name=cmobilecom
dbms.home=C\:\\oraclexe\\app\\oracle\\product\\11.2.0\\server

data.backup.enabled=true
data.backup.dir=D\:\\CmobilecomBackup
data.backup.timeOne=12\:30
data.backup.timeTwo=20\:00
data.backup.keepCount=50
data.backup.namePrefix=Backup-

# desktop and mobile themes
theme=dot-luv
#mobile.theme=mobile-theme-1

install.app.server=true
as.name=tomcat
as.http.port=8088
as.service.name=cmobilecom
as.service.display.name=Cmobilecom AF/Tomcat8
as.service.description=Cmobilecom AF/Tomcat8
as.start.service=true
as.empty.apps=true
Change directories and database configuration according to your environment.

Troubleshooting

In case of errors, check [cmobilecom.af.dir]/log/install.log for detail.

Common Issues:

Uninstall

Miscellaneous