Accessing Additional Information about Business Services

This chapter discusses how to

Click to jump to parent topicAccessing Javadoc for Business Services

This section provides an overview of Javadoc for business services and discusses how to:

Click to jump to top of pageClick to jump to parent topicUnderstanding Javadoc for Business Services

Javadoc is a tool that parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages. These pages describe the public and protected classes, nested classes, interfaces, constructors, methods, and fields. Javadoc generates the Application Programming Interface (API) documentation for the JD Edwards EnterpriseOne business services source files.

Javadoc is installed automatically when you install the JD Edwards EnterpriseOne system. You access Javadoc by navigating to the javadoc folder that is located in your JD Edwards EnterpriseOne install directory. This is an example of the path you would follow to access javadoc: 

C:\B9\STAGINGA\java\javadoc

Note. Javadoc generates several main pages of documentation, each of which can be launched by double clicking on the corresponding html file in the javadoc folder. This documentation provides instructions for accessing and navigating through the API documentation by launching the overview-summary.html file. If you choose to access the documentation by launching a different file, the instructions might be slightly different.

Javadoc is organized into several main pages of documentation, each of which is described in this table:

Page Title

Description

Overview

The overview page is the main page of API documentation. This page contains a list of all of the available packages and a link to each package.

Package

Each package has its own page that contains a list of each class and interface. The page also contains a summary of each class and interface and provides a link to each.

Class

Each class, interface, nested class and nested interface has its own page. Each page contains a brief description of the class/interface. The page also includes summary and detail tables for field, constructor and method information. The page also includes information about inherited methods.

Tree

Each package has a tree or hierarchy page. The information that appears in the Tree page depends on the page from which the Tree option is selected. Clicking the Tree option from the overview page displays the hierarchy for all packages. Clicking the Tree option from a particular package, class or interface page displays the hierarchy for only that package.

Index

The index page contains an alphabetical list of all classes, interfaces, constructors, methods and fields. You access the index by clicking the Index link in the navigation bar from any page.

Help

The help page provides general instructions about how to use javadoc and overview information about how the documentation is organized. You access the help page by clicking the Help link in the navigation bar from any page.

Display and Navigation Options

To navigate through the Javadoc documentation, you can click on any of the package, class, method, value object or field names that are live links. When you click on these links a new page opens with additional detail about that object. You can also use the links in the navigation bar at the top of each page. The standard navigation bar includes these links:

All javadoc pages are available with or without HTML frames. To view the page with or without frames, click on one of these options at the top of any page:

You can also use the previous and next options at the top of each page to view the next package, class, or interface. Depending on the page you are on, the names of the options change. For example, when you are viewing a package, you can click NEXT PACKAGE or PREV PACKAGE to navigate to another package.

Package Naming Conventions

To access javadoc for a specific business service, you must locate the appropriate package. The naming convention for JD Edwards EnterpriseOne business service packages is: 

oracle.e1.bssv.<OMW object name>

In package naming, objects can be published business services or business services. Published business service object names begin with JP followed by a numeric identification code. For example, the AddressBookManager object name is JP010000. Business service object names begin with J followed by a numeric identification code. For example, the processAddressBook business service object name is J0100001. Therefore, to access javadoc for the AddressBookManager business service, you would select one of these packages from the overview page:

Note. Javadoc for several reference implementations has also been provided. Reference implementation package names include the letter R after the J or JP.

Uses of a Business Service Object

You can also use javadoc to determine where a business service or related object is used. Each documented package, class and interface has its own Use page. The page describes what packages, classes, methods, constructors and fields use any part of the selected class or package. You access the Use page for an object by clicking the Use link in the navigation bar.

For example, if you are viewing class ABC, and you click on Use, the Use page for class ABC displays:

Class Hierarchy

You can use Javadoc to display the hierarchy of all packages, or of individual packages, classes or interfaces. You use the Tree link in the navigation bar to access hierarchy information. If you click the Tree link from the main overview page, the system displays a hierarchical view of all packages along with a hierarchical view of each package.

Alternatively, you can click the Tree link from any package, class or interface page to view the hierarchy for only that package.

Classes are organized by inheritance structure, starting with java.lang.object. The interfaces do not inherit from java.lang.object.

Click to jump to top of pageClick to jump to parent topicPrerequisite

Before you can access Javadoc, you must install your JD Edwards EnterpriseOne system and identify your install directory. Contact your system administrator for assistance.

Click to jump to top of pageClick to jump to parent topicAccessing Javadoc

Access the Javadoc folder in your JD Edwards EnterpriseOne install directory and double click on the overview-summary.html file.

Your web browser opens the main overview page. To view information about a specific business service, click on the corresponding package name. For example, to view information about the AddressBookManager business service, click on package oracle.e1.bssv.JP010000.

The web browser displays the package page, which includes the Class Summary table for the selected package.

Review the information in the Class Summary table and click on the link in the table to view field, constructor and method summary and detail information, along with inherited method information for the business service.

Note. You can access value object information by clicking on the links in the method summary table. For additional information about viewing value objects, proceed to the next task in this section.

Click to jump to top of pageClick to jump to parent topicViewing Value Object and Field Information

Access the javadoc folder in your JD Edwards EnterpriseOne install directory and double click on the overview-summary.html file.

Click the link for the business service you want to review. For example, to view the value objects for the AddressBookManager business service, click oracle.e1.bssv.JP010000.valueobject.

Your web browser opens a new page that lists each value object that is associated with the business service.

Click on the value object that you want to view. The web browser displays a summary of the value object, along with a summary of each field that is included in the value object.

To view detailed information about a field or method, click on the field or method name link.

Note. When viewing fields, the field names are in alphabetical order in the Field Summary table. The Field Detail table lists the fields in the order in which they appear in the source code. This preserves the logical groupings that were established by the programmer.

Click to jump to top of pageClick to jump to parent topicViewing the Uses of an Object in Javadoc

Using any of the previous tasks in this section, access the object on which you want to inquire. Click the Use link in the navigation bar on the Javadoc page.

Click to jump to top of pageClick to jump to parent topicViewing Hierarchy Information

Access the javadoc folder in your JD Edwards EnterpriseOne install directory and double click on the overview-summary.html file. From the main overview page, click the Tree link in the navigation bar. The system displays the hierarchy of all packages.

Note. You can access hierarchy information for a selected package by clicking the Tree link from any package, class or interface page.

Click to jump to parent topicReviewing Input and Response Interfaces

This section provides an overview of input and response interfaces.

Click to jump to top of pageClick to jump to parent topicUnderstanding Input and Response Interfaces

You use input and response interface information to determine what data must be passed into and out of the JD Edwards EnterpriseOne system in order to make a web service function properly. An input interface and a response interface table are provided for each web service operation. The tables are listed in an appendix to this reference guide, and appear in the order in which the web services appear in the reference guide.

The input interface includes all of the fields that comprise the message that the JD Edwards EnterpriseOne web service sends to the external system. Some of the fields are required, while others are optional. If a field is required, the data must be included in the input message, or the web service will not send the message successfully.

The response interface includes all of the fields that are returned to the JD Edwards EnterpriseOne user via the web service or web service operation.

Reading the Input Interface Tables

The input interface tables list all of the classes and fields that are contained in the interface. A class is a container for a group of fields and other classes. In the interface tables, classes are highlighted, and the fields that are included in the class appear indented in the rows below the highlighted class name.

The input interface tables also specify which fields are required when performing a specific action. If a field is required, then a Y appears in the table under the specified action column for that field. These actions are included in the table:

For example, if a value is required in the currencyCode field when adding a record, the table lists a Y in the currencyCode field row under the column titled A. This table illustrates the example:

Class

Field

Data Type

A

C

D/C

I

Key

Financial

              
 

currencyCode

String

Y

      

Y
 

amountAdjustment

BigDecimal

          

In some circumstances, one or more fields within a particular class are required. Typically, the user can select which of the fields within the category to pass in. For example, many web services require a value for the Entity class, which can be passed in using one or more of these fields:

In instances where one of the fields within a class is required, the required information is listed in the row that contains the class heading. This table shows an input interface that requires one of the fields in the Entity - customer class to be passed in:

Class

Field

Data Type

A

C

D/C

I

Key

Entity - customer

    

Y

      

Y
 

entityID

Integer

          
 

entityLongId

String

          
 

entityTaxId

String

          

The input interface tables also specify the data type for each field. Valid data types include:

Lastly, the input interface tables specify which of the fields in the interface are key fields. A key field is a field or set of fields in a database table that together form a single unique identifier for a database record. Depending on the transaction, a key field might not be a required input field, as in the case of a query or if the key is generated by the transaction.

Reading the Response Interface Tables

The response interface tables include the classes and fields that are included in the return message that the web service delivers.

Note. Depending on the data that is available in either the JD Edwards EnterpriseOne or the third-party system, it is possible that some or all of the fields will contain blank values.

Please refer to the documentation for each specific web service operation to determine which fields, if any, will always contain a value if the operation completes successfully.

The response interface tables also specify the data type for each field.

See Also

Appendix A: Input and Response Interfaces