## 4.2.13.2.1.1  Inbound Service: Business User
Technical name: MANAGEBUSINESSUSERIN
This synchronous inbound SOAP service enables you to create, update, and delete business users from your external data sources, such as an identity management system. Deleting business users doesn't mean you've actually deleted them yet. The user assigned to the business user is deleted and the MarkedForArchivingIndicator has been set. Only during the ILM process the business user is physically deleted.
You can assign business role IDs to the users at the node Role .
We recommend processing blocks of 10 users to a maximum of 100 users. Otherwise, the target system may time out.
This service supports the business users Employee (BUP003).
##  Caution
This service directly influences the data and authorizations of business users. Changes are effective immediately in the target system.
Make sure to maintain only those authorizations that are intended for what a user needs to do in the system. Not doing so can cause security issues.
## Service Request
The service is structured into the following two top-level nodes:
Message Header ( MessageHeader )
The service message header is not in use in this service.
Business User ( BusinessUser )
The service nodes contain the service's business data.
##  Note
In the following table, attributes are marked in blue.
Nodes and Fields for the BusinessUser Node
|                         | Maximum Field                                         | Maximum Field   | Maximum Field   | Maximum Field                                                                                                                                         |
|-------------------------|-------------------------------------------------------|-----------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| Node or Field           | Description                                           | Length          | Cardinality     | Necessity                                                                                                                                             |
| PersonExternalID        | The Person Ex- ternal ID is the ID of the em- ployee. | 60              | 0..1            | Mandatory for create for busi- ness partner category ( BUP003 - Em- ployee). Optional for up- date (at least one of the per- son IDs is man- datory.) |
| PersonID                | Person ID is the ID of the busi- ness partner.        | 10              | 0..1            | Optional (At least one of the person IDs is mandatory.)                                                                                               |
| PersonUUID              | Person UUID is the unique ID of the business partner. | 36              | 0..1            | Optional (At least one of the person IDs is mandatory.)                                                                                               |
| BusinessPartnerRoleCode | Business Part- ner Role Code                          | 6               | 0..1            | Mandatory for create for Busi- ness partner category ( BUP003 - Em- ployee). Optional for up- date.                                                   |
| Node or Field                               | Description                                  |               | Maximum Field Length Cardinality   | Necessity   |
|---------------------------------------------|----------------------------------------------|---------------|------------------------------------|-------------|
| MarkedForArchivingIndicator                 | Mark for Archiv- ing                         | actionCo must | 0..1                               | Optional    |
| ValidityPeri od Cardinality: 0..1 StartDate | Format: YYYY-MM-DD By default,               | the is        | 0..1                               | Optional    |
| EndDate                                     | Format: YYYY-MM-DD By default, 9999-12-31 is |               | 0..1                               | Optional    |
| PersonalInfo rmation FormOfAddress          | Form of ad- dress                            | 4             | 0..1                               | Optional    |
| Node or Field     |                        | Description                        |   Maximum Field Length | Cardinality   | Necessity   |
|-------------------|------------------------|------------------------------------|------------------------|---------------|-------------|
| Cardinality: 0..1 | FirstName              | First name                         |                     40 | 0..1          | Optional    |
|                   | LastName               | Last name This field is mandatory. |                     40 | 0..1          | Mandatory   |
|                   | PersonFullName         | Person full name                   |                     80 | 0..1          | Optional    |
|                   | AcademicTitle          | Academic title                     |                      4 | 0..1          | Optional    |
|                   | CorrespondenceLanguage | Correspond- ence language          |                      9 | 0..1          | Optional    |
|                   | MiddleName             | Middle name                        |                     40 | 0..1          | Optional    |
|                   | AdditionalLastName     | Additional last name               |                     40 | 0..1          | Optional    |
|                   | BirthName              | Birth name                         |                     40 | 0..1          | Optional    |
|                   | NickName               | Nick name                          |                     40 | 0..1          | Optional    |
|                   | Initials               | Initials                           |                     10 | 0..1          | Optional    |
|                   | AcademicSecondTitle    | Academic sec- ond title            |                      4 | 0..1          | Optional    |
|                   | LastNamePrefix         | Last name pre- fix                 |                      4 | 0..1          | Optional    |
|                   | LastNameSecondPrefix   | Last name sec- ond prefix          |                      4 | 0..1          | Optional    |
|                   | NameSupplement         | Namesupple- ment                   |                      4 | 0..1          | Optional    |
<!-- image -->
| Node or Field                                                                                                 |                     | Description                                                                                                                                            |   Maximum Field Length | Cardinality   | Necessity   |
|---------------------------------------------------------------------------------------------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|-------------|
| User (only Cloud)                                                                                             | actionCode UserName | You can use the following val- ues: • 01 - Create • 02 - Up- date • 03 - Delete Mandatory if [2] is not set and personal in- formation data are given. |                      2 | optional      | Optional    |
| for                                                                                                           |                     | User name/ Alias                                                                                                                                       |                     40 | 0..1          | Optional    |
| Cardinality: 0..1  Note For more information about de- fault val- ues, see Defaulting of User At- tributes . | LogonLanguageCode   | Logon language                                                                                                                                         |                      9 | 0..1          | Optional    |
| Node or Field   | Description                                                                                                                               |   Maximum Length | Field Cardinality   | Necessity   |
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------|------------------|---------------------|-------------|
| DateFormatCode  | You can use the following val- ues: • 1 - DD.MM.YY YY (Gre- gorian Date) • 2 - MM/DD/ YYYY (Gre- gorian Date) • 3 -MM- DD-YYYY (Gregorian |                2 | 0..1                | Optional    |
|                   | Maximum Field                                                                                                         | Maximum Field   | Maximum Field   | Maximum Field   |
|-------------------|-----------------------------------------------------------------------------------------------------------------------|-----------------|-----------------|-----------------|
| Node or Field     | Description                                                                                                           | Length          | Cardinality     | Necessity       |
| DecimalFormatCode | • A - YYYY/MM/ DD(Is- lamic Date 1) • B- YYYY/MM/ DD(Is- lamic Date 2) • C- YYYY/MM/ DD(Iranian Date) You can use the | 2               | 0..1            | Optional        |
| TimeZoneCode      | Time zone                                                                                                             | 10              | 0..1            | Optional        |
| Node or Field             | Description                                                                                                                                                                      |    | Maximum Field Length Cardinality   | Necessity   |
|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|------------------------------------|-------------|
| TimeFormatCode            | You can use the following val- ues: • 0 - 24 Hour Format (Example: 12:05:10) • 1 - 12 Hour Format (Example: 12:05:10 PM) • 2 - 12 Hour Format (Example: 12:05:10 pm) • 3 - Hours | 2  | 0..1                               | Optional    |
| LockedIndicator           | Locked indica- tor                                                                                                                                                               | 5  | 0..1                               | Optional    |
| ValidityPeri od StartDate | Format: YYYY-MM-DD                                                                                                                                                               |    | 1                                  | Optional    |
| Cardinality: 1            | If the start date is not main- tained for the User , the StartDate for the BusinessUser is entered.                                                                              |    |                                    |             |
|                           |            | Maximum Field                                                                                                            | Maximum Field   | Maximum Field   | Maximum Field   |
|---------------------------|------------|--------------------------------------------------------------------------------------------------------------------------|-----------------|-----------------|-----------------|
| Node or Field             |            | Description                                                                                                              | Length          | Cardinality     | Necessity       |
|                           | EndDate    | Format:                                                                                                                  |                 | 1               | Optional        |
| Role                      | RoleName   | Role name                                                                                                                | 40              | 1               | Optional        |
| Cardinality: 0..unbounded | actionCode | You can use the following val- ues: • 01 - Create • 03 - Delete Mandatory if [6] is not set and role name data is given. | 2               | Optional        | Optional        |
| GlobalUserID              |            | Used to uniquely iden- tify your busi- ness user across different systems.                                               | 36              |                 | Optional        |
| UserGroupCode             |            | Assign a busi- ness user to an existing user group.                                                                      | 12              | 0..1            | Optional        |
| Node or Field                 |                                                                         | Description                                                                                                                                                | Maximum Field Length   | Cardinality   | Necessity   |
|-------------------------------|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|-------------|
|                               | actionCode                                                              | You can use the following val- ues: • 01 - Create • 02 - Up- date • 03 - Delete Mandatory if [3] is not set and user data ( UserName and Role ) are given. | 2                      | Optional      | Optional    |
|                               | [6] roleListCompleteTransmiss ionIndicator                              | CTI for the Role node See CTI note [page 972] for more informa- tion.                                                                                      |                        | Optional      | Optional    |
| UserAssignme nt (only for on- | UserID                                                                  | User ID                                                                                                                                                    | 12                     | 1             | N/A         |
| premise) Cardinality: 0..1    | actionCode                                                              | You can use the following val- ues: • 01 - Create • 02 - Up- date • 03 - Delete Mandatory if [4] is not set and User ID data are given.                    | 2                      | Optional      | N/A         |
| WorkplaceInf ormation         | EmailAddress                                                            | Email address                                                                                                                                              | 241                    | 0..1          | N/A         |
|                               | PhoneInforma tion Cardinality: 0..2 One set of phone informa- PhoneType | Phone type • B- Busi- ness • C- Cell                                                                                                                       | 1                      | 1             | N/A         |
| Node or Field   |                                |                          | Description                                                                                                                          |   Maximum Field Length | Cardinality   | Necessity   |
|-----------------|--------------------------------|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|-------------|
|                 | tion per phone type supported. | CountryDiali ngCode      | Country dialing code Used for both phone types.                                                                                      |                     10 | 0..1          | N/A         |
|                 |                                | PhoneNumberA reaID       | Phone number area code Used only for phone type B.                                                                                   |                     10 | 0..1          | N/A         |
|                 |                                | PhoneNumberS ubscriberID | Phone number subscriber ID Used for both phone types.                                                                                |                     30 | 0..1          | N/A         |
|                 |                                | PhoneNumberE xtension    | Phone number extension Used only for phone type B.                                                                                   |                     10 | 0..1          | N/A         |
|                 |                                | actionCode               | You can use the following val- ues: • 01 - Create • 02 - Up- date • 03 - Delete Mandatory if [7] is not set and phone data is given. |                      2 | Optional      | N/A         |
|                 | FunctionalTitleName            | FunctionalTitleName      | Functional title name                                                                                                                |                     40 | 0..1          | N/A         |
|                 | Department                     | Department               | Department name                                                                                                                      |                     40 | 0..1          | N/A         |
|                 | RoomNumber                     | RoomNumber               | Room number                                                                                                                          |                     10 | 0..1          | N/A         |
|                 | Building                       | Building                 | Building name                                                                                                                        |                     10 | 0..1          | N/A         |
| Node or Field                       | Description                                                                                                                           | Maximum Field Length   | Cardinality   | Necessity   |
|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|------------------------|---------------|-------------|
|                                     | You can use the following val- ues: • 01 - Create • 02 - Up- date • 03 - Delete Mandatory if [5] is not set and workplace information | 2                      | Optional      | N/A         |
|                                     | phoneInformationListCompl eteTransmissionIndicator CTI for the PhoneInforma tion node See CTI note [page 972] for more informa- tion. |                        | Optional      | N/A         |
| Relationship (only for on- premise) | BusinessPart nerID                                                                                                                    |                        |               | N/A         |
|                                     | BusinessPart nerUUID                                                                                                                  |                        |               | N/A         |
|                                     | BusinessPart nerExternalI D                                                                                                           |                        |               | N/A         |
|                                     | BusinessPart nerExternalI DCategoryCod e                                                                                              |                        |               | N/A         |
|                                     | BusinessPart                                                                                                                          |                        |               | N/A         |
|                                     | BusinessPart nerUUID                                                                                                                  |                        | 0..1          | N/A         |
|                                     | BusinessPart nerExternalI D                                                                                                           |                        | 0..1          | N/A         |
| Node or Field                                                                           | Description                                                                             | Maximum Length                                                                | Field Cardinality   | Necessity   |
|-----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|---------------------|-------------|
| e                                                                                       | BusinessPart nerExternalI DCategoryCod                                                  |                                                                               | 0..1                | N/A         |
|                                                                                         | RelationshipCategoryCode                                                                |                                                                               | 0..1                | N/A         |
|                                                                                         | actionCode                                                                              |                                                                               | Optional            | N/A         |
| [1] actionCode You can ues: • 01 • 02 • 03 This                                         | [1] actionCode You can ues: • 01 • 02 • 03 This                                         | use the following val- - Create - Up- date - Delete attribute is mandatory. 2 | Optional            | Optional    |
| [2] personalInformationListCompleteTransmis sionIndicator CTI for rmation See CTI [page | [2] personalInformationListCompleteTransmis sionIndicator CTI for rmation See CTI [page | the PersonalInfo node note 972] for more informa- tion.                       | Optional            | Optional    |
| [3] userListCompleteTransmissionIndicator User node See CTI                             | [3] userListCompleteTransmissionIndicator User node See CTI                             | CTI for the note [page 972] for more informa- tion.                           | Optional            | Optional    |
| [4] userAssignmentListCompleteTransmissionI ndicator CTI for nt node See CTI [page      | [4] userAssignmentListCompleteTransmissionI ndicator CTI for nt node See CTI [page      | the UserAssignme note 972] for more informa- tion.                            | Optional            | Optional    |
|                                                            | Maximum Field                                                                          | Maximum Field   | Maximum Field   | Maximum Field   |
|------------------------------------------------------------|----------------------------------------------------------------------------------------|-----------------|-----------------|-----------------|
| Node or Field                                              | Description                                                                            | Length          | Cardinality     | Necessity       |
| [5] workplaceInformationListCompleteTransmi ssionIndicator | CTI for the WorkplaceInf ormation node See CTI note [page 972] for more informa- tion. |                 | Optional        | Optional        |
| [5] relationshipListCompleteTransmissionInd icator         |                                                                                        |                 | Optional        | Optional        |
##  Note
## Complete Transmission Indicator (CTI)
The complete transmission indicator represents the state of the data in the inbound XML There are multiple transmission indicators that represents the state of the corresponding segment. The transmission indicator is interpreted by the web service:
- If a complete transmission indicator is set to true, the existing data is overwritten by the newly entered data.
- If a complete transmission indicator is set to false, the value of the action code of the corresponding node applies.
- If an action code and the complete transmission indicator are set, then the action code of the corresponding node applies.
## Sample Payload
##  Sample Code
&lt;soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aba="http://sap.com/xi/ABA"&gt;
&lt;soapenv:Header/&gt;
&lt;soapenv:Body&gt;
&lt;aba:BusinessUserBundleMaintainRequest\_sync&gt;
&lt;!--1 or more repetitions:--&gt;
&lt;BusinessUser actionCode="01"
personalInformationListCompleteTransmissionIndicator="false"
userListCompleteTransmissionIndicator="false"
userAssignmentListCompleteTransmissionIndicator="false"
workplaceInformationListCompleteTransmissionIndicator="false"&gt;
- &lt;PersonExternalID&gt;Muster01&lt;/PersonExternalID&gt;
- &lt;BusinessPartnerRoleCode&gt;BUP003&lt;/BusinessPartnerRoleCode&gt;
&lt;PersonalInformation actionCode="01"&gt;
&lt;FormOfAddress&gt;0002&lt;/FormOfAddress&gt;
- &lt;FirstName&gt;Max&lt;/FirstName&gt;
- &lt;LastName&gt;Muster&lt;/LastName&gt;
- &lt;PersonFullName&gt;Prof. Dr. Max Muster&lt;/PersonFullName&gt;
- &lt;AcademicTitle&gt;0002&lt;/AcademicTitle&gt;
- &lt;CorrespondenceLanguage&gt;D&lt;/CorrespondenceLanguage&gt;
```
<MiddleName>Michael</MiddleName> <AcademicSecondTitle>0001</AcademicSecondTitle> <BirthName>Milli</BirthName> <NickName>Maxi</NickName> <LastNamePrefix>0001</LastNamePrefix> </PersonalInformation> <User actionCode="01" roleListCompleteTransmissionIndicator="false"> <!--Optional:--> <UserName>MAXMUSTER01</UserName> <LogonLanguageCode>DE</LogonLanguageCode> <LockedIndicator>false</LockedIndicator> <Role actionCode="01"> <RoleName>SAP_BR_MANAGER</RoleName> </Role> <Role actionCode="01"> <RoleName>SAP_BR_BPC_EXPERT</RoleName> </Role> </User> <WorkplaceInformation actionCode="01" phoneInformationListCompleteTransmissionIndicator="true"> <EmailAddress>Max.Muster01@Test.com</EmailAddress> <PhoneInformation actionCode="01"> <PhoneType>C</PhoneType> <CountryDialingCode>+49</CountryDialingCode> <PhoneNumberSubscriberID>0160123456</ PhoneNumberSubscriberID> </PhoneInformation> <PhoneInformation actionCode="01"> <PhoneType>B</PhoneType> <CountryDialingCode>+49</CountryDialingCode> <PhoneNumberAreaID>06227</PhoneNumberAreaID> <PhoneNumberSubscriberID>7</PhoneNumberSubscriberID> <PhoneNumberExtension>12345</PhoneNumberExtension> </PhoneInformation> <FunctionalTitleName>TESTER</FunctionalTitleName> <Department>QUALITY</Department> <RoomNumber>C1.23</RoomNumber> <Building>WDF01</Building> </WorkplaceInformation> </BusinessUser> <BusinessUser actionCode="01" personalInformationListCompleteTransmissionIndicator="false" userListCompleteTransmissionIndicator="false" userAssignmentListCompleteTransmissionIndicator="false" workplaceInformationListCompleteTransmissionIndicator="false"> <PersonExternalID>MINIMUSTER01</PersonExternalID> <BusinessPartnerRoleCode>BUP003</BusinessPartnerRoleCode> <PersonalInformation actionCode="01"> <FormOfAddress>0001</FormOfAddress> <FirstName>Mini</FirstName> <LastName>Muster</LastName> <PersonFullName>Prof. Dr. Mini Muster</PersonFullName> <AcademicTitle>0002</AcademicTitle> <CorrespondenceLanguage>D</CorrespondenceLanguage> <AcademicSecondTitle>0001</AcademicSecondTitle> <LastNamePrefix>0001</LastNamePrefix> </PersonalInformation> <User actionCode="01" roleListCompleteTransmissionIndicator="false"> <!--Optional:--> <UserName>MINIMUSTER01</UserName> <LogonLanguageCode>DE</LogonLanguageCode> <LockedIndicator>false</LockedIndicator> <Role actionCode="01"> <RoleName>SAP_BR_MANAGER</RoleName> </Role> <Role actionCode="01">
```
```
<RoleName>SAP_BR_BPC_EXPERT</RoleName> </Role> </User> <WorkplaceInformation actionCode="01" phoneInformationListCompleteTransmissionIndicator="true"> <EmailAddress>Mini.Muster01@Test.com</EmailAddress> <PhoneInformation actionCode="01"> <PhoneType>C</PhoneType> <CountryDialingCode>+49</CountryDialingCode> <PhoneNumberSubscriberID>0160123456</ PhoneNumberSubscriberID> </PhoneInformation> <PhoneInformation actionCode="01"> <PhoneType>B</PhoneType> <CountryDialingCode>+49</CountryDialingCode> <PhoneNumberAreaID>06227</PhoneNumberAreaID> <PhoneNumberSubscriberID>7</PhoneNumberSubscriberID> <PhoneNumberExtension>12345</PhoneNumberExtension> </PhoneInformation> <FunctionalTitleName>TESTER</FunctionalTitleName> <Department>QUALITY</Department> <RoomNumber>C1.23</RoomNumber> <Building>WDF01</Building> </WorkplaceInformation> </BusinessUser> </aba:BusinessUserBundleMaintainRequest_sync> </soapenv:Body> </soapenv:Envelope>
```
## Service Response
You receive a confirmation message response for each bundle of business users you send. If the service request is processed, a confirmation message is sent. This contain crucial information provided by the fields PersonExternalID , PersonID , and PersonUUID for each business user of the bundle.
The following table provides an overview of the response structure for the BusinessUser service node.
| Field or Node                      | Description        | Maximum Field Length   | Cardinality   |
|------------------------------------|--------------------|------------------------|---------------|
| PersonExternalID                   | Person External ID | 60                     | 0..1          |
| PersonID                           | Person ID          | 10                     | 0..1          |
| PersonUUID                         | Person UUID        | 36                     | 0..1          |
| Log BusinessDocumentProcessingResu | Not in use         | 2                      | 0..1          |
| Cardinality: 1 ltCode              |                    |                        |               |
| Field or Node   |                               |                               | Description Maximum Field Length                                                                                                                                                                   | Cardinality                                                                                                                                                                                        |
|-----------------|-------------------------------|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|                 | MaximumLogItemSeverityCode If | MaximumLogItemSeverityCode If | several mes- sages are stored for a business user, the maxi- mumofall re- ceived severity co- des the most se- vere level will be shown. 1                                                         | 0..1                                                                                                                                                                                               |
|                 | Item                          | TypeID                        | Message number 40                                                                                                                                                                                  | 0..1                                                                                                                                                                                               |
|                 | Cardinality: 0..un- bounded   | CategoryCode                  | Not in use 15                                                                                                                                                                                      | 0..1                                                                                                                                                                                               |
|                 |                               | SeverityCode                  | Severity code defi- 1                                                                                                                                                                              | 0..1                                                                                                                                                                                               |
|                 |                               |                               | • 1 - Informa- tion • 2 - Warning • 3 - Error                                                                                                                                                      |                                                                                                                                                                                                    |
|                 |                               | Note                          | Contains the mes- 200                                                                                                                                                                              | 1                                                                                                                                                                                                  |
|                 |                               | WebURI                        | Not in use                                                                                                                                                                                         | 0..1                                                                                                                                                                                               |
| Error Codes     |                               |                               |                                                                                                                                                                                                    |                                                                                                                                                                                                    |
| Error Code      |                               |                               | Description                                                                                                                                                                                        |                                                                                                                                                                                                    |
| 104             |                               |                               | Combination of Ext. ID &1 and ID &2 inconsistent. Process- ing cancelled. PersonExternalID and PersonID have a 1:1 relation- ship. Enter the PersonID that corresponds with the PersonExternalID . | Combination of Ext. ID &1 and ID &2 inconsistent. Process- ing cancelled. PersonExternalID and PersonID have a 1:1 relation- ship. Enter the PersonID that corresponds with the PersonExternalID . |
| 105             |                               |                               | Combination of Ext. ID &1 and UUID &2 inconsistent. Person ExternalID and PersonUUID have a 1:1 relation- ship.                                                                                    | Combination of Ext. ID &1 and UUID &2 inconsistent. Person ExternalID and PersonUUID have a 1:1 relation- ship.                                                                                    |
## Constraints
This service does not support:
- Freelancer (BBP010) business users
## Additional Information
##  Note
For more details about Communication Management, see Communication Management [page 2707].