Logs

Purpose: A variety of logs are available to help troubleshoot Oracle Retail Order Management System processing:

TomEE Logs: to review messages generated by the Oracle Retail Order Management System application server at startup and during Oracle Retail Order Management System processing, such as when the application receives an invalid character in an XML message, or when a submitted job encounters an error.

Information related to TomEE logs:

- Log4j XML File

- CWDirect Log

Oracle Retail Order Management System Application Logs: to review activity such as:

- processing by the Oracle Retail Order Management System job scheduler

- email notification processing

- creation, change, or deletion of a record in Oracle Retail Order Management System

also, you can use these logs to troubleshoot situations such as:

- occasions when a stored value card or authorization job requires user intervention in order to proceed due to error or communication failure

- communication problems between Oracle Retail Order Management System and the PC manifest station

- communication problems between Oracle Retail Order Management System and PayPal when using the PayPal Direct Connection Integration

Information related to application logs:

- Location of Oracle Retail Order Management System Application Logs

- Logging Level

- Archived Logs

- Logging Properties

- MQ Message Log

- Application Log

- Response Log

- Trace Log

- Manifest Log

- Order Log

- PayPal Log

- Cybersource Log

- User Exit/Edit Point (UEP) Log

- Customer API Log

- Alert Log

- IntegrationOrder (ChannelAdvisor) Log

- ORCE (Oracle Retail Customer Engagement Loyalty) Log

- OROB (Oracle Retail Order Broker) Log

TomEE Logs

Purpose: Use the TomEE logs to review messages generated by the Oracle Retail Order Management System application server at startup, and the messages generated during processing of the Oracle Retail Order Management System application.

Log4j XML File

CWDirect Log

Log4j XML File

The log4j.xml file contains configuration settings for logs.

Level of logging: The Threshold setting in the log4j.xml file controls the level of detail included in the TomEE logs.

Location of file: This file is normally saved on the application server at /usr/local/tomcat01/conf/log4j.xml, where /usr/local/tomcat01 is the installed location of Oracle Retail Order Management System.

To edit the file: You can use a text editor to edit the file, being careful not to change any of the settings except those indicated below.

If you make any changes to the log4j.xml file, you must stop and restart Oracle Retail Order Management System before the changes take effect.

Setting

Description

Append

This setting controls whether to clear the CWDirect Log file each time the service restarts. If the Append value for the FILE is set to true, the CWDirect Log is saved with a date stamp in the file name when the service restarts, and any subsequent activity is noted in the new CWDirect.log file. For example, if you restart the service on August 27, 2015, the existing log file is renamed CWDirect.log.2015-08-27.

To change the setting so that the CWDirect Log is saved under a different file name when the service restarts:

1. Stop the OMS service.

2. Find the FILE entry, such as:

<appender name="FILE" class="org.apache.log4j.DailyRollingFileAppender">

- <errorHandler class="org.apache.log4j.helpers.OnlyOnceErrorHandler"/>

- <param name="File" value="${openejb.base}/log/CWDirect.log"/>

- <param name="Append" value="false"/>

3. Change the Append value to true,so that it reads:

<param name="Append" value="true"/>

4. Restart the service.

Threshold

The level of detail to include in the TomEE logs.

Valid values:

ALL = Include all levels of information in the log, including debug statements, informational statements, warnings, errors, and fatal statements. This is the most detailed level of logging.

DEBUG = Include debug, or detailed informational event statements in the log, as well as informational, warning, error, and fatal statements. This setting also includes the java class associated with the log message for troubleshooting purposes.

INFO = Include informational statements in the log, as well as warning, error, and fatal statements. Do not include debug statements in the log.

WARN = Include warning statements in the log, as well as error and fatal statements. Do not include debug or informational statements in the log.

ERROR = Include error, or serious issue, statements and fatal statements in the log. Do not include debug, informational, or warning statements in the log.

FATAL = Include fatal statements on actions that cause the application to abort in the log. Do not include debug, informational, warning, or error statements in the log. This is the highest level of logging.

OFF = Do not log any messages.

CONSOLE

It is important to make sure that the CONSOLE entry toward the end of the file is commented out to eliminate needless logging and improve performance. To do so:

1. Stop the OMS service

2. Find the CONSOLE entry, such as:

<root>

<appender-ref ref="CONSOLE"/>

<appender-ref ref="FILE"/>

</root>

3. Comment out the CONSOLE entry, so that it reads:

<root>

<!-- <appender-ref ref="CONSOLE"/> -->

<appender-ref ref="FILE"/>

</root>

4. Restart the service.

CWDirect Log

Use this log to review messages generated during processing of the Oracle Retail Order Management System application.

Name of log: The File setting in the Log4j XML File defines the name of the CWDirect log. You should not change this setting in order to avoid confusion when troubleshooting.

Location of file: This file is normally saved on the application server at /usr/local/tomcat01/log/CWDirect.log, where /usr/local/tomcat01 is the installed location of Oracle Retail Order Management System.

To review the file: You can review the contents of this file using a text editor.

Cleared when? If the Append value in the Log4j XML File is set to false, this file is cleared each time you restart the application; otherwise, if the value is set to true, the file is not cleared. See the Log4j XML File for information on configuring this file.

Special characters in the CWOrderIn message: If you pass a special character in the Header element of the Inbound Order XML message (CWOrderIn), the system does not process the message and logs the error in the CWDirect log.

Example:

If you pass Mary&Joe in the sold_to_fname tag, an error message similar to the following is in the CWDirect log:

2008-06-18 11:25:59,934 99184497 ERROR [STDERR] (43049:) (LoggerStream.java:152) [Fatal Error] :1:214: The reference to entity "Joe" must end with the ';' delimiter.

If you pass Mary& in the sold_to_fname tag, an error message similar to the following is in the CWDirect log:

2008-06-18 11:10:29,315 98253878 ERROR [STDERR] (43049:) (LoggerStream.java:152) [Fatal Error] :1:110: The entity name must immediately follow the '&' in the entity reference.

Email errors: If the mail.debug setting in Working with Cloud Properties (CPRP) is true, the system includes error messages about email generation in the CWDirect log. For example, if a program defined for a periodic process is not a valid program, an error message similar to the following is in the log:

2008-06-20 16:08:44,868 169401020 ERROR [JENASYS] (43298:) (JenasysJob.java:307) execute(): com.mincron.framework.BusinessLogicException: Program name=[Xx123456] not found.

2008-06-20 16:08:44,868 169401020 ERROR [JENASYS] (43298:) (JenasysJob.java:699) run(): Job status change to [MSG]. execute(): com.mincron.framework.BusinessLogicException: Program name=[Xx123456] not found.

In addition, the system generates a Oracle Retail Order Management System Support Notification indicating the job has been placed in MSG status due to an error during processing; see Oracle Retail Order Management System Support Notifications for more information.

Errors for submitted jobs: To see if the system has written a log message for an error that occurred during a submitted job, search for the Job number displayed at the Job Management screen. For example, the following message indicates a problem with submitted job 3133:

2014-11-20 14:14:12,852 ERROR [JENASYS] (197213%Thu Nov 20 14:14:11 EST 2014) -MonitorOutputQueues- processServiceRequest: could find/load properties filr for the queue = [QPRINT]

Oracle Retail Order Management System Application Logs

Purpose: Use the following logs to review the processing that occurred on the Oracle Retail Order Management System application server.

MQ Message Log

Application Log

Response Log

Trace Log

Manifest Log

Order Log

PayPal Log

Cybersource Log

User Exit/Edit Point (UEP) Log

Alert Log

IntegrationOrder (ChannelAdvisor) Log

ORCE (Oracle Retail Customer Engagement Loyalty) Log

OROB (Oracle Retail Order Broker) Log

Location of Oracle Retail Order Management System Application Logs

The CW_LOG_DIR setting in the CWDirectCP Server Properties File defines the directory path on the application server where the logs are located.

An example directory is //usr//local//tomcat01//OMSFiles//Logs, where //usr//local//tomcat01 is the installed location of Oracle Retail Order Management System.

Logging Level

The LOG_LEVEL in Working with Cloud Properties (CPRP) defines the level of detail to include in the log.

ALL = Include all levels of information in the log, including debug statements, informational statements, warnings, errors, and fatal statements. This is the most detailed level of logging.

DEBUG = Include debug, or detailed informational event statements in the log, as well as informational, warning, error, and fatal statements.

INFO = Include informational statements in the log, as well as warning, error, and fatal statements. Do not include debug statements in the log.

WARN = Include warning statements in the log, as well as error and fatal statements. Do not include debug or informational statements in the log.

ERROR = Include error, or serious issue, statements and fatal statements in the log. Do not include debug, informational, or warning statements in the log.

FATAL = Include fatal statements on actions that cause the application to abort in the log. Do not include debug, informational, warning, or error statements in the log. This is the highest level of logging.

OFF = Do not create a log.

Logging Level Illustration:

Archived Logs

The MAXBACKUP_DAYS setting in Working with Cloud Properties (CPRP) defines the number of days the system stores a backup copy of the log before deleting. For example, if the MAXBACKUP_DAYS setting is set to 30, the system stores a backup copy of the log for 30 days before deleting it.

When is a log archived? Each day at midnight, the system archives the current log, adding a zip file extension and date to the log name. For example, if the current date is 02/05/2008, the system archives the APP.log, renaming the file from APP.log to APP.2008-02-05.log.zip.

Note: The system does not create a new log until activity occurs to write to the log. For example, the system does not create a new APP.log until application activity occurs. The LOG_LEVEL determines when the system writes a message to the APP.log.

Logging Properties

Use Working with Cloud Properties (CPRP) to define the type of information the system includes in the Oracle Retail Order Management System application logs.

Setting

Description

CW_LOG_DIR

located in the CWDirectCP Server Properties File

The directory path on the Oracle Retail Order Management System application server where the logs are located.

An example directory is //usr//local//tomcat01//OMSFiles//Logs, where //usr//local//tomcat01 is the installed location of Oracle Retail Order Management System.

CW_LOG_ BACKUP_ PATTERN

The file extension added to backup copies of the log file.

The system creates a backup copy of the log file for each day, using the date format from the CW_LOG_DATE_PATTERN setting and file extension from the CW_LOG_BACKUP_PATTERN setting.

For example, for the APP.log file, the system names the backup copy APP.YYYY-DD-MM.log.zip.

The delivered setting is .zip.

Note: The file extension must be lower case.

CW_LOG_DATE_PATTERN

The date format for backup copies of the log file.

The system creates a backup copy of the log file for each day, using the date format from the CW_LOG_DATE_PATTERN setting and file extension from the CW_LOG_BACKUP_PATTERN setting.

For example, for the APP.log file, the system names the backup copy APP.YYYY-DD-MM.log.zip.

The delivered setting is .%d{yyyy-MM-dd}.log.

CW_LOG_DATAQ

Defines whether the system includes messages written to data queues in the log.

Valid values:

true = The system includes messages written to data queues in the log.

false = The system does not include messages written to data queues in the log.

LOG_ RETENTION_ DAYS

The number of days to store the CWDirect Log before it is eligible for deletion. Each time you restart Oracle Retail Order Management System, it deletes archived copies of the CWDirect log that are older than the number of days indicated here. If you do not specify the number of retention days, logs are eligible for deletion after 30 days.

Note: The log deletion uses both the date and the time in determining whether to purge a log. For example, the current time is 7:00 a.m. and the LOG_RETENTION_DAYS is set to 30. If the log was created earlier than 7:00 30 days ago, it is eligible for deletion; otherwise, if it was created later than 7:00 30 days ago, it is not currently eligible.

MQ Message Log

Use this log to track XML and transactional messages generated or received by Oracle Retail Order Management System that are not tracked in the Application Log, Manifest Log, Order Log, or Trace Log. You can use this file to confirm that you are receiving or generating messages correctly, to isolate communication problems, or to recover information.

MQ_FILE_NAME

located in the CWDirectCP Server Properties File

The name of the log that stores XML and transactional message information.

An example setting is Message.log.

MQ_LOG_LEVEL

Defines the level of detail to include in the log. See Logging Level.

MQ_ MAXBACKUP_ DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

Job Log

This log is not currently implemented.

Application Log

Use this log to track the activity performed in the Oracle Retail Order Management System application, such as:

• the processing that occurs in the Oracle Retail Order Management System job scheduler

• email notification processing

• when a user creates, changes, or deletes a record in Oracle Retail Order Management System

APP_FILE_NAME

located in the CWDirectCP Server Properties File

The name of the log that stores application information.

The delivered setting is APP.log.

APP_LOG_LEVEL

Defines the level of detail to include in the log. See Logging Level.

APP_ MAXBACKUP_DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

Response Log

Use this log to review when a job required user intervention in order to proceed. A job may require user intervention if:

• an error occurs during processing

• the job sends transactions to another system, and communication failures occur before the transmission completes

The types of job that require user intervention:

• stored value card (activation, balance inquiry, or authorization reversal)

• authorization (batch only, for all card types)

• deposit

RESP_FILE_ NAME

The name of the log that stores response information.

The delivered setting is RESP.log.

RESP_LOG_ LEVEL

Defines the level of detail to include in the log. See Logging Level.

RESP_ MAXBACKUP_ DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

Trace Log

Use this log to review internal messages about Oracle Retail Order Management System application processing. Typically, you review this log only if the contents of the Application Log did not help you.

TRACE_FILE_ NAME

located in the CWDirectCP Server Properties File

The name of the log that stores trace information.

The delivered setting is TRACE.log.

TRACE_LOG_ LEVEL

Defines the level of detail to include in the log. See Logging Level.

TRACE_ MAXBACKUP_ DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

Manifest Log

Use this log to review the messages between Oracle Retail Order Management System and the PC manifest station. You can use this log to confirm that communication between Oracle Retail Order Management System and the PC manifest station is working correctly, to isolate communication problems, or to recover information. Any errors that occur during processing are also in this log.

MANIFEST_FILE_NAME

located in the CWDirectCP Server Properties File

The name of the log that stores manifesting information.

The delivered setting is MANIFEST.log.

MANIFEST_LOG_LEVEL

Defines the level of detail included in the log. See Logging Level.

MANIFEST_MAXBACKUP_DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

Order Log

Use this log to review the messages between an external system and Oracle Retail Order Management System through the Generic Order Interface (Order API). You can use this log to confirm that communication between the external system and Oracle Retail Order Management System is working correctly, to isolate communication problems, or to recover information.

ORDER_FILE_ NAME

The name of the log that stores order API information.

The delivered setting is ORDER.log.

ORDER_LOG_ LEVEL

Defines the level of detail to include in the log. See Logging Level.

ORDER_MAX BACKUP_ DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

OROB (Oracel Retail Order Broker) Log

Use this log to review the messages between Oracle Retail Order Management System and Oracle Retail Order Broker when you use the Order Broker Integration. You can use this log, in addition to Oracle Retail Order Broker’s logs, to review data passed between the two systems.

OROB_FILE_ NAME

The name of the log that tracks Oracle Retail Order Broker message activity.

The delivered setting is OROB.log.

OROB_LOG_ LEVEL

Defines the level of detail to include in the log. See Logging Level.

OROB_MAX BACKUP_DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

PayPal Log

Use this log to review the messages between Oracle Retail Order Management System and PayPal when you use the PayPal Direct Connection Integration. You can use this log to confirm that communication between Oracle Retail Order Management System and PayPal is working correctly, to isolate communication problems, or to recover information. Any errors that occur during processing are also in this log.

PAYPAL_FILE_ NAME

located in the CWDirectCP Server Properties File

The name of the log that stores PayPal transaction information.

The delivered setting is PAYPAL.log.

PAYPAL_LOG_ LEVEL

Defines the level of detail to include in the log. See Logging Level.

PAYPAL_MAX BACKUP_DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

User Exit Point Log

Use this log to review the parameters passed for user exit points you have set up through the Working with User Exit/Edit Point (WUEP) option. See the User Exit/Edit Point (UEP) Log for more information.

UEP_FILE_NAME

located in the CWDirectCP Server Properties File

The name of the log that stores user exit point activity information.

The delivered setting is USER_EXIT_POINT.log.

UEP_LOG_LEVEL

Defines the level of detail to include in the log. See Logging Level.

UEP_MAX BACKUP_ DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

Customer API Log

Use this log to review the messages between Oracle Retail Order Management System and Oracle Retail Xstore Point-of-Service when you use the Generic Customer API. You can use this log to confirm that communication between Oracle Retail Order Management System and Oracle Retail Xstore Point-of-Service is working correctly, to isolate communication problems, or to recover information. Any errors that occur during processing are also in this log.

Note: Messages between Oracle Retail Order Management System and any other system using the Generic Customer API are logged in the MQ Message Log.

CUST_FILE_ NAME

The name of the log that stores Customer API transaction information.

The delivered setting is CUST.log.

CUST_LOG_ LEVEL

Defines the level of detail to include in the log. See Logging Level.

CUST_MAXBACKUP_ DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

Alert Log

Use this log to review the alerts generated by the Job Monitor Status (WJMO) menu option; see Monitoring Jobs.

Note: The system updates this log only if the ALLOW_JOB_ MONITOR and TRACK_ALERTS_IN_LOG settings in the Monitor Properties file are set to Y. These settings should only be set to Y for the application server that allows job scheduling; see How to Schedule a Job.

See the Alert Log for more information.

ALERT_FILE_NAME

located in the CWDirectCP Server Properties File

The name of the log that stores Job Monitor Alert information.

The delivered setting is ALERT.log.

ALERT_LOG_ LEVEL

Defines the level of detail to include in the log. See Logging Level.

ALERT_MAX BACKUP_ DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

IntegrationOrder (ChannelAdvisor) Log

Use this log to review activity related to integration with ChannelAdvisor.

Note: The system updates this log only if the you use the ChannelAdvisor integration. See ChannelAdvisor Integration Overview for background.

See the IntegrationOrder (ChannelAdvisor) Log for more information.

INTEGRATION ORDER_FILE_ NAME

located in the CWDirectCP Server Properties File

The name of the log that tracks activity related to the ChannelAdvisor integration.

The delivered setting is IntegrationOrder.log.

INTEGRATION ORDER_LOG_ LEVEL

Defines the level of detail to include in the log. See Logging Level.

INTEGRATION ORDER_MAX BACKUP_DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

ORCE (Oracle Retail Customer Engagement) Log

Use this log to review activity related to the loyalty integration with Oracle Retail Customer Engagement.

Note: The system updates this log only if the you use the Customer Engagement Loyalty integration. See Customer Engagement Loyalty Integration for background.

See the ORCE (Oracle Retail Customer Engagement Loyalty) Log for more information.

ORCE_FILE_ NAME

The name of the log that tracks activity related to the Oracle Retail Customer Engagement Loyalty integration.

The delivered setting is ORCE.log.

ORCE_LOG_ LEVEL

Defines the level of detail to include in the log. See Logging Level.

ORCE_MAX BACKUP_DAYS

The number of days to store a backup copy of a log before deleting it. See Archived Logs.

Example: To retain a month’s worth of logs, set this field to 30. The system deletes any log file older than 30 days.

MQ Message Log

Use this log to track XML and transactional messages generated or received by Oracle Retail Order Management System, with the exception of those captured in the Manifest Log, the Order Log, and the tax messages captured in the Trace Log. You can use this file to confirm that you are receiving or generating messages correctly, to isolate communication problems, or to recover information.

The MQ Message Log settings in the Logging Properties define the name of the log, the level of detail to include in the log, and the number of days to store a backup copy of the log before deleting it.

To review the file: You can use a text editor to review the log.

Data security: For data security, Oracle Retail Order Management System masks credit card information in this log.

Successful message: A message similar to the following indicates if the transmission was successful:

08:33:54,228 INFO MQ - Out Message:<Message source="OMS" target="external" type="CWPickOut" date_created="2011-08-08" time_created="08:33:53"> <PickHeader transaction_type="A" company="7" pick_nbr="2464" pick_status="M" nbr_labels="2" billing_batch_nbr="1011" date_printed="2011-08-05" time_printed="13:50:46" cart_batch_nbr="18" pick_zone1="A" nbr_lines="1" gen_type="R" merch_amt="10.35" tax_amt="0.52" amt_paid="10.87" total_order_amt="10.87" first_pick="Y" master_carton_nbr="2464" master_carton_pick="N" master_label_order="N" order_nbr="3715" order_shipto_nbr="1" ...

Errors to look for:

A message similar to the following indicates if the transmission failed:

14:42:48,724 ERROR MQ - Cwmqget -Queue Manager: QM_process Queue:ORDERDATAQ Error Message: MQ Object not found

 

A message similar to the following indicates the queue manager is down and needs to be restarted:

09:08:19,939 ERROR MQ - Cwmqput -Queue Manager: QM_PD3 Queue:PD3.CWDIRECTCPDEV.RETURN_OUT Error Message:null

or

12:51:07,721 INFO MQ - Cwmqput -Queue Manager:QM_PD3 Queue:PD3.CWDIRECTCPDEV.RETURN_OUT Message:

Application Log

Use this log to track the activity performed in the Oracle Retail Order Management System application, such as:

• the processing that occurs in the Oracle Retail Order Management System job scheduler

• any errors that occur during email notification processing

• when a user creates, changes, or deletes a record in Oracle Retail Order Management System

• any errors that occur during the Customer Engagement Batch Customer and Sales Integrationthe CWEmailOut message

• the processing that occurs by the Long Running Jobs Monitor

The Application Log settings in the Logging Properties defines the name of the APP.log, the level of detail to include in the log, and the number of days the system stores a backup copy of the log before deleting it.

To review the file: You can use a text editor to review the log.

Email error: The following error indicates an attempt to send an email failed. In this example, the mail server rejected the email request from port 25. This error usually occurs due to virus-checker rejecting the remote mail requests.

13:06:28,586 ERROR APP - Error in CWSendMail.sendMessage(). Could not send email. Here is the exception: javax.mail.SendFailedException: Sending failed; nested exception is: class javax.mail.MessagingException: Could not connect to SMTP host: CWIEX1, port: 25; nested exception is: java.net.SocketException: Software caused connection abort: connect

Response Log

Use this log to review when a job required user intervention in order to proceed. A job may require user intervention if:

• an error occurred during processing

• the job is used to send transactions to another system and communication failures occur before the transmission completes

The types of job that require user intervention:

• stored value card (activation, balance inquiry, or authorization reversal)

• authorization (batch only, for all card types)

• deposit

The Response Log settings in the Logging Properties defines the name of the RESP.log, the level of detail included in the log, and the number of days the system stores a backup copy of the log before deleting it.

To review the file: You can use a text editor to review the log.

Sample messages:

Message

Written When

Deposits - Response required for job. E-Mail sent to:email1@cware.com; email2@cware.com

Oracle Retail Order Management System generates a Response Required email, indicating a job requires user intervention.

In this example, Deposits is the job name and email@cware.com is the email address to receive the Response Required email.

Deposits - Received R response from BMIRANDA

A user responded to a response required message at the Reply To Message screen.

In this example, Deposits is the job name and BMIRANDA is the user that responded to the job.

Deposits - No response after 5 attempts, will retry

Oracle Retail Order Management System reviewed the Response Required table five times to determine if a user responded to the response required message.

In this example, Deposits is the job name.

Deposits - No response after 10 attempts, will retry

Oracle Retail Order Management System reviewed the Response Required table ten times to determine if a user responded to the response required message.

In this example, Deposits is the job name.

Deposits - No response received, default response used

The number of times to look for a response in the Response Required table has been reached without a response from a user. Oracle Retail Order Management System uses the default response for the job.

In this example, Deposits is the job name.

Deposits - Response Required entry not found, default response used

A user deleted a response required message at the Work with Required Response screen. Oracle Retail Order Management System uses the default response for the job.

In this example, Deposits is the job name.

Trace Log

Use this log to review internal messages about Oracle Retail Order Management System application processing. Typically, you review this log only if the contents of the Application Log did not help you.

The Trace Log settings in the Logging Properties define the name of the trace log, the level of detail to include in the log, and the number of days to store a backup copy of the log before deleting it.

To review the file: You can use a text editor to review the log.

Manifest Log

Use this log to review the messages generated between Oracle Retail Order Management System and the PC manifest station. You can use this log to confirm that communication between Oracle Retail Order Management System and the PC manifest station is working correctly, to isolate communication problems, or to recover information. Also, any errors that occur during processing are written in this log.

The Manifest Log settings in the Logging Properties define the name of the manifest log, the level of detail to include in the log, and the number of days to store a backup copy of the log before deleting it.

To review the file: You can use a text editor to review the log.

Order Log

Use this log to review the CWOrderIn and CWORDEROUT messages between an external system and Oracle Retail Order Management System as part of the Generic Order Interface (Order API). You can use this log to confirm that communication between the external system and Oracle Retail Order Management System is working correctly, to isolate communication problems, or to recover information.

The Order Log settings in the Logging Properties define the name of the ORDER.log, the level of detail to include in the log, and the number of days to store a backup copy of the log before deleting it.

To review the file: You can use a text editor to review the log.

Successful message: A message similar to the following indicates if an order message was successful:

12:32:42,483 INFO ORDER - In Message: <Message source="IDC" target="RDC" type="CWORDERIN" resp_qmgr="CWIAS400" resp_q="CWDIRECT.PROMOTION.OUT.10.Q"> <Header company_code="009" order_number="021711-1" payment_only="N" source_code="JMNSRC" response_type="E" order_channel="I" customer_number="13115" pay_incl="Y" order_type="W"> <Payments> <Payment pay_seq_number="1" payment_type="04" cc_type="04" cc_number="************1443" cc_exp_month="12" cc_exp_year="2012" auth_number="manual" auth_date="02112011" /></Payments> <ShipTos><ShipTo shipping_method="98" ship_to_type="2"> <Items><Item quantity="1" item_id="API100"></Item></Items></ShipTo></ShipTos><Coupons> <Coupon /></Coupons></Header></Message>

 

Errors to look for:

A message similar to the following indicates that the CWOrderIn message passed was not formatted correctly or contained invalid data:

17:21:46,031 INFO ORDER - Out Message:<Message>Invalid XML Message: <Message source="String" target="String" type="CWORDERIN" > <Header company_code="6" rdc_order_number="9967" payment_only="Y" nbr_ship_tos="1" pay_incl="Y" source_code="SOURCE" response_type="E" order_channel="I" sold_to_fname="Freddie" sold_to_lname="Snare" sold_to_address1="10 Main Street" sold_to_city="NATICK" sold_to_state="MA" sold_to_zip="01760" sold_to_country="USA" order_type="I" sold_to_email="ekaplan@example.com" > <Payments> <Payment payment_type="5" cc_number="***5556" cc_exp_month="12" cc_exp_year="12" /> </Payments> </Header> </Message> com.mr.serenade.exception.BOException: OrderInMessageBO.checkDuplicateWebOrder - null </Message>

 

PayPal Log

Use this log to review the messages generated between Oracle Retail Order Management System and PayPal when you are using the PayPal Direct Connection Integration. You can use this log to confirm that communication between Oracle Retail Order Management System and PayPal is working correctly, to isolate communication problems, or to recover information. Also, any errors that occur during processing are written in this log.

The PayPal Log settings in the Logging Properties define the name of the PAYPAL.log, the level of detail to include in the log, and the number of days to store a backup copy of the log before deleting it.

To review the file: You can use a text editor to review the log.

Data security: For data security, Oracle Retail Order Management System masks credit card information in this log.

Successful message: A message similar to the following indicates if the PayPal deposit transmission was successful:

11:56:55,831 INFO PAYPAL - [Settlement] Transmitted deposit(*PURCH) Processed : AMT=20.94&INVNUM=111-1754&NOTE=PAYPAL+1754&AUTHORIZATIONID=12345678901234567890&COMPLETETYPE=NotComplete&METHOD=DoCapture

Failed message: A failure in the deposit process or errors during processing generate ERROR level messages, such as the following:

11:56:55,831 ERROR PAYPAL - [Settlement] Transmitted deposit(*PURCH) Failure : AMT=20.94&INVNUM=111-1754&NOTE=PAYPAL+1754&AUTHORIZATIONID=12345678901234567890&COMPLETETYPE=NotComplete&METHOD=DoCapture

11:57:06,581 ERROR PAYPAL - [Settlement] Timestamp : 2009-05-08T15:52:55Z

11:57:08,737 ERROR PAYPAL - [Settlement] CorrelationId : 6e035b0d97c05

11:57:10,284 ERROR PAYPAL - [Settlement] Error code : 10002

11:57:11,972 ERROR PAYPAL - [Settlement] Short message : Security error

11:57:15,018 ERROR PAYPAL - [Settlement] Long message : Security header is not valid

11:57:17,300 ERROR PAYPAL - [Settlement] Severity code : Error

Setup errors: Errors reading the authorization service or authorization service extended generate ERROR level messages, such as the following:

11:31:04,471 ERROR PAYPAL - [Settlement] Defaults set. Do not process in PayPal 'live' environment

11:31:31,841 ERROR PAYPAL - [Settlement] Exception(s) encountered during Initialization. No Deposit processing performed.

For more information: See PayPal Direct Connection Integration for an overview and the required setup for processing deposit transactions between Oracle Retail Order Management System and PayPal using a direct connection.

Cybersource Log

Use this log to review messages generated between Oracle Retail Order Management System and Cybersource when you are using the Cybersource Point-to-Point Integration.

Data security: For data security, Oracle Retail Order Management System masks credit card information in this log.

You can use this log to confirm that communication between Oracle Retail Order Management System and Cybersource is working correctly, to isolate communication problems, or to recover information. Also, any errors that occur during processing are written in this log.

Setup: The CYB_PAY_LINK_SERVICE_ENABLE_LOG setting in Working with Customer Properties (PROP) defines whether the Cybersource web service logs messages generated between Oracle Retail Order Management System and Cybersource when you are using the Cybersource Point-to-Point Integration. Valid values are:

true = Oracle Retail Order Management System writes transactions for the Cybersource Point-to-Point Integration to the Cybersource log.

false = Oracle Retail Order Management System does not write transactions for the Cybersource Point-to-Point Integration to the Cybersource log.

Important: For data security, set this value to false unless you are troubleshooting the Oracle Retail Order Management System integration with Cybersource. Once you are done troubleshooting, delete any log files that are created.

The CYB_PAY_LINK_SERVICE_LOG_DIRECTORY setting in the CWDirectCP Server Properties File defines the location of the log written by the Cybersource web service API program. For example: /usr/local/tomcat01/OMSFiles/Integrations/Cybersource/Log, where /usr/local/tomcat01 is the installed location of Oracle Retail Order Management System.

To review the file: You can use a text editor to review the log.

For more information: See Cybersource Point-to-Point Integration for an overview and processing details.

User Exit/Edit Point (UEP) Log

Use this log to review user exit point and user edit point activity based on the user exit points and user edit points you have set up through the Working with User Exit/Edit Point (WUEP) option.

User exit points: You can use this log to confirm the exact parameters being passed for a user exit point during system processing.

Example:

16:45:14,599 INFO UEP - User Exit Point com.mr.serenade.bo.interfaces.UserExitPointTester called.

16:45:14,599 INFO UEP - User Exit Point Tester executed.

16:45:14,599 INFO UEP - User Exit Point Tester value for position 0 is 002

16:45:14,615 INFO UEP - User Exit Point Tester value for position 1 is 000013644

16:45:14,615 INFO UEP - User Exit Point Tester value for position 2 is C

16:45:14,615 INFO UEP - User Exit Point Tester value for position 3 is 1110804

16:45:14,615 INFO UEP - User Exit Point Tester value for position 4 is 0164514

16:45:14,615 INFO UEP - User Exit Point Tester value for position 5 is D

16:45:14,615 INFO UEP - User Exit Point com.mr.serenade.bo.interfaces.UserExitPointTester execution was successful! Database update returned was false.

User edit points: The unique program you define in the Implementation class field for the user edit point controls the information written to the UEP log. Create an entry for the parameters passed and the response string returned.

Example:

13:03:52,043 INFO UEP - User Edit Point Tester executed.

13:03:52,043 INFO UEP - User Edit Point Tester value for key COMPANY is 002

13:03:52,043 INFO UEP - User Edit Point Tester value for key ORDER_TYPE is P

13:03:52,043 INFO UEP - User Edit Point Tester value for key SHIP_VIA is 01

13:03:52,043 INFO UEP - User Edit Point Tester value for key CUST_CLASS is

13:03:52,043 INFO UEP - User Edit Point Tester value for key SALES_REP is 0000000

13:03:52,043 INFO UEP - User Edit Point Tester value for key SHIP_TO_NBR is 001

13:03:52,043 INFO UEP - User Edit Point Tester value for key ORDER_NBR is 00009189

13:03:52,043 INFO UEP - User Edit Point Tester value for key PO_NBR is

To review the file: You can use a text editor to review the log.

Setup: Complete the User Exit Point Log settings in the Logging Properties.

Customer API Log

Use this log to review the messages between Oracle Retail Order Management System and Oracle Retail Xstore Point-of-Service when you use the Generic Customer API.

You can use this log to confirm that communication between Oracle Retail Order Management System and Oracle Retail Xstore Point-of-Service is working correctly, to isolate communication problems, or to recover information. Any errors that occur during processing are also in this log.

Note: Messages between Oracle Retail Order Management System and any other system using the Generic Customer API are logged in the MQ Message Log.

The Customer API Log settings in the Logging Properties define the name of the CUST.log, the level of detail to include in the log, and the number of days to store a backup copy of the log before deleting it.

To review the file: You can use a text editor to review the log.

For more information: See the Generic Customer API for an overview and the required setup for processing Customer API transactions.

Alert Log

Use this log to review the alerts generated by the Job Monitor Status (WJMO) menu option. This log indicates:

• the name of the job monitor associated with the alert

• the name of the job monitor rule associated with the alert

• the action taken for the job monitor rule, such as generating an email or running a periodic process

Note: The system updates this log only if the ALLOW_JOB_ MONITOR and TRACK_ALERTS_IN_LOG settings in Working with Cloud Properties (CPRP) are set to Y. These settings should only be set to Y for the application server that allows job scheduling; see How to Schedule a Job.

IntegrationOrder (ChannelAdvisor) Log

Use this log to review activity related to integration with ChannelAdvisor. See ChannelAdvisor Integration Overview for background.

ORCE (Oracle Retail Customer Engagement Loyalty) Log

Use this log to review activity related to the loyalty integration with Oracle Retail Customer Engagement. The system logs the loyalty transactions passed between Oracle Retail Order Management System and Oracle Retail Customer Engagement if the Logging Level is DEBUG. See Customer Engagement Loyalty Integration for background.

OROB (Oracle Retail Order Broker) Log

Use this log, in addition to Oracle Retail Order Broker’s logs, to review messages passed between Oracle Retail Order Management System and Oracle Retail Order Broker as part of the Order Broker Integration.

logs OROMS 15.1 June 2016 OTN