IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > Flat Files > Configure the module for deployment > Configure the module for inbound processing

Setting deployment and runtime properties

After you have decided whether your module is to be used for outbound or inbound communication with the enterprise information system (local file system), configure the activation specification properties, which hold the inbound event processing configuration information for the export.

Before you can set the properties in this section, create your adapter module. It is displayed in IBM Integration Designer below the adapter project. For more information about creating the adapter project, see Starting the external service wizard.

To set the activation specification properties, follow this procedure. For more information about the properties in this topic, see Activation specification properties.


Procedure

  1. In the Select the Processing Direction window, select Inbound and click Next.

    Figure 1. Selecting inbound or outbound in the external service wizard

  2. In the Specify the Security and Configuration Properties window, in the Deploy connector project field, select With module for use by single application.

  3. In the Specify the Security and Configuration Properties window, define the activation specification properties for your module. For more details on the properties found on this window, see Activation specification properties.

    Figure 2. Setting the connection properties

  4. In the Event directory field, specify the directory in the local file system where the event files are stored.

  5. Click Advanced and expand the Event polling configuration, Event delivery configuration, Event persistence configuration, Additional configurationCluster deployment settings, File archiving configuration, Bidi properties, and Logging and tracing sections to specify values as needed.

    • Event polling configuration

      1. In the Interval between polling periods (milliseconds) field, type the time in milliseconds, that the adapter waits between polling periods. For more information about the property, see Interval between polling periods (PollPeriod).

      2. In the Maximum events in polling period field, type the number of events to deliver in each polling period. For more information about the property, see Maximum events in polling period (PollQuantity).

      3. In the Time between retries in case of case of system connection failure (in milliseconds) field, type the time in milliseconds, that the adapter waits before trying to connect after a connection failure during polling. See Time between retries in case of system connection failure (RetryInterval).

      4. In the Maximum number of retries in case of system connection failure field, type the number of times the adapter tries again the connection before reporting a polling error. See Maximum number of retries in case of system connection failure (RetryLimit).

      5. If you want the adapter to stop if polling errors occur, select the Stop the adapter when an error is encountered while polling check box. If you do not select this option, the adapter logs an exception but continues to run. See Stop the adapter when an error is encountered while polling (StopPollingOnError).

      6. Select Retry EIS connection on startup.

        If you select this property, the adapter continues trying to connect to a system to which it failed to connect when starting. For more information, see Retry EIS connection on startup (RetryConnectionOnStartup).

      7. Select the calendar based scheduling option to create calendar based polling for inbound activities.

        You can schedule your business activities, when you create a new calendar in IBM Integration Designer. The option of working with the calendar based scheduling feature is only possible with IBM Integration Designer as the tooling environment. The following figure helps you to schedule a calendar polling option.

        Figure 3. Polling based on business calendar

        You can either select a blank calendar or create a new calendar for a module or library.

        When you select a blank calendar, you will not be able to set predefined time intervals. You have to define your time intervals. When you create a calendar using a predefined template, you can define time intervals for each template.

        • To select an existing calendar for a module or library, click Browse. In the Select a Business Calendar window, you can search for existing calendar files ( *cal) in the IBM Integration Designer workspace.

          1. In the Filter by name field, type the calendar name or name pattern. The calenders matching the pattern are displayed in the Matching business calendars area.

          2. Select a calendar and click OK to return to the external service wizard.

        • To create a new calendar entry for a module or library, click New. The Create a business calendar window is displayed.

          1. In the Module or library field, click Browse to select an existing calendar module or click New to create a module for the new calendar.

          2. In the Folder field, click Browse to select an existing folder or create a new folder for the calendar.

          3. In the Name field, enter a name for the new calendar.

            • To create a non template calendar, click Finish. Or

            • To generate the calendar based on a predefined template, click Next. In the Use a template window, select the Create a calendar using one of the templates check box and click Finish.

            The new business calendar is created and available in the Business Integration view. Once you complete the wizard, you can view or modify the calendar schedules in the Business Integration view using the Business Calendar Editor. You can modify the intervals and exceptions, or add new entries for these elements. For more details about working with business calendars, see Business calendars.

        You must deploy the Business Calendar module to the same IBM BPM or WebSphere Enterprise Service Bus instance, along with the inbound application. If you do not map these two connections to the same server instance, the inbound application using the business calendar will by default, poll as there is no calendar configured.

      8. In the FlatFile specific polling properties section, you can retrieve a file by using one of the following properties. When any one of the properties is selected, the other property is automatically disabled.

        • In the Time interval for polling unchanged files (in milliseconds) field, you can specify if the adapter retrieves only those files that are not changed during the specified time interval. See Time interval for polling unchanged files (in milliseconds).

        • Select Poll event files for modified content check box to specify if the adapter polls the files that changed since the last recorded time stamp. See Poll event files for modified content.

          This property is disabled if you select the Pass only file name and directory, not the content property.

        • Select the Include only the newly appended content check box to deliver the appended file contents to the endpoint. This property is enabled when you select the Poll event files for modified content check box. See Include only the newly appended content.

          Figure 4. Configure the polling properties

    • Event delivery configuration

      1. In the Type of delivery field, select the delivery method. The methods are described in Delivery type (DeliveryType).

        The HA Active-Active configuration supports only unordered delivery type events. If the delivery type specified is ORDERED, then the adapter throws a runtime exception error.

      2. If you want to ensure that events are delivered only once and to only one export, select the Ensure assured-once event delivery check box. This option might reduce performance but does not result in duplicate or missing event delivery. For more information, see Ensure once-only event delivery (AssuredOnceDelivery).

      3. In the Retry limit for failed events field, specify the number of times to try to deliver an event after a delivery failure. See Retry limit for failed events (FailedEventRetryLimit).
    • Event persistence configuration

      In a HA Active-Active configuration, ensure that you provide values for the mandatory event persistence properties. If a value is not assigned to any of the event persistence properties, then the adapter throws a runtime exception error.

      1. Select Auto create event table check box if you want the adapter to create the Event Persistence table. See Auto create event table.

      2. In the Event recovery table name field, you can specify the name of the table that the adapter uses for event persistence. If you specify the Event recovery table name field, you must enter value in the Table name to store the file processing status field, to specify the table name that the adapter uses for file processing. See Event recovery table name and Table name to store the file processing status (EP_FileTableName) properties.

      3. In the Event recovery data source (JNDI) name field, specify the JNDI name of the data source that event persistence uses to connect to the JDBC database. See Event recovery data source (JNDI) name.

      4. In the User name used to connect to event data source field, specify the user name that the event persistence uses to connect to the database from the data source. See User name used to connect to event data source.

      5. In the Password used to connect to event data source field, specify the password that the event persistence uses to connect to the database from the data source. See Password used to connect to event data source.

      6. In the Database schema name field, specify the schema name of the database that the event persistence uses. See Database schema name.

      7. In the Time interval for processing the fetched events (in seconds) field, specify the time interval for the adapter to process the fetched events. See Time out period for HA Active-Active event processing change (in seconds) (EP_Timeout).

    • Additional configuration

      1. In the Retrieve files with this pattern field, specify the filter for the event files. See Retrieve files with pattern.

      2. Select Include business object delimiter in the file content check box to specify if the delimiter value specified in the SplitCriteria property is sent with the business object content for further processing. See Include business object delimiter in the file content.

      3. In the Retrieve files in sorted order list, specify sorting order of polled event files. See Retrieve files in sorted order.

        In a HA Active-Active configuration, sorting of event files is not supported. If the default value (no sort) is changed, then the adapter throws a runtime exception error.

      4. Select a value for the File content encoding field.

        If you are working with binary event data, select BINARY.

        If you are working with non-binary event data, such as text or XML, select a valid file encoding value, such as UTF-8 (the default value). See File content encoding.

      5. Select Include total business object count in the ChunkInfo property to specify that the total business object count is included in the chunk information of the dataobject being sent to the endpoint. See Include total business object count in the ChunkInfo (includeBOCountInChunkInfo).

      6. Select Split file content based on size (bytes) or delimiter check box to specify file splitting either by size or delimiter. See Split file content based on size (bytes) or delimiter.

        This property is disabled if you select the Pass only file name and directory, not the content property.

      7. In the Split function class name field, specify how the event file is to be split, by delimiter or by size. See Split function class name.

      8. In the Specify criteria to split file content field, specify the delimiter that separates the business objects in the event file or the maximum size of the event file, depending on the value that is set in the Splitting Function Class Name. See Specify criteria to split file content.

      9. Select Poll subdirectories in event directory check box to specify if the adapter polls the subdirectories within the event directory. See Poll subdirectories in event directory.
    • File archiving configuration

      1. Select Pass only file name and directory, not the content check box to specify if the adapter sends the directory name and file name to the endpoint. See Pass only file name and directory, not the content.

        In the external service wizard, you can use this property if both the Split file content based on size (bytes) or delimiter property and Poll event files for modified content properties are not selected.

      2. In the Archive directory field, specify the directory where the adapter archives processed event files. See Archive directory.

      3. In the File extension for archive field, specify the file extension used to archive unsuccessfully processed business objects in the input event file. See File extension for archive.

      4. In the Success file extension for archive field, specify the file extension used to archive successfully processed business objects. See Success file extension for archive.

      5. In the Failure file extension for archive field, specify the file extension used to archive unsuccessfully processed business objects in the input event file. See Failure file extension for archive.
    • Bidi properties

      1. Select the Bidi transformation check box to specify bidirectional format. For more information about setting the Bidi properties, refer to the Globalization section.

    • Logging and tracing

      1. If you have multiple instances of the adapter, expand Logging and tracing and enter a value in the Adapter ID field that is unique for this instance. For more information about this property, see Adapter ID (AdapterID).

      2. If you want to mask certain information so that the information is not displayed in the logs or traces, select Disguise user data as "XXX" in log and trace files.

      3. To specify the log file output location or define the level of logging for this module, select the Change logging properties for wizard check box. For information about setting logging levels, see Configure logging properties.

  6. In the Service properties section, select whether to use the default function selector configuration or create a new one.

    1. To create a function selector configuration, click Select next to the Function selector field.

    2. In the Select a Function Selector window, select the Use existing function selector from the list option.

    3. Select the required function selector from the list of available function selectors. Click Next.

    A function selector assigns incoming messages or requests to the correct operation on the service.

    Figure 5. Creating a function selector configuration

    The enterprise information system (EIS) function name is not available in the external service wizard.

    If you want to specify a value other than the default that is generated by the adapter (base classes), you can edit it using the assembly editor.

  7. To filter the inbound event file by configuring rules, click Add or Edit in the Rule editor table. The rule constitutes three parameters, namely, Property type, Operator and Value.

    Figure 6. Adding or editing a rule

    1. Select any of the following metadata filtering property types from Property type list.

      • FileName
      • FileSize
      • Directory
      • LastModified

    2. Select the operator for the property type from the Operator list. Each of the property type metadata has its own operators.
      1. FileName contains the following operators:

        • Matches_File_Pattern (matches pattern)
        • Matches_RegExp (matches regular expression)

      2. FileSize metadata contains the following operators:

        • Greater than
        • Less than
        • Greater than or equal to
        • Less than or equal to
        • Equal to
        • Not equal to

      3. Directory contains Matches_RegExp as its operators.
      4. LastModified metadata contains the following operators:

        • Greater than
        • Less than
        • Greater than or equal to
        • Less than or equal to
        • Equal to
        • Not equal to

    3. Type the value for filtering the event file in the Value column.

      You must enter a valid Java™ regular expression in value for Matches_RegExp operator.

    To configure multiple rules, select END-OF-RULE option for each rule from the Property type list.

    The rules are grouped by using the logical OR operator, unless END-OF-RULE is selected in the property field. If an END-OF-RULE is selected between expressions (an expression can be a single rule or multiple rules grouped by an OR operator), it will be grouped using the logical AND operator.

    For example, If the rule A (FileName) is grouped with rule B (FileSize) using the logical OR operator, and on selecting the END-OF-RULE option, this expression will be grouped with another rule C (LastModified) using an AND operator. This can be represented as follows: ((A) OR (B)) AND (C)

    For more information see, Rule editor to filter files (ruleTable).

  8. Click Finish.


Results

The adapter saves the activation specification properties.


What to do next

Select a data type for the module and name the operation associated with the chosen data type.

Configure the module for inbound processing


Next topic: Selecting the operation and data type


Related concepts:

Known issues in editing the Rule Table

File retrieval


Related reference:

Connection properties for the wizard

Activation specification properties

Activation specification properties