## Customer Manager Web Service

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

- getCustomer

- getCustomerCreditInformation

- processCustomer

### Understanding the Customer Manager Web Service

The Customer Manager web service (JP010020) manages the processing of customer-related web service operations. This table includes a description of the customer web service operations:

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.
getCustomerCreditInformation (J0100023) | Use this operation to retrieve and review customer credit information 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.

Accessing Javadoc for the Customer Manager Web Service Operations

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

- JP010020 (Customer Manager)

- J0100022 (getCustomer)

- J0100023 (getCustomerCreditInformation)

- J0100021 (processCustomer)

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 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, Entering Address Book Records.

See Setting Up the JD Edwards EnterpriseOne Accounts Receivable System, Setting Up Customer Master Information.

### getCustomer

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

#### Understanding the getCustomer Web Service Operation

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.

Supported Functionality

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.

Setup Considerations

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 8.98 Business Services Development Methodology Guide, Creating a Business Service, Managing Business Service Properties

Implementation Details

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: entityName entityTypeCode company
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.

### getCustomerCreditInformation

This section provides an overview of the getCustomerCreditInformation web service operation and lists a prerequisite.

#### Understanding the getCustomerCreditInformation 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.

Implementation Details

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: entityID creditHoldExempt
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.

#### Prerequisite

Before you use this operation, you must enter customer credit information.

See Setting Up Credit and Collections Management.

### processCustomer

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

#### Understanding the processCustomer 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 Address Book Manager Web Service.

Supported Functionality

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.

Setup Considerations

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 8.98 Business Services Development Methodology Guide, Creating a Business Service, Managing Business Service Properties

Implementation Details

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: entityID entityName entityTypeCode
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.