This chapter includes these topics:
Section 29.2, "Customer Master Data Business Services - CustomerManager"
Section 29.3, "Customer Master Data Business Services - CustomerAndContactManager"
This chapter provides detailed information about the business interfaces that are available for the Customer Master Data business object.
This table lists all of the available interface components:
| Interface Type | Available Interfaces |
|---|---|
| Business Services | The CustomerManager published business service (JP010020) manages these business services:
The CustomerAndContactManager published business service (JP010050) manages these business services:
The Customer Master Data business object also uses the getCustomerCreditLimits method (J000044), which is managed by the FinancialComplianceManager. See Section 34.2, "FinancialComplianceManager Business Services." |
| Real-Time Events | This list includes the real-time events for the Customer Master Data business object:
Note that several of the single events contained within RTCMOUT3 are also contained within RTCMOUT2. The documentation for those events is located under the RTCMOUT2 container event. |
| Batch Import Programs | This list includes the batch import programs for the Customer Master Data business object: |
| Additional Interfaces | The Customer Master Data business object also uses the following business interfaces:
See Setting Processing Options for Customer Master MBF - PO (P0100042) |
|
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 CustomerManager (JP010020) business services associated with the Customer Master Data business object, which include:
| Operation | Description |
|---|---|
| getCustomer (J0100022) | Use this operation to retrieve and review customer information, including address, phone numbers, electronic addresses, and contact information, from the JD Edwards EnterpriseOne database. |
| getCustomerV2 (J0100022) | Use this operation to retrieve and review customer information such as address, phone number, electronic address, contact information, and global locator number (GLN) from the JD Edwards EnterpriseOne database. |
| getCustomerV3 (J0100022) (Release 9.1 Update) | Use this operation to retrieve and review customer information such as address, phone number, electronic address, contact information, and global locator number (GLN) from the JD Edwards EnterpriseOne database. You can also search for customers by address using this operation.
This is a LIKE query method that is case insensitive. |
| getCustomerCreditInformation (J0100023) | Use this operation to retrieve and review customer credit information from the JD Edwards EnterpriseOne Accounts Receivable system. |
| getCustomerCreditInformationV2 (J0100023) | Use this operation to retrieve and review customer credit information, including GLN, from the JD Edwards EnterpriseOne Accounts Receivable system. |
| processCustomer (J0100021) | Use this operation to add, change, or delete customer information in the JD Edwards EnterpriseOne system. |
| processCustomerV2 (J0100021) | Use this operation to add, change, or delete customer information, including GLN, in the JD Edwards EnterpriseOne system. |
| processCustomerV3 (J0100021) (Release 9.1 Update) | Use this operation to add, change, or delete customer information, including GLN, in the JD Edwards EnterpriseOne system.
Using this method, the user can provide the state description instead of the state code, and the system will derive the state code. |
To access Javadoc for the CustomerManager web service and its related operations, review these Javadoc packages:
JP010020 (CustomerManager)
J0100022 (getCustomer)
J0100022 (getCustomerV2)
J0100022 (getCustomerV3) (Release 9.1 Update)
J0100023 (getCustomerCreditInformation)
J0100023 (getCustomerCreditInformationV2)
J0100021 (processCustomer)
J0100021 (processCustomerV2)
J0100021 (processCustomerV3) (Release 9.1 Update)
Before using this web service, or any of the related operations, you must install and configure the JD Edwards EnterpriseOne Address Book and Accounts Receivable systems. Additionally, you should be familiar with customer and contact information that is stored in the Address Book system.
See "Setting Up the JD Edwards EnterpriseOne Address Book System" in the JD Edwards EnterpriseOne Applications Address Book Implementation Guide, and "Entering Address Book Records" in the JD Edwards EnterpriseOne Applications Address Book Implementation Guide.
See "Setting Up the JD Edwards EnterpriseOne Accounts Receivable System" in the JD Edwards EnterpriseOne Applications Accounts Receivable Implementation Guide, and "Setting Up Customer Master Information" in the JD Edwards EnterpriseOne Applications Accounts Receivable Implementation Guide.
The getCustomer web service operation is a database query operation that enables consumers to retrieve and review customer information from the JD Edwards EnterpriseOne database. This operation retrieves these items for each customer, if the data exists in the database:
Address book information, including:
Phone numbers.
Electronic addresses.
Customer master information.
Who's Who line 0 contact information.
Parent address information.
The operation uses the business view V03012JA to select records. Then the operation uses the AB – Get Parent Address business function (B0100002) to retrieve the parent address for each record the operation returns. If the operation is successful, zero to many records are returned. If the operation encounters errors, processing stops and the errors are returned to the consumer.
This section discusses the functionality that the getCustomer 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. |
The getCustomer operation does not retrieve related-person information for a specified customer.
Before you use this operation, you can set business service properties to specify how the system retrieves data from the database. This table includes information about the business service properties that the getCustomer operation uses:
| Group | Key | Description | Default Value |
|---|---|---|---|
| J0100022 | J0100022_MAX_ROWS | Use this business service property to specify the maximum number of records the operation can return for a query. | 100 |
|
Note: It is recommended that this business service property is configured and used. Also, it is strongly recommended that the consumer pass in selection criteria when performing a query. If these two recommendations are not followed, the operation attempts to fetch all the records from the database, which can significantly impact performance. |
See JD Edwards EnterpriseOne Tools Business Services Development Methodology Guide.
This table includes information that can help determine whether the getCustomer 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 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. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing. |
Review the information in the getCustomer section of this chapter before using the getCustomerV2 web service operation. All of the information in the getCustomer section also applies to the getCustomerV2 operation.
The getCustomerV2 operation is a version of the getCustomer web service operation. This web service is operation is used to retrieve customer information with associated GLNs. This version executes the getCustomer (J0100022) web service operation.
Review the information in the getCustomer and getCustomerV2 sections of this chapter before using the getCustomerV3 web service operation. All of the information in those sections also applies to the getCustomerV3 operation.
The getCustomerV3 operation is a version of the getCustomer web service operation. This web service operation is used to retrieve customer information using a LIKE query that is case insensitive. This method also enables users to search for customers by address. This version executes the getCustomer (J0100022) web service operation.
The getCustomerCreditInformation web service operation is an inbound transaction operation that enables consumers to retrieve customer credit information from the JD Edwards EnterpriseOne database.
The operation uses several business functions, including the CreditCheckProcessing business function (B4200420,) to process credit information. If the operation is successful, credit information for the specified entity is returned to the consumer. If the operation encounters errors, processing stops and the errors are returned to the consumer.
This table includes information that can help determine whether the getCustomerCreditInformation operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, records containing credit information for the specified entities are returned 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 processing a transaction, do I need to reverse the transaction? | This operation does not perform transactions. No data in the EnterpriseOne system is updated when this operation processes. If you encounter errors when processing this operation, review the error messages, along with your selection criteria, and retry your query. Additionally, you can verify that records matching your selection criteria exist in the EnterpriseOne database. |
| Does this operation use record reservation? | No. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing. |
Review the information in the getCustomerCreditInformation section of this chapter before using the getCustomerCreditInformationV2 web service operation. All of the information in the getCustomerCreditInformation section also applies to the getCustomerCreditInformationV2 operation.
The getCustomerCreditInformationV2 operation is a version of the getCustomerCreditInformation web service operation. This web service is operation is used to retrieve customer credit information with associated GLNs. This version executes the getCustomerCreditInformation (J0100023) web service operation.
The processCustomer web service operation is an inbound transaction operation that enables consumers to add, change, or delete customer records from the EnterpriseOne database.
The operation uses the CustomerMasterMBF business function (N0100042) to process customer information. If the operation is successful, the system returns a completion message to the consumer. If the operation encounters errors, processing stops and the errors are returned to the consumer.
|
Note: This operation calls the processAddressBook web service operation to process customer address information. If the operation encounters errors while processing address information, processing stops and those errors are returned to the consumer. |
See Section 35.2, "Address Book Business Services - AddressBookManager."
This section discusses the functionality that the processCustomer 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. |
Before you use this operation, you can set business service properties to specify how the system processes customer and address information. This table includes information about the business service properties that the processCustomer operation uses:
| Group | Key | Description | Default Value |
|---|---|---|---|
| J0100021 | J0100021_CUS_MBF_VERSION | Use this business service property to specify the version of the CustomerMasterMBF business function (N0100042) that the operation uses when processing customer data. | ZJDE0001 |
| J0100021 | J0100021_AB_MBF_VERSION | Use this business service property to specify the version of the AddressBookMasterMBF (N0100041) that the operation uses when processing customer address information. You should enter a different version than you use in the business service properties of the processAddressBook business service. | ZJDE0001 |
See JD Edwards EnterpriseOne Tools Business Services Development Methodology Guide.
This table includes information that can help determine whether the processCustomer operation is functioning correctly:
| Question | Answer |
|---|---|
| How can I tell if the operation completes successfully? | If the operation completes successfully, the consumer receives a successful return message.
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 processing a transaction, do I need to reverse the transaction? | This operation uses standard transaction processing. 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. |
Review the information in the processCustomer section of this chapter before using the processCustomerV2 web service operation. All of the information in the processCustomer section also applies to the processCustomerV2 operation.
The processCustomerV2 operation is a version of the processCustomer web service operation. This web service is operation is used to add, update, or delete customer information with associated GLNs. This version executes the getCustomerCreditInformation (J0100021) web service operation.
Review the information in the processCustomer and processCustomerV2 sections of this chapter before using the processCustomerV3 web service operation. All of the information in the those sections also applies to the processCustomerV3 operation.
The processCustomerV3 operation is a version of the processCustomer web service operation. This web service operation is used to add, update, or delete customer information with associated GLNs. This version allows the user to pass in the state description rather than the state code, and the sytem will derive the state code from the entered state description. This version executes the getCustomerCreditInformation (J0100021) web service operation.
This section describes CustomerAndContactManager published business service (JP010050). This published business service processes two methods, which are both contained under other published business services.
The CustomerAndContactManager published business service manages these business services:
processCustomer (J0100021)
This method is documented under the CustomerManager published business service (JP010020, which is documented in this chapter.
processContact(J0100003)
This method is documented under the AddressBookManager published business service.
See Section 35.2, "Address Book Business Services - AddressBookManager."
This section describes the available real-time events associated with the Customer Master Data business object, which include:
RTCMOUT, which is a container event for these single events:
RTCMOUT2, which is a container event for these single events:
RTCMOUT3, which is a container event for these single events:
RTCMHDR3
RTCMAAOUT *
RTCMEAOUT2
RTCMPHOUT2 *
RTCMCCOUT2 *
RTABCCOUT *
* Note that many of the single events contained within RTCMOUT3 are also contained within RTCMOUT2. Documentation for those single events can be found in the RTCMOUT2 section.
RTCMOUT is used by the JD Edwards EnterpriseOne system to notify third-party systems of customer additions, changes, or deletions.
|
Note: There are three customer-related RTEs, which include RTCMOUT, RTCMOUT2, and RTCMOUT3. RTCMOUT is documented in this section, and was the original customer RTE. RTCMOUT2 and RTCMOUT3 were created to handle additional customer-related changes for the JD Edwards EnterpriseOne integration with CRM On Demand. RTCMOUT2 and RTCMOUT3 are discussed in the next sections. |
| Event Type | Event Description | Event Category | Event Aggregate | Product Code |
|---|---|---|---|---|
| RTCMOUT | Customer Master | RTE | Container
Container event for:
|
01 |
Please see the appropriate real-time events that are contained by this event for more information about the fields, conceptual approach, and processes that can initiate this event.
Special Setup
RTCMOUT has some additional special setup requirements due to the logic in the real-time wrapper.
The processing option for version ZJDE001 of the Customer Master Real Time Event Wrapper Application program (P0100077) determines whether RTCMOUT is always sent or is sent only if certain fields are changed. The purpose of the processing option is to enable filtering of the outbound event, RTCMOUT.
When the processing option is 0, blank, or null, no filtering occurs, and RTCMOUT is sent whenever a change is made to a customer master record. If the processing option is 1, an event is sent only if one of the five territory alignment fields have been changed. Events always occur on an Add or Delete. The five territory alignment fields are Industry Classification Code, City, State, Zip, and Country. If one of these fields have changed and the filter is turned off, a flag is set in a cTerritoryAlign parameter in the event data structure. This flag is a signal that something has changed in those five fields.
Objects that Can Initiate the Event
These objects can initiate the RTCMOUT event and the single events contained within this event:
N0100041 - Address Book MBF
N0100042 - Customer Master MBF
P0111 - Whos Who application
B0100087 - Who's Who MBF
B0100089 - Electronic Address MBF
B0100090 - Phones MBF
RTCMHDR is used by the JD Edwards EnterpriseOne system to notify third-party systems of customer additions, changes, or deletions.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTCMHDR | Customer Master Header | RTE | Single | 01 | D0100077A: Customer Master Real Time Record | Included in container event RTCMOUT. |
Conceptual Approach
A customer record added, modified, or deleted in the JD Edwards EnterpriseOne system creates a new record in a number of tables such as Customer Master by Line of Business (F03012) and Address Book Master (F0101) tables. A real-time notification event is triggered in the Customer Master or Address Book Master Business Function after data is modified to any customer table.
RTCMPHOUT is used by the JD Edwards EnterpriseOne system to inform third-party systems of customer phone number changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTCMPHOUT | Customer Master Phone | RTE | Single | 01 | D0100077B: Customer Phones Wrapper Data Structure | Included in container event RTBUOUT |
Conceptual Approach
A phone number is changed in the JD Edwards EnterpriseOne system for a customer. This change is sent out using real-time events. A given customer may have an infinite number of phone numbers.
RTCMEAOUT is used by the JD Edwards EnterpriseOne system to inform third-party systems of customer email address changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTCMEAOUT | Customer Electronic Address | RTE | Single | 01 | D0100077C: Customer Master Real Time Email Structure | Included in container event RTCMOUT |
Conceptual Approach
An email address is added or changed in the JD Edwards EnterpriseOne system for a customer. This change is sent out using real-time events. A given customer may have an infinite number of email addresses.
RTCMCCOUT is used by the JD Edwards EnterpriseOne system to inform third-party systems of customer category code changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTCMCCOUT | Customer Category Codes | RTE | Single | 01 | D0100077D: Customer Master Real Time Cat Codes Structure | Included in container event RTCMOUT. |
Conceptual Approach
A customers category code data is added or changed in the JD Edwards EnterpriseOne system. This change is sent out using real-time events.
This section provides the details of the RTCMOUT2 RTE.
The RTCMOUT2 RTE structure publishes customer data in a format that can be easily consumed by external systems. RTCMOUT2 is used by the JD Edwards EnterpriseOne system to notify third-party systems of customer additions, changes, or deletions.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code |
|---|---|---|---|---|
| RTCMOUT2 | Customer Master Version 2 | RTE | Container
Container event for:
|
01 |
Special Setup
RTCMOUT2 has some additional special setup requirements due to the logic in the real-time wrapper.
The processing option for version ZJDE0001 of the Customer Master Real Time Event Wrapper Application program (P0100077) determines whether RTCMOUT2 is always sent or is sent only if certain fields are changed. The purpose of the processing option is to enable filtering of the outbound event, RTCMOUT2.
When the processing option is 0, blank, or null, no filtering occurs, and RTCMOUT2 is sent whenever a change is made to a customer master record. If the processing option is 1, an event is sent only if one of the five territory alignment fields has been changed. Events always occur on an Add or Delete. The five territory alignment fields are Industry Classification Code, City, State, Zip, and Country. If one of these fields has changed and the filter is disabled, a flag is set in a cTerritoryAlign parameter in the event data structure. This flag is a signal that something has changed in those five fields.
Objects that Can Initiate the Event
These objects can initiate the RTCMOUT2 event, and the single events contained within the event:
N0100041 -Address Book MBF
N0100042 -Customer Master MBF
B0100087 - Who's Who MBF
R01840 - Effective Address Update
RTCMHDR2 is used by the JD Edwards EnterpriseOne system to notify third-party systems of customer additions, changes, or deletions.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTCMHDR2 | Customer Header Version 2 | RTE | Single | 01 | D0100096A | Included in container event RTCMOUT2. |
Conceptual Approach
A customer record added, modified, or deleted in the JD Edwards EnterpriseOne system creates a new record in a number of tables such as the Customer Master by Line of Business (F03012) and Address Book Master (F0101) tables. A real-time notification event is triggered in the Customer Master or Address Book Master Business Function after data is modified in any customer table.
RTCMEAOUT2 is used by the JD Edwards EnterpriseOne system to inform third-party systems of customer email address changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTCMEAOUT2 | Customer Elec Addr Version 2 | RTE | Single | 01 | D0100096C | Included in container event RTCMOUT2. |
Conceptual Approach
An email address is added or changed in the JD Edwards EnterpriseOne system for a customer. This change is sent using RTEs. A given customer may have an infinite number of email addresses.
RTCMAAOUT is used by the JD Edwards EnterpriseOne system to inform third-party systems of alternate address data changes for customers.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTCMAAOUT | Customer Alternate Address | RTE | Single | 01 | D0100096D | Included in container event RTCMOUT2. |
Conceptual Approach
An alternate address is added or changed in the JD Edwards EnterpriseOne system for a customer. This change is sent using RTEs. A given customer may have an infinite number of alternate addresses.
RTCMPHOUT2 is used by the JD Edwards EnterpriseOne system to inform third-party systems of customer phone number changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTCMPHOUT2 | Customer Phone Version 2 | RTE | Single | 01 | D0100096E | Included in container event RTCMOUT2. |
Conceptual Approach
A phone number is changed in the JD Edwards EnterpriseOne system for a customer. This change is sent using RTEs. A given customer may have an infinite number of phone numbers.
RTCMCCOUT2 is used by the JD Edwards EnterpriseOne system to inform third-party systems of customer category code changes.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTCMCCOUT2 | Customer Cat Codes Version 2 | RTE | Single | 01 | D0100096I | Included in container event RTCMOUT2. |
Conceptual Approach
A customer's category code data is added or changed in the JD Edwards EnterpriseOne system. This change is sent out using RTEs.
RTABCCOUT is used by the JD Edwards EnterpriseOne system to inform third-party systems of address book category code changes.
| Event Name | Event Description | Event Type | Event Category | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTABCCOUT | Address Book Category Codes | RTE | Single | 01 | D0100096H | Included in container event RTCMOUT2. |
Conceptual Approach
A customer's address-book category-code data is added or changed in the JD Edwards EnterpriseOne system. This change is sent using real-time events.
RTCMOUT3 is used by the JD Edwards EnterpriseOne system to notify third-party systems of customer additions, changes, or deletions.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code |
|---|---|---|---|---|
| RTCMOUT3 | Customer Master Version 3 | RTE | Container
Container event for:
|
01 |
Please see the appropriate real-time events that are contained by this event for more information about the fields, conceptual approach, and processes that can initiate this event.
Special Setup
RTCMOUT3 has some additional special setup requirements due to the logic in the real-time wrapper.
The processing option for version ZJDE001 of the Customer Master Real Time Event Wrapper Application program (P0100077) determines whether RTCMOUT3 is always sent or is sent only if certain fields are changed. The purpose of the processing option is to enable filtering of the outbound event, RTCMOUT3.
When the processing option is 0, blank, or null, no filtering occurs, and RTCMOUT3 is sent whenever a change is made to a customer master record. If the processing option is 1, an event is sent only if one of the five territory alignment fields have been changed. Events always occur on an Add or Delete. The five territory alignment fields are Industry Classification Code, City, State, Zip, and Country. If one of these fields have changed and the filter is turned off, a flag is set in a cTerritoryAlign parameter in the event data structure. This flag is a signal that something has changed in those five fields.
Objects that Can Initiate the Event
These objects can initiate the RTCMOUT3 event, and the single events contained within the event:
N0100041 - Address Book MBF
N0100042 - Customer Master MBF
B0100078 - Who's Who MBF
B0100089 - Electronic Address MBF
B0100090 - Phones MBF
RTCMHDR3 is used by the JD Edwards EnterpriseOne system to notify third-party systems of customer additions, changes, or deletions.
| Event Type | Event Description | Event Category | Event Aggregate | Product Code | Data Structure | Event Relationship |
|---|---|---|---|---|---|---|
| RTCMHDR3 | Customer Header Version 3 | RTE | Single | 01 | D0100091A: Customer Master Real Time Record | Included in container event RTCMOUT. |
Conceptual Approach
A customer record added, modified, or deleted in the JD Edwards EnterpriseOne system creates a new record in a number of tables such as Customer Master by Line of Business (F03012) and Address Book Master (F0101) tables. A real-time notification event is triggered in the Customer Master or Address Book Master Business Function after data is modified to any customer table.
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 Customer Master Data business object: