Configuring the EDI Activity Log Using iWay Service Manager

How to:

This section describes how to configure the Data Provider and the EDI Activity Log.


Top of page

x
Procedure: How to Configure the Data Provider

To configure the Data Provider:

  1. In the left console pane of the Server menu, select Data Provider.

    The Data Provider pane opens, as shown in the following image.

    Data Provider pane

  2. Click Add (JDBC Connections) to configure a new Data Provider handler.

    The configuration pane for the Data Provider handler opens, as shown in the following image.

    Configuration pane for Data Provider handler

  3. In the Name field, type a unique name for the JDBC Data Provider.
  4. From the Driver Class drop-down list, click the appropriate database driver. Alternatively, you can manually type the database driver class.
  5. From the Connection URL drop-down list, click the database connection URL, or manually type the URL.
  6. In the User field, type a valid user name for the JDBC URL and driver.
  7. In the Password field, type a valid password for the user name.
  8. In the Initial Pool Size field, type the number of connections that are placed in the pool at startup.
  9. In the Maximum Number of Idle Connections field, type the maximum number of idle connections that are retained in the pool.
  10. In the Maximum Number of Connections field, type the maximum number of connections allowed in the pool. In the following image, sample values for a new Data Provider have been supplied.

    Tip: In the image, the Initial Pool Size, Maximum Number of Idle Connections, and Maximum Number of Connections are set to 1. See your database administrator to determine the optimum connection pool properties for your site.

    Sample values for a new Data Provider

  11. Click Add to complete the procedure for adding a Data Provider. Next, you need to configure the EDI Activity Log, as described in the following procedure.

Top of page

x
Procedure: How to Configure the EDI Activity Log

To configure the EDI Activity Log:

Configuring the EDI Activity Driver

  1. In the left console pane of the Server menu, select Activity Facility. The Activity Facility pane opens, as shown in the following image.

    The table that is provided lists the configured Activity Facility handlers. Initially, no handlers are shown.

  2. Click Add to configure a new Activity Facility handler. The configuration pane for the Activity Facility handler opens.

    Configuration pane for Activity Facility handler

  3. From the Type drop-down list, click EDI Activity Logs.
  4. Type a unique name for the EDI Activity Driver and a brief description.
  5. From the Active drop-down list, click true.
  6. In the JNDI Name field, type the name of the Data Provider that you created in How to Configure the Data Provider. For example, if the Data Provider name is edilogger, then the JNDI Name is:
    edilogger
  7. Provide values for the remaining parameters, as defined in the following table.

    Parameter Name

    Type

    Description

    Table

    String

    Table name for the activity log. This must be a valid identifier in the database being used. If the table does not exist at startup, it will be created automatically.

    Compression

    Drop-down list

    Specify whether the messages are to be compressed. Values include:

    • none (default)
    • smallest
    • fastest
    • standard
    • Huffman

    Start Events

    Boolean

    Drop-down list

    If set to true (default), the input messages will be recorded in the activity log. This values must be set to true for use of the audit reports in the console.

    Internal Events

    Boolean

    Drop-down list

    If set to true, system events are included in the activity log. System events include activities such as parsing and transformations (optional). False is selected by default.

    Business Error Events

    Boolean

    Drop-down list

    If set to true, business errors are recorded, such as rules system violations. False is selected by default.

    Emit Events

    Boolean

    Drop-down list

    If set to true (default), output messages from emitter services will be recorded. This is required for use of the audit log reports in the console.

    End Events

    Boolean

    Drop-down list

    If set to true (default), the end of message processing will be recorded in the activity log. This is required for use of the audit log reports in the console.

    Notes Table

    String

    Table name for the notes table, which contains log annotations. If the table does not exist at startup, it will be created automatically.

    MAC Algorithm

    String

    Drop-down list

    The Message Authentication Code (MAC) algorithm. None (default) indicates a MAC should not be computed.

    MAC Provider

    String

    Drop-down list

    The Message Authentication Code (MAC) provider. Not Specified indicates the default provider should be used. The remaining available value is SunJCE.

    MAC Secret Key

    String

    The Message Authentication Code (MAC) secret key to use.

  8. Click Update.

    If necessary, start the database services.

  9. Restart iSM to start the EDI Activity Driver and begin logging.

    The EDI Activity Driver inserts records into the configured activity database. The records are designed for fast writing rather than for ease of later analysis. A set of inquiry service agents suitable for use in a process flow is available to assist during the analysis of the log. Users are cautioned that iWay does not guarantee the layout of the record from release to release, and this should be checked against the actual schema.

    Database Field

    Description

    recordkey

    Unique record identifier.

    recordtype

    Type of this record - the event being recorded.

    • 101 - Message start.
    • 131 - Entry to event (see subtype codes below).
    • 132 - Normal exit from event.
    • 133 - Failed exit from event.
    • 151 - Ancillary message (usually rules violation).
    • 181 - Emit.
    • 191 - Message end.

    signature

    Encoding of the listener name and protocol.

    protocol

    Name of the protocol.

    address

    Address to which an emit is to be issued. The format depends on the protocol.

    tstamp

    Timestamp of record.

    correlid

    UNB05

    tid

    Transaction ID assigned to this message.

    msg

    Message appropriate to this record type. For example, an input message contains the original message received, if possible. Streaming input does not contain a record.

    context

    Serialized special registers that were in the context at the time the record was written.

    text

    Message text for business errors (rules system violations).

    status

    Status code recorded.

    • 0 - Success
    • 1 - Success, message end (191 record)
    • 10 - Rules error

    subtype

    Event code for event records.

    • 1 - Preparser
    • 2 - Parser
    • 3 - In reviewer
    • 5 - In validation
    • 6 - In transform
    • 7 - Agent or flow
    • 8 - Out transform
    • 9 - Out validation
    • 11 - Preemitter
    • 1000 - input record written to table before transformation

    partner_to

    UNB03

    partner_from

    UNB02

    encoding

    Encoding of the listener that obtained the document.

    mac

    Not used in this version.

    Driver version

    1.0 in 5.5.SM


iWay Software