%META:TOPICPARENT{name="UDAMTRulesBookSettings"}%
=Multi-Tier Rulebook Settings: {{{[generic_agentname]}}} =

Each Database Agent will have a section that is typically called "{{{generic_}}}" followed by a database label. For example: {{{[generic_virt]}}}, {{{[generic_odbc]}}}, {{{[generic_db2]}}}.


|  *Parameter*                     |  *Default*           |  *Comment*                                               |
|<code><nop>Program</code>         |                      | name of the executable to run                         |
|<code><nop>Environment</code>     |                      | specify Environment section to use                    |
|<code><nop>CommandLine</code>     |                      | commandline options (optional)                         |
|<code><nop>ServerOptions</code>   |                      | force DBMS-specific client options (optional)          |
|<code><nop>Directory</code>       |                      | where to chdir before starting the Agent          |
|<code><nop>Database</code>        |                      | force name of the database (optional)               |
|<code><nop>ConnectOptions</code>  |                      | force DBMS-specific connect options (optional)     |
|<code><nop>UserID</code>          |                      | force userid (optional)                             |
|<code><nop>Password</code>        |                      | force password (optional)                         |
|<code><nop>ReadOnly</code>        |  <code>No</code>     | force read-only mode (optional)                        |
|<code><nop>OpsysLogin</code>      |  <code>No</code>     | when set to Yes, the Request Broker will do an operating system login before spawning. This implies {{{ReUse = ifsame user}}}. (optional)|
|<code><nop>NeedsCLI</code>        |                      | (VMS only) Use CLI to spawn the agent                     |
|<code><nop>ReUse</code>           |  <code>never</code>  | Defines how an agent will be re-used. See below for details of the [[ReUse Parameter]].       |

== <nop>CommandLine parameter ==

The <code><nop>CommandLine</code> value can include any or all of the following options:

* **<code>+noautocommit</code>** -- This means that all connections routed (by the mapping rules) through this agent section will have autocommit behaviour turned off. This is useful if your client-side application relies on manual commits of its transactions; you can define a mapping rule to match only that application and add <code>+noautocommit</code>, while other applications use a different agent section.
* **<code>+maxrows</code>** -- This defines the maximum number of rows to fetch from any query.
* **<code>+initsql</code>** -- Specifies a file with a set of SQL statements to execute immediately when each connection is established. For example, this can be useful to set transaction isolation levels, if your application assumes them to be set a specific way.
* **<code>+jetfix</code>** -- This enables various workarounds for operation with the Microsoft Jet Engine, e.g., through MS Access or MS Query. Particularly, data type mappings may be changed for greater accuracy using these applications.
* **<code>+norowsetlimit</code>** -- This disables any rowset-size limit; it is useful in cursor operations on large tables.

== <nop>ReUse parameter ==

<code>always</code> is implied by all values other than <code>never</code>.

|  *<nop>ReUse Value*             |  *When is agent re-used*  |
|<code>never</code>               | never reuse this instance (default)  |
|<code>always</code>              | always try to reuse this instance  |
|<code>upto &lt;n&gt;</code>      | allow at most n connection to the same instance  |
|<code>ifreadonly</code>          | allow only read-only requests  |
|<code>ifsame database</code>     | group connection requests that alias to the same database  |
|<code>ifsame process</code>      | group connections with the same calling process id (pid)  |
|<code>ifsame options</code>      | group connections specifying the same connect options  |
|<code>ifsame application</code>  | group connections from same application alias  |
|<code>ifsame user</code>         | group connections from the same username  |
|<code>ifsame machine</code>      | group connections from the same client host  |
|<code>ifsame opsys</code>        | group connections from the same operating system  |