Supplier Manager Web Service

This chapter provides an overview of the Supplier Manager web service, lists prerequisites, and discusses these web service operations:

processSupplier
getSupplier

Understanding the Supplier Manager Web Service

The SupplierManager web service (JP010030) manages the processing of supplier-related web service operations. This table includes a description of the supplier manager web service operations:

Operation	Description
processSupplier (J0100031)	Use this operation to complete these tasks within the JD Edwards EnterpriseOne Address Book, JD Edwards EnterpriseOne Accounts Payable, and JD Edwards EnterpriseOne Accounts Receivable systems. Add, change or delete supplier records. Add, change or delete supplier address book records. Add, change or delete supplier phone numbers. Add, change or delete supplier electronic address records.
getSupplier (J0100032)	Use this operation to query the JD Edwards EnterpriseOne database for existing supplier information.

Operation

Description

processSupplier (J0100031)

Use this operation to complete these tasks within the JD Edwards EnterpriseOne Address Book, JD Edwards EnterpriseOne Accounts Payable, and JD Edwards EnterpriseOne Accounts Receivable systems.

Add, change or delete supplier records.
Add, change or delete supplier address book records.
Add, change or delete supplier phone numbers.
Add, change or delete supplier electronic address records.

getSupplier (J0100032)

Use this operation to query the JD Edwards EnterpriseOne database for existing supplier information.

Accessing Javadoc for the Supplier Manager Web Service Operations

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

JP010030 (SupplierManager)
J0100031 (processSupplier)
J0100032 (getSupplier)

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.

Prerequisites

Before using the Supplier Manager web service, or any of the related web service operations, you must install and configure the JD Edwards EnterpriseOne Address Book and JD Edwards EnterpriseOne Accounts Payable systems.

See Getting Started With JD Edwards EnterpriseOne Address Book.

See Getting Started with JD Edwards EnterpriseOne Accounts Payable.

processSupplier

This section provides an overview of the processSupplier web service operation.

Understanding the processSupplier Web Service Operation

The processSupplier web service operation is an inbound transaction operation that enables consumers to process supplier information within the JD Edwards EnterpriseOne system. The processSupplier web service operation enables source systems to process supplier information in JD Edwards EnterpriseOne in a real-time fashion. The web service uses JD Edwards EnterpriseOne master business functions to process the supplier information to add, change or delete supplier related records.

The consumer can complete these tasks in the JD Edwards EnterpriseOne Address Book, JD Edwards EnterpriseOne Accounts Payable, and JD Edwards EnterpriseOne Accounts Receivable systems:

Add, change or delete supplier records.
Add, change or delete address book records.
Add, change or delete phone number records.
Add, change or delete electronic address records.

After processing supplier information, the processSupplier web service operation calls the processAddressBook web service operation to process the address book record. If the operation encounters no errors then the processAddressBook web service operation calls the processPhones and processElectronicAddresses web service operations. The AddressBookProcessor web service operation will return either success messages or error messages if the transaction failed.

If AddressBookProcessor returns success, the processSupplier operation calls the SupplierMaster business function (N0100043) to process the supplier records regardless of the success or failure of the phone and electronic address processing.

Note. The processSupplier operation processes address book information and supplier records even if the processPhones and processElectronicAddresses web service operations fail. If the system encounters errors while processing the address book or supplier record information the system rolls back all transactions.

Every change in the supplier address book is a net change. If a null is passed in a variable field the system will check to see if that field has a value in the database. If the field does have a value in the database then the system will not overwrite the field with the null.

Supported Functionality

This section discusses the functionality that the processSupplier operation supports.

Note. If functionality is not explicitly documented as supported functionality, it is to be understood that the functionality is not supported by the integration solution.

When adding, changing or deleting supplier records, the processSupplier operation updates the Supplier Master (F0401), Address Book Master (F0101), Address Book -Who's Who (F0111), Address Book - Phone Numbers (F0115), Address by Date (F0116), Electronic Address (F01151), and Address Organization Structure Master (F0150) tables.

The processSupplier operation does not support localizations.

Setup Considerations

Before you use this operation, you can set business service properties to specify how the system processes supplier information. This table includes information about the business service properties that the processSupplier web service operation uses:

Group	Key	Description	Default Value
J0100031	J0100031_Supplier_MBF_VERSION	Use this business service property to specify which version of the Supplier Master MBF – PO program (P0100043) the operation uses. See Setting Processing Options for Supplier Master MBF - PO (P0100043).	ZJDE0001
J0100001	J0100031_AB_MBF_VERSION	Use this business service property to specify which version of the Address Book MBF – PO (for N0100041) program (P0100041) the operation uses. See Setting Processing Options for Address Book MBF (P0100041).	ZJDE0001

Group

Key

Description

Default Value

J0100031

J0100031_Supplier_MBF_VERSION

Use this business service property to specify which version of the Supplier Master MBF – PO program (P0100043) the operation uses.

See Setting Processing Options for Supplier Master MBF - PO (P0100043).

ZJDE0001

J0100001

J0100031_AB_MBF_VERSION

Use this business service property to specify which version of the Address Book MBF – PO (for N0100041) program (P0100041) the operation uses.

See Setting Processing Options for Address Book MBF (P0100041).

ZJDE0001

Implementation Details

The following table includes information that can help determine whether the processSupplier operation is functioning correctly:

Question	Answer
How can I tell if the operation completes successfully?	If the operation completes successfully, the system returns a confirmation message to the consumer. The return message includes 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: EntityId EntityName EntityTypeCode If the operation completes successfully, the AN8 (Address Number) and ALPH (Alpha Name) fields in the F0101 and F0111 tables and the AN8 field in the F0401 table will be populated.
If I encounter errors while processing a transaction, do I need to reverse the transaction?	This operation uses standard transaction processing. The processSupplier operation processes address book information and supplier records even if the processPhones and processElectronicAddresses operations fail. If the system encounters errors while processing the address book or supplier record information the system rolls back all transactions. No manual update is necessary.
Does this operation use record reservation?	No. This operation does not reserve records.

getSupplier

This section provides an overview of the getSupplier web service operation.

Understanding the getSupplier Web Service Operation

The getSupplier web service operation is a database query operation that enables consumers to query the JD Edwards EnterpriseOne database to retrieve existing supplier information, phone numbers, and electronic address records.

When the getSupplier web service operation is called, it first performs a select on the V0401XPI view (business view over the F0101, F0116, and F0401 tables) which returns zero or more supplier records. If the V0401XPI view produces errors then the program stops processing. Otherwise, the program loops through the returned supplier records and calls the getContact web service operation for each of the supplier records returned. Finally, the getSupplier operation exits and returns any errors to the Supplier Manager web service.

If the operation is successful, the system returns zero to many supplier records to the consumer. You can specify the maximum number of records to return during a query using the Max Rows business service property. It is recommended that you specify selection criteria when you query the JD Edwards EnterpriseOne database. If the operation fails, the system returns an error message to the consumer.

Setup Considerations

Before you use this operation, you can set business service properties to specify how many records the system returns when you query the JD Edwards EnterpriseOne database. This table includes information about the business service properties used by the getSupplier operation:

Group	Key	Description	Default Value
J0100032	J0100032_MAX_ROWS	Use this business service property to define the maximum number of rows that the operation returns when querying the JD Edwards EnterpriseOne database.	100

Note. It is strongly recommended that you set this business service property to a value other than 0 (zero). If you leave this value set to 0, the system returns all matching records. Additionally, it is recommended that you specify selection criteria when you query the JD Edwards EnterpriseOne database. However, open queries are allowed.

Implementation Details

The following table includes information that can help determine whether the getSupplier operation is functioning correctly:

Question	Answer
How can I tell if the operation completes successfully?	If the operation completes successfully, the system returns records that match your search criteria. These records 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, if the query finds matching records, the system returns non-zero values for these fields: MailingName EntityId EntityTypeCode Also, the operation completes successfully if no errors are returned.
If I encounter errors while processing 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. This operation does not reserve records that are returned in a query.