Configuring the adapter

The connector component of the adapter has two types of configuration properties: standard configuration properties, which apply to most adapters, and connector-specific configuration properties, which apply only to your adapter and provide a way for you to change static information or logic within the connector without having to recode and rebuild it. A connector obtains its configuration values at startup. You must set the values of these properties before running the connector.

To configure connector properties, use the Connector Configurator tool. Details are given in Appendix B, Connector Configurator. This tool provides a graphical user interface for configuring the connector.

When you have finished specifying values for the connector's configuration properties, the Connector Configurator saves the values in the adapter repository (for ICS) or generates a configuration file and places it in the adapter's local repository (for WebSphere MQ Integrator Broker and WebSphere Application Server).

Specifying properties

In this section, the steps required to specify properties are described. The project name for the folder used in these procedures is INDUS.

To specify properties, start the WebSphere Business Integration System Manager and do the following steps

  1. Expand the User Projects folder.
  2. Expand InterChange Server Projects.
  3. Expand the INDUS folder.
  4. Expand the Connectors folder.
  5. Double-click IndusConnector::wbieuicl.
  6. Click the Standard Properties tab to add or modify configuration properties.
  7. Specify the AgentTraceLevel for the adapter. Selecting the value 5 generates detailed trace level; zero (0) generates no trace information.
  8. Your application information might inform you which of the following transports to select for the DeliveryTransport property.
    MQ
    IDL (the default transport method)
    JMS

    Accept the defaults for the remainder of the configuration for standard properties.

    In the next few steps, you define the connector-specific properties for the transport.

  9. Click the Connector-Specific Properties tab.
  10. Click to expand wbiadapter.
  11. Click to expand transports.
  12. Expand Indus.
  13. Expand senders.
  14. Expand IndusSenderReceiver.
  15. Expand parameters.
  16. Specify the appropriate values for the properties listed in Table 4.

    Table 4. Connector-specific configuration properties for adapter for IndusConnect Framework transport

    Property / Parameter Description Value Default value
    sendUrl This is the URL to which this sender component sends events. This URL must be fully qualified and resolvable over HTTP. This parameter should point to the IndusConnect process servlet, for example, APIFWAdapterServlet N/A
    pollingInterval Interval in milliseconds that specifies how long to wait before calling the poll() method to retrieve new events from IndusConnect. See Polling parameter considerations for additional polling information. Integer value in milliseconds or "no" to stop polling. 30000
    prePollStatus When polling, this is the status level of events that are searched for. Events of this status are returned in the poll() method. The value of this option must be a single character. R
    postPollStatus When polling, this is the status level that events are set to after polling. All events returned in the poll() method have their status level set to this value. The value of this option must be a single-digit integer. 9
    apifwVersion The version of APIFW business objects. This value is used to construct the DTD and header for process requests. String V090000
    dtdLocation Location of business object DTD documents on the IndusConnect Framework server. This value is necessary to construct DTD headers for process requests. String name of the xml directory on the server hosting the IndusConnect Framework and containing the IndusConnect.DTD files. N/A
    environment Indus PassPort environment name needed for apiFW. IndusConnect Framework application environment. This value is necessary to construct DTD headers for process requests.
    D903
    username Application (for example, Indus Passport) username that the adapter uses when conducting requests. String

    This value must match the apifw.properties apiUsername property. See IndusConnect Framework documentation for this property.

    N/A
    DefaultEncoding Default encoding to assume for documents received from the server when the ContentEncoding header is not set. Valid Java encoding

    Strings

    UTF-8
    DefaultSendMethod Parameter indicating whether to default to GET or POST as the method for accessing URLs. GET or POST POST
    generateErrorObject Flag that indicates whether the adapter should generate a separate business object from the error and warning information received from the IndusConnect Framework. The object generated is named indusErrorObject. True or False False
    OverrideServerEncoding Flag indicating to override the set ContentEncoding header of the server with the DefaultEncoding property True or False False
  17. Expand eventstore.
  18. Expand parameters.
  19. Specify the appropriate values for the properties listed in Table 5.

    Table 5. Connector-specific configuration properties for adapter for IndusConnect Framework event store

    Property / Parameter Description Value Default value
    fetchURL URL from which this store retrieves events. {IBM servlet location}/getEventXML N/A
    fetchIDParameter Parameter name that the remote site uses to identify the event to retrieve. When placed in the URL, the value of this parameter will be the eventID argument passed into the fetchRecords method.
    eventID
    fetchStatusParameter Parameter name that the event store will use to retrieve events of a set status. When placed in the URL, the value of this parameter will be the status argument passed into the fetchRecords method.
    status
    postPollStatus Event status to set after poll. This value is used to indicate when an event has been copied from the HTTP event store to the file system event store. The value of the option should match that specified in the IndusSenderReceiver class and must be a single-digit integer. 9
    updateURL URL that allows updating of events in the event store. {IBM servlet location}/setStatus N/A
    updateIDParameter Parameter name that the remote site uses to identify the event to update. When placed in the URL, the value of this parameter is the eventID argument passed into the setEventStoreStatus method.
    eventID
    useGetMethod Indicates whether the event store should use GET as the method for accessing URLs. Change this value to FALSE in a production environment. TRUE (GET) or FALSE (POST) TRUE
    eventDir Directory in which event store is located. This argument can be relative or fully qualified.
    eventStore
    archive Directory in which archive store is located. Set this argument to null or omit to not implement archival.
    archive
    archiveFailureFatal Boolean indicating whether to return a fatal exception if the system fails to initialize the archive. True or False False
    successCompletionStatus Event status to set after the adapter has successfully consumed an event (for example, successfully passed the event on to the integration broker). The value of this option must be a single-digit integer. 8
    errorCompletionStatus Event status to set after the adapter has failed to consume an event (for example, failure either in logic processing or in sending the event to the integration broker). The value of this option must be a single-digit integer. 7
    deleteOnArchive Boolean indicating whether to delete an event when requested to archive an event. True or False False
    updateStatusParameter Parameter name that the remote site uses to identify the new status of the specified event. When placed in the URL, the value of this parameter is the status argument passed into the setEventStoreStatus method.
    status
    deleteURL URL that supports deletion of events from the store.
    N/A
    deleteIDParameter Parameter name that the remote site uses to identify the event to delete. When placed in the URL, the value of this parameter is the eventID argument passed into the deleteEvent method.
    eventID
  20. Expand logicmodules.
  21. Expand TranslationManager.
  22. Expand parameters.

    The adapter uses the XSLT logic module as the primary transformation mechanism for translating between the adapter's XML messages and the WBI XML. Translations between XML formats are direct, there is no chaining. To configure the logic module with properties other than the defaults, specify values for the properties listed in Table 6.

    Table 6. Connector-specific configuration properties for adapter for IndusConnect Framework logic module

    Property / Parameter Description Value Default value
    schemaConfig Provides translation between application and integration broker data formats. repository_dir\schemaTypes.xml translations \schemaTypes.xml
    repository The xslt subdirectory is specified as the root for name resolution within the repository, versus the top-level translations directory. repository_dir\xslt translations\xslt
    Indus Used to configure routing path.
    CW
    CW Used to configure routing path. This value must match the routing paths. Indus
  23. If you selected MQ as the delivery transport in step 8, you must specify the queue manager name:
    1. Click the Messaging tab.
    2. Specify the queue manager name in the Queue Manager field. The default is server.queue.manager.
  24. After making the changes, click File->Save-> To Project.
  25. Exit the Connector Configurator.

Copyright IBM Corp. 1997, 2003