## Address Book Manager Web Service

This chapter provides an overview of the Address Book Manager web service, lists a prerequisite, and discusses these web service operations:

- getAddressBook

- processAddressBook

- getContact

- processContact

### Understanding the Address Book Manager Web Service

The AddressBookManager web service (JP010000) manages the processing of address book-related web service operations. This table includes a description of the address book web service operations:

Operation | Description
getAddressBook (J0100002) | Use this operation to retrieve and review address, phone, and electronic mail address information from the JD Edwards EnterpriseOne Address Book system.
processAddressBook (J0100001) | Use this operation to add, change, or delete address book records in the JD Edwards EnterpriseOne Address Book system.
getContact (J0100004) | Use this operation to retrieve and review contact information from the JD Edwards EnterpriseOne Address Book system.
processContact (J0100003) | Use this operation to add, change, or delete contact records in the JD Edwards EnterpriseOne Address Book system.

Accessing Javadoc for the Address Book Manager Web Service

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

- JP010000 (AddressBookManager)

- J0100001 (processAddressBook)

- J0100002 (getAddressBook)

- J0100003 (processContact)

- J0100004 (getContact)

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.

### Prerequisite

Before you can use the Address Book Manager web service, or any of the related web service operations, you must first install and configure the JD Edwards EnterpriseOne Address Book system.

See Setting Up the JD Edwards EnterpriseOne Address Book System.

Additionally, you must set up business service properties that are used by all Address Book web service operations that process phone and electronic mail address information. This table lists the business service properties that must be set up:

Group | Key | Description | Default Value
J0100005 | J0100005_PHONE_ERROR_PREFIX | Use this business service property to specify the prefix that the system uses for phone error messages. | Phone Record Sent
J0100006 | J0100006_ELECADDR_ERROR_PREFIX | Use this business service property to specify the prefix that the system uses for electronic address error messages. | Electronic Address Record Sent

### getAddressBook

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

#### Understanding the getAddressBook Web Service Operation

The getAddressBook web service operation is a database query operation that enables consumers to retrieve and review address, phone, and electronic mail information for specified entities from the JD Edwards EnterpriseOne Address Book system.

The operation returns zero to many records if it completes successfully. If the operation encounters errors while processing address information, processing stops and those errors and warnings are returned to the consumer. If the operation encounters errors while processing phone or electronic mail information, the errors are converted to warnings, processing continues, and the warnings are returned to the consumer.

Setup Considerations

Before you use this operation, you can set business service properties to specify how the system retrieves data from the JD Edwards EnterpriseOne database. This table includes information about the business service properties that the getAddressBook operation uses:

Group | Key | Description | Default Value
J0100002 | J0100002_MAX_ROWS | Use this operation to specify the maximum number of records that the operation returns. | 100

Note. It is recommended that users configure this business service property, and use a value other than 0 (zero). Setting this property to 0 enables the operation to return all matching records. Additionally, it is recommended that you pass in selection criteria when processing this operation. If you do not pass in selection criteria, and you set this business property to 0, you might encounter significant performance issues.
Additionally, this operation uses a joined view of the F0101, F0116, and F0150 tables when retrieving data. The system enforces a one-to-one relationship between records from the F0101 and F0116, and a one-to-many relationship between the F0101 and the F0150 during initial record retrieval. After all records have been retrieved, the operation deletes records with duplicate address book numbers (AN8). This business service property is enforced during the initial record retrieval, before duplicate records are deleted. Therefore, the actual number of records that the operation returns might be less than the maximum number of rows specified.

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 getAddressBook operation is functioning correctly:

Question | Answer
How can I tell if the operation completes successfully? | If the operation completes successfully, the system displays zero to many records, based on the selection criteria that the consumer passes in. If the operation fails, an error is 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 entityName entityTypeCode
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.

### processAddressBook

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

#### Understanding the processAddressBook Web Service Operation

The processAddressBook web service operation is an inbound transaction operation that enables consumers to:

- Add records to the JD Edwards EnterpriseOne Address Book system.

- Delete records from the JD Edwards EnterpriseOne Address Book system.

- Change records in the JD Edwards EnterpriseOne Address Book system.

The operation uses the AddressBookMasterMBF business function (N0100041) to process information. If the operation encounters errors while processing address book information, processing stops and all errors and warnings are returned to the consumer. If the operation encounters errors while processing phone or electronic mail information, the errors are converted into warnings, processing continues, and the warnings are returned to the consumer.

Supported Functionality

This section discusses the functionality that the processAddressBook 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.

This operation enables consumers to add, change, or delete address book records. The operation also enables users to add, change, or delete the Who's Who records in the Address Book. These records contain a value of 0 (zero) in the Who's Who Line Number field. The operation also processes phone and electronic mail information for the Who's Who record with line number zero.

This operation does not support related person or alternate address processing for an address book record.

See Adding Who's Who Information to Address Book Records.

Setup Considerations

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

Group | Key | Description | Default Value
J0100001 | J0100001_AB_MBF_VERSION | Use this business service property to specify the version of the AddressBookMasterMBF (N0100041) the operation uses to process address book information. | 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 processAddressBook operation is functioning correctly:

Question | Answer
How can I tell if the operation completes successfully? | If the operation completes successfully, the user receives a return message that includes the records that were added, changed or updated. 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 while processing address book information, no data in the JD Edwards EnterpriseOne system is updated. No manual updates are required. If the operation encounters errors while processing phone or electronic mail information, those errors are converted to warnings and the warnings are returned to the consumer. These warnings do not stop the processAddressBook operation from processing, but the phone or electronic address that causes the error is not processed.
Does this operation use record reservation? | No. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing.

### getContact

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

#### Understanding the getContact Web Service Operation

The getContact web service operation is a database query operation that enables consumers to retrieve and review contact, alternate address, phone, and electronic mail information for specified contacts from the JD Edwards EnterpriseOne Address Book system.

The operation returns zero to many records if it completes successfully. If the operation encounters errors while processing contact information, processing stops and those errors and warnings are returned to the consumer. If the operation encounters errors while processing phone or electronic mail information, the errors are converted to warnings, processing continues, and the warnings are returned to the consumer.

Setup Considerations

Before you use this operation, you can set business service properties to specify how the system retrieves data from the JD Edwards EnterpriseOne database. This table includes information about the business service properties that the getContact operation uses:

Group | Key | Description | Default Value
J0100004 | J0100004_MAX_ROWS | Use this operation to specify the maximum number of records that the operation returns. | 100

Note. It is recommended that users configure this business service property, and use a value other than 0 (zero). Setting this constant to 0 enables the operation to return all matching records. Additionally, it is recommended that you pass in selection criteria when processing this operation. If you do not pass in selection criteria, and you set this business property to 0, you might encounter significant performance issues.

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 getAddressBook operation is functioning correctly:

Question | Answer
How can I tell if the operation completes successfully? | If the operation completes successfully, the system displays zero to many records, based on the selection criteria that the consumer passes in. If the operation fails, an error is 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 contactID entityNameContact
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.

### processContact

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

#### Understanding the processContact Web Service Operation

The processContact web service operation is an inbound transaction operation that enables consumers to add, change, or delete records to and from these JD Edwards EnterpriseOne tables:

- Who's Who table (F0111)

- Phones table (F0115)

- Electronic Addresses table (F01151)

- Alternate Addresses table (F01161)

The operation uses the WhosWhoMBF (N0100087) to process contact information. If the operation encounters errors while processing contact information, processing stops and the errors are returned to the consumer. If the operation encounters errors while processing phone or electronic mail information, the errors are converted to warnings, processing continues, and the warnings are returned to the consumer.

Supported Functionality

This section discusses the functionality that the processContact 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 operation does not support any country-specific localization functionality. Additionally, the operation does not enable users to add, change or delete a contact's related person information.

Setup Considerations

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

Group | Key | Description | Default Value
J0100003 | J0100003_WHOSWHO_MBF_VERSION | Use this business service property to specify the version of the Who'sWhoMBF (N0100087) that the operation uses to process contact information. | 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 processContact operation is functioning correctly:

Question | Answer
How can I tell if the operation completes successfully? | If the operation completes successfully, the user receives a return message that includes the records that were changed or updated. 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 contactID
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 while processing contact information, no data in the JD Edwards EnterpriseOne system is updated. No manual updates are required. If the operation encounters errors while processing phone or electronic mail information, those errors are converted to warnings and the warnings are returned to the consumer. These warnings do not stop the processContact operation from processing, but the phone or electronic address that causes the error is not processed.
Does this operation use record reservation? | No. The operation does not reserve records within the JD Edwards EnterpriseOne system during processing.