<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- Installing cosTransactions</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/cosTransactions-1.2.12.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>cosTransactions</strong><br><strong>User's Guide</strong><br><small>Version 1.2.12</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Chapters</strong></small></p>
<ul class="flipMenu" imagepath="../../../../doc/js/flipmenu">
<li id="no" title="The cosTransactions Application" expanded="false">The cosTransactions Application<ul>
<li><a href="ch_contents.html">
Top of chapter
</a></li>
<li title="Content Overview"><a href="ch_contents.html#id61154">Content Overview</a></li>
<li title="Brief Description of the User's Guide"><a href="ch_contents.html#id57422">Brief Description of the User's Guide</a></li>
</ul>
</li>
<li id="no" title="Introduction to cosTransactions" expanded="false">Introduction to cosTransactions<ul>
<li><a href="ch_introduction.html">
Top of chapter
</a></li>
<li title="Overview"><a href="ch_introduction.html#id60972">Overview</a></li>
</ul>
</li>
<li id="loadscrollpos" title="Installing cosTransactions" expanded="true">Installing cosTransactions<ul>
<li><a href="ch_install.html">
Top of chapter
</a></li>
<li title="Installation Process "><a href="ch_install.html#id61216">Installation Process </a></li>
</ul>
</li>
<li id="no" title="cosTransactions Examples" expanded="false">cosTransactions Examples<ul>
<li><a href="ch_example.html">
Top of chapter
</a></li>
<li title="A Tutorial on How to Create a Simple Service"><a href="ch_example.html#id58308">A Tutorial on How to Create a Simple Service</a></li>
</ul>
</li>
<li id="no" title="Resource Skeletons" expanded="false">Resource Skeletons<ul>
<li><a href="ch_skeletons.html">
Top of chapter
</a></li>
<li title="Resource Skeletons"><a href="ch_skeletons.html#id56632">Resource Skeletons</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<h1>3 Installing cosTransactions</h1>
<h3><a name="id61216">3.1
Installation Process </a></h3>
<p>This chapter describes how to install
<span class="bold_code"><a href="cosTransactions.html">cosTransactions</a></span>
in an Erlang Environment.
</p>
<h4>Preparation</h4>
<p>Before starting the installation process for cosTransactions,
the application Orber must be running.</p>
<p>The cosTransactions application must be able to log progress to disk. The log files are
created in the current directory as "oe_name@machine_type_timestamp". Hence, <span class="code">read</span> and
<span class="code">write</span> rights must be granted. If the transaction completes in an orderly fashion the
logfiles are removed, but not if an error, which demands human intervention, occur.</p>
<h4>Configuration</h4>
<p>When using the Transaction Service the <span class="code">cosTransactions</span> application
must be started using either <span class="code">cosTransactions:start()</span> or
<span class="code">application:start(cosTransactions)</span>.
</p>
<p>The following application configuration parameters exist:</p>
<ul>
<li>
<span class="code">maxRetries</span> - default is 40 times, i.e., if a transaction participant is unreachable
the application will retry to contact it <span class="code">N</span> times. Reaching the maximum is considered to be a disaster.</li>
<li>
<span class="code">comFailWait</span> - default is 5000 milliseconds, i.e., before the application
retries to contact unreachable transaction participants the application wait <span class="code">Time</span> milliseconds.</li>
</ul>
<p>Then the <span class="bold_code"><a href="CosTransactions_TransactionFactory.html">Transaction Factory</a></span>
must be started:</p>
<ul>
<li>
<span class="code">cosTransactions:start_factory()</span> - starts and returns a reference to a factory using default configuration parameters.</li>
<li>
<span class="code">cosTransactions:start_factory(Options)</span> - starts and returns a reference to a factory using given configuration parameters.</li>
</ul>
<p>The following options exist:
</p>
<ul>
<li>
<span class="code">{hash_max, HashValue}</span> -
This value denotes the upper bound of the hash value the <span class="bold_code"><a href="CosTransactions_Coordinator.html">Coordinator</a></span> uses.
Default is <span class="code">1013</span>. HashValue must be an integer.</li>
<li>
<span class="code">{allow_subtr, Boolean}</span> -
If set to true it is possible to create <span class="bold_code"><a href="CosTransactions_Coordinator.html">subtransactions</a></span>.
Default is <span class="code">true</span>.</li>
<li>
<span class="code">{typecheck, Boolean}</span> -
If set to to true all transaction operation's arguments will be type-checked.
Default is <span class="code">true</span>.</li>
<li>
<span class="code">{tty, Boolean}</span> -
Enables or disables error printouts to the tty.
If Flag is false, all text that the error logger would have sent to the terminal is discarded.
If Flag is true, error messages are sent to the terminal screen. </li>
<li>
<span class="code">{logfile, FileName}</span> -
This function makes it possible to store all system information in <span class="code">FileName</span> (string()).
It can be used in combination with the tty(false) item to have a silent system,
where all system information are logged to a file.
As default no logfile is used.</li>
<li>
<span class="code">{maxRetries, Integer}</span> -
default is 40 times, i.e., if a transaction participant is unreachable the application will
retry to contact it <span class="code">N</span> times. Reaching the maximum is considered to be a disaster.
This option overrides the application configuration parameter.</li>
<li>
<span class="code">{comFailWait, Integer}</span> -
default is 5000 milliseconds, i.e., before the application retries to contact unreachable
transaction participants the application wait <span class="code">Time</span> milliseconds.
This option overrides the application configuration parameter.</li>
</ul>
<p>The Factory is now ready to use. For a more detailed description see <span class="bold_code"><a href="ch_example.html">Examples</a></span>.
</p>
</div>
<div class="footer">
<hr>
<p>Copyright © 1999-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
