6/18/24, 4:48 PM Document 2901874.

1
Copyright (c) 2024, Oracle. All rights reserved. Oracle Confidential.

Workflow Java Mailer Analyzer (Doc ID 2901874.1)

In this Document

Main Content
Purpose
Download The Latest Version
Running The Analyzer - Configuration / Setup / Execution
Parameters :
Running the Analyzer (run_analyzer.sh) from the command line :
Running the Analyzer as a Concurrent Request
Analyzer & Sample Output
Known Issues & Solutions
Questions, Comments & Feedback
Related Resources
EBS Analyzer Bundle Menu Tool
References

APPLIES TO:

Oracle Application Object Library - Version 12.1.3 to 12.2 [Release 12.1 to 12.2]
Information in this document applies to any platform.

MAIN CONTENT

TECHNICAL REQUIREMENTS

Requires Java 1.7+

TIP: To verify Java version

$ java -version
java version "1.8.0_141"
Java(TM) SE Runtime Environment (build 1.8.0_141-b15)
Java HotSpot(TM) 64-Bit Server VM (build 25.141-b15, mixed mode)

Does not run on Windows systems. Linux/Unix only.

Download the latest Workflow Java Mailer Analyzer version

New for Sysadmins/DBA’s! EBS Analyzer Bundle Menu Tool Doc ID 1939637.1 to provision and maintain all your
analyzers.
Analyzer Bundle Menu Tool is a perl menu system to easily execute, update and install as concurrent programs/assign
to request groups.

PURPOSE

Analyzers are designed by Support to proactively assist you to better diagnose and maintain your Oracle Application
environments. We welcome and encourage you to share your feedback via the Workflow Java Mailer Analyzer

https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=j9miwcsy5_537&id=2901874.1 1/8
6/18/24, 4:48 PM Document 2901874.1
feedback thread in the My Oracle Support EBS Core Workflow Community. Your feedback shapes the content of
existing Analyzers and drives creation of new Analyzers.

The Workflow Java Mailer Analyzer is a self-service health-check script that validates Workflow Java Mailer
connectivity for both SMTP and IMAP servers, analyzes current configurations and settings for the environment and
provides feedback and recommendations on best practices. Analyzers may also be used as data collection tools by
Support Engineers. Your application data is not altered in any way when you run this analyzer.

NOTE: This is a non-invasive script - the Analyzer does not perform any INSERTs, UPDATEs or
DELETEs to your data; it just reports on it.
The Analyzer collects data using all the tables necessary to diagnose issues and provides solutions and
recommended actions. For production instances, you should first apply any recommended actions or solutions to
a recent clone to ensure an expected outcome.

Global Customer Support (GCS) services and systems are not designed to accommodate special security controls
that may be required to store or process certain types of sensitive data.
Please ensure that you do not submit any sensitive data that requires protections greater than those specified in
GCS published Security Practices document.
Reference: How to Edit Output from Oracle Tools and Utilities to Remove Sensitive Content (Doc ID 1227943.1)

Audience
DBAs and System Administrators - run the script and review the output
Product Specialists and Business Analysts - review the output
Other interested parties/end users - review output to resolve identified opportunity improvement areas

Benefits
Immediate analysis and output of a specific Workflow Mailer (based on Mailer component id) for a particular
environment
Identifies Workflow Java Mailer setup, tests connectivity, and confirms required patches and configurations
Provides recommended actions and best practices
Runs as a standalone java program on the Applications Concurrent Tier

Back to Top

DOWNLOAD THE LATEST VERSION

Download the latest Workflow Java Mailer Analyzer version

Since Analyzers are regularly updated to include newly identified issues and solutions, we highly
recommend always using the latest version.
To verify the version of your currently installed Java Analyzer:

• After download : The version is in the zip filename : wf_mailer_analyzer_200.1.zip

• After running Analyzer : The main HTML output page displays the current version as well as the latest
version available, which is also a hyperlink to download the latest version.
Also, Execution Details button includes the analyzer file name and version.

Want to be notified via email when this document is updated? Check out the Enabling Hot Topics section
under the Just the Facts tab of Doc ID 793436.2 (My Oracle Support How to Series: How to use Hot Topics Email
notification to subscribe to Support Product News, SRs, Bugs, etc. and events so that you Never Miss an Important
Update - [VIDEO])

Back to Top

RUNNING THE ANALYZER - CONFIGURATION / SETUP / EXECUTION

The Workflow Java Mailer Analyzer is a Java Program that is run as a shell script. Instructions listed below:

https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=j9miwcsy5_537&id=2901874.1 2/8
6/18/24, 4:48 PM Document 2901874.1
System Administrators / DBAs may choose to install one or more Analyzers as Concurrent Programs or run individual
Analyzers via SQL*Plus or Java directly from the E-Business Suite Support Analyzer Bundle Menu Tool.
For details see Doc ID 1939637.1.

Parameters :

We limit the parameters prompted for ease of running, and pull the remaining values from the Mailer
configurations table. The mailer parameters are found using View Details button from :
System Administration > Oracle Applications Manager > Workflow > Service Components > Notification Mailers

Using INLINE parameters on the command line (see below) supersedes the value found in the
Mailer Configurations table (FND_SVC_COMP_PARAM_VALS).
Note: Correct passwords are required to test connectivity.

Mailer Component ID: (Required) Enter specific Java Mailer Component ID or the default Mailer (10006)
Workflow Notification Mailer is used

select component_id, component_name from FND_SVC_COMPONENTS where COMPONENT_TYPE = 'WF_MAILER';

Mailer Question: (Required) Enter if using Outbound Only: OUT or BOTH for Outbound and Inbound or
<Enter> for default BOTH
Inbound AUTH Type: (Required) Enter the AUTH Type: BASIC or OAUTH or <Enter> for default OAUTH
BASIC means using an OnPrem inbound mail server
OAUTH means using a 3rd party inbound mail server like Office365, Gmail, Yahoo, etc
Outbound SMTP User Password: (Optional) If using user/pwd with SMTP, enter the Mailer Outbound SMTP
User Password or <Enter> to skip
Inbound IMAP Password (for Basic Authentication): (Optional) If using BASIC authentication for IMAP,
then enter the IMAP password
Inbound OAuth Private Key Password (for OAuth Authentication): (Optional) If using OAuth
authentication, enter the Inbound OAuth Private Key Password
appsCredentials: (Required) This prompts for the APPS user name and password in the format of
AppsUser/AppsPassword

Running the Analyzer (run_analyzer.sh) from the command line :

1) Source the APPS RUN environment.

2) Download the Workflow Java Mailer Analyzer using the DOWNLOAD button above, and unzip on the
Concurrent Tier.

3) Navigate to the directory where you unzipped the wf_mailer_analyzer_200.x.zip file from the
DOWNLOAD button above.

4) Move into the HAF directory and confirm the following files exist :

HAF (root folder)

ha_scripts (folder)
lib (folder)
resource (folder) ...
run_analyzer.sh (shell script)

A. If using On-Prem SMTP/IMAP servers, (BASIC) please run the

Workflow Java Mailer Analyzer java program using this command :

bash run_analyzer.sh -
Danalyzer="resource/wf_mailer_analyzer.xml" -
Dp_inbound_auth_type="BASIC" (follow all prompts and
provide details)

B. If using OAUTH, (office365, Gmail, other off-site mail services,

etc) for inbound[IMAP] run the Workflow Java Mailer Analyzer using
this command :
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=j9miwcsy5_537&id=2901874.1 3/8
6/18/24, 4:48 PM Document 2901874.1

bash run_analyzer.sh -
Danalyzer="resource/wf_mailer_analyzer.xml" -
Dp_inbound_auth_type="OAUTH" (follow all prompts and provide
details)

C. If this is the First time you are setting up mailer for OAUTH
or HAVING ISSUES STARTING THE WORKFLOW MAILER
Many of the parameters requested are pulled from the Mailer
Configurations table (FND_SVC_COMP_PARAM_VALS) but if first time, or
not starting these values may be missing or incorrect,
so enter all the correct parameter values inline to be used by the
Java Mailer Analyzer.

Run the Workflow Java Mailer Analyzer using inline parameters

:
bash run_analyzer.sh -
Danalyzer=resource/wf_mailer_analyzer.xml \
-Dp_mailer_comp_id="<12345>" \
-Dp_mailer_question="<OUT|BOTH>" \
-Dp_inbound_auth_type="<BASIC|OAUTH>" \
-Dp_outbounduser="<name>@<domain.com>" \
-Dp_smpt_account_password="<SMTP_pwd>" \
-Dp_account="<name>@<domain.com>" \
-Dp_inbnd_oauth_token_url="<https://xxxx/oauth2/v2.0/token>" \
-Dp_inbnd_oauth_client_id="<oauth_client_id>" \
-Dp_inbnd_private_key_id="<1234567>" \
-Dp_inbnd_private_key_pwd="<Password>" \
-Dp_inbnd_public_key_id="<1234567>" \
-Dp_inbnd_oauth_scope="https://outlook.office365.com/.default"
\
-DpMailerLogTrimMaxLines=400000 \
-DpMailerLogTrimMaxHours=24 \
-Dp_max_output_rows="20"

Where:
-Dp_mailer_comp_id="<12345>" --> Specify specific Mailer
Component ID [i.e. 10006 = Workflow Notification Mailer (default)]
select component_id,
component_name from FND_SVC_COMPONENTS where COMPONENT_TYPE = 'WF_MAILER';
-Dp_mailer_question="<OUT|BOTH>" --> Does this mailer process
Outbound Only emails [OUT] or [BOTH] Outbound and Inbound emails
-Dp_inbound_auth_type="<BASIC|OAUTH>" --> AUTH Type: If processing Inbound
Mail using IMAP Mailer then [BASIC] or [OAUTH] for OUTLOOK365 or GMAIL or
online service
-Dp_outbounduser="<name>@<domain.com>" --> Outbound SMTP Username
-Dp_smpt_account_password="<SMTP_pwd>" --> Outbound SMTP Password
-Dp_account="<name>@<domain.com>" --> Inbound IMAP Username
-Dp_inbnd_oauth_token_url="URL" --
> https://login.microsoftonline.com/<tenant ID>/oauth2/v2.0/token(Replace
<tenant ID> with the directory tenant ID.)
-Dp_inbnd_oauth_client_id="<_client_id>" --> Inbound OAuth Client ID
-Dp_inbnd_private_key_id="<1234567>" --> Inbound OAuth Private Key
Certificate File ID
To get privateKeyFileID use
below query (FileId not Filename)
select file_id from fnd_lobs
where file_name = '<provide privatekey file name like ms.p12';
-Dp_inbnd_private_key_pwd="<Password>" --> Inbound OAuth Private Key
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=j9miwcsy5_537&id=2901874.1 4/8
6/18/24, 4:48 PM Document 2901874.1
Password
-Dp_inbnd_public_key_id="<1234567>" --> Inbound OAuth Public Key
Certificate File ID
To get publicKeyFileID use below
query (FileId not Filename)
select file_id from fnd_lobs
where file_name = '<provide publickey file name like ms.cer';
-Dp_inbnd_oauth_scope --> Default setting is
"https://outlook.office365.com/.default"
-DpMailerLogTrimMaxLines=400000 --> Default (hidden) setting is the
latest 400,000 lines within the (MaxHours) 24 hrs whichever comes first
-DpMailerLogTrimMaxHours=24 --> Default (hidden) setting is the
latest 24 hours of Mailer log
The above Trim parameters are used to reduce the potential size of the
mailer log for processing and parsing the latest log information and avoid
old errors.

If Troubleshooting Workflow Mailer issues:

Trouble starting mailer, mailer crashing, or mailer runs but seeing
errors in mailer log sending or receiving notifications,
it is recommended to change mailer log level to STATEMENT (level 1)
for the most detailed robust logging.
1. Stop Workflow Mailer Service (container), will shutdown all
mailers.
2. Change the SVC_CONTAINER_LOG_LEVEL and Mailer Log level to 1
(STATEMENT) to generate the most detailed logs, follow Doc ID
1365320.1 - Getting and Reading Workflow Notification Mailer Log
File.
3. Start the Workflow Mailer Service (container), this will start
all mailers with a brand new log (at STATEMENT level).
4. Reproduce your issue
5. Run the latest Workflow Java Mailer Analyzer, so it will
collect the latest mailer log, parse for errors, and analyze mailer
setup(s).
6. Review the results, upload to support, then change your mailer
log level back to exception, or error to reduce huge log files.

The java program will prompt for the APPS user password.

The JAVA program run as a shell script (.sh) runs Operating System (OS) checks, validates credentials,
gathers log files, and also runs the wf_mailer_analyzer.xml, then collects all the logs and output files
together into a single zip file which can be uploaded to a Service Request.

Running the Analyzer as a Concurrent Request

Currently, we are not releasing this JAVA analyzer program as a Concurrent Program. Let us know if this is
something you need.
Most people that will be running this analyzer will be SYSADMINs or DBAs, so likely they prefer to run via
command line.

Back to Top

ANALYZER & SAMPLE OUTPUT

The Workflow Java Mailer Analyzer generates a single zip file that contains all the script outputs and
files collected along with the main Analyzer HTML report (WFMLRHA_<date>_<time>.html).
Use the main Analyzer HTML output to review all the findings and easily access all the collected script outputs and log
files.
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=j9miwcsy5_537&id=2901874.1 5/8
6/18/24, 4:48 PM Document 2901874.1
Running the analyzer as a java program:

Workflow Java Mailer Analyzer output zip file is located in the same directory where it was run. This location
is also displayed in the window after execution.
INFO: Output zipped at: WFMLRHA_<date>_<time>.zip

Click the button below to view a sample output of the Workflow Java Mailer Analyzer:

In the images and/or the attached document, user details / company name / address / email / telephone
number represent a fictitious sample (based upon made up data used in the Oracle Demo Vision instance). Any
similarity to actual persons, living or dead, is purely coincidental and not intended in any manner.
Your report output(s) can change based upon the parameters selected and the attached sample output is one
possible variation.

Known Issues & Solutions

Issue Solution

Framework code limitation. The expected result is

for all the Diagnostic output files to be displayed in
the SCRIPTS section with links.
ATGSuppJavaMailerSetup12.sh Workaround : Unzip the output zip file, the files exist
---------------------------------------------------- in the WFMLRHA_DD-Mon-
1. Script completion status: this script ran successfully! YYYY_xxxxxx\ha_tools\out directory.
However, no script output file(s) were found and collected in:
WFMLRHA_DD-Mon-YYYY_xxxxxx.zip Solution : Upgrade to Workflow Java Mailer Analyzer
v200.2 or higher. Issue is fixed.

2. Exception: java.lang.IllegalArgumentException: Property

'http://javax.xml.XMLConstants/property/accessExternalDTD' This warning message is reported if a non-JAXP 1.5
is not recognized. compliant xml parser is used or JDK version 6 is
used.

First, confirm JDK 7 exists on CP Tier where the

hybrid analyzer is being run:

IBM AIX
$ java -version
java version "1.7.0"
Java(TM) SE Runtime Environment (build
pap3270sr9fp10-20150708_01(SR9 FP10))
IBM J9 VM (build 2.6, JRE 1.7.0 AIX ppc-32
20150701_255667 (JIT enabled, AOT enabled)
J9VM -
R26_Java726_SR9_20150701_0050_B255667
JIT - tr.r11_20150626_95120.01
GC - R26_Java726_SR9_20150701_0050_B255667
J9CL - 20150701_255667)
JCL - 20150628_01 based on Oracle jdk7u85-b15

LINUX
$ java -version
java version "1.7.0_85"
Java(TM) SE Runtime Environment (build 1.7.0_85-
b15)
Java HotSpot(TM) Server VM (build 24.85-b06,
mixed mode)
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=j9miwcsy5_537&id=2901874.1 6/8
6/18/24, 4:48 PM Document 2901874.1
Secondly, Error suggests issue is from Xerces specific
implementation of XML parser. Since we do not
know or control this since this is executed by
customer DBAs. So in Framework 6.25 we have
created a central XmlUtils utility class to handle the
creation of the various XML classes that enables the
secure features whenever supported. If an option
isn't supported by the implementation, it'll log a
warning but won't completely stop processing.

So the analyzer should now run when encountering

this issue.

Until Analyzer Builder Framework 6.25 is available,

download these Beta versions for customer to run :
(If you need a different Java (Hybrid) Analyzer
contact PSD, or leave a comment on this Note.)

Workflow Mailer Analyzer v200.21 (test Jar)

The check script outputs are intentionally limited for this report. To run the full output, see Basic Troubleshooting and
Data to be Uploaded by Customers Logging Workflow Mailer Issues Doc ID 432949.1

See Doc ID 2700644.1 for all known issues with analyzers.

Back to Top

QUESTIONS, COMMENTS & FEEDBACK

Have questions or suggestions?

Click the button above to ask questions about and/or provide feedback on the Oracle
Applications Workflow Java Mailer Analyzer. Share your recommendations for enhancements and help
us make this Analyzer even more useful!

To search for solutions or post new questions about Workflow Java Mailer in general, visit the EBS Core Workflow
Community on My Oracle Support Community (MOSC).

Back to Top

RELATED RESOURCES

Check out the full list of Oracle E-Business Suite (EBS) Proactive Support Analyzers
and Tools (Doc ID 1545562.1)

EBS Analyzer Bundle Menu Tool

The EBS Analyzer Bundle Menu Tool (Doc ID 1939637.1) allows you to provision and maintain all your Analyzers. The
Analyzer Bundle Menu Tool is a Perl menu system that enables you to easily execute, update and install most
Analyzers as concurrent programs and assign them to request groups.

The tool is updated monthly to include newly released and updated EBS Analyzers. For a complete list of EBS
Analyzers currently included in the EBS Analyzer Bundle Menu Tool :
See the Change Log for Bundle Zip section of E-Business Suite Support Analyzer Bundle Menu Tool (Doc ID
1939637.1)

https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=j9miwcsy5_537&id=2901874.1 7/8
6/18/24, 4:48 PM Document 2901874.1

Back to Top
Didn't find what you are looking for?

https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=j9miwcsy5_537&id=2901874.1 8/8