Event Logging
Purpose: Oracle staff use the Event Logging screen to configure the logging to take place for Order Broker.
Logging options: Oracle staff can configure Order Broker to write logs for:
-
Order Broker modules:
-
errors only
-
deletions only (deletion logging is available only for the user interface)
-
detailed: all events are logged
-
nothing
-
-
Integrated Message Logging:
-
errors only
-
all messages
-
nothing
-
All personally identifiable information for customers, vendors, or locations is removed from logs. 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 logs as <email>*** Removed by Logger ***</email>.
Email notifications: Oracle staff can also use the Event Logging screen to specify the events that should trigger an email notification to the admin user; the individual user who performed the action, such as an upload; both the admin user and the individual user; or not to trigger an email, as well as to configure the language to use for these emails.
Note:
See the System screen for information on specifying the email address to receive the Order Broker Polling Status Email.Additional Logging Setup
Log retention days: The Server Logs setting in the Retention Settings section of the Tenant screen controls how many days to retain log entries until they are eligible for deletion through a scheduled process.
How to display this screen: Select Event Logging from the Home Screen or from the Systems Menu.
Note:
Only users with Event Logging authority can display this screen. See the Role Wizard for more information.Field | Description |
---|---|
Event
Logging Note: 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. |
|
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:
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:
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:
|
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:
Oracle recommends that shopping logic tracing be enabled only when needed to research shopping logic questions, and otherwise tracing is turned off 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 logs. 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 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:
|
Drop Ship Request/Response |
Controls the logging that is related to the Supplier Direct Fulfillment request and response XML messages. Set this option to:
|
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:
|
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:
|
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 or EICS. Set this option to:
|
Email Notifications | |
Language |
Controls the language to use for proximity uploads notifications. Supported languages: Only the following languages are currently available:
|
Proximity Data Load |
Controls the generation of email notifications when you upload proximity data through the Proximity Uploads screen. Possible settings:
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:
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:
For more information: See the Incremental Inventory Import. |
Email Settings | |
Administrative email |
The email address(s) to receive system-wide email notifications, including the Proximity Upload Status Email, Incremental Inventory Import Status Email, Product Import Status Email, and the duplicate order alert email. This email address is also used if a job is rejected because of a conflicting job; see Schedule Jobs for a discussion of jobs that might conflict. You can enter multiple email addresses, separating each with a semicolon (;).
For more information on the duplicate order alert email, see the SubmitOrder Request Message in the Operations Guide on My Oracle Support (2114324.1). |
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. Note: You need to change the delivered email address to one that is approved by Oracle in order to be used as a return address on an email generated by Order Broker. Please contact your Oracle Representative to have this email address added. |
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:
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.Note: Oracle staff need to make sure that this URL is added to the allow list. |
Message Version |
Indicates the version of the Job Notification message to generate when a job completes. If the message version is 2.0, the Job Notification includes the jobRequestId. The jobRequestId is also included in the Run Job API response, enabling an integrating system that uses the Run Job API to connect the Run Job request with the completion of the submitted job. The version is set to 1.0 by default. |
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: When the authentication type is OAuth, you need to enter: 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:
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 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. |