JD Edwards EnterpriseOne Connector 1.0.0.0
The JD Edwards EnterpriseOne Connector lets you import and run JD Edwards EnterpriseOne orchestrations and reports.
Prerequisites
- RunMyJobs 9.2.9 or later
- Connection Management Extension 1.0.0.4 or later. Note that the Connection Management Extension will be installed or updated automatically if necessary when you install this Connector.
- Privileges Required to Use the JD Edwards EnterpriseOne Connector.
- JD Edwards EnterpriseOne Application Interface Services (AIS) Server, with a REST API that can be reached via outbound HTTP from the Secure Gateway (for SaaS customers) or the RunMyJobs Scheduler (for on-site installations).
Contents
Object Type | Name | Description |
---|---|---|
Folder | GLOBAL.Redwood.REDWOOD.JD Edwards EnterpriseOne | JD Edwards EnterpriseOne Connector |
Constraint Definition | REDWOOD.Redwood_EnterpriseOneConnectionConstraint | Constraint for JD Edwards EnterpriseOne Connection fields |
Extension Point | REDWOOD.Redwood_EnterpriseOneConnection | JD Edwards EnterpriseOne Connection |
Job Definition | REDWOOD.Redwood_EnterpriseOne_ImportOrchestrations | Import Orchestrations from JD Edwards EnterpriseOne |
Job Definition | REDWOOD.Redwood_EnterpriseOne_RunOrchestration | Run an orchestration in JD Edwards EnterpriseOne |
Job Definition | REDWOOD.Redwood_EnterpriseOne_RunOrchestrationTemplate | Template Job Definition to run an orchestration in JD Edwards EnterpriseOne |
Job Definition | REDWOOD.Redwood_EnterpriseOne_RunReport | Run a Report in JD Edwards EnterpriseOne |
Job Definition | REDWOOD.Redwood_EnterpriseOne_RunReportTemplate | Template Definition to run a Report in JD Edwards EnterpriseOne |
Job Definition | REDWOOD.Redwood_EnterpriseOne_ShowOrchestrations | List all existing orchestrations in JD Edwards EnterpriseOne |
Job Definition Type | REDWOOD.Redwood_EnterpriseOne | JD Edwards EnterpriseOne Definition Type |
Library | REDWOOD.Redwood_EnterpriseOne | Library for JD Edwards EnterpriseOne Connector |
Setup
- Locate the JD Edwards EnterpriseOne Connector in the Catalog and install it.
- Navigate to Configure > Admin > Security > Connections.
- Click New.
-
Select the EnterpriseOne Connection type.
-
Click Next or Basic Properties, then create a Queue and Job Server for the Connection. All required settings will be set up automatically.
- ClickNext or Security, then click
to specify which roles can access the connection information. It is recommended to grant the role at least the following additional privileges: View on the JD Edwards Connector Job Server, View Processes on the JD Edwards Connector Jobs Queue, View on library REDWOOD.Redwood_EnterpriseOne, and Run on any Job Definitions users with this role are to run.
- ClickNext or EnterpriseOne Properties
- Enter the URL of the JD Edwards AIS server in the Endpoint field.
- Enter your JD Edwards Username and Password.
- Click Save & Close.
- Optionally, enter your JD Edwards Environment identifier and Role.
- Navigate to Configure > Control > Job Servers, locate the JD Edwards Connector Job Server, start it, and make sure it reaches status Running.
Job Definitions
Redwood_EnterpriseOne_ImportOrchestrations
Imports orchestrations from JD Edwards EnterpriseOne.
Parameters
Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
---|---|---|---|---|---|---|---|
Parameters | connection
|
Connection | The Connection object that defines the connection to the EnterpriseOne server. | String | In |
|
|
Parameters | nameFilter
|
Orchestration Name Filter | Only import orchestrations where the name matches this filter. Wildcards * and ? are supported. If omitted, all available orchestrations are imported. | String | In |
|
|
Generation Settings | overwrite
|
Overwrite Existing Definition | When set to Y, if a definition with the same Business Key already exists, it will be overwritten by the import. When set to N, the import will be skipped if the definition already exists. | String | In | N
|
Y =Yes, N =No |
Generation Settings | importParameters
|
Import Parameters | When set to Y, available input parameters for the Orchestration will be imported as Parameters on the generated Job. | String | In | Y
|
Y =Yes, N =No |
Generation Settings | targetPartition
|
Partition | The Partition to create the new definitions in. | String | In |
|
QueryFilter: User.Redwood System.Partition.Partition%2e;all |
Generation Settings | targetApplication
|
Folder | The Folder to create the new definitions in. | String | In |
|
QueryFilter: User.Redwood System.Application.Application%2e;all |
Generation Settings | targetQueue
|
Default Queue | The default Queue to assign to the generated definitions. | String | In |
|
QueryFilter: User.Redwood System.Queue.Queue%2e;all |
Generation Settings | targetPrefix
|
Definition Name Prefix | The prefix to add onto the name of the imported Orchestration to create the Job Definition name. | String | In |
|
|
Redwood_EnterpriseOne_RunOrchestration
Runs an orchestration in JD Edwards EnterpriseOne.
Parameters
Tab | Name | Description | Documentation | Data Type | Direction |
---|---|---|---|---|---|
Parameters | connection
|
Connection | The Connection object that defines the connection to the EnterpriseOne server. | String | In |
Parameters | orchestrationName
|
Orchestration Name | The name of the orchestration to execute. | String | In |
Parameters | parameters
|
Parameters | Input parameters for the orchestration. Each entry in the array must be specified in name=value format. | String | In |
Parameters | output
|
Orchestration Output | The output of the orchestration run. | String | Out |
Redwood_EnterpriseOne_RunOrchestrationTemplate
Template Job Definition to run an orchestration in JD Edwards EnterpriseOne.
Parameters
Tab | Name | Description | Documentation | Data Type | Direction |
---|---|---|---|---|---|
Parameters | connection
|
Connection | The Connection object that defines the connection to the EnterpriseOne server. | String | In |
Parameters | orchestrationName
|
Orchestration Name | The name of the orchestration to execute. | String | In |
Parameters | output
|
Orchestration Output | The output of the orchestration. | String | Out |
Redwood_EnterpriseOne_RunReport
Runs a report in JD Edwards EnterpriseOne.
Parameters
Tab | Name | Description | Documentation | Data Type | Direction |
---|---|---|---|---|---|
Parameters | connection
|
Connection | The Connection object that defines the connection to the EnterpriseOne server. | String | In |
Parameters | reportName
|
Report Name | The name of the report to run. | String | In |
Parameters | reportVersion
|
Report Version | The version of the report to run. If not specified, the default version will be used. | String | In |
Parameters | jobNumber
|
JD Edwards Job Number | The job number of the UBE run. | String | Out |
Redwood_EnterpriseOne_RunReportTemplate
Template Definition to run a report in JD Edwards EnterpriseOne.
Parameters
Tab | Name | Description | Documentation | Data Type | Direction |
---|---|---|---|---|---|
Parameters | connection
|
Connection | The Connection object that defines the connection to the EnterpriseOne server. | String | In |
Parameters | reportName
|
Report Name | The name of the report to run. | String | In |
Parameters | reportVersion
|
Report Version | The version of the report to run. If not specified, the default version will be used. | String | In |
Parameters | jobNumber
|
JD Edwards Job Number | The job number of the UBE run. | String | Out |
Redwood_EnterpriseOne_ShowOrchestrations
Lists all existing orchestrations in JD Edwards EnterpriseOne.
Parameters
Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
---|---|---|---|---|---|---|---|
Parameters | connection
|
Connection | The Connection object that defines the connection to the EnterpriseOne server. | String | In |
|
|
Parameters | nameFilter
|
Orchestration Name Filter | Only return orchestrations where the name matches this filter. Wildcards * and ? are supported. If omitted, all available orchestrations are returned. | String | In |
|
|
Parameters | listing
|
Orchestration Listing | List of orchestrations that match the filters. | Table | Out |
|
|
Procedures
Finding JD Edwards Orchestrations
To retrieve the list of orchestrations available for scheduling:
-
Navigate to Applications > Redwood > JD Edwards EnterpriseOne , and run Redwood_EnterpriseOne_ShowOrchestrations.
-
Select the Connection.
-
To specify a search string, enter a value in the Orchestration Name Filter field. Wildcards * and ? are supported.
-
Once the Job has finished, right-click the Job Definition and choose Monitor Related Processes, then select the Job and click
listing.rtx
in the Detail View. Sample output is shown below.
Running a JD Edwards Orchestration
To run an orchestration:
-
In the JD Edwards EnterpriseOne Application, run Redwood_EnterpriseOne_RunOrchestration.
-
Select the Connection.
-
Specify the Orchestration Name to run.
-
If you specify Parameters, use a
key=value
format for each parameter, as demonstrated in the following screen shot. -
Run the Job Definition.
Running a JD Edwards Orchestration with a Template
To create a customized Job Definition, optionally with default values, for an orchestration:
-
Right-click the Redwood_EnterpriseOne_RunOrchestrationTemplate Job Definition and choose New (from Template) from the context menu. The New Job Definition screen displays.
- In the Definition tab, delete the default Folder value (if any) and substitute your own Folder name if desired.
-
In the Parameters tab, enter any Default Expressions you want to use.
-
When specifying the Connection value, use the format
EXTCONNECTION:<partition>.<connection name>
.
-
-
In the Parameters tab, specify orchestration parameters by adding them to a Parameter Group named
Orchestration Parameters
. -
Save and then run the new Job Definition.
Out Parameters
When configuring Out Parameters in a Job Definition created from a template, use the following guidelines. The JSON below is a sample response used in this section.
{
"Prop1": "value1",
"Prop2": "value2",
"SubObject": {
"Prop1": "sub value 1",
"Prop3": "value3"
},
"stringArray": [
"string1",
"string2"
]
}
The default behavior is to look up the first JSON node whose name matches an Out Parameter name, and assign the node's value to the Out Parameter. For example, using the above JSON, if you create an Out Parameter named Prop1
, its output value will be value1
.
This rule applies to nested elements as well. If you add an Out Parameter named Prop3
, its output value will be value3
.
If there are multiple occurrences of Prop1
:
-
If the Parameter is an Array Parameter, all matching values (here,
[value1, sub value 1]
) are in the Parameter's value. -
If the Parameter is NOT an Array Parameter, only the first value (here,
value1
) are in the Parameter's value.
If a property points to an object, it will be included in output as a JSON String. For example, if you add a String Out Parameter named SubObject
, the value of the Out Parameter will be {"Prop1": "sub value 1", "Prop3": "value3"}
.
You can map arrays to Array Parameters. For example, if you add an Array Out Parameter named stringArray
, the value of the Out Parameter will be an array (here, ["string1", "string2"]
). However, if you map an array to an Out Parameter that is not an Array Parameter, only the first value of the array is assigned to the Parameter (here, "string1"
)
String and Number Parameters are supported for both single values and arrays.
-
A number value or array of numbers can be assigned to a String Parameter or a Number Parameter.
-
Only numbers can be assigned to a Number Parameter. Attempting to provide a string to a Number Parameter will result in that Parameter not receiving a value. A warning message will be logged in the
stdout.log
file.
If an Out Parameter does not map to any property in the JSON, the Parameter will not be assigned a value. This will not fail the job automatically, but it will write a warning message to the stdout.log
file.
Importing a JD Edwards Orchestration
To import an orchestration as a RunMyJobs Job Definition:
-
Submit Redwood_EnterpriseOne_ImportOrchestrations.
- Select the Connection.
-
To specify a search string, enter a value in the Orchestration Name Filter field. Wildcards * and ? are supported.
-
In the Generation Settings tab, configure the options as follows.
Name Description Overwrite Existing Definition Set to Y
to overwrite existing orchestrations, orN
to create new ones.Import Parameters Set to Y
to create any In Parameters on the new Job Definitions, orN
to not create them.Partition The Partition to create the new Job Definitions in. Folder The Folder to create the new Job Definitions in. Default Queue The default Queue to assign to the generated Job Definitions. Definition Name Prefix The prefix to add onto the name of the imported JD Edwards EnterpriseOne orchestration to create the Job Definition name. -
Submit the Job Definition. When the Job completes, you should have one or more new Job Definitions that are named after the imported orchestrations.
Note: When you import a JD Edwards Orchestration, its Out Parameters will not be imported automatically. You must manually configure them on the generated Job Definition(s).
Running a JD Edwards Report
In the JD Edwards EnterpriseOne Application, submit Redwood_EnterpriseOne_RunReport. Specify the Report Name and, optionally, Report Version.
Running a JD Edwards Report with a Template
To create a customized Job Definition for an orchestration, optionally with default values:
-
Right-click the Redwood_EnterpriseOne_RunReportTemplate Job Definition and choose New (from Template) from the context menu. The New Job Definition pop-up window displays.
- In the Definition tab, delete the default Folder value (if any) and substitute your own Folder name if desired.
-
In the Parameters tab, enter any Default Expressions you want to use.
-
When specifying the Connection value, use the format
EXTCONNECTION:<partition>.<connection name>
.
-
-
Save and then run the new Job Definition.
Configuration Options
You can configure the Connect and Read timeout values for EnterpriseOne via the Registry keys listed below. To test that the values are set correctly, run the process in debug mode. RunMyJobs will log the configuration in the stdout.log
file.
Name | Path | Default Value | Minimum Value | Maximum Value |
---|---|---|---|---|
ConnectTimeout
|
/configuration/jcs/apps/EnterpriseOne/ConnectTimeout
|
20 seconds | 1 seconds | 600 seconds (10 minutes) |
ReadTimeout
|
/configuration/jcs/apps/EnterpriseOne/SocketTimeout
|
60 seconds | 1 second | 600 seconds (10 minutes) |