---
title: "Installer Behaviour"
canonical: "https://wiki.yellowfinbi.com/space/USER72/2833510/Installer%20Behaviour"
format: markdown
---
> Macro (anchor)



> Macro (toc)

## Overview

These properties directly modify the behaviour of the installer itself.

## Language


### Installer Language

| **Property** | `lang` |
| --- | --- |
| **Value** | The language code to use to display the installer interface in. This must be one of the supported languages:  
 `en` - *English*  
 `ja` - *Japanese*  
 `de` - *German*  
 `es` - *Spanish*  
 `fr` - *French*  
 `nl` - *Dutch*  
 `pt` - *Portuguese (Brazil)* |
| **Default** | If not specified, the graphical installer will display a language selection dialog box. The command-line installer will default to English. |
| **Example** | `lang=fr` |

### Install Language Packs

| **Property** | `action.langpacks` |
| --- | --- |
| **Value** | Set this to `false` if language packs should not be installed into the Yellowfin database. This affects the Yellowfin installation’s interface, not the installer’s interface. |
| **Default** | `true` |
| **Example** | `action.langpacks=false` |

## Out-Of-The-Box Content


### Hide Pack Selection Screen

| **Property** | `action.hidepacks` |
| --- | --- |
| **Value** | Set this to `true` to hide the pack selection screen from the user during installation. In combination with the `option.pack.*` properties, this can be used to force a specific set of packs to be installed. |
| **Example** | `action.hidepacks=true`  
 `option.pack.tutorial=false`  
 `option.pack.geopack.world=false`  
 `option.pack.geopack.us=false` |

### Hide Tutorial Pack

| **Property** | `action.hidepack.tutorial` |
| --- | --- |
| **Value** | Set this to `true` to hide the tutorial content pack on the pack selection screen. In combination with the `option.pack.tutorial` property, this can be used to force the tutorial content pack to be installed or not installed. If action.hidepacks is true, this property is ignored. |
| **Example** | `action.hidepack.tutorial=true`  
 `option.pack.tutorial=true` |

### Hide World GeoPack

| **Property** | `action.hidepack.geopack.world` |
| --- | --- |
| **Value** | Set this to `true` to hide the World Countries GeoPack on the pack selection screen. In combination with the `option.pack.geopack.world` property, this can be used to force the World Countries GeoPack to be installed or not installed. If `action.hidepacks` is `true`, this property is ignored. |
| **Example** | `action.hidepack.geopack.world=true`  
 `option.pack.geopack.world=false` |

### Hide US GeoPack

| **Property** | `action.hidepack.geopack.us` |
| --- | --- |
| **Value** | Set this to `true` to hide the US Zip Codes GeoPack on the pack selection screen. In combination with the `option.pack.geopack.us` property, this can be used to force the US Zip Codes GeoPack to be installed or not installed. If `action.hidepacks` is `true`, this property is ignored. |
| **Example** | `action.hidepack.geopack.us=true`  
 `option.pack.geopack.us=false` |

## Licence


### Yellowfin Licence File

| **Property** | `resource.licencefile` |
| --- | --- |
| **Value** | A Yellowfin licence file resource that is packaged in the installer. If this property is set, the user will not be prompted to select a licence file at installation time.<br>> See [Adding Files to the Installer](https://yellowfin.atlassian.net/wiki/spaces/USER72/pages/2833441) for more information. |
| **Example** | `resource.licencefile=resources/licence.lic` |

## General Options


### Hide Server Port Option

| **Property** | `action.hideserverport` |
| --- | --- |
| **Value** | Set this to `true` to hide the server port option from the user during installation. In combination with the `option.serverport` property, this can be used to force a specific server port. |
| **Example** | `action.hideserverport=true`  
 `option.serverport=81` |

### Hide Windows Service Option

| **Property** | `action.hidewinservice` |
| --- | --- |
| **Value** | Set this to `true` to hide the Windows service option from the user during installation. In combination with the `option.winservice` property, this can be used to force the Windows service to be installed or not installed. This property is ignored on other Operating Systems. |
| **Example** | `action.hidewinservice=true`  
 `option.winservice=false` |

### Windows Service Name

| **Property** | `installer.winservice.name` |
| --- | --- |
| **Value** | The name of the Windows service. This property is ignored if the Windows service is not being installed. |
| **Default** | `Yellowfin` |
| **Example** | `installer.winservice.name=Report Server` |

### Windows Service Description

| **Property** | `installer.winservice.description` |
| --- | --- |
| **Value** | The description of the Windows service. This property is ignored if the Windows service is not being installed. |
| **Default** | Yellowfin Application Server –<br>[http://www.yellowfinbi.com/](http://www.yellowfinbi.com/) |
| **Example** | `installer.winservice.desc=This service starts the Report Server` |

### Enable SQL Logging

| **Property** | `action.debugsql` |
| --- | --- |
| **Value** | Set this to `true` to enable logging of all SQL queries that the installer makes to the configuration database. This will create a log file under the installation directory named `YellowfinInstallSQL-yyyymmdd.log` which contains SQL queries run during installation. |
| **Example** | `action.debugsql=true` |

## Database Options


### Allowed Databases

| **Property** | `action.allowed.databases` |
| --- | --- |
| **Value** | A comma-separated list of databases that the user may choose as the Yellowfin configuration database. The possible values are the same as for the `option.db.dbtype` property. This is used to limit the list of available database types. |
| **Example** | `action.allowed.databases=SQLServer,MySQL,Oracle` |

### Hide All Database Options

| **Property** | `action.hidedboptions` |
| --- | --- |
| **Value** | Set this to `true` to hide all database options from the user during installation. In combination with the `option.db.*` properties, this can be used to force a specific database configuration. |
| **Example** | `action.hidedboptions=true` |

### Do Not Access the Database

| **Property** | `action.nodbaccess` |
| --- | --- |
| **Value** | Set this to `true` to stop the installer from accessing the database. The installer will not set up the required schema or load initial data. Database configuration is still required via the {[option.db.*}} properties (or by the user during installation) as the database configuration parameters have to be inserted into Yellowfin configuration files.  
 This can be useful when installing additional nodes in a clustered environment, where there is a shared database. |
| **Default** | `false` |
| **Example** | `action.nodbaccess=true` |

### Running Custom SQL

> See [Running Custom SQL](https://yellowfin.atlassian.net/wiki/spaces/USER72/pages/2833258) for more information.

## Installation Path


### Hide Installation Path

| **Property** | `action.hideinstallpath` |
| --- | --- |
| **Value** | Set this to `true` to hide the installation path option from the user during installation. In combination with the `option.installpath` property, this can be used to force a specific install location. |
| **Example** | `action.hideinstallpath=true` |

## Installation Components


### Do Not Install Development Files

| **Property** | `action.nodevelopment` |
| --- | --- |
| **Value** | Set this to `true` to stop the installer from creating the development directory. This directory contains source code, examples and documentation that are useful for integrating Yellowfin into other systems. |
| **Default** | `false` |
| **Example** | `action.nodevelopment=true` |

### Only Write the Application .war File

| **Property** | `action.warfileonly` |
| --- | --- |
| **Value** | Set this to `true` to stop the installer from writing any files to the filesystem except the `yellowfin.war` file. This may be useful when installing into an environment with an existing Application Server. |
| **Default** | `false` |
| **Example** | `action.warfileonly=true` |

### Include Yellowfin-branded Content

| **Property** | `action.yellowfincontent` |
| --- | --- |
| **Value** | Set this to `false` to stop the installer from loading any Yellowfin-branded content into the database. This includes the standard email header image and introductory Storyboards. This may be useful when installing a re-branded version of Yellowfin. |
| **Default** | `true` |
| **Example** | `action.yellowfincontent=false` |

## Program Shortcuts


### Do Not Create Start Menu Shortcuts

| **Property** | `action.noshortcuts` |
| --- | --- |
| **Value** | Set this to `true` to stop the installer from creating Start Menu shortcuts on supported Windows systems. This property is ignored on other Operating Systems. |
| **Default** | `false` |
| **Example** | `action.noshortcuts=true` |

### Start Menu Program Group Name

| **Property** | `shortcut.default.programgroup` |
| --- | --- |
| **Value** | Set this to the name of the program group to create when creating Start Menu shortcuts on a supported Windows system. This name must only include characters that are valid in filenames. |
| **Default** | The application name and version. |
| **Example** | `shortcut.default.programgroup=Report Server` |

### Start Server Shortcut Name

| **Property** | `shortcut.startserver.title` |
| --- | --- |
| **Value** | The name of the “Start Server” shortcut in the Start Menu. |
| **Default** | Start Yellowfin Server |
| **Example** | `shortcut.startserver.title=Start Report Server` |

### Start Server Shortcut Description

| **Property** | `shortcut.startserver.description` |
| --- | --- |
| **Value** | The description of the “Start Server” shortcut in the Start Menu. |
| **Default** | Starts the Yellowfin application server |
| **Example** | `shortcut.startserver.description=Starts the Report Server` |

### Start Server Shortcut Icon

| **Property** | `resource.shortcut.startserver.icon` |
| --- | --- |
| **Value** | A resource to use as the icon for the “Start Server” shortcut in the Start Menu. This should point to a Microsoft icon file.<br>> See [Adding Files to the Installer](https://yellowfin.atlassian.net/wiki/spaces/USER72/pages/2833441) for more information. |
| **Example** | `resource.shortcut.startserver.icon=resources/start.ico` |

### Stop Server Shortcut Name

| **Property** | `shortcut.stopserver.title` |
| --- | --- |
| **Value** | The name of the “Stop Server” shortcut in the Start Menu. |
| **Default** | Stop Yellowfin Server |
| **Example** | `shortcut.stopserver.title=Stop Report Server` |

### Stop Server Shortcut Description

| **Property** | `shortcut.stopserver.description` |
| --- | --- |
| **Value** | The description of the “Stop Server” shortcut in the Start Menu. |
| **Default** | Stops the Yellowfin application server |
| **Example** | `shortcut.stopserver.description=Stops the Report Server` |

### Stop Server Shortcut Icon

| **Property** | `resource.shortcut.stopserver.icon` |
| --- | --- |
| **Value** | A resource to use as the icon for the “Stop Server” shortcut in the Start Menu. This should point to a Microsoft icon file.<br>> See [Adding Files to the Installer](https://yellowfin.atlassian.net/wiki/spaces/USER72/pages/2833441) for more information. |
| **Example** | `resource.shortcut.stopserver.icon=resources/stop.ico` |

### Homepage Shortcut Name

| **Property** | `shortcut.homepage.title` |
| --- | --- |
| **Value** | The name of the “Homepage” shortcut in the Start Menu. |
| **Default** | Yellowfin Homepage |
| **Example** | `shortcut.homepage.title=Login to Report Server` |

### Homepage Shortcut Description

| **Property** | `shortcut.homepage.description` |
| --- | --- |
| **Value** | The description of the “Homepage” shortcut in the Start Menu. |
| **Default** | Open the Yellowfin homepage in your web browser. |
| **Example** | `shortcut.stopserver.description=Open the Report Server login page` |

### Homepage Shortcut Icon

| **Property** | `resource.shortcut.homepage.icon` |
| --- | --- |
| **Value** | A resource to use as the icon for the “Homepage” shortcut in the Start Menu. This should point to a Microsoft icon file.<br>> See [Adding Files to the Installer](https://yellowfin.atlassian.net/wiki/spaces/USER72/pages/2833441) for more information. |
| **Example** | `resource.shortcut.homepage.icon=resources/homepage.ico` |

### Windows Service Shortcut Name

| **Property** | `shortcut.winservice.title` |
| --- | --- |
| **Value** | The name of the “Service Properties” shortcut in the Start Menu. This property is ignored if the Windows Service is not installed. |
| **Default** | Yellowfin Service Properties |
| **Example** | `shortcut.winservice.title=Report Server Service Properties` |

### Windows Service Shortcut Description

| **Property** | `shortcut.winservice.description` |
| --- | --- |
| **Value** | The description of the “Windows Service” shortcut in the Start Menu. |
| **Default** | Opens the Service Properties editor |
| **Example** | `shortcut.winservice.description=Open the Report Server Service Properties editor` |

### Windows Service Shortcut Icon

| **Property** | `resource.shortcut.winservice.icon` |
| --- | --- |
| **Value** | A resource to use as the icon for the “Windows Service” shortcut in the Start Menu. This should point to a Microsoft icon file.<br>> See [Adding Files to the Installer](https://yellowfin.atlassian.net/wiki/spaces/USER72/pages/2833441) for more information. |
| **Example** | `resource.shortcut.winservice.icon=resources/winservice.ico` |