This chapter includes these topics:
This chapter provides detailed information about the additional business interfaces that are available for the EnterpriseOne Foundation system.
This table lists all of the available interface components:
| Interface Type | Available Interfaces |
|---|---|
| Business Services | The FoundationEnvironmentManager (JP000000) manages these web service operations: |
|
Note: You can find additional technical information about each type of business interface component. For additional descriptions of the information available, and instructions for finding this information, see Chapter 5, "Accessing Additional Information for Business Interface Components." |
The Foundation Environment web service (JP000000) manages the processing of the these web service operations:
You use the getUserDefinedCode web service operation to retrieve and review user defined codes from the JD Edwards EnterpriseOne system.
lookupBusinessUnits (J0000040)
You use this operation to retrieve business unit values when searching for valid business units in the EnterpriseOne database.
Use this method to retrieve sales order type description values from user defined code (UDC) table 00/DT.
lookupCurrencyCodes (J0000060)
You use this operation to retrieve currency code values when searching for valid currency codes in the EnterpriseOne database.
setUserValues and getUserValues (J0000070)
Use the setUserValues method to save the user-entered values in the mobile sales application. Use the getUserValues method to retrieve previously saved user-entered values.
Use this operation to retrieve the language preference, date separator and format, and other profile information from the EnterpriseOne database for the signed - on mobile applications user.
Use this operation to retrieve user defined code details for a specified code.
Before using this web service, you should be familiar with how user defined codes (UDCs) are used in the JD Edwards EnterpriseOne system.
To access Javadoc for the FoundationEnvironmentManager web service and its related operations, review these Javadoc packages:
JP000000 (FoundationEnvironmentManager)
J0000030 (getUserDefinedCode)
J0000040 (lookupBusinessUnits)
J0000050 (getUDCDescription)
J0000060 (lookupCurrencyCodes)
J0000070 (get or setUserValues)
J0000080 (getUserProfile)
J0000090 (lookupUDC)(
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.
This operation contains the getExpenseManagementValuesList method, which is used to retrieve expense management UDC values. This method is used in the Expense Management mobile application.
|
Note: When you enter a query, you must specify selection criteria. The operation does not allow a query without selection criteria. |
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. |
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:
|
| 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. |
The lookupBusinessUnits web service operation is a database query operation that enables consumers to retrieve and review business unit values that are stored in the JD Edwards EnterpriseOne system.
The operation retrieves this data from the EnterpriseOne system, if it exists in the database:
BusinessUnit
BusinessUnitType
BusinessUnitDescription
Company
CategoryCodeBusinessUnit, which includes:
Division
Region
Group
BranchOffice
DepartmentType
PersonResponsible
LineOfBusiness
CategoryCodeCostCt008 through CategoryCodeCostCt023
CategoryCodeCostCenter24 through CategoryCodeCostCenter50
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 lookupBusinessUnit operation uses:
| Group | Key | Description | Default Value |
|---|---|---|---|
| J0000040 | J0000040_MAX_ROWS | Use this business service property to specify the maximum number of F0006 records the operation can return for a query. | 100 |
This table includes information that can help determine whether the lookupBusinesUnit operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, the system returns zero or more 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:
|
| 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. |
The getUDCDescription (J0000050) is a database query operation that enables consumers to retrieve the sales order type description values from user-defined code table 00/DT in the EnterpriseOne database. getUDCDescription is called by the getDocumentTypeDescription method.
This operation retrieves the description001 value if data exists in the database.
This operation is called from within the MobileSalesOrderManager published business service (JP42M000).
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 document type description is returned, based on the selection criteria.
At a minimum, the system returns non-zero values for the description001 field. |
| 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. |
The lookupCurrencyCodes web service operation is a database query operation that enables consumers to retrieve and review currency code values that are stored in the JD Edwards EnterpriseOne system.
The operation retrieves this data from the EnterpriseOne system, if it exists in the database:
CurrencyCode
CurrencyDescription
EditCode
CurrencyDecimals
CheckRoutine
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 lookupCurrencyCodes operation uses:
| Group | Key | Description | Default Value |
|---|---|---|---|
| J0000060 | J0000060_MAX_ROWS | Use this business service property to specify the maximum number of F0013 records the operation can return for a query. | 100 |
This table includes information that can help determine whether the lookupCurrencyCodes operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, the system returns zero or more 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:
|
| 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. |
The setUserVaues web service operation is an inbound transaction operation that enables consumers to save the user-entered values from the mobile sales application in the JD Edwards EnterpriseOne database. This operation retrieves these items, if the insert or update database operation is successful:
numRowsInserted
numRowsUpdated
If this operation is successful, one of the above fields will contain a value of 1.
The getUserValues web service operation is a database query operation that enables consumers to retrieve saved user-entered values in the mobile sales application from the JD Edwards EnterpriseOne database. This operation retrieves these items for each mobile user-entered value record, if the data exists in the database:
addressNumberSoldTo
addressNumberShipTo
documentOrderInvoiceE
itemFreeForm
documentTypesList
searchOnDate
todayMinus
todayPlus
salesBranchPlantsList
availabilityBranchPlantsList
priceBranchPlantsList
availabilityItemFreeForm
priceItemFreeForm
unitOfMeasure
reference1
omitZeroQuantities
This table includes information that can help determine whether the setUserValues operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, one of these fields will contain a value of 1:
|
| If I encounter errors while process a transaction, do I need to reverse the transaction? | This is a database Insert/update operation that does not perform transactions. If the system encounters errors during processing, no data in the JD Edwards EnterpriseOne system is updated. No manual updates are required. |
| Does this operation use record reservation? | No. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing. |
This table includes information that can help determine whether the getUserValues operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, zero to many records are returned, based on the selection criteria. 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. |
| If I encounter errors while process a transaction, do I need to reverse the transaction? | This is a database query operation that does not perform transactions. If you encounter errors during processing, review your search criteria and business service property settings and try your query again. If the operation does not return any records, verify that records matching your query exist in the JD Edwards EnterpriseOne database. |
| Does this operation use record reservation? | No. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing. |
The getUserProfile web service operation retrieves LanguagePreference, DateSeparator, DateFormat, and other data from the JD Edwards EnterpriseOne database. This operation retrieves these items, if the data exists in the database:
LanguagePreference
DateSeparator
DateFormat
fup
uprc
pqoh
This table includes information that can help determine whether the getUserProfile operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, zero to many records are returned, based on the selection criteria. 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 operation returns non-zero values for these fields:
|
| If I encounter errors while process a transaction, do I need to reverse the transaction? | This is a database query operation that does not perform transactions. If you encounter errors during processing, review your search criteria and business service property settings and try your query again. If the operation does not return any records, verify that records matching your query exist in the JD Edwards EnterpriseOne database. |
| Does this operation use record reservation? | No. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing. |
The lookupIDC web service operation retrieves user defined code details of a specific UDC and description from the JD Edwards EnterpriseOne database. This operation retrieves these items if the data exists in the database:
UserDefinedCode
Description1
Description 2
Before you use this operation, you can set business services properties to specify how many records the system returns for a query. This table includes information about the business service property that the lookup IDC operation uses:
| Group | Key | Description | Default Value |
|---|---|---|---|
| J0000090 | J0000090_V0005A_MAX_GRID_ROWS_RETURNED | Use this business service property to specify the maximum number of header records the operation can return for a query. | 100 |
This table includes information that can help determine whether the lookupUDC operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, zero to many records are returned, based on the selection criteria. 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:
|
| If I encounter errors while process a transaction, do I need to reverse the transaction? | This is a database query operation that does not perform transactions. If you encounter errors during processing, review your search criteria and business service property settings and try your query again. If the operation does not return any records, verify that records matching your query exist in the JD Edwards EnterpriseOne database. |
| Does this operation use record reservation? | No. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing. |