<!doctype html>
<html>
<head>
<title>Installation Options</title>
<link rel="stylesheet" href="styles/site.css" type="text/css">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="styles/icons.css" type="text/css">
<script src="js/jquery.min.js"></script>
<script src="tree/collapsibleTreeMenu.js"></script>
<link href="tree/collapsibleTreeMenu.css" rel="stylesheet" type="text/css">
</head>
<body class="theme-default aui-theme-default">
<div id="page">
<div id="main" class="aui-page-panel">
<div id="main-header">
<div id="breadcrumb-section">
<ol id="breadcrumbs">
<li> <span><a href="Rhapsody-Integration-Engine-6.5_133160975.html">Rhapsody Integration Engine 6.5</a></span> </li>
<li> <span><a href="Installing-or-Upgrading-Rhapsody_133164145.html">Installing or Upgrading Rhapsody</a></span> </li>
<li> <span><a href="Installing-Rhapsody_133164241.html">Installing Rhapsody</a></span> </li>
<li> <span><a href="Unattended-Installations_133164341.html">Unattended Installations</a></span> </li>
<li> <span><a href="Installing-the-Rhapsody-Engine-Unattended_133164357.html">Installing the Rhapsody Engine Unattended</a></span> </li>
</ol>
</div>
<h1 id="title-heading" class="pagetitle"> <span id="title-text">Installation Options</span> </h1>
</div>
<div id="content" class="view">
<div id="main-content" class="wiki-content group">
<p>The options that can be specified in the <code>.varfile</code> are:</p>
<div class="table-wrap">
<table class="wrapped confluenceTable">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<th class="confluenceTh"><p>Variable</p></th>
<th class="confluenceTh"><p>Description</p></th>
</tr>
<tr>
<td class="confluenceTd"><p><code>windows.service.account</code></p></td>
<td class="confluenceTd"><p>The<em> Windows®</em> service account username.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>windows.service.description</code></p></td>
<td class="confluenceTd"><p>The description of the <em>Windows®</em> service.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>windows.service.name</code></p></td>
<td class="confluenceTd"><p>The name under which you want to register the <em>Windows®</em> service.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>windows.service.name.display</code></p></td>
<td class="confluenceTd"><p>The display name of the <em>Windows®</em> service.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>windows.service.password.encoded</code></p></td>
<td class="confluenceTd"><p>The<em> Windows®</em> service account password.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>windows.program.group</code></p></td>
<td class="confluenceTd"><p>The name of the Rhapsody program group in the <em>Windows®</em> Start menu.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>windows.service.startType</code></p></td>
<td class="confluenceTd"><p>The start type of the <em>Windows®</em> service: either automatic or by demand (manually). To start the service automatically, set the variable to <code>Auto Start</code>. Setting the variable to any other value requires the service to be started manually. For production environments, the service should be set to start automatically.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>windows.launch.engine$Boolean</code></p></td>
<td class="confluenceTd"><p>Whether the Rhapsody engine should start after installation completes [<code>true/false</code>].</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>windows.launch.monitor$Boolean</code></p></td>
<td class="confluenceTd"><p>Whether the <strong>Rhapsody Service Monitor</strong> icon, on the <em>Windows®</em> taskbar, should start after installation completes [<code>true/false</code>].</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>jvm.initial</code></p></td>
<td class="confluenceTd"><p>The initial size of the JVM heap.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>jvm.maximum</code></p></td>
<td class="confluenceTd"><p>The maximum heap size.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>port.admin</code></p></td>
<td class="confluenceTd"><p>The administration port.</p></td>
</tr>
<tr>
<td colspan="1" class="confluenceTd"><code>port.broadcast</code></td>
<td colspan="1" class="confluenceTd"><p><span style="color: rgb(0,0,0);">The Rhapsody IDE broadcast port.</span></p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>port.http.management</code></p></td>
<td class="confluenceTd"><p>The Management Console HTTP port.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>port.https.management</code></p></td>
<td class="confluenceTd"><p>The Management Console HTTPS port.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>port.https.webservice.api</code></p></td>
<td class="confluenceTd"><p>The web service API HTTPS port.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>prop.user.name</code></p></td>
<td class="confluenceTd"><p>The Unix user to run Rhapsody as.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>dir.data</code></p></td>
<td class="confluenceTd"><p>The location of the Data directory.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>sys.installationDir</code></p></td>
<td class="confluenceTd"><p>The installation directory.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>sys.languageId</code></p></td>
<td class="confluenceTd"><p>The two-letter ISO 639 code for the actual language of the installer.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>uninstall.data</code></p></td>
<td class="confluenceTd"><p>Deletes all Rhapsody data, including configuration data [<code>true/false</code>].</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>uninstall.logs</code></p></td>
<td class="confluenceTd"><p>Deletes all Rhapsody engine logs [<code>true/false</code>].</p></td>
</tr>
</tbody>
</table>
</div>
<h2 id="InstallationOptions-CommandLineOptions">Command Line Options</h2>
<p>The Rhapsody installer can be run in three modes:</p>
<div class="table-wrap">
<table class="wrapped confluenceTable">
<tbody>
<tr>
<th class="confluenceTh"><p>Mode</p></th>
<th class="confluenceTh"><p>Description</p></th>
</tr>
<tr>
<td class="confluenceTd"><p><code>-q</code></p></td>
<td class="confluenceTd"><p>Unattended mode. Does not interact with the user during installation.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>-c</code></p></td>
<td class="confluenceTd">
<div class="content-wrapper">
<p>Console mode. Queries for each option on the command line. On <em>Windows®, </em>ensure you use the mode as follows:</p>
<div class="code panel pdl" style="border-width: 1px;">
<div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: bash; gutter: false; theme: Confluence" data-theme="Confluence">start /wait installer.exe -c </pre>
</div>
</div>
</div></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>-g</code></p></td>
<td class="confluenceTd"><p>GUI mode (default on <em>Windows®</em>).</p></td>
</tr>
</tbody>
</table>
</div>
<p>The following parameters are only valid when used with the unattended mode:</p>
<div class="table-wrap">
<table class="wrapped confluenceTable">
<tbody>
<tr>
<th class="confluenceTh"><p>Parameter</p></th>
<th class="confluenceTh"><p>Description</p></th>
</tr>
<tr>
<td class="confluenceTd"><p><code>-dir [directoryPath]</code></p></td>
<td class="confluenceTd"><p>Sets the installation directory.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>-splash [title]</code></p></td>
<td class="confluenceTd"><p>Displays a small window with a progress bar and the specified title, and informs the user about the progress of the installer.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>-wait [timeout]</code></p></td>
<td class="confluenceTd"><p>A timeout in seconds. In unattended mode, the installer carries out the installation immediately. On <em>Windows®</em>, this can lead to locking errors if the installer is called by an updater or a launcher. If <code>-wait</code> is specified, the installer will wait for all installed launchers and installers (including the updater) to shut down. If this does not happen before the specified timeout, the installer exits with an error message.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>-console</code></p></td>
<td class="confluenceTd"><p>On <em>Windows®</em>, allocates a console and displays the installer output. Must be used as <code>-q -console</code>.</p></td>
</tr>
</tbody>
</table>
</div>
<p>The following parameters are used to control installation options:</p>
<div class="table-wrap">
<table class="wrapped confluenceTable">
<tbody>
<tr>
<th class="confluenceTh"><p>Parameter</p></th>
<th class="confluenceTh"><p>Description</p></th>
</tr>
<tr>
<td class="confluenceTd"><p><code>-V [variableName=value]</code></p></td>
<td class="confluenceTd"><p>You can set arbitrary installer variables with the <code>-V</code> parameter. The variable name should be used without a prefix, so if you have a variable called <code>\${installer:variableName</code>} in the GUI, the parameter would be <code>-V variableName=value</code>. The variable will be a String object.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p><code>-varfile [fileName]</code></p></td>
<td class="confluenceTd"><p>The property file containing your installation options.</p></td>
</tr>
</tbody>
</table>
</div>
<h2 id="InstallationOptions-References">References</h2>
<ul>
<li><a href="http://resources.ej-technologies.com/install4j/help/doc/help.pdf" class="external-link" rel="nofollow">install4j Manual</a></li>
</ul>
<p> </p>
</div>
</div>
</div>
</div>
</body>
</html>