A Oracle JCA Adapter Properties

This appendix lists and describes the properties of Oracle JCA Adapters.

This appendix includes the following sections:

Oracle File and FTP Adapters Properties

Table A-1 lists the properties of Oracle File and FTP Adapters.

Table A-1 Properties for Oracle File and FTP Adapters

Property Description

JCA Properties for Oracle File and FTP Adapters

-

PhysicalDirectory

This property specifies the physical input directory or directories to be polled. The parameter is of type String. The inbound directory where the files appear is mandatory. You must specify the physical directory or logical directory.

LogicalDirectory

This parameter specifies the logical input directory to be polled. The parameter is of type String.

UseHeaders

This parameter can be set to true or false. If you need to read file headers and skip reading the payload while using inbound Oracle File and FTP Adapters, then set the UseHeader property to true.

This is typically used in large payload scenarios where the inbound adapter is used as a notifier.

Recursive

If this property is set to true, then the adapter can process all the sub-directories under the main input directory recursively.

PhysicalArchiveDirectory

This property specifies where to archive successfully processed files. The property is of type String and is not mandatory.

LogicalArchiveDirectory

This property specifies the logical directory in which to archive successfully processed files. The property is of type String and is not mandatory.

DeleteFile

If set to true, the Oracle File or FTP Adapter deletes the file after processing.

IncludeFiles

This property specifies the pattern for types of files to pick up during polling. The parameter is of type String and is mandatory.

ExcludeFiles

This property specifies the pattern for types of files to be excluded during polling. The property is of type String and is not mandatory.

PollingFrequency

This parameter specifies how often to poll a given input directory for new files. The parameter is of type int and is mandatory. The default value is 1 minute.

MinimumAge

This parameter specifies the minimum age of files to be retrieved. This enables a large file to be completely copied into the input directory before it is retrieved for processing. The age is determined by the last modified time stamp. For example, if you know that it takes three to four minutes for a file to be written, then set the minimum age of pollable files to five minutes. If a file is detected in the input directory and its modification time is within five minutes of the current time, then the file is not retrieved because it is still potentially being written to.

PublishSize

This property indicates whether the file contains multiple messages and how many messages to publish to the BPEL process at a time. The parameter is of type int and is not mandatory. The default value is 1.

For example, if a certain file has 11 records and this parameter is set to 2, then the file will be processed 2 records at a time and the final record will be processed in the sixth iteration.

Lenient

If set to true, then the Oracle File Adapter does not complain if it does not have enough permission to read or write to the inbound directory. The default value of this property is false.

TriggerFilePhysicalDirectory

The directory path where the Oracle File or FTP Adapter looks for the trigger files.

TriggerFile

The name of the trigger file that activates the inbound Oracle File or FTP Adapter.

TriggerFileStrategy

This property defines the strategy that the Oracle File or FTP Adapter uses to look for the specified trigger file in the trigger file directory. The acceptable values are EndpointActivation, EveryTime, or OnceOnly.

MaxRaiseSize

This property specifies the maximum number of files that the Oracle File or FTP Adapter submits for processing in each polling cycle. For example, if the inbound directory has 1000 files and MaxRaiseSize is set to 100 and the polling frequency is one minute, then the Oracle File or FTP Adapter will submit 100 files every minute.

Distributed

This property specifies whether the Oracle File or FTP Adapter inbound directory is being polled in a distributed fashion. In other words, there are more than one processes polling the same directory in one or more managed servers.

DirectorySeparator

When you choose multiple directories, the generated JCA files use semicolon (;) as the separator for these directories. However, you can change the separator to something else. If you do so, manually add <property name="DirectorySeparator" value="chosen separator"/> in the generated JCA file. For example, to use comma (,) as the separator, you must first change the separator to comma (,) in the Physical directory and then add <property name="DirectorySeparator" value=","/> in the JCA file.

AsAttachment

If set to true, it causes the inbound file to be published as an attachment.

CharacterSet

Set it to the character set for the attachment. This parameter is not used internally by the Oracle File and FTP Adapters, and it is meant for third party applications that process the attachments published by the Oracle File and FTP Adapters.

Encoding

Set it to the encoding used for the attachment. This parameter is not used internally by the Oracle File and FTP Adapters, and it is meant for third party applications that process the attachments published by the Oracle File and FTP Adapters.

ContentType

Set it to the mime-type of the attachment. This parameter is not used internally by the Oracle File and FTP Adapters, and it is meant for third party applications that process the attachments published by the Oracle File or FTP Adapter.

ListSorter

This property specifies the sorter that the Oracle File and FTP Adapters use to sort files in inbound. You can set this parameter to:

  • ListSorter="oracle.tip.adapter.file.sorter.TimestampSorterAscending in order to sort the file names by their modified timestamps in ascending manner or

  • ListSorter="oracle.tip.adapter.file.sorter.TimestampSorterDescending in order to sort the file names by their modified timestamps in descending manner

SingleThreadModel

If the value is true, Oracle File or FTP Adapter poller processes files in the same thread. In other words, it does not use the global in-memory queue for processing.

ThreadCount

If this property is available, then the adapter creates its own processor threads rather than depend on the global thread pool processor threads (by deafult, 4 of them). In other words, this parameter partitions the in-memory queue and each composite application gets its own in-memory queue.

  • If the ThreadCount property is set to 0, then the threading behavior is the same as that of the single-threaded model.

  • If the ThreadCount property is set to -1, then the global thread pool is used, which is the same as the default threading model.

  • The maximum value for the ThreadCount property is 40.

NumberMessages

This property is used for outbound batching. The outgoing file is created when the number of messages condition is met. The parameter is of type int and is not mandatory. The default value is 1.

ElapsedTime

This property is used for outbound batching. When the time specified elapses, the outgoing file is created. The parameter is of type int and is not mandatory. The default value is 1.

FileSize

This property is used for outbound batching. The outgoing file is created when the file size condition is met. The parameter is of type int and is not mandatory. The default value is 1000 KB.

FileNamingConvention

This property is used for the naming convention for the outbound write operation file.

FileName

Use this parameter to specify a static single file name during the write operation.

Append

If this property is set to true, it causes Oracle File and FTP Adapters to append to a file on outbound. If the file does not exist, then a new file is created.

The file name can either be specified in the JCA file for the outbound operation or in the jca.file.FileName header.

UseStaging

If set to true, then the outbound Oracle File or FTP Adapter writes translated data to a staging file, and later it streams the staging file to the target file. If set to false, then the outbound Oracle File or FTP Adapter does not use an intermediate staging file.

ConcurrentThreshold

The maximum number of translation activities that can be allowed to execute in parallel for a particular outbound scenario. The translation step during the outbound operation is CPU-intensive and must be guarded because it might cause other applications or threads to starve. The maximum value is 100 (same as the maximum value for dspMaxThreads in BPEL.)

SequenceName

Specifies the Oracle database sequence name to be used if you have already configured the outbound Oracle File or FTP Adapter for High Availability.

SourceFileName

The source file for the File IO operation.

SourcePhysicalDirectory

The source directory for the File IO operation.

SourceType

Set this to native if the source file is native and xml if the source file is xml.

SourceSchema

Set it to the schema for the source file.

SourceSchemaRoot

Set it to the root element name for the source file.

TargetFileName

The target file for the File IO operation.

TargetPhysicalDirectory

The target directory for the File IO operation.

TargetType

Set this to native if the target file is native and xml if the source file is xml.

TargetSchema

Set it to the schema for the target file.

TargetSchemaRoot

Set it to the root element name for the target file.

Xsl

Set it to the xsl transformer between the source and the target.

Type

Set it to COPY, MOVE, or DELETE.

BatchSize

Set it to the batch size for the batching transformation.

ChunkSize

Set it to the chunk size for the chunked interaction operation.

JCA Properties Specific to Oracle FTP Adapter

-

FileType

Set this property to either ascii or binary depending on the requirement.

UseRemoteArchive

Set this property to true to notify the Oracle FTP Adapter that the archival directory is on the same FTP server. If set to false, the Oracle FTP Adapter uses a local file system folder for archival.

UseNlst

Set this property to true if you want the Oracle FTP Adapter to use the NLST FTP command instead of the LIST command that the adapter uses by default.

SourceIsRemote

Set this property to false if you want to notify the Oracle FTP Adapter that the source for the IO operation is a local file system as opposed to a remote FTP server.

TargetIsRemote

Set this property to false if you want to notify the Oracle FTP Adapter that the target for the IO operation is a local file system as opposed to a remote FTP server.

Binding Properties for Oracle File and FTP Adapters

-

recoveryInterval

This property is used by the inbound adapter to configure the recovery interval in case of errors. For example, if the physical directory is nonexistent, then the adapter uses this value to perform periodic sleep or wakeup checks to check whether the physical directory has been created and is accessible.

jca.message.encoding

This property is used to override the encoding specified in the NXSD schema for inbound Oracle File and FTP Adapters.

oracle.tip.adapter.file.debatching.rejection.quantum

This property lets you control the size of rejected messages for inbound Oracle File and FTP Adapters partner link. For example, if you set it to 100, it will cause the Oracle File and FTP Adapters to reject 100 lines from the file because the actual file is too large.

ignoreListingErrors

Lets you control the behavior of the inbound Oracle File Adapter during the polling operation. If set to true, the Oracle File Adapter does not complain if it is unable to read from a nested folder.

useFileSystem

This property is used by inbound Oracle File and FTP Adapters during read-only polling in a clustered environment. Setting it to true causes the adapter to use the file system to store the metadata of the already processed files. Setting it to false causes the adapter to use a database table.

oracle.tip.adapter.file.timeout.recoverpicked.minutes

This property is used by the inbound highly available adapter when using FILEADAPTER_IN as the coordinator. Remember that when a file is first claimed (enqueued) by a node for processing, the FILE_PROCESSED column in FILEADAPTER_IN is set to 0. At a later point in time, when one of the decoupled processor threads picks up the file for processing, the value of the FILE_PROCESSED column is updated from 0 to 1. And when the file is processed completely, the FILE_PROCESSED column is updated from 1 to 2. However, if the processor thread picks up a file but the node crashes before processing the file, then the file will never be processed. This property is used to undo the pick operation. The adapter does this by deleting the entries in the FILEADAPTER_IN table that have been picked up but not processed within the value specified here.

oracle.tip.adapter.file.timeout.recoverunpicked.minutes

This property is used by the inbound highly available adapter when using FILEADAPTER_IN as the coordinator. Remember that when a file is first claimed by a node for processing, FILE_PROCESSED column in FILEADAPTER_IN is set to 0. Later on, when the decoupled-processor thread picks up the file for processing, the value of the FILE_PROCESSED column is updated from 0 to 1. And when the file is processed completely, the FILE_PROCESSED column is updated from 1 to 2. If the node crashes when the FILE_PROCESSED is still 0, it would mean that the file is enqueued by a node (this means no other nodes can pick this one up). However, it also means that the decoupled processor threads have still not picked this one for processing. This property is used to undo the claim(enqueue_ operation.) The adapter does this by deleting the entries in the FILEADAPTER_IN table that have been claimed (for example, FILE_PROCESSED =="0"), but not picked up till now.

oracle.tip.adapter.file.highavailability.maxRetryInterval

Number of milliseconds after which inbound Oracle File and FTP Adapters retry to establish a database connection in distributed polling scenarios.

oracle.tip.adapter.file.highavailability.maxRetry

Number of times that inbound Oracle File and FTP Adapters retry to establish a database connection in distributed polling scenarios.

oracle.tip.adapter.file.rejectOriginalContent

Setting to true causes Oracle File and FTP Adapters to reject the original content. If set to false, the adapter rejects the XML data created as a result of the translation step.

notifyEachBatchFailure

Setting to true causes the Oracle File or FTP Adapter to call the Notification Agent's onBatchFailure every time an error occurs in a debatching scenario. If set to false, Oracle File and FTP Adapters call onBatchFailure only once after all the messages are debatched.

oracle.tip.adapter.file.mutex

Set it to the class name that specifies the mutex that you want to use for the outbound write operation. This class must extend the oracle.tip.adapter.file.Mutex abstraction.

serializeTranslation

If set to true, then the translation step is serialized using a semaphore. The number of permits for semaphore (guarding the translation step) comes from the ConcurrentThreshold property. If false, then the translation step occurs outside the semaphore.

inMemoryTranslation

This property is applicable only if UseStaging is set to false .If UseStaging is set to true, then the translation step occurs in-memory (that is, an in-memory byte array is created). If set to false, then the adapter creates an output stream to the target file (FTP, FTPS, and SFTP included) and allows the translator to translate and write directly to the stream.

IgnoreZeroByteFile

Set it to true if you do not want Oracle File and FTP Adapters to throw an exception during the outbound read operation, if the file could not be found. This property is ignored if the schema for the inbound file is anything other than Opaque.

Binding Property Specific to Oracle FTP Adapter

-

timestampOffset

This property is used by the Oracle FTP Adapter to handle time zone issues, typically to convert the time difference between the FTP server and the system on which the Oracle FTP Adapter is running to millisecond.

Oracle Socket Adapter Properties

Table A-1 lists the properties of Oracle Socket Adapter.

Table A-2 JCA Properties for Oracle Socket Adapter

Property Description

Host

In case of outbound, the computer name on which the socket server is running, to which you want to connect. In case of inbound, it is always localhost.

Port

In case of outbound, it is the port number on which a socket server is running, to which the adapter will be connecting.

In case of inbound, it is the port number on which the socket adapter listens for incoming connections.

TransMode

Mechanism for defining the protocol. Set to XSLT to use style sheets, set to CustomImpl to use custom Java code, and set to NXSD for plain schema translation.

Xslt

If XSLT is chosen as the TransMode property, then it specifies the path to the stylesheet defining the handshake for inbound request, in case of inbound and outbound request or reply.

ReplyXslt

If XSLT is chosen as the TransMode property, then it specifies the path to the style sheet defining the handshake for inbound reply.

CustomImpl

If CustomImpl is chosen as the TransMode property, then it is the name of the Java class defining the handshake. This property is a concrete implementation of the ICustomParser interface.

ByteOrder

Byte order of the remote machine being communicated with.

Encoding

Character encoding used by the remote computer.

Oracle AQ Adapter Properties

Table A-3 lists the properties of Oracle AQ Adapter.

Table A-3 JCA Properties for Oracle AQ Adapter

Property Description

Normalized Properties

-.

Priority

Priority of the message.

A smaller number indicates a higher priority.

Delay

The number of seconds after which the message is available for dequeuing.

Expiration

The number of seconds before the message expires. This parameter is an offset from the Delay parameter.

Correlation

User-assigned correlation ID.

RecipientList

The list of recipients for this message, separated by commas. This overrides RecipientList in InteractionSpec.

ExceptionQueue

The exception queue name.

EnqueueTime

The time at which the message was enqueued.

MessageID

The hexadecimal representation of the message ID.

OrigMessageId

The hexadecimal representation of the original message ID.

Attempts

The number of failed attempts at dequeuing the message.

Endpoint Properties

-

DequeueTimeOut

It is the interval after which the dequeue() API will time out if no message is received on the inbound queue.

ConnectionRetryDelay

The time for which the Oracle AQ Adapter will wait before trying to re-create a connection after a connection is lost.

Oracle JMS Adapter Properties

Table A-4 lists the properties of Oracle JMS Adapter.

Table A-4 JCA Properties for Oracle JMS Adapter

Property Description

Normalized Properties

NA

jca.jms.JMSDestinationName

The destination to which the message is sent, and is set by the JMS producer.

JMSDeliveryMode

Set to persistent or nonpersistent mode by the JMS producer.

JMSExpiration

Duration of the message before the expiration is set by the producer.

JMSPriority

Number between 0 and 9 set by the consumer. A larger number represents a higher priority.

JMSMessageID

Unique message identifier set by the consumer.

JMSTimestamp

Time stamp when the message was sent to the JMS provider for forwarding.

JMSCorrelationId

Set by both producers and consumers for linking the response message with the request message. This is an optional attribute.

JMSReplyTo

Optional attribute indicating the destination to which to send a message reply. Can be set by the producer and consumer.

JMSType

JMS message type.

JMSRedelivered

Set by the JMS provider to indicate that the provider has tried to send this message once before to the consumer and has failed.

requestReply.useCorrelation

If true, will apply a JMS Message selector for obtaining the reply message.If the Request message header contains a user-specified CorrelationID, it will be used for correlation, otherwise the JMS Message ID property.

Note: the JMS adapter uses the following message selector: "JMSCorrelationID = '<corrId>' [ AND (<wsdlSelector>) ]" where the AND branch only is included if the user has specified a Selector in the WSDL. Default value of this property is true.)

requestReply.cacheReceivers

If the same small number of JMS receivers are used for the same Request destination repeatedly, it will improve performance to set this property to true, but not if this does not apply. Default is false.

adapter.jms.encoding

Used to encode the text message.

adapter.jms.retry.interval

Used by the inbound connection retry layer.

adapter.jms.receive.threads

Supports multiple inbound receivers.

adapter.jms.registration.interval

This value is typically set higher because you do not have to register the MessageListener property too often. Only valid if UseMessageListener=true.

adapter.jms.receive.timeout

Timeout value used for the synchronous receive call. Valid only if UseMessageListener=false.

JMSReplyToDestinationProperties

Declaratively impose custom property settings on Destination objects received during inbound request/reply scenarios.

JMSReplyUseCorrelationIdForCorrelation

Used to specify whether correlation id should be used for correlation. Valid values are true and false.

JMSReplyUseMessageIdForCorrelation

Used to specify whether message id should be used for correlation. Valid values are true and false.

suppressHeaders

Bypass headers. For scenarios in which BPEL application does not use/produce these headers. Improves performance.

Oracle Database Adapter Properties

Table A-5 lists the properties of Oracle Database Adapter.

Table A-5 JCA Properties for Oracle Database Adapter

Property Description

Oracle Database Adapter Instance Properties

-

xADataSourceName

This is a mandatory property. Refers to the JNDI name (jdbc/...) of the tx-level=”global” data source connecting to. All operations using this pool will bind to the global transaction and commit or roll back as a unit.

dataSourceName

This is a mandatory property. Refers to the JNDI name (jdbc/...) of the tx-level=”local” data source connecting to. All operations using this pool will be locally transacted, independent on the global transaction. If both xADataSourceName and dataSourceName are specified, then the latter will be used for READ operations.

platformClassName

This is a mandatory property. This points to the type of database being connected to. The suggested values for this property are:

  • Oracle11Platform

  • Oracle10Platform

  • Oracle9Platform

  • Oracle8Platform

  • DB2Platform

  • InformixPlatform

  • SybasePlatform

  • SQLServerPlatform

  • MySQL4Platform

  • DatabasePlatform

You also can give the full package and class name of a subclass of oracle.toplink.platform.database.DatabasePlatform. For DB2 on AS/400, Oracle recommends that you give the value of oracle.tip.adapter.db.toplinkext.DB2AS400Platform.

usesNativeSequencing

The default value if TRUE. If any SOA services are configured to automatically assign sequence numbers on INSERT operation, then a TRUE value indicates that the sequence values are coming from a database native sequence.

usesBatchWriting

The default value is TRUE. Multiple identical statements will be executed as a single batch statement. You must only disable this property for certain JDBC drivers that have known issues.

logTopLinkAll

The default value is FALSE. You must increase DB Adapter logging to include all underlying TopLink log messages at maximum granularity. This property provides maximum visibility, but adapter logging is already tuned to show the most relevant TopLink SQL logging.

Normalized Message Properties

-

jca.db.XADataSourceName

Outbound.

jca.db.DataSourceName

Outbound.

jca.db.UserName

Outbound. You cannot assign values to the jca.db.userName property on Oracle WebLogic Server because its data source does not support setting user name dynamically to the getConnection method.

jca.db.Password

Outbound. You cannot assign values to the jca.db.password property on Oracle WebLogic Server because its data source does not support setting password dynamically to the getConnection method.

jca.db.CursorName

Inbound/Outbound

Oracle MQ Series Adapter Properties

Table A-6 lists the properties of Oracle MQ Series Adapter.

Table A-6 JCA Properties for Oracle MQ Series Adapter

Property Description

jca.mq.MQMD.AccountingToken

Inbound/Outbound

jca.mq.MQMD.ApplIdentityData

Inbound/Outbound

jca.mq.MQMD.ApplOriginData

Inbound/Outbound

jca.mq.MQMD.BackoutCount

Inbound/Outbound

jca.mq.MQMD.CodedCharSetId

Inbound/Outbound

jca.mq.MQMD.CorrelId

Inbound/Outbound

jca.mq.MQMD.Encoding.Integer

Inbound/Outbound

jca.mq.MQMD.Encoding.Decimal

Inbound/Outbound

jca.mq.MQMD.Encoding.Float

Inbound/Outbound

jca.mq.MQMD.Expiry

Inbound/Outbound

jca.mq.MQMD.Feedback

Inbound/Outbound

jca.mq.MQMD.Feedback.ApplicationDefined

Inbound/Outbound

jca.mq.MQMD.Format

Inbound/Outbound

jca.mq.MQMD.GroupId

Inbound/Outbound

jca.mq.MQMD.MsgFlags.IsMsgInGroup

Inbound/Outbound

jca.mq.MQMD.MsgFlags.IsLastMsgInGroup

Inbound/Outbound

jca.mq.MQMD.MsgFlags.IsSegment

Inbound/Outbound

jca.mq.MQMD.MsgFlags.IsLastSegment

Inbound/Outbound

jca.mq.MQMD.MsgId

Inbound/Outbound

jca.mq.MQMD.MsgSeqNumber

Inbound/Outbound

jca.mq.MQMD.MsgType

Inbound/Outbound

jca.mq.MQMD.MsgType.ApplicationDefined

Inbound/Outbound

jca.mq.MQMD.Offset

Inbound/Outbound

jca.mq.MQMD.OriginalLength

Inbound/Outbound

jca.mq.MQMD.Persistence

Inbound/Outbound

jca.mq.MQMD.Priority

Inbound/Outbound

jca.mq.MQMD.PutApplName

Inbound/Outbound

jca.mq.MQMD.PutApplType

Inbound/Outbound

jca.mq.MQMD.PutApplType.UserDefined

Inbound/Outbound

jca.mq.MQMD.PutDateTime

Inbound/Outbound

jca.mq.MQMD.ReplyToQMgr

Inbound/Outbound

jca.mq.MQMD.ReplyToQ

Inbound/Outbound

jca.mq.MQMD.Report.Generate.CorrelId

Inbound/Outbound

jca.mq.MQMD.Report.Generate.MsgId

Inbound/Outbound

jca.mq.MQMD.Report.Generate.COA

Inbound/Outbound

jca.mq.MQMD.Report.Generate.COD

Inbound/Outbound

jca.mq.MQMD.Report.Generate.Exception

Inbound/Outbound

jca.mq.MQMD.Report.Generate.Expiry

Inbound/Outbound

jca.mq.MQMD.Report.Generate.NAN

Inbound/Outbound

jca.mq.MQMD.Report.Generate.PAN

Inbound/Outbound

jca.mq.MQMD.Report.TakeAction.OnMsgDeliveryFailure

Inbound/Outbound

jca.mq.MQMD.StrucId

Inbound/Outbound

jca.mq.MQMD.UserIdentifier

Inbound/Outbound

jca.mq.MQMD.Version

Inbound/Outbound

jca.mq.Inbound.MQMD.CorrelId

Outbound

jca.mq.Inbound.MQMD.MsgId

Outbound

jca.mq.Inbound.MQMD.MsgType

Outbound

jca.mq.Inbound.MQMD.Nan

Outbound

jca.mq.Inbound.MQMD.Pan

Outbound

jca.mq.Inbound.MQMD.ReplyToQMgr

Outbound

jca.mq.Inbound.MQMD.ReplyToQ

Outbound

jca.mq.Inbound.MQMD.Report.Generate.CorrelId

Outbound

jca.mq.Inbound.MQMD.Report.Generate.MsgId

Outbound

jca.mq.ISpec.EnqueueMsgToQMgr

Outbound

jca.mq.ISpec.EnqueueMsgToQ

Outbound