---
title: "User Options"
canonical: "https://wiki.yellowfinbi.com/space/USER72/2833267/User%20Options"
format: markdown
---
> Macro (anchor)



> Macro (toc)

## Overview

Properties in this section are used to provide initial values for the user entry options in the installer. When using the graphical and command-line installers, these will be used as defaults that the user can override at installation time. Certain user options can be hidden from the user, in which case they cannot override the values provided for these properties.

When using the silent installer, these options must be used to specify the installation parameters.

## Out-Of-The-Box Content


### Tutorial Pack Installation

| **Property** | `option.pack.tutorial` |
| --- | --- |
| **Value** | Set this to `true` or `false` to determine whether to install the Ski Team tutorial database and sample content. |
| **Default** | `true` |
| **Example** | `option.pack.tutorial=true` |

### World GeoPack Installation

| **Property** | `option.pack.geopack.world` |
| --- | --- |
| **Value** | Set this to `true` or `false` to determine whether to install the World Countries GeoPack. |
| **Default** | `false` |
| **Example** | `option.pack.geopack.world=true` |

### US GeoPack Installation

| **Property** | `option.pack.geopack.us` |
| --- | --- |
| **Value** | Set this to `true` or `false` to determine whether to install the US GeoPack. |
| **Default** | `false` |
| **Example** | `option.pack.geopack.us=true` |

## Licence


### Licence File Location

| **Property** | `option.licencefile` |
| --- | --- |
| **Value** | The path to the Yellowfin licence file. This value should be the full path to the licence file which should exist on the installation target computer at install time. |
| **Example** | `option.licencefile=/usr/local/yellowfin.lic` |

## General Options


### Server Port

| **Property** | `option.serverport` |
| --- | --- |
| **Value** | The server port that Yellowfin will use. This value should be a valid port number between 1 and 65535. At installation time, the installer checks if the port is available. If not, a warning is displayed to the user. |
| **Default** | Selects an available port starting with 8080 |
| **Example** | `option.serverport=8080` |

### Windows Service

| **Property** | `option.winservice` |
| --- | --- |
| **Value** | Set to `true` to install a Windows Service. This property is ignored on other Operating Systems. |
| **Default** | `false` |
| **Example** | `option.winservice=true` |

## Database Selection


### Database Type

| **Property** | `option.db.dbtype` |
| --- | --- |
| **Value** | The database type to use for the Yellowfin configuration database. The available values are:  
 `AS400` - *(AS/400 DB2)*  
 `CacheDB`  
 `DB2`  
 `HSQLDB` - *(Embedded database)*  
 `Ingres`  
 `MySQL`  
 `Oracle`  
 `PostgreSQL`  
 `Progress` - *(Progress 9)*  
 `SQLServer` - *(Microsoft SQL Server)*  
 `SQLServerAzure` - *(Microsoft SQL Server Azure)*  
 `SybaseASA` - *(Sybase SQL Anywhere / IQ)*  
 `SybaseASE` - *(Sybase ASE)* |
| **Example** | `option.db.dbtype=PostgreSQL` |

### Progress JDBC Driver

| **Property** | `option.db.progressdriver` |
| --- | --- |
| **Value** | The location of the Progress JDBC driver file. This file should exist on the installation target computer (not the computer where the installer is built). This is ignored for other database types. |
| **Example** | `option.db.progressdriver=/usr/local/dlc/java/jdbc.jar` |

### Database Hostname

| **Property** | `option.db.hostname` |
| --- | --- |
| **Value** | The Yellowfin configuration database server hostname. |
| **Example** | `option.db.hostname=localhost` |

### Database Port

| **Property** | `option.db.port` |
| --- | --- |
| **Value** | The Yellowfin configuration database server port. If this value is omitted, the default port for the selected database type will be used. |
| **Example** | `option.db.port=5432` |

### Database Name

| **Property** | `option.db.dbname` |
| --- | --- |
| **Value** | The Yellowfin configuration database name. |
| **Example** | `option.db.dbname=yellowfin` |

### Create New Database

| **Property** | `option.db.createdb` |
| --- | --- |
| **Value** | Set to `true` to create a new database to use as the Yellowfin configuration database. This property is ignored if the selected database type does not support creating databases. |
| **Example** | `option.db.createdb=true` |

### SQL Server Instance Name

| **Property** | `option.db.sqlinstance` |
| --- | --- |
| **Value** | The instance name to use when connecting to SQL Server. This property is ignored for other database types. If this value is omitted, the default instance will be used. |
| **Example** | `option.db.sqlinstance=MyInstance` |

### SQL Server Authentication Type

| **Property** | `option.db.sqlauthtype` |
| --- | --- |
| **Value** | The authentication type to use when connecting to SQL Server. This property is ignored for other database types. This should be set to `windows` or `sqlserver`. |
| **Default** | `sqlserver` |
| **Example** | `option.db.sqlauthtype=windows` |

### SQL Server Logon Domain

| **Property** | `option.db.sqldomain` |
| --- | --- |
| **Value** | The logon domain to use when connecting to SQL Server with authentication type set to `windows`. |
| **Example** | `option.db.sqldomain=MyDomain` |

### Database Username

| **Property** | `option.db.username` |
| --- | --- |
| **Value** | The username used to connect to the Yellowfin configuration database. |
| **Example** | `option.db.username=myuser` |

### Database Password

| **Property** | `option.db.userpassword` |
| --- | --- |
| **Value** | The user password used to connect to the Yellowfin configuration database. |
| **Example** | `option.db.userpassword=password` |

### Create New Database User

| **Property** | `option.db.createuser` |
| --- | --- |
| **Value** | Set to `true` to create a new database user to use when connecting to the Yellowfin configuration database. This property is ignored if the selected database type does not support creating database users. |
| **Example** | `option.db.createuser=true` |

### Database Administrator Username

| **Property** | `option.db.dbausername` |
| --- | --- |
| **Value** | The database administrator username, used to connect to the database to create the database or database user. If neither of the **Create New Database** and **Create New Database User** options are set to `true`, this property is ignored. |
| **Example** | `option.db.dbausername=admin` |

### Database Administrator Password

| **Property** | `option.db.dbapassword` |
| --- | --- |
| **Value** | The database administrator user password, used to connect to the database to create the database or database user. If neither of the **Create New Database** and **Create New Database User** options are set to `true`, this property is ignored. |
| **Example** | `option.db.dbapassword=password` |

## Installation Path


### Installation Path

| **Property** | `option.installpath` |
| --- | --- |
| **Value** | The path to install Yellowfin into. This value should be the full path name to install Yellowfin into. The directory will be created if it does not already exist. |
| **Example** | `option.installpath=/usr/local/Yellowfin` |

### Installation Folder Name

| **Property** | `installer.installfolder` |
| --- | --- |
| **Value** | This property sets the default name for the installation folder. In the graphical installer, the installation folder will be defaulted to a folder with this name, in an Operating System-specific location. |
| **Default** | `The application name and version.` |
| **Example** | `installer.installfolder=Report Server 7.1` |