Show TOC

Find Business Partner Basic Data by ElementsLocate this document in the navigation structure

Definition

An operation that finds business partners that match the search criteria.

Technical Data

Entity Type

Service Operation

Release State

Released

Technical Name

BusinessPartnerDataManagementQueryBusinessPartnerIn.FindBusinessPartnerBasicDataByElements

Mode

Synchronous

Idempotency

Not applicable

Change/Update Behavior

Not applicable

Business Context

This operation can be used for business partners of any type, that is persons, organizations, or groups.

For more information about the business context, see the Business Partner business object.

Related Operations

Business-Related Operations

Not applicable

Compensation Operation

Not applicable

Counterpart Operation

Not applicable

Features

This operation is used to search for business partners using a fixed set of search criteria. To search for business partners, at least one search criterion must be specified. A partner is added to the results if all the search criteria are fulfilled (AND function). If multiple values are entered for one search criterion, just one of these values has to match to find a business partner (OR function).There are many possible search criteria that can be specified, singularly or in combination, including the following:

  • A coded representation of the category of a business partner (BusinessPartnerCategoryCode element)

  • A coded representation of a life cycle status of the business partner (BusinessPartnerLifeCycleStatusCode element)

  • The internal ID of a business partner (SelectionByBusinessPartnerInternalID node) or text to search for the business partner ID (SelectionByIdentification node)

  • Text to search for the business partner name (BusinessPartnerNameSearchText element)

    This allows a search for business partners in one call by BusinessPartnerCommonName, BusinessPartnerCommonAdditionalName or BusinessPartnerAliasName elements. Business Partners are found if the search text is matched by one of these elements.

    Note

    If BusinessPartnerNameSearchText is provided, none of the following elements must be provided:

    • BusinessPartnerCommonNameSearchText

    • BusinessPartnerCommonAdditionalNameSearchText

    • BusinessPartnerAliasNameSearchText

  • The coded representation of the role of the business partner (BusinessPartnerRoleCode element)

For each successfully found business partner, the operation returns a list of the identifying elements of the business partner as well as further details. If a business partner cannot be found, an error message is sent to the log. The response message also includes the ChangeStateID element for each business partner, which is needed for the Update Business Partner service operation.

Alphanumeric Search

An alphanumeric search works on character fields and treats the values as character strings and not as numbers. Two strings are compared starting from the left to the right place, comparing them according to the (comparison) operator. This comparison is done until the result is uniquely true or false.

Example: Operator Less than (<)

String1: 22222

String2: 11500

Result: false

1.Place: 2 < 1 => Comparison is unique, no further comparison

String1: 10000123

String2: 11500

Result: true

1.Place: 1 < 1 => Comparison is not unique, continue

2.Place: 0 < 1 => Unique result, no further comparison

Example: Greater than or equals (>=)

String1: 9876

String2: 115200

Result: true

1.Place: 9 >= 1 => Unique result, no further comparison

String1: 115R5

String2: 11500

Result: false

1.Place: 1 >= 1 => Comparison not unique, continue

2.Place: 1 >= 1 => Comparison not unique, continue

3.Place: 5 >= 5 => Comparison not unique, continue

4.Place: R >= 0 => Unique result, no further comparison

Note: If you want the alphanumeric search on the field business partner identification behave like a numeric search, you have the possibility for numeric characters to maintain these numbers with leading zeros.

Example: Operator: Less than (<)

String1: 0022222

String2: 011500

Result: true

1.Place: 0 = 0 => Comparison is not unique, continue

2.Place: 0 < 1 => Unique result, no further comparison

String1: 10000123

String2: 00011500

Result: false

1.Place: 1 < 0 => Unique result, no further comparison

Wildcard Search

A wildcard search (using the character “*” to represent 0...n characters) or a case-insensitive search may be used where the following elements are used as search criteria:

  • Text to search for common keywords of business partners (BusinessPartnerCommonKeyWordsTextSearchText element)

  • Text to search for common additional keywords of business partners (BusinessPartnerCommonAdditionalKeyWordsTextSearchText element)

  • Text to search for the names of business partners (BusinessPartnerNameSearchText element). Note that  BusinessPartnerNameSearchText must not be used if BusinessPartnerCommonNameSearchText is provided.

  • Text to search for common names of business partners (BusinessPartnerCommonNameSearchText element)

  • Text to search for common additional names of business partners (BusinessPartnerCommonAdditionalNameSearchText element)

  • Text to search for alias names of business partners (BusinessPartnerAliasNameSearchText element)

  • Text to search for city names of business partners (BusinessPartnerAddressCityNameSearchText element)

  • Text to search for street names of business partners (BusinessPartnerAddressStreetNameSearchText element)

  • Text to search for email URIs of business partners (BusinessPartnerEmailURISearchText element)

  • Text to search for web URIs of business partners (BusinessPartnerWebURISearchText element)

  • Text to search for given names of contact persons (ContactPersonGivenNameSearchText element)

  • Text to search for family names of contact persons (ContactPersonFamilyNameSearchText element)

  • Text to search for given names of employees (EmployeeResponsibleGivenNameSearchText element)

  • Text to search for family names of employees (EmployeeResponsibleFamilyNameSearchText element)

  • Text to search for identifiers of business partners (LowerBoundaryBusinessPartnerIDSearchText element). Note that wildcard search is only supported if IntervalBoundaryTypeCode is “single value”.

  • Text to search for internal identifiers of business partners (LowerBoundaryBusinessPartnerInternalIDSearchText element). Note that wildcard search is only supported if IntervalBoundaryTypeCode is “single value”.

  • Text to search for the lower boundary of postal codes of business partners (LowerBoundaryAddressPostalCodeSearchText element). Note that wildcard search is only supported if IntervalBoundaryTypeCode is “single value”.

Selection by Common Birthdate

Wildcards can be used in the LowerBoundaryBirthDateSearchText element as the only value or part of the value as in the following examples:

  • 1970-05-* means any day in May 1970

  • *-06-30 means any year on the 30th June

If the LowerBoundaryBirthDateSearchText element contains a wildcard, the UpperBoundaryBirthDate element must not contain a value. If the input is incorrect, an appropriate error message is generated.

Date Range

A date range may be specified as follows: Lower Boundary = 1970-01-01 and Upper Boundary = 1970-03-31 means the first three months of 1970.

Search Examples

Example 1

A search contains both the common name of the business partner (BusinessPartnerCommonName element) and the name of the contact person (ContactPerson element). In this case, a business partner is added to the results if the common name search criterion is fulfilled and the business partner has a contact person with the specified name.

Example 2

Multiple internal IDs are provided for the SelectionByBusinessPartnerInternalID element (for example 123 and 456): At least one business partner is added to the results if it has one of the specified internal IDs.

InclusionExclusionCode

The following code values are supported at delivery: Code: I, Name: Inclusion, Description: A set is included into a result set.

IntervalBoundaryTypeCode

The following code values are supported at delivery:

  • Code: 1, Name: Single Value; = X, Alternative business berm: Equal to, Description:  Single Value; = X

  • Code: 3, Name: Interval with closed lower and closed upper boundary; [X, Y], Alternative business term: Between, Description: Interval with clsd lower and clsd upper boundary; [X, Y]

  • Code: 6, Name: Interval with unlimited lower and open upper boundary; [X]: Alternative business term: Less Than; Description: Interval with unlmt lower and open upper boundary; <X

  • Code: 7, Name: Interval with unlimited lower and closed upper boundary; <=X; Alternative business term: Less Than or Equal to; Description: Interval with unlmt lower and clsd upper boundary; <=X

  • Code: 8, Name: Interval with open lower and unlimited upper boundary; >X; Alternative business term: Greater Than; Description: Interval with open lower and unlmt upper boundary; >X

  • Code: 9, Name: Interval with closed lower and unlimited upper boundary; >=X; Alternative business term: Greater Than or Equal to; Description: Interval with clsd lower and unlmt upper boundary; >=X

Telephone and Fax Number Searches

Telephone numbers can consist of regional area code, phone number, and extension, for example 0415 508 9630. It can also contain the international dialing code with the leading symbol “+” and the regional area code without the leading number “0”, for example +1 415 508 9630. If the international dialing code is specified, the  BusinessPartnerAddressCountryCode element must also be specified. In this case, a business partner is found only if the business partner has a matching telephone number and an address with the same country.

Processing Conditions

You can restrict the search results to a maximum number of hits (QueryHitsMaximumNumberValue element), or you can let the service operation return an unlimited number of hits.If you specify a maximum number of hits, and the number of results available exceeds the maximum number, the MoreHitsAvailableIndicator indicator is set in the response of the service operation and you can restart the service operation. When you restart the service operation, you can enter an internal ID that can be used to continue the search from the last entry found by the first service response (LastReturnedObjectID element).

Authorization and Exclusions

If the caller has the corresponding authorization, the results contain the basic data of all business partners. Otherwise the results show no information. You can also exclude a business partner from the results using the Business Add-In (BAdI) for this operation (see Notes on SAP Implementation -> Enhancements below).

Error Handling

For more information, see Error Handling in Financial Services .

The following main error messages are recorded in the Log of the response message:

  • DCE.VME (Value Mapping Error):

    • FSBP_MAIN_ERROR_MSG 013 (Error occurred during mapping (inbound))

    • FSBP_MAIN_ERROR_MSG 014 (Error occurred during mapping (outbound))

  • FOE.SVE (Scheme violation error): FSBP_MAIN_ERROR_MSG 011 (Error during validation (inbound))

For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode.

Notes on SAP Implementation

Authorization

The user must be authorized to find a business partner. The following authorization objects are checked in the SAP back-end system:

  • B_BUPA_GRP

  • B_BUPA_PGM

  • B_BUPA_RLT

  • B_BUPR_BZT

  • B_CCARD

Enhancements

You can find the Business Add-In (BAdI) BAdI for FindBusinessPartnerBasicDataByElements(FSBP_FND_SE_FIND) for this operation through Transaction SIMGH. Choose Start of the navigation path BAdIs for XI Interfaces Next navigation step Mapping and Processing of Service Enhancements Next navigation step Business Partner End of the navigation path. Depending on the application, the BAdIs for XI Interfaces structure could also be available in the IMG of your system such as SAP Policy Management.