Operation
What is it?
The JDEdwards Connector runs JDEdwards reports through OpCon by using the JDEdwards E1 job subtype within a Windows job. When OpCon schedules the job, the connector submits the defined report to the JDEdwards scheduler and monitors its completion status.
Use this documentation when you need to:
- Define a JDEdwards E1 job in Enterprise Manager
- Understand the fields required to submit a report through the connector
- Interpret return codes and log output for a JDEdwards job
Defining a JDEdwards E1 job
The JDEdwards E1 job subtype is accessed through the Windows job type in Enterprise Manager. It defines a single report to be processed by the JDEdwards scheduler. The connector does not create job definitions in JDEdwards — the report must already exist in the JDEdwards environment.
To define a JDEdwards E1 job, complete the following steps:
- In Enterprise Manager, open the Job Master for the target schedule.
- Select the Add button to create a new job.
- In the Job Type list, select Windows.
- In the Job Sub-Type list, select JD Edwards E1. The JD Edwards E1 Definition screen is displayed.
- Complete the required fields as described in the table below.
- Select the Save button. The job is added to the schedule.
JDEdwards E1 definition fields
| Field | Required | Description |
|---|---|---|
| Connector Location | Yes | The installed location of the JDEdwards Connector. The default value is [[JDEPath]]. Do not change this unless more than one connector is installed — in that case, define a new global property and update this field accordingly. |
| Report Name | Yes | The name of the report to start. The report must already exist in the JDEdwards environment. |
| Report Version | Yes | The version of the report to run. |
| Batch Queue Name | No | The batch queue on which the report will be processed. If omitted, the value set by RUNUBEXML in the request XML is used. |
| Environment | Yes | The JDEdwards environment where the report will run. |
| Database Name | Yes | The name of a database connection defined in Connector.config. Used to retrieve the report status. |
| User Name | Yes | A JDEdwards user with the required privileges to run the report. |
| User Role | Yes | The role associated with the defined JDEdwards user. |
| User Password | Yes | The password for the JDEdwards user. |
Return codes
A JDEdwards E1 job returns one of the following codes when it completes:
| Code | Status | Description |
|---|---|---|
0 | FINISHED_OK | The report completed successfully. |
1 | ERRORED | An exception occurred during job processing. |
Set the Failure Criteria for the job to NE (Not Equal) 0 to treat any non-zero return code as a failure.
NOTE: On older JDEdwards systems, successful completion may be indicated by a value other than 0. Check the Agent.config User Defined RC section if jobs fail unexpectedly despite completing successfully in JDEdwards.
Logging
The connector writes activity and job status information to a rotating set of five log files:
jdedwardse1.logjdedwardse1.log.1throughjdedwardse1.log.5
The log files are located in installation_dir\log. New entries are appended to the active log file. When the active file reaches its size limit, it rotates to the next numbered file.
All output produced during a job run is available in the OpCon job output and can be retrieved using the Job Output Retrieval System (JORS).
When a job fails, the connector appends the JDEdwards jde.log and jdedebug.log files to the OpCon job output. You can retrieve the combined output through JORS and use it with the Event Notification System to send the log output as an email attachment to a defined address or distribution list.
Sample log output
The following example shows typical log output for a successful report run:
2014-09-25 09:37:43,342 INFO (JDEdwardsConnector) -------------------------------------------------------------
2014-09-25 09:37:43,389 INFO (JDEdwardsConnector) SMA JDEwards Connector : 5.20.01.10
2014-09-25 09:37:43,389 INFO (JDEdwardsConnector) XML files directory : C:\jdeconn\xml
2014-09-25 09:37:43,389 INFO (JDEdwardsConnector) Job Output Directory : null
2014-09-25 09:37:43,389 INFO (JDEdwardsConnector) Runubexml location : c:\JDEdwardsPPack\E910\system\bin32
2014-09-25 09:37:43,389 INFO (JDEdwardsConnector) -------------------------------------------------------------
2014-09-25 09:37:43,389 INFO (JDEdwardsJobExecutorImpl) Report Name : R0006P
2014-09-25 09:37:43,389 INFO (JDEdwardsJobExecutorImpl) Report Version : XJDE0001
2014-09-25 09:37:43,389 INFO (JDEdwardsJobExecutorImpl) Environment : DV910
2014-09-25 09:37:43,389 INFO (JDEdwardsJobExecutorImpl) User : JDE
2014-09-25 09:37:43,389 INFO (JDEdwardsJobExecutorImpl) User Role : *ALL
2014-09-25 09:37:43,389 INFO (JDEdwardsJobExecutorImpl) -------------------------------------------------------
2014-09-25 09:37:43,654 INFO (JDEdwardsJobExecutorImpl) Created job base XML file 'C:\jdeconn\xml\R0006P_XJDE0001_base.xml'
2014-09-25 09:37:43,654 INFO (JDEdwardsConnectionFactory) buildBatchRequestXml command line '"c:\JDEdwardsPPack\E910\system\bin32\runubexml.exe" S "C:\jdeconn\xml\R0006P_XJDE0001_base.xml" "C:\jdeconn\xml\R0006P_XJDE0001_request.xml"'
2014-09-25 09:38:07,023 INFO (JDEdwardsConnectionFactory) submitJob command line '"c:\JDEdwardsPPack\E910\system\bin32\runubexml.exe" S "C:\jdeconn\xml\R0006P_XJDE0001_request.xml" "C:\jdeconn\xml\R0006P_XJDE0001_result.xml"'
2014-09-25 09:38:08,521 INFO (JDEdwardsJobExecutorImpl) Job ID '89' returned
2014-09-25 09:38:08,521 INFO (JDEdwardsConnectionFactory) Connecting to database type (ORACLE) using URL 'jdbc:oracle:thin:@//192.168.168.210:1521/E910DB'
2014-09-25 09:38:08,817 INFO (JDEdwardsJobExecutorImpl) Connected to database 'jdbc:oracle:thin:@//192.168.168.210:1521/E910DB'
2014-09-25 09:38:08,817 INFO (JDEdwardsJobExecutorImpl) Job Status Change : JD Edwards Status (Queued)
2014-09-25 09:38:13,918 INFO (JDEdwardsConnectionFactory) SELECT JCJOBSTS FROM SVM910.F986110 WHERE JCJOBNBR = 89 AND JCEXEHOST = 'ENTSQL2013'
2014-09-25 09:38:14,417 INFO (JDEdwardsJobExecutorImpl) Job Status Change : JD Edwards Status (Processing)
2014-09-25 09:38:24,433 INFO (JDEdwardsConnectionFactory) SELECT JCJOBSTS FROM SVM910.F986110 WHERE JCJOBNBR = 89 AND JCEXEHOST = 'ENTSQL2013'
2014-09-25 09:38:24,433 INFO (JDEdwardsJobExecutorImpl) Job Fin : JD Edwards Status (Done)
FAQs
Does the connector create or modify job definitions in JDEdwards? No. The connector only submits and monitors existing JDEdwards jobs. You must define the report in JDEdwards before scheduling it through OpCon.
What should I set for Failure Criteria?
Set Failure Criteria to NE (Not Equal) 0. A return code of 0 indicates successful completion; any other value indicates an error.
Where do I find log files when a job fails?
Log files are located in installation_dir\log. When a job fails, the connector also appends the JDEdwards jde.log and jdedebug.log to the OpCon job output, which you can retrieve using JORS.
What does the Batch Queue Name field do? The Batch Queue Name field is optional. If you leave it blank, RUNUBEXML sets the queue value in the request XML automatically. If your environment requires a specific queue, enter the queue name here.
Can I run the same report in multiple JDEdwards environments? Yes. Define a separate job for each environment and set the Environment and Database Name fields accordingly for each job.
Glossary
Batch Queue Name — The optional JDEdwards batch queue where the report will be processed. If not specified, RUNUBEXML assigns the default queue.
Database Name — The DATABASE_CONNECTION_NAME value from Connector.config that identifies which database connection the connector uses to monitor the report status.
Environment — The JDEdwards environment (such as a production or development environment) where the report will run.
ERRORED — The return code status indicating that an exception occurred during connector processing. Corresponds to return code 1.
FINISHED_OK — The return code status indicating that the report completed successfully. Corresponds to return code 0.
JORS — Job Output Retrieval System. The OpCon capability for retrieving job output, including connector logs and JDEdwards error logs appended on failure.
User Role — The JDEdwards role associated with the user who submits the report. Required by JDEdwards to determine the user's access and privileges when running the report.
Related topics: