SAP Adapter Properties
The following list describes the SAP adapter properties. The properties are listed in alphabetical order. Each of the following entries contains a property name, a description, and a default (if applicable):
Adapter Home
adapterHome
The directory containing the adapter /conf directory. This property is required if the adapter is run in process.
Character Locale
charTypeLocale
The operating system locale used to interpret the encoding of data being sent to and from SAP. This property is optional. The default value is the C locale.
This property is related to the encoding property. The encoding property specifies the Java identifier for the encoding; the charTypeLocale specifies the operating system locale for the same type of encoding.
Client
client
The client number to be used when connecting to SAP. This property is required.
Classification Prefix
classificationPrefix
A parameter name prefix that implies any parameter beginning with this prefix is a classification characteristic. This property is optional.
Database Host
dbHost
The name of the machine on which the SAP library is running. This property is required. The default value is localhost.
Database Port
dbPort
The port number to which the SAP library is listening. This property is required.
Document Number
documentNumber
The SAP field name for a document number. Used by Update-Document-Info-Record, Add-Document-Link, and Delete-Document-Link. This property is optional. The default value is DOC_NUMBER.
Document Part
documentPart
The SAP field name for a document part. Used by Update-Document-Info-Record, Add-Document-Link, and Delete-Document-Link. This property is optional. The default value is DOC_PART.
Document Type
documentType
The SAP field name for document type. Used by Update-Document-Info-Record, Add-Document-Link, and Delete-Document-Link. This property is optional. The default value is DOC_TYPE.
Document Version
documentVersion
The SAP field name for the document version. Used by Update-Document-Info-Record, Add-Document-Link, and Delete-Document-Link. This property is optional. The default value is DOC_VERS.
Encoding
encoding
The character encoding applied to data sent to SAP. This property is optional. The default value is ISO8859_1.
This property is related to the charTypeLocale property. Refer to the example under charTypeLocale for more information.
Language
language
The language code to be used when connecting to SAP. This property is required.
Log File
logFile
The name of a file to contain various output messages. This property is required.
Message Locale
messageLocale
The operating system locale that to use in localizing text messages. This property is optional. The default value for Java and C messages is the JVM default locale. For example, enUS.ISO8859-1.
Maximum Number of Connections in Pool
maxNoOfConnectionsInPool
The maximum connections allowed in the pool. If the pool is exhausted, the connection request waits for the time specified in the Maximum Wait Time property for the release of at least one connection. If no connection is released during this waiting period, an exception is thrown.
This property is optional. A value of 5 is used if the property is not specified.
|
This field accepts an integer value that falls between the range of 1 through 100. However, this range is configurable by editing the property form.
|
Maximum Threads
socketAccess.maxThreadCount
The maximum number of concurrent request threads allowed against each adapter instance. The value is a positive integer. Setting this value to an integer greater than 100 allows more concurrent connections, but also requires more resources (memory and CPU cycles).
Maximum Wait Time
maxWaitTime
Specifies the maximum time (in seconds) to wait in a connection request for a free connection when the specified pool is exhausted. This property is optional.
|
This field accepts an integer value that falls between the range of 1 through 60. However, this range is configurable by editing the property form.
|
Password
password
The password to be used when connecting to SAP. This property is required.
SAP R/3 Host
r3Host
Specifies the hostname to be used when connecting to SAP. This property is only used by the Execute-RPC webject. This property is required.
|
HPUX might require IP addresses instead of host names for this property.
|
Run SAP Library
runSaplib
Specifies whether or not the SAP library is automatically invoked by the SAP adapter. This property is optional. The default value is TRUE.
SAP Library Connection Attempts
saplibConnectAttempts
The maximum number of times SAP adapter attempts to connect with the SAP library. The interval between attempts is 2 seconds. This property is optional. The default value is 30.
System Number
systemNumber
The system number to be used when connecting to SAP. This property is required.
User
user
The user name to be used when connecting to SAP. This property is required.
Verbose
verbose
Controls the amount of log output. Set this property to true to increase the output volume. This property is optional.
The default for this property is false.