WebSphere Message Broker, Version 8.0.0.7 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

Inbound adapter properties for JD Edwards

Inbound adapter properties hold the inbound event processing configuration information for a message endpoint. These properties also control the general operation of the adapter. Use the Adapter Connection wizard to set these properties.

The following table lists the properties for inbound processing that you set by using the Adapter Connection wizard. A more detailed description of each property is provided in the sections that follow the table.
Property Description
Adapter ID to use for logging and tracing (AdapterID) The name of the adapter instance in the log and trace files.
Auto acknowledge (AutoAcknowledge) Specifies the event acknowledge mode that is used.
Delivery type (DeliveryType)

Determines the order in which events are delivered by the adapter to the export component.

Ensure once-only event delivery (AssuredOnceDelivery)

Specifies whether the adapter provides assured once-only delivery of events.

Failed events folder The absolute path to the file folder on the local system where unsuccessfully processed events are archived in file format.
Retry limit for failed events The number of times the adapter attempts to deliver an event before marking the event as failed.
Interval between polling periods (PollPeriod)

The length of time that the adapter waits between polling periods.

Maximum connections (MaximumConnections)

The maximum number of connections that the adapter can use for inbound event delivery.

Maximum events in polling period (PollQuantity)

The number of events that the adapter delivers to the export component during each poll period.

Minimum connections (MinimumConnections)

The minimum number of connections that the adapter can use for inbound event delivery.

No wait (NoWait) Specifies whether the adapter waits for a time interval to get an event from the JD Edwards EnterpriseOne transaction server by calling the Dynamic Java™ Connector API.
Retry EIS connection on startup Controls whether the adapter retries the connection to the JD Edwards EnterpriseOne transaction server if it cannot connect at startup.
Retry interval if connection fails (RetryInterval)

The length of time that the adapter waits between attempts to establish a new connection after an error occurs during inbound operations.

Stop the adapter when an error is encountered while polling (StopPollingOnError)

Specifies whether the adapter stops polling for events when it encounters an error during polling.

Wait time (WaitTime) Specifies the waiting time if the No Wait property is set to false.

Adapter ID to use for logging and tracing (AdapterID)

This property identifies a specific deployment, or instance, of the adapter.

Required Yes
Default 001
Property type String
Usage This property identifies the adapter instance in the log and trace files, and also helps identify the adapter instance while monitoring adapters. The adapter ID is used with an adapter-specific identifier, JDERA, to form the component name used by the Log and Trace Analyzer tool. For example, if the adapter ID property is set to 001, the component ID is JDERA001.

If you run multiple instances of the same adapter, ensure that the first eight characters of the adapter ID property are unique for each instance so that you can correlate the log and trace information to a particular adapter instance. By making the first seven characters of an adapter ID property unique, the component ID for multiple instances of that adapter is also unique, allowing you to correlate the log and trace information to a particular instance of an adapter.

For example, when you set the adapter ID property of two instances of WebSphere® Adapter for JD Edwards EnterpriseOne to 001 and 002. The component IDs for those instances, JDERA001 and JDERA002, are short enough to remain unique, enabling you to distinguish them as separate adapter instances. However, instances with longer adapter ID properties cannot be distinguished from each other. If you set the adapter ID properties of two instances to Instance01 and Instance02, you will not be able to examine the log and trace information for each adapter instance because the component ID for both instances is truncated to JDERAInstance.

For inbound processing, this property is retrieved from the resource adapter properties. For outbound processing, it is retrieved from the managed connection factory properties.

Globalized Yes
bidi supported No

Auto acknowledge (AutoAcknowledge)

This property specifies the event acknowledge mode that is used. You can specify either the auto acknowledge mode or the client acknowledge mode.
Required No
Possible values

True
False

Default False
Property type Boolean
Usage Specifies the event acknowledge mode, which is either the auto acknowledge mode or the client acknowledge mode.
Example False
Globalized No
bidi supported Yes

Delivery type (DeliveryType)

This property specifies the order in which events are delivered by the adapter to the export component.

Required No
Possible values

ORDERED
UNORDERED

Default ORDERED
Property type String
Usage The following values are supported:
  • ORDERED: The adapter delivers events to the export component one at a time.
  • UNORDERED: The adapter delivers all events to the export component at once.
Globalized No
bidi supported No

Ensure once-only event delivery (AssuredOnceDelivery)

This property specifies whether to provide ensured once-only event delivery for inbound events.

Required Yes
Possible values

True
False

Default True
Property type Boolean
Usage When this property is set to True, the adapter provides assured once-only event delivery so that each event is delivered only once. A value of False does not provide assured once event delivery, but provides better performance.

When this property is set to True, the adapter attempts to store transaction (XID) information in the event store. If it is set to False, the adapter does not attempt to store the information.

This property is used only if the export component is transactional. If it is not, no transaction can be used, regardless of the value of this property.

Globalized No
bidi supported No

Failed events folder

This property specifies the file folder on the local system where unsuccessfully processed events are archived in file format.

Required No
Possible values No default value
Default Null
Property type String
Usage Create this folder manually on the same system before the adapter is run. If no failed events folder is specified, the adapter does not archive unsuccessfully processed events.
Globalized Yes
bidi supported No

Retry limit for failed events (FailedEventRetryLimit)

This property specifies the number of times that the adapter attempts to deliver an event before marking the event as failed.

Required No
Possible values Integers
Default 5
Property type Integer
Usage Use this property to control how many times the adapter tries to send an event before marking it as failed. It accepts the following values:
Default
If this property is not set, the adapter tries five additional times before marking the event as failed.
0
The adapter tries to deliver the event an infinite number of times. When the property is set to 0, the event remains in the event store and the event is never marked as failed.
> 0
For integers greater than zero, the adapter retries the specified number of times before marking the event as failed.
< 0
For negative integers, the adapter does not retry failed events.
Globalized No
bidi supported No

Interval between polling periods (PollPeriod)

This property specifies the length of time for which the adapter waits between polling periods.

Required Yes
Possible values Integers greater than or equal to 0.
Default 2000
Unit of measure Milliseconds
Property type Integer
Usage The poll period is established at a fixed rate, so that if running the poll cycle is delayed for any reason (for example, if a prior poll cycle takes longer than expected to complete), the next poll cycle occurs immediately to make up for the lost time that was caused by the delay.
Globalized No
bidi supported No

Maximum connections (MaximumConnections)

This property specifies the maximum number of connections that the adapter can use for inbound event delivery.

Required No
Default 1
Property type Integer
Usage Only positive values are valid. The adapter considers any positive entry less than 1 to be equal to 1. Typing a negative value or 0 for this property might result in runtime errors.
Globalized No
bidi supported No

Maximum events in polling period (PollQuantity)

This property specifies the number of events that the adapter delivers to the export component during each poll period.

Required Yes
Default 10
Property type Integer
Usage The value must be greater than 0. If this value is increased, more events are processed per polling period, and the adapter might perform less efficiently. If this value is decreased, fewer events are processed per polling period, and the performance of the adapter might improve slightly.
Globalized No
bidi supported No

Minimum connections (MinimumConnections)

This property specifies the minimum number of connections that the adapter can use for inbound event delivery.

Required No
Default 1
Property type Integer
Usage Only positive values are valid. Any value less than 1 is treated as 1 by the adapter. Typing a negative value or 0 for this property might result in runtime errors.
Globalized No
bidi supported No

No wait (NoWait)

This property specifies whether the adapter waits for a time interval to get an event from the JD Edwards EnterpriseOne transaction server by calling the Dynamic Java Connector API.
Required No
Possible values

True
False

Default True
Property type Boolean
Usage Specifies whether the adapter waits for a time interval to get an event from the JD Edwards EnterpriseOne transaction server by calling the Dynamic Java Connector API.
Example True
Globalized No
bidi supported Yes

Number of times to retry the system connection (RetryLimit)

This property specifies the number of times that the adapter tries to reestablish an inbound connection.

Required No
Possible values Positive integers
Default 0
Property type Integer
Usage Only positive values are valid.

When the adapter encounters an error that is related to the inbound connection, this property specifies the number of times that the adapter tries to restart the connection. A value of 0 indicates an infinite number of retries.

Globalized Yes
bidi supported No

Retry EIS connection on startup (RetryConnectionOnStartup)

This property controls whether the adapter attempts to connect again to the JD Edwards EnterpriseOne server if it cannot connect at startup.

Required No
Possible values

True
False

Default False
Property type Boolean
Usage This property indicates whether the adapter retries the connection to the JD Edwards EnterpriseOne server if the connection cannot be made when the adapter is started.
  • Set the property to False when you want immediate feedback about whether the adapter can establish a connection to the JD Edwards EnterpriseOne server; for example, when you are building and testing the application that receives events from the adapter. If the adapter cannot connect, the adapter writes log and trace information, and stops. The application status is shown as Stopped. After you resolve the connection problem, start the adapter manually.
  • Set the property to True if you do not need immediate feedback about the connection. If the adapter cannot connect during startup, it writes log and trace information, and then attempts to reconnect, by using the RetryInterval property to determine how frequently to retry and the value of the RetryLimit property to retry multiple times until that value is reached. The application status is shown as Started.
Globalized No
bidi supported No

Retry interval if connection fails (RetryInterval)

When the adapter encounters an error that is related to the inbound connection, this property specifies the length of time that the adapter waits before trying to establish a new connection.

Required Yes
Default 2000
Unit of measure Milliseconds
Property type Integer
Usage Only positive values are valid. When the adapter encounters an error that is related to the inbound connection, this property specifies the length of time that the adapter waits before trying to establish a new connection.
Globalized Yes
bidi supported No

Stop the adapter when an error is encountered while polling (StopPollingOnError)

This property specifies whether the adapter stops polling for events when it encounters an error during polling.

Required No
Possible values

True
False

Default False
Property type Boolean
Usage If this property is set to True, the adapter stops polling when it encounters an error.

If this property is set to False, the adapter logs an exception when it encounters an error during polling, and continues polling.

Globalized No
bidi supported No

Wait time (WaitTime)

This property specifies the waiting time if the No Wait property is set to false.
Required No
Possible values Any positive integer. Any negative integer is treated as the default value (3000 milliseconds)
Default 3000
Unit of measure Milliseconds
Property type Integer
Usage This property specifies the waiting time if the No Wait property is set to false.
Example 5000
Globalized No
bidi supported Yes
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2016Copyright IBM Corporation 1999, 2016.

        
        Last updated:
        
        Last updated: 2016-05-23 14:48:35


Reference topicReference topic | Version 8.0.0.7 | rbp_jde_inbound_props_WMB