Event Logging

Important:                           See Additional Logging Setup, above, for information on additional required setup that controls the level of detail in the logs and whether to log activity in files, in the database, or both.

Probability Rules

Controls the logging to take place when applying probability rules to locate items requests and other activities that require evaluation of availability in a product location. Possible settings:

•         Errors only: write to the error.log file if probability rule evaluation results in an error. Default setting.

•         Nothing: do not update logs based on probability rule activity.

Detailed logging is not supported for probability rules.

See Probability Rule Overview for background.

Location Product Import

Controls the logging to take place when importing product and inventory information from an external system, including the incremental import program. Possible settings are:

•         Detailed: write errors to the error.log file, and write other updates to the server.log and application.log files when importing information.

•         Errors only: write to the error.log and server.log file only when an error occurs during imports. Do not write to the application.log file. Default setting.

•         Nothing: do not update logs based on product or product location import activity or the incremental import.

See Schedule Jobs and the Incremental Inventory Import for background.

User Interface

Controls the logging to take place for activity in the Order Broker user interface. If this field is set to:

•         Detailed: Creation, update, and deletion of records are logged.

•         Deletions: Deletions only are logged.

•         Errors Only: Errors only are logged. Default setting.

•         Nothing: No screen activity is logged.

Trace Shopping Logic

Controls whether to track why individual locations are filtered when the Routing Engine selects a location to source an order. If this field is set to:

•         Detailed: The reasons why the Routing Engine filters individual locations from sourcing an order are tracked, and available for review at the Trace Shopping Log screen.

•         Nothing: Shopping logic is not traced.

Oracle recommends that you turn on shopping logic tracing only when needed to research shopping logic questions, and otherwise turn off tracing in order to avoid impairing performance.

For more information: See the Trace Shopping Log screen.

Integrated Message Logging

All personally identifiable information for customers, vendors, or locations is removed from log files. Personally identifiable information includes names, address, email addresses, phone numbers, customer numbers, and tender accounts.

The personally identifiable information is replaced in the log with the text *** Removed by Logger ***. For example, the email address might appear in the log file as <email>*** Removed by Logger ***</email>.

Order Broker Request/Response

Controls the logging that is related to the Routing Engine request and response messages, including geocode requests and responses if you use the Oracle Maps Cloud Service (see Proximity Locator Searching for background). Set this option to:

•         Everything: 

•         update the xml.log file and the geocode.log file with XML messages and the json.log file with JSON messages, including the ProductUpdate, LocationUpdate, and LocationDetail messages and interactive inventory request messages. The availability service request messages are generated only when the Connection Type at the System screen is set to URL.

•         update the error log with incorrectly formed XML messages.

•         Errors Only: update the error log file with incorrectly formed XML messages and the json.log file with the incorrect JSON messages, but do not update the xml.log file. Default setting.

•         Nothing: do not update any logs based on Routing Engine requests and responses.

Drop Ship Request/Response

Controls the logging that is related to the Supplier Direct Fulfillment request and response XML messages. Set this option to:

•         Everything: 

•         update the xml_ds.log file with all messages.

•         update the error log with incorrectly formed XML messages.

•         Errors Only: update the error log with incorrectly formed XML messages, but do not update the xml_ds.log file. Default setting.

•         Nothing: do not update the error log or the xml_ds.log files for XML messages.

Vendor Portal Request/Response

Controls the logging that is related to communication between Order Broker and an integrated vendor that use JSON messages. Set this option to:

•         Everything: 

•         update the json_ds.log file with JSON messages (getDSOrders, getDSShipConfirm, and setDSAcknowledge request and response messages).

•         update the error log with incorrectly formed JSON messages.

•         Errors Only: update the error log with incorrectly formed JSON messages, but do not update the json_ds.log file. Default setting.

•         Nothing: do not update the error log for integrated vendor messages.

Integrated Shipping Request/Response

Controls the logging that is related to the integrated shipping option in the Vendor Portal and Store Connect. Set this option to:

•         Everything: update the shipping_ds.log file with messages between Order Broker and the integrated shipping provider.

•         Errors Only: update the error log file with incorrectly formed messages, but do not update the shipping_ds.log file. Default setting.

•         Nothing: do not update the error log or the shipping_ds.log file for messages between Order Broker and the integrated shipping provider.

Inventory Request/Response

Controls the logging that is related to the availability update request and response, and the inventory request and response between Order Broker and SIM. Set this option to:

•         Everything: update the inventory.log file with availability update request and response messages, and the error.log file with any errors such as an invalid request message.

•         Errors Only: update the error.log file with incorrectly formed messages, but do not update the inventory.log file. Default setting.

•         Nothing: do not update the error.log or the inventory.log file for availability update request and response messages.

Email Notifications

Language

Controls the language to use for proximity uploads notifications.

Supported languages: Only the following languages are currently available:

•         Brazil-Portuguese

•         China-Chinese (simplified)

•         France-French

•         Germany-German

•         Italy-Italian

•         Japan-Japanese (Gregorian calendar)

•         Netherlands-Dutch

•         Russia-Russian

•         Spain-Spanish

•         Sweden-Swedish

•         United States-English (default)

Note:             

•         The selected language applies only to the Proximity Upload Status Email generated through the Proximity Uploads screen. The Incremental Inventory Import Status Email, Product Import Status Email, and Order Broker Polling Status Email use the language specified for the organization; see the Edit Organization screen. Emails generated to customers or vendors are in English.

•         Your selection applies immediately after you select Save.

Proximity Data Load

Controls the generation of email notifications when you upload proximity data through the Proximity Uploads screen. Possible settings:

•         Administrator: generate an email notification to the Administrative email.

•         User only: generate an email notification to the email specified at the User Profiles screen for the user who submitted the upload.

•         Admin and User: generate email notifications to the email specified at the for the user who submitted the upload and to the Administrative email.

•         Nothing: do not generate an email. Default setting.

See Proximity Upload Status Email for more information.

Location Product Import

Controls the generation of email notifications when importing product, system product, product barcode, location, and product location information from an external system. Possible settings:

•         Administrator: generate an email notification to the Administrative email. Default setting.

•         Nothing: do not generate an email.

See the Product Import Status Email for more information.

User Interface

Controls the email generation of email notifications for activity that takes place using the Order Broker user interface. Additional information will be provided by Oracle at a later date.

Incremental Inventory Import

Controls the generation of email notifications when the Incremental Inventory Import does not run successfully. Possible settings:

•         Administrator: generate an email notification to the Administrative email if Order Broker cannot retrieve updated inventory information.

•         Nothing: do not generate an email if Order Broker cannot retrieve inventory updates. Default setting.

For more information: See the Incremental Inventory Import.

Email Settings

Administrative email

The email address to receive system-wide email notifications, including the Proximity Upload Status Email, Incremental Inventory Import Status Email, and Product Import Status Email. You can enter multiple email addresses, separating each with a semicolon (;).

Note:             

•         Order Broker uses this email address, rather than the email address specified for the admin user at the User Profiles screen.

•         If you do not specify an internal email address, contact your email systems administrator to reset your mail server configuration to enable Order Broker to generate emails to addresses outside your company domain.

From Email

The “from” email address to appear on generated emails; depending on your mail server configuration, this might need to be an existing email address.

SMTP Server

The IP address or name of the email server.

Mail User

A valid user ID for the email server. Needed if your mail server requires user authentication.

Mail Password

The current password for the Mail User. Needed if your mail server requires user authentication.

A period is displayed if you left this field blank.

Your entry is masked on the screen and encrypted in the database.

Event Notifications

Use these fields to configure Order Broker to generate a job notification web service message to an external system each time one of the following job completes:

•         Auto Cancel Unclaimed Pickup Orders

•         Completed Order Private Data Purge

•         Daily Clean Up

•         Email Notifications

•         Fulfilled Inventory Export

•         Incremental Inventory Import

•         Inventory Quantity Export

•         Product Import

•         Incremental Inventory Import

For more information: See the Job Notification Messages appendix in the Operations Guide for details on the message contents and troubleshooting information.

Job Notification URL

The URL to receive the job notifications. Up to 255 positions.

Note:  When the Authentication Type is set to OAuth, the URL must implement getAuthToken to obtain the token.

Wait Time

The number of seconds to wait for a response. Defaults to 30. Required.

Note:  A response is not required.

Authentication Type

Indicates whether to use Basic or OAuth authentication.

When the authentication type is Basic, you need to enter:

•         User ID

•         Password

When the authentication type is OAuth, you need to enter:

•         Client ID

•         Client Secret

See Manage External Application Access for background.

User ID

The user ID to use for authenticating the message in the system receiving the notification.This field is available only when the Authentication Type for a URL connection is set to Basic; otherwise, the Client ID field is available.

Up to 50 positions. Required when a Job URL is specified and Basic authentication is selected.

Password

The password to use for authenticating the message in the system receiving the notification. Available only when a URL is specified and when the Authentication Type is set to Basic; otherwise, the Client Secret field is available. Required when Basic authentication is selected.

Your entry is masked on the screen and encrypted in the database.

Client ID

Identifies Order Broker as a client application for authentication using OAuth. Available only when the Authentication Type is OAuth. Required when OAuth authentication is selected.

For more information: See Manage External Application Access for background on OAuth authentication.

Client Secret

The client secret to authenticate Order Broker as a client application in order to obtain a token. Available only when the Authentication Type is OAuth. Required when OAuth authentication is selected.

For more information: See Manage External Application Access for background on OAuth authentication.

Retry Attempts

Determines the number of times to attempt to retry sending a notification if there are communication issues. If this field is set to:

•         0, Order Broker does not attempt to resend a notification.

•         1-100, Order Broker retries sending the notification the specified number of times, using the Retry Attempt Wait Time as the interval to pause between retry attempts.

The number of retry attempts is tracked locally on the server rather than in the database.

Defaults to 0. A value from 0 to 100 is required.

Retry Attempt Wait Time

The number of minutes to wait between retry attempts. Must be set to a number from 1 to 60 if the Retry Attempts is not set to 0. Defaults to 0.

# of Current Retry Attempts

The total number of job notifications that Order Broker will attempt to retry after the next Retry Attempt Wait Time has elapsed. Display-only.

# of Held Failed Notifications

The total number of notification attempts that have failed. This total can include multiple attempts for the same notification. Held attempts are retained on the server so they can be retried periodically, based on the Retry Attempt Wait Time. Display-only.

A number of failed notifications often indicates that the URL is incorrect or not available, the port number is incorrect, or that the authentication credentials are incorrect.

Maximum retry attempts: After 50,000 failed attempts, Order Broker stops retrying to send the job notifications. A message is written to the JSON log, for example: JobNotificationBO.sendJobNotification() - Held Message limit of 50000 has be reached. No further messages will be queued for retry.