ObjectGears Help

Forum   ObjectGears (Version:

System installation

ObjectGears system consists of several components that are installed separately. Therefore, proceed with following steps that describe the new installation. Upgrade of the system is described in the bottom part of this page. Upgrade omits some steps, however, it is basically the same process.


In order to start ObjectGears system it is necessary to have following components installed on server(s):

  • .NET Framework 4.0 or newer
  • Internet Information Server (IIS)
  • Microsoft SQL Server

Detailed system requirements.

Installation of a new system

Multiple server instances

According to the licence model you can create more ObjectGears system instances. You can operate these multiple instances on a single server. Instances do not interfere, however, they have to have different names. We speak about names of folders with ObjectGears files and names of databases.

We recommend to use some naming conventions. Choose name OG and suffix according to the environment type for the database:

Database name Environment
OG_dev Development environment
OG_test Test environment
OG_acc Acceptance environment
OG_acc_2 Second acceptance environment
OG Production environment
OG_2 Second production environment

Names of another instances can contain numbers or you can use real names according to the instance purpose. We recommend to keep the same name for the database and folders with system files.

Create the folder OG for the files on the disc and then subfolders for particular instances. We you want to operate both web part, win service and admin tool on a single server, then copy all these components in a single subfolder. Hence, you will have everything for one instance together. Therefore, you can create a copy for a new instance in a fast way or delete the existing one.

Saving all the instances into a single folder simplifies you also future back up of all the instances at ones.

Preliminary steps

We state here an overview for .NET Frameworku installation and creation of application on IIS for completeness purpose. It is a basic approach and may differ from your current version. However, it will be basically same.

Installation package

Unpack the ZIP file with installation. Folder contents are:

Folder Description
Administration Administration tool.
Documentation Folder with documentation.
LicenceCreator Utility for creating license file.
Piklo Utility for reading data from Active Directory and other functions.
Web Web part of the system.
WinService Programme for the windows service.
x_Sql_update.sql Upgrade scripts for the database.
db.bak Database backup.
1_Sql_Create DB - Empty.sql Script for database creation.
1_Sql_Create DB - With models.sql Script for database creation including models.

Creating objects in the database

In order to create objects in the database execute one of scripts 1_Sql_Create DB - Empty.sql or 1_Sql_Create DB - With models.sql. Run the script in an empty database that you prepared.

Installation of the web part

In order to install web part just copy all the files from the folder Web from the installation files into in advance prepared folder on IIS (see preliminary steps).

Installation of the WinService

You can find description of installation here.

After starting the web part and creating the first user you can also start the windows service. This is performed by executing the file winservice-install.bat.

After the execution check the service in Windows, whether it is running. In the Windows Event log check, what the service logged and whether it handles a correct folder. (That in case of operating more services on a single server.)

You can stop and restart the service in Windows according to your needs. 

Installation of the administration tool

Administration tool is used by administrator. It does not need any configuration and does not need to be on the same server like web part or windows service. The only condition for a correct functioning is available connection from the ObjectGears database.

Installation of Piklo

Piklo tool does not need any configuration. It shall be only saved in the folder that will be availale for the Windows Service and the web part. If these components are placed on various servers, then copy Piklo to both servers.

Back up after installation

After an successful installation and system start we recommend to create a folder on another folder where you will back up system files. We recoomend to perform the first back up immediately after the installation.

Create back up files by means of new folders with names "instance_name_YYYY_MM_DD". Therefore, you will have a history of previous versions, that will be useful when you need to go more days back for the restore.

Create the back up for case of unintended file deletion, error or disk failure.  You will then always have a possibility to get to the last valid installation within couple of minutes.

Back up plan

We recommend to create a plan of regular back up (daily, weekly...) - both database and files of the ObjectGears system web part. Back up the webpart when you are changing files with themes, custom scripts or users are uploading pictures to web...

You will then have always possibility to get back to a working versions in case of a sudden error. Such error may consist in data or file deletion, physical disk damage etc. 

System upgrade

System upgrade is similar to the new system installation. It is necessary to perform back up of some file for case of going back to the old version.

Stopping current system

  • Stop the winservice by means of Windows tool Services
  • Stop the web by means of Internet Information Services administration.

Back up

Create database full backup in the first step because it will be changes during upgrade. Process for back up creation shall be found in the database documentation.

Create a back up of the whole folder Web on IIS in the second step. THe reason for that is that during operation of the system you may have updated system file, e.g.:

  • web.config
  • files with styles in folder Styles
  • file with custom javascript in folder Scripts
  • themes in folder App_Themes
  • users could have uploaded user pictures in folder ImagesData
  • ...etc

Database upgrade

Excute SQL script 1_Sql_update.sql in the installation files.

Update of web part

Update of the web part can be split in two steps:

Overwrite all the files from the web part from upgrade files (folder Web) in folder on IIS.

Overwrite your changed files from the back up you created before the upgrade back to the folder on IIS. These are changed styles, custom javascripts, themes, web.config, pictures from ImagesData...

Note these changed files for a fast system upgrade, optionally use a batch file that will copy them back in a fast way.

Start the web by means of Internet Information Services administration.

Update of WinService

You have to first uninstall current Windows service. This can be performed by executing file winservice-uninstall.bat from the operation folder of the web service (not from the upgrade folder). Before executing it check it contents wheather there is correctly selected 32/64 bit version according to the OS on server and wheather there are correctly set access paths.

After that load files from the upgrade folder (folder WinService) into Windows service folder.

Chack and configure files winservice-install.bat and winservice-uninstall.bat. They are likely same as for prevois version.

Start the new windows service by means of file winservice-install.bat.

After execution check wheather the winservice is running. In the Windows Event log check what the service has logged and wheather it handles the correct folder. (That in case of operating more OG services on a single server.)

You can stop and restart the service according to your needs. 

Upgrade of Administrator tool

You just overwrite files from upgrade (folder Administration) in folder with Administration tool.

Upgrade of Piklo

You just overwrite  files from upgrade (folder Piklo) in folder with Piklo and that both for Windows Service and web part. Like in case of a first installation.   

Back up after upgrade

We recommend to create back up after a succesful upgrade and system start. Proceed with the same steps like after the initial installation.

This website is using cookies files to provide services and analyse visits. You agree with that by using this website.     Further information