This chapter includes these topics:
This chapter provides detailed information about the business interfaces that are available for the Supplier Master Data business object.
This table lists all of the available interface components:
| Interface Type | Available Interfaces |
|---|---|
| Business Services | The SupplierManager published web service (JP010030) manages the processing of these web service operations: |
| Real-Time Events | This list includes the real-time events for the Supplier Master Data business object: |
| Batch Import Programs | This list includes the batch import programs for the Supplier Master Data business object: |
| Additional Interfaces | The Supplier Master Data business object also uses the following business interfaces:
See Setting Processing Options for Supplier Master MBF - PO (P0100043). |
|
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." |
This section describes the available business services associated with the Supplier Master Data business object.
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.
|
| processSupplierV2 (J0100031) | Use this operation to add, update, or delete supplier information in the JD Edwards EnterpriseOne Address Book, Accounts Payable, and Accounts Receivable systems. This version includes global locator number (GLN) in the process. |
| processSupplierV3 (J0100031) (Release 9.1 Update) | Use this operation to add, update, or delete supplier information in the JD Edwards EnterpriseOne Address Book, Accounts Payable, and Accounts Receivable systems. This version includes global locator number (GLN) and the voucher match automation attributes in the process. |
| getSupplier (J0100032) | Use this operation to query the JD Edwards EnterpriseOne database for existing supplier information. |
| getSupplierV2 (J0100032) | Use this operation to retrieve supplier information, including GLN, from the JD Edwards EnterpriseOne database. |
| getSupplierV3 (J0100032) (Release 9.1 Update) | Use this operation to retrieve supplier information, including GLN and the voucher match automation attributes, from the JD Edwards EnterpriseOne database. |
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 JD Edwards EnterpriseOne Applications Address Book Implementation Guide.
See JD Edwards EnterpriseOne Applications Accounts Payable Implementation Guide.
To access Javadoc for the Supplier Manager web service and its related operations, review these Javadoc packages:
JP010030 (SupplierManager)
J0100031 (processSupplier)
J0100031 (processSupplierV2)
J0100031 (processSupplierV3) (Release 9.1 Update)
J0100032 (getSupplier)
J0100032 (getSupplierV2)
J0100032 (getSupplierV3) (Release 9.1 Update)
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.
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.
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. | 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 |
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:
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. |
Review the information in the processSupplier section of this chapter before using the processSupplierV2 web service operation. All of the information in the processSupplier section also applies to the procesSupplierV2 operation.
The processSupplierV2 operation is a version of the processSupplier web service operation. This web service operation is used to add, update, and delete supplier information with associated GLNs. This version executes the processSupplier (J0100031) web service operation.
Review the information in the processSupplier section of this chapter before using the processSupplierV3 web service operation. All of the information in the processSupplier section also applies to the procesSupplierV3 operation.
The processSupplierV3 operation is a version of the processSupplier web service operation. This web service operation is used to add, update, and delete supplier information with associated GLNs and the voucher match automation attributes. This version executes the processSupplier (J0100031) 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.
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. |
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:
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. |
Review the information in the getSupplier section of this chapter before using the getSupplierV2 web service operation. All of the information in the getSupplier section also applies to the getSupplierV2 operation.
The getSupplierV2 operation is a version of the getSupplier web service operation. This web service operation is used to retrieve supplier information with associated GLNs. This version executes the getSupplier (J0100032) web service operation.
Review the information in the getSupplier section of this chapter before using the getSupplierV3 web service operation. All of the information in the getSupplier section also applies to the getSupplierV3 operation.
The getSupplierV3 operation is a version of the getSupplier web service operation. This web service operation is used to retrieve supplier information with associated GLNs and the voucher match automation attributes.
This version executes the getSupplier (J0100032) web service operation.
This section describes the available real-time events associated with the Supplier Master Data business object, which include:
RTSMOUT, which is a container event for these single events:
RTSMHDR
RTSMPHOUT
RTSMEAOUT
RTSMOUT2, which is a container event for these single events:
RTSMHDR2
RTSMPHOUT2
RTSMEAOUT2
RTSMOUT is used by the JD Edwards EnterpriseOne system to inform third-party systems of supplier additions, changes, or deletions.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code |
|---|---|---|---|---|
| RTSMOUT | Supplier Master | XAPI | Container
Contains these events:
|
01 |
Special Setup
RTSMOUT has some additional special setup requirements due to the logic in the real-time wrapper.
The processing options for version ZJDE0001 of the Supplier Master Real Time Event Wrapper application program (P0100083) determine which phone and email records are sent when records are changed. The purpose of these processing options is to enable filtering of the outbound event, RTSMOUT.
This table explains the processing options:
Enter a code to specify how you want to send contact information. Values are:
0, blank, or null: The system sends only primary contact information for an address book record as single fields. It sends the first telephone number, fax number, and email address of an address book record that matches the type specified in the other processing options.
1: Regardless of the types specified in the other processing options, the system sends the complete collection of contact information, including primary contact information, for an address book record in one group.
2: The system sends primary contact information in single fields, and the complete collection of contact information in a group. This value is a combination of values 0 and 1.
Indicate either the location or use of a telephone number. Values are defined in UDC table 01/PH (Phone Type).
Specify the phone type for the telephone number to use for faxes. Values are defined in UDC table 01/PH (Phone Type).
Specify the electronic address type that the system uses for an individual or an entity for internet communications. Values are defined in UDC table 01/ET (Electronic Address Type).
Objects that Can Initiate the Event
These objects can initiate the event, and the single events contained within this event:
N0100041 – Address Book MBF
N0100043 – Supplier Master MBF
B0100090 - Phones MBF
B0100087 - Who's Who MBF
B0100089 - Electronic Address MBF
P01111 - Contact Information E-mail application
RTSMHDR is used by the JD Edwards EnterpriseOne system to inform third-party systems of supplier additions, changes, or deletions.
| Event Name | Event Description | Event Type | Event Category | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTSMHDR | Supplier Master Details | RTE | Single | 01 | D0100083A: Supplier Master Real Time Record | Included in container event RTSMOUT. |
Conceptual Approach
A supplier record added, modified, or deleted in the JD Edwards EnterpriseOne system creates a new record in a number of tables, such as Supplier Master (F0401) and Address Book Master (F0101). A real-time notification event is triggered in the Supplier Master or Address Book Master Business Function after data is modified in any supplier table.
RTSMPHOUT is used by the JD Edwards EnterpriseOne system to inform third-party systems of supplier phone number changes.
| Event Name | Event Description | Event Type | Event Category | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTSMPHOUT | Supplier Master Phone | RTE | Single | 01 | D0100083B: Supplier Phones Records | Included in container event RTSMOUT. |
Conceptual Approach
A phone number is changed for a supplier. This change is sent out using real-time events. A given supplier may have an infinite number of phone numbers.
RTSMEAOUT is used by the JD Edwards EnterpriseOne system to inform third-party systems of supplier email address changes.
| Event Name | Event Description | Event Type | Event Category | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTSMEAOUT | Supplier Electronic Address | RTE | Single | 01 | D0100083C: Supplier Electronic Address | Included in container event RTSMOUT. |
Conceptual Approach
An email address is added or changed for a supplier. This change is sent out using real-time events. A given supplier may have an infinite number of email addresses.
RTSMOUT2 is used by the JD Edwards EnterpriseOne system to inform third-party systems of supplier additions, changes, or deletions.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code |
|---|---|---|---|---|
| RTSMOUT2 | Supplier Master Version 2 | RTE | Container
Contains these events:
|
01 |
Special Setup
RTSMOUT2 has some additional special setup requirements due to the logic in the real-time wrapper.
The processing options for version ZJDE0001 of the Supplier Master Real Time Event Wrapper application program (P0100083) determine which phone and email records are sent when records are changed. The purpose of these processing options is to enable filtering of the outbound event, RTSMOUT2.
This table explains the processing options:
Enter a code to specify how you want to send contact information. Values are:
0, blank, or null: The system sends only primary contact information for an address book record as single fields. It sends the first telephone number, fax number, and email address of an address book record that matches the type specified in the other processing options.
1: Regardless of the types specified in the other processing options, the system sends the complete collection of contact information, including primary contact information, for an address book record in one group.
2: The system sends primary contact information in single fields, and the complete collection of contact information in a group. This value is a combination of values 0 and 1.
Indicate either the location or use of a telephone number. Values are defined in UDC table 01/PH (Phone Type).
Specify the phone type for the telephone number to use for faxes. Values are defined in UDC table 01/PH (Phone Type).
Specify the electronic address type that the system uses for an individual or an entity for internet communications. Values are defined in UDC table 01/ET (Electronic Address Type).
RTSMHDR2 is used by the JD Edwards EnterpriseOne system to inform third-party systems of supplier additions, changes, or deletions.
| Event Name | Event Description | Event Type | Event Category | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTSMHDR2 | Supplier Header Version 2 | RTE | Single | 01 | D0100101A: Supplier Master Real Time Record | Included in container event RTSMOUT2. |
Conceptual Approach
A supplier record added, modified, or deleted in the JD Edwards EnterpriseOne system creates a new record in a number of tables, such as Supplier Master (F0401) and Address Book Master (F0101). A real-time notification event is triggered in the Supplier Master or Address Book Master Business Function after data is modified in any supplier table.
RTSMPHOUT2 is used by the JD Edwards EnterpriseOne system to inform third-party systems of supplier phone number changes.
| Event Name | Event Description | Event Type | Event Category | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTSMPHOUT2 | Supplier Phone Version 2 | RTE | Single | 01 | D0100101B: Supplier Phones Records | Included in container event RTSMOUT. |
Conceptual Approach
A phone number is changed for a supplier. This change is sent out using real-time events. A given supplier may have an infinite number of phone numbers.
RTSMEAOUT2 is used by the JD Edwards EnterpriseOne system to inform third-party systems of supplier email address changes.
| Event Name | Event Description | Event Type | Event Category | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTSMEAOUT2 | Supplier Elec Addr Version 2 | RTE | Single | 01 | D0100101C: Supplier Electronic Address | Included in container event RTSMOUT2. |
Conceptual Approach
An email address is added or changed for a supplier. This change is sent out using real-time events. A given supplier may have an infinite number of email addresses.
You use batch import programs to import data from an external software system into the JD Edwards EnterpriseOne system, where it can then be processed by EnterpriseOne programs.
This table lists and describes the available batch import programs that are associated with the Supplier Master Data business object: