Foundation Environment Web Service

This chapter provides an overview of the Foundation Environment web service, lists prerequisites, and discusses the getUserDefinedCode web service operation (J0000030).

Click to jump to parent topicUnderstanding the Foundation Environment Web Service

The Foundation Environment web service (JP000000) manages the processing of the getUserDefinedCode web service operation. You use the getUserDefinedCode web service operation to retrieve and review user defined codes from the JD Edwards EnterpriseOne system.

Accessing Javadoc for the Foundation Environment Web Service Operations

To access Javadoc for the Foundation Environment web service and its related operations, review these Javadoc packages:

See Accessing Javadoc for Business Services.

Reviewing Input and Response Interfaces

To review information about the classes and fields that are used by these web service operations, you can review the input and response interface tables. Input and response interface tables list the classes and fields used by each operation, the key fields, the data types of each fields, and which fields or classes are required for each action.

See Accessing Additional Information about Business Services, Appendix A: Input and Response Interfaces.

Click to jump to parent topicPrerequisites

Before using this web service, you should be familiar with how user defined codes (UDCs) are used in the JD Edwards EnterpriseOne system.

Click to jump to parent topicgetUserDefinedCode

This section provides an overview of the getUserDefinedCode web service operation and lists prerequisites.

Click to jump to top of pageClick to jump to parent topicUnderstanding the getUserDefinedCode Web Service Operation

The getUserDefinedCode web service operation is a database query operation that enables consumers to retrieve and review user-defined code (UDC) tables that are stored in the JD Edwards EnterpriseOne system.

UDC tables are used throughout the EnterpriseOne system. They enable consumers to store, track, calculate, and process information that is specific to their business operations. The getUserDefinedCode operation enables consumers to search on UDC tables and review information about the tables and the values that are stored in those tables.

Note. When you enter a query, you must specify selection criteria. The operation does not allow a query without selection criteria.

Setup Considerations

Before you use this operation, you can set business service properties to specify how many records the system returns for a query. This table includes information about the business service property that the getUserDefinedCode operation uses:

Group

Key

Description

Default Value

J0000030

J0000030_V0004A_MAX_GRID_ROWS_RETURNED

Use this business service property to specify the maximum number of records that the system returns for a query.

100

Note. It is strongly recommended that consumers set this business service property to a value other than 0. Entering 0 in this property will allow the operation to retrieve all records that match the search criteria, and could cause performance issues.

Implementation Details

This table includes information that can help determine whether the getUserDefinedCode operation is functioning correctly:

Question

Answer

How can I tell if the operation completes successfully?

If the operation completes successfully, the system returns UDC records to the consumer. The records that are returned to the consumer include all of the fields that are listed in the response interface for this operation. However, some of those fields can contain blank or zero values, depending on the data that exists in the JD Edwards EnterpriseOne system.

At a minimum, the system returns non-zero values for these fields:

  • productCode

  • userDefinedCodeTable

  • description1

If I encounter errors while process a transaction, do I need to reverse the transaction?

This operation does not process transactions, therefore, no updates are necessary if you encounter errors.

If you receive errors while processing this operation, review your selection criteria and business service properties, and then retry your query.

If you do not receive any matching records, review the data in the EnterpriseOne system to verify that the records for which you are searching exist in the database.

Does this operation use record reservation?

No. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing.