Activation specification properties

Activation specification properties hold the inbound event processing configuration information for a message endpoint. They can be set through the enterprise service discovery wizard or the administrative console.

When you configure the adapter, specify the activation specification properties listed below.

Table 1. Activation specification properties
Property Type Description Bidirectional Transport Support Default Value Required
Archive Directory String Directory where the adapter archives processed event files. Yes None Yes, if Archiving
Processed = true
ArchivingProcessed Boolean Determines if the adapter should archive processed events. Yes True No
AssuredOnceDelivery Boolean Provides assured once only event delivery. If the value is true, the adapter attempts to store XID information in the event store. If the value is false, the adapter will not attempt to store XID information in the Event Store.
Note: Setting the value of this property to false improves adapter performance.
No True Yes
Default Object Name String Name of the business graph that is used by the Data Transformation Framework before delivering an event to an endpoint. For example, the generic wrapper business graph used by the adapter is FlatFileBG. No None No
CreateTable Boolean Determines if the event persistence table gets created automatically or manually. If the value is true and the event persistence table does not exist, then the adapter creates the table. If the value is false, then the adapter does not create the table and the user must manually create the table. No True No
DatabasePassword String Password used by event persistence to obtain the JDBC database connection from the data source. Yes None No
DatabaseSchemaName String Schema name of the database used by event persistence. Yes None No
DatabaseUsername String User name used by event persistence to obtain the JDBC database connection from the data source. Yes None No
DataSourceJNDIName String JNDI name of the data source used by event persistence to obtain the JDBC database connection. The data source must be created in WebSphere Process Server. Yes None Yes
EventTableName String Name of the table used by the adapter for event persistence. This value must be unique for each activation specification instance when multiple activation specification instances are used. Yes None Yes
Event Content Type String Represents the mime type of the event file. No None No
Event Directory String Directory where the event files are stored by the back-end enterprise information system. Yes None Yes
EventFileMask String Specifies the filter for the event files. The file filter is a well-qualified valid regular expression consisting of alphanumeric characters and only the wildcard "*". Yes *.* Yes
EventTypeFilter String List of event types that the adapter can deliver. The adapter will not deliver events that are not in the list. If the list is empty (null), no filter is applied, and all events are delivered. No Null No
Failed Archive Extension String Specifies the file extension used to archive unsuccessfully processed business objects in the input event file. Yes fail No
File Content Encoding String Determines how files are read and written by the adapter. No None No
File Pass By Reference Boolean Determines if the adapter needs to load the contents of a file or just provide information about the directory name and the file name to the endpoint. No false Yes
FilterFutureEvents Boolean If true, the adapter will inspect the timestamp on each event and compare it to the system time. If the event time is ahead of the system time, the event will not be delivered. No false Yes
Include End BO Delimiter Boolean When this property is set to true, the delimiter value specified in the SplitCriteria property is also sent with the business object content for further processing.
Note: This property is valid only if event file splitting is based on a delimiter.
No false No
Original Archive Extension String Specifies the file extension used to archive the original event file. This property also preserves the entire event file for reference in case any of the business objects fail processing. No original Yes
PollPeriod Integer Rate, in milliseconds, which the adapter polls the enterprise information system event store for new inbound events. The poll cycle is established at a fixed-rate. If an the poll cycle is delayed for any reason, for example, the poll cycle takes longer than expected to complete, then the next cycle immediately starts. If the value of this property is set to 0, the adapter will not wait between cycles to begin polling. No 500 Yes
PollQuantity Integer Determines the number of events to deliver to each endpoint per poll cycle. No 1 Yes
Retry Interval Integer Determines the interval of time, in milliseconds, that an adapter uses to reconnect to the enterprise information system after the adapter encounters an inbound connection error. No 60000 (1 minute) No
Retry Limit Integer Specifies the number of times the adapter attempts to reconnect to the enterprise information system before the adapter stops trying. A value of 0 means that the adapter attempts re-connection an unlimited number of times. No 0 (unlimited) No
Sort Event Files String Determines the sorting order of polled event files. The values supported include:
  • Filename - sort in ascending order on file name
  • Timestamp - sort in ascending order on last modified timestamp
  • <Blank> - not sorted
To support globalization, the sorting of file names is provided according to the system locale. The ICU4J package is used to track the locales and the rules corresponding to the locales.
No <blank> (= not sorted) No
Split Criteria String This attribute takes different values based on the value set in the SplittingFunctionClass
Name property.
  • If the SplittingFunctionClass
    Name property is set to a value which splits based on a delimiter, then the SplitCriteria property must contain the delimiter which separates the business objects in the event file.
  • If the SplittingFunctionClass
    Name property is set to a value that splits based on size, then the SplitCriteria property must contain a valid number that represents the size in bytes. If the event file size is greater than this value, it is split into chunks of this value and that number of chunks are posted. If the event file size is less than this value, the entire event file is posted.
When the SplitCriteria property value is set to zero, file splitting is disabled.
Note: During an inbound pass through scenario, if file splitting is based on size, and FilePassByReference property is enabled, then the event files are not split into chunks.
Yes 0 No
Splitting Function Class Name String Uses the fully qualified class name in order to split event files. This property takes either of the following two class values:
  • com.ibm.j2ca.
    extension.utils.filesplit.
    SplitByDelimiter - A class which splits the event file based on a delimiter that separates business objects in the event file
  • com.ibm.
    j2ca.utils.
    filesplit.SplitBySize - A class which splits event files based on the size of the event file.
The delimiter or file size is set in the SplitCriteria property.
Note: If the EventContentType property is null, then this property is automatically set to the class name that splits files based on size.
No com.ibm.
j2ca.utils.
filesplit.
SplitBySize
No
Stop polling on error Boolean Stops the adapter when an error is encountered during polling. No false No
Success Archive Extension String Specifies the file extension used to archive all the successfully processed business objects. No success Yes

FlatFileActivationSpec properties are the properties that are applicable only to the 6.0.1 version of the Adapter for Flat Files. These properties are necessary for backward compatibility and migration, where the adapter will support two activation specifications. However, there is no scenario to run the enterprise service discovery wizard for the 6.0.1 version properties for inbound processing. Rather, running the enterprise service discovery wizard for inbound processing is with respect to 6.0.2 configuration only.

Table 2. FlatFileActivationSpec properties
Property Type Description Bidirectional Transport Support Default Value Required
AutocreateEDT   If the value of this property is set true, an in-memory table is created and the event management framework uses this table to track event delivery. No True Yes
EDTDatabaseName   Name of the database used by the event management framework. No None Yes
EDTDriverName   Name of the driver for the EDT database. No None Yes
EDTTableName   Name of the table on the EDT database used by the event management framework. No None Yes
EDTUserName   User ID credential to access the EDT DB No None Yes
EDTUserPassword   Password credential to access the EDT DB No None Yes
FFEventTableName   Name of the table that will be utilized by the adapter for tracking event status values. Yes FFLOG Yes
FFDatabaseName   This is the database that is used internally by the adapter for inbound operations. Yes FFDB Yes
FileChunkSize   Specifies the size of each chunk in bytes, when the file needs to be split into chunks. When the property FileSplitThreshold is empty, this property is disabled. Yes 8000 No
FileSplitThreshold   Specifies the threshold file size for splitting files in bytes. All files above this file size are split into chunks. When this attribute is empty, file splitting is disabled. Yes -1 No
Related reference
Resource adapter properties
Managed (J2C) connection factory properties

Terms of use |


(c) Copyright IBM Corporation 2005, 2006.
This information center is powered by Eclipse technology (http://www.eclipse.org)