9 Set Up EDD

This chapter contains these topics:

Before you can use EDD, you must set up the system to meet your business needs. To use EDD features, you must have access to a shared directory in the Integrated File System (IFS) on your System i server. If you have access to a shared directory, you can map a network drive to access the shared IFS directory from a Windows PC. This allows for easier access to the directory from your PC. You must set up the IFS directory that you use for EDD with an ASCII CCSID so the documents you distribute are in the correct format.

The system stores the Java system properties in the Configuration Master table (F00CFG). JD Edwards delivers this table with default values for the following:

  • XDO_TOP

  • EDD Classpath

  • JAVA_HOME

See Work with Configuration Master Records in the JD Edwards World Technical Foundation Guide for more information.

Additionally, there are settings for Import/Export that you access from the User Display Preferences program (P00923), which makes EDD more convenient to use.

EDD includes the following components:

  • EDD RPG programs

  • Import/Export RPG programs with modifications, beginning with JD Edwards World release A9.2

  • EDD Java programs. JD Edwards World includes some programs with the software and other prerequisite software you must download from vendors. Beginning with release A9.3, JD Edwards World includes the World EDD Java programs with the software and you must download other vendor's software from their web site. See Section 9.1, "Installing Prerequisite Software" for more information.

  • BIP is also available for advanced distribution tasks

Before You Begin

  • Review Action Code Security and the security on the Integrated File System (IFS) before making Import/Export available to users

  • Ensure that you have proper authority before creating an IFS directory

  • Ensure that you have a User Display Preferences record, otherwise you cannot set up Import/Export preferences

  • Set up IFS directories. EDD uses files in the IFS on your System i server. See Chapter 4, "Work with Import/Export" for information about setting up and working with directories in the IFS.

Note:

Users can create IFS directories with EBCDIC or ASCII CCSIDs. You must set up IFS directories that you use for EDD with an ASCII CCSID. See Chapter 4, "Work with Import/Export" for more information about setting up directories.

9.1 Installing Prerequisite Software

See the following document on the My Oracle Support web site for the applicable required software updates based on your software release level: https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&id=1349790.1 (WS: EDD: Installing Prerequisite Software (Doc ID 1349790.1).

9.2 Setting up xdodelivery.cfg Configuration File (Release A9.3 Update)

EDD uses the xdodelivey.cfg file, a configuration file, throughout the EDD process. Ensure that you store this file in the /World_EDD_A93/resource directory. This file contains:

  • Server information for each of the delivery options (email, FTP, SFTP, direct print)

  • Server IP address, port number, and user information, and so forth

The file might contain one or more server elements for each delivery type, where each of the server elements has the following structure:

<server name="SMTP1" type="smtp_e-mail" default="true">
 <Additional elements>
 </server>

Where:

  • Server name is an identifier for this server. EDD applications use this to retrieve the server information.

  • Type is the type of server. This identifies the type of server (smtp_e-mail, FTP, SFTP, or system).

  • Default is an optional attribute that identifies this server as the default for this type of server. Only one server of each type can be the default with a value = true.

There can only be one default server for each server type. If you mark multiple severs of the same type as the default, the system uses the first server as the default.

The following elements are available for <server type="smtp_e-mail"> and <server type="FTP">:

Element Description
<host> Host name or IP address for this server.
<port> Port for this server.
<username> User name for this server, if necessary.
<password> User password for this server, if necessary.

The following elements are supported for <server type="SFTP">

Element Description
<host> Host name or IP address for this server.
<port> Port for this server.
<username> User name for this server, if necessary.
<password> User password for this server, which the system requires if you chose password authentication.
<authType> Authorization type for this server.

Valid values:

  • password: (default) requires that you provide a password at login

  • publickey: public key authorization type

<privateKeyFile> Location of the client private key file, which the system requires if you use publickey authentication.
<privateKeyPassword> Client private key password, which the system requires if you use publickey authentication.

The following elements are available for <server type="server">. This element provides connection information to the EDD World APIs and you must enter this information.

Element Description
<host> Host name or IP address for this server.
<username> User name for this server. This must be a JD Edwards World user.
<password> User password for this server, which the system requires if you chose password authentication.
<libList> Library list for EDD. This library list must contain the libraries that contain the EDD transaction tables (F00E06, F00E061, F00E062, and F00E063), EDD Configuration table (F00E05), QTEMP, and the UDC table (F0005). QTEMP must be the first library in the library list.
<updatePID> Element which you can use to specify the value to enter in the EDD transaction files when the system processes them.

The following elements are available for <server type="ipp_printer">.

Element Description
<host> Host name or IP address for this server. This is a required field.
<port> Port for this server. This is an optional field. The default value is 631.
<printerName> Enter the name of the printer that is to receive the output. This is a required field.
  • If you use CUPS with the default setup, enter the printer name as /printers/<printer-name>.

  • If you use the Microsoft Internet Information Service (IIS) with the default setup, enter the printer name as /printers/<printer-name>/.printer.

<uri>  
<username> Enter the username for authentication. This is an optional field.
<password> User password for authentication. This is an optional field.
<authType> This is an optional field and valid values for authentication type are:
  • IPP_AUTHTYPE_NONE - no authentication (default)

  • IPP_AUTHTYPE_BASIC - use HTTP basic authentication

  • IPP_AUTHTYPE_DIGEST - use HTTP digest authentication

<encType> This is an optional field and the encryption type can be set to either of the following:
  • IPP_ENCTYPE_NONE - no encryption (default)

  • IPP_ENCTYPE_SSL - use Secure Socket Layer

<proxyHost> Enter the proxy server host name. This is an optional field.
<proxyPort> Enter the proxy server port number. The default = 80. This is an optional field.
<proxyUsername> Enter the username for proxy authentication. This is an optional field.
<proxyPassword> Enter the password for proxy authentication. This is an optional field.
<proxyAuthType> Enter the proxy Authentication Type. This is an optional field.
<filter> Enter Document Filter. This is an optional field.

Note: The Delivery API supports the document filter functionality for all the supported protocols. This functionality allows you to call the native OS command to transform the document before each delivery request. To specify the filter, pass the native OS command string with the two placeholders for the input and output filename: {infile} and {outfile}.


The following attributes are available for <properties> element:

Element Description
<property name="ds-temp-dir"> Location of the temporary directory EDD uses. If you do not specify a temporary directory, the system uses the default temporary directory of xdoRoot/temp.
<property name="ds-buffering"> True or false for buffering mode.

The following is a sample of the xdoDelivery file:

<?xml version='1.0' encoding="UTF-8"?>
<config xmlns="http://xmlns.oracle.com/oxp/delivery/config">
<!--======================================================== 
   servers section
========================================================-->
  <servers>
    <server name="SMTP1" type="smtp_e-mail" default="true">
      <host>mail.mcycompany.com</host>
      <port>25</port>
      <username>username</username>
      <password>password</password>
    </server>
    <server name="SMTP2" type="smtp_e-mail" >
      <host>10.111.222.33</host>
      <port>25</port>
    </server>
    <server name="FTP1" type="FTP" default="true">
      <host>10.111.222.33</host>
      <port>21</port>
      <username>username</username>
      <password>password</password>
    </server>
    <server name="SFTP1" type="SFTP" default="true">
      <host>10.111.222.33</host>
      <port>22</port>
      <username>username</username>
      <password>password</password>
      <authType>password</authType>
    </server>
    <server name="SFTP2" type="SFTP" >
      <host>10.111.222.33</host>
      <port>22</port>
      <authType>publickey</authType>
      <username>username</username>
      <privateKeyFile>/World_EDD_JAVA/resource/id_rsa</privateKeyFile>
      <privateKeyPassword>keypassword</privateKeyPassword>
    </server>    
    <server name="myServer" type="system" default="true">
      <host> System iName </host>
      <username>username</username>
      <password>password</password>
      <libList>QTEMP JDFDTA91</libList>
      <updatePID>EDDPROCESS</updatePID>
    </server>
  </servers>
<!--========================================================
   properties section
========================================================-->
  <properties>
    <property name="ds-temp-dir">/World_EDD_JAVA/temp</property>
    <property name="ds-buffering">true</property>
  </properties>
</config>

Use the XDODelivery Maintenance application on the EDD Setup menu (G00E41) to edit the xdodelivery.cfg file.

Note:

If you need to make changes to the xdodelivery.cfg file, you must modify the file manually using the properties section.

Figure 9-1 XDODelivery Maintenance screen

Description of Figure 9-1 follows
Description of "Figure 9-1 XDODelivery Maintenance screen"

Field Explanation
Server Type This is the value for the type of server being modified. Valid server types are:
  • EMAIL

  • FTP

  • PRINTER

  • SFTP

  • SYSTEM

You must enter a value in this field.

Server Name This is the value for the name of the server. This is the name referenced on setup screens within EDD. These values are maintained in the appropriate UDC tables used by EDD. When the Server Type is populated, the F1 help key displays the current servers for the selected server type.
Default Server This value determines if this is the default server for a server type. Only one server can be set as the default for each server type.

When adding or updating a server, the available properties for that server type are displayed on the screen, allowing you to review/change each property value. For password fields, the property value is encrypted when written to the xdodelivery.cfg file and display as &rsquor;**********' on the screen when inquiring.

Figure 9-2 XDODelivery Maintenance (Properties Displayed) screen

Description of Figure 9-2 follows
Description of "Figure 9-2 XDODelivery Maintenance (Properties Displayed) screen"

Figure 9-3 XDODelivery Maintenance (Password) screen

Description of Figure 9-3 follows
Description of "Figure 9-3 XDODelivery Maintenance (Password) screen"

9.3 Setting Up UDCs for EDD

UDCs are an integral part of EDD. JD Edwards World provides values for certain UDCs and others you must set up prior to using EDD. See Work with User Defined Codes in the JD Edwards World Technical Foundation Guide for information about setting up and maintaining UDCs.

You use certain UDCs to maintain the values for the servers (smtp_e-mail, FTP, SFTP, or System i) that you define in the xdodelivery.cfg file. The server value defines a connection to another server, such as a remote or System i server. For example, you set up UDC 00E/AS to connect to the System i server where you store the EDD data and configuration files. You define the servers in the xdodelivery.cfg file. See Section 9.2, "Setting up xdodelivery.cfg Configuration File (Release A9.3 Update)" for more information.

You must set up the following UDCs:

  • 00E/AS - System Server Alias

    You use this UDC to maintain the values for the system server in the xdodelivery.cfg file. The type parameter in the xdodelivery.cfg file is system.

  • 00E/ES - Email Server Alias

    You use this UDC to maintain the values for the E-mail Server in the xdodelivery.cfg file.

JD Edwards recommends that you set up the following optional UDCs:

  • 00E/FS - FTP Server Alias

    You use this UDC to maintain the values for the FTP server in the xdodelivery.cfg file.

  • 00E/SS - SFTP Server Alias

    You use this UDC to maintain the values for the SFTP server in the xdodelivery.cfg file.

  • 00E/PS - Print Server Alias

    You use this UDC to maintain the values for the direct print server in the xdodelivery.cfg file.

JD Edwards World provides values for the following UDCs:

  • 00E/BE -Valid Email Body Extensions

    File extensions that you use for an email body.

  • 00E/BO - BIP Valid Output extensions

    File extensions that you use for an output file that you create using the BIP APIs.

  • 00E/BT - BIP Valid Template Extensions

    File extensions that you use for a BIP template file.

  • 00E/BY - Body Type

    Values for a body type in an Email Template.

  • 00E/DT - Delivery Type

    Values for the delivery type in the email, such as To, From, Reply-To, and BCC. You can use some of these to override system values.

  • 00E/MT - Mime Types

    MIME types in EDD. The UDC maps a file extension to a standard mime type. The EDD Java programs use the mappings to determine the mime type for a document based on the file extension.

  • 00E/PC - Path Code

    Values for the path code in the F00E063 file.

  • 00E/TT - Template Type

    Template types to use when defining a transformation template.

  • 00E/XO - XSL Valid Output Extensions

    File extensions that you use as the output file from an XSL transformation.

  • 00E/XT - XSL Valid Template Extensions

    File extensions that you use as the template file for an XSL transformation.

9.4 Setting up EDD Configuration Parameters

You set up the EDD configuration parameters to specify default values and information for the EDD system. You use the EDD Configuration (P00E05) program to enter the information and the system stores the values in the Configuration Master table (F00E05).

To set up EDD configuration parameters

Navigation

From Electronic Document Delivery (G00E), enter 29

From Electronic Document Delivery Setup (G00E41), choose EDD Configuration

  1. On EDD Configuration, complete the following fields and click Add.

    • Email From Address

    • Audit BCC

    • Default Burst Address

    • Error Notification Address

    • Batch Job Queue

    • System Server Alias

    • Email Address Code

    • FROM Address Override Code.

    • Encoding Method

    • PDF Profile

    Figure 9-4 EDD Configuration screen

    Description of Figure 9-4 follows
    Description of "Figure 9-4 EDD Configuration screen"

Field Explanation
Email From Address This is the value for the default Email address to be used as the 'From' address in Emails.

Screen-Specific Information

This is the default email address the system uses as the FROM address in EDD. See Section 10.10, "Sending an Email using EDD" for more information.

You must enter a value in this field.

Audit BCC This is the value for the Email address that will be appended to all outgoing Emails in the 'BCC' address field.

Screen-Specific Information

JD Edwards recommends that you enter your email address in this field so you can keep a copy of the email. This allows you to keep a copy of the documents that you send in the email.

Default Burst Address This value is the default address that will be used for the EDD bursting process. The burst process will first attempt to retrieve the email address for bursting from a specified distribution profile. If no address is found for the burst field in the distribution profile, this email address will be used as a default.
Error Notification Address This is the value for the Email address to be used for sending error messages.
Batch Job Queue The name of the object.
System Server Alias This is the name of server alias specified in the xdodelivery.cfg file for server-type = "system". This value will be passed to the Java delivery programs and used to retrieve information from the xdodelivery.cfg file necessary to establish a connection and log on to the server. If the field is left blank, the information for the default server will be used.

Screen-Specific Information

Enter a value for UDC 00E/AS. This value specifies the name of the System i where you store the EDD files.

Email Address Code A user defined code (01/UC) that provides a description of the Email Address or URL Address.

Screen-Specific Information

This is the UDC that specifies the code to use when retrieving the FROM address record from the F01018. See Section 10.10, "Sending an Email using EDD" for more information.

FROM Address Override Code. A user defined code (01/UC) that defines a group of email addresses that can be used with a delivery type = '6'. Since these addresses can be used to override the default "TO" address for an email, they need to be categorized separately from other email addresses in the F01018. If this RPYC field is left blank, a delivery type value of '6' will be invalid.
Encoding Method Specifies the character encoding used in the EDD XML documents.

Screen-Specific Information

This is the encoding method to use for emails ID EDD, if left blank, the system uses UTF-8.

PDF Profile This is the PDF template name. A PDF template contains parameters used when creating a PDF document. These parameters can be used to control PDF report format and security settings.

9.5 Validating the EDD Setup

The RPGLE program to call ValidateEDD.java program (P00EVALED) validates several areas of your EDD configuration and setup information. It also generates an HTML report with the validation information and all system properties. A spooled report on the System i includes the path on the IFS where the HTML report exists.The administrator responsible for setting up EDD should review the report that this program produces to ensure that your system is setup properly.

The program validates the following EDD settings:

  • XDO_TOP parameter is correct

  • xdodelivery.cfg file location and that it includes the correct XML syntax

  • All servers in the xdodelivery.cfg file are accessible.

  • All system server entries in the xdodelivery.cfg file by:

    • Testing the connection to server using the user name and password you specify

    • Verifying it can locate the EDD tables and Control files in the library list you specify

    • Verifying all server entries are in the correct EDD UDC tables

    • Verifying all EDD UDC entries exist

  • All required .jar files are in the correct IFS folders

  • TCP/IP settings.

  • JAVA and JT400 versions.

Navigation

From Electronic Document Delivery (G00E), enter 29

From Electronic Document Delivery Setup (G00E41), choose Validate EDD

9.6 Setting up EDD Substitution Variables

You use EDD substitution variables in an email template. You can enter a variable in the email template and when you generate the email, the system replaces the variable with a value. You use the EDD - Substitution Variables - Selection (P00E042S) program to enter substitution variables and the Substitution Variables Maintenance (P00E042) program to maintain substitution variables. The system stores the variables in the Email Template Variables (F00E042) table.

The Substitution Variables screen displays a list of existing variables.

Following are examples of substitution variables.

9.6.1 Company Address Example

You can enter a substitution variable, such as CO_ADDR for the company name, address and telephone number. You can use the variable &CO_ADDR in email templates to ensure the company name and address has a consistent appearance in all emails. When you generate an email, the substitution value displays as:

Company XYZ

12345 Main Street

Denver, CO

80137

Phone:303-111-2222

If the companies' address or phone number changes in the future, you update only the substitution value and do not have to make any modifications to the templates, which use the substitution variable.

Figure 9-5 Substitution Variables Maintenance screen

Description of Figure 9-5 follows
Description of "Figure 9-5 Substitution Variables Maintenance screen"

9.6.2 Date Example

You can enter a substitution variable, such as DATETODAY to display the date in an email. When you use the &DATETODAY variable in email templates and generate an email, the substitution variable enters the current date in the MM/DD/YYYY format, such as 12/01/2017.

Figure 9-6 Substitution Variables Maintenance (Date) screen

Description of Figure 9-6 follows
Description of "Figure 9-6 Substitution Variables Maintenance (Date) screen"

You can also use date substitutions to display a past or future date in an email by specifying a number of days to add or subtract from the current date.

For example, the substitution value in the Variable Value field displays the date 30 days after today's date in MM/DD/YYYY format.

Figure 9-7 Substitution Variables Maintenance (30 Days After) screen

Description of Figure 9-7 follows
Description of "Figure 9-7 Substitution Variables Maintenance (30 Days After) screen"

9.6.3 Sequence Example

Use the Record Sequence field to set the order in which EDD converts substitution variables. You use this when you want to embed substitution variables within each other. In the following example, the substitution variable DATEP30 is in the variable PAY_BY.

The Variable DATEP30 must have a record sequence greater than the record sequence of PAY_BY, for EDD to convert the embedded variable.

Figure 9-8 Substitution Variables Maintenance (DATEP30) screen

Description of Figure 9-8 follows
Description of "Figure 9-8 Substitution Variables Maintenance (DATEP30) screen"

To set up substitution variables

Navigation

From Electronic Document Delivery (G00E), enter 29

From Electronic Document Delivery Setup (G00E41), choose Substitution Variables

  1. On Substitution Variables, enter 3 in the Option field.

    Figure 9-9 Substitution Variables screen

    Description of Figure 9-9 follows
    Description of "Figure 9-9 Substitution Variables screen"

  2. On Substitution Variables Maintenance, complete the following fields and click Add.

    • Process Name

    • Variable Key

    • Record Sequence

    • Description

    • Variable Value

    Figure 9-10 Substitution Variables Maintenance (Set Up) screen

    Description of Figure 9-10 follows
    Description of "Figure 9-10 Substitution Variables Maintenance (Set Up) screen"

Field Explanation
Process Name The process name will identify a set of variables which can be used in email templates as substitution values.
Variable Key This is the name of the substitution value used in EDD. The substitution values can be used in the body of Emails and will be replaced by substitution text at run time.
Record Sequence EDD Transaction Record Sequence.

Screen-specific information

The record sequence controls the order in which EDD processes the substitution variables. For example, if there are two Substitution Variables:

  • TITLE="Today's date is &DATETODAY"

  • DATETODAY = "yyyy.MM.dd 'at' HH:mm:ss"

The value in the Record Sequence field for DATETODAY must be greater than the value in the Record Sequence field for TITLE if you want EDD to process TITLE substitution prior to the DATETODAY substitution.

Variable Value This is the value of a substitution parameter used in EDD. At run time, this substitution value will replace a substitution variable used in an Email body.

Screen-specific information

For example, when the value in the Variable Key field begins with DATE, EDD performs a date substitution and this value determines the format of the date field. The format is:

xxx|format

Where:

xxx - is the integer that specifies an offset for the Date field. The offset can be a positive (30 - specifies 30 days from the current date) or negative (-30 - specifies 30 days prior to the current date) value.

| - use the separator character only for an offset.

format -use the Java Simple Date Format to specify the formatting parameters for the field. For example, the Variable Key = :

  • yyyy.MM.dd 'at' HH:mm z displays the current date in the format 2008.12.01 at 10:00:00 AM

  • -30|yyyy.MM.dd 'at' HH:mm z displays the date 30 days prior to the current date in the format 2008.11.01 at 10:00:00 AM


To maintain substitution variables

  1. On Substitution Variables, enter 2 in the Option field.

  2. On Substitution Variables Maintenance, change the values in any of the fields and click Change.