Projects:Bitrock Installers/Technical Documentation

Project Bitrock Installers - Technical Documentation

Overview

This article will explain how to create installers of Openbravo POS for different platforms using Bitrock.

Technical design

Bitrock

At the beginning Bitrock must be installed in the system. To do that download the latest version of Bitrock and install it.

Creating an installer

As the result of using Bitrock similar to Developer Manual an xml file was created:

<project>
    <shortName>openbravopos</shortName>
    <fullName>Openbravo POS</fullName>
    <version>2.30</version>
    <installerFilename></installerFilename>
    <readmeFile>../../Desktop/pos/README</readmeFile>
    <licenseFile>../../Desktop/pos/licensing/gpl-2.0.txt</licenseFile>
    <leftImage>../left.png</leftImage>
    <logoImage>../icon.png</logoImage>
    <splashImage>../splash.png</splashImage>
    <allowLanguageSelection>1</allowLanguageSelection>
    <description>Openbravo POS is a point of sale designed for touch screens</description>
    <enableRollback>1</enableRollback>
    <release>3</release>
    <summary>POS</summary>
    <vendor>openbravo</vendor>
    <componentList>
        <component>
            <name>default</name>
            <description>Default Component</description>
            <canBeEdited>1</canBeEdited>
            <selected>1</selected>
            <show>1</show>
            <desktopShortcutList>
                <shortcut>
                    <comment>Openbravo POS is a point of sale designed for touch screens</comment>
                    <exec>openbravopos</exec>
                    <icon>openbravopos.png</icon>
                    <name>Openbravo POS</name>
                    <path>${installdir}</path>
                    <platforms>all</platforms>
                    <runInTerminal>0</runInTerminal>
                    <windowsExec>start.bat</windowsExec>
                    <windowsExecArgs>${installdir}/start.bat</windowsExecArgs>
                    <windowsIcon>openbravopos.ico</windowsIcon>
                    <windowsPath>${installdir}</windowsPath>
                </shortcut>
            </desktopShortcutList>
            <folderList>
                <folder>
                    <description>Program Files</description>
                    <destination>${installdir}</destination>
                    <name>programfiles</name>
                    <platforms>all</platforms>
                    <shortcutList>
                        <shortcut>
                            <comment>Uninstall</comment>
                            <exec>${installdir}/${uninstallerName}</exec>
                            <icon></icon>
                            <name>Uninstall ${product_fullname}</name>
                            <path>${installdir}</path>
                            <platforms>all</platforms>
                            <runInTerminal>0</runInTerminal>
                             <windowsExec>${installdir}/${uninstallerName}.exe</windowsExec>
                            <windowsExecArgs></windowsExecArgs>
                            <windowsIcon></windowsIcon>
                            <windowsPath>${installdir}</windowsPath>
                        </shortcut>
                    </shortcutList>
                </folder>
                <folder>
                    <description>Program Files</description>
                    <destination>${installdir}</destination>
                    <name>programfileswindows</name>
                    <platforms>windows</platforms>
                </folder>
                <folder>
                    <description>Linux</description>
                    <destination>${installdir}/newfolder</destination>
                    <name>newfolder</name>
                    <platforms>linux</platforms>
                </folder>
            </folderList>
        </component>
    </componentList>
    <parameterList>
        <directoryParameter>
            <name>installdir</name>
            <description>Installer.Parameter.installdir.description</description>
            <explanation>Installer.Parameter.installdir.explanation</explanation>
            <value>${platform_install_prefix}/${product_shortname}-${product_version}</value>
            <default>${platform_install_prefix}/${product_shortname}-${product_version}</default>
            <allowEmptyValue>0</allowEmptyValue>
            <ask>yes</ask>
            <cliOptionName>prefix</cliOptionName>
            <mustBeWritable>yes</mustBeWritable>
            <mustExist>0</mustExist>
            <width>30</width>
        </directoryParameter>
    </parameterList>
 </project>

Now this file will be used as a template for future installers.