Enterprise Services Documentation

Enterprise Services for

SAP ERP 2005

SAP Documentation Enterprise SOA

Copyright

© Copyright 2007 SAP AG. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice.

Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.

Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft

Corporation.

IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400,

OS/390, OS/400, iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner,

WebSphere, Netfinity, Tivoli, Informix, i5/OS, POWER, POWER5, OpenPower and PowerPC are trademarks or registered trademarks of IBM Corporation.

Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries.

Oracle is a registered trademark of Oracle Corporation.

UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.

Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc.

HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World

Wide Web Consortium, Massachusetts Institute of Technology.

Java is a registered trademark of Sun Microsystems, Inc.

JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape.

MaxDB is a trademark of MySQL AB, Sweden.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies.

Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP

AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

ES for SAP ERP 2005 2


Icons in Body Text

Icon Meaning

Caution

Example

Note

Recommendation

Syntax

Additional icons are used in SAP Library documentation to help you identify different types of information at a glance. For more information, see Help on Help General Information

Classes and Information Classes for Business Information Warehouse on the first page of any version of SAP Library .

Typographic Conventions

Type Style

Example text

Example text

EXAMPLE TEXT

Example text

Example text

<Example text>

EXAMPLE TEXT

Description

Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options.

Cross-references to other documentation.

Emphasized words or phrases in body text, graphic titles, and table titles.

Technical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE.

Output on the screen. This includes file and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools.

Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation.

Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system.

Keys on the keyboard, for example, F2 or ENTER .



Enterprise Services for SAP ERP ........................................................................................ 25

SAP Enterprise Services.................................................................................................. 25 mySAP Business Suite: Service Processing ................................................................. 26

Introduction to Enterprise Service-Oriented Architecture............................................ 26

Composite Application........................................................................................... 28

Service.................................................................................................................. 28

Web Service.......................................................................................................... 29

Service-Oriented Architecture................................................................................ 30

Enterprise Service ................................................................................................. 31

SAP's Enterprise Service-Oriented Architecture (SOA) .......................................... 32 mySAP Service Provisioning: Runtime ...................................................................... 33

Runtime Architecture Overview.............................................................................. 33

HTTP Communication Layer .............................................................................. 35

Web Service Enabling Layer .............................................................................. 36

Invocation and Execution of Synchronous Web Services.................................... 38

Dispatching a Request.................................................................................... 39

Processing a Request .................................................................................... 39

Sending a Response ...................................................................................... 40 mySAP as Service Provider and Service Consumer .............................................. 40

Communication Pattern...................................................................................... 40

Proxy Type ........................................................................................................ 42

Data Conversion and Customer Modifications........................................................ 45

Proxy Meta Data ................................................................................................ 46

Application Level Mapping of Data Types........................................................... 46

Data Access .......................................................................................................... 47

Concurrency Control .......................................................................................... 48

Overwrite........................................................................................................ 49

Delta Update .................................................................................................. 49

Optimistic Locking .......................................................................................... 49

Reliable Messaging............................................................................................ 51

Restartable Services ...................................................................................... 52

Verification Services ....................................................................................... 52

Idempotent Services....................................................................................... 54

Important Facts for Implementers................................................................ 55

Commit Procedures ........................................................................................... 55

Commit by XI Only.......................................................................................... 56

No Commit by Framework .............................................................................. 57

Exceptions and Errors ........................................................................................... 58

Exception........................................................................................................... 59



Error Message ................................................................................................... 60

Security................................................................................................................. 61

Providing Secure Transportation ........................................................................ 62

Providing Authentication in SAP Web AS ........................................................... 62

Providing Authorization within the mySAP Business Suite .................................. 63

Web Service Invocation via XI Message Broker ..................................................... 63

SAP Exchange Infrastructure ............................................................................. 63

XI Protocol ......................................................................................................... 65

XI Local Integration Engine ................................................................................ 65 mySAP Service Provisioning: Design Time ............................................................... 65

Business Object and Service Modeling.................................................................. 66

Business Object Modeling.................................................................................. 66

Process Component ....................................................................................... 67

Business Object ............................................................................................. 67

Service Interface Modeling................................................................................. 69

Proxy Generation in the ABAP Stack ..................................................................... 71 mySAP Service Provisioning: Configuration .............................................................. 72

Releasing a Web Service ...................................................................................... 73

Service Definition and Service Variant................................................................ 74

Performing Web Service Administration................................................................. 74

Configuring Idempotent Services ........................................................................... 75

Example: Service Operation...................................................................................... 76

Modeling of Process Components in ARIS............................................................. 76

Business Object Modeling ..................................................................................... 78

Modeling of Service Interface in ESR..................................................................... 79

Proxy Implementation............................................................................................ 80

RFC: PT_ESA_REQUEST_CREATE................................................................. 86 mySAP Service Provisioning: Documentation............................................................ 86

Stability of Released Enterprise Services .................................................................. 88

Glossary ................................................................................................................... 90

A2A....................................................................................................................... 90

ABAP .................................................................................................................... 90

BAPI ..................................................................................................................... 90

B2B....................................................................................................................... 90

HTTP .................................................................................................................... 90

HTTPS.................................................................................................................. 91

Java ...................................................................................................................... 91

RFC ...................................................................................................................... 91

SAML.................................................................................................................... 91

SSL....................................................................................................................... 92



XML ...................................................................................................................... 92

XML Encryption..................................................................................................... 92

XML Signature ...................................................................................................... 92

About This Documentation ........................................................................................... 92

SAP: Important Disclaimers and Legal Information ....................................................... 96

Enterprise Services for SAP ERP Cross-Application Components.................................... 96

Enterprise Services for SAP ERP Foundation............................................................... 97

Business Partner Data Processing ............................................................................ 97

Employee.............................................................................................................. 97

Manage Employee In ......................................................................................... 98

Read Employee Basic Data ............................................................................ 99

Read Employee Name.................................................................................. 100

Read Employee Photo.................................................................................. 101

Create Personal Address.............................................................................. 102

Change Personal Address ............................................................................ 105

Cancel Personal Address ............................................................................. 106

Read Employee Dependant.......................................................................... 107

Query Employee In .......................................................................................... 109

Find Reporting Line Manager by Employee .................................................. 110

Find Reporting Employee by Employee ........................................................ 111

Find Reporting Line Peer by Employee......................................................... 113

Find Organisational Centre Employee by Employee...................................... 114

Find Employee Address by Employee........................................................... 115

Find Employee Communication Data by Employee....................................... 117

Find Employee by Work Centre .................................................................... 118

Customer ............................................................................................................ 120

Manage Customer In........................................................................................ 120

Read Customer Basic Data .......................................................................... 121

Change Customer Basic Data....................................................................... 122

Query Customer In........................................................................................... 123

Find Customer by Address and Contact Person............................................ 123

Supplier............................................................................................................... 124

Query Supplier In............................................................................................. 125

Find Supplier by Name and Address............................................................. 126

Supplier Product Category By Id Query Response_In....................................... 127

Read Supplier Product Category .................................................................. 127

Sales Arrangement.............................................................................................. 128

Query Sales Arrangement In............................................................................ 128

Find Sales Arrangement by Customer .......................................................... 129

Identity Management .............................................................................................. 130



Identity ................................................................................................................ 130

Query Identity In .............................................................................................. 131

Find User Account by Employee................................................................... 131

Organisational Management ................................................................................... 132

Organisational Centre.......................................................................................... 133

Query Organisational Centre In........................................................................ 133

Find Organisational Centre by Employee...................................................... 134

Find Employee by Organisational Centre...................................................... 135

Find Manager by Organisational Centre........................................................ 136

Cost Centre......................................................................................................... 137

Query Cost Centre In ....................................................................................... 138

Find Cost Centre by Organisational Centre................................................... 138

Programme ......................................................................................................... 139

Manage Programme In .................................................................................... 140

Read Programme Plan Value ....................................................................... 140

Product Data Management ..................................................................................... 141

Material ............................................................................................................... 142

Query Material In ............................................................................................. 142

Find Material by ID and Description .............................................................. 143

Find Material by GTIN................................................................................... 144

Find Material by Search Text ........................................................................ 145

Find Material Sales Specification by Elements .............................................. 146

Manage Material In .......................................................................................... 147

Read Material Basic Data ............................................................................. 148

Read Material Sales Specification................................................................. 149

Individual Material ............................................................................................... 149

Manage Individual Material In........................................................................... 150

Read Individual Material ............................................................................... 151

Query Individual Material In.............................................................................. 152

Find Individual Material by Elements............................................................. 152

Individual Material Action In.............................................................................. 153

Install Individual Material .............................................................................. 154

Dismantle Individual Material ........................................................................ 155

Identified Stock.................................................................................................... 156

Query Batch In................................................................................................. 157

Find Batch By Elements ............................................................................... 157

Manage Batch In.............................................................................................. 159

Read Batch .................................................................................................. 160

Create Batch ................................................................................................ 161

Change Batch .............................................................................................. 162



Create Batch Plant Assignment .................................................................... 164

Change Batch Plant Assignment .................................................................. 165

Product Procurement Arrangement...................................................................... 166

Query Product Procurement Arrangement In.................................................... 166

ProductProcurementArrangementByElementsQueryResponse_In ................ 167

ProductProcurementArrangementByIDQueryResponse_In ........................... 168

Merchandise Category Hierarchy......................................................................... 169

Query Merchandise Category Hierarchy In....................................................... 170

MerchandiseCategorySimpleByIDAndDescriptionQueryResponse_In ........... 171

Enterprise Services for SAP ERP ECC....................................................................... 172

Document Management.......................................................................................... 172

Document............................................................................................................ 173

Manage Document In....................................................................................... 173

Create Document ......................................................................................... 174

Create Documents........................................................................................ 174

Create Document Version............................................................................. 175

Read Document ........................................................................................... 176

Update Document ........................................................................................ 176

Update Documents....................................................................................... 177

Document Action In.......................................................................................... 178

Release Document ....................................................................................... 178

Query Document In.......................................................................................... 179

Find Document by Elements......................................................................... 179

Read Latest Released Document Version..................................................... 180

Find Document by Property Valuation........................................................... 181

Resource Data Management .................................................................................. 181

Work Centre........................................................................................................ 182

Query Work Centre In ...................................................................................... 183

Find Work Centre by Plant............................................................................ 183

Enterprise Services for SAP ERP Logistics .................................................................... 184

Appropriation Request ................................................................................................ 185

Appropriation Request Action In.............................................................................. 185

Approve Appropriation Request ........................................................................... 186

Reject Appropriation Request .............................................................................. 187

Postpone Appropriation Request ......................................................................... 187

Manage Appropriation Request............................................................................... 188

Read Appropriation Request................................................................................ 189

Query Appropriation Request In .............................................................................. 190

Find Appropriation Request for Approval by Approver and Approval Status.......... 191

Find Appropriation Request Plan Values by Programme and Planning Version.... 192



Customer Quote Processing....................................................................................... 193

Customer Quote ..................................................................................................... 194

Manage Customer Quote In................................................................................. 195

Read Customer Quote ..................................................................................... 195

Change Customer Quote User Status .............................................................. 196

Query Customer Quote In.................................................................................... 198

Find Customer Quote Basic Data by Basic Data and User Status..................... 199

Find Customer Quote Basic Data by Buyer and Basic Data.............................. 202

Find Customer Quote Basic Data by Buyer and Incompleteness ...................... 204

Find Customer Quote Basic Data by Buyer and Validity Period ........................ 205

Entries for Customer Quote ................................................................................. 206

Find Allowed User Status by Processing Type Code ........................................ 207

Customer Return Processing...................................................................................... 208

Customer Return .................................................................................................... 208

Manage Customer Return In................................................................................ 208

Create Customer Return .................................................................................. 209

Query Customer Return In................................................................................... 211

Find Customer Return Basic Data by Buyer and Basic Data............................. 212

Engineering Change Processing................................................................................. 214

Engineering Change Order ..................................................................................... 215

Query Engineering Change Order In.................................................................... 215

Find Engineering Change Order by Material..................................................... 216

Find Engineering Change Order by Production Bill of Material.......................... 217

Manage Engineering Change Order In................................................................. 218

Create Engineering Change Order ................................................................... 219

Read Engineering Change Order ..................................................................... 220

Engineering Change Request ................................................................................. 221

Query Engineering Change Request In................................................................ 222

Find Engineering Change Request by Material................................................. 223

Find Engineering Change Request by Production Bill of Material...................... 224

Manage Engineering Change Request In ............................................................ 225

Read Engineering Change Request ................................................................. 226

Create Engineering Change Request ............................................................... 227

Inbound Delivery Processing ...................................................................................... 228

Customer Returns Delivery ..................................................................................... 228

Manage Customer Returns Delivery In ................................................................ 229

Create Delivery With Reference to Customer Return........................................ 230

Inspection Master Data Processing............................................................................. 231

Quality Issue Category Catalogue ........................................................................... 231

Manage Quality Issue Category Catalogue In ...................................................... 232



Read Quality Issue Category Catalogue Category............................................ 233

Query Quality Issue Category Catalogue In ......................................................... 234

Find Quality Issue Category Catalogue by Quality Issue Notification Type........ 235

Installed Base Data Processing .................................................................................. 236

Installation Point ..................................................................................................... 236

Query Installation Point In.................................................................................... 237

Find Installation Point by Elements................................................................... 238

Manage Installation Point .................................................................................... 239

Read Installation Point ..................................................................................... 239

Change Installation Point User Status .............................................................. 240

Installation Point Action In ................................................................................... 241

Install Individual Material .................................................................................. 242

Dismantle Individual Material............................................................................ 243

Inventory Processing .................................................................................................. 244

Inventory................................................................................................................. 245

Query Inventory In............................................................................................... 245

Find Inventory by Material and Location ........................................................... 246

Maintenance Processing ............................................................................................ 247

Maintenance Request ............................................................................................. 247

Maintenance Request Action In ........................................................................... 248

Release Maintenance Request ........................................................................ 248

Close Maintenance Request ............................................................................ 249

Manage Maintenance Request In ........................................................................ 250

Create Maintenance Request ........................................................................... 251

Read Maintenance Request ............................................................................. 252

Check Maintenance Request Change .............................................................. 253

Change Maintenance Request ......................................................................... 254

Entries for Maintenance Request In ..................................................................... 255

Find Allowed Importance by Request Type....................................................... 255

Find Maintenance Request by Individual Material and Installation Point............ 256

Maintenance Order ................................................................................................. 257

Query Maintenance Order In ............................................................................... 258

Find Maintenance Order by Basic Data ............................................................ 259

Maintenance Order Action In ............................................................................... 260

Release Maintenance Order............................................................................. 260

Technically Close Maintenance Order .............................................................. 261

Check Maintenance Order Release.................................................................. 262

Check Technical Close Maintenance Order...................................................... 263

Manage Maintenance Order In ............................................................................ 264

Read Maintenance Order ................................................................................. 265



Create Maintenance Order............................................................................... 266

Change Maintenance Order ............................................................................. 266

Check Create Maintenance Order .................................................................... 267

Check Change Maintenance Order .................................................................. 268

Entries for Maintenance Order In ......................................................................... 269

Find Allowed User Status by Order Type.......................................................... 270

Find Allowed Planner Group by Location ID ..................................................... 271

Maintenance Confirmation ...................................................................................... 272

Manage Maintenance Confirmation In ................................................................. 272

Create Maintenance Confirmation .................................................................... 273

Maintenance Master Data Processing ........................................................................ 274

Maintenance Issue Category Catalogue.................................................................. 274

Manage Maintenance Issue Category Catalogue In ............................................. 275

Read Maintenance Issue Category Catalogue.................................................. 276

Query Maintenance Issue Category Catalogue In ................................................ 277

Find Catalogue by Maintenance Request Type ................................................ 278

Material Inspection Processing ................................................................................... 279

Material Inspection.................................................................................................. 279

Manage Material Inspection In............................................................................. 280

Read Material Inspection.................................................................................. 281

Create Material Inspection Decision ................................................................. 281

Create Subset Operation Inspection Activity..................................................... 282

Read Subset Operation Inspection Activity ....................................................... 283

Create Subset Operation Inspection Activity Finding ........................................ 284

Create Material Inspection Subset.................................................................... 285

Create Material Inspection Subset Decision ..................................................... 286

Material Inspection Action In................................................................................ 287

Record Subset Operation Inspection Activity Result ......................................... 287

Query Material Inspection In................................................................................ 288

Find Material Inspection Basic Data by Elements ............................................. 289

Find Material Inspection Subset Operation by Elements ................................... 291

Find Subset Operation Inspection Activity Basic Data by Elements................... 292

Material Inspection Sample ..................................................................................... 294

Manage Material Inspection Sample In ................................................................ 294

Create Material Inspection Sample................................................................... 295

Query Material Inspection Sample In ................................................................... 296

Find Material Inspection Sample by Elements .................................................. 296

Outbound Delivery Processing ................................................................................... 297

Outbound Delivery .................................................................................................. 298

Query Outbound Delivery .................................................................................... 298



Find Outbound Delivery Simple by Customer ................................................... 299

Product Model Management....................................................................................... 300

Product Engineering and Production Assembly ....................................................... 300

Query Product Engineering and Production Assembly In ..................................... 301

Find Product Engineering and Production Assembly Item Basic Data by Elements

........................................................................................................................ 302

Product Engineering and Production Structure ........................................................ 303

Query Product Engineering and Production Structure In ...................................... 304

Find Product Engineering and Production Structure Variant Basic Data by

Elements ......................................................................................................... 305

Production.................................................................................................................. 306

Production Order .................................................................................................... 306

Query Production Order In................................................................................... 307

Find Production Order By Elements ................................................................. 308

Find Production Order By Work Centre ............................................................ 309

Manage Production Order In................................................................................ 311

Read Production Order .................................................................................... 311

Production Confirmation.......................................................................................... 312

Production Confirmation In .................................................................................. 313

Maintain Production Confirmation..................................................................... 314

Manage Production Confirmation In..................................................................... 315

Create Production Confirmation ....................................................................... 316

Cancel Production Confirmation....................................................................... 317

Production Confirmation Out................................................................................ 318

Confirm Production Confirmation...................................................................... 318

Repetitive Manufacturing Confirmation.................................................................... 319

Repetitive Manufacturing Confirming In ............................................................... 320

Maintain Repetitive Manufacturing Confirmation............................................... 320

Manage Repetitive Manufacturing Confirmation In............................................... 321

Create Repetitive Manufacturing Confirmation.................................................. 322

Cancel Repetitive Manufacturing Confirmation ................................................. 323

Repetitive Manufacturing Confirmation Out.......................................................... 324

Confirm Repetitive Manufacturing Confirmation................................................ 325

Production Model Management .................................................................................. 326

Production Bill of Material........................................................................................ 326

Query Production Bill of Material In...................................................................... 327

Find Production Bill of Material Variant Basic Data by Material and Plant.......... 328

Find Variant Item Basic Data by Variant Identifying Elements........................... 329

Manage Production Bill of Material In................................................................... 330

Find Variant Item by Variant Identifying Elements............................................. 331



Production Bill of Operations................................................................................... 332

Query Production Bill of Operations In ................................................................. 332

Find Production BOO Simple by Identifying Elements and Material .................. 333

Project Master Data Management .............................................................................. 334

Project Issue Category Catalogue ........................................................................... 335

Manage Project Issue Category Catalogue In ...................................................... 335

Project Issue Category Catalogue Category ..................................................... 336

Query Project Issue Category Catalogue In ......................................................... 337

Find Project Issue Category Catalogue Simple by Change Type ...................... 338

Project Processing ..................................................................................................... 339

Project .................................................................................................................... 340

Query Project In .................................................................................................. 340

Find Project Activity by Work Breakdown Structure Element............................. 341

Find Project Description by ID .......................................................................... 342

Find Project Work Breakdown Structure Element by Project............................. 343

Read Project Work Breakdown Structure Element Attachment ......................... 344

Read Project Activity Attachment ..................................................................... 345

Find Project Party by ID and Party Role Code .................................................. 346

Find Project ID by Party ................................................................................... 347

Manage Project In ............................................................................................... 348

Read Project Description.................................................................................. 348

Read Project Work Breakdown Structure Element............................................ 349

Read Project Activity ........................................................................................ 350

Change Project Activity .................................................................................... 351

Check Change Project Activity ......................................................................... 352

Project Change ....................................................................................................... 353

Manage Project Change In .................................................................................. 354

Create Project Change..................................................................................... 354

Appropriation Request ............................................................................................ 355

Appropriation Request Action In .......................................................................... 356

Approve Appropriation Request........................................................................ 357

Reject Appropriation Request........................................................................... 358

Postpone Appropriation Request...................................................................... 358

Manage Appropriation Request ........................................................................... 359

Read Appropriation Request ............................................................................ 360

Query Appropriation Request In........................................................................... 361

Find Appropriation Request for Approval by Approver and Approval Status ...... 361

Find Appropriation Request Plan Values by Programme and Planning Version 363

Purchase Order Processing........................................................................................ 364

Purchase Order ...................................................................................................... 365



Query Purchase Order In..................................................................................... 365

Find Purchase Order by Seller and Product and Organisational Data ............... 366

Find Purchase Order by ID............................................................................... 367

Find Purchase Order Item by Account Assignment........................................... 368

Manage Purchase Order In ................................................................................. 369

Create Purchase Order .................................................................................... 370

Change Purchase Order .................................................................................. 371

Strategic Investment Buy ........................................................................................ 373

StrategicInvestmentBuySimulateQueryResponse_In ........................................... 373

Simulate Strategic Investment Buy................................................................... 374

Purchase Request Processing.................................................................................... 374

Purchase Request .................................................................................................. 375

Query Purchase Request In................................................................................. 376

Find Purchase Request Item by Product and Organisational Data .................... 376

Find Purchase Request by ID........................................................................... 377

Find Purchase Request by Release Information ............................................... 378

Find Purchase Request Item by Account Assignment....................................... 379

Manage Purchase Request In ............................................................................. 380

Create Purchase Request ................................................................................ 381

Change Purchase Request .............................................................................. 382

Release Purchase Request.............................................................................. 383

Quality Issue Processing ............................................................................................ 384

Quality Issue Notification......................................................................................... 385

Manage Quality Issue Notification In.................................................................... 385

Create Quality Issue Notification ...................................................................... 386

Read Quality Issue Notification ........................................................................ 387

Change Quality Issue Notification..................................................................... 388

Query Quality Issue Notification In....................................................................... 389

Find Quality Issue Notification by Elements ...................................................... 389

Sales Order Processing.............................................................................................. 391

Sales Order ............................................................................................................ 392

Query Sales Order In........................................................................................... 392

Find Sales Order Item by Buyer and Product.................................................... 393

Find Sales Order Basic Data by Buyer and Basic Data..................................... 394

Find Sales Order Basic Data by Buyer and by Invoicing Blocked...................... 396

Find Sales Order Basic Data by Buyer and Credit Blocked ............................... 397

Find Sales Order Basic Data by Buyer and Incompleteness ............................. 398

Find Sales Order Basic Data by Buyer and Delivery Blocked............................ 400

Manage Sales Order In ....................................................................................... 401

Create Sales Order .......................................................................................... 401



Read Sales Order Item .................................................................................... 404

Read Sales Order ............................................................................................ 405

Change Sales Order Item Schedule Line.......................................................... 406

Site Logistics Processing............................................................................................ 407

Goods Movement ................................................................................................... 407

Manage Goods Movement In............................................................................... 408

Create Goods Movement With Reference ........................................................ 409

Create Goods Movement ................................................................................. 410

Cancel Goods Movement................................................................................. 415

Supply and Demand Matching.................................................................................... 416

Production Planning Order ...................................................................................... 417

Query Production Planning Order In .................................................................... 418

Find Production Planning Order By Elements................................................... 419

Manage Production Planning Order In ................................................................. 420

Create Production Planning Order.................................................................... 421

Read Production Planning Order...................................................................... 421

Change Production Planning Order .................................................................. 422

Update Production Planning Order................................................................... 422

Cancel Production Planning Order ................................................................... 422

Material Supply and Demand View.......................................................................... 422

Manage Material Supply and Demand View......................................................... 424

Read Material Supply and Demand View ......................................................... 426

Product Availability Requirement............................................................................. 429

Manage Product Availability Requirement............................................................ 430

Check Requirement ......................................................................................... 433

Check Requirement and Reserve..................................................................... 435

Cancel Requirement ........................................................................................ 438

Enterprise Services for SAP ERP Financials .................................................................. 441

Accounting ................................................................................................................. 441

Cost Center Variance Budget Monitoring Rule ........................................................ 442

Manage Cost Center Variance Budget Monitoring Rule ....................................... 443

Create Rule ..................................................................................................... 444

Change Rule.................................................................................................... 444

Cancel Rule ..................................................................................................... 445

Read Rule........................................................................................................ 446

Read Rule Evaluation Result............................................................................ 447

Query Cost Center Variance Budget Monitoring Rule........................................... 448

Find Rule by Owner ......................................................................................... 448

Find Rule Evaluation Result by Owner ............................................................. 449

Cost Center Line Item Budget Monitoring Rule........................................................ 450



Manage Cost Center Line Item Budget Monitoring Rule....................................... 451

Create Rule ..................................................................................................... 452

Change Rule.................................................................................................... 453

Cancel Rule ..................................................................................................... 453

Read Rule........................................................................................................ 454


Query Cost Center Line Item Budget Monitoring Rule .......................................... 456



Profit Center Variance Budget Monitoring Rule ....................................................... 459

Manage Profit Center Variance Budget Monitoring Rule ...................................... 460

Create Rule ..................................................................................................... 461

Change Rule.................................................................................................... 462

Cancel Rule ..................................................................................................... 462

Read Rule........................................................................................................ 463


Query Profit Center Variance Budget Monitoring Rule.......................................... 465



Profit Center Line Item Budget Monitoring Rule....................................................... 467

Manage Profit Center Line Item Budget Monitoring Rule...................................... 468

Create Rule ..................................................................................................... 469

Change Rule.................................................................................................... 470

Cancel Rule ..................................................................................................... 471

Read Rule........................................................................................................ 471


Query Profit Center Line Item Budget Monitoring Rule ......................................... 473



Internal Order Variance Budget Monitoring Rule...................................................... 476

Manage Internal Order Variance Budget Monitoring Rule..................................... 477

Create Rule ..................................................................................................... 478

Change Rule.................................................................................................... 479

Cancel Rule ..................................................................................................... 480

Read Rule........................................................................................................ 480


Query Internal Order Variance Budget Monitoring Rule........................................ 482



Internal Order Line Item Budget Monitoring Rule ..................................................... 484



Manage Internal Order Line Item Budget Monitoring Rule .................................... 485

Create Rule ..................................................................................................... 486

Change Rule.................................................................................................... 487

Cancel Rule ..................................................................................................... 488

Read Rule........................................................................................................ 489


Query Internal Order Line Item Budget Monitoring Rule ....................................... 490



Cost Center Variance Budget Monitoring Rule Configuration................................... 493

Query Cost Center Variance Budget Monitoring Rule Configuration..................... 494

Find Cost Center Variance Budget Monitoring Rule Configuration by Owner .... 495

Cost Center Line Item Budget Monitoring Rule Configuration .................................. 495

Query Cost Center Line Item Budget Monitoring Rule Configuration .................... 496

Find Cost Center Line Item Budget Monitoring Rule Configuration by Owner.... 497

Profit Center Variance Budget Monitoring Rule Configuration.................................. 498

Query Profit Center Variance Budget Monitoring Rule Configuration .................... 499

Find Profit Center Variance Budget Monitoring Rule Configuration by Owner ... 499

Profit Center Line Item Budget Monitoring Rule Configuration ................................. 500

Query Profit Center Line Item Budget Monitoring Rule Configuration ................... 501

Find Profit Center Line Item Budget Monitoring Rule Configuration by Owner... 502

Internal Order Variance Budget Monitoring Rule Configuration................................ 503

Query Internal Order Variance Budget Monitoring Rule Configuration .................. 504

Find Internal Order Variance Budget Monitoring Rule Configuration by Owner . 504

Internal Order Line Item Budget Monitoring Rule Configuration ............................... 505

Query Internal Order Line Item Budget Monitoring Rule Configuration ................. 506

Find Internal Order Line Item Budget Monitoring Rule Configuration by Owner . 507

Funds Management Account .................................................................................. 507

Query Funds Management Account..................................................................... 508

Find Funds Management Account by Elements................................................ 509

Manage Funds Management Account ................................................................. 509

Create Funds Management Account ................................................................ 510

Change Funds Management Account .............................................................. 511

Read Funds Management Account .................................................................. 512

Funds Management Program.................................................................................. 512

Query Funds Management Program.................................................................... 513

Find Funds Management Program by Elements ............................................... 514

Manage Funds Management Program................................................................. 515

Create Funds Management Program ............................................................... 515

Change Funds Management Program.............................................................. 516



Read Funds Management Program.................................................................. 517

Funds Management Fund ....................................................................................... 518

Query Funds Management Fund ......................................................................... 518

Find Funds Management Fund by Elements .................................................... 519

Manage Funds Management Fund ...................................................................... 520

Create Funds Management Fund..................................................................... 521

Change Funds Management Fund ................................................................... 522

Read Funds Management Fund....................................................................... 522

Funds Management Functional Area....................................................................... 523

Query Funds Management Functional Area......................................................... 524

Find Funds Management Functional Area by Elements .................................... 524

Manage Funds Management Functional Area...................................................... 525

Create Funds Management Functional Area .................................................... 526

Change Funds Management Functional Area................................................... 527

Read Funds Management Functional Area....................................................... 527

Financial Accounting View Of Project ...................................................................... 528

Query Financial Accounting View Of Project In .................................................... 529

Find Financial Accounting View Of Project by Project ID .................................. 529

Manage Financial Accounting View Of Project In ................................................. 530

Read Financial Accounting View of Project Structure ....................................... 531

Read Financial Accounting View Of Project...................................................... 532

Budget Processing ..................................................................................................... 533

Budget Document ................................................................................................... 534

Manage Budget Document In .............................................................................. 534

Create Budget Document................................................................................. 535

Contract Accounting Receivables Payables Processing.............................................. 536

Contract Account .................................................................................................... 537

Manage Contract Account In ............................................................................... 538

Read Contract Account Payment Terms........................................................... 538

Query Contract Account In .................................................................................. 539

Find Contract Account Balance ........................................................................ 539

Cash Deposit Request ............................................................................................ 540

Manage Cash Deposit Request ........................................................................... 540

Create Cash Deposit Request .......................................................................... 541

Credit Management.................................................................................................... 542

SAP A2A Interface CreditWorthinessQuery_In ........................................................ 542

SAP A2A Interfaces CreditCommitment_In and CreditCommitment_Out ................. 547

SAP A2A Interface CreditPaymentBehaviourSummaryNotification_In...................... 553

SAP A2A Interface BusinessPartnerIDByElementsQuery_Out................................. 557



SAP A2A Interfaces CreditAgencyMonitorQuery_Out and

CreditAgencyMonitorNotification_In ........................................................................ 561

SAP A2A Interface CreditManagementAccountByIDQuery_In ................................. 567

SAP A2A Interface CreditManagementAccountChangeNotification_In..................... 571

SAP A2A Interface CreditWorthinessCriticalPartiesQuery_In................................... 573

SAP A2A Interface CreditWorthinessChangeInformation_Out ................................. 577

Due Item Processing .................................................................................................. 579

Due Payment.......................................................................................................... 579

Manage Due Payment In..................................................................................... 579

Create Due Payment........................................................................................ 580

Trade Receivables Payables Account ..................................................................... 582

Query Trade Receivables Payables Account In ................................................... 582

Find Open Item by Customer ........................................................................... 583

Find Cleared Item by Customer........................................................................ 585

Expense and Reimbursement Management ............................................................... 587

Expense Arrangement ............................................................................................ 587

Query Expense Arrangement In........................................................................... 588

Find Expense Arrangement by Employee......................................................... 589

Find Expense Reporter Substitute by Expense Arrangement............................ 590

Manage Expense Arrangement ........................................................................... 590

Create Expense Reporter Substitute ................................................................ 592

Cancel Expense Reporter Substitute................................................................ 593

Internal Control Management ..................................................................................... 593

Business Process Internal Control........................................................................... 595

Manage Business Process Internal Control In...................................................... 595

Read Business Process Internal Control .......................................................... 596

Read Business Process Internal Control Risk Assignment................................ 597

Read Business Process Internal Control Account............................................. 598

Control Activity Assessment.................................................................................... 599

Query Control Activity Assessment In .................................................................. 600

Find Control Activity Assessment by Internal Control........................................ 600

Manage Control Activity Assessment In............................................................... 601

Read Control Activity Assessment.................................................................... 602

Action Control Activity Assessment In.................................................................. 603

Validate Control Activity Assessment ............................................................... 603

Business Process Internal Control Assessment....................................................... 604

Manage Business Process Internal Control Assessment In.................................. 605

Read Business Process Internal Control Assessment....................................... 605

Change Business Process Internal Control Assessment................................... 606

Create Internal Control Assessment Attachment .............................................. 607



Read Business Process Internal Control Assessment Attachment .................... 608

Cancel Business Process Internal Control Assessment Attachment ................. 609

Management Control Assessment........................................................................... 610

Query Management Control Assessment In......................................................... 610

Find Management Control Assessment by Elements........................................ 611

Manage Management Control Assessment In...................................................... 612

Read Management Control Assessment .......................................................... 613

Change Management Control Assessment....................................................... 614

Internal Control Issue .............................................................................................. 615

Query Internal Control Issue In ............................................................................ 615

Find Issue by Reporting Line Unit..................................................................... 616

Find Issue by Management Control Assessment .............................................. 617

Manage Internal Control Issue In ......................................................................... 618

Read Issue ...................................................................................................... 618

Create Issue .................................................................................................... 619

Change Issue................................................................................................... 620

Cancel Issue .................................................................................................... 621

Entries for Internal Control Issue Allowed Responsible In..................................... 622

Find Allowed Responsible ................................................................................ 623

Internal Control Remediation Plan........................................................................... 624

Manage Internal Control Issue Remediation Plan In............................................. 624

Read Remediation Plan ................................................................................... 625

Action Internal Control Issue Remediation Plan In................................................ 626

Validate Remediation Plan ............................................................................... 626

Internal Control Sign-Off ......................................................................................... 627

Query Internal Control Sign-Off In........................................................................ 628

Find Subordinate Internal Control Sign-Off by Internal Control Sign-Off ............ 628

Manage Internal Control Sign-Off In..................................................................... 629

Read Sign-Off .................................................................................................. 630

Create Sign-Off Attachment ............................................................................. 631

Read Sign-Off Attachment ............................................................................... 632

Cancel Sign-Off Attachment ............................................................................. 633

Action Internal Control Sign-Off In ....................................................................... 634

Perform Sign-Off .............................................................................................. 634

Payment Processing................................................................................................... 635

Payment Card Payment Authorisation..................................................................... 636

Payment Card Payment Authorisation Out........................................................... 636

Request Payment Card Payment Pre Authorisation.......................................... 637

Request Payment Card Authorisation............................................................... 638

Request Payment Card Authorisation Cancellation........................................... 639



Clearing House Payment Order .............................................................................. 640

Payment Card Payment Settling Out ................................................................... 641

Request Payment Card Payment ..................................................................... 641

Payment Card Payment Settling In ...................................................................... 642

Change Clearing House Payment Order Based On Confirmation ..................... 643

Enterprise Services for SAP ERP Human Capital Management...................................... 644

Personnel Administration............................................................................................ 644

Employment............................................................................................................ 645

Manage Employment........................................................................................... 645

Find Employment Country by Employee........................................................... 646

Work Agreement..................................................................................................... 647

Query Work Agreement In ................................................................................... 648

Find Work Agreement by Elements .................................................................. 649

Find Administrative and Organisational Data by Employee ............................... 650

Time and Labour Management................................................................................... 653

Employee Time Sheet............................................................................................. 654

Example: Message Choreography for the Employee Time Sheet ......................... 656

Manage Employee Time Sheet In........................................................................ 657

Change Time Sheet ......................................................................................... 658

Check Change Time Sheet .............................................................................. 659

Employee Time Sheet Action In........................................................................... 660

Standard Account Assignments with the Time Sheet (CATS) ........................... 662

Complete Employee Time Sheet ...................................................................... 663

Query Employee Time Sheet In........................................................................... 665

Find Employee Time Sheet by Employee ......................................................... 665

Entries for Employee Time Sheet In..................................................................... 667

Find Allowed Receiving Cost Centres by Employee.......................................... 667

Find Allowed Network by Employee ................................................................. 668

Find Allowed Order by Employee ..................................................................... 670

Find Allowed Work Break Down Structure Element by Employee ..................... 671

Find Allowed Measure Unit by Employee ......................................................... 672

Find Allowed Employee Time Item Types by Employee.................................... 673

Find Allowed Resource Class by Employee...................................................... 674

Find Allowed Purchase Orders by Employee.................................................... 675

Find Allowed Controlling Key Figures by Employee .......................................... 676

Find Allowed Service Products by Employee.................................................... 678

Find Allowed Warranty Goodwill Types by Employee ....................................... 679

Find Allowed Receiving Funds Management Functional Areas by Employee .... 680

Find Allowed Receiving Funds by Employee .................................................... 681

Find Allowed Receiving Grants by Employee ................................................... 682



Find Allowed Receiving Costing Activities by Employee ................................... 684

Find Allowed Currencies by Employee ............................................................. 685

Find Allowed Task Types by Employee ............................................................ 686

Find Allowed Task Levels by Employee............................................................ 687

Find Allowed Task Components by Employee.................................................. 688

Find Allowed Receiving Sales Orders by Employee.......................................... 689

Find Allowed Projects by Employee.................................................................. 690

Employee Time Agreement..................................................................................... 691

Manage Employee Time Agreement In................................................................ 692

Create Time Recording Completion Rule ......................................................... 693

Cancel Time Recording Completion Rule ......................................................... 695

Read Time Recording Completion Rule............................................................ 696

Read Time Recording Provisions ..................................................................... 697

Employee Time Sheet Configuration ....................................................................... 699

Manage Employee Time Sheet Configuration In .................................................. 699

Read Employee Time Sheet Configuration....................................................... 700

Employee Time Calendar........................................................................................ 702

Manage Employee Time Calendar In................................................................... 702

Read Employee Time Calendar Planned Working Time ................................... 703

Query Employee Time Calendar In...................................................................... 704

Find Availability by Employee........................................................................... 705

Employee Time....................................................................................................... 706

Query Employee Time In..................................................................................... 707

Find Times for Employee Time Sheet by Elements........................................... 707

Manage Employee Time In.................................................................................. 708

Read Employee Time by Employee.................................................................. 709

Employee Time Account ......................................................................................... 711

Query Employee Time Account In ....................................................................... 711

Find Employee Time Account for Employee ..................................................... 712

Employee Leave Request ....................................................................................... 714

Example: Message Choreography for the Employee Leave Request ................... 716

Manage Employee Leave Request In .................................................................. 717

Create Employee Leave Request..................................................................... 719

Check Create Employee Leave Request .......................................................... 722

Change Employee Leave Request ................................................................... 723

Check Change Employee Leave Request ........................................................ 724

Cancel Employee Leave Request .................................................................... 725

Check Cancel Employee Leave Request.......................................................... 727

Read Employee Leave Request In ................................................................... 728

Employee Leave Request Action In ..................................................................... 729



Approve Employee Leave Request .................................................................. 730

Check Approve Employee Leave Request........................................................ 731

Reject Employee Leave Request ..................................................................... 732

Check Reject Employee Leave Request........................................................... 733

Entries for Employee Leave Request In ............................................................... 734

Find Allowed Approvers by Identifying Elements .............................................. 734

Find Default Request by Owner........................................................................ 736

Query Employee Leave Request ......................................................................... 737

Find Employee Leave Request by Participant .................................................. 737

Employee Leave Request Configuration.................................................................. 739

Manage Employee Leave Request Configuration In............................................. 740

Read Employee Leave Request Configuration by Employee ............................ 741

Compensation Management....................................................................................... 742

Employee Compensation Agreement ...................................................................... 742

Employee Compensation Agreement Statistics In................................................ 743

Employee Compensation Agreement Estimated Annual Salary ........................ 744

Manage Employee Compensation Agreement ..................................................... 745

Read Compensation Structure Grade Assignment............................................ 745

Read Long Term Incentive Plan ....................................................................... 747

Benefits Administration............................................................................................... 748

Employee Benefits Participation.............................................................................. 749

Manage Employee Benefits Participation In ......................................................... 749

Read Health Plan............................................................................................. 750

Read Insurance Plan........................................................................................ 751

Read Savings Plan .......................................................................................... 752

Read Credit Plan.............................................................................................. 753

Read Miscellaneous Plan................................................................................. 754

Read Stock Purchase Plan .............................................................................. 755

Read Flexible Spending Account...................................................................... 756

Read Flexible Spending Account Claim............................................................ 757

Enterprise Services for SAP for Utilities.......................................................................... 758

Measurement Processing ........................................................................................... 758

Meter Reading Card................................................................................................ 759

Manage Meter Reading Card In........................................................................... 759

Meter Reading Card Change............................................................................ 760

Utilities Contract Processing ....................................................................................... 760

Utility Contract ........................................................................................................ 761

Manage Utility Contract In ................................................................................... 761

Read Utility Contract Basic Data ...................................................................... 762

Enterprise Services for SAP for Insurance...................................................................... 762



Claims Management................................................................................................... 762

Insurance Claim Processing.................................................................................... 763

Insurance Claim .................................................................................................. 763

Manage Insurance Claim In.............................................................................. 763

Create Insurance Claim ................................................................................ 764

Insurance Claim Notification ................................................................................ 765

Manage Insurance Claim Notification ............................................................... 765

Create Insurance Claim Notification.............................................................. 766


SAP Documentation

Enterprise Services for SAP ERP

Enterprise SOA

SAP Enterprise Services

Purpose

Enterprise Services from SAP afford you many new opportunities to automate your business processes and react flexibly to changes in your business processes. You can convert new business processes much more easily. You can also implement the Enterprise Services in heterogeneous, distributed system landscapes by implementing standardized Web technologies.

Integration

A large number of Enterprise Services for typical business processes are already available in the SAP Business Suite applications. You can implement these services so that they communicate directly with other applications, client programs, user interfaces, and so on.

Alternatively, you can use the Enterprises Services from SAP using the SAP

NetWeaver Exchange Infrastructure ( SAP NetWeaver XI ). In this case, Enterprise

Services communication occurs using the Integration Broker of the SAP NetWeaver

Exchange Infrastructure , which contains additional functions for the processing and creation of messages. In the Enterprise Services Repository in SAP NetWeaver XI you can find descriptions of the interfaces of all the services that SAP has developed for communication with SAP applications. You can also define your own Enterprise

Services using the SAP NetWeaver Exchange Infrastructure .

Features

Enterprise Services are standardized interfaces for specific functions within an application, for example, for functions that read the business partner's address or that update reports. They simultaneously display descriptions of process steps and technical modules. In this way, and due to their very specific syntax and strictly defined naming convention, the Enterprise Services represent a shared language for communication between different business areas (for example, marketing and IT).

You can use the Enterprise Services from SAP to create user interfaces independently of the underlying individual applications in the back-end system. These interfaces can be exactly adjusted to the workflows and work organization of your company.

You can therefore provide user interfaces that are tailored exactly to the tasks and knowledge of the employees in your company. You use the same services and process the same data regardless of whether you create user interfaces for experts or for occasional users. The Enterprise Service works in the background on the technical details and data entry and processing is considerably simplified.

With the help of the Enterprise Services from SAP, you can trigger automated processes, enter and process data, and exchange data with other systems and applications. In contrast to simple Web services, Enterprise Services from SAP are generally logical steps of a business process and can thus be used to support crossapplication and cross-departmental business processes.

You can implement Enterprise Services from SAP to automate flows for which you previously could not use any standard SAP solution or for which there previously was no integration possible. SAP does not only develop Enterprise Services with the aim of


SAP Documentation Enterprise SOA providing individual interfaces for communication between individual application functions.

Enterprise Services from SAP also aim to enable central business processes using several SAP Business Suit e applications. For this purpose, Enterprise

Services are bundled into Enterprise Services Bundles (ES Bundles). The ES Bundles represent templates for the processing of Enterprise Services for the illustration of business processes such as Order to Cash. You can find descriptions of the Enterprise

Services Bundles in the Enterprise Services Workplace (ES Workplace) by choosing sdn.sap.com

Enterprise SOA ES Workplace ES Bundles Wiki.

The Enterprise Services are used to split the complex functions of a business process into reusable elements. These elements – the individual Enterprise Services – can then be reused, exchanged, combined into new combinations, or incorporated into completely different business processes according to your own needs.

Let us assume that you use the Enterprise Services to provide both an application with which your employees can submit their expenses and a number of additional services for the distribution of expenses. At the moment, the data is probably sent to particular administrators in the relative departments. However, you already anticipate that a central administration center will take over the processing in the near future. An automatic system for processing expenses or outsourcing to a foreign company is probably under discussion.

If you use Enterprise Services you need only perform such changes in a few critical places. In addition, nothing will change on the employee's user interface, regardless of how you construct the distribution in the background. The function for sending expenses remains unchanged for employees and they are thus not required to understand the various flows in the background.

mySAP Business Suite: Service Processing

With the product enterprise services packages for the mySAP Business Suite 2005, SAP is moving the mySAP Business Suite 2005 toward Enterprise Service-Oriented Architecture

(SOA). Introducing Enterprise SOA into the mySAP Business Suite 2005 naturally has implications for its software architecture. This document describes the implications and the concepts used to meet the challenges that arise.

Introduction to Enterprise Service-Oriented

Architecture

The introduction of Enterprise Service-Oriented Architecture (SOA) essentially constitutes a new, more standardized way of accessing mySAP Business Suite functionality from other applications, alongside conventional access mechanisms like Business Application

Programming Interfaces (BAPIs), Remote Function Calls (RFCs) and the SAP Exchange

Infrastructure (SAP XI). Another application in this context may be an independent third-party application, a composite application or another SAP application like another mySAP Business

Suite instance.

Introduction of Enterprise SOA into the mySAP Business Suite



Other Application

R R R R

BAPI

Interface

R

RFC

Interface

R

XI

R

Service

Interface

R mySAP Business Suite Backend mySAP Business Suite

Implementation Considerations

Enterprise SOA sets requirements for functionality access both on a technical and semantic level. To meet the requirements, which are detailed in the following sections, SAP has built a service interface layer on top of the mySAP Business Suite as shown in the figure above.

When discussing the SOA-enabling of the mySAP Business Suite, three different dimensions need to be distinguished and addressed:

Runtime: the running system including all mechanisms in use to process a request via the service interface layer

See mySAP Service Provisioning: Runtime

Design time: procedures and methods applied by SAP during application design and development to create the software in the first place

See mySAP Service Provisioning: Design Time

Configuration: all concepts concerning activation and publication of functionality provided by the service interface layer



See mySAP Service Provisioning: Configuration

Note

It is expected that the reader is familiar with the structure and the basic architecture concepts of the mySAP Business Suite. For detailed information on the mySAP Business Suitesee the

SAP help portal (help.sap.com

mySAP Business Suite ) or the SAP Developer Network

(SDN) (sdn.sap.com

).

End of the note.

Features

The remainder of this section defines the relevant terms and introduces the concept of enterprise SOA:

Service

Web Service

Enterprise Service

Service-Oriented Architecture

SAP's Enterprise SOA

Example

The section Example: Service Operation ‘Create Employee Leave Request’ provides a walkthrough of service provision.

Composite Application

A composite application is an application that is built upon the mySAP Business Suite and uses and extends the functionality of the mySAP Business Suite. Composite applications are developed by both SAP and external companies.

Service

A service is a well-defined piece of functionality which can be invoked via a stable and implementation-independent interface.

The entity that offers a service to other entities is called service provider . An entity that makes use of a service by triggering its execution and – if appropriate – receiving its result, is called service consumer .

Synchronous/Asynchronous Communication

Services may be invoked either synchronously or asynchronously . In the synchronous case, the service consumer waits for the result after triggering the service provider, and is blocked until the result has arrived. In the asynchronous case, the service consumer continues its work after triggering the service provider, and may go back to the original task, as soon as the


SAP Documentation Enterprise SOA answer arrives. For the asynchronous case, an additional agent for receiving the response and a well-defined interface for the return of the response are required.

Synchronous Versus Asynchronous Service Call

Consumer Provider Consumer

Synchronous Request:

Synchronous Response:

Asynchronous

Receiver

Asynchronous

Request:

Provider

Asynchronous

Response: response is retrieved in some way

Statefulness/Stateless

Services may be stateful or stateless . Statefulness means that context information is stored on the provider side between successive service calls. State may be established on different levels as shown in the figure below.

On communication level , by means of a stateful protocol.

On service level , by combining successive service calls from the same consumer to a session (for example by exchanging session IDs).

On application level , by using application-specific mechanisms.

A stateless service, as defined by SAP, is a service that is stateless on the service level.

However, it may establish state on the communication level or application level.

Levels of Statefulness

Consumer

Application

Client

R

Virtual

Channels

Appl. Request/Response

R

Provider

Application

Service

R

Application State Application Level

SOAP Client

R

SOAP Messages

R

SOAP Server

R

Session Service Level

Transport Agent

(Client)

Transport Protocol

(e.g. HTTP)

R

Transport Agent

(Server)

Transport State

Communication

Level

Communication Medium

Web Service



A Web service is a special service which can be triggered via a network and conforms to the following Web standards:

Web Service Definition Language (WSDL) is a standardized XML format for describing a service. In WSDL, the term service refers to a concrete instance of a service, provided by a service provider at a specified network endpoint. A service description in WSDL therefore comprises a service interface description and a concrete binding.

The service interface is the abstract technology-independent description of the service. In WSDL, a service may comprise several service operations which can be invoked separately. For each operation WSDL describes the parameters needed to invoke the service and the result that will be returned.

The binding determines the technical parameters, such as the network endpoint that acts as the service provider, the protocol used to communicate with the service provider and the format in which messages are exchanged.

Universal Description, Discovery and Integration (UDDI) is the name of a directory service which can be used to publish the WSDL descriptions of the service instances that a service provider wants to make available to other applications.

SOAP is a standardized, message-based protocol that is used by Web services for communication between the service consumer and the service provider. A SOAP message comprises a header part, which contains communication control parameters, and a body part, which contains the payload

The requirement of adherence to these three standards makes a Web service a standardized form of an Internet-based service.

Service-Oriented Architecture

Service-Oriented Architecture (SOA) is the term for software architecture that is based on the concept of services.

Structure

In SOA there are one or more service providers on one side, and one or more service consumers on the other side.

The service providers offer certain functionality as services and publish their interfaces which are designed to be stable.

Service consumers and service providers are only loosely coupled. The interplay of consumer and provider is based on the service interface definition as a kind of contract. The concrete implementation of a service is hidden from the consumer.

The services should be defined in such a way that they can be found and used easily in various applications. Consumers usually make use of several services, which may come from multiple service providers to create new functionality.

Benefits

Following the principles of SOA when building an application provides several advantages:

Flexibility



Since service interfaces according to SOA are stable, and service implementations are transparent for the consumers, SOA provides the prerequisites for applications in which higher-level functionality realized by the service consumer can be modified without having to change the underlying service functionality.

Productivity

If the services are well defined, it is very efficient to build and advance SOA-based applications once a pool of services is available.

Adaptability

SOA facilitates the integration of different applications, thanks to the use of open and non-proprietary standards. This helps customers to integrate applications from different application vendors into their IT landscape.

Enterprise Service

An enterprise service is a service which provides business functionality and which is published by SAP in the enterprise services workplace in the SAP Developer Network (SDN)

(at sdn.sap.com

Enterprise SOA ES Workplace ). In general, enterprise services have the following features:

Business semantics: Enterprise services are structured according to a harmonized enterprise model based on process components, business objects and global data types (GDTs). They are defined using an outside-in approach: common business rules and know-how, rather than SAP-specific implementations, are the guideline for defining the business content of SAP applications.

Quality and stability: Enterprise services ensure a stable interface for future versions

(backward compatibility). Their behavior, prerequisites, dependencies of usage and configuration possibilities are well documented.

Standards: Enterprise services are based on open standards. The interfaces are described according to WSDL. They are created out of global data types which are based on UN/CEFACT CCTS (Core Component Technical Specification).

There are different application areas for enterprise services, for example application-toapplication ( A2A ) and business-to-business ( B2B ) integration or user interfaces.

Integration

Enterprise Services for the mySAP Business Suite 2005

A first wave of enterprise services for the mySAP Business Suite was released in the product enterprise services packages for the mySAP Business Suite.

While enterprise services can have different technical characteristics, most of the enterprise services in the enterprise services packages are optimized for a usage in which SAP makes no assumptions about the service consumer. As a consequence, these enterprise services are as simple and easy to use as possible, which results in the following characteristics:

Atomic transaction: The execution of a service must always result in consistent business data. It shall not be necessary to execute any further services subsequently to achieve a consistent state on the database.

Statelessness: No context information is stored on the service level between service calls. In addition, enterprise services for the mySAP Business Suite do not store


SAP Documentation Enterprise SOA transient context information on the application level either. Hence, one service call only influences subsequent service calls by means of the persistent data in the database.

Furthermore, these enterprise services for the mySAP Business Suite are defined as synchronous services. This means, in particular, that they can be used without the SAP

Exchange Infrastructure (SAP XI).

These enterprise services can be combined to form new business processes (service orchestration). User interfaces as well as composite applications can be built upon them.

SAP's Enterprise Service-Oriented Architecture

(SOA)

SAP has been able to move the mySAP Business Suite toward enterprise SOA firstly by realizing the technical prerequisites for Web services and secondly, by introducing enterprise services.

1.

Generated Web Services

By means of SAP Web Application Server (SAP Web AS), SAP has supported the concept of Web services since SAP Web AS 6.40.

SAP Web AS is the basis for all SAP applications. It comprises a framework for processing ABAP and Java programs and basic functionality for communications, transaction handling, database access, and other functions. The conventional way of calling SAP Web AS from other applications is via Business Application Programming

Interfaces (BAPIs) or Remote Function Calls (RFCs). Both are proprietary SAP methods for inter-application communication.

In SAP Web AS 6.40, SAP Web AS can act as a Web service provider, and there is a way of generating Web services based on any BAPI or RFC function.

These generated Web services conform to the technical requirements of a Web service. However, their semantics are still those of the underlying BAPIs or RFCs.

Hence, from a semantic point of view, they are not optimized for SOA.

2.

Enterprise Services

In order to take the step towards SOA on a semantic level as well, SAP introduced the notion of enterprise services. SOA based on enterprise services together with the required infrastructure is called enterprise SOA.

Prerequisites

To transform the mySAP Business Suite into an enterprise SOA solution, two main objectives have to be accomplished.

1. A technical framework has to be set up to allow service publication and the processing of service calls.

To allow for as much reuse as possible and to avoid re-implementation of the business functionality of the mySAP Business Suite, the technical framework has been realized by means of a service interface layer on top of the mySAP Business

Suite, as shown in the figure below.

2. The functionality of the mySAP Business Suite has to be optimized for use in a service-oriented application



The second task is to provide the business content of the mySAP Business Suite in a form that meets the principles of enterprise SOA. Here, SAP follows an outside-in, model-based approach. All services, and the business objects that these services operate on, are modeled according to current business practice.

mySAP Service Provisioning: Runtime

This section describes the concepts required to understand the execution of a Web service offered by the mySAP Business Suite.

The Runtime Architecture Overview describes the components of SAP Web AS that are involved in the execution of a Web service. It focuses only on the point-to-point scenario of executing Web services. In this scenario, a Web service offered by a provider is directly called by a consumer.

The following specific concepts related to the invocation of synchronous Web services are also described: o mySAP as Service Provider and Service Consumer o Data Conversion and Custom Modifications o Data Access o Exceptions and Errors o Security

Some of these concepts are not necessary to understand the services contained in the enterprise services packages, but they provide a complete picture of what service provisioning means at SAP.

Web Service Invocation via XI Message Broker : An alternative to the point-to-point scenario is to use the SAP Exchange Infrastructure (XI) integration server as a message broker between the consumer and the provider. XI is not required for executing the synchronous Web services offered in the enterprise services packages, but only for asynchronous services. This scenario is therefore described separately.

Runtime Architecture Overview

The mySAP Business Suite is a family of applications running on SAP Web AS. In order to call the Web services offered by the mySAP Business Suite, another application acting as service consumer sends SOAP requests to SAP Web Application Server, which acts as a service provider. The following figure shows an overview of such a system.

Web Service-Enabled mySAP Business Suite



Other Application (Consumer)

R

SOAP (over HTTP)

HTTP Communication Layer

Web Service Enabling Layer mySAP Application

Applications on SAP Web Application Server

Database

The applications which form the mySAP Business Suite can be distributed across different instances of SAP Web AS. This fact is omitted in the described architecture, as this bluebook does not focus on the implementation of SAP Web AS. It only describes components as necessary, to explain the execution of a Web service.



Structure

In order to allow the execution of Web services, two layers of functionality in SAP Web AS are required as shown above:

The HTTP Communication Layer

The Web Service Enabling Layer

Process

The majority of Web services provided by the enterprise services packages are invoked synchronously.

For more information on this process, see Invocation and Execution of Synchronous Web

Services .

Note

The enterprise services packages for the mySAP Business Suite on SAP NetWeaver 2004s focus on providing synchronous Web services. However, Web services provided or called by an mySAP application need not be invoked synchronously. The underlying technical infrastructure of SAP Web AS also supports asynchronous service invocations. However, in order to use them reasonably, a networking infrastructure providing reliable messaging is required (see Web Service Invocation via XI Message Broker ).

End of the note.

HTTP Communication Layer

The HTTP communication layer is one of two layers of functionality in SAP Web AS required for the execution of Web services.

The HTTP communication layer of the SAP Web AS handles all HTTP-based communication, which includes Web service communication. SAP Web AS can, for example, also act as a regular Web server, providing HTML Web pages. This layer is necessary for Web service invocations, because currently at SAP, all SOAP messages are sent via HTTP.

The main task of the layer is to accept incoming HTTP requests and dispatch them to the appropriate receiver within SAP Web AS. Dispatching is performed in two consecutive steps by the Internet Communication Manager and the Internet Communication Framework.





R

SOAP (over HTTP)

Registered

Receivers

Internet Communication Manager

HTTP Message

(containing SOAP Message)

Registered

Receivers

Internet Communication Framework

HTTP Message


Web Service Enabling Layer

Java

Stack

HTTP

Communication

Layer mySAP Application

ABAP Stack


Note

According to the W3C recommendation, SOAP does not necessarily need to be based on

HTTP, but can use other transport protocols, such as SMTP. However, as transport protocols other than HTTP are rarely used, SAP Web AS only supports SOAP communication via

HTTP or HTTPS.

End of the note.

Web Service Enabling Layer

The Web Service Enabling Layer is one of two layers of functionality in SAP Web AS required for the execution of Web services.



The Web Service Enabling Layer receives HTTP-based SOAP messages from the HTTP

Communication Layer. It interprets the SOAP messages and extracts the parameters for calling a Web service. The layer also contains the Web service proxies (as seen in the figure below), which are the implementation components that implement the Web service interface by forwarding calls to existing mySAP applications. In addition they can provide new functionality.



R

SOAP (over HTTP)


HTTP Message


XI Local

Integration Engine

R

Web Service Interpreter

(Web Service Runtime)

Web Service Data

(XML)

Proxy Framework

Web Service Data

(ABAP)

Web Service Proxy

Local Calls mySAP Application

ABAP Stack


Web Service

Enabling

Layer



In addition to the Web service interpreter for interpreting point-to-point Web service calls, the figure above also depicts the XI Local Integration Engine . It is the counterpart of the Web service interpreter if Web services are executed via the XI infrastructure (see Web Service

Invocation via XI Message Broker ). However, it is also used in the point-to-point scenario, as it provides some functionality, such as logging, that is used by the Web service interpreter.

The Web Service Enabling Layer fulfills two tasks:

Interpreting the SOAP messages and mapping the contained Web service data to a format that can be processed by existing applications on the SAP Web AS.

Providing the Web services, meaning that this layer contains the implementations of the Web service interfaces. Such an implementation builds on existing functionality provided by mySAP applications.

Invocation and Execution of Synchronous Web

Services

The majority of Web services provided by the enterprise services packages are invoked synchronously.

The following figure shows the execution of a synchronous web service. For the sake of clarity, the Web service consumer and the components of the HTTP Communication Layer are omitted.

Invocation and Execution of Synchronous Web Services

HTTP C ommunication

Layer


R eceive Web service request

1

2

D ispatch Web ser vice request to Web Service

Runtime



Proxy Framework We b Service Proxy

3

Interpret SOAP control information mySAP Application

Extract Web service data from request

(XML)

4

Map XML to ABAP data structures

Read request data

5

Execute

Web service

Write response data

Execute business functionality

6 Map ABAP data structures to XML

7

Assemble SOAP message

8

Send Web service response



Process

The execution of such a service takes eight steps. Steps one to five deal with dispatching the incoming message, mapping the contained data, and triggering the appropriate Web service proxy. The remaining steps are required to return the Web service result to the service consumer.

Dispatching a request (steps 1–3)

Processing a request (steps 4–5)

Sending a response (steps 6–8)

The steps described are processed in every invocation of a Web service offered by the enterprise services packages.

Dispatching a Request

1. The Internet Communication Manager (ICM) decides whether to forward an incoming request to the ABAP stack or the Java stack. All services contained in the enterprise services packages are implemented in ABAP, which is why a request for the execution of such an enterprise service is forwarded to the ABAP stack

2. The Internet Communication Framework (ICF) receives all HTTP requests which are sent to the ABAP stack and forwards the request to the appropriate application.

SOAP requests for the execution of Web services are forwarded to the Web Service

Enabling Layer.

The decisions made in both steps are based on the URL which is in the request.

Each receiver is registered for a specific URL, or for a part of a URL, to specify the type of requests that it can accept.

To determine whether the ABAP stack or the Java stack is addressed, the Internet

Communication Manager analyzes the first part of the URL, which identifies the virtual host, for example https://www.myCompany.com:1234/WebServices/myService . The Internet

Communication Framework analyzes the rest of the URL, for example https://www.myCompany.com:1234/WebServices/myService , to determine the application that is to receive the request.

The HTTP Communication Layer does not modify the HTTP messages it forwards.

Processing a Request

All incoming Web service requests are processed by the components of the Web Service

Enabling Layer in three sequential steps.

1. The Web service interpreter reads the SOAP message provided by the HTTP

Communication Layer. It reads the information in the SOAP header and extracts the

Web service data from the body of the message. The SOAP header is used to extend the standard SOAP protocol with information required for additional protocol services, such as reliable messaging. The Web service interpreter component, which is called

Web service runtime in SAP Web AS, must interpret this information in order to provide the additional services.



2. The extracted XML Web service data is forwarded to the proxy framework. The proxy framework maps the data from XML to ABAP data structures and invokes the appropriate Web service proxy.

3. The Web service proxy provides functionality of the Web service by placing local calls to function modules, BAPIs and RFCs of mySAP applications. As a Web service proxy is a standard ABAP class, it can also contain further coding that adds to existing mySAP functionality.

Note

Web service proxies can be used for both point-to-point and XI-based invocation of

Web services.

The Web service proxy described above is only one of the proxy types available in

SAP Web AS and is the proxy for synchronous Web services in the inbound scenarios. For more information on all the proxy types available see Proxy Type .

End of the note.

Sending a Response

The steps required to send a response are as follows:

1. When the processing of the Web service proxy is finished, the proxy triggers the proxy framework to map the response data from ABAP data structures to XML.

2. The SOAP message containing the Web service response is assembled by the Web service interpreter, meaning that it adds SOAP control information to the header of the message and Web service data to the body of the message.

3. The HTTP Communication Layer sends the response to the specified receiver as an

HTTP message.

mySAP as Service Provider and Service Consumer

Web service-based communication in which the mySAP application acts as a service provider, is referred to as an inbound scenario . Communication in which the mySAP application acts as the service consumer is referred to as an outbound scenario .

The communication patterns that can be used in these scenarios are described in the section

Communication Pattern .

The Web service proxy described in the previous sections is only one of the proxy types available in SAP Web AS and is the proxy for synchronous Web services in the inbound scenarios. All the proxy types that are available are described in the section Proxy Type .

Communication Pattern

A communication pattern defines the choreography of a single interaction between the communication partners and defines which messages types are exchanged as request and


SAP Documentation Enterprise SOA response. Four patterns for communication between a mySAP application and another application have been implemented, as can be seen in the following figure.

Communication Patterns

Request/Confirmation

Other

Application

Request Confirmation mySAP

Application

Query/Response

Query

Other

Application mySAP

Application

Response

Database Database

Notification

Other

Application

Notification mySAP

Application

Other

Application

Information

Other

Application mySAP Application

Other

Application publish

The patterns can be categorized into patterns for transactional processing of data and patterns for data retrieval or information syndication. Patterns of the first category are used to change data of mySAP applications, while patterns of the second category are only used for retrieving data or information.

Transactional Data Processing

Request/Confirmation : The basic pattern for transactional processing is called request/confirmation. It assumes that a Web service request is sent from another application to a mySAP application. The confirmation of the execution of the Web service is returned either immediately (synchronously) or later (asynchronously).

Notification : A second pattern for transactional processing is called notification. Here, the other application sends a notification message to the mySAP application. This message leads to data changes. In contrast to the request/confirmation pattern, no response is sent.

Data Retrieval and Information Syndication

Query/Response : The basic data provisioning pattern is called query/response.

Another application requests some data from a mySAP application in a read-only form, specified by a query. Query/response communication can be either synchronous or asynchronous.



Information : A second data provisioning pattern is the information pattern, which informs other registered applications of data changes in a mySAP application. The difference to the notification pattern is that the information message is typically sent to a list of subscribed receivers, and the receivers do not take immediate action upon the information received. No response to the information message is expected.

All communication patterns can be used in the outbound scenario as well. Communication patterns are realized by invoking Web services. Therefore, an application which is a consumer (or provider respectively) in a communication pattern need not always be a consumer on the level of Web service invocations but may also provide Web services that are required for the communication pattern (see figure).

The example in the above figure shows the asynchronous realization of a query/response communication pattern. On communication pattern level, a consumer sends a query to a provider and receives a response. On the Web service invocation level both communication partner consume and provide Web service.

To distinguish between the two levels, in this document inbound (or outbound) scenario refers to the communication pattern level and inbound (or outbound) call refers to the Web service invocation level . An inbound (or outbound) scenario may comprise inbound and outbound calls.

Proxy Type

A Web service proxy, or proxy, is the implementation of a Web service interface in the Web

Service Enabling Layer. Different types of proxies are used to implement the communication patterns, introduced in the previous section, in the inbound and outbound scenarios.

The first figure illustrates the proxy types used in the inbound scenario. The second figure shows a slightly modified version of the lower part of the first. It depicts the proxies used in the outbound scenario.

Proxy Types Used in the Inbound Scenario

Other Application

Inbound Calls Outbound Calls

SOAP (over HTTP)


HTTP Message


Web Service Interpreter (Web Service Runtime)

Web Service Data

(XML)

Proxy Framework

Meta Data

Web Service

Data (ABAP)

Web Service

Data (ABAP)

Web Service

Data (ABAP)

Asynchronous

Consumer Proxy

R

Confirmation,

Response,

Notification,

Information

Asynchronous

Provider Proxy

R

Request, Query,

Notification,

Information

Synchronous

Consumer Proxy

R mySAP Application

ABAP Stack


R

Web Service

Data (ABAP)

R R

Synchronous

Provider Proxy

R

Request,

Confirmation,

Query,

Response

RFC/BAPI Proxy

R

Local Calls


SAP Documentation

Proxy Types Used in the Outbound Scenario

Asynchronous

Consumer Proxy

R

Request, Query,

Notification,

Information

Asynchronous

Provider Proxy

R

Confirmation,

Response,

Notification,

Information

Synchronous

Consumer Proxy

R

Request,

Confirmation,

Query,

Response

Synchronous

Provider Proxy

R mySAP Application

Enterprise SOA

RFC/BAPI Proxy

R

Local Calls

Note

The names of the proxy types used in this document are the names used in SAP NetWeaver

NewYork. In SAP NetWeaver 2004s the proxy types are called client (consumer) and server

(provider) proxy.

End of the note.

Proxy Type Proxy

Asynchronous

Proxies

These proxy types send or receive asynchronous Web service calls.

Asynchronous Consumer Proxy: This proxy type sends asynchronous Web service calls to a provider.

Asynchronous Provider Proxy: This proxy type receives asynchronous Web service calls. The Web services provided by the proxy are based on the functionality of existing applications within

SAP Web AS.

Synchronous

Proxies

These proxy types send and receive synchronous Web service calls.

Synchronous Consumer Proxy: This type of proxy sends synchronous Web service calls to a provider and waits for the response.

Synchronous Provider Proxy: This type of proxy receives synchronous Web service calls and sends a response to the consumer once processing has finished.

2 RFC/BAPI

Proxies

This proxy type wraps an existing RFC/BAPI or function group as Web service. Therefore, an RFC/BAPI proxy also is a synchronous provider proxy.

However, this proxy is depicted separately in Figure 2–7 Proxy Types used in the Inbound Scenario

Note

RFC/BAPI proxies are generated automatically without any further need of implementation effort. This is why they are not visible in the development environment. However, it is necessary to define a virtual interface for these proxies. This allows to hide specific parameters of an RFC/BAPI call in a

Web service. It is, for example, possible to set default values for parameters which should not be available in the Web service.

End of the note.



In the two figures above, the messages types (see Communication Pattern ) that can be sent or received by each proxy type are shown next to the channels connecting the proxies and the mySAP applications. The usage of the proxies in the communication patterns are shown in the two figures below. All patterns, except the notification and information patterns, are depicted in the inbound scenario. If used in the opposite direction, the consumer/provider proxies have to be replaced with their counterparts.

The first figure below shows the communication patterns available in the synchronous scenario, while the second shows the communication patterns available in the asynchronous scenario.

Usage of Proxy Types in Synchronous Scenarios

Synchronous

Other Application

Synchronous

Provider Proxy mySAP

Application wait

Request/Confirmation or

Query/Response

Use of Proxy Types in Asynchronous Scenarios

Asynchronous

Other Application

Asynchronous

Receiver

Asynchronous

Provider Proxy

Asynchronous

Consumer Proxy

Request/Confirmation or

Query/Response mySAP

Application

Notification or

Information



Data Conversion and Customer Modifications

The data contained in a Web service call is represented by XML data types. To allow ABAP applications to process the data, it has to be mapped to ABAP data types. The ABAP data of a Web service call is depicted by the Web service data storages in the following figure.

Proxy Types Used in the Inbound Scenario

Other Application

Inbound Calls Outbound Calls

SOAP (over HTTP)


HTTP Message


Web Service Interpreter (Web Service Runtime)

Web Service Data

(XML)

Proxy Framework

Meta Data

Web Service

Data (ABAP)

Web Service

Data (ABAP)

Web Service

Data (ABAP) R

Web Service

Data (ABAP)

R R

Asynchronous

Consumer Proxy

R

Confirmation,

Response,

Notification,

Information

Asynchronous

Provider Proxy

R

Request, Query,

Notification,

Information

Synchronous

Consumer Proxy

R

Synchronous

Provider Proxy

R

Request,

Confirmation,

Query,

Response

RFC/BAPI Proxy

R


ABAP Stack


Depending on the type of proxy, these storages contain either a request or a response only, or both requests and responses. The ABAP data structures implementing these Web service data storages are provided by the proxies. The proxy framework knows how to map the XML data types to an ABAP representation and vice versa.

Proxy Meta Data : The information required to do the mapping is contained in the proxy meta data.

Application Level Mapping of Data Types : The technical mapping between XML and

ABAP performed in the proxy framework is not sufficient. A conversion of data types on the application level is required for specific data types.



Proxy Meta Data

The data contained in a Web service call is represented by XML data types. To allow ABAP applications to process the data, it has to be mapped to ABAP data types. The information required to do the mapping is contained in the proxy meta data.

The proxy framework creates mapping programs, called Simple Transformations , based on the given mapping information specified for the data types. For incoming messages, a mapping program uses the XML parameters as input and fills the ABAP data structure. For outgoing messages, a different mapping program with ABAP as input and XML as output is executed. The information contained in the proxy meta data is derived from the abstract service definitions during design time (see mySAP Service Provisioning: Design Time .

Application Level Mapping of Data Types

The technical mapping between XML and ABAP performed in the proxy framework is not sufficient. A conversion of data types on the application level is required for specific data types, too. Examples of such data types are codes, units, and time-related data types. In a

Web service call, such data types are typically specified in a standardized format, such as

ISO codes. However, mySAP applications have a different format. Therefore, the Web service proxy has to convert the data types into the correct format before it can begin to execute the application logic.

Process

Data Conversion

Proxy Framework Web Service Proxy

Map XML to ABAP data structures

Execute Default

Import Conversion

Call BAdI Inbound

Processing

Execute Application

Logic

Execute Default

Export Conversion

Call BAdI Outbound

Processing

Map ABAP data structures to XML



Business Add-In (BadI)

As the data conversion on the application level also affects data types that can be extended by customers, such as code lists, a Business Add-In (BAdI) is provided for adding custom import and export data conversion (see figure).

In addition to data conversion alone, the methods for inbound and outbound processing provided by the BAdI, can be used by customers to modify the behavior of a Web service.

Example

Per default, a Web service that retrieves information about all goods that can be ordered from a supplier by a retailer does not filter the returned information. However, business cases exist, in which the returned information must be filtered according to certain criteria. If, for example, the retailer is a store, only information about those goods should be retrieved that are part of the retailer’s assortment of goods.

End of the example.

The BAdI for the import and export processing in Web service calls uses a sorter concept for the registered BAdIs implementations. Each implementation is categorized as SAP, partner or customer implementation. The implementations are executed in this order.

The BAdI methods can access and modify all parameters of a Web service, even parameters that have been added through custom extensions.

Note

The data structures implementing the Web service data (ABAP) storages in the figure Proxy

Types used in the Inbound Scenario (see Proxy Type ) are called Data Type Proxies in the development environment

End of the note.

Data Access

Consistency and correctness of the data in the database have to be ensured for all services in the mySAP Business Suite.

Services for the enterprise services packages for the mySAP Business Suite 2005 are stateless services. On the service level, no context information is stored on the provider side between service calls. This means that each service call is an atomic transaction. The execution of a single mySAP Business Suite service always transfers the database from one consistent state to another. It is not allowed for a service to finish with an inconsistent database state, requiring that further service calls will fix it. Therefore, it is not possible to have transactions on the database level that span several service calls.

The following consequences have to be considered:

Snapshot data : Data retrieval and subsequent data modification cannot be combined in one transaction. Hence, data captured by stateless services is not real-time data.

Since data is only locked as long as service processing takes place, the service consumer retrieves data as a snapshot taken at a certain point in time. For more information see Concurrency Control .

Reliable messaging : Since the standard SOAP protocol does not provide a means for reliable messaging, protection against loss and multiple execution of web service requests has to be provided. For more information see Reliable Messaging .



Commit : The work has to be committed to the database at the end of each service execution that involves data modification. For more information see Commit

Procedures .

Concurrency Control

Each service in the enterprise services packages constitutes an atomic transaction. That is, a single service call always transfers the global data in the database from one consistent state to another.

However, though the database state is always consistent, it may still become semantically incorrect if multiple service consumers are interacting concurrently on a pair of services for retrieving or modifying a piece of data respectively.

Example

Overwrite Strategy Leading to Incorrect Database Content

Consumer A Consumer B Provider Stock count in database

500

Actual stock count

500

Read stock count:

Stock count = 500:

Calculate stock count: 500 + 200 =

700:

Read stock count:

Stock count = 500:

Calculate stock count:

500 + 100 = 600

+ 200

700

+ 100

800

Write stock count = 700:

Accepted:

700

Write stock count = 600:

Accepted:

600

600 != 800

Two consumer applications A and B are about to independently post the receipt of a delivery of screws. After querying the current quantity of screws in the warehouse, they calculate the new quantity of screws based on the current quantity and the delivery size. Subsequently they write the result in the sequence A-B.

If no precautions are taken, the new value in the database will be the amount calculated by application B, as B was the last one to write the value. Though there is no consistency problem, the value in the database is still not the right value from a business point of view.

End of the example.

To avoid such problems due to the interleaved execution of corresponding data retrieval and data modification Web services, it is necessary to implement adequate prevention strategies .



Basically, there are three different conciliation strategies which may be appropriate depending on the business semantics of the set of data in question. These are:

Overwrite

Delta Update

Optimistic Locking

Overwrite

For the overwrite strategy, also called last-one-wins strategy, each database modification attempt is accepted and the data provided simply overwrites the old data in the database.

In the example in the previous section Concurrency Control , this strategy is applied and leads to incorrect data. However, there are business cases for which this strategy is appropriate. An example is the recording of the stock count as determined during a physical inventory. It is desirable that the result of the last physical inventory, which is the most recent stock count, is always stored in the database

Services for which the last-one-wins strategy is appropriate are called change services. The term “change” indicates that the service overwrites the old data with new up-to-date data, ignoring the old data.

Delta Update

For the delta update strategy, also called everybody-wins strategy, each database modification attempt is accepted as well, but in contrast to the overwrite strategy, the data provided by different consumers is accumulated in the database.

For instance, in the example in the previous section Concurrency Control , the applications could provide the changes to stock quantity instead of the new total stock count. All provided changes can then simply be added to the current stock count in the database with the database always containing the correct stock count.

The feasibility and implementation constraints of delta updates depend on the concrete business semantics of the service.

Optimistic Locking

For the optimistic locking strategy, also called first-one-wins strategy, only the first one of a sequence of consecutive database update attempts is successful, so the data provided in the first attempt will persist in the database, whereas further attempts fail. According to this strategy, the second database update attempt fails, and the second application is forced to query the current stock amount again and recalculate the new total stock amount.

Optimistic Locking Strategy


SAP Documentation

Consumer A

Return data (A):

Process data

(result B):

Accepted:

Consumer B Provider

Enterprise SOA

Database content

A

Read data:

Read data:

Return data (A):

Process data

(result C):

Write updated data (B):

Rejected:

Write updated data (C):

B

Update Services

The term optimistic locking refers to the fact that, in the first place, no locking actually takes place at all, assuming that in most cases no conflicts occur. Instead, for each modification attempt there is a check as to whether a conflict has occurred, and the modification attempt is rejected if need be.

Services for which the first-one-wins strategy is appropriate are called update services. The term “update” indicates that the service provides renewed data, the determination of which has been based upon the data read from the database before.

As explained above, the optimistic locking strategy is to ensure that, of all the service consumers which have read a certain database state, only the first one can commit its updated data. The same strategy can be expressed the other way round as well: Whenever a service consumer wants to store some updated data, it has to be ensured that the data it has read before is still the current data in the database. Otherwise it may have based its data processing on obsolete data.

Change State Identifier

To realize this, the service consumer must be able to indicate which data it has read originally. Therefore, an identifier is assigned to all pieces of data that are to be read, which uniquely identifies the state of the data. This identifier is called change state identifier (CSI).

The change state identifier must be guaranteed to change with each database update.

As illustrated in the figure below, the consumer always receives the change state identifier together with the requested data. In a subsequent update request, the consumer can use the identifier to specify the state of the data which the update request refers to. If the specified state is no longer the current state, the update request is denied. In this case, the consumer has to read the new state and repeat the update request.


SAP Documentation

Change State Identifier

Enterprise SOA

Consumer

Read data

+ CSI

R

Provider

Updated data

R

+ CSI

CSI Set of Data

Database

The sole requirement for a change state identifier is that it must change with each database update. For the enterprise services for the mySAP Business Suite, an existing database field will be used if an appropriate one is available (such as a change document number or the time stamp of the last document modification). Otherwise, a hash value generated from the current data is used as the change state identifier. As a hash value can be generated from the current data whenever needed, it does not need to be stored in the database. This is an advantage compared to other possible implementations such as an update counter or an update time stamp.

The consumer is not allowed to interpret the change state identifier. For the consumer, it is a token in the form of an arbitrary character string without semantics, because this allows for the underlying implementation to be changed later on.

Reliable Messaging



While SAP XI ensures reliable messaging for broker-based service calls via SAP XI (see Web

Service Invocation via XI Message Broker ), the standard SOAP protocol does not include any means of reliable messaging. Hence, in the point-to-point scenario, where Web services are called directly using the SOAP protocol, there is no guarantee that each request message sent by the consumer will arrive exactly once at the provider. It may get lost or may arrive several times in case of network problems. Even if the request message arrives at the provider, the response message may get lost during network transport as well. Hence the consumer might assume that its request did not arrive and re-send it.

Protection against loss and multiple execution of web service requests must therefore be provided. Three mechanisms are available. These are:

Restartable Services

Verification Services

Idempotent Services

Restartable Services

It may be possible to implement some services in such a way that multiple invocations do not result in incorrect data in the database. For example, if a service that changes the address information of a customer is invoked several times with the same address as a parameter, this will still result in the correct address being stored in the database. Such services are called restartable services or said to have restart capability . In the case of restartable services, the consumer can repeat any request without causing the data to be incorrect.

Change services are typically restartable.

For many services, however, it is crucial that the service is executed exactly once when requested. For example, if a new purchase order is to be created via a service invocation, it is neither acceptable to have no purchase order created nor to have two or more duplicates created.

For these services, there are two mechanisms available for ensuring that a service is executed exactly once when it is requested by a consumer: Verification Services and

Idempotent Services .

Verification Services

For many services, it is crucial that the service is executed exactly once when requested. For example, if a new purchase order is to be created via a service invocation, it is neither acceptable to have no purchase order created nor to have two or more duplicates created.

One mechanism, which can be used for the services in the enterprise services packages for the mySAP Business Suite 2005, provides the consumer with a way of ensuring that a service is executed exactly once when it is requested by a consumer. The idea is to create an additional service, a verification service , accompanying the actual service.

Verification Services


SAP Documentation

Consumer

1. Issue request

R

2. Check result

R

Enterprise SOA

Pair of

Services

Actual

Service

Verification

Service

Database

Provider

The verification service is a service that does not modify the database and has such semantics that it can be used to check whether a request to the actual service has been successful or not. In many cases, verification services do not need to be implemented explicitly, because an appropriate query service exists anyway.

In the example of a purchase order creation service, a verification service would retrieve purchase orders according to unique identifying parameters, such as a creation date within a certain time period and a specific creator.

Integration

This mechanism has two disadvantages:

It may not be reasonable to create a matching verification service for every service.

It requires the consumer to cope with up to twice the amount of services it actually needs, which implies some additional configuration effort.

Another mechanism for ensuring that a service is executed exactly once when it is requested by a consumer is provided by Idempotent Services .



Idempotent Services

For many services, it is crucial that the service is executed exactly once when requested. For example, if a new purchase order is to be created via a service invocation, it is neither acceptable to have no purchase order created nor to have two or more duplicates created.

With Netweaver 2004S SPS09 / ECC SE 600 SP03, a framework is provided that ensures on the provider side that service calls are executed exactly once. Such services are called idempotent services or said to have idempotency .

The framework is used to store a message created in response to an incoming service call before the response is actually sent to the consumer. The response is identified by the request message’s ID. For each incoming request, the provider can thus determine if the exact same request has already been processed by checking if a response for the request ID has been stored, and if yes directly return the earlier created response without really reprocessing the request.

The figure below shows how a service provider implementation using the framework looks like conceptually (“Request ID” corresponds to the message ID).

The framework takes care of locking the response store, and of removing stored responses after a certain period such that the database isn’t filled up unnecessarily.

Idempotent Services


SAP Documentation

Integration

See Important Facts for Service Implementers

Enterprise SOA

Important Facts for Implementers


The framework or the “request checker” as illustrated in the section Idempotent Services is not called automatically by the web service infrastructure or the local integration engine. Each proxy implementation that has to ensure exactly-once processing must actively call the framework.

You must manually configure the time periods governing for how long messages and information about sent messages are saved. You can find a description of how to do this in

Configuring Idempotent Services .

To employ services as idempotent services, you must use the MessageHeader element and its subelement UUID in the inbound and outbound message types. The UUID values must be globally recognizable and satisfy the format that is specified, for example, in IETF RFC 4122

( http://www.ietf.org/rfc/rfc4122.txt

). If you do not use both elements when you call the services, the services do not behave in an idempotent manner.

Commit Procedures

The figure below shows all the relevant agents involved in the execution of a Web service call. As can be seen from the diagram, in addition to the mySAP Business Suite applications, two different agents have modifying access to the database: the XI Local Integration Engine and the service proxy . While the mySAP Business Suite applications need modifying access in order to write their data modifications to the database, these other two agents are responsible for committing the data modifications to the database in different scenarios.

Asynchronous Commit by XI Only

Synchronous No Commit by Framework

Commit Procedures


SAP Documentation

External Application (Consumer)

Enterprise SOA


XI Inbound

Queue

XI Outbound

Queue

XI Local Integration

Engine

Web Service

Interpreter (Web

Service Runtime)

Proxy Framework

Web Service Proxy

Applications on SAP

Web Application

Server mySAP Application

Database

Commit by XI Only

In the case of asynchronous service requests via SAP XI, the XI Local Integration Engine takes care of the transaction handling. It always opens a transaction before passing control to the proxy framework, and triggers a commit when the request processing is completed by the service proxy and control is handed back by the proxy framework.



Therefore, asynchronous service proxies must not perform a commit or call any function module which implicitly does so.

No Commit by Framework

For synchronous and point-to-point service calls, the commit is not carried out by any framework agent. Even if the service is called synchronously via SAP XI, the XI Local

Integration Engine assumes that a synchronous call has the semantics of a query-response call, meaning that there is no modifying database access. Hence it will not trigger a commit.

Therefore, in the case of synchronous services, the commit has to be implemented explicitly in the service proxy. The following figure shows the general process.

Regular Process Flow in Service Proxy Implementation

Synchronous

Provider Proxy

Framework Function

Module for Commit

Local Update

Task

Central Database

Management

System

Web Service Call

SET UPDATE

TASK

LOCAL

Process Web Service

Request:

COMMIT WORK wait update/insert/delete commit

Web Service Response

After the actual processing of the Web service request, the service proxy triggers the commit.

However, it does not trigger the commit process directly. The invocation of the commit process is encapsulated in a framework function module. This provides the flexibility to alter the transaction handling later on without having to change each service proxy implementation.

For example, it leaves room for providing general transaction handling in the proxy framework at a later stage.

At the beginning of processing, the service proxy calls the ABAP statement SET UPDATE

TASK LOCAL. This causes the commit to be carried out in the so-called local update task, synchronously within the same operating system process (called “work process” in SAP Web

AS). The advantage of a synchronous commit is that the commit is guaranteed to be completed before the response is returned. Hence, information about the success of the commit can be included in the response message and it is ensured that in a subsequent reading call up-to-date data is read. Additionally, no separate operating system process

(called “update work process”) is needed, and thus overhead is reduced.

In some cases, direct database access during the actual processing of the Web service request cannot be avoided. For example, if a new object is created, it might need a unique identifier, so that it can be put in relation to existing objects. When such a unique identifier is to be drawn from a continuously increasing number schema without gaps, it must persist in the database immediately to make sure that nobody else assigns the same unique identifier


SAP Documentation Enterprise SOA to another newly created object of the same type. This is depicted in the following figure by the direct call from the synchronous server proxy on the left to the database management system on the right.

Regular Process Flow in a Service Proxy Implementation

Synchronous

Provider Proxy

Framework Function

Module for Rollback

Local Update

Task

Central Database

Management System

Web Service Call

SET UPDATE

TASK LOCAL

Process Web Service

Request: update/insert/delete

In case of application error, ensure that any DB update is rolled back.

ROLLBACK WORK wait rollback

Web Service Response

If an error occurs during subsequent processing, all database modifications of the current

Web service execution need to be rolled back. For this purpose, the service proxy has to call a framework function module in case of errors. This function module takes care of the database rollback. Again, the rollback is encapsulated in a separate function module to allow for alteration of the transaction handling in the future.

Exceptions and Errors

During the execution of a Web service provided by mySAP applications, different types of errors can occur. Depending on the nature of the error, the other application is notified via either:

An exception

An error message

Exceptions and error messages are returned in different ways. Error messages are contained in the normal response, whereas exceptions are sent instead of the normal response.



User

R

Other Application

Request

Response

Response Data

Log

Fault Message

Error Messages Exception


XI Log

Exception

XI Local

Integration Engine

R

Store Exception

Web Service

Interpreter (Web

Service Runtime) mySAP Applications + Proxies

ABAP Stack


Exception

An exception is raised when the error cannot be solved by the user, for example code errors, or inconsistent database data. Exceptions are sent instead of the normal response, unlike errors which are contained in the normal response.



XI Log

Exceptions are not only sent to the other application in the synchronous case, but are also stored in the XI log. This is especially important for invoking Web services asynchronously, as no response is sent in this case. This log is managed by the XI Local Integration Engine (see

Web Service Invocation via XI Message Broker ). The stored exceptions can be accessed and viewed at anytime by using the XI monitoring tools.

Fault Message

In the definition of a service, it is possible to specify fault messages which are sent back instead of the normal response message. Such a fault message is used to return an exception. A standardized fault message, called StandardMessageFault, is used for all Web services provided in the enterprise services packages. Again, in the asynchronous case the fault message is not directly sent to the calling application but is stored in the XI Log for later retrieval.

Error Message

Error messages are returned for problems that can be solved by the user, such as invalid input of data, authorization error, or locking error. Errors are contained in the normal response, unlike exceptions which are sent instead of the normal response.

Log Data Type

Including error messages in the normal response message is possible due to a convention.

All return messages contain a specific data field, called log. This field is typed with a complex data type that is shown in the figure below.

Log Data Type

Log

Processing Result

Code

Maximum LogItem

Severity Code

LogItem

TypeID Note

Category Code Web Address

Severity Code



The processing result code specifies whether the Web service execution was successful, partially successful or failed. Depending on the code, the receiving other application can read and interpret the contained information and error messages. Each error message is transmitted as a single log item of the log. A log item can be assigned to an application specific type and category. The note of the log item contains the description of the error message. Any additional information about the error which is available on the Web is specified via the given Web address. Each log item is assigned to a severity level, which can be information, warning, error and abort. The highest level of all log items contained in a log is also stored in the log itself.

Security

The security of a Web service in mySAP Business Suite is accomplished in three areas: secure transportation of Web services messages authentication of Web service consumers in SAP Web AS authorization of Web service consumers within the mySAP Business Suite

Security in mySAP Web Services

User

Other Application

Internet Communication Manager

Secure Transportation of Messages

HTTPS

User Authentication

Internet Communication Framework

XI Local

Integration Engine



Proxy Framework

Web Service Proxy mySAP Application

ABAP Stack




More Information

As the subjects covered in these areas are not particular for Web services, the following sections only give an overview. For more information on security at SAP, see the SAP

Service Marketplace at service.sap.com/security .

Providing Secure Transportation

This process is used to ensure secure transportation of Web service messages.

Process

To ensure secure transportation of Web service messages, a Secure Sockets Layer (SSL) connection for HTTP messages (HTTPS) can be used. This is the recommended option for secure message transportation in SAP NetWeaver 2004s. SAP NetWeaver 2004s partially supports the OASIS Web Services Security standard (XML Signature and authentication using UsernameToken). Future releases will fully support the OASIS Web Services Security standards, including XML-Signature and XML Encryption for securing the message content and Security Assertion Markup Language (SAML) 1.1 for single sign-on.

Providing Authentication in SAP Web AS

This process is used to authenticate Web service consumers in SAP Web AS.

Process

Consumers of ABAP Web services are authorized by the Internet Communication

Framework. As the ICF only interprets HTTP and not SOAP, the information required for authentication must be contained in the HTTP part of a message.

SAP NetWeaver 2004s supports three different options for authentication of services:

Username and Password: Service request messages contain the user name and password. ICF checks whether the user may access the system and the given password is correct.

SSL and Client Certificate: This authentication option is based on a certificate that is used to prove the other application’s (client) identity on the SSL connection from the other application to the SAP Web AS. The certificate contains a description of the identity of the other application and a public key that can be used by SAP Web AS to encrypt messages. With this key, SAP Web AS can establish the SSL connection with the other application and authenticate the user.

SAP Logon Ticket: This authentication option is used for user authentication between different SAP Web AS instances. The different applications of the mySAP Business

Suite may run on different instances of SAP Web AS. A user that is authorized in one instance of SAP Web AS does not have to authenticate itself again in another instance. Therefore, a ticket containing authentication information for Single Sign-On, called mySAP SSO2, is contained in the HTTP header of messages that are exchanged between SAP Web AS instances.

If the authentication of the Web service consumer is successful, the request is executed under this user’s identity. This identity is used for authorization checks in subsequent calls to application functionality (see Providing Authorization within the mySAP Business Suite ).



Public Web Services

It is also possible to define default users for Web services. In this case, the other application does not include any user data in the Web service message. The ICF assigns a predefined user to the incoming requests. Web services with default users are also called Public Web services, as everybody can access them without restriction.

Note

In future releases of SAP NetWeaver, other authentication options, such as user name and password in a SOAP message, XML-Signature and SAML will be supported. Some of these authentication options can only be provided by the Web service interpreter, as ICF cannot read the SOAP content of HTTP messages. For this reason, a standard user is assigned by the ICF during the normal authentication process. The Web service interpreter substitutes the real user for this standard user if the authentication is successful.

End of the note.

Providing Authorization within the mySAP

Business Suite

This process is used to authorize Web service consumers within the mySAP Business Suite.

Process

Accessing mySAP functionality via Web services follows the standard mySAP authorization concept. This concept is based on authorizations for specific authorization objects. If a user does not have an authorization for an authorization object, which is checked during the execution of a Web service, the execution is terminated, and an error message is returned

(see Exceptions and Errors ).

Web Service Invocation via XI Message Broker

The enterprise services packages for the mySAP Business Suite on SAP NetWeaver 2004s focus on providing synchronous Web services. However, Web services provided or called by an mySAP application need not be invoked synchronously. The underlying technical infrastructure of SAP Web AS also supports asynchronous service invocations. However, in order to use them reasonably, a networking infrastructure that provides reliable messaging is required.

Features

SAP Exchange Infrastructure (SAP XI)

XI Protocol

XI Local Integration Engine

SAP Exchange Infrastructure



SAP Exchange Infrastructure (SAP XI) is an integration technology and platform. XI uses by default an extended SOAP protocol for connecting applications. In addition, other protocols, such as JMS, JDBC, RFC and IDOC, can be used with adapters. XI provides communication services such as message routing and mapping of messages between different formats and contains a component for cross-component business process management (ccBPM). This component makes it possible to model and execute business processes on XI.

SAP XI provides, among other things, reliable messaging for asynchronous communication.

Therefore, the mySAP application does not implement such functionality on its own for the asynchronous invocation of Web services but requires SAP XI-based communication in this scenario.

The figure below shows the XI scenario for invoking Web services by refining the architecture introduced in the previous sections. The different types of proxies described in the section

Proxy Type are not shown (for clarity reasons).

XI Based Web Service Invocation

Other Application

XI Protocol, SOAP, or others

R

R

R

XI Integration Server

R

SOAP (over HTTP)

XI Protocol (over HTTP)


HTTP Message


Web Service

Enabling

Layer

XI Local Integration

Engine



Web Service Data

(XML)

Proxy Framework

Web Service Data

(ABAP)

Asynchronous Web

Service Proxy

Synchronous Web

Service Proxy


ABAP Stack





For more information about SAP XI, see the SAP help portal at help.sap.com

SAP

NetWeaver.

XI Protocol

The XI Integration Server understands all common network communication protocols, and application protocols, such as HTTP and SOAP. In addition, it offers the specific XI protocol on the application level. This protocol is based on SOAP and enhances it with information required to provide network infrastructure services, such as message routing, reliable messaging, and message monitoring. These services are not available in point-to-point scenarios that rely on the standard SOAP protocol. By default, the XI Integration Server is accessed via the XI protocol. However, other protocols can be utilized by using adapters.

Communication between the XI Integration Server and SAP Web AS is always carried out using the XI protocol. As this protocol is an enhanced SOAP protocol and based on HTTP, the HTTP Communication Layer can also handle XI protocol messages without modification.

XI Local Integration Engine

The XI Local Integration Engine is the receiver of the XI messages in the Web Service

Enabling Layer, instead of the Web service interpreter.

This local counterpart to the XI integration server speaks to the XI protocol and extracts the

Web service data from the message. As the XI protocol also provides services such as reliable messaging, the XI Local Integration Engine does not only transform and forward the incoming message, but may also trigger the XI integration server to retransmit messages that have been lost.

Once the Web service data has been extracted from the XI message, the rest of the Web service execution is identical to the execution in the point-to-point scenario (see Runtime

Architecture Overview ).

Note

By using standardized extensions to the SOAP protocol, it is possible that some of the mentioned services, such as reliable messaging, can be provided in point-to-point scenarios.

However, these standardized extensions are not supported in SAP NetWeaver 2004s, but in later releases only. The most common standardized extensions are Web Service Reliable

Messaging, Web Service Addressing and Web Service Security.

End of the note.

mySAP Service Provisioning: Design Time

Services in the enterprise services packages are created in two steps during design time.



Process

First, implementation independent service interfaces are defined. These service interfaces are aligned through a common object model representing the business content of the mySAP

Business Suite.

See Business Object and Service Modeling

In order to realize the defined services as Web services working on mySAP applications on the ABAP stack, corresponding ABAP entities have to be created and implemented.

See Proxy Generation in the ABAP Stack

Business Object and Service Modeling

This process is the first step in creating services in the enterprise services packages.

Process

This process involves the definition of implementation-independent service interfaces by creating a model of the business functionality to be offered, determining the functions to be realized, and deriving the appropriate service interface definitions.

Business Object Modeling

Service Interface Modeling

Governance Process

Since a sound model of the business content is crucial for SAP’s success in service provisioning, SAP has set up a governance process for the modeling activities. The governance process ensures that domain experts from all concerned divisions of SAP have reviewed the model and that the model is harmonized across SAP as far as possible.

ESR

The approved service interface definitions are stored in the Enterprise Service Repository

(ESR). The ESR is SAP’s design time repository for reusable type definitions.

ARIS

High-level models are kept and maintained in the modeling tool ARIS and can be viewed in the Enterprise Services Workplace in the SAP Developer Network (SDN) (at sdn.sap.com

sdn.sap.com ES Workplace ).

Business Object Modeling

This process is used to create a model of the business functionality to be offered, determining the functions to be offered.

The entities in the business model of SAP application functionality are shown in the figure below.

Entities of Service Interfaces and Business Object Models



Process Component

1

1..*

Business Object

1

1..*

Business Object

Node

*

1..* 1..*

Global Data Type

*

1..*

CCTS Core Data

Type

Service Interface

1

1..*

Service Operation

1

1..*

Message Type

*

1

Message Data Type

*

*

*

Structure

Data Typing

Usage specific

Global / Reusable

Business Semantics

No Business Semantics

Process

Process components and business objects are modeled in the ARIS modeling tool and can thus be viewed in the Enterprise Services Workplace. The internal structure of the business objects is only modeled SAP-internally and not released to the customers.

1.

Process Component

2.

Business Object

Process Component

A process component comprises all functionality offered by a service-oriented SAP application that realizes a certain business process, where a business process is regarded to be a sequence of activities transforming a defined business input into a defined business outcome.

Integration

A set of business objects belongs to each process component.

Example

An example for a process component is “customer invoice processing”.

Business Object

Business objects are entities from the business world that are relevant for a business process. A business object may be of diverse nature. Examples for business objects are documents, such as “customer invoice” or “employment” contract, legal entities, such as

“customer” or “bank”, or physical objects such as “material” or “inventory” item.

Example of a Business Object Model


SAP Documentation

BO Material

Material

BO CustomerInvoice

Customer Invoice Item

Enterprise SOA

Product

BO Service

Service Product

BO Customer

Customer

Taxation Terms

Customer Party

Structure

Business Object Node

Each business object is modeled as a hierarchical structure of nodes. As an example, the figure above shows an extract of the business object model of the customer invoice.

Nodes may have different cardinalities depending on their business semantics. For some nodes an arbitrary number of node instances is possible, like for line items in a customer invoice. For other nodes only a limited number of instances may exist. For example, each line item of a customer invoice represents only a single product, which is to be invoiced. In addition to the internal structure of a business object, the associations between related business objects are modeled as well in the business object model. For example, the customer invoice depends on a customer and a material or a service product.

Global Data Type (GDT)

Each business object node is made up of data fields, which are typed with so-called global data types (GDTs). GDTs are allowed and intended to be reused in different business object nodes. The idea is that for each basic business fact a GDT is defined and used wherever the business fact has to be represented in a data field.

GDTs may be either unstructured (for example, ProjectName and TaxableIndicator) or structured, that is a record of two or more other GDTs (for example, DeliveryTerms and

Address).

CCTS

Unstructured GDTs are either qualified versions of other unstructured GDTs or represent a core data type as defined in the Core Components Technical Specification (CCTS) by

UN/CEFACT ( http://www.unece.org/cefact/ebxml/CCTS_V2-01_Final.pdf) .

Core component types are basic data type definitions on a more technical level, which have no business semantics on their own. Examples for core data types are identifier (a character string uniquely identifying a certain object within a certain context), indicator (a Boolean value) or amount (an amount of money together with the currency). By adhering to a public standard for elementary data types, it is easier to exchange data with third party applications.

Example

Examples for business objects are documents, such as “customer invoice” or “employment” contract, legal entities, such as “customer” or “bank”, or physical objects such as “material” or

“inventory” item.



Service Interface Modeling

This process is used to derive the appropriate service interface definitions.

Service interface definitions for enterprise services have a uniform hierarchical structure, as shown below.

Entities of Service Interfaces and Business Object Models

Process Component

1

1..*

Business Object

1

1..*

Business Object

Node

*

1..* 1..*

Global Data Type

*

1..*

CCTS Core Data

Type

Service Interface

1

1..*

Service Operation

1

1..*

Message Type

*

1

Message Data Type

*

*

*

Structure

Data Typing

Usage specific

Global / Reusable

Business Semantics

No Business Semantics

Service Operation / Message Interface

For each operation, up to two parameters may be required, an input parameter and an output parameter. The input parameter has to be provided when calling the service. The output parameter is determined during the service execution and returned to the caller.

In addition to these two parameters per operation, an additional universal fault parameter exists. This fault parameter is sent back to the consumer in case of exceptions instead of the normal output parameter (see Exceptions and Errors ).

Service Operations are also called Message Interfaces.

Message Type

The parameters are also called messages, since they make up the payload of the SOAP messages transferred between the consumer and the provider. For each service, the message required as input parameter and/or the message provided as output parameter must have a certain message type. The universal fault parameter has its own separate message type. Except for the fault message type, message types must not be reused between service operations, but are unique to one service operation.

Message Data Type

The message types are typed with a message data type, which is a record of data fields typed with GDTs, analogous to the data fields of business object nodes. Message data types unlike message types may be reused.



Process

Leading Business Object

All services are grouped around the business objects. Each service operation is associated with the business object that is central for the service operation’s business purpose. For example the service operation customer invoice creation request is associated with the business object customer invoice. There may be multiple business objects relevant for the execution of a service operation. In the customer invoice example, the customer and the products to be invoiced are relevant as well. The service operation will be assigned to the central business object, which has to be identified among all relevant business objects. This central business object is also called leading business object for the service operation.

Message data types for a service operation are always derived from the leading business object as described in the following paragraphs. This ensures that service operations that are associated with the same central business object always use compatible message data types.

A message data type consists of up to three parts:

a generic message header

a so-called business document object for output messages: a generic log structure, which is used to return administrative information about the service execution.

Business Document Object

The business document object contains the specific business content of the message, that is the business facts relevant for the service execution or the business facts that show the result of the service execution. The business document object is the part of the message data type that is derived from the business object model. The business document object is a trimmed extract from the business object model containing all relevant parts of the leading business object of the service interface and all relevant parts of related business objects. The following figure shows the business document object corresponding to the customer invoice example above.

Example of a Business Document Object

Customer Invoice Item Product Material

Taxation Terms

Customer Party Customer Party

Service Product

Since the business document object is always a part of the message data type, it has to be structured hierarchically. The root node of the leading business object becomes the root node of the business document object. Below the root node, all relevant parts of the leading business object are included in the business document object according to the business object model. The required parts of associated business objects are linked below those nodes of the leading business object, with which they are associated in the business object model.

The extent to which associated business objects are included in the business document object depends on the semantics of the service operation. In some cases an identifier of the


SAP Documentation Enterprise SOA object is sufficient. In other cases one or more nodes or even the whole business object may be required.

Proxy Generation in the ABAP Stack

A service interface definition in ESR is an abstract definition that does not depend on a specific implementation. In order to use the abstract definitions in the ABAP stack, corresponding ABAP entities have to be created and implemented in SAP Web AS.

ABAP Entities and Meta Data

In the ESR, the structure of a Web service is defined by specifying a service interface and the data types that are used in this interface (see Business Object and Service Modeling ).

Corresponding ABAP entities for the service interfaces and data types defined in ESR are

ABAP interfaces, ABAP classes and ABAP data types. In addition meta data of the ABAP entities are required in the ABAP stack in order to execute a Web service. The meta data contains information about the entities that have been created based on ESR content. This information specifies for example how to map data types from the XML representation in ESR to the ABAP representation.

Design Time Architecture

Enterprise

Services

Modeler

R

Enterprise Services

Builder

Data Types

(GDTs)

Service Interface

Definitions

Enterprise Services

Repository

Proxy

Generator

(SPROXY)

Developer

R

ABAP Workbench

Proxy Classes

Proxy

Interfaces

Meta Data

Service

Definitions

ABAP Repository

Data Types

ABAP Dictionary

Database

Service

Definition

Generator

(Web

Service

Wizard)



Process

1.

Enterprise Services Builder

The figure above shows the systems involved in designing service interfaces in ESR and creating ABAP entities in the ABAP Stack on SAP Web AS for providing mySAP

Web services. Service interface definitions and data types are created in ESR with the enterprise services builder.

2.

Proxy Generator

Based on the ESR content, the proxy generator creates all necessary ABAP entities for a service interface. It creates, on the one hand, the required ABAP data types in the ABAP dictionary, on the other hand, the ABAP interface and the ABAP class for the proxy which implements the service interface.

3.

Automatic and Manual Proxy Implementation

The implementation of a consumer proxy can be generated automatically.

A provider proxy which relies on existing functionality must be implemented by a developer, as the logic which calls the existing functionality can not be created automatically. Therefore, the proxy generator only creates an empty ABAP class for provider proxies. The methods of this class have to be implemented by a developer.

Each method corresponds to an operation of the Web service.

4.

Service Definition Generator

Once the proxy classes have been implemented, a service definition has to be created with the Web service definition generator, before a Web service can be released (see Releasing a Web Service ). A service definition contains the design time properties of a Web service. The properties specify preferred security settings which should be used when the Web service is released during configuration. Design time properties, which are created with the service definition generator, are stored in a service definition entity.

mySAP Service Provisioning: Configuration

This process is used to configure services created by SAP. Once the services have been created by SAP, they are delivered with the enterprise services packages to the customer.

The customer needs to configure the services according to his or her needs and the available

IT infrastructure.

Business Configuration

The business configuration of the service-enabled mySAP Business Suite does not differ from that of the conventional mySAP Business Suite. Details of the business configuration of the mySAP Business Suite can be found in its Implementation Guide (IMG). The implementation guide is a tool for configuring the SAP system to meet customer requirements. It is accessed from the SAP menu of the SAP system by choosing Tools Customizing IMG .

SAP XI

For services that are to be called via SAP XI, the conventional XI configuration has to be carried out. For more information about SAP XI, see the SAP help portal at help.sap.com

SAP NetWeaver .


SAP Documentation

Process

Releasing a Web Service

Performing Web Service Administration

Configuring Idempotent Services

Releasing a Web Service

Enterprise SOA

This is the first step of the configuration process.

Note

You perform the configuration described in these steps using the WSCONFIG transaction.

For more information, see the SAP Help Portal under help.sap.com

SAP NetWeaver

Releasing for the SOAP Runtime .

End of the note.

Procedure

1. Activate the required services

You need to decide which of the services delivered by SAP should be active in your installation of the mySAP Business Suite. These services have to be activated explicitly. The activation process is also referred to as the release of the service.

2. Apply variants

For each service delivered, a service definition is provided. The service definition consists of a service interface description and one or more variants. When a service is to be released, the next step is to decide which of the variants available is applied.

See Service Definition and Service Variant

3. Specify the following additional information: o Name and release text: Name and textual description of the service that will be published to the consumers.

o Virtual host: The name of the SAP system which acts as the service provider.

The virtual host implicitly determines the transfer protocol.

o URL: The relative URL of the service in relation to the virtual host.

o Security profiles: Security settings specifying the authorizations required for the execution of the Web service.

4. Generate a runtime configuration

The service configuration utility takes the service interface description, the chosen variant and the additional information to generate a WSDL description and a runtime configuration. The WSDL description can be published to the service consumers, while the runtime configuration is needed by the Web service interpreter and the proxy framework to process calls to the service.



Service Definition and Service Variant

For each service delivered, a service definition is provided. The service definition consists of a service interface description and one or more variants. A variant describes the features of the service. Features in this context are properties of the service on a non-technical level, which restrict the choice of host and protocol in the configuration process. For example, if the variant specifies that the service needs authentication by certificates, it is not possible to use HTTP as a transfer protocol. HTTPS should be used instead.

Features

There are three feature types for services:

Unique message ID: A unique message ID should be assigned to each message.

Authentication level : Requirements for the authentication mechanism. Possible values are: “no authentication required”, “password authentication required” and

“certificate authentication required”.

Transport guarantee level: Requirements for the transport mechanism. It specifies whether integrity and/or confidentiality have to be ensured. Integrity is the guarantee that transferred messages arrive unmodified at the receiver. Confidentiality is the guarantee that only the receiver can access the unencrypted content of a transferred message.

Activities

When a service is to be released, the first step is to decide which of the variants available is applied.

Performing Web Service Administration

The administration of Web services is the part of the configuration which takes place when the Web services are released.

1. Make the following two administration settings for an SAP Web service o Trace and Log: The extent to which information about the use of a service is recorded. It is possible, for example, to record information about calls to the service received, errors that occur during service execution, and performance measures.

o UDDI publication: The WSDL description of released Web services can be published in UDDI repositories.

2. Test the Web service

SAP’s Web service administration utility provides a test Web site, which allows invoking the Web service with test parameters. This can be used to check the configuration settings applied.

Note



You perform the administration described below using the WSADMIN transaction. For more information, see the SAP Help Portal under help.sap.com

SAP NetWeaver Administration for the SOAP Runtime.

End of the note.

Configuring Idempotent Services

You use this method to set how long the system stores saved response messages or saved information about responses that have been sent. An initialization process takes you through the steps the first time you make these settings.

The initialization process incorporates the following steps:

The system creates several database objects that are necessary for saving response messages.

The system schedules the following background jobs for the regular deletion of saved response messages and message IDs: o SAP_BC_IDP_WS_SWITCH_BD o SAP_BC_IDP_WS_SWITCH_BDID

To ensure, for performance reasons, that the responses or the information about sent responses are deleted as soon as possible after the desired period, the system uses table pairs:

two tables per client for response messages two tables per client for information about response messages that have been sent

The two tables are filled alternately. When changing from the first table to the second table, the data in the first table is kept, but the data from the second table is deleted before the system adds new content. You decide how often the background jobs change tables using the procedure described here. This results in a minimum storage duration for the data.

Prerequisites

You must be using at least SAP NetWeaver 2004s SPS09.

Procedure

1. Start transaction WSIDPADMIN.

2. In the Document area, enter the minimum storage period for response messages. In addition, enter how often the tables must be changed.

3. In the Document ID area, enter the minimum storage period for information about response messages that have already been sent. In addition, enter how often the

Document ID tables must be changed. We recommend you choose a longer time interval than you did for the response messages. Note that a repeated request message results in an error if the corresponding response message has already been deleted but the information about the sent response message is still available.

4. Execute the transaction by choosing Schedule or pressing F8 .

5. Repeat the settings in every client in which you want to call Enterprise Services.



Example

You use a time period of two hours for changing the document tables. This means that response messages are stored for at least two hours but at most for just less than four hours.

You use a time period of one day for changing the document ID tables. This means that information about sent response messages is stored for a maximum of just less than two days.

Example: Service Operation “Create Employee

Leave Request”

This section provides a walk-through of service provision using the example of the service operation “Create Employee Leave Request”. This service operation is associated with the business object “EmployeeLeaveRequest”, which belongs to the process component “Time and Labour Management”.

Process

1.

Modeling of Process Components in ARIS

2.

Business Object Modeling

3.

Modeling of Service Interfaces in ESR

4.

Proxy Implementation

Modeling of Process Components in ARIS

The first step in the process of service creation is the development of the process component model in the modeling tool ARIS.

Procedure

The first figure below shows the process component “Time and Labour Management” as an extract from the business object map, which is an overview of all process components and business objects.

Time and labour management supports the definition of employees' planned working time as well as the recording of the actual working times and absences and their evaluation.

Inside the process component, the contained business objects are shown. One of them is the business object EmployeeLeaveRequest.

An EmployeeLeaveRequest is the application form used by an employee to request leave.

The request contains information about the desired leave besides request information such as submission date or the selected approver. The approver receives information about the desired leave and (depending on the type of desired leave and its configuration) has the possibility to approve or reject the request.

Process Component & Business Objects


SAP Documentation

Time and Labour Management

Enterprise SOA approved

The next figure below shows an extract of the process component model of the process component “Time and Labour Management”. The process component model particularizes the business object map. For one process component, it shows all contained business objects together with the related service interfaces. For each service interface the operations and messages are shown.

For the business object EmployeeLeaveRequest, one of the service interfaces is the interface

“Manage Employee Leave Request”, which contains all operations necessary to write, change and delete employee leave requests. Another service interface for the business object

EmployeeLeaveRequest is “Employee Leave Request Action”, which contains operations for approving and denying employee leave requests.

One of the operations in the service interface “Manage Employee Leave Request” is the operation “Create Employee Leave Request”, which triggers the creation of a new employee leave request. The operation makes use of two messages, the inbound message

EmployeeLeaveRequestCreateRequest and the outbound message

EmployeeLeaveRequestCreateConfirmation.

Process Component Model



Management

Message Type

EmployeeLeaveRequestCreateRequest

EmployeeLeaveRequestCreateConfirmation

Manage Employee Leave

Request

Create Employee Leave

Request

Service Interface

Service Operation

EmployeeLeaveRequestChangeRequest

EmployeeLeaveRequestChangeConfirmation Request

...

Business Object

Employee Leave

EmployeeLeaveRequestCreateRequest

EmployeeLeaveRequestCreateConfirmation

Employee Leave Request

Action

Approve Employee

Leave Request

Kommentar

...

...

...

Employee Time

...

Business Object Modeling

The second step in the process of service creation is to define the inner structure of the business objects in a business object model.

Procedure

The figure below shows the business object model for the business object

EmployeeLeaveRequest. Besides the root node, there are three sub nodes: Note,

AllowedAction and Item.

Business Object Model



A note is a free text together with information about its author and the date and time of creation.

The allowed action is a coded representation of the way in which the transmitted document can be processed, for example “delete”, “modify” or “approve”.

An item of an employee leave request is a document item describing the details of an employee’s requested leave, e.g. the kind of leave and the planned period.

The business object EmployeeLeaveRequest has four associations with other business objects: to EmployeeTime, to EmployeeLeaveRequestConfiguration and two associations to

Employee.

The linked employee time entry is an existing one, which is the result or the subject of this employee leave request.

The linked employee leave request configuration provides information about the functional and UI arrangement of employee leave requests concerning the individual business needs of the company.

One of the linked employees is the requester. The other linked employees are further participants, for example the responsible approver of the request.

The data fields contained in the business object nodes are not discussed here individually, but can be seen from the message structure in the next section about service interface modeling.

Modeling of Service Interface in ESR

The third step in the process of service creation is to derive the structure of the messages from the business object model and register the service operations together with the required messages in ESR.



Procedure

The figure below shows the message structure for the “Employee Leave Request Create

Request” message as it is registered in the ESR.

Message Structure

SAP - Service Interface: Element Structure for EmployeeLeaveRequestCreateRequestMessage

Package

Employee Lea veRe questCre ateRequest/

Employee Lea veRe questCre ateC heckQu e ry

Employ ee Lea ve Re quest

Employee Leav eRe questC re ateReq uest/EmployeeLea ve Re questC re at e Che ckQ uery

Employee Leav eRe que stHeader

Employee Leav eRequ est

Participant

BusinessTransactionDocume nt

Reference

Role Code

WorkA gree mentID

Note

Le av eEmployee Time Re fere nce

Text

Employee TimeItem

A ctionC ode

Leave EmployeeTimeRefere nce

Le av eEmployee Time Ite m

C ategoryC ode

Type Code

Validity

FullWorkingDayIndica tor

Valuation Terms

EmployeeTimeVa lua tionTe rms

A ctiv ityA llocationA ndCostA ssignme nt

ServiceProvisionA ndResourceConsu mption

WorkBrea kDownStructure Ele mentI

D

Re ceivingC ostC entre ID

LogisticC onfirmation

OrderID

DifferentPayment

Pos itionID

ValuatedDura tion

DurationCa lculationMethodC ode

Duration

A dditionalInformation

Firs tA dditionalInforma tionText

SecondA dditionalInformationTex t

ThirdA dditiona lInforma tionText

FourthAdditionalInformationTex t

FifthA dditiona lInformationTex t

SixthA dditiona lInforma tionText

Sev enthA dditionalInformationTex t

EighthA dditionalInformationTex t

NinthAdditionalInformationTex t

TenthAdditionalInformationTe xt

1

1

0. .n

GDT

GDT

XXX

1

1

1

0. .1

0. .1

0. .1

0. .1

GDT

GDT

GDT

GDT

XXX

GDT

XXX

0. .1

GDT

0. .1

XXX

0. .1

0. .1

0. .1

0. .1

0. .1

0. .n

1

GDT

XXX

GDT

XXX

GDT

XXX

GDT

GDT

XXX

GDT

GDT

GDT

GDT

GDT

GDT

GDT

GDT

GDT

GDT

1

0. .1

0. .1

0. .1

0. .1

0. .1

0. .1

0. .1

0. .1

0. .1

0. .1

0. .1

1

0. .n

1

1

0. .1

1

0. .1

XXX

XXX

GDT

GDT

XXX

GDT

XXX

Type

MDT

Name

Employee Leave RequestC re ateReque st/Em ploye eLe aveReque stC rea te CheckQuery

Employee Leave Request

Pa rticipa nt

Employee Leave RequestPa rticipantRoleC od e

WorkA gre ementID

Note

Te xt

Leav eEmployee Time Reference

A ctionC ode

Busine ssTransactionDocumentReference

Leav eEmployee Time Item

Employee TimeIte mC ategoryC ode

Employee TimeIte mTypeCode

Employee TimeIte mValidity

FullWorkingDayIndicator

Va lua tionTerms

Employee TimeValuationTe rms

A ctivity A llocationAndC ostA ssignment

ProjectEle mentID

ServiceProvisionA ndResource C onsumption

C ostC entreID

LogisticConfirma tion

Busine ssTransactionDocumentID

Diffe re ntPayme nt

PositionID

Va luate dDuration

Employee TimeIte mDurationC a lculationMet hodCode

Dura tion

A dditiona lInforma tion

A dditiona lInforma tionText










Level 1 represents the complete message, which (on level two) consists only of the business document object for “EmployeeLeaveRequest”. The message header and log are not required in this case.

The business document consists of four parts. The participant, the note, the employee time reference and the employee time item.

The participant is the employee linked to the business object, which is relevant for the service operation. In the case of the create operation the relevant employee is the requester.

The note is the note from the business object.

The employee time reference is a reference to the existing employee time, which is the subject of this leave request. This reference is only needed if an existing (planned) employee time entry is requested to be changed or canceled.

The employee time item corresponds to the employee leave request item and describes the requested leave.

For all parts of the message the contained data fields are listed together with the global data types with which they are typed.

Proxy Implementation

In order to provide the Web service on the ABAP stack, ABAP entities have to be created with the proxy generator (see Proxy Generation in the ABAP Stack ).



Procedure

The message interface in ESR which defines the Web service is,

EmployeeLeaveRequestCreateRequestConfirmation_In

Based on this message interface, the proxy generator creates the following ABAP entities:

ABAP data types

ABAP Interface: II_TIM_EMPLOYEELR_CRTRC

ABAP class for the Web service proxy which implements the interface:

CL_TIM_EMPLOYEELR_CRTRC

The implementation of the proxy is shown in the following in more detail. To keep the example clear, the created ABAP data types are not depicted in this example.

When a Web service call is received, the proxy framework triggers the proxy by calling the

II_TIM_EMPLOYEELR_CRTRC interface method EXECUTE_SYNCHRONOUS . It calls the following methods in the specified order:

1.

INPUT_MAPPING: Performs the application level mapping of input parameters (see

Data Conversion and Custom Modifications )

2.

BUSINESS_LOGIC: Executes the business logic by calling the existing RFC (see

RFC: PT_ESA_REQUEST_CREATE )

3.

OUTPUT_MAPPING: Performs the application level mapping of output parameters

(see Data Conversion and Custom Modifications )

Example

The following is an excerpt of the source code of the EXECUTE_SYNCHRONOUS method.

Execute Synchronous

METHOD ii_tim_employeelr_crtrc~execute_synchronous.

Syntax

1.

* EmployeeLeaveRequestCreateRequestConfirmation_In DATA

2.

lv_employeenumber TYPE pernr_d.

3.

DATA lv_leave_id TYPE tim_req_id.

4.

DATA lt_messages TYPE bapirettab.

5.

DATA ...

6.

7.

* database updates are done synchronously

8.

SET UPDATE TASK LOCAL.

9.

10.

* Input Mapping: map proxy input parameters to function module (RFC) input parameters

11.

CALL METHOD me->input_mapping

12.

EXPORTING



13.

is_input = input "/input format according to proxy ABAP datatype

14.

IMPORTING

15.

ev_employeenumber = lv_employeenumber "/internal format

16.

ev_leave_id = lv_leave_id

17.

ev_operationid = lv_operationid.

18.

19.

* Business logic call

20.

CALL METHOD me->business_logic

21.

EXPORTING

22.

iv_employeenumber = lv_employeenumber

23.

iv_leave_id = lv_leave_id.

24.

IMPORTING

25.

ev_request_detail = lv_request_detail business logic processing

"/result from

26.

ev_success = lv_success

27.

et_messages = lt_messages. "/ application message table -

28.

internal format

29.

30.

* Map application errors table to format of global data type

Log

31.

CALL METHOD cl_proxy_log=>fill

32.

EXPORTING

33.

bapireturn_tab = lt_messages

34.

IMPORTING

35.

log = output-... .

36.

EXIT.

37.

ENDIF.

38.

39.

* Output Mapping: map function module (RFC) output parameters to proxy output parameters

40.

CALL METHOD me->output_mapping

41.

EXPORTING

42.

iv_request_detail = lv_request_detail

43.

IMPORTING

44.

rs_output = output... . "/ input format according to proxy

ABAP

45.

datatype

46.

47.

* Commit

48.

cl_soap_commit_rollback=>commit( ).



49.

50.

ENDMETHOD. "ii_tim_employeelr_crtrc~execute_synchronous

51.

End of the code.

The methods called in this excerpt are shown in more detail in the following. The methods for input and output mapping show the mapping of parameters based on a few examples. The method which executes the business logic basically only calls the existing RFC (see RFC:

PT_ESA_REQUEST_CREATE )

Input Mapping

METHOD input_mapping.

Syntax

1.

DATA wa_participant TYPE LINE OF hrsef_employeelr_crt_req_msg-employee_leave_requestparticipant.

2.

DATA lt_messages TYPE bapirettab.

3.

...

4.

5.

* Mapping employee numbers

6.

LOOP AT is_input-employee_leave_request_createemployee_leave_request-participant INTO wa_participant.

7.

CASE wa_participant-role_code-value.

8.

WHEN cl_tim_proxy_constants=>participant_role_owner.

9.

ev_employeenumber = wa_participant-work_agreement_idvalue.

10.

...

11.

ENDCASE.

12.

ENDLOOP.

13.

...

14.

15.

* Mapping LeaveID and ActionCode

16.

CALL METHOD cl_tim_leave_proxy_mappings=>time_ref_input_mapping

17.

EXPORTING

18.

is_proxy_time_ref = is_inputemployee_leave_request_create-

19.

employee_leave_request-

20.

leave_employee_time_reference

21.

IMPORTING

22.

ev_fm_leave_id = ev_leave_id

23.

ev_fm_operation_id = ev_operationid

24.

et_messages = lt_messages.

25.



26.

APPEND LINES OF lt_messages TO et_messages.

27.

...

28.

29.

ENDMETHOD. "input_mapping

End of the code.

Business Logic

METHOD business_logic.

Syntax

1.

DATA : lv_pernr TYPE pernr_d.

2.

DATA : lt_messages TYPE bapirettab.

3.

4.

lv_pernr = iv_employeenumber.

5.

6.

*** If owner pernr is not supplied, use the pernr of the user who is invoking the service

7.

IF iv_employeenumber IS INITIAL.

8.

9.

CALL FUNCTION 'PAD_EMPLOYEENUMBERS_GET_LIST'

10.

EXPORTING

11.

iv_username = sy-uname

12.

iv_key_date = sy-datum

13.

IMPORTING

14.

ev_employee_number = lv_pernr

15.

TABLES

16.

t_messages_out = lt_messages.

17.

18.

IF NOT lt_messages IS INITIAL.

19.

APPEND LINES OF lt_messages TO et_messages.

20.

RETURN.

21.

ENDIF.

22.

23.

ENDIF.

24.

25.

26.

CALL FUNCTION 'PT_ESA_REQUEST_CREATE'

27.

EXPORTING

28.

iv_employee_number = lv_pernr

29.

iv_leave_id = iv_leave_id

30.

iv_oparation_id = iv_operationid

31.

iv_leave_request = iv_requestdetail



32.

IMPORTING

33.

ev_request_detail = ev_request_detail

34.

ev_success_confirmation = ev_success

35.

TABLES

36.

et_messages = et_messages.

37.

38.

ENDMETHOD.

39.

End of the code.

Output Mapping

METHOD output_mapping

Syntax

1.

DATA ls_participant TYPE ptesa_actor_struc.

2.

DATA ls_proxy_participant TYPE hrsef_employee_leave_request13.

3.

DATA ls_time_item TYPE hrsef_employee_leave_request10.

4.

DATA lv_owner TYPE pernr_d.

5.

...

6.

7.

* Participant table

8.

LOOP AT iv_request_detail-participant INTO ls_participant.

9.

CALL METHOD cl_tim_leave_proxy_mappings=>participant_output_mapping

10.

EXPORTING

11.

is_fm_participant = ls_participant

12.

IMPORTING

13.

ev_owner = lv_owner

14.

es_proxy_participant = ls_proxy_participant.

15.

16.

IF NOT ls_proxy_participant IS INITIAL.

17.

APPEND ls_proxy_participant TO rs_output-

18.

employee_leave_request_createemployee_leave_request-

19.

participant.

20.

ENDIF.

21.

ENDLOOP.

22.

...

23.

24.

* Time item table

25.

CALL METHOD cl_tim_leave_proxy_mappings=>item_output_mapping



26.

EXPORTING

27.

iv_pernr = lv_owner

28.

is_fm_item = iv_request_detail-item

29.

IMPORTING

30.

es_proxy_item = ls_time_item.

31.

32.

APPEND ls_time_item TO rs_outputemployee_leave_request_create-

33.

employee_leave_request-leave_employee_time_item.

34.

35.

ENDMETHOD. "output_mapping

36.

End of the code.

RFC: PT_ESA_REQUEST_CREATE

The RFC used to implement the Web service in the ABAP stack is

PT_ESA_REQUEST_CREATE. The RFC not only supports the creation of an employee leave request but also makes it possible to change and delete employee leave requests.

Therefore other Web services can be created that are based on the same RFC. As in our example, only employee leave requests are created, the proxy implementing the Web service only uses part of the available functionality.

Basically the RCF takes the employee number, the leave request and an operation type as input. In case of the creation of a request (determined by the operation type) and if executed successfully, it returns the created leave request containing additional detailed information that was added to the original request during creation.

mySAP Service Provisioning: Documentation

The services delivered by SAP for mySAP Business Suite are developed in two steps. First, the services are defined independently of an actual implementation. To do this, they are presented uniformly in a business object model that is valid in general. The models represent the business content of mySAP Business Suite in a simple and structured form.

Note

You can view the models on the Enterprise Service Workplace in SAP Developer Network

(SDN) at sdn.sap.com

Enterprise SOA ES Workplace

End of the note.

Second, SAP implements the objects required for realizing the services in the SAP system as

ABAP entities.

The uniform and structured view that the business models provide for the functions of mySAP

Business Suite is also used for structuring the documentation. Therefore, objects are described in the documentation that do not have a direct correspondent in an SAP system.

These consist of the following objects: process components, business objects, and service


SAP Documentation Enterprise SOA interfaces. The description of these objects provides you with an overview of the actual business process in which you can use the services delivered by SAP.

The implementations of service operations are available as part of the delivery of mySAP

Business Suite enterprise services package.

Documentation Target Groups

The documentation is aimed primarily at the following target groups:

Business consultants who design processes and applications for customers and who want to learn about the features of the individual services

Business consultants for service providers who set up a back-end system such that the services can be used in the conventional way

Software developers who use the services when creating applications (user interfaces) to enable data communication with the back-end system

Members of the support team who provide support to the above target groups on how to use the service

Documentation Structure

Title

The titles of the documents for the individual SOA entities correspond to the names that were used in the business models to describe the objects.

Note

In following releases, the message interfaces are called operations. For this reason, the message interfaces are now called (service) operations in the documentation.

End of the note.

Technical Data

The technical data of the operations includes the names of the operations as objects in the

Enterprise Service Repository (ESR) and specifies what the associated Web service definitions are called.

Documentation

In addition to the technical data, the documentation includes the definitions of the relevant

SOA entities as they can be found in the business models. The following sections describe the business use of the objects and their position within the business model. If the data structures of the operation’s message types have special features, these are described in the

Requirements, Structure, and Error Handling sections. Information that is valid for all objects of a process component, business object, or service interface is grouped together for each object.

All special features that are based on the implementation of the service and the processing of messages in the SAP back-end system are described in the Notes for SAP Back-End System

Administration section.

Features

The following table explains the meaning of the individual entries in the tables of technical data.



Entity Type Entry in the Table Meaning

Process component

Software Component

Name of the software component in the SAP back-end system with the release number as of which the implementation of the services of this process component is available

Business object

Service interface

Software Component

Name of the software component in the SAP back-end system with the release number as of which the implementation of the services of this business object is available

Software Component

Name of the software component in the SAP back-end system with the release number as of which the implementation of the services of this service interface is available

Category

Mode

Information indicating whether this is an inbound or outbound interface

Technical Name in Enterprise Service Repository

(ESR)

Service operation

Technical Name in

Enterprise Service

Repository (ESR)

Unique name of the operation in ESR

Namespace in ESR

The namespace indicates the SAP back-end software component in which the specified business logic of the operation is stored.

Software Component

Version in ESR

The software component version indicates the release status of the SAP back-end as of which the operation is available

Category

Mode

Information indicating whether this is an inbound or outbound operation

Information indicating whether the operation is used for synchronous or asynchronous processing

Related Web Service

Definition

Name of the Web service definition

Stability of Released Enterprise Services

On the one hand, it is necessary to further develop enterprise services to satisfy new or changed requirements. On the other hand, it is essential that as soon as enterprise services are released, they remain stable. This means they should only be further developed to be upward compatible so that existing consumers do not have to make any adjustments after an upgrade of the enterprise service.



Compatible Further Developments of Enterprise Services

Compatible further developments must necessarily be syntactically compatible. This means that the interfaces of a service, especially the XML schema of the input and output message types, may only be enhanced in a particular way. For example, no elements may be renamed, nor may type or length be changed.

A simplified example is only the syntactically downward-compatible addition of new optional elements and attributes. An element or attribute is optional if it does not have to be contained in an XML document that is exchanged at runtime. A new optional element or attribute can be added at any place in the interface as a sub-element or attribute of an existing element, as long as that element already has at least one sub-element or attribute.

Note

Since this rule is also valid for response messages, it implies requirements regarding the way enterprise service consumers must process response messages. A consumer must ignore unknown elements or attributes when receiving a response message, meaning they should not strictly validate the messages. In this sense, enterprise services must be consumerupward compatible .

End of the note.

At first glance, additional forms of syntactically compatible enhancements would be feasible

— especially for input message types. However, they frequently indicate changes that are incompatible in content or they are incompatible from the perspective of customer-defined extensions of the data conversion (see BAdIs).

Changes in content arise , for example, if the existing implementation of the service is changed or enhanced, thus causing the service or some of the elements in its interface to receive a modified meaning, without the structure of the interface itself being changed. In addition to the syntactical downward compatibility, content compatibility is also essential for service consumers.

If the further development of a service provides for syntactical compatibility as well as content compatibility, the released service itself is enhanced, and a new service is not developed.

After an upgrade of the enterprise service, consumer automatically use its enhanced version.

If an incompatible change cannot be avoided, one or more new enterprise services are offered to replace the existing one. However, exceptions to this rule are possible.

New Enterprise Services to Replace Enterprise Services to be

Discontinued

If the incompatible change is a change in content, the new enterprise services will correspondingly have a different name. Thus, the new services must not necessarily have the same name as the replaced services.

If the change is not a change in content , the new enterprise service will essentially keep the name of the replaced service. However, both enterprise services belong to the same namespace, so that the new service cannot have the exact same name. It can be considered to be a new version of the replaced service and therefore has an attached version number "_V1". If there are additional incompatible changes, the version number increases accordingly.

The enterprise service to be replaced is not removed immediately, but rather flagged as

“Deprecated” (obsolete). It is still supported in the change release (the release in which the subsequent service is rolled out) and its functionality is retained.

In the subsequent release, the actual implementation of the discontinued service is removed and replaced by coding which merely returns an exception message. At the same time, the enterprise service changes its status to “Revoked.”



The replaced service can only be removed after at least one more release when the discontinuation phase has been entirely finished.

As long as it exists, the discontinued enterprise service refers to its successor services and there is documentation on how existing applications that use the discontinued service can be converted to the new services.

Glossary

Terms used in Enterprise Service Oriented Architecture

A2A

A2A refers to communication between different software applications within the same company. Interfaces for A2A communication, unlike B2B interfaces, may be specific to a certain software application. (Compare B2B )

ABAP

ABAP (Advanced Business Application Programming) is a 4th generation programming language created by SAP. It is currently positioned as the language for programming the SAP

Web Application Server, part of the SAP NetWeaver platform for building business applications.

BAPI

A standardized and stable programming interface that facilitates external access to business processes and data in the SAP System. BAPIs offer an object-oriented view of business components in the SAP system.

B2B

B2B refers to communication between different companies. Interfaces for B2B communication must be independent of specific software applications. Usually B2B interfaces comply with international e-business standards. (Compare A2A )

HTTP



Hypertext Transfer Protocol (HTTP) is the protocol used to transfer or convey information on the World Wide Web. It is a patented open internet protocol whose original purpose was to provide a way to publish and receive HTML pages.


HTTP/1.1 specification (RFC 2616, June 1999)

HTTPS

HTTPS refers to the combination of normal HTTP interaction over an encrypted secure socket layer transport mechanism.

Java

Java refers to a number of computer software products and specifications from Sun

Microsystems (the Java™ technology) that together provide a system for developing and deploying cross-platform applications in an object-oriented way.

More Information http://java.sun.com

RFC

A Remote Function Call is a call of an SAP function module that runs in a different system

(destination) from the calling program. Connections are possible between different SAP systems and between an SAP system and a non-SAP system. In non-SAP systems, instead of function modules, special programmed functions are called, whose interface simulates a function module. The term RFC sometimes also refers to the called function module.

SAML

Security Assertion Markup Language (SAML), developed by the Security Services Technical

Committee of OASIS, is an XML-based framework for communicating user authentication, entitlement, and attribute information. SAML allows business entities to make assertions regarding the identity, attributes, and entitlements of a subject (an entity that is often a human user) to other entities, such as a partner company or another enterprise application.

More Information http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=security



SSL

Secure Sockets Layer (SSL) is a cryptographic protocol which provides secure communication on the Internet.

XML

Extended Markup Language (XML) is a generic language for defining new markup languages specified by the World Wide Web Consortium (W3C). Markup languages (such as HTML) are used to represent documents with a nested, treelike structure.

More Information http://www.w3.org/XML/

XML Encryption

XML Encryption is a specification that defines how to encrypt the content of an XML element, as recommended by the World Wide Web Consortium (W3C).

More Information http://www.w3.org/Encryption/2001/

XML Signature

XML Signature is a specification that defines an XML syntax for digital signatures, as recommended by the World Wide Web Consortium (W3C).

More Information http://www.w3.org/TR/xmldsig-core/

About This Documentation

Documentation Target Groups

The documentation is aimed primarily at the following target groups:

Business consultants who design processes and applications for customers and who want to learn about the features of the individual services

Business consultants for service providers who set up a back-end system such that the services can be used in the conventional way



Software developers who use the services when creating applications (user interfaces) to enable data communication with the back-end system

Members of the support team who provide support to the above target groups on how to use the service

Documentation Structure

Title

The titles of the documents for the individual SOA entities correspond to the names that were used in the business models to describe the objects.

In following releases, the message interfaces are called operations . For this reason, the message interfaces are now called (service) operations in the documentation.

Technical Data

The technical data of the operations includes the names of the operations as objects in the

Enterprise Service Repository (ESR) and specifies what the associated Web service definitions are called.

Documentation

In addition to the technical data, the documentation includes the definitions of the relevant

SOA entities as they can be found in the business models. The following sections describe the business use of the objects and their position within the business model. If the data structures of the operation’s message types have special features, these are described in the

Requirements, Structure, and Error Handling sections. Information that is valid for all objects of a process component, business object, or service interface is grouped together for each object.

All special features that are based on the implementation of the service and the processing of messages in the SAP back-end system are described in the Notes for SAP Back-End System

Administration section.

Tables of Technical Data

The following tables explain the meaning of the individual entries in the tables of technical data.

Entity

Type

Entry in the Table

Meaning t

Process componen

Software

Compone nt

Name of the software componen t in the

SAP back-end system with the release number as of which the implement ation of the services of this


SAP Documentation

Business object

Service interface

ES for SAP ERP 2005

Software

Compone nt

Software

Compone nt

Category

Mode

Enterprise SOA process componen t is available


SAP back-end system with the release number as of which the implement ation of the services of this business object is available


SAP back-end system with the release number as of which the implement ation of the services of this service interface is available

Informatio n indicating whether this is an inbound or outbound interface

Informatio n

94

SAP Documentation

Service operation

ES for SAP ERP 2005

Technical

Name in

Enterprise

Service

Repositor y (ESR)

Namespa ce in ESR

Software

Compone nt Version in ESR

Category

Enterprise SOA

The software componen t version indicates the release status of the SAP back-end as of which the operation is available.

The namespac e indicates the SAP back-end software componen t in which the specified business logic of the operation is stored.

Informatio n indicating whether this is an inbound or outbound operation indicating whether the interface supports synchrono us or asynchron ous processin g

Unique name of the operation in ESR

95

SAP Documentation

Mode

Related

Web

Service

Definition

Enterprise SOA

Informatio n indicating whether the operation is used for synchrono us or asynchron ous processin g

Name of the Web service definition

SAP: Important Disclaimers and Legal Information

The services delivered by SAP for mySAP Business Suite are developed in two steps. First, the services are defined independent of an actual implementation. To do this, they are presented uniformly in a business object model that is valid in general. The models represent the business content of mySAP Business Suite in a simple and structured form.

You can view the models on the Enterprise Service Workplace in SAP

Developer Network (SDN) at sdn.sap.com

Enterprise SOA

ES Workplace .

Second, SAP implements the objects required for realizing the services in the SAP system as

ABAP entities.

The uniform and structured view that the business models provide for the functions of mySAP

Business Suite is also used for structuring the documentation. Therefore, objects are described in the documentation that do not have a direct correspondent in an SAP system.

These consist of the following objects: process components, business objects, and service interfaces. The description of these objects provides you with an overview of the actual business process in which you can use the services delivered by SAP.

The implementations of service operations are available as part of the delivery of mySAP

Business Suite enterprise services package .

Enterprise Services for SAP ERP Cross-

Application Components



Enterprise Services for SAP ERP Foundation

Business Partner Data Processing

The process component Business Partner Data Processing is a part of the ERP foundation. The business content described here refers only to the enterprise services relevant to SAP ECC.

Definition

Includes all basic data on employees and business partners.

Use

You can use the Business Partner Data Processing process component to manage all business partner data that is necessary for controlling business processes such as Sales and

Distribution, Purchasing, and Accounting. You can also use this process component to provide services for queries related to person-specific information on employees, as well as information along the organizational structure.

Notes for SAP Back-End System Administration

Processing

Take into account the following behavior of the change and update operations of this process component when you use it:

The data transferred by request messages overwrites only those affected objects in the databases of the back-end system that are also filled in the message structure. This also applies to the individual items of list-like elements.

This means that if optional elements are not filled in a request message, the back-end system leaves the values as they are in the affected fields in the database. The only exception to this behavior is when these values are automatically updated due to changes to other data.

Employee

Technical Data

Entity Type

Software Component

Business object mySAP ERP enterprise services package (as of ECC-SE 501)

Definition

Person who contributes, or has contributed to, the creation of goods and services within the enterprise.

This includes internal and external employees. As opposed to external employees, internal employees are bound by instructions and are subject to job-related organizational control.



Use

The Employee business object is a fundamental object that cannot be assigned to a specific process component. It is used in both the Personnel Administration process component and in Organisational Management .

From a Personnel Administration perspective, the business object includes data, such as, name, address data, communication data and the employee's photo.

Each employee is also part of an organizational structure within the company. From an

Organisational Management perspective, the business object includes data, such as, the

Organisational Centre that the employee belongs to, the responsible manager and all employees that belong to this Organisational Centre .

Related Business Objects

Work Agreement [Seite 647 ]

Employment [Seite 645 ]

An employee's tasks and responsibilities are specified in the Work Agreement . This work agreement establishes Employment . It forms the basis for further agreements such as working times and salary data that are specified in other business objects.


Prerequisites

You use the SAP ECC Enterprise Extension Human Capital Management (EA-HR) .

Manage Employee In

Technical Data

Entity Type


Category

Mode

Service interface mySAP ERP enterprise services package (as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that retrieves personal information about an employee and creates, changes, or deletes an employee's Personal Address via several Employee interfaces.

Use

The Manage Employee In inbound service interface contains operations that read specific personal information regarding an employee, for example, personal data, name, photo, and family members or related persons. In addition, the service interface groups operations that create, change, and delete an employee's Personal Address .

Integration

This inbound service interface is part of the Business Partner Data Processing [Seite 97 ] process component and the Employee [Seite 97 ] business object.



Structure

The Manage Employee In inbound service interface contains the following inbound operations:

EmployeeBasicDataByEmployeeQueryResponse_In ( Read Employee Basic

Data [Seite 99 ] )

EmployeeNameByEmployeeQueryResponse_In ( Read Employee Name [Seite

100 ] )

EmployeePhotoByEmployeeQueryResponse_In ( Read Employee Photo [Seite

101 ] )

EmployeePersonalAddressCreateRequestConfirmation_In ( Create Personal

Address [Seite 102 ] )

EmployeePersonalAddressChangeRequestConfirmation_In ( Change

Personal Address [Seite 105 ] )

EmployeePersonalAddressCancelRequestConfirmation_In ( Cancel

Personal Address [Seite 106 ] )

EmployeeDependantByEmployeeQueryResponse_In ( Read Employee

Dependant [Seite 107 ] )

Read Employee Basic Data

Technical Data

Entity Type

Technical Name in Enterprise Service

Repository (ESR)

Namespace in ESR

Software Component Version in ESR

Category

Mode

Related Web Service Definition

Operation

EmployeeBasicDataByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound

Synchronous

ECC_EmployeeBasicDByEmployeeQR

Definition

Provides personal data on an employee.

Use

The Read Employee Basic Data inbound operation reads employee information from the

Personal Data infotype (0002).

Features

The inbound operation processes the following message types:

EmployeeBasicDataByEmployeeQuery

In this message, you have to fill the Employee_ID or the WorkAgreement_ID.



EmployeeBasicDataByEmployeeResponse

The message returns an employee's personal data, sorted using the following criteria:

General Personal Data:

Name

Gender

Place of Birth

Postal Code Place of Birth

Date of Birth

Marital Status

Date of Change of Marital Status

Number of Children

Correspondence Language

Nationality:

Country Indicator

For multiple nationalities, the message returns all appropriate country indicators.

The output is based on key dates.

Error Handling

The Employee_ID entered does not exist for the key date entered.

The WorkAgreement_ID entered does not exist for the key date entered.

The WorkAgreement_ID entered does not belong to the Employee_ID entered.

Integration

This inbound operation belongs to the Manage Employee [Seite 98 ] inbound service interface.


Processing

If you do not enter a key date in the query, the system uses the current date as the default value.

The Business Add-In (BAdI) PAD_ESA_BASIC_CONV (Conversions for Proxy: Employee

Basic Data) is available for this operation. For more information about this BAdI, see the

Implementation Guide for Enterprise Services under Business Partner Data Processing .

Read Employee Name

Technical Data

Entity Type



Operation

EmployeeNameByEmployeeQueryResponse_In





Category

Mode

Related Web Service Definition http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound

Synchronous

ECC_EmployeeNameByEmployeeQR

Definition

Provides Employee Name .

Use

The employee name consists of various parts, for example, name format, first name, preferred first name, name at birth, and name affix.

The Read Employee Name inbound operation provides all relevant name components for an employee.

Features

The Read Employee Name inbound operation processes the following message types:

EmployeeNameByEmployeeQuery


EmployeeNameByEmployeeResponse

The message returns the employee's name based on key dates.

Error Handling




Integration



Processing


The Business Add-In (BAdI) PAD_ESA_NAME_CONV ( Conversions for Proxy: Employee

Name ) is available for this operation. For more information about this BAdI, see the

Implementation Guide for Enterprise Services under Business Partner Data Processing .

Read Employee Photo

Technical Data

Entity Type Service operation







Category

Mode


EmployeePhotoByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound

Synchronous

ECC_EmployeePhotoByEmployeeQR

Definition

Provides an employee's photo.

Features


EmployeePhotoByEmployeeQuery


EmployeePhotoByEmployeeResponse

The message returns the photo in a binary format.

If you enter an earliest change date, the message only provides the employee photo if it was created or changed after this date. If you do not enter an earliest change date, the last photo is returned, regardless of when it was created or last changed.

Error Handling




Integration



Processing

If you do not enter a key date in the query, the system uses the lowest system date

(18000101) as the default value.

Create Personal Address

Technical Data

Entity Type




Operation

EmployeePersonalAddressCreateRequestConfirmation_In http://sap.com/xi/EA-HR/SE/Global




Category

Mode


As of ECC-SE 600

Inbound

Synchronous

ECC_EMPPERSADDRCRTRC

Definition

Creation of a Personal Address .

Use

The Create Personal Address inbound operation transfers the personal address to the backend system for a single employee.

Features

The Create Personal Address inbound operation processes the following message types:

EmployeePersonalAddressCreateRequest

In this message, you must fill the Employee_ID, the Address_UsageCode, and the data for the PhysicalAddress .

EmployeePersonalAddressCreateConfirmation

The request and confirmation messages contain the following fields:

PhysicalAddress

Contains the address data of a physical address. It consists of the following address components:

CountryCode

Contains the country key.

RegionCode

Contains the encoded description for regions that belong together under logical, geographical, or political criteria.

StreetPostalCode

Contains the encoded description of a postal code.

CityName

Contains the name of the city.

DistrictName

Contains the name of a city district.

StreetName

Contains the name of the street.

StreetPrefixName

Contains a prefix for the street name.

HouseID

Contains the unique identifier of a building or a building complex.

CareOfName



Addition to the address if the recipient differs from the addressee.

Communication

Contains information about paths of communication that can be used to contact a person or an organization. This consists of the following data:

Telephone

Only the Number field below is used for this.

Number

Contains the telephone number with country code and area code, connection number, and extension number.

ValidityPeriod

Contains the period in which the AddressAssignment (assignment of an address to the work agreement) is valid.

Error Handling

You have not specified the Employee_ID or the Address_UsageCode in the message.

The WorkAgreement_ID entered does not exist in the validity period specified for the

AddressAssignment .

Integration



Processing

If you have not specified a validity period in the request, the system uses the current date as the start date and the highest system date (12/31/9999) as the end date.

The following Address_UsageCodes are supported:

HCM001 – Private address

HCM003 – Permanent residence

HCM004 – Temporary address

HMC005 – Home address

HCM006 – Emergency address

You can use a BAdI to use customer-specific Address_UsageCodes as well.

The following Business Add-Ins (BAdI) are available for this operation:

PAD_ADDR_SUBTY_CONV (C onversions for Proxy: Subtype Mapping for Employee

Address )

You can use this BAdI to change the Address Subtype Mapping Address_UsageCode delivered in the standard system and to use your own Address_UsageCodes.

PAD_ESA_ADDRESS_UPDATE_CONV ( Enhancements for Address Update

Services )

You can use this BAdI to change standard mappings between fields on the user interface and fields in the back-end system and to define your own mappings.



Change Personal Address

Technical Data

Entity Type

Technical Name in Enterprise

Service Repository (ESR)


Software Component Version in

ESR

Category

Mode


Operation

EmployeePersonalAddressChangeRequestConfirmation_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_EMPPERSADDRCHGRC

Definition

Change of a Personal Address .

Use

The Change Personal Address inbound operation transfers the change to the Personal

Address to the back-end system for a single employee.

Features

The Change Personal Address inbound operation processes the following message types:

EmployeePersonalAddressChangeRequest

In this message, you must fill the Employee_ID, the Address_ID, and the data for the

PhysicalAddress.

EmployeePersonalAddressChangeConfirmation

The request and confirmation messages contain the following fields:

PhysicalAddress

Contains the address data of a physical address. It consists of the following address components:

CountryCode

Contains the country key.

RegionCode

Contains the encoded description for regions that belong together under logical, geographical, or political criteria.

StreetPostalCode

Contains the encoded description of a postal code.

CityName

Contains the name of the city.

DistrictName

Contains the name of a city district.



StreetName

Contains the name of the street.

StreetPrefixName

Contains a prefix for the street name.

HouseID

Contains the unique identifier of a building or a building complex.

CareOfName

Addition to the address if the recipient differs from the addressee.

Communication

Contains information about paths of communication that can be used to contact a person or an organization. This consists of the following data:

Telephone

Only the Number field below is used for this.

Number

Contains the telephone number with country code and area code, connection number, and extension number.

Error Handling

You have not specified the Employee_ID or the Address_ID in the message.

The specified Address_ID does not belong to the Employee_ID entered.

Integration



Processing


PAD_ADDR_SUBTY_CONV (C onversions for Proxy: Subtype Mapping for Employee

Address )

You can use this BAdI to change the Address Subtype Mapping Address_UsageCode delivered in the standard system and to use your own Address_UsageCodes.

PAD_ESA_ADDRESS_UPDATE_CONV ( Enhancements for Address Update

Services )

You can use this BAdI to change standard mappings between fields on the user interface and fields in the back-end system and to define your own mappings.

Cancel Personal Address

Technical Data

Entity Type Operation





EmployeePersonalAddressCancelRequestConfirmation_In

Namespace in ESR http://sap.com/xi/EA-HR/SE/Global

Software Component Version in ESR As of ECC-SE 600

Category

Mode


Inbound

Synchronous

ECC_EMPPERSADDRCNCRC

Definition

Deletion of a Personal Address .

Use

The Cancel Personal Address inbound operation transfers the deletion of the Personal

Address to the back-end system for a single employee.

Features

The Cancel Personal Address inbound operation processes the following message types:

EmployeePersonalAddressCancelRequest

In this message, you have to fill the Employee_ID and the Address_ID.

EmployeePersonalAddressCancelConfirmation

Error Handling

You have not specified the Employee_ID or the Address_ID in the message.

The specified Address_ID does not belong to the Employee_ID entered.

Integration


Read Employee Dependant

Technical Data

Entity Type





Category

Mode


Operation

EmployeeDependantByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound

Synchronous

ECC_EmployeeDependentByEmpQR

Definition

Retrieves information about Employee Dependants .



Use

The Read Employee Dependant inbound operation reads information from the Family/Related

Persons infotype (0021).

Features


EmployeeDependantByEmployeeQuery


EmployeeDependantByEmployeeResponse

The message returns an employee's family members or related persons, sorted using the following criteria:

Dependant Relationship:

Dependant

ValidityPeriod

RoleCode

The DependantRelationship includes time-dependent information about an employee's family members and related persons. Dependants are persons affiliated with the employee through birth, marriage, or a comparable legal relationship (for example, adoption). The RoleCode defines this related or legal affiliation between the employee and the Dependant .

General Data on the Dependant :

Name

Gender

Place of Birth

Postal Code Place of Birth

Date of Birth

Marital Status

Nationality:

Country Indicator

For multiple nationalities, the message returns all appropriate country indicators.

Error Handling

The Employee_ID entered does not exist for the validity period of the

DependantRelationship .

The WorkAgreement_ID entered does not exist for the validity period of the

DependantRelationship .


The DependantRelationshipRoleCode (or RoleCode ) is invalid.

Integration





Processing

If you have not specified a validity period for the DependantRelationship in the request, the system uses the lowest system date (18000101) as the start date and the highest system date (99991231) as the end date for the validity period.

The following DependantRelationshipRoleCodes are supported:

Supported RoleCodes

DependantRelationshipRoleCode

BUR0004-0

BUR0021-1

Subtype of Family/Related Person infotype

(0021)

1 (Spouse)

2 (Child)

BUR0022-2 5 (Guardian)

The following Business Add-Ins (BAdIs) are available for this operation:

PAD_FAM_SUBTY_CONV ( Conversions for Proxy: Subtype Mapping for Employee

Dependants )

PAD_ESA_DEPNDNT_CONV ( Conversions for Proxy: Employee Dependants )

For more information about these BAdIs, see the Implementation Guide for Enterprise

Services under Business Partner Data Processing .

Query Employee In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for retrieving organizational information about an employee using individual Employee interfaces.

Use

The Query Employee In inbound service interface groups operations that provide information along the reporting structure such as the line manager of an employee, the employees that report to the same manager, the employees with the same organizational affiliation

( Organisational Centre ), and data that is required for oral, written, and electronic communication with an employee.

Related Service Interfaces

Manage Employee [Seite 98 ]



Integration

This inbound service interface is part of the Business Partner Data Processing [Seite 97 ] process component and the Employee [Seite 97 ] business object.

Structure

The Query Employee In inbound service interface contains the following inbound operations:

ReportingLineManagerSimpleByEmployeeQueryResponse_In ( Find Reporting

Line Manager by Employee [Seite 110 ] )

ReportingEmployeeByEmployeeQueryResponse_In ( Find Reporting Employee by Employee [Seite 111 ] )

ReportingLinePeerSimpleByEmployeeQueryResponse_In ( Find Reporting

Line Peer by Employee [Seite 113 ] )

OrganisationalCentreEmployeeSimpleByEmployeeQueryResponse_In

( Find Organisational Centre by Employee [Seite 114 ] )

EmployeeAddressByEmployeeQueryResponse_In ( Find Employee Address

[Seite 115 ] )

EmployeeCommunicationDataByEmployeeQueryResponse_In ( Find Employee

Communication Data [Seite 117 ] )

EmployeeSimpleByWorkCentreQueryResponse_In ( Find Employee by Work

Centre [Seite 118 ] )

Find Reporting Line Manager by Employee

Technical Data

Entity Type





ESR

Category

Mode


Operation

ReportingLineManagerSimpleByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound

Synchronous

ECC_RptLineMgSEEQR

Definition

Provides employees that have personnel responsibility for a particular employee (line manager).

Features




ReportingLineManagerSimpleByEmployeeQuery

In this message, you have to fill the Employee_ID or the WorkAgreement_ID. If you only fill the Employee_ID, the system determines all associated WorkAgreement_IDs and reads the respective direct managers for them.

ReportingLineManagerSimpleByEmployeeResponse

The message returns the information, sorted using the following criteria:

ID

PersonFormattedID

WorkAgreement

The output is based on key dates. The message always returns the WorkAgreement .

Error Handling




Integration

This inbound operation belongs to the Query Employee [Seite 109 ] inbound service interface.


Processing


Find Reporting Employee by Employee

Technical Data

Entity Type





Category

Mode


Operation

ReportingEmployeeByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ESA ECC-SE 501

Inbound

Synchronous

ECC_RptEEEEQR

Definition

Provides the employees that report to a particular employee.

Features




ReportingEmployeeByEmployeeQuery

In this message, you have to fill the Employee_ID or the WorkAgreement_ID. If you fill the Employee_ID only, the system reads the data on all of the employee's existing

WorkAgreements .

ReportingEmployeeByEmployeeResponse

The message returns the employee, sorted using the following criteria:

ID

PersonFormattedName

EmployeeAssignment:

Position

OrganisationalCentreManagingPositionIndicator

OrganisationalCentreAssignment

OrganisationalCentre_ID, Organisational Centre Name,

OrganisationalCentreBusinessCharacterCode

Work Agreement

Depending on the selection criteria, the message returns employees that report either directly or indirectly to a particular employee. The message also includes important data on the personnel area of responsibility. The

OrganisationalCentreManagingPositionIndicator specifies whether the position is an executive position within an organizational unit.

The OrganisationalCentreBusinessCharacterCode specifies the type of

OrganisationalCentre.


Constraints

In this release, only OrganisationalCentreBusinessCharacterCode 9 is permitted for

Reporting Line Unit.

Error Handling




Integration

This inbound operation belongs to the Query Employee [Seite 109 ] service interface.


Processing




Find Reporting Line Peer by Employee

Technical Data

Entity Type





Category

Mode


Operation

ReportingLinePeerSimpleByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound

Synchronous

ECC_RptLinePeerSEEQR

Definition

Provides the ReportingLinePeerSimple .

Use

The Find Reporting Line Peer by Employee inbound operation reads all employees that report to the same manager as a particular employee that you specify.

Features


ReportingLinePeerSimpleByEmployeeQuery

In this message, you have to fill the Employee_ID or the WorkAgreement_ID. If you only fill the Employee_ID, the system first determines all existing WorkAgreements that are linked to this Employee_ID and reads the ReportingLinePeerSimple from here.

ReportingLinePeerSimpleByEmployeeResponse


ID


WorkAgreement


Error Handling




Integration





Processing


Find Organisational Centre Employee by

Employee

Technical Data

Entity Type

Technical Name in





Version in ESR

Category

Mode

Related Web Service

Definition

Operation

OrganisationalCentreEmployeeSimpleByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound

Synchronous

ECC_OrgCtrSEEQR

Definition

Retrieves the OrganisationalCentreEmployeeSimple .

Use

The Find Organisational Centre Employee by Employee inbound operation reads all employees that belong to the same OrganisationalCentre as a particular employee that you specify.

Features


OrganisationalCentreEmployeeSimpleByEmployeeQuery

In this message, you have to fill the Employee_ID or the WorkAgreement_ID. If you only fill the Employee_ID, the system first determines all existing WorkAgreements that are linked to this Employee_ID and reads the OrganisationalCentreEmployeeSimple from here.

OrganisationalCentreEmployeeSimpleByEmployeeResponse


ID


WorkAgreement




Error Handling




Integration

The inbound operation belongs to the Query Employee [Seite 109 ] inbound service interface.


Processing


Find Employee Address by Employee

Technical Data

Entity Type





Category

Mode


Operation

EmployeeAddressByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_EmpAddrEmpQR

Definition

Retrieves an employee's address data.

Use

The Read Employee Address inbound operation provides structured information about an employee's various addresses. This includes, for example, information about the Organisation

Address and home address.

Features


EmployeeAddressByEmployeeQuery

If you fill only the Employee_ID in this message, the system first determines all existing WorkAgreement_IDs that are linked to this Employee_ID and reads the respective address data for each of these Work Agreements .

If you fill the WorkAgreement_ID, the system determines the specific address data for this Work Agreement .



If you fill the Employee_ID and the WorkAgreement_ID, the system checks whether the WorkAgreement_ID belongs to this Employee_ID. If this is the case, the system reads the address data for this Work Agreement .

EmployeeAddressByEmployeeResponse

The message returns the data, sorted using the following criteria:

ID

Address

AddressTypeCode

AddressUsageCode

The AddressTypeCode defines the address type, such as Organisation Address ,

Personal Address , or Workplace Address . If no AddressTypeCode is specified in the query, the message returns all of the employee's addresses.

The AddressUsageCode is only relevant in connection with Personal Address as the

AddressTypeCode . It defines the address type, such as permanent residence, emergency address, and so on.


Error Handling




The AddressTypeCode is invalid.

The AddressUsageCode is invalid.

Integration



Prerequisites

If you want to use the AddressTypeCode 2 (Personal address) as the selection criterion, you must have maintained the Addresses infotype (0006) for your employees in the SAP backend system.

If you want to use the AddressTypeCode 3 (Workplace address) as the selection criterion, you must have maintained the Internal Data infotype (0032) for your employees in the SAP back-end system.

Processing


The following AddressTypeCodes are supported:

2 - Personal address

3 - Workplace address

1 - Organisation address



The following AddressUsageCodes are supported:

HCM001 – Private address

HCM003 – Permanent residence

HCM004 – Temporary address

HMC005 – Home address

HCM006 – Emergency address

You can also implement a BAdI so you can use customer-specific AddressUsageCodes .


PAD_ADDR_SUBTY_CONV ( Conversions for Proxy: Subtype Mapping for Employee )

PAD_ESA_ADDRESS_CONV ( Conversions for Proxy: Employee Address )

For more information about these BAdIs, see the Implementation Guide for Enterprise

Services under Business Partner Data Processing .

Find Employee Communication Data by Employee

Technical Data

Entity Type





ESR

Category

Mode


Operation

EmployeeCommunicationDataByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound

Synchronous

ECC_EmpCommDataEmpQR

Definition

Retrieves information for communicating with an employee.

Use

The Read Employee Communication Data inbound operation reads communication data from the Communication infotype (0105) that is not dependent on the address. Typical communication data that is not included in the address is e-mail address and telephone number, for example. The service also returns information such as the fax number.

The private telephone number is read from subtype 1 of the Addresses infotype (0006).

Features


EmployeeCommunicationDataByEmployeeQuery



If you fill only the Employee_ID in this message, the system first determines all existing WorkAgreement_IDs that are linked to this Employee_ID and reads the respective communication data for each of these Work Agreements .

If you fill the WorkAgreement_ID, the system determines the specific communication data for this Work Agreement .

If you fill the Employee_ID and the WorkAgreement_ID, the system checks whether the WorkAgreement_ID belongs to this Employee_ID. If this is the case, the system reads the communication data for this Work Agreement .

EmployeeCommunicationDataByEmployeeResponse


Telephone

(Telephone number, TelephoneUsage )

Fax

E-mail address

Pager

TelephoneUsage specifies whether it is a private or business connection. The telephone number also includes the cell phone number.


Error Handling




Integration



Prerequisites

You have maintained the Communication infotype (0105) for your employees in the SAP back-end system.


Processing

The Business Add-In (BAdI) PAD_ESA_COMM_CONV ( Conversions for Proxy: Employee

Communication Data ) is available for this operation. For more information about this BAdI, see the Implementation Guide for Enterprise Services under Business Partner Data

Processing .

Find Employee by Work Centre

Technical Data



Entity Type





Category

Mode


Operation

EmployeeSimpleByWorkCentreQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_WORKCENTRE001QR ????

Definition

Provision of the Employee_ID of employees.

Use

The Find Employee by Work Centre inbound operation reads to a Work Centre all employees that are assigned to this Work Centre .

Features


EmployeeSimpleByWorkCentreQuery

In this message, you have to fill the WorkCentre_ID and the Plant_ID. Both parameters are mandatory as the WorkCentre_ID is unique only when used in connection with the

Plant_ID.

EmployeeSimpleByWorkCentreResponse


Employee_ID


WorkAgreement_ID

Error Handling

The WorkCentre_ID entered does not exist in the specified validity period.

The Plant_ID entered does not exist in the specified validity period.

The WorkCentre_ID entered does not belong to the Plant_ID entered.

Integration



Processing

If you do not enter a validity period in the query, the system uses the current date as the start date and the end date.



Customer

Technical Data

Entity Type



Definition

A Customer is a business partner who is offered or sold materials or services.

Use

Sales employees need to have information about customers so they can create sales documents (for example, queries or contracts), get a quick overview of a customer, or simply contact a customer.

Information about whether a customer exists already, and basic information including address and contact details can be crucial for a business transaction.

The business object Customer is a projection of the business object Business Partner . The following element displays the business object.

ID (Mandatory)

The ID uniquely identifies the customer.


Prerequisites

To use the operations in this business object, you must implement the software component

SAP_APPL as well as the component Sales (SD-SLS) . You have also performed the basic

Customizing settings for the component.

Manage Customer In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations that provide information about a customer.

Use

The inbound service interface Manage Customer In groups operations that sales employees can use to read or process data about a customer.



Integration

The inbound service interface Manage Customer In is part of the Business Partner Data

Processing [Seite 97 ] process component and the Customer [Seite 120 ] business object.

Structure

The Manage Customer In inbound service interface contains the following inbound operations:

CustomerBasicDataByIDQueryResponse_In ( Read Customer Basic Data [Seite 121 ] )

CustomerBasicDataChangeRequestConfirmation_In ( Change Customer Basic Data

[Seite 122 ] )

Read Customer Basic Data

Technical Data

Entity Type





Category

Mode


Service operation

CustomerBasicDataByIDQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_CUSTOMER001QR

Definition

Query to and response from Business Partner Data Processing to retrieve basic information about a customer. The basic data contains the general data about a customer as well as address and communication data.

Use

Sales employees use the inbound operation Read Customer Basic Data to display data about a customer, to create sales documents (for example, queries and contracts), or contact a customer.

Features

This inbound operation processes the following message types:

CustomerBasicDataByIDQuery_sync

CustomerBasicDataByIDResponse_sync

The ID of the customer must be filled out. The general data ( Common ) must be supplied.

Error Handling

If errors occur, the process is terminated and a corresponding message is sent to the application.



Integration

This inbound operation belongs to the Manage Customer In [Seite 120 ] inbound service interface.


Prerequisites

For more information, see Customer [Seite 120 ] .

Processing

You can use the Business Add-In (BAdI) BPC_CUSTOMERBASICDATAIDQR for this operation.

Change Customer Basic Data

Technical Data

Entity Type

Technical Name in Enterprise Services




Category

Mode


Service operation

CustomerBasicDataChangeRequest

Confirmation_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_CUSTOMERBASICDATACHGRC

Definition

Query to and confirmation from Business Partner Data Processing to change customer basic data.

Use

Sales employees can use the Change Customer Basic Data inbound operation to change customer basic data.

Features


CustomerBasicDataChangeRequest_sync

CustomerBasicDataChangeConfirmation_sync

Error Handling


Integration

This inbound operation belongs to the Manage Customer In [Seite 120 ] inbound service interface.



Constraints

You can only change the standard telephone and fax numbers, not the telephone and fax numbers entered additionally. It is also not possible to change cell phone numbers.


Prerequisites


Processing

You can use the Business Add-In (BAdI) BPC_SE_CUST_CBD_RC for this operation.

Query Customer In

Technical Data

Entity Type


Category

Mode

Service interface mySAP ERP enterprise services package

(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that enable customers to be searched for, restricted according to different criteria.

Use

The Query Customer In inbound service interface contains operations that sales employees can use to search for customers according to certain criteria.

Integration

The Query Customer In inbound service interface is part of the Business Partner Data

Processing [Seite 97 ] process component and the Customer [Seite 120 ] business object.

Structure

The Query Customer In inbound service interface contains the following inbound operations:

CustomerSimpleByAddressQueryResponse_In ( Find Customer by Address [Seite

123 ] )

Find Customer by Address and Contact Person

Technical Data








Category

Mode


CustomerSimpleByAddressQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_CUSTOMER002QR

Definition

Query to and response from Business Partner Data Processing to retrieve customers according to name and address.

Use

Sales employees use the Find Customer by Address inbound operation to select a customer according to address, to create sales documents or contact customers, for example.

Features


CustomerSimpleByAddressQuery_sync

CustomerSimpleByAddressResponse_sync

You must fill out at least one selection criterion.

Error Handling


Integration

This inbound operation belongs to the Query Customer In [Seite 123 ] inbound service interface.


Prerequisites


Processing

You can use the Business Add-In (BAdI) BPC_CUSTOMERSNAMEADDRESSQR for this operation.

Supplier

Technical Data

Entity Type


ES for SAP ERP 2005


124


Definition

A Supplier is a business partner who offers or sells materials or services.

Use

Purchasing employees need to have information about suppliers so they can create purchasing documents (for example, purchase requisitions, inbound deliveries, or purchase orders), get a quick overview of a supplier, or just contact a supplier.

Information about whether a supplier already exists, and basic information including address and contact details can be crucial for a business transaction.

The business object Supplier is a projection of the business object Business Partner . The following element displays the business object.

ID (Mandatory)

The ID uniquely identifies the customer.



SAP_APPL .

Query Supplier In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations that enable suppliers to be searched for, restricted according to different criteria.

Use

The inbound service interface Query Supplier In contains operations that purchasing employees can use to search for suppliers according to certain criteria.

Integration

The inbound service interface Query Supplier In is part of the Business Partner Data

Processing [Seite 97 ] process component and the Supplier [Seite 124 ] business object.

Structure

The inbound service interface Query Supplier In contains the following inbound operations:

SupplierSimpleByNameAndAddressQueryResponse_In ( Find Supplier by Name and

Address [Seite 126 ] )



Find Supplier by Name and Address

Technical Data

Entity Type





Category

Mode


Service operation

SupplierSimpleByNameAndAddressQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_SUPPLIERSNAQR

Definition

Query to and response from Business Partner Data Processing to retrieve a supplier according to name and address.

Use

Purchasing employees use the inbound operation Find Supplier By Name and Address to select a supplier according to name and address, to create purchasing documents or contact a supplier for example.

Features


SupplierSimpleByNameAndAddressQuery_sync

SupplierSimpleByNameAndAddressResponse_sync

You must fill out at least one selection criterion. The selection criterion should be specific to avoid timeout or memory errors.

Error Handling


Integration

This inbound operation belongs to the Query Supplier In [Seite 125 ] inbound service interface.


Processing




Supplier Product Category By Id Query

Response_In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

The SupplierProductCategoryByIdQueryResponse_In inbound service interface groups operations that operations that lists all supplier product categories of one supplier.

Integration

The inbound service interface SupplierProductCategoryByIdQueryResponse_In is part of the

Business Partner Data Processing [Seite 97 ] process component and the Supplier [Seite 124 ] business object.

Structure

This inbound service interface contains the SupplierProductCategoryByIdQueryResponse_In

[Seite 127 ] inbound operation.

Read Supplier Product Category

Technical Data

Entity Type





Category

Mode


Service operation

SupplierProductCategoryByIdQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_SUPPLPRODCATBYIDQR

Definition

The SupplierProductCategoryByIdQueryResponse_In inbound service interface groups operations that lists all supplier product categories of one supplier.

Features


Supplier Product Category by ID Query

(SupplierProductCategoryByIdQueryMessage_sync)



Supplier Product Category by ID Response

(SupplierProductCategoryByIdResponseMessage_sync)

Integration

This inbound operation belongs to the Supplier Product Category By Id Query Response_In

[Seite 127 ] inbound service interface.


Processing

You can use the Business Add-In (BAdI) PUR_SE_SUPPLPRODCATBYIDQR for this operation.

Sales Arrangement

Technical Data

Entity Type



Definition

Arrangement between a sales department and a customer for transacting sales. The arrangement deals with, for example, payment conditions, invoice currency, and Incoterms.

The arrangement in no way represents a contract with the customer.

Use

A sales employee needs the detailed information from a sales arrangement to plan and carry out sales transactions with a customer.


Customer

Sales Unit


To use the operations contained in the business object, you must implement SAP ECC Sales and Distribution (SD) and have knowledge from Master Data Business Partners

Customers and from the Sales Summary.

Query Sales Arrangement In

Technical Data

Entity Type





Category

Mode

Inbound

Synchronous

Definition

Group of operations that allow you to search for sales arrangements.

Use

The inbound service interface Query Sales Arrangement In contains operations that sales employees can use to search for sales arrangements according to different selection criteria.

Integration

The inbound service interface Query Sales Arrangement In belongs to the process component Business Partner Data Processing [Seite 97 ] and to the business object Sales

Arrangement [Seite 128 ] .

Structure

The inbound service interface Query Sales Arrangement In contains the following inbound operations:

SalesArrangementSimpleByCustomerIDQueryResponse_In ( Find Sales Arrangement by Customer ID [Seite 129 ] )

Find Sales Arrangement by Customer

Technical Data

Entity Type





Category

Mode


Service operation

SalesArrangementSimpleByCustomerID

QueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_SALESARRANGEMENTSBCQR

Definition

Query to and response from Business Partner Data Processing to retrieve data about sales arrangements according to customer.

Use

Sales employees can use the Find Sales Arrangement by Basic Data inbound operation to search for a sales arrangement, restricted by customer.

Features


SalesArrangementSimpleByCustomer IDQuery



SalesArrangementSimpleByCustomerIDResponse

Error Handling


Integration

This inbound operation belongs to the Query Sales Arrangement In [Seite 128 ] inbound service interface.


Prerequisites

For more information, see Sales Arrangement [Seite 128 ] .

You have also performed the basic Customizing settings for the Sales (SD-SLS) component .

Processing

You can use the Business Add-In (BAdI) BPC_SE_SALESARRANGEMENTSBCQR for this operation.

Identity Management

The Identity Management process component is part of the ERP foundation.

The business content described here refers only to the enterprise services relevant to SAP ECC.

Definition

Manages the identity of users in a system landscape and controls their access to the systems by assigning user authorizations and restrictions.

Use

You use the Identity Management process component to manage the identity of users, such as permanent and fixed-term employees, or business partners. This includes creating system users, assigning system resources, assigning to various back-end systems, and assigning the appropriate access rights.

Identity

The Identity business object is part of the ERP foundation. The business content described here refers only to the enterprise services relevant to SAP ECC.



Definition

Summary of all User Accounts for a person or a user in a system landscape, as well as all settings that are required for accessing systems, and the associated user authorizations and restrictions.

User Accounts contain information that controls a user’s access to a system.

Use

The Identity business object enables the credentials of a person or a technical user for accessing systems within a system landscape. This includes the assigned authorizations and the system settings that are valid for this person or technical user.

Query Identity In

Technical Data

Entity Type


Category

Mode

Service interface

SAP ERP enterprise services package (as of

ECC-SE 501)

Inbound

Synchronous

Use

The Query Identity inbound service interface contains an operation that makes it possible to search for identifying information of people or technical users in a system landscape. It is possible to search for an employee’s system user name with this operation.

Integration

This inbound service interface is part of the Identity Management [Seite 130 ] process component and the Identity [Seite 130 ] business object.

Structure

The Query Identity In inbound service interface includes the

IdentityUserAccountByEmployeeQueryResponse_In inbound operation ( Find User Account by Employee [Seite 131 ] ).

Find User Account by Employee

Technical Data

Entity Type





Category

Operation

IdentityUserAccountByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound



Mode


Synchronous

ECC_IdentityUserAccountEmpQR

Use

The Find User Account by Employee inbound operation reads the related system user name for an employee, based on a key date.

The system user name is read from subtype 0001 System User Name SAP System (SY-

UNAME) of the Communication infotype (0105).

Features


IdentifyUserAccountByEmployeeQuery

If you fill the Employee_ID in this message, the system first determines all existing WorkAgreement_IDs that are linked to this Employee_ID and reads the respective system user name for each of these Work Agreements .

If you fill the WorkAgreement_ID, the system determines the system user name for this specific Work Agreement .

If you fill the Employee_ID and the WorkAgreement_ID, the system checks whether the WorkAgreement_ID belongs to this Employee_ID. If this is the case, the system reads the system user name for this Work Agreement .

IdentifyUserAccountByEmployeeResponse

The message returns the system user names, sorted using the following criteria:

Employee_ID

UserAccount_ID

WorkAgreement_ID


StandardMesssageFault

Integration

This inbound operation belongs to the Query Identity In [Seite 131 ] inbound service interface.


Prerequisites

You have maintained the Communication infotype (0105) for your employees in the SAP back-end system.

Processing


Organisational Management

Technical Data



Entity Type


Process component mySAP ERP enterprise services package (as of ECC-SE 501)

Definition

Manages all organizational structures within a company, such as the organizational plan, functional organizational structure (department hierarchy, for example), and reporting structure.

Use

Company employees are part of the organizational structure. You can use the Organisational

Management process component to provide services for queries relating to information on reporting structure, department hierarchy, and the organizational plan.


Prerequisites

To use the operations contained in the process component, you must implement SAP ECC

Enterprise Extension Human Capital Management (EA-HR).

Organisational Centre

Technical Data

Entity Type



Definition

A business unit belonging to an organizational structure of a company. Examples of such organizational structures are the organizational plan or the company’s financial structure. This kind of unit can assume one or more business roles such as organization, cost center, branch, and reporting line unit.


Cost Centre [Seite 137 ]


Prerequisites

You use SAP ECC Enterprise Extension Human Capital Management (EA-HR).

Query Organisational Centre In

Technical Data

Entity Type Service interface




Category

Mode mySAP ERP enterprise services package (as of ECC-

SE 501)

Inbound

Synchronous

Definition

Group of operations that retrieve information about individual interfaces of the Organisational

Centre In that affect the organizational assignment of the employees and their relevant responsibilities.

Use

A company employee is part of the organizational structure. The Organisational Centre In inbound service interface groups operations that deliver the following information:

An employee’s position within the organization (organizational assignment)

A list of employees who belong to a particular Organisational Unit

The employees who have management responsibilities

Additional organizational structure view windows are available to employees with management responsibilities.

Integration

This inbound service interface is part of the Organisational Management [Seite 132 ] process component and the Organisational Centre [Seite 133 ] business object.

Structure

The Query Organisational Centre In inbound service interface contains the following inbound operations:

OrganisationalCentreSimpleByEmployeeQueryResponse_In ( Find

Organisational Centre by Employee [Seite 134 ] )

OrganisationalCentreEmployeeSimpleByOrganisationalCentreQueryRes ponse_In ( Find Employee by Organisational Centre [Seite 135 ] )

OrganisationalCentreManagerSimpleByOrganisationalCentreQueryResp onse_In ( Find Reporting Line Manager by Organisational Centre [Seite 136 ] )

Find Organisational Centre by Employee

Technical Data




OrganisationalCentreSimpleByEmployeeQueryResponse_In



Category Inbound



Mode


Synchronous

ECC_OrgCtrSEEQR

Definition

Provides the Organisational Centre to which an employee belongs.

Use

The Find Organisational Centre by Employee inbound operation is used to read all

Organisational Centres to which an employee is assigned on a key date.

Related Operations

Find Employee by Organisational Centre [Seite 135 ]

Features


OrganisationalCentreSimpleByEmployeeQuery

In this message, you have to fill the Employee_ID or the WorkAgreement_ID. If you fill only the Employee_ID, the system first determines all existing WorkAgreement_IDs that are linked to this Employee_ID and then reads the related Organisational Centres to which the employee belongs.

OrganisationalCentreSimpleByEmployeeResponse


OrganisationalCentre_ID

OrganisationalCentreName

BusinessCharacterCode

The BusinessCharacterCode defines the type of Organisational Centre .


Constraints

In this release, the BusinessCharacterCode 9 ( Reporting Line Unit ) is supported.

Integration

This inbound operation belongs to the Query Organisational Centre [Seite 133 ] inbound service interface.

Find Employee by Organisational Centre

Technical Data

Entity Type


Service

Repository

(ESR)

Operation

OrganisationalCentreEmployeeSimpleByOrganisationalCentreQueryResponse_In



Namespace in

ESR

Software

Component

Version in ESR

Category

Mode

Related Web

Service

Definition http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound

Synchronous

ECC_OrgCtrEESOrgCtrQR

Definition

Provides all employees that are assigned to a particular organizational unit.

Use

The Find Employee by Organisational Centre inbound operation is used to read all employees who are directly assigned to an Organisational Centre via their positions.


Find Organisational Centre by Employee [Seite 134 ]

Features


OrganisationalCentreEmployeeSimpleByOrganisationalCentreQuery

You must fill the OrganisationalCentre_ID in this message.

OrganisationalCentreEmployeeSimpleByOrganisationalCentreResponse


Employee_ID

PersonFormattedName

WorkAgreement_ID


Integration


Find Manager by Organisational Centre

Technical Data

Entity Type


Service


Operation

OrganisationalCentreManagerSimpleByOrganisationalCentreQueryResponse_In



Namespace in

ESR

Software

Component

Version in ESR

Category

Mode

Related Web

Service Definition http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound

Synchronous

ECC_OrgCtrMgSOrgCtrQR

Definition

Retrieves the employees of an Organisational Centre who have management responsibilities.

Use

The Find Reporting Line Manager by Organisational Centre inbound service operation is used to determine the employees of an Organisational Centre who have management responsibilities for this Organisational Centre .

Features


OrganisationalCentreManagerSimpleByOrganisationalCentreQuery


OrganisationalCentreManagerSimpleByOrganisationalCentreResponse


Employee_ID

PersonFormattedName

WorkAgreement_ID


Integration


Cost Centre

Technical Data

Entity Type



Definition

Organizational center that represents a clearly defined location at which costs arise, and for which costs are entered separately. It can be defined based on functional requirements, allocation criteria, physical location, or responsibility for costs.




Organisational Centre [Seite 133 ]

The Cost Centre is an instance of the Organisational Centre business object.

Prerequisites

You use SAP ECC Enterprise Extension Human Capital Management (EA-HR).

Query Cost Centre In

Technical Data

Entity Type


Category

Mode

Service interface mySAP ERP enterprise services package (as of

ECC-SE 501)

Inbound

Synchronous

Definition

Query to, and response from, the Cost Centre In to determine the Cost Centre of a particular

Organisational Centre .

Use

The Query Cost Centre In inbound service interface includes an operation that gets information about the Cost Centre of an Organisational Centre .

Integration

This inbound service interface is part of the Organisational Management [Seite 132 ] process component and the Cost Centre [Seite 137 ] business object.

Structure

The Query Cost Centre In inbound service interface includes the

OrganisationalCentreCostCentreSimpleByOrganisationalCentreQueryRespon se_In inbound operation ( Find Cost Centre by Organisational Centre [Seite 138 ] ).

Find Cost Centre by Organisational Centre

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)

Namespace in

ESR

Operation

OrganisationalCentreCostCentreSimpleByOrganisationalCentreQueryResponse_In http://sap.com/xi/EA-HR/SE/Global



Software

Component

Version in ESR

Category

Mode

Related Web

Service

Definition

As of ECC-SE 501

Inbound

Synchronous

ECC_OrgCtrCCSOrgCtrQR

Definition

Provides the Cost Centre of a certain Organisational Centre .

Use

The Find Cost Centre by Organisational Centre inbound operation is used to determine the

Cost Centre and information about the controlling area of an Organisational Centre .

Features

The inbound service operation processes the following message types:

OrganisationalCentreCostCentreSimpleByOrganisationalCentreQuery


OrganisationalCentreCostCentreSimpleByOrganisationalCentreRespon se


CostCentre_ID

CostCentreName

ControllingArea_ID

ControllingAreaName


Integration

This inbound operation belongs to the Query Cost Centre [Seite 138 ] inbound service interface.

Programme

Technical Data

Entity Type



Definition

Organisational Centre [Seite 133 ] for managing a group of projects or subprograms for a given time period as part of a planned, large-scale activity.



Use

The Programme business object makes it possible to manage investment programs over a specified period of time.

Manage Programme In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Reads data for investment programs.

Use

The Manage Programme In inbound service interface returns master data, plan values, and budget values for investment programs.

Integration

The Manage Programme In inbound service interface belongs to the Organisational

Management [Seite 132 ] process component and to the Programme [Seite 139 ] business object.

Structure

The Manage Programme In inbound service interface contains the

ProgrammePlanningVersionPlanValueByIDAndPlanningVersionQueryResponse_In ( Read

Programme Plan Value [Seite 140 ] ) inbound operation.

Constraints

The contents of value fields are always output in the controlling area currency.

Read Programme Plan Value

Technical Data

Entity Type





Service operation

ProgrammePlanningVersionPlanValueByIDAnd

PlanningVersionQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global



SAP Documentation

Category

Mode


Enterprise SOA

Inbound

Synchronous

ECC_IM_PROGRAMMEPLAQR

Definition

Reads data of investment program positions for a plan version.

Use

The Read Programme Plan Value inbound operation returns the plan values of investment program positions for a given plan version.

Features


ProgrammePlanningVersionPlanValueByIDAndPlanningVersionQuery_sync

ProgrammePlanningVersionPlanValueByIDAndPlanningVersionResponse_sync

StandardMessageFault

Integration

This inbound operation belongs to the Manage Programme In [Seite 140 ] inbound service interface.

Product Data Management

Technical Data

Entity Type


Process component mySAP ERP enterprise services package

(as of ESA ECC-SE 600)

Definition

The management of all product data that describes a company's tangible and intangible products, and that is used to control business processes such as sales, purchasing, planning, production, and accounting.

Use

The Product Data Management process component enables you to provide applications to find and return material identifiers and to read and return material basic data for your business process.


Currently the system uses the TREX search engine for the search using search text.



Prerequisites

To be able to use the operations contained in this process component, you have to use SAP

ECC .

Processing


The data transferred by the request messages completely overwrites the corresponding objects in the database of the back-end system. The response of the back-end system, therefore, is to expect a value for all elements that are found in the message types structure.

This also applies to elements that are designated as optional in the message structure.

This means that if elements are not filled in a request message, the back-end system interprets this information as a deletion entry, and initializes the corresponding fields in the database.

For list-type elements that can contain several items, the items that are not filled are interpreted as a deletion entry. You can recognize these list-type elements in that unbounded is entered for maxOccurs .

An order contains items 10, 20, 30, 40, 50. With the request message for a chance operation, item 10 is to be changed, and item 30 is to be deleted.

So that you do not delete items 20, 40 and 50 with the change operation, you also have to specify items 20, 40 and 50 in addition to items 10 and 30, even if the former have not been changed. Item 30 is deleted if you do not specify it.

Material

Technical Data

Entity Type



Definition

A Material is a tangible product such as a sellable article, packaging, auxiliary material and expendable supplies. A product is a commodity that is the object of the business of a company and serves to create value for this company. A product can be tangible or intangible. A product can contain other products, or belong to another product, for example, display or gift sets. A product can have relationships to other products or objects.

Use

The Material business object contains operations that enable you to find the identifier of a material, or elements of a material, for your business process from given vague data. The business object also contains an operation that reads and returns basic data for a given material.

Query Material In

Technical Data



Entity Type


Category

Mode


Inbound

Synchronous

Definition

Query Material In is a service interface that enables you to find the identifier of a material, or elements of a material, for your business process from vague date given.

Use

The inbound service interface Query Material In groups operations that specify search patterns for a material ID to be used to select materials. Operations in this inbound service interface are relevant to all search-service business purposes.


Manage Material_In [Seite 147 ]

Integration

The inbound service interface Query Material In belongs to the process component Product

Data Management and the business object Material .

Structure

This inbound service interface groups the following inbound operations:

MaterialSimpleByIDAndDescriptionQueryResponse_In ( Find Material by ID and

Description [Seite 143 ] )

MaterialSimpleByGTINQueryResponse_In ( Find Material By GTIN [Seite 144 ] )

MaterialSimpleBySearchtextQueryResponse_In ( Find Material by Search Text [Seite

145 ] )

MaterialSalesSpecificationByElementsQueryResponse_In ( Find Material Sales

Specification by Elements [Seite 146 ] )

Find Material by ID and Description

Technical Data

Entity Type





ESR

Category

Mode


Operation

MaterialSimpleByIDAndDescriptionQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MATERIALBYIDDESCR001QR



Definition

Find Material by ID and Description is an operation that searches for material IDs and their descriptions.

Use

The Find Material by ID and Description inbound operation allows you to find the identifier and description of a material for your business process using part or all of its description, or part of its ID as search criteria.

Features


MaterialSimpleByIDAndDescriptionQuery_sync

MaterialSimpleByIDAndDescriptionResponse_sync


The message type MaterialSimpleByIDAndDescriptionQuery_sync receives search parameters for part or all of a material description, or part of the material ID, and the message type MaterialSimpleByIDAndDescriptionResponse_sync returns a full description of material and a whole material ID.


Processing

For this inbound operation, the following Business Add-In (BAdI) is available in enhancement spot MAT_SPOT_SE_PROXY:

MAT_SE_MATSIMPLEBYIDDSCR001QR

Find Material by GTIN

Technical Data

Entity Type





Category

Mode


Operation

MaterialSimpleByGTINQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MATERIALBYGTIN002QR

Definition

Find Material by GTIN is an operation that searches for material IDs and their descriptions.

Use

The Find Material by GTIN inbound operation allows you to find the identifier and description of a material for your business process using its Global Trade Item Number as a search criterion.



Features


MaterialSimpleByGTINQuery_sync

MaterialSimpleByGTINResponse_sync


The message type MaterialSimpleByGTINQuery_sync receives search parameters for a

Global Trade Item Number, and the message type MaterialSimpleByGTINResponse_sync returns a whole material ID and its description.


Processing


MAT_SE_MATSIMPLEBYGTIN002QR

Find Material by Search Text

Technical Data

Entity Type





Category

Mode


Operation

MaterialSimpleBySearchtextQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MATERIALBYSEARCHTEXT003QR

Definition

Find Material by Search Text is an operation that searches for material IDs and their descriptions.

Use

The Find Material by Search Text inbound operation allows you to find the identifier and the description of a material for your business process using search text as a search criterion.

Features


MaterialSimpleBySearchtextQuery_sync

MaterialSimpleBySearchtextResponse_sync




The message type MaterialSimpleBySearchtextQuery_sync receives search parameters for a material text, and the message type MaterialSimpleBySearchtextResponse_sync returns a whole material ID and description. The scope of the search includes both short and long texts, as well as most attributes of a material.


Currently the system uses the TREX search engine for the search using searchtext. The scope of the search depends on the configuration of the TREX search engine.

Prerequisites

You have set up the TREX search engine and connected it to your ERP system

You have configured the TREX search engine in such a way that it covers the material attributes and texts that you would like to use as search criteria

Processing

The operation passes the search text, together with the information that it is a search for a material, to the TREX search engine and returns the results


MAT_SE_MATSIMPLEBYSRTXT003QR

Find Material Sales Specification by Elements

Technical Data

Entity Type





Category

Mode


Operation

MaterialSalesSpecificationByElementsQuery

Reponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MATERIALSLSBYELMNTS004QR

Definition

A query to and response from Product Data Management to search for sales specification information about materials according to certain selection criteria.

Use

A sales clerk can use the Find Material Sales Specification by Elements inbound operation to search for material according to certain sales specification data.

Features


MaterialSalesSpecificationByElementsQuery_sync

MaterialSalesSpecificationByElementsReponse_sync



One of the following values must be supplied:

MaterialInternalID

Description

DivisionCode

SalesOrganisationID

DistributionChannelCode

The elements are defined as ranges.

Error Handling

If errors occur, the process is aborted and an appropriate message is sent to the application.

Integration

This inbound operation belongs to the inbound service interface Query Material In [Seite 142 ] .

Notes for SAP Back-end System Administration

Processing

The MAT_SE_MATSLSBYELEMTS004_QR Business Add-In (BAdI) is available for this operation.

Manage Material In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Manage Material In is a service interface that contains an operation to read and return basic data for a given material.

Use

The inbound service interface Manage Material In contains an operation that returns the basic data of a material ID. Operations in this inbound service interface are relevant to all readservice business purposes.


Query Material In [Seite 142 ]

Integration

The inbound service interface Manage Material In belongs to the process component Product

Data Management and to the business object Material .



Structure


MaterialBasicDataByIDQueryResponse_In ( Read Material Basic Data [Seite 148 ] )

MaterialSalesSpecificationByIDQueryResponse_In ( Read Material Sales Specification by ID [Seite 149 ] )

Read Material Basic Data

Technical Data

Entity Type





Category

Mode


Operation

MaterialBasicDataByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MATERIALBASICDATABYID000QR

Definition

Read Material Basic Data is an operation that reads the basic data of a material.

Use

The Read Material Basic Data inbound operation reads and returns the detailed information of the basic data of a material with a given ID.

Features


MaterialBasicDataByIDQuery_sync

MaterialBasicDataByIDResponse_sync


The message type MaterialBasicDataByIDQuery_sync receives the material ID, and the message type MaterialBasicDataByIDResponse_sync returns detailed information about identifying elements, descriptions, Global Trade Item Numbers, and quantity units of the material.


Processing


MAT_SE_MATBASICDATABYID000QR



Read Material Sales Specification

Technical Data

Entity Type





Category

Mode


Operation

MaterialSalesSpecificationByIDQuery

Response_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MATERIALSLSBYID005QR

Definition

A query to and response from Product Data Management to read the sales specification information about a material with a given ID.

Use

A sales clerk can use the inbound operation Read Material Sales Specification to read the sales specification of a material.

Features


MaterialSalesSpecificationByIDQuery_sync

MaterialSalesSpecificationByIDResponse_sync

The following value must be supplied:

MaterialInternalID

Error Handling


Integration

This inbound operation belongs to the inbound service interface Manage Material In [Seite

147 ] .


Processing

The MAT_SE_MATSLSBYID005_QR Business Add-In (BAdI) is available for this operation.

Individual Material

Technical Data

Entity Type Business object



Software Component mySAP ERP enterprise services package

(as of ECC-SE 600)

Definition

A material that only occurs once in the real world and is therefore uniquely identifiable. It can also be a material that will only exist in the future.

An individual material is the same as a piece of equipment in SAP ECC .

Use

A maintenance technician requires details of an individual material to plan and execute maintenance activities on it. He or she can obtain the required information by searching for an individual material based on ID, basic data, or warranty information. He or she can also make changes to an individual material.


Installation Point

Warranty

Business Partner


Prerequisites

To be able to use the operations in this business object, you must have implemented the

Equipment (PM-EQM-EQ) component and have made the basic Customizing settings for this component.

Manage Individual Material In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that enable the processing of an individual material.

An individual material corresponds to a piece of equipment in SAP ECC .

Use

The Manage Individual Material In inbound service interface contains the operations that a maintenance technician can use to manage individual materials.

Integration

The Manage Individual Material In inbound service interface belongs to the Product Data

Management [Seite 141 ] process component and the Individual Material [Seite 149 ] business object.



Structure

This inbound service interface contains the following inbound operation:

IndividualMaterialByIDQueryResponse_In ( Read Individual Material [Seite 151 ] )

Read Individual Material

Technical Data

Entity Type

Technical

Name in

Enterprise

Services

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode

Related

Web

Service

Definition

Operation

IndividualMaterialByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_INDIVIDUALMATERIALIDQR

Definition

A query to and response from Product Data Management to get the details of an individual material on the basis of the individual material identification.


Use

The Read Individual Material inbound operation enables a maintenance technician to search for an individual material by its identification.

Features


IndividualMaterialByIDQuery_sync

IndividualMaterialByIDResponse_sync

Error Handling

If errors occur, the process terminates and an appropriate message is sent to the application.

Integration

This inbound operation belongs to the Manage Individual Material In [Seite 150 ] inbound service interface.




Prerequisites

For more information, see Individual Material [Seite 149 ] .

Processing

The EAM_SE_IM_BYIMID_QR Business Add-In (BAdI) is available for this operation.

Query Individual Material In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that enable a search for an individual material.


Use

The Query Individual Material In inbound service interface contains the operations that a maintenance technician can use to search for individual materials.

Integration

The Query Individual Material In inbound service interface belongs to the Product Data


Structure


IndividualMaterialSimpleByElementsQueryResponse_In ( Find Individual Material by

Basic Data [Seite 152 ] )

Find Individual Material by Elements

Technical Data

Entity Type





Category

Operation

IndividualMaterialSimpleByElements

QueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound



Mode


Synchronous

ECC_INDIVIDUALMATERIALSELQR

Definition

A query to and response from Product Data Management to search for an individual material according to specific data.


Use

The Find Individual Material by Basic Data inbound operation allows a maintenance technician to search for individual materials according to specific data. The maintenance technician receives a list of all individual materials that match the search criteria.

Features


IndividualMaterialSimpleByElementsQuery_sync

IndividualMaterialSimpleByElementsResponse_sync

Error Handling


Integration

This inbound operation belongs to the Query Individual Material [Seite 152 ] inbound service interface.


Prerequisites


Processing

The EAM_SE_IM_SEL_QR Business Add-In (BAdI) is available for this operation.

Individual Material Action In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that enable the installation and dismantling of an individual material.




Use

The Individual Material Action In inbound service interface contains the operations that a maintenance technician can use to install and dismantle an individual material.

Integration

The Individual Material Action In inbound service interface belongs to the Product Data


Structure


IndividualMaterialInstallRequestConfirmation_In ( Install Individual Material [Seite 154 ] )

IndividualMaterialDismantleRequestConfirmation_In ( Dismantle Individual Material

[Seite 155 ] )

Install Individual Material

Technical Data

Entity Type

Technical

Name in

Enterprise

Services

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode

Related

Web

Service

Definition

Operation

IndividualMaterialInstallRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global

As of ESA ECC_SE 600

Inbound

Synchronous

ECC_INDIVIDUALMATERIALINSRC

Definition

A request to and confirmation from Product Data Processing to install an individual material at another individual material.


Use

The Install Individual Material inbound operation enables a maintenance technician to install an individual material at another individual material.



Features


IndividualMaterialInstallRequest_sync

IndividualMaterialInstallConfirmation_sync

Error Handling


Integration

This inbound operation belongs to the Individual Material Action [Seite 153 ] inbound service interface.


Prerequisites


Processing

The EAM_SE_IM_INS_RC Business Add-In (BAdI) is available for this operation.

Dismantle Individual Material

Technical Data


IndividualMaterialDismantleRequestConfirmation_In Technical

Name in

Enterprise

Services

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode

Related

Web

Service

Definition http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_INDIVIDUALMATERIALDISRC

Definition

A request to and confirmation from Product Data Processing to dismantle an individual material from another individual material.




Use

The Dismantle Individual Material inbound operation allows a maintenance technician to dismantle an individual material from another individual material.

Features


IndividualMaterialDismantleRequest_sync

IndividualMaterialDismantleConfirmation_sync

Error Handling


Integration

This inbound operation belongs to the Individual Material Action [Seite 153 ] inbound service interface.


Prerequisites


Processing

The EAM_SE_IM_DIS_RC Business Add-In (BAdI) is available for this operation.

Identified Stock

Technical Data

Entity Type


Version

Business object mySAP ERP enterprise services package (as of

ECC-SE 600)

Definition

A batch is a homogenous material with uniform quality and characteristics, and is generally produced during one production process. Batches may differ with regard to their quality, properties, and property valuations.

Use

The Identified Stock business object contains relevant information that is used to track the batches with identifiable portions of stock. In the pharmaceutical industry, ingredients and the finished goods need to be tracked with regard to the following:

Quality

Purity

Active ingredient content

Production

Expiry date



The relevant materials are grouped together to form a batch which is used to track the relevant details.


Material [Seite 142 ]


Prerequisites

To use this business object, you must have:

Executed the SAP ECC component LO-BM.

Batch managed at least one material in the organization.

Constraints

The batch level must be set at either the Material Level (1) or the Client Level (2) in the system.

Query Batch In

Technical Data

Entity Type


Version

Message Direction

Transmission Type


ECC-SE 600)

Inbound

Synchronous

Definition

Query Batch In service interface enables you to retrieve batches containing identifiable portions of stock.

Use

The Query Batch In inbound service interface includes a set of operations that retrieves batches with identifiable portions of stock for a given material/plant/storage location.

Integration

The Query Batch In inbound service interface belongs to the Product Data Management

[Seite 141 ] process component and the Identified Stock [Seite 156 ] business object.

Structure

The Query Batch In inbound service interface contains the inbound operation

BatchSimpleByElementsQueryResponse_In inbound operation ( Find Batch By

Elements [Seite 157 ] ).

Find Batch By Elements

Technical Data

Entity Type

Technical

Name in

Operation

BatchSimpleByElementsQueryResponse_In



Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode http://sap.com/xi/APPL/SE/Global

As of ECC-SE 600

Inbound

Synchronous

Definition

Find Batch By Elements operation retrieves batches based on the selection criteria, with the assigned plants and the storage location.

Use

The Find Batch By Elements inbound operation provides customizing settings for the field selection from the back-end system. When creating a UI, you can use this inbound service operation to dynamically access the fields that are relevant for a batch, such as the following:

MaterialInternalID

PlantID

InventoryManagedLocationInternalID

ProductionDate

AvailabilityDate

LastGoodsReceiptDate

NextQualityInspectionDate

ExpirationDate

RestrictedUseIndicator

ActiveIndicator

You can, therefore, tailor the number of batches to be displayed on the interface.

Features


BatchSimpleByElementsQuery

This message is a query to Product Data Management to retrieve batches. It contains the list of fields to be transmitted as a part of the query. You can select a field listed in the Use section above.

BatchSimpleByElementsResponse

This message retrieves the batches that match the selection criteria.




Prerequisites

You must have executed the SAP ECC application component LO-BM.

Constraints

The batch level must be set at either the Material (1) level or the Client (2) level.

Processing

For this inbound operation, the following Business Add-In (BAdI) is available in the enhancement spot LOBM_SPOT_SE_BATCH:

LOBM_SE_BATCHSEQR

Manage Batch In

Technical Data

Entity Type


Version




ECC-SE 600)

Inbound

Synchronous

Definition

Manage Batch In service interface enables you to read, create and change the batches. Also, the service interface enables you to create and change plant assignment for the batches.

Use

The Manage Batch In inbound service interface includes operations for reading relevant information in a batch, creating and changing batches. This service interface returns

BatchID field which in turn is used to read and change different batches.

Integration

The Manage Batch In inbound service interface belongs to the Product Data Management

[Seite 141 ] process component and the Identified Stock [Seite 156 ] business object.

Structure

The Manage Batch In inbound service interface groups the following inbound operations:

BatchByIDQueryResponse_In ( Read Batch [Seite 160 ] )

BatchCreateRequestConfirmation_In ( Create Batch [Seite 161 ] )

BatchChangeRequestConfirmation_In ( Change Batch [Seite 162 ] )

BatchPlantAssignmentCreateRequestConfirmation_In ( Create Batch Plant

Assignment [Seite 164 ] )

BatchPlantAssignmentChangeRequestConfirmation_In ( Change Batch Plant




Read Batch

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)

Namespace in

ESR

Software

Component

Version in

ESR

Category

Mode

Related Web

Service

Definition

Operation

BatchByIDQueryResponse_In http://sap.com/xi/APPL/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_BATCHIDQR

Definition

Read Batch operation enables you to read different elements of a batch for a given BatchID .

Use

The Read Batch inbound operation reads and retrieves the details of a batch for a given

BatchID . You can use these details for recording the quality, expiry date, and production.

Related Services

Find Batch By Elements [Seite 157 ]

Features


BatchbyIDQuery

In this message, you must select the BatchID field and the corresponding

MaterialInternalID field to obtain the batch details.

BatchbyIDResponse

This response message returns the batch details like Batch , PlantAssignment , and

InventoryManagedLocationAssignment .


Prerequisites

You must have executed the following:

The SAP ECC component LO-BM.

Find Batch by Elements inbound service interface for a list of all the batches.



Constraints

The batch level must be set at either the Material (1) level or the Client (2).

Processing


LOBM_SE_BATCHBYIDQR

Create Batch

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode

Related

Web

Service

Definition

Operation

BatchCreateRequestConfirmation_In http://sap.com/xi/APPL/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_BATCHIDQR

Definition

Create Batch operation enables you to create a new batch in the system.

Use

The Create Batch inbound service operation creates a batch based on the parameters sent as part of the BatchCreateRequest . You can use this inbound service operation to return the

BatchID of the newly created batch, and optionally to valuate the batch properties.

Features


BatchCreateRequest

In this message, you have to select the RestrictedUseIndicator ,

ActiveIndicator , AutomaticClassificationIndicator fields along with the

MaterialInternalID field for creating a batch. The optional parameters are as follows:

BatchID



ProductionDate

AvailabilityDate



ExpirationDate

OriginCountryCode

OriginRegionCode

BatchCreateConfirmation

This message returns the BatchID for the newly created batch.


Prerequisites

You must have executed the SAP ECC components LO-BM. The batch should not currently exist in the system.

Constraints


Processing


LOBM_SE_BATCHCRTRC

Change Batch

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode

Related

Web

Service

Operation

BatchChangeRequestConfirmation_In http://sap.com/xi/APPL/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_BATCHCHGRC



Definition

Definition

Change Batch operation enables you to change an existing batch.

Use

The Change Batch inbound operation changes a batch based on the selected parameters.

The operation returns the BatchID and MaterialInternalID parameters. A message is sent from the manufacturing execution system to the Product Data Management [Seite 141 ] process component to change a batch, and optionally to change the valuation of the batch’s properties.

Features


BatchChangeRequest

In this message, you have to select the BatchID , RestrictedUseIndicator ,

ActiveIndicator , AutomaticClassificationIndicator and

MaterialInternalID parameters. The optional parameters are as follows:

Production Date

Availability Date

PropertyValuation



ExpirationDate

OriginCountryCode

OriginRegionCode

BatchChangeConfirmation

This message returns the BatchID and the MaterialInternalID fields for the changed batch.

The parameters with blank values will override the existing values.


Prerequisites

You must have executed the SAP ECC components LO-BM. Only the existing batch can be changed.

Constraints


Procesing



SAP Documentation

LOBM_SE_BATCHCHGRC

Enterprise SOA

Create Batch Plant Assignment

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode

Related

Web

Service

Definition

Operation

BatchPlantAssignmentCreateRequestConfirmation_In http://sap.com/xi/APPL/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_BATCHPLANTASSIGNCRTRC

Definition

Create Batch Plant Assignment operation enables you to create a plant assignment for a batch.

Use

The Create Batch Plant Assignment inbound operation creates an assignment between a batch and a plant. A message is sent from manufacturing execution to the Product Data

Management [Seite 141 ] process component to assign a batch to at least one plant and optionally, to one or more inventory-managed locations. The valuation type of the batch can be assigned per plant; you can also add dependent data for the batch plant assignment.

Features


BatchPlantAssignmentCreateRequest

In this message, you have to select the BatchID , MaterialInternalID and

PlantID parameters. The other parameters, such as,

InventoryValuationTypeCode and InventoryManagedLocationInternalID are optional.

BatchPlantAssignmentCreateConfirmation

This response message returns the BatchID for the relevant batch assigned to the plants for which the assignment was created.




Prerequisites

You must have executed the SAP ECC component LO-BM.

The batch and plant already exists in the system, but the assignment is not yet available.

Constraint


Processing


LOBM_SE_BATCHPLANTASSIGNCRTRC

Change Batch Plant Assignment

Technical Data


BatchPlantAssignmentChangeRequestConfirmation_In Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode http://sap.com/xi/APPL/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_BATCHPLANTASSIGNCHGRC Related

Web

Service

Definition

Definition

Change Batch Plant Assignment operation enables you to change an existing batch plant assignment in the system.

Use

A message is sent from the manufacturing execution system to the Product Data

Management [Seite 141 ] process component to change the assignment of a batch to plants and inventory-managed storage locations. The valuation type of a batch can also be changed per plant.



Features


BatchPlantAssignmentChangeRequest

In this message, you have to select the BatchID , MaterialInternalID and

PlantID parameters. Other parameters, such as, InventoryValuationTypeCode and InventoryManagedLocationInternalID are optional.

BatchPlantAssignmentChangeConfirmation

This response message returns the BatchID for the relevant batch for which the assignment has to be changed.


Prerequisites

You must have executed the SAP ECC components LO-BM.

The batch, plant, and the assignment already exist in the system.

Constraints

The batch level must be set at either the Material (1) level or the Client (2) level in the system.

Processing


LOBM_SE_BATCHPLANTASSIGNCHGRC

Product Procurement Arrangement

Technical Data

Entity Type



Definition

A Product Procurement Arrangement is a source of information for the procurement of a certain material or service from a certain vendor.

Use

The Product Procurement Arrangement business object contains operations that enable you to access the purchasing info record in ERP.

Query Product Procurement Arrangement In

Technical Data





Category

Mode mySAP ERP enterprise services package (as of ECC-SE 600)

Inbound

Synchronous

Definition

The service interface Query Product Procurement Arrangement In provides service operations for inquiries to Product Data Processing for a Product Procurement Arrangement .

Use

The service interface Query Product Procurement Arrangement In contains synchronous inbound operations to the business object Product Procurement Arrangement . It includes queries to Product Procurement Arrangement .

Integration

The Query Product Procurement Arrangement In inbound service interface belongs to the

Product Data Management process component and to the Product Procurement Arrangement business object.

Structure


ProductProcurementArrangementByElementsQueryResponse_In [Seite 167 ]

ProductProcurementArrangementByIDQueryResponse_In [Seite 168 ]

ProductProcurementArrangementByElementsQueryR esponse_In

Technical Data

Entity Type






Version in ESR

Category

Mode


Definition

Operation

ProductProcurementArrangementByElementsQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global

ESA ECC-SE 600

Inbound

Synchronous

ECC_PURPRODPROCARRNGMNTBYELMQR

Definition

The operation provides a query to instances of Product Procurement Arrangement.



Use

You require a service to query for Product Procurement Arrangements with different selection criteria like vendor, material.

Features

The service provides the following parameters:

PRODUCT_INTERNAL_ID: Internal Material Number

SELECTION_BY_PRODUCT_INTERNAL_ID: Interval for Internal Material Number

This parameter may only be used, if the PRODUCT_INTERNAL_ID is not involved in the payload.

SUPPLIER_ID: Internal Vendor Id

PURCHASING_ORGANISATION_PARTY: Purchasing Organization

PLANT_ID: Plant

SELECTION_BY_PLANT_ID: Interval for Plant

This parameter may only be used, if the PLANT_ID is not involved in the payload.

SUPPLIER_PRODUCT_CATEGORY_ID: Vendor Subrange

MERCHANDISE_CATEGORY_ID: Merchandise category

If one or more records exists for the query the service provides following information:

ID: Id of the Product Procurement Arrangement (Vendor Info Record)


SUPPLIER_ID: Internal Vendor Id

PURCHASING_ORGANISATION_ID: Purchasing Organization

PLANT_ID: Plant


PRICE: Net price in Product Procurement Arrangement (Vendor Info Record)

ORDER_RATE: Conversion between the order unit of measure and the base unit of measure

ORDER_PRICE_RATE: conversion between the order price unit of measure and the order unit of measure

Besides the plant dependent product procurement arrangement record the plant independent record is also returned to the consumer.

ProductProcurementArrangementByIDQueryRespons e_In

Technical Data








Category

Mode


Definition

ProductProcurementArrangementByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_PURPRODPROCARRNGMNTBYIDQR

Definition

The operation provides a query to an instance of Product Procurement Arrangement.

Use

The operation offers you a query for an instance of Product Procurement Arrangement with selection criteria ID.

Features

The single selection criterion of the service operation is the ID of a Product Procurement

Arrangement.

If a record exists for the query the service provides following information:

ID: ID of the Product Procurement Arrangement (Vendor Info Record)


SUPPLIER_ID: Internal Vendor ID

PURCHASING_ORGANISATION_ID: Purchasing Organization

PLANT_ID: Plant


PRICE: Net price in Product Procurement Arrangement (Vendor Info Record)


Processing

For this inbound operation, a Business Add-In (BAdI) is available in enhancement spot

PUR_SPOT_SE_PURCHASING.

Merchandise Category Hierarchy

Technical Data

Entity Type





Definition

The Merchandise Category Hierarchy implements a hierarchical assignment of merchandise categories reflecting retail needs.

Use

Retail is an industry with mass data, especially the number of products a retailer carries can become significant. Thus, there is a need to group together products that have common attributes from a consumer perspective (e.g. pasta, dairy products, ties, etc.). Merchandise categories are relevant for almost processes in Retail, that is from a reporting perspective:

Retailers want to analyze key figures aggregated at merchandise category level.

from a control parameter perspective:

For ease of maintenance many parameters are stored at merchandise category/object level (for example, replenishment parameters at level merchandise category site, which are then effective for all products assigned to the merchandise category.

from a data retention level perspective:

Often master data is created at merchandise category level (for example, discount percentage for all products of a merchandise category).

from a selection/operational perspective:

In operational transactions, all products of a merchandise category are worked on simultaneously (for example, execute replenishment for all products of a merchandise category).

Query Merchandise Category Hierarchy In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

The service interface Merchandise Category Hierarchy In provides service operations for inquiries on Merchandise Category Hierarchy .

Use

The service interface Query Merchandise Category Hierarchy contains synchronous inbound operations to the business object Product Procurement Arrangement . It includes queries to

Merchandise Category Hierarchy .

Integration

The Query Merchandise Category Hierarchy inbound service interface belongs to the Product

Data Management process component and to the Merchandise Category Hierarchy business object.



Structure


MerchandiseCategorySimpleByIDAndDescriptionQueryResponse_In [Seite 171 ]

MerchandiseCategorySimpleByIDAndDescriptionQuer yResponse_In

Technical Data

Entity Type





Software

Component Version in ESR

Category

Mode


Definition

Operation

MerchandiseCategorySimpleByIDAndDescriptionQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MERCHCATBYIDDESCQR

Definition

The Operation provides a query to instances of Merchandise Category Hierarchy.

Features

The service allows the search by short text and/or ID. Selection Criteria of the query are

MERCHANDISE_CATEGORY_ID: ID of merchandise category

PRODUCT_ASSIGNMENT_ALLOWED_IN: Flag if product assignment is allowed

(inner/leaf node of hierarchy)

DESCRIPTION: Description of merchandise category

The Service provides as response Id’s and descriptions of Merchandise Categories fitting to the selection criteria.


MerchandiseCategorySimpleByIDAndDescriptionQuery_sync

MerchandiseCategorySimpleByIDAndDescriptionResponse_sync


Processing

For this inbound operation, a Business Add-In (BAdI) is available in enhancement spot

RT_SPOT_SE_RETAIL.


SAP Documentation

Enterprise Services for SAP ERP ECC

Enterprise SOA

Document Management

Technical Data

Entity Type


Process Component mySAP ERP enterprise service package (as of ESA ECC-SE 600)

Definition

Document Management is used to manage document processing.

Use

The Document Management process component can automate in the area of product development and design the entire life cycle of a document from document creation to document storage and from access to update. The required information can be obtained by searching for the business object Document .

Document Management facilitates the usage of a central document management system as document repository for business processes in SAP and non-SAP applications in the area of product development and design. It allows Documents to be uploaded and retrieved to and from a central document management system


To be able to use the operations contained in the process component, you have to use mySAP ERP.

Processing





For list-type elements that can contain several items, the items that are not filled are interpreted as a deletion entry. You can recognize these list-type elements in that unbounded is entered for maxOccurs.

Example





Document

Technical Data

Entity Type


Business Object mySAP ERP enterprise service package (as of ESA ECC-SE 600.

Definition

A carrier of unstructured information as well as control and monitoring information. A

Document can be defined as a file or folder. Every Document has a status and may or may not have properties.

It is not currently possible to define Documents as links to other business objects.

Use

The Document business object contains operations that enable you to create, read, or update documents, and to find documents by searching for a document by different elements.

Although it would be possible to assign more than one property value to a

Document , the Document Management System only allows a single value for each of the following properties:

Amount which is of Currency Type

Decimal , Float , or Integer which is of Numeric Type

Date which is of Date Type

Time which is of Time Type

Name which is of Character Type

Manage Document In

Technical Data

Entity Type


Category

Mode

Service Interface mySAP ERP enterprise service package (as of ESA ESS-SE 600)

Inbound

Synchronous



Use

The Manage Document In service interface groups operations that enable you to manage one or more Documents at the same time.

Create Document

Technical Data

Entity Type





Category

Mode


Operation

DocumentCreateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_DocumentCrtRC

Use

The Create Document inbound operation is used to create a Document . For information about the mass creation of Documents , see Create Documents [Seite 174 ] .

Features


DocumentCreateRequest_sync

DocumentCreateConfirmation_sync



The Business Add-In (BAdI) DMS_SE_DOCUMENTCRTRC is available in enhancement spot

DMS_SPOT_SE_DOCUMENT for this inbound operation.

Create Documents

Technical Data

Entity Type





Category

Mode

Operation

DocumentBulkCreateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous


SAP Documentation

Related Web Service Definition ECC_DocumentBulkCrtRC

Enterprise SOA

Use

The Create Documents inbound operation is used to create multiple Documents with all their attributes at the same time. For more information about creation of single Documents , see

Create Document [Seite 174 ] .

Features


DocumentBulkCreateRequest_sync

DocumentBulkCreateConfirmation_sync



The Business Add-In (BAdI) DMS_SE_DOCUMENTBULKCRTRC is available in enhancement spot DMS_SPOT_SE_DOCUMENT for this inbound operation.

Create Document Version

Technical Data

Entity Type





Category

Mode


Operation

DocumentVersionCreateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_DOCUMENTVRCRTRC

Use

The Create Document Version inbound operation is used to create a new version of a

Document . The version applies to the whole Document .

Features


DocumentVersionCreateRequest_sync

DocumentVersionCreateConfirmation_sync



The Business Add-In (BAdI) DMS_SE_DOCUMENTVRCRTRC is available in enhancement spot DMS_SPOT_SE_DOCUMENT for this inbound operation.



Read Document

Technical Data

Entity Type





Category

Mode


Operation

DocumentByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_DOCUMENTIDQR

Use

The Read Document operation is used to read a Document .

Features


DocumentByIDQuery_sync

DocumentByIDResponse_sync



The Business Add-In (BAdI) DMS_SE_DOCUMENTIDQR is available in enhancement spot

DMS_SPOT_SE_DOCUMENT for this inbound operation .

Update Document

Technical Data

Entity Type





Category

Mode

Relates Web Service Definition

Operation

DocumentUpdateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_DOCUMENTUPDRC



Use

The Update Document inbound operation is used to change metadata (elements), originals

(files), property values, and user statuses of a Document . For information about mass update of Documents see Update Documents [Seite 177 ] .

Features


DocumentUpdateRequest_sync

DocumentUpdateConfirmation_sync



The Business Add-In (BAdI) DMS_SE_DOCUMENTUPDRC is available in enhancement spot


Update Documents

Technical Data

Entity Type





Category

Mode


Operation

DocumentBulkUpdateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_DOCUMENTBULKUPDRC

Use

The Update Documents inbound operation is used to make mass changes to metadata

(elements), originals (files), property values, and user statuses of multiple Documents at the same time. A single Document can be updated using the Update Document [Seite

176 ] inbound operation.

Features


DocumentBulkUpdateRequest_sync

DocumentBulkUpdateConfirmation_sync





The Business Add-In (BAdI) DMS_SE_DOCUMENTBULKUPDRC is available in enhancement spot DMS_SPOT_SE_DOCUMENT for this inbound operation.

Document Action In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Use

The Document Action In service interface contains the Release Document inbound operation that is used to release a Document .

Release Document

Technical Data

Entity Type





Category

Mode


Operation

DocumentReleaseRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_DOCUMENTRELRC

Use

The Release Document inbound operation is used to set the status of a Document to

"release".

Features


DocumentReleaseRequest_sync

DocumentReleaseConfirmation_sync





The Business Add-In (BAdI) DMS_SE_DOCUMENTRELRC is available in enhancement spot


Query Document In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Use

The Query Document In service interface groups operations that search for Documents by queries.

Find Document by Elements

Technical Data

Entity Type





Category

Mode


Operation

DocumentSimpleByElementsQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_DOCUMENTSEQR

Use

The Find Document by Elements inbound operation is used to find a Document by any of the following metadata:

DocumentName

DocumentTypeCode

AlternativeDocumentID

DocumentVersionID

Description

SystemAdministrativeData

FileVariantDocumentFormatCode



DocumentStatusCode

DeleteIndicator

CoputerAidedDesignDrawingIndicator

QueryHitsMaximumNumberValue

Features


DocumentSimpleByElementsQuery_sync

DocumentSimpleByElementsResponse_sync



The Business Add-In (BAdI) DMS_SE_DOCUMENTSEQR is available in enhancement spot


Read Latest Released Document Version

Technical Data

Entity Type




Operation

DocumentLatestReleasedVersionByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global



Category

Mode

Inbound

Synchronous

Related Web Service Definition ECC_DOCUMENTLRVIDQR

Use

The Read Latest Released Document Version inbound operation is used to find the latest released version of a Document . If no versions of a Document have been released, the system returns the latest version of the Document .

Features


DocumentLatestReleasedVersionByIDQuery_sync

DocumentLatestReleasedVersionByIDResponse_sync



The Business Add-In (BAdI) DMS_SE_DOCUMENTLRVIDQR is available in enhancement spot DMS_SPOT_SE_DOCUMENT for this inbound operation .



Find Document by Property Valuation

Technical Data

Entity Type





Operation

DocumentSimpleByPropertyValuationQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Category

Mode

Inbound

Synchronous

Related Web Service Definition ECC_DOCUMENTSPQR

Use

The Find Document by Property Valuation inbound operation is used to find a Document by its property values.

Features


DocumentSimpleByPropertyValuationQuery_sync

DocumentSimpleByPropertyValuationResponse_sync



The Business Add-In (BAdI) DMS_SE_DOCUMENTSPQR is available in enhancement spot


Resource Data Management

Technical Data

Entity Type



(as of ECC-SE 600)

Use

The process component Resource Data Management comprises services for reading and finding work centres and supports the business process for integrating a manufacturing execution system.



Using these services improves the integration of manufacturing execution systems in the ERP system.


Prerequisites

You have to implement SAP ECC Production Planning and Control (PP) to be able to use the operations contained in the process component.

Work Centre

Technical Data

Entity Type


Business object mySAP ERP enterprise services package

(as of ECC-SE 600)

Definition

Organisational unit that specifies where and by whom an operation is to be executed.

Use

Work centres are part of the fundamental master data of production planning and control along with bills of material and routings. Work centres are used in the operations of task lists and work orders. Task lists include routings, maintenance task lists, inspection plans, and standard networks. Work orders are created in the form of a network for production, quality assurance, plant maintenance and the project system.

The business object Work Centre has a specific available capacity. The work carried out at or by the work centre is costed with allocation records that are defined by the cost centres and activity types. The following units can be defined as work centres:

Machines

People

It is also possible to define customer-specific work centre categories.

The services in this area support the work centre search and the reading of work centre data.


Other PP basic data, such as bills of material and routings.


Prerequisites

To be able to use the operations of this business object, you must have implemented the component PP-BD-WKC (work centre) and made the basic Customizing settings for it.



Query Work Centre In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Operation for finding work centres by the search criterion plant .

Use

The inbound service interface Query Work Centre In groups operations you can use to search for work centres by the criterion plant .

Prerequisites

The component SAP ECC Production Planning and Control (PP) must be active.

Integration

The inbound service interface Query Work Centre In belongs to the process component

Resource Data Management [Seite 181 ] and to the business object Work Centre [Seite 182 ] .

Structure

The inbound service interface Query Work Centre In contains the following inbound operation:

WorkCentreSimpleByPlantQueryResponse_In ( Find Work Centre by Plant) [Seite 183 ]

Constraints

It is currently only possible to search for work centres using the criterion plant .


You have created master data for work centres in the back-end system in the Basic Data area in SAP ECC Production Planning and Control (PP) .

Find Work Centre by Plant

Technical Data

Entity Type





Category

Service operation

WorkCentreSimpleByPlantQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound



Mode


Synchronous

ECC_WorkCentre001QR

Definition

Query to and response from Resource Data Management to provide data for work centres in a particular plant.

Use

The production planner uses the inbound operation Find Work Centre by Plant to find work centres by plants.

Features


WorkCenterSimpleByPlantQuery

WorkCenterSimpleByPlantResponse

In the message type WorkCenterSimpleByPlantQuery , you have to enter the key of a plant in the WorkCenterPlantId field. If you do not enter a plant, the system issues an error message.

The message type WorkCenterSimpleByPlantResponse returns all work centres of the specified plant. The following fields are returned:

Key of the work centre found

Plant of the work centre found

Short Description of the work centre in the logon language (if available)

Error Handling

In case of errors, the process terminates and an appropriate message is transferred to the application.

Integration

This inbound operation belongs to the inbound service interface Query Work Centre In [Seite

183 ] .


Prerequisites

You have created master data for work centres in the back-end system in the Basic Data area in SAP ECC Production Planning and Control (PP) .

For more information, see Resource Data Management [Seite 181 ] .

Processing

You can use the Business Add-In (BAdI) WKC_SE_WORKCENTRE001QR for this operation.

Enterprise Services for SAP ERP Logistics



Appropriation Request

Technical Data

Entity Type



Definition

A request for conducting an investment measure or other measure that has to be assessed and approved by one or more persons in an enterprise.

Use

The Appropriation Request business object makes it possible to implement one or more measures that initially result in costs but that generate revenue or provide other benefits after a longer time period has elapsed. These measures could be capital investment measures, research and development projects, or even large-scale maintenance and repair projects.

Appropriation Request Action In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Processes appropriation requests.

Use

The Appropriation Request Action In inbound service interface groups operations that the person responsible can use to approve, reject, or postpone appropriation requests.

Integration

The Appropriation Request Action In inbound service interface belongs to the Project

Processing [Seite 339 ] process component and to the Appropriation Request [Seite 355 ] business object.

Structure

The Appropriation Request Action In inbound service interface groups the following inbound operations together:

AppropriationRequestApproveRequestConfirmation_In ( Approve Appropriation

Request [Seite 357 ] )



AppropriationRequestPostponeRequestConfirmation_In ( Postpone Appropriation


AppropriationRequestRejectRequestConfirmation_In ( Reject Appropriation Request

[Seite 358 ] )

Constraints

The person responsible can only process appropriation requests that have For approval status.

Approve Appropriation Request

Technical Data

Entity Type





Category

Mode


Service operation

AppropriationRequestApproveRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_IMAPPROPRIATIONREQAPRRC

Definition

Approves an appropriation request.

Use

The Approve Appropriation Request inbound operation makes it possible for the person responsible to approve certain appropriation requests.

Features


AppropriationRequestApproveRequest_sync

AppropriationRequestApproveConfirmation_sync


Integration

This inbound operation belongs to the Appropriation Request Action In [Seite 356 ] inbound service interface.

Constraints

If approval levels are defined in Customizing for the appropriation request type of an appropriation request and event linkage is activated for the approval workflow, then the


SAP Documentation Enterprise SOA person responsible is not able to approve the appropriation request using this inbound operation.

Reject Appropriation Request

Technical Data

Entity Type





Category

Mode


Service operation

AppropriationRequestRejectRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_IMAPPROPRIATIONREQREJRC

Definition

Rejects an appropriation request.

Use

The Reject Appropriation Request inbound operation makes it possible for the person responsible to reject a given appropriation request.

Features


AppropriationRequestRejectRequest_sync

AppropriationRequestRejectConfirmation_sync


Integration


Postpone Appropriation Request

Technical Data

Entity Type




Service operation

AppropriationRequestPostponeRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global




Category

Mode



Inbound

Synchronous

ECC_IMAPPROPRIATIONREQPPNRC

Definition

Postpones approval of an appropriation request.

Use

The Postpone Appropriation Request inbound operation makes it possible for the person responsible to postpone approval for a given appropriation request. As a result, the status of the appropriation request is reset to Created .

Features


AppropriationRequestPostponeRequest_sync

AppropriationRequestPostponeConfirmation_sync


Integration


Manage Appropriation Request

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Queries master data and plan values.

Use

The Manage Appropriation Request inbound service interface contains an operation that reads the master data and plan values of appropriation requests.

Integration

The Manage Appropriation Request inbound service interface belongs to the Project




Structure

The Manage Appropriation Request inbound service interface contains the

AppropriationRequestByIDQueryResponse_In ( Read Appropriation Request [Seite 360 ] ) inbound operation.

Constraints


Read Appropriation Request

Technical Data

Entity Type





Category

Mode


Service operation

AppropriationRequestByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_IMAPPROPRIATIONREQDTLQR

Definition

A query of data of an appropriation request.

Use

The Read Appropriation Request inbound operation reads the master data and plan data of an appropriation request and its variants, including the data of the preinvestment analysis.

Features


AppropriationRequestByIDQuery_sync

AppropriationRequestByIDResponse_sync


Integration

This inbound operation belongs to the Manage Appropriation Request [Seite 359 ] inbound service interface.

Constraints

This operation does not read the following data:

Business area, division, material group, plant, company, location, functional location

Assigned measures, assets, equipment


SAP Documentation

User-defined fields

User status

Verbal assessment, completion date, start-up date of the variants

Depreciation simulation data of the variants

Documents assigned to the variants

Enterprise SOA

Query Appropriation Request In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Searches for appropriation requests that fulfill certain selection criteria.

Use

The Query Appropriation Request In inbound service interface groups operations that the person responsible can use to search for appropriation requests based on selection criteria.

The plan data and master data of the appropriation requests is issued.

Integration

The inbound service interface Query Appropriation Request In belongs to process component

Project Processing [Seite 339 ] and business object Appropriation Request [Seite 355 ] .

Structure

The inbound service Query Appropriation Request In encompasses the following inbound operations:

AppropriationRequestVariantByApproverAndInApprovalStatusQueryResponse_In

( Find Appropriation Request for Approval by Approver and In Approval Status [Seite

361 ] )

AppropriationRequestVariantPlanValuesByProgrammeAndPlanningVersionQueryResp onse_In ( Find Appropriation Request Plan Values by Programme and Planning

Version [Seite 363 ] )

Constraints




Find Appropriation Request for Approval by

Approver and Approval Status

Technical Data

Entity Type


Services Repository (ESR)

Service operation

AppropriationRequestVariantByApproverAndInApprovalStatus





ESR

Category

Mode


Language

Inbound

Synchronous

ECC_IMAPPROPRIATIONREQTBAQR

Definition

Searches for a particular user based on the appropriation requests that have For approval status.

Use

The Find Appropriation Request for Approval by Approver and In Approval Status inbound operation returns all appropriation requests for a given user that have For approval status.

The operation returns the following data of the appropriation requests:

Name of the appropriation request

Assigned investment program position

Variant of the appropriation request (also with For approval status) with its description, assigned plan versions and plan values

Features


AppropriationRequestVariantByApproverAndInApprovalStatusQuery_sync

AppropriationRequestVariantByApproverAndInApprovalStatusResponse_sync


Integration

This inbound operation belongs to inbound service interface Query Appropriation Request In

[Seite 361 ] .

Constraints

This operation does not return any appropriation requests for which approval levels are defined in Customizing and for which event linkage is activated for the approval workflow.




Prerequisites

An approver role is specified for the approver in partner management in the master data of the appropriation request. The system can determine this role from various sources. The system checks these sources one after the other when determining the role for the master record of the appropriation request. The system copies the first approver role that it finds into the master record of the appropriation request. The system checks the sources in the

...

following sequence:

1. Business Add-Ins (BAdIs)

You can specify an approver role for each appropriation request type by implementing the IM_BEHAVIOUR BAdI.

For appropriation requests with appropriation request types 01 and 02, you want the approver in the master record of the appropriation request to have role I3. For appropriation requests with appropriation request types 03, you want the approver in the master record of the appropriation request to have role I4.

Implement the GET_BEHAVIOUR method as follows:

METHOD if_ex_im_behaviour~get_behaviour.

IF situation = 'IM_GET_APPROVER_ROLES'.

CONCATENATE '01' 'I3'

'02' 'I3'

'03' 'I4' INTO behaviour.

ENDIF.

ENDMETHOD.

2. Customizing for the approval levels

In Customizing for the approval process of appropriation requests, you can define approval levels for each appropriation request type and then assign these to roles. If more than one approval level is defined for an appropriation request type, then the system interprets the role of the first approval level as the approver role.

3. Customizing for the appropriation request type

In Customizing for the appropriation request type, you can define two roles that can be maintained directly in the master data of the appropriation request. The system interprets the second of these two roles as the approver role.

Find Appropriation Request Plan Values by

Programme and Planning Version

Technical Data

Entity Type



Service operation

AppropriationRequestVariantPlanValuesByProgrammeAnd

PlanningVersionQueryResponse_In



Namespace in ESR http://sap.com/xi/EA-APPL/SE/Global

Software Component Version in ESR As of ESA ECC-SE 600

Category

Mode


Inbound

Synchronous

ECC_IMAPPROPRIATIONREQPLAQR

Definition

Searches for appropriation requests using the investment program position and the plan version.

Use

The Find Appropriation Request Plan Values by Programme and Planning Version inbound operation returns all appropriation requests that are assigned to a given investment program position and which have a variant that is assigned to a given plan version with a given approval year. The operation returns the following data of the appropriation requests:


Approval status of the appropriation request

The unique variant of the appropriation request that has the entered plan version and approval year, along with the description of the variant

The plan values of this variant

Features


AppropriationRequestVariantPlanValuesByProgrammeAndPlanningVersionQuery_syn c

AppropriationRequestVariantPlanValuesByProgrammeAndPlanning

VersionResponse_sync


Integration

This inbound operation belongs to the Query Appropriation Request In [Seite 361 ] inbound service interface.

Customer Quote Processing

Technical Data

Entity Type

Software Component

Process component mySAP ERP enterprise services package

(as of ECC-SE 600)



Definition

Processing of quotations to customers. The quotations contain the delivery of goods according to specific conditions.

Use

The process component Customer Quote Processing enables the provision of applications that a seller can use to process customer quotes.


Prerequisites

Before you can use the operations in this process component, you must run SAP ECC Sales

(SD).

Processing






An order contains the items 10, 20, 30, 40, 50. With the request message for a chance operation, item 10 is to be changed, and item 30 is to be deleted.


Item 30 is deleted if you do not specify it.

Customer Quote

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

Offer from a seller to a customer to deliver goods at a specific price, in a specific quantity, and at a specific point in time. A quotation is legally binding for the seller for a specific time period.


SAP Documentation

Use

The Customer Quote business object is used to process customer quotes.

Enterprise SOA

Manage Customer Quote In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that a salesperson uses to process customer quotes.

Use

The Manage Customer Quote inbound service interface encompasses operations that the seller can use to process customer quotes.

Integration

The inbound service interface Manage Customer Quote belongs to process component

Customer Quote Processing [Seite 193 ] and business object Customer Quote [Seite 194 ] .

Structure

Inbound service interface Manage Customer Quote encompasses the following inbound operations:

CustomerQuoteByIDQueryResponse_In ( Read Customer Quote [Seite 195 ] )

CustomerQuoteUserStatusChangeRequestConfirmation_In ( Change Customer Quote

User Status [Seite 196 ] )

Read Customer Quote

Technical Data

Entity Type





Category

Mode


Service operation

CustomerQuoteByIDQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_CUSTOMERQUOTE002QR



Definition

Query to and answer from Customer Quote Processing to retrieve data about customer quotes.

Use

Sellers can use the inbound operation Read Customer Quote to display a customer quote.

Features


CustomerQuoteByIDQuery_sync

CustomerQuoteByIDResponse_sync


CustomerQuoteID

Value

The following value must not be supplied:

CustomerQuoteID schemeAgencyID

Error Handling


Integration

This inbound operation belongs to the Manage Customer Quote [Seite 195 ] inbound service interface.

Constraints


Prerequisites

For more information, see Customer Quote Processing [Seite 193 ] .

Processing

You can use the Business Add-In (BAdI) SLS_SE_CUSTOMERQUTOE002QR for this operation.

Change Customer Quote User Status

Technical Data

Entity Type




Service operation

CustomerQuoteUserStatusChangeRequestConfirmation_In http://sap.com/xi/APPL/SE/Global




Category Inbound

Mode


Synchronous

ECC_CUSTOMERQUOTE001CHGRC

Definition

Query to and confirmation from Customer Quote Processing to change the user status in a customer quote.

Use

The seller can use the inbound operation Change Customer Quote User Status to change the user status in a customer quote.

Features


CustomerQuoteUserStatusChangeRequest_sync

CustomerQuoteUserStatusChangeConfirmation_sync

The following values must be supplied:

CustomerQuote-ID

Value

CustomerQuote-StatusObject-UserStatusProfileCode

Value

CustomerQuote-StatusObject-UserStatus-Code

Value

CustomerQuote-StatusObject-UserStatus-ActiveIndicator

The following values must not be supplied:

CustomerQuote-ID schemeAgencyID

CustomerQuote-StatusObject-UserStatusProfileCode listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID

CustomerQuote-StatusObject-UserStatus-Code listAgencyID listAgencySchemeID listVersionID


SAP Documentation Enterprise SOA listAgencySchemeAgencyID listID

Error Handling


Integration

This inbound operation belongs to the Manage Customer Quote [Seite 195 ] inbound service interface.


Prerequisites


To change the user status in a customer quote, you must define a status profile in

Customizing and assign the sales document type ( IMG Sales & Distribution Sales

Sales Documents Define and Assign Status Profile ).

Processing

You can use the Business Add-In (BAdI) SLS_SE_CUSTOMERQUOTE001CHGRC for this operation.

Query Customer Quote In

Technical Data

Entity Type


Category

Mode

Service interface mySAP ERP enterprise services package

(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that a salesperson uses to search for customer quotes.

Use

The inbound service interface Query Customer Quote contains the operations that the seller can use to search for customer quotes according to various criteria.

Integration

The inbound service interface Query Customer Quote belongs to process component


Structure

Inbound service interface Query Customer Quote encompasses the following inbound operations:



CustomerQuoteBasicDataByBasicDataAndUserStatusQueryResponse_In ( Find

Customer Quote Basic Data by Basic Data and User Status [Seite 199 ] )

CustomerQuoteBasicDataByBuyerAndBasicDataQueryResponse_In ( Find Customer

Quote Basic Data by Buyer and Basic Data [Seite 202 ] )

CustomerQuoteBasicDataByBuyerAndIncompletnessQueryResponse_In ( Find

Customer Quote Basic Data by Buyer and Incompleteness [Seite 204 ] )

CustomerQuoteBasicDataByBuyerAndValidityPeriodQueryResponse_In ( Find

Customer Quote Basic Data by Buyer and Validity Period [Seite 205 ] )

Find Customer Quote Basic Data by Basic Data and User Status

Technical Data

Entity Type





ESR

Category

Mode


Service operation

CustomerQuoteBasicDataByBasicDataAndUserStatus



Inbound

Synchronous


Definition

Query to and response from Customer Quote Processing to retrieve basic data about customer quotes according to basic data and user status.

Use

Sellers can use the inbound operation Find Customer Quote Basic Data by Basic Data and

User Status to search for customer quotes according to basic data and user status.

Features


CustomerQuoteBasicDataByBasicDataAndUserStatusQuery_sync

CustomerQuoteBasicDataByBasicDataAndUserStatusResponse_sync

One of the following values must be delivered:

CustomerQuoteProcessingTypeCode

CustomerQuoteBuyerPartyInternalID

Value

CustomerQuoteSalesOrganisationPartyInternalID

Value


SAP Documentation

CustomerQuoteSalesOfficePartyInternalID

Value

CustomerQuoteSalesGroupPartyInternalID

Value

CustomerQuoteSalesTermsDistributionChannelCode

Value

CustomerQuoteSalesTermsDivisionCode

Value

CustomerQuoteStatusObjectUserStatusProfileCode

Value

CustomerQuoteStatusObjectUserStatusCode

Value

If the user status is to be used as search criteria, the

CustomerQuoteStatusObjectUserStatusProfileCode and the

CustomerQuoteStatusObjectUserStatusCode must be filled.


CustomerQuoteBuyerPartyInternalID schemeAgencyID schemeID

CustomerQuoteSalesOrganisationPartyInternalID schemeAgencyID schemeID

CustomerQuoteSalesOfficePartyInternalID schemeAgencyID schemeID

CustomerQuoteSalesGroupPartyInternalID schemeAgencyID schemeID

CustomerQuoteSalesTermsDistributionChannelCode listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID


ES for SAP ERP 2005

Enterprise SOA

200

SAP Documentation Enterprise SOA listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID

CustomerQuoteStatusObjectUserStatusProfileCode listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID

CustomerQuoteStatusObjectUserStatusCode listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID

Error Handling


Integration

This inbound operation belongs to the Query Customer Quote [Seite 198 ] inbound service interface.


Prerequisites


To use the user status as search criteria, you must define a status profile in Customizing and assign the sales document type ( IMG Sales & Distribution Sales Sales Documents

Define and Assign Status Profile ).

Processing

You can use the Business Add-In (BAdI) SLS_SE_CUSTOMERQUOTE001QR for this operation.



Find Customer Quote Basic Data by Buyer and

Basic Data

Technical Data

Entity Type





Category

Mode


Service operation

CustomerQuoteBasicDataByBuyerAndBasicData



Inbound

Synchronous


Definition

Query to and response from Customer Quote Processing to retrieve basic data about customer quotes according to customer and basic data.

Use

Sellers can use the inbound operation Find Customer Quote Basic Data by Buyer and Basic

Data to search for customer quotes according to customer and basic data.

Features


CustomerQuoteBasicDataByBuyerAndBasicDataQuery_sync

CustomerQuoteBasicDataByBuyerAndBasicDataResponse_sync



Value


CustomerQuoteSalesOrganisationPartyInternalID

Value

CustomerQuoteSalesOfficePartyInternalID

Value

CustomerQuoteSalesGroupPartyInternalID

Value


CustomerQuoteSalesTermsDistributionChannelCode

Value




Value



CustomerQuoteSalesOrganisationPartyInternalID schemeAgencyID schemeID

CustomerQuoteSalesOfficePartyInternalID schemeAgencyID schemeID

CustomerQuoteSalesGroupPartyInternalID schemeAgencyID schemeID

CustomerQuoteSalesTermsDistributionChannelCode listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID

CustomerQuoteSalesTermsDivisionCode listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID

Error Handling


Integration

This inbound operation belongs to the Query Customer Quote [Seite 198 ] inbound service interface.




Prerequisites


Processing



Incompleteness

Technical Data

Entity Type





Category

Mode


Service operation

CustomerQuoteBasicDataByBuyerAnd

IncompletenessQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous


Definition

Query to and answer from Customer Quote Processing to retrieve basic data about incomplete customer quotes according to customer.

Use

Sellers can use the inbound operation Find Customer Quote Basic Data by Buyer and

Incompleteness to search for incomplete customer quotes restricted according to customer.

Features


CustomerQuoteBasicDataByBuyerAndIncompletenessQuery_sync

CustomerQuoteBasicDataByBuyerAndIncompletenessResponse_sync



Value





Error Handling


Integration

This inbound operation belongs to inbound service interface Query Customer Quote [Seite

198 ] .


Prerequisites


Processing



Validity Period

Technical Data

Entity Type





Category

Mode


Service operation

CustomerQuoteBasicDataByBuyerAnd

ValidityPeriodQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous


Definition

Query to and answer from Customer Quote Processing to retrieve basic data about customer quotes according to customer and validity period.

Use

Sellers can use the inbound operation Find Customer Quote Basic Data by Buyer and Validity to search for customer quotes restricted according to customer and validity period.

Features


CustomerQuoteBasicDataByBuyerAndValidityPeriodQuery_sync

CustomerQuoteBasicDataByBuyerAndValidityPeriodResponse_sync





Value

CustomerQuoteDateTermsValidityStartDate

CustomerQuoteDateTermsValidityEndDate



Error Handling


Integration

This inbound operation belongs to inbound service interface Query Customer Quote [Seite

198 ] .


Prerequisites


Processing


Entries for Customer Quote

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that provide a list of the allowed entries for Customer Quote, restricted by additional criteria.

Use

The inbound service interface Entries for Customer Quote contains the operations that the buyer can use to search for allowed entries, restricted according to additional criteria.

Integration

The inbound service interface Entries for Customer Quote belongs to process component




Structure

Inbound service interface Entries for Customer Quote encompasses the following inbound operation:

CustomerQuoteAllowedUserStatusByProcessingTypeCodeQueryResponse_In ( Find

Allowed User Status by Processing Type Code [Seite 207 ] )

Find Allowed User Status by Processing Type

Code

Technical Data

Entity Type





Category

Mode


Service operation

CustomerQuoteAllowedUserStatusByProcessing

TypeCodeQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_CUSTOMERQUOTEF40001QR

Definition

Query to and response from Customer Quote Processing to find the permitted user status according to sales document type.

Use

The inbound operation Find Allowed User Status by Processing Type Code gives the seller a list of user statuses that are permitted for each sales document type.

Features


CustomerQuoteAllowedUserStatusByProcessingTypeCodeQuery_sync

CustomerQuoteAllowedUserStatusByProcessingTypeCodeResponse_sync



Error Handling


Integration

This inbound operation belongs to the Entries for Customer Quote [Seite 206 ] inbound service interface.




Prerequisites


To use the user status as search criteria, you must define a status profile in Customizing and assign the sales document type ( IMG Sales & Distribution Sales Sales Documents

Define and Assign Status Profile ).

Processing

You can use the Business Add-In (BAdI) SLS_SE_CUSTOMERQUOTEF4001QR for this operation.

Customer Return Processing

Technical Data

Entity Type




Use

The process component Customer Return Processing enables the provision of applications that a seller can use to process customer returns. A seller creates a customer return if a customer returns damaged goods or goods that were sold on a sale or return basis.


Prerequisites

Before you can use the operations in this process component, you must run SAP ECC Sales and Distribution (SD).

Customer Return

Technical Data

Entity Type




Definition

The request by a customer to the seller to take back delivered goods and reverse the sale.

Manage Customer Return In

Technical Data



Entity Type


Category

Mode



Inbound

Synchronous

Definition

A request to and confirmation from Customer Return Processing to create a customer return.

Use

The inbound service interface CustomerReturnCreateRequestConfirmation_In contains the operation that the seller can use to create a customer return for a customer.

Integration

The inbound service interface Manage Customer Return In belongs to process component

Customer Return Processing [Seite 208 ] and business object Customer Return [Seite 208 ] .

Structure

Inbound service interface Manage Customer Return In contains the following inbound operation:

CreateCustomerReturn ( Create Customer Return [Seite 209 ] )

Create Customer Return

Technical Data

Entity Type





Category

Mode


Service operation

CustomerReturnCreateRequestConfirmation_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_CustomerReturnCRTRC

Definition

Query to and confirmation from Customer Return Processing to create a customer return.

Use

The seller uses the inbound operation Create Customer Return to create a customer return for a customer.

Features


CustomerReturnCreateRequest



CustomerReturnCreateConfirmation

The following values must be delivered:

ProcessingTypeCode – Order type in the back end, for example, RE for return

BuyerParty-InternalID – Customer number (sold-to party in the back end)

Value

SalesOrganisationParty-InternalID – Customer’s sales organization in the back end

Value

SalesTerms-DistributionChannelCode – Customer’s distribution channel in the back end

Value

SalesTerms-DivisionCode – Customer’s division in the back end

Value

CustomerReturnReasonCode – Order reason for return in the back end

Value

Item-Product-SellerID- Material number of the product in the back end

Item-TotalValues-RequestedQuantity-UnitCode – Sales unit of the product in the back end

Item-TotalValues-RequestedQuantity – Desired delivery quantity for the product in the back end

Value

You must not use the following values:

BuyerID: schemeAgencySchemeAgencyID schemeAgencyID schemeID

BuyerParty-InternalID schemeAgencyID schemeID

SalesOrganisationParty-InternalID schemeAgencyID schemeID

SalesTerms-DistributionChannelCode: listAgencyID listAgencySchemeID listVersionID


SAP Documentation Enterprise SOA listAgencySchemeAgencyID listID

SalesTerms-DivisionCode: listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID

CustomerReturnReasonCode: listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID

Error Handling

Customer Return Processing carries out input checks and error handling. If an error occurs, the corresponding message is published in the message log.

If an error occurs while the order is being processed, processing is canceled. In this case, no return is created.

Integration

This inbound operation belongs to the Manage Customer Return In [Seite 208 ] inbound service interface.


Prerequisites

For more information, see Customer Return Processing [Seite 208 ] .

Processing

The back end delivers additional data from the master data (customer, material, and

Customizing)


Query Customer Return In

Technical Data

Entity Type





Category

Mode

Inbound

Synchronous

Definition

Group of operations to search for customer returns, restricted according to different criteria.

Use

The inbound service interface Query Customer Return In comprises operations that sellers can use to search for customer returns according to different criteria.

Integration

The inbound service interface Query Customer Return In is part of the Customer Return

Processing [Seite 208 ] process component and the Customer Return [Seite 208 ] business object.

Structure

The inbound service interface Query Customer Return In contains the following inbound operations:

CustomerReturnBasicDataByBuyerAndBasicDataQueryResponse_In ( Find Customer

Return Basic Data by Buyer and Basic Data [Seite 212 ] )

Find Customer Return Basic Data by Buyer and

Basic Data

Technical Data

Entity Type





Category

Mode


Service operation

CustomerReturnBasicDataByBuyerAnd

BasicDataQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_CustomerReturn001QR

Definition

Query to and answer from Customer Return Processing to retrieve basic data about customer returns, restricted according to customer and basic data.

Use

Sellers can use the inbound operation Find Customer Return Basic Data by Buyer and Basic

Data to search for customer returns according to customer and basic data.

Features


CustomerReturnBasicDataByBuyerAndBasicDataQuery



CustomerReturnBasicDataByBuyerAndBasicDataResponse


CustomerReturnBuyerPartyInternalID – Customer number (sold-to party in the back end)

Value

The following values can be delivered to restrict the selection:

CustomerReturnSalesOrganisationPartyInternallD – Customer’s sales organization in the back end

Value

CustomerReturnSalesOfficePartyInternallD – Sales office in the back end

Value

CustomerReturnSalesGroupPartyInternallD – Sales group in the back end

Value

CustomerReturnProcessingTypeCode – Order type in the back end

CustomerReturnSalesTermsDistributionChannelCode – Distribution channel in the back end

Value

CustomerReturnSalesTermsDivisionCode – Division in the back end

Value

The following values must not be used:

CustomerReturnBuyerPartyInternalID schemeAgencyID schemeID

CustomerReturnSalesOrganisationPartyInternalID schemeAgencyID schemeID

CustomerReturnSalesOfficePartyInternalID schemeAgencyID schemeID

CustomerReturnSalesGroupPartyInternalID schemeAgencyID schemeID

CustomerReturnSalesTermsDistributionChannelCode listAgencyID listAgencySchemeID


SAP Documentation Enterprise SOA listVersionID listAgencySchemeAgencyID listID

CustomerReturnSalesTermsDivisionCode listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID

Error Handling


Integration

This inbound operation belongs to the inbound service interface Query Customer Return In

[Seite 211 ] .


Prerequisites

For more information, see Customer Return Processing [Seite 208 ] .

Processing

You can use the Business Add-In (BAdI) SLS_SE_CUSTOMERRETURN001QR for this operation.

Engineering Change Processing

Technical Data

Entity Type


Process Component mySAP enterprise services package (as of

ESA ECC-SE 600)

Definition

Engineering Change Processing reflects the process of planning and tracking changes to various aspects of production basic data like Bills of Material , Bills of Operation , and materials, supporting changes based on history date.

Use

The Engineering Change Processing process component enables you to provide applications to find Engineering Change Requests and Engineering Change Orders, and to read and


SAP Documentation Enterprise SOA create Engineering Change Requests and Engineering Change Orders for your business process.


Prereqisites

You are running the SAP ECC Component Engineering Change Management (LO-ECH).

Engineering Change Order

Technical Data

Entity Type


Business Object mySAP ERP enterprise services package (as of ESA ECC-SE 600)

Definition

An Engineering Change Order is a set of instructions to make changes to a number of objects from the areas of engineering or production. It defines the conditions under which these changes become effective and specifies the release status of these.

Use

The Engineering Change Order business object contains operations that enable you to organize changes to several objects, for example Material, Production Bill of Material, and

Production Bill of Operations. By changing these objects with reference to an Engineering

Change Order the validity start dates of the Engineering Change Order determines when the changes become effective. The Engineering Change Order controls which objects can be changed with reference to that order.


Engineering Change Request [Seite 221 ]

Query Engineering Change Order In

Technical Data

Entity Type


Category

Mode

Service Interface mySAP ERP enterprise services package (as of ESA ECC-SE 600)

Inbound

Synchronous



Definition

Query Engineering Change Order In is a service interface that enables you to find

Engineering Change Orders for your business process from given search criteria.

Use

The Query Engineering Change Order In inbound service interface groups operations that enable you to find Engineering Change Orders that refer to a given Material or to a given

Production Bill of Material. Operations in this inbound service interface are relevant to all search-service business purposes.


Manage Engineering Change Order [Seite 218 ]

Integration

The Query Engineering Change Order In inbound service interface belongs to the

Engineering Change Processing process component and to the Engineering Change Order business object.

Structure

The Query Engineering Change Order In service interface groups the following inbound operations:

EngineeringChangeOrderSimpleByMaterialQueryResponse_In ( Find Engineering Change

Order by Material [Extern] )

EngineeringChangeOrderSimpleByProductionBillOfMaterialQueryResponse_In ( Find

Engineering Change Order by Production Bill of Material [Seite 217 ] )

Find Engineering Change Order by Material

Technical Data

Entity Type






Version in ESR

Category

Mode


Definition

Operation

EngineeringChangeOrderSimpleByMaterialQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_ENGNRNGCHANGEORDERBYMATQR



Definition

Find Engineering Change Order by Material is an operation that searches for Engineering

Change Orders that refer to a given material.

Use

The Find Engineering Change Order by Material inbound operation allows you to find

Engineering Change Orders with reference to which a given material was changed or will be changed. From the Engineering Change Order you can determine, for example, the reason for the change or the validity of the change.

Features


EngineeringChangeOrderSimpleByMaterialQuery_sync

EngineeringChangeOrderSimpleByMaterialResponse_sync


The message type EngineeringChangeOrderSimpleByMaterialQuery_sync receives the material ID, and the message type

EngineeringChangeOrderSimpleByMaterialResponse_sync returns identifying data for matching EngineeringChangeOrders.

For this inbound operation, the following Business Add-In (BAdI) is available in enhancement spot ECH_SPOT_SE_ECO:

ECH_SE_ECO_SMPL_BY_MAT_QR


Prerequisites

ECH_SE_ECO_SMPL_BY_MAT_QR can be run with the standard customizing.

Find Engineering Change Order by Production Bill of Material

Technical Data

Entity Type





Category

Mode

Operation

EngineeringChangeOrderSimpleByProduction

BillOfMaterialQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous


SAP Documentation


Enterprise SOA

ECC_ENGNRNGCHANGEORDERBYBOMQR

Definition

Find Engineering Change Order by Production Bill of Material is an operation that searches for Engineering Change Orders that refer to a given Production Bill of Material.

Use

The Find Engineering Change Order by Production Bill of Material inbound operation allows you to find Engineering Change Orders with reference to which a given Production Bill of

Material was changed or will be changed. From the Engineering Change Order you can determine, for example, the reason for the change or the validity of the change.

Features


EngineeringChangeOrderSimpleByProduction BillOfMaterialQuery_sync

EngineeringChangeOrderSimpleByProductionBillOfMaterialResponse_sync


The message type EngineeringChangeOrderSimpleByProductionBillOfMaterialQuery_sync receives the identifying elements of a Production Bill of Material , and the message type

EngineeringChangeOrderSimpleByPrroductionBillOfMaterialResponse_sync returns identifying data for matching EngineeringChangeOrders.


ECH_SE_ECO_SMPL_BY_BOM_QR


Prerequisites

ECH_SE_ECO_SMPL_BY_BOM_QR can be run with the standard customizing.

Manage Engineering Change Order In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous



Definition

Manage Engineering Change Order In is a service interface that contains operations to read and create an Engineering Change Order.

Use

The Manage Engineering Change Order In inbound service interface contains an operation that returns the detailed data of an Engineering Change Order and an operation that creates an Engineering Change Order . Operations in this inbound service interface are relevant to all business purposes where detailed information about an Engineering Change Order is needed or where a new Engineering Change Order must be created.


Query Engineering Change Order [Seite 215 ]

Integration

The Manage Engineering Change Order In inbound service interface belongs to the

Engineering Change Processing process component and to the Engineering Change Order business object.

Structure


EngineeringChangeOrderByIDQueryResponse_In ( Read Engineering Change Order

[Seite 220 ] )

EngineeringChangeOrderCreateRequestConfirmation_In ( Create Engineering Change

Order [Seite 219 ] )

Create Engineering Change Order

Technical Data

Entity Type

Technical Name in Enterprise

Service Repository (ESR)

Namespace in ESR

Software Component Version in

ESR

Category

Mode

Related Web Service Definition

Operation

EngineeringChangeOrderCreateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_ENGNRNGCHANGEORDERCRTRC



Definition

Create Engineering Change Order is an operation that creates an Engineering Change Order.

Use

The Create Engineering Change Order inbound operation is used when an Engineering

Change Order is needed and no approval process for this order is necessary.

Features


EngineeringChangeOrderCreateRequest_sync

EngineeringChangeOrderCreateConfirmation_sync


The message type EngineeringChangeOrderCreateRequest_sync receives the detailed data of an Engineering Change Order , and the message type

EngineeringChangeOrderCreateConfirmation_sync returns the ID of the newly created

Engineering Change Order .


ECH_SE_ECO_CRT_RC


Prerequisites

ECH_SE_ECO_CRT_RC can be run with the standard customizing.

Check RELESE KEY Customizing from Engineering Change Management.

Read Engineering Change Order

Technical Data

Entity Type

Technical Name in Enterprise Service

Repository (ESR)

Namespace in ESR

Software Component Version in ESR

Category

Mode


Operation

EngineeringChangeOrderByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_ENGNRNGCHANGEORDERBYIDQR



Definition

Read Engineering Change Order is an operation that reads detailed data of an Engineering

Change Order.

Use

The Read Engineering Change Order inbound operation reads and returns the detailed information of an Engineering Change Order with a given ID.

Features


EngineeringChangeOrderByIDQuery_sync

EngineeringChangeOrderByIDResponse_sync


The message type EngineeringChangeOrderByIDQuery_sync receives the Engineering

Change Order ID, and the message type EngineeringChangeOrderByIDResponse_sync returns detailed information about the Engineering Change Order.


ECH_SE_ECO_BY_ID_QR


Prerequisites

ECH_SE_ECO_BY_ID_QR can be run with the standard customizing.

Engineering Change Request

Technical Data

Entity Type



Definition

The Engineering Change Request business object contains the same functionality as the

Engineering Change Order but is enlarged with request functionality.



Use

After approval the Engineering Change Request becomes an Engineering Change Order and can be used for changes. During the request phase the Engineering Change Request cannot be used for changes.


Engineering Change Order [Seite 215 ]

Query Engineering Change Request In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Query Engineering Change Request In is a service interface that enables you to find

Engineering Change Requests for your business process from given search parameters.

Use

The Query Engineering Change Request In inbound service interface groups operations that enable you to find Engineering Change Requests that refer to a given Material or to a given

Production Bill of Material. Operations in this inbound service interface are relevant to all search-service business purposes.


Manage Engineering Change Request [Seite 225 ]

Integration

The Query Engineering Change Request In inbound service interface belongs to the

Engineering Change Processing process component and to the Engineering Change Request business object.

Structure

The Query Engineering Change Request In inbound service interface groups the following inbound operations:

EngineeringChangeRequestSimpleByMaterialQueryResponse_In ( Find Engineering

Change Request by Material [Seite 223 ] )



EngineeringChangeRequestSimpleByProductionBillOfMaterialQueryResponse_In

( Find Engineering Change Request by Production Bill of Material [Seite 224 ] )

Find Engineering Change Request by Material

Technical Data

Entity Type






Version in ESR

Category

Mode


Definition

Operation

EngineeringChangeRequestSimpleByMaterialQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_ENGNRNGCHNGEREQUESTBYMATQR

Definition

Find Engineering Change Request by Material is an operation that searches for Engineering

Change Requests that refer to a given material.

Use

The Find Engineering Change Request by Material inbound operation allows you to find

Engineering Change Requests with reference to which a given material was changed or will be changed. From the Engineering Change Request you can determine, for example, the reason for the change or the validity of the change.

Features


EngineeringChangeRequestSimpleByMaterialQuery_sync

EngineeringChangeRequestSimpleByMaterialResponse_sync


The message type EngineeringChangeRequestSimpleByMaterialQuery_sync receives the material ID, and the message type

EngineeringChangeRequestSimpleByMaterialResponse_sync returns identifying data for matching Engineering Change Requests.



SAP Documentation

ECH_SE_ECR_SMPL_BY_MAT_QR

Enterprise SOA


Prerequisites

ECH_SE_ECR_SMPL_BY_MAT_QR can be run with the standard customizing.

Find Engineering Change Request by Production

Bill of Material

Technical Data

Entity Type





Category

Mode


Operation

EngineeringChangeRequestSimpleByProduction

BillOfMaterialQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_ENGNRNGCHNGEREQUESTBYBOMQR

Definition

Find Engineering Change Request by Production Bill of Material is an operation that searches for Engineering Change Requests that refer to a given Production Bill of Material .

Use

The Find Engineering Change Request by Production Bill of Material inbound operation allows you to find Engineering Change Requests with reference to which a given Production

Bill of Material was changed or will be changed. From the Engineering Change Request you can determine, for example, the reason for the change or the validity of the change.

Features


EngineeringChangeRequestSimpleByProduction BillOfMaterialQuery_sync

EngineeringChangeRequestlSimpleByProductionBillOfMaterialResponse_sync


The message type EngineeringChangeRequestSimpleByProductionBillOfMaterialQuery_sync receives the identifying elements of a Production Bill of Material , and the message type

EngineeringChangeRequestSimpleByPrroductionBillOfMaterialResponse_sync returns identifying data for matching EngineeringChangeRequests.




ECH_SE_ECR_SMPL_BY_BOM_QR


Prerequisites

ECH_SE_ECR_SMPL_BY_BOM_QR can be run with the standard customizing.

Check RELESE KEY Customizing and Change Type Customizing from

Engineering Change Management (LO-ECH).

Manage Engineering Change Request In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Manage Engineering Change Request In is a service interface that contains operations to read and create an Engineering Change Request .

Use

The Manage Engineering Change Request In inbound service interface contains an operation that returns the detailed data of an Engineering Change Request and an operation that creates an Engineering Change Request . Operations in this inbound service interface are relevant to all business purposes where detailed information about an Engineering Change

Request is needed or where a new Engineering Change Request must be created.


Query Engineering Change Request [Seite 222 ]

Integration

The Manage Engineering Change Request In inbound service interface belongs to the

Engineering Change Processing process component and to the Engineering Change Request business object.



Structure


EngineeringChangeRequestByIDQueryResponse_In ( Read Engineering Change


EngineeringChangeRequestCreateRequestConfirmation_In ( Create Engineering

Change Request [Seite 227 ] )

Read Engineering Change Request

Technical Data

Entity Type





ESR

Category

Mode


Operation

EngineeringChangeRequestByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_ENGNRNGCHANGEREQUESTBYIDQR

Definition

Read Engineering Change Request is an operation that reads detailed data of an Engineering

Change Request .

Use

The Read Engineering Change Request inbound operation reads and returns the detailed information of an Engineering Change Request with a given Engineering Change Request ID.

Features


EngineeringChangeRequestByIDQuery_sync

EngineeringChangeRequestByIDResponse_sync


The message type EngineeringChangeRequestByIDQuery_sync receives the Engineering

Change Request ID, and the message type Engineering Change OrderByIDResponse_sync returns detailed information about the Engineering Change Request .




ECH_SE_ECR_BY_ID_QR


Prerequisites

ECH_SE_ECR_BY_ID_QR can be run with the standard customizing.

Create Engineering Change Request

Technical Data

Entity Type





Category

Mode


Definition

Operation

EngineeringChangeRequestCreateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_ENGNRNGCHANGEREQUESTCRTRC

Definition

Create Engineering Change Request is an operation that creates an Engineering Change

Request .

Use

The Create Engineering Change Request inbound operation is used when an Engineering

Change Request is needed and no approval process for this order is necessary.

Features


EngineeringChangeRequestCreateRequest_sync

EngineeringChangeRequestCreateConfirmation_sync


The message type EngineeringChangeRequestCreateRequest_sync receives the detailed data of an Engineering Change Request , and the message type



EngineeringChangeRequestCreateConfirmation_sync returns the ID of the newly created

Engineering Change Request .


ECH_SE_ECR_CRT_RC


Prerequisites

ECH_SE_ECR_CRT_RC can be run with the standard customizing.

Inbound Delivery Processing

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

Logistical control process that is triggered by a delivery request. The delivery request is the request from a vendor to a product recipient to receive goods.

Use

The process combines all tasks concerning the delivery process (preparation and triggering execution) and enables communication with the vendor and billing.


Prerequisites


Shipping (LE-SHP) .

Customer Returns Delivery

Technical Data

Entity Type


Business object mySAP ERP enterprise services package

(as of ECC-SE 600)

Definition

A group of goods that is sent back by a product recipient to a vendor. The business object is used in the returns process in sales order processing.



Use

Up until now, the methods of delivery processing were limited to the possibility of creating deliveries manually or with interfaces that use proprietary technologies.

To simplify communication between the shipping clerk and the Inbound Delivery Processing process component, new operations were defined that use commonly available technologies.

In this way, you can integrate applications that implement these operations without the need for complex project work.


OutboundDelivery

InboundDelivery

VendorReturnsDelivery

Manage Customer Returns Delivery In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Required in an A2X process to exchange delivery information between a shipping clerk and the Inbound Delivery Processing process component.

Use

The Manage Customer Returns Delivery In inbound service interface groups together operations with which the shipping clerk can process customer returns deliveries.

Integration

The Manage Customer Returns Delivery In inbound service interface belongs to the Inbound

Delivery Processing [Seite 228 ] process component and the Customer Returns Delivery

[Seite 228 ] business object.

Structure

The Manage Customer Returns Delivery In inbound service interface contains the following inbound operation:

CustomerReturnsDeliveryWithReferenceToCustomerReturnCreateRequestConfirmatio n_In ( Create Customer Returns Delivery [Seite 230 ] )



Create Delivery With Reference to Customer

Return

Technical Data

Entity Type





Category

Mode


Service operation

CustomerReturnsDeliveryWithReferenceTo

CustomerReturnCreateRequestConfirmation_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_CUSTOMERRETURNSDLVCRTRC

Definition

Request to and confirmation from Inbound Delivery Processing to create a customer returns delivery.

Use

A shipping clerk uses the Create Customer Returns Delivery inbound operation to create a customer returns delivery with reference to a returns order.

Features


CustomerReturnsDeliveryWithReferenceToCustomerReturnCreateRequest_sync

CustomerReturnsDeliveryWithReferenceToCustomerReturnCreateConfirmation_sync


To create a customer returns delivery with reference to a returns order, the reference to a returns order must be specified.

Entering a due date is optional. If you do not enter a date, all returns order items are delivered.

Entering a goods receiving point is optional. If you do not enter a goods receiving point, the operation tries to determine a goods receiving point from the returns order.

The operation enables you to specify serial numbers for the returns order items. To do this, you must enter the returns order, the returns order item, and the serial number.

It is also possible to specify delivery quantities for the individual items.

Error Handling

If errors occur, the process is aborted and a corresponding message is sent to the application.

Integration

This inbound operation belongs to the Manage Customer Returns Delivery In [Seite 229 ] inbound service interface.



Constraints

It is not possible to create customer returns deliveries without a reference to a returns order.


Prerequisites

For more information, see Inbound Delivery Processing [Seite 228 ] .

Processing

The Business Add-In (BAdI) SHP_SE_CUSTOMERRETURNSDLVCRTRC is available for this operation.

Inspection Master Data Processing

Technical Data

Entity Type



(as of ECC-SE 600)

Use

Quality inspections for goods receipts and goods issues are examples of business transactions where quality problems can arise.

For example, a quality inspector receives a container with computer monitors.

One of the monitors in the delivery is defect. To record a quality issue notification, the quality inspector looks for the code ‘Defect Monitor’ in the code group ‘Error’ in the catalog 'Material Inspection'.


To use the operations in the process component, you must implement SAP ECC Quality

Management (QM) .

Quality Issue Category Catalogue

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

A hierarchically structured catalog of categories, which classify quality-related issues for a particular quality aspect.



Use

Quality inspectors can use the business object Quality Issue Category Catalogue to group in coded form any issues (for example, error type, error location, causes, measures, usage decisions) that are needed in QM processes.

Here is an example:

Catalog: Error

ParentCategory (Code group): Defect monitor

CategoryID (Code): No picture, image flickers


To use the operations in this business object, you must implement the component SAP ECC

Quality Management (QM) and have performed the basic Customizing settings for this component.

Manage Quality Issue Category Catalogue In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for processing a catalog about quality-related issues.

Use

The inbound service interface Manage Quality Issue Category Catalogue In groups operations that quality inspectors or employees can use to process catalogs about qualityrelated issues.

Integration

The inbound service interface Manage Quality Issue Category Catalogue In belongs to the process component Inspection Master Data Processing [Seite 231 ] and the business object

Quality Issue Category Catalogue [Seite 231 ] .

Structure

The Manage Quality Issue Category Catalogue In inbound service interface contains the following inbound operation:

QualityIssueCategoryCatalogueCategoryByIDQueryResponse_In ( Read Quality Issue

Category Catalogue Category by ID [Seite 233 ] ).



Read Quality Issue Category Catalogue Category

Technical Data

Entity Type





Category

Mode

Relevant Web Service Definition

Service operation

QualityIssueCategoryCatalogueCategory

ByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_QUALITYISSUECATIDQR

Definition

A query to and response from Inspection Master Data Processing to read the

QualityIssueCategoryCatalogueCategory from the catalog for quality issues using the

CatalogueID.

The CategoryID is the same as the code in SAP ECC and the ParentCategoryID is the same as the code group.

Use

The Read Quality Issue Category Catalogue Category by ID inbound operation reads, for example, all code groups of all catalog types that are necessary for notification processing, defects recording, characteristic value assignment, and usage decision.

Features


QualityIssueCategoryCatalogueCategoryByIDQuery_sync

QualityIssueCategoryCatalogueCategoryByIDRequest_sync

The following values must be provided:

QualityIssueCategoryCatalogueID (mandatory)

CategoryParentQualityIssueCategoryID (optional)

ProfileIssueCategoryFilterCode (optional)

LanguageCode (optional)

The following values are returned:


QualityIssueCategoryTypeCode (mandatory)

QualityIssueCategoryTypeName (optional)

QualityIssueCategoryCatalogueName (optional)

QualityIssueCategoryID (mandatory)

ParentQualityIssueCategoryID (optional)



QualityIssueCategoryName (optional)

QualityIssueCategoryDescription (optional)

Error Handling


Integration

This inbound operation belongs to the Manage Quality Issue Category Catalogue In [Seite

232 ] inbound service interface.


Prerequisites

For more information, see Quality Issue Category Catalogue [Seite 231 ] .

Processing

The QUM_SE_QUALITYISSUECATIDQR Business Add-In (BAdI) is available for this operation.

Query Quality Issue Category Catalogue In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations for searching for catalogs about maintenance-related issues.

Use

The inbound service interface Query Quality Issue Category Catalogue In groups operations for searching catalogs about quality-related issues, restricted according to certain selection criteria.

Integration

The inbound service interface Query Quality Issue Category Catalogue In belongs to the process component Inspection Master Data Processing [Seite 231 ] and the business object

Quality Issue Category Catalogue [Seite 231 ] .

Structure

The Query Quality Issue Category Catalogue In inbound service interface contains the following inbound operation:

QualityIssueCategoryCatalogueSimpleByProfileQualityRequestTypeCodeQueryRespo nse_In ( Find Quality Issue Category Catalogue by Profile Quality Issue N [Seite 235 ] )



Find Quality Issue Category Catalogue by Quality

Issue Notification Type

Technical Data

Entity Type





Category

Mode


Service operation

QualityIssueCategoryCatalogueSimple

ByProfileQualityIssueNotificationTypeCode



Inbound

Synchronous

ECC_QUALITYISSUECAT1BYQR

Definition

A query to and response from Inspection Master Data Processing to read the catalogs for quality issues using the QualityIssueNotificationTypeCode.

A QualityIssueNotification is the same as a quality notification in SAP ECC and the TypeCode is the same as the notification type.

Use

The Find Quality Issue Category Catalogue by Quality Issue Notification Type inbound operation finds all catalog types that are necessary for notification creation and defects recording.

Features


QualityIssueCategoryCatalogueSimpleByProfileQualityIssueNotificationTypeCodeQuer y_sync

QualityIssueCategoryCatalogueSimpleByProfileQualityIssueNotificationTypeCodeRes ponse_sync

The following values must be provided:

ProfileQualityIssueNotificationTypeCode (mandatory)




QualityIssueCategoryTypeCode (mandatory)

QualityIssueCategoryTypeName (optional)

QualityIssueCategoryCatalogueName (optional)

Error Handling




Integration

This inbound operation belongs to the Query Quality Issue Category Catalogue In [Seite 234 ] inbound service interface.


Prerequisites

For more information, see Quality Issue Category Catalogue [Seite 231 ] .

Processing

The QUM_SE_QUALITYISSUECAT1BYQR Business Add-In (BAdI) is available for this operation.

Installed Base Data Processing

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

The management and structuring of installed objects in an installed base according to their logical or physical location.

Use

The Installed Base Data Processing process component provides applications with which a maintenance technician can process Installation Points.

An Installation Point is the same as a functional location in SAP ECC .


Prerequisites

To be able to use the operations contained in the process component, you must run SAP

ECC Plant Maintenance (PM).

Installation Point

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

A physical or logical location at which a business object, for example, software or a material is installed during a period of time.



An Installation Point contains descriptive information about its installed object, for example, the quantity of materials used. It can be structured in a hierarchical relationship with other

Installation Points .


Use

A maintenance technician requires detailed information about Installation Points to be able to plan and carry out maintenance tasks on them.

Related business objects:

Individual Material

Business Partner

Warranty

Attachment Folder


Prerequisite


Functional Locations (PM-EQM-FL) component and have made the basic Customizing settings for this component.

Query Installation Point In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that provide data for Installation Points.


Use

The Query Installation Point In inbound service interface groups operations with which an employee can search for Installation Points according to various criteria.

Integration

The Query Installation Point In inbound service interface belongs to the Installed Base Data

Processing [Seite 236 ] process component and the Installation Point [Seite 236 ] business object.



Structure

The Query Installation Point In inbound service interface contains the following inbound operation:

InstallationPointByIDQueryResponse_In ( Find Installation Point by Elements [Seite

238 ] )

Find Installation Point by Elements

Technical Data

Entity Type





Category

Mode


Service operation

InstallationPointSimpleByElementsQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_INSTALLATIONPOINTSELQR

Definition

A query to and response from Installed Base Data Processing to search for an Installation

Point according to specific data.

Use

The Find Installation Point by ID inbound operation allows employees to search for Installation

Points according to different criteria. The employee receives a list of all Installation Points , based on the description and category of the Installation Point .


Features


InstallationPointSimpleByElementsQuery_sync

InstallationPointSimpleByElementsResponse_sync


Description of Installation Point

Category of Installation Point

Error Handling





Prerequisites

For more information, see Installation Point [Seite 236 ] .

Processing

The EAM_SE_IP_SE_QR Business Add-In (BAdI) is available for this operation.

Manage Installation Point

Technical Data

Entity Type


Category

Mode



Inbound

Synchronous

Definition

Group of operation for processing installation points.


Use

The Manage Installation Point inbound service interface groups operations with which an employee can process Installation Points .

Integration

The Installation Point Action inbound service interface belongs to the Installed Base Data


Structure

The Manage Installation Point inbound service interface groups the following inbound operations:

InstallationPointByIDQueryResponse_In ( Read Installation Point [Seite 239 ] )

InstallationPointUserStatusChangeRequestConfirmation_In ( Change Installation Point

User Status [Seite 240 ] )

Read Installation Point

Technical Data

Entity Type



Service operation

InstallationPointByIDQueryResponse_In





Category

Mode

Related Web Service Definition http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_INSTALLATIONPOINIDQR

Definition

A query to and response from Installed Base Data Processing to provide data for Installation

Points after identification.

Use

The Read Installation Point by ID inbound operation allows an employee to display detail data for an Installation Point after identification.


Features


InstallationPointByIDQuery_sync

InstallationPointByIDResponse_sync


ID of Installation Point

Error Handling


Integration

This inbound operation belongs to the Query Installation Point [Seite 237 ] inbound service interface.


Prerequisites


Processing

The EAM_SE_IP_BYIPID_QR Business Add-In (BAdI) is available for this operation.

Change Installation Point User Status

Technical Data

Entity Type




Service operation

InstallationPointUserStatusChangeRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global




Category

Mode


Definition


Inbound

Synchronous

ECC_INSTALLATIONPOINTUSCRC

Definition

Query to and confirmation from Installed Base Data Processing to change the user status in the Installation Point .

Use

Employees can use the inbound operation Change Installation Point User Status to activate or deactivate user status in the Installation Point.

A Installation Point corresponds to a functional location in SAP ECC .

Features


InstallationPointUserStatusChangeRequest_sync

InstallationPointUserStatusChangeConfirmation_sync

Error Handling


Constraints

Although this service’s input message type contains an element MessageHeader/UUID , the service does not support idempotent behavior as described in the mySAP Service

Provisioning Handbook . Since support for idempotent behavior may be added in the future, we recommend that you do not use this UUID element for the time being.

Integration

This inbound operation belongs to the Manage Installation Point [Seite 239 ] inbound service interface.


Prerequisites


Processing

You can use the Business Add-In (BAdI) EAM_SE_IP_USC_QR for this operation.

Installation Point Action In

Technical Data



Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations for installing and dismantling an Individual Material at an Installation

Point.

An Individual Material corresponds to a piece of equipment in SAP ECC.

An Installation Point corresponds to a functional location.

Use

The Installation Point Action In inbound service interface encompasses the operations that an employee can use to install and dismantle an Individual Material at an Installation Point.

Integration

The Installation Point Action In inbound service interface belongs to the Installed Base Data


Structure

The inbound service interface Installation Point Action In groups the following inbound operations:

Install Individual Material [Seite 242 ]

Dismantle Individual Material [Seite 243 ]


Prerequisites

To be able to use the operations of this service interface, you must have implemented the

Functional Locations (PM-EQM-FL) component and have made the basic Customizing settings for this component.

You also require knowledge of the Technical Objects (PM-EQM) component.

Install Individual Material

Technical Data

Entity Type





Category

Service operation

InstallationPointInstallIndividualMaterial

RequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound



Mode


Synchronous

ECC_INSTALLATIONPOINTINSTRC

Definition

A request to and confirmation from Installed Base Data Processing to install an Individual

Material at an Installation Point.

An Individual Material corresponds to equipment in SAP ECC. An Installation Point corresponds to a functional location.

Use

The Install Individual Material inbound operation enables an employee to install an Individual


Features


InstallationPointInstallIndividualMaterialRequest_sync

InstallationPointInstallIndividualMaterialConfirmation_sync


Identification under the InstallationPoint node

Identification of the Individual Material under the InstalledObject node

Error Handling


Integration

This inbound operation belongs to the Installation Point Action [Seite 241 ] inbound service interface.


Prerequisites

For more information, see Installation Point Action [Seite 241 ] .

Processing

Business Add-In (BAdI) EAM_SE_IP_IM_INST_RC is available for this operation.

Dismantle Individual Material

Technical Data

Entity Type




Service operation

InstallationPointDismantleIndividualMaterial





Category

Mode



Inbound

Synchronous

ECC_INSTALLATIONPOINTDISRC

Definition

A request to and confirmation from Installed Base Data Processing to dismantle an Individual


An individual material corresponds to equipment in SAP ECC. An installation point corresponds to a functional location.

Use

The Dismantle Individual Material inbound operation enables an employee to dismantle an

Individual Material at an Installation Point.

Features


InstallationPointDismantleIndividualMaterialRequest_sync

InstallationPointDismantleIndividualMaterialConfirmation_sync


Identification under the InstallationPoint node

Identification of the Individual Material under the InstalledObject node

Error Handling


Integration

This inbound operation belongs to the Installation Point Action [Seite 241 ] inbound service interface.


Prerequisites

For more information, see Installation Point Action [Seite 241 ] .

Processing

Business Add-In (BAdI) EAM_SE_IP_DIS_RC is available for this operation.

Inventory Processing

Technical Data

Entity Type





Definition

The administration and processing of all tasks necessary for recording stock changes and other transactions.

Use

The different areas of a company such as planning, production, sales and distribution, controlling, and financial accounting all need details of the quantities of raw materials, semifinished goods, finished products, and trading goods in stock. Customers and suppliers might also be interested in having this information.

Inventory processing allows you to get and update details of the current stock, expected stock, and the content of the logistics units as well as the identified logistics units.


Prerequisites

To use the operations in the process component, you must implement SAP ECC Inventory

Management (MM-IM) .

Inventory

Technical Data

Entity Type



Definition

Quantity of all materials in a specific location, resource, or logistics area. Quantities of products can be grouped physically in handling units.

Query Inventory In

Technical Data

Entity Type


Category

Mode

Definition

Group of operations for supplying inventory data.


Inbound

Synchronous

Use

The inbound service interface Query Inventory In groups operations that supply data about stocks.



Integration

The inbound service interface Query Inventory In belongs to the process component

Inventory Processing [Seite 244 ] and the business object Inventory [Seite 245 ] .

Structure

The inbound service interface Query Inventory In contains the following inbound operations:

InventoryByMaterialAndLocationQueryResponse_In ( Find Inventory by Material and

Location [Seite 246 ] )

Find Inventory by Material and Location

Technical Data

Entity Type





Category

Mode


Service operation

InventoryByMaterialAndLocation



Inbound

Synchronous

ECC_INVENTORY001QR

Definition

Query to and answer from Inventory Processing to find stock by material and location.

Use

The inbound operation Find Inventory by Material and Location supplies employees with a list of stock by material and location.

Features


InventoryByMaterialAndLocationQuery_sync

InventoryByMaterialAndLocationResponse_sync

You can call the operation with initial values for material and location. However, you can also use single values and/or intervals. If you use single values or intervals, you must also enter a corresponding IntervalBoundaryTypeCode and fill the upper and lower limits accordingly. The

InclusionExclusionCode is optional, although it is set at I in the standard system.

Error Handling


Integration

This inbound operation belongs to the Query Inventory In [Seite 245 ] inbound service interface.



Constraints

The operation only returns unrestricted stock of materials at plant level. Special stock is also not taken into account.


Prerequisites


Inventory Management (MM-IM) and have performed the basic Customizing settings for this component. You have also defined your company as customer-specific.

Processing

You can use the Business Add-In (BAdI) NV_SE_INVENTORY001QR for this operation.

Maintenance Processing

Technical Data

Entity Type



(as of ECC-SE 600)

Use

The Maintenance Processing process component covers breakdown maintenance, which comprises the steps requesting maintenance tasks, planning and executing them, and completing them.

Constraints

It is not possible to create external operations or service operations and non-stock materials.


Prerequisites

To be able to use the operations contained in this process component, you must run SAP

ECC Plant Maintenance (PM).

Maintenance Request

Technical Data

Entity Type



Definition

Instruction that requests maintenance activity for a maintenance object.



Use

The business object Maintenance Request is used to request maintenance work.


Prerequisites

To use the operations in this business object, you must implement the component

Maintenance Notifications (PM-WOC-MN) and have performed the basic Customizing settings for this component.

Maintenance Request Action In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for releasing and closing maintenance requests.

Use

The inbound service interface Maintenance Request Action In groups operations that maintenance employees can use to release and close maintenance requests.

Integration

The inbound service interface Maintenance Request Action In belongs to the process component Maintenance Processing [Seite 247 ] and the business object Maintenance

Request [Seite 247 ] .

Structure

The Maintenance Request Action In inbound service interface groups the following inbound operations:

MaintenanceRequestReleaseRequestConfirmation_In ( Release Maintenance Request

[Seite 248 ] )

MaintenanceRequestCloseRequestConfirmation_In ( Close Maintenance Request

[Seite 249 ] )

Release Maintenance Request

Technical Data








Category

Mode


MaintenanceRequestReleaseRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCEREQUESTRELRC

Definition

Query to and confirmation from Maintenance Processing to release a maintenance request.

Use

Maintenance employees can use the inbound operation Release Maintenance Request to release a maintenance request.

Features


MaintenanceRequestReleaseRequest_sync

MaintenanceRequestReleaseConfirmation_sync

Error Handling


Integration

This inbound operation belongs to the Maintenance Request Action In [Seite 248 ] inbound service interface.


Prerequisites

For more information, see Maintenance Request [Seite 247 ] .

Processing

You can use the Business Add-In (BAdI) EAM_SE_MR_RE_RC for this operation.

Close Maintenance Request

Technical Data

Entity Type





Service operation

MaintenanceRequestCloseRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global




Category

Mode


Inbound

Synchronous

ECC_MAINTENANCEREQUESTCLSRC

Definition

Query to and confirmation from Maintenance Processing to close a maintenance request.

Use

Maintenance employees can use the inbound operation Close Maintenance Request to close a maintenance request.

Features


MaintenanceRequestCloseRequest_sync

MaintenanceRequestCloseConfirmation_sync

Error Handling


Integration

This inbound operation belongs to the Maintenance Request Action In [Seite 248 ] inbound service interface.


Prerequisites


Processing

You can use the Business Add-In (BAdI) EAM_SE_MR_CLS_RC for this operation.

Manage Maintenance Request In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for processing maintenance requests.



Use

The inbound service interface Manage Maintenance Request In groups operations that employees can use to process maintenance requests.

Integration

The inbound service interface Manage Maintenance Request In belongs to the process component Maintenance Processing [Seite 247 ] and the business object Maintenance


Structure

The Manage Maintenance Request In inbound service interface groups the following inbound operations:

MaintenanceRequestCreateRequestConfirmation_In ( Create Maintenance Request

[Seite 251 ] )

MaintenanceRequestByIDQueryResponse_In ( Read Maintenance Request [Seite

252 ] )

MaintenanceRequestChangeRequestConfirmation_In ( Change Maintenance Request

[Seite 254 ] )

MaintenanceRequestChangeCheckQueryResponse_In ( Check Maintenance Request

Change [Seite 253 ] )

Create Maintenance Request

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceRequestCreateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCEREQUESTCRTRC

Definition

Query to and confirmation from Maintenance Processing to create a maintenance request.

Use

Maintenance employees can use the inbound operation Create Maintenance Request to create a maintenance request.

Features


MaintenanceRequestCreateRequest_sync



MaintenanceRequestCreateConfirmation_sync

Error Handling


Integration

This inbound operation belongs to the Manage Maintenance Request In [Seite 250 ] inbound service interface.


Prerequisites


Processing

You can use the Business Add-In (BAdI) EAM_SE_MR_CRT_RC for this operation.

Read Maintenance Request

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceRequestByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCEREQUESTIDQR

Definition

Query to and answer from Maintenance Processing to provide data from a maintenance request.

Use

Maintenance employees can use the inbound operation Read Maintenance Request to display a maintenance request.

Features


MaintenanceRequestByIDQuery_sync

MaintenanceRequestByIDResponse_sync



Error Handling


Integration



Prerequisites


Processing

You can use the Business Add-In (BAdI) EAM_SE_MR_ID_QR for this operation.

Check Maintenance Request Change

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceRequestChangeCheckQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCEREQUESTCHCQR

Definition

A query to and response from Maintenance Processing whether a maintenance request can be changed.

Use

The Check Change Maintenance Request inbound operation is used to check whether a maintenance request can be changed with the specified data. It is executed in test mode and does not transfer any changes to the back end.

Features


MaintenanceRequestChangeCheckQuery_sync

MaintenanceRequestChangeCheckResponse_sync

Error Handling




Integration



Prerequisites


Processing

The EAM_SE_MR_CHC_RC Business Add-In (BAdI) is available for this operation.

Change Maintenance Request

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceRequestChangeRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCEREQUESTCHGRC

Definition

Query to and confirmation from Maintenance Processing to change a maintenance request.

Use

Maintenance employees can use the inbound operation Change Maintenance Request to change a maintenance request.

Features


MaintenanceRequestChangeRequest_sync

MaintenanceRequestChangeConfirmation_sync

Error Handling


Integration





Prerequisites


Processing

You can use the Business Add-In (BAdI) EAM_SE_MR_CHG_RC for this operation.

Entries for Maintenance Request In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that provide data for maintenance requests.

Use

The Entries for Maintenance Request In inbound service interface groups operations that provide data for maintenance requests.

Integration

The Entries for Maintenance Request In inbound service interface belongs to the

Maintenance Processing [Seite 247 ] process component and the Maintenance Request [Seite

247 ] business object.

Structure

The Entries for Maintenance Request In inbound service interface contains the following inbound operation:

MaintenanceRequestImportanceCodeByTypeCodeQueryResponse_In ( Find Allowed

Importance by Request Type [Seite 255 ] )

MaintenanceRequestSimpleByIndividualMaterialAndInstallationPointQueryResponse_I n ( Find Maintenance Request by Individual Material and Installation [Seite 256 ] )

Find Allowed Importance by Request Type

Technical Data

Entity Type



Service operation

MaintenanceRequestImportanceCodeByType

CodeQueryResponse_In





Category

Mode



Inbound

Synchronous

ECC_MAINTENANCEREQUEST002QR

Definition

Query to and answer from Maintenance Processing to find allowed importances for each request type.

Use

The inbound operation Find Allowed Importance by Request Type supplies employees with a list of the importance keys that are allowed per maintenance request type.

Features


MaintenanceRequestImportanceCodeByTypeCodeQuery_sync

MaintenanceRequestImportanceCodeByTypeCodeResponse_sync

Error Handling


Integration

This inbound operation belongs to the Entries for Maintenance Request In [Seite 255 ] inbound service interface.


Prerequisites


Processing

You can use the Business Add-In (BAdI) EAM_SE_MR_IMP_QR for this operation.

Find Maintenance Request by Individual Material and Installation Point

Technical Data

Entity Type





Service operation

MaintenanceRequestSimpleByIndividualMaterial

AndInstallationPointQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global




Category

Mode


Inbound

Synchronous

ECC_MAINTENANCEREQUEST001QR

Definition

A request to and response from Maintenance Processing to find a maintenance request, restricted according to Individual Material or Installation Point.

An Individual Material corresponds to a piece of equipment in SAP ECC.

An Installation Point corresponds to a functional location.

Use

The Find Maintenance Request Simple by Individual Material And Installation Point inbound operation enables the maintenance employee to search for a maintenance request, restricted according to the selection criteria equipment and/or functional location.

Features


MaintenanceRequestSimpleByIndividualMaterialAndInstallationPointQuery_sync

MaintenanceRequestSimpleByIndividualMaterialAndInstallationPointResponse_sync


IndividualMaterialID or

InstallationPointID or

IndividualMaterialID and InstallationPointID

Error Handling


Integration

This inbound operation belongs to the Entries for Maintenance Request In [Seite 255 ] inbound service interface.


Prerequisites


Processing

The EAM_SE_MR_SIM_QR Business Add-In (BAdI) is available for this operation.

Maintenance Order

Technical Data

Entity Type

ES for SAP ERP 2005

Business object

257



(as of ECC-SE 600)

Definition

An instruction to a work center to perform a maintenance activity on a maintenance object.

Use

The Maintenance Order business object is used in maintenance order cycles to describe the maintenance work that needs to be done. It is used to do the following:

Create capacity requirements

Create reservations

Request external work or material

Collect costs


Prerequisites


Maintenance Orders (PM-WOC-MO) component and have made the basic Customizing settings for this component.

Query Maintenance Order In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Use

The Query Maintenance Order In inbound service interface groups operations that provide data for maintenance orders.

Integration

The Query Maintenance Order In inbound service interface belongs to the Maintenance

Processing [Seite 247 ] process component and the Maintenance Order [Seite 257 ] business object.

Structure

The Query Maintenance Order In inbound service interface contains the following inbound operation:



MaintenanceOrderSimpleByBasicDataQueryResponse_In ( Find Maintenance Order by

Basic Data [Seite 259 ] )

Find Maintenance Order by Basic Data

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceOrderSimpleByBasicDataQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCEORDERSBDQR

Definition

A query to and response from Maintenance Processing to provide maintenance order data according to specific basic data.

Use

The inbound operation Find Maintenance Order Simple by Basic Data is used by a maintenance employee to search for a maintenance order according to specific data.

Features


MaintenanceOrderSimpleByBasicDataQuery_sync

MaintenanceOrderSimpleByBasicDateResponse_sync


If you do not enter a time period for selection for BasePeriod, only orders from the last

90 days are selected.

Error Handling


Integration

This inbound operation belongs to the Query Maintenance Order [Seite 258 ] inbound service interface.


Prerequisites

For more information, see Maintenance Order [Seite 257 ] .


SAP Documentation

Processing

Business Add-In (BAdI) EAM_SE_MO_SBD_QR is available for this operation.

Enterprise SOA

Maintenance Order Action In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Use

The Maintenance Order Action In inbound service interface groups operations with which a maintenance employee can release and technically complete maintenance orders.

Integration

The Maintenance Order Action In inbound service interface belongs to the Maintenance


Structure


MaintenanceOrderReleaseRequestConfirmation_In ( Release Maintenance Order

[Seite 260 ] )

MaintenanceOrderTechnicalCloseRequestConfirmation_In ( Technical Close

Maintenance Order [Seite 261 ] )

MaintenanceOrderCheckReleaseQueryResponse_In ( Check Release Maintenance


MaintenanceOrderCheckTechnicalCloseQueryResponse_In ( Check Technical Close

Maintenance Order [Seite 263 ] )

Release Maintenance Order

Technical Data

Entity Type





Category

Service operation

MaintenanceOrderReleaseRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound



Mode


Synchronous

ECC_MAINTENANCEORDERRELRC

Definition

A request to and confirmation from Maintenance Processing to release a maintenance order.

Use

The Release Maintenance Order inbound operation allows a maintenance employee to release a maintenance order.

Features


MaintenanceOrderReleaseRequest

MaintenanceOrderReleaseConfirmation

Error Handling


Integration

This inbound operation belongs to the Maintenance Order Action In [Seite 260 ] inbound service interface.


Prerequisites


Processing

The EAM_SE_MO_REL_RC Business Add-In (BAdI) is available for this operation.

Technically Close Maintenance Order

Technical Data




MaintenanceOrderTechnicalCloseRequestConfirmation_In



Category

Mode


Inbound

Synchronous

ECC_MAINTENANCEORDERTECORC

Definition

A request to and confirmation from Maintenance Processing to complete a maintenance order.



Use

The Technical Close Maintenance Order inbound operation allows a maintenance employee to technically complete a maintenance order.

Features


MaintenanceOrderTechnicalCloseRequest_sync

MaintenanceOrderTechnicalCloseConfirmation_sync

Error Handling


Integration



Prerequisites


Processing

The EAM_SE_MO_TECO_RC Business Add-In (BAdI) is available for this operation.

Check Maintenance Order Release

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceOrderReleaseCheckQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCEORDERRELCHKQR

Definition

A query to and response from Maintenance Processing to check whether a maintenance order can be released with the data specified.

Use

The Check Maintenance Order Release inbound operation is used to check whether a maintenance order can be released with the specified data.



Features


MaintenanceOrderReleaseCheckQuery_sync

MaintenanceOrderReleaseCheckResponse_sync

Error Handling


Integration



Prerequisites


Processing

The EAM_SE_MO_REL_CHK_QR Business Add-In (BAdI) is available for this operation.

Check Technical Close Maintenance Order

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceOrderTechnicalCloseCheckQueryResponse_In

Inbound

Synchronous

ECC_MAINTENANCEORDERTECOCHKQR

Definition

A query to and response from Maintenance Processing to check whether a maintenance order can be technically completed with the data specified.

Use

The Check Technical Close Maintenance Order inbound operation is used to check whether a maintenance order can be technically completed with the specified data.

Features


MaintenanceOrderTechnicalCloseCheckQuery_sync



MaintenanceOrderTechnicalCloseCheckResponse_sync

Error Handling


Integration



Prerequisites


Processing

The EAM_SE_MO_TECO_CHK_QR Business Add-In (BAdI) is available for this operation.

Manage Maintenance Order In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Use

The Manage Maintenance Order In inbound service interface groups operations with which a maintenance employee can create, display, and change maintenance orders. He or she can also check whether maintenance orders can be created or changed.

Integration

The Manage Maintenance Order In inbound service interface belongs to the Maintenance


Structure

The Manage Maintenance Order inbound service interface groups the following inbound operations:

MaintenanceOrderByIDQueryResponse_In ( Read Maintenance Order [Seite 265 ] )

MaintenanceOrderCreateRequestConfirmation_In ( Create Maintenance Order [Seite

266 ] )

MaintenanceOrderChangeRequestConfirmation_In ( Change Maintenance Order [Seite

266 ] )

MaintenanceOrderCreateCheckQueryResponse_In ( Check Create Maintenance Order

[Seite 267 ] )



MaintenanceOrderChangeCheckQueryResponse_In ( Check Change Maintenance


Read Maintenance Order

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceOrderByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCEORDERBYIDQR

Definition

A query to and response from Maintenance Processing to provide data for a maintenance order.

Use

The Read Maintenance Order inbound operation allows a maintenance employee to display a maintenance order.

Features


MaintenanceOrderByIDResponse_sync

MaintenanceOrderByIDQuery_sync

Error Handling


Integration

This inbound operation belongs to the Manage Maintenance Order In [Seite 264 ] inbound service interface.


Prerequisites


Processing

The EAM_SE_MO_BYID_QR Business Add-In (BAdI) is available for this operation.



Create Maintenance Order

Technical Data

Entity Type





Category

Mode


Operation

MaintenanceOrderCreateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCEORDERCRTRC

Definition

A request to and confirmation from Maintenance Processing to create a maintenance order.

Use

The Create Maintenance Order inbound operation allows a maintenance employee to create a maintenance order.

Features


MaintenanceOrderCreateRequest_sync

MaintenanceOrderCreateConfirmation_sync

Error Handling


Integration



Prerequisites


Processing

The EAM_SE_MO_CRT_RC Business Add-In (BAdI) is available for this operation.

Change Maintenance Order

Technical Data








Category

Mode


MaintenanceOrderChangeRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCEORDERCHGRC

Definition

A request to and confirmation from Maintenance Processing to change a maintenance order.

Use

The Change Maintenance Order inbound operation allows a maintenance employee to change a maintenance order.

Features


MaintenanceOrderChangeRequest_sync

MaintenanceOrderChangeConfirmationt_sync

Error Handling


Integration


Constraints

No long text can be created.


Prerequisites


Processing

The EAM_SE_MO_CHG_RC Business Add-In (BAdI) is available for this operation.

Check Create Maintenance Order

Technical Data

Entity Type



Service operation

MaintenanceOrderCreateCheckQueryResponse_In





Category

Mode



Inbound

Synchronous

ECC_MAINTENANCEORDERCRTCHKQR

Definition

A query to and response from Maintenance Processing to check whether a maintenance order can be created with the data specified.

Use

The Check Create Maintenance Order inbound operation is used to check whether a maintenance order can be created with the specified data.

Features


MaintenanceOrderCreateCheckQuery_sync

MaintenanceOrderCreateCheckResponse_sync

Error Handling


Integration



Prerequisites


Processing

The EAM_SE_MO_CRT_CHK_QR Business Add-In (BAdI) is available for this operation.

Check Change Maintenance Order

Technical Data

Entity Type





Category

Mode

Service operation

MaintenanceOrderChangeCheckQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous



Related Web Service Definition ECC_MAINTENANCEORDERCHGCHKQR

Definition

A query to and response from Maintenance Processing to check whether a maintenance order can be changed with the data specified.

Use

The Check Change Maintenance Order inbound operation is used to check whether a maintenance order can be changed with the specified data.

Features


MaintenanceOrderChangeCheckQuery_sync

MaintenanceOrderChangeCheckResponse_sync

Error Handling


Integration



Prerequisites


Processing

The EAM_SE_MO_CHG_CHK_QR Business Add-In (BAdI) is available for this operation.

Entries for Maintenance Order In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations to find maintenance orders according to different criteria.

Use

The inbound service interface Entries for Maintenance Order groups operations that maintenance employees can use to look for maintenance orders, restricted by different criteria.



Integration

The inbound service interface Entries for Maintenance Order In belongs to the process component Maintenance Processing [Seite 247 ] and the business object Maintenance Order

[Seite 257 ] .

Structure

The inbound service interface Entries for Maintenance Order groups the following inbound operations:

MaintenanceOrderAllowedUserStatusByOrderIDQueryResponse_In ( Find Allowed

User Status by Order ID [Seite 270 ] )

MaintenanceOrderAllowedPlannerGroupByLocationIDQueryResponse_In ( Find

Allowed Planner Group by Location ID [Seite 271 ] )

Find Allowed User Status by Order Type

Technical Data

Entity Type





Category

Mode


Service operation

MaitenanceOrderAllowedUserStatusby

TypeIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MaintenanceOrderUSRSTATQR

Definition

A query to and response from Maintenance Processing to find permitted user statuses by order type.

Use

The Find Allowed User Status by Order Type inbound operation provides an employee with a list of user statuses that are allowed for each entered maintenance order type.

Features


MaintenanceOrderAllowedUserStatusByTypeQuery_sync

MaintenanceOrderAllowedUserStatusByTypeResponse_sync

Error Handling


Integration

This inbound operation belongs to the Entries for Maintenance Order In [Seite 269 ] inbound service interface.




Prerequisites


Processing

The EAM_SE_MO_USRSTAT_BY_ID_QR Business Add-In (BAdI) is available for this operation.

Find Allowed Planner Group by Location ID

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceOrderAllowedPlannerGroupBy

LocationIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCEORDERPGMPPQR

Definition

Query to and answer from Maintenance Processing to find allowed planner groups for each planning plant.

Use

The generic inbound operation Find Allowed Planner Group by Location ID supplies employees with a list of the planner groups that are allowed per planning plant.

Features


MaintenanceOrderAllowedPlannerGroupByLocationIDQuery_sync

MaintenanceOrderAllowedPlannerGroupByLocationIDResponse_sync

Error Handling


Prerequisites

You must have created planning groups for the planning plants.

Integration

This inbound operation belongs to the Entries for Maintenance Order In [Seite 269 ] inbound service interface.




Prerequisites


Processing

You can use the Business Add-In (BAdI) EAM_SE_MO_PGRP_BY_MPPLANT_QR for this operation.

Maintenance Confirmation

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

A message confirming the service performed to fully or partly process an operation or suboperation within a maintenance order.

Use

The Maintenance Confirmation business object documents the processing status of operations and suboperations within a maintenance order. It is part of order monitoring. It is used to document the following:

Who performed the operation

Whether operations or suboperations were started or executed

When processing was started and when it was completed

How high are the costs for internal processing

The extent to which the order has been processed (work progress)

Where additional capacity is needed and surplus capacity can be reduced


Prerequisites


Completion Confirmations (PM-WOC-JC) component and have made the basic Customizing settings for this component.

Manage Maintenance Confirmation In

Technical Data



Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Use

The Manage Maintenance Confirmation In inbound service interface contains the operation with which a maintenance employee can create completion confirmations for maintenance orders.

Integration

The Manage Maintenance Confirmation In inbound service interface belongs to the

Maintenance Processing [Seite 247 ] process component and the Maintenance Confirmation


Structure


MaintenanceConfirmationCreateRequestConfirmation_In ( Create Maintenance

Confirmation [Seite 273 ] )

Create Maintenance Confirmation

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceConfirmationCreateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTENANCECONFCRTRC

Definition

A request to and confirmation from Maintenance Processing to create a maintenance confirmation.

Use

The Create Maintenance Confirmation inbound operation allows a maintenance employee to create a maintenance confirmation.

Features




MaintenanceConfirmationCreateRequest_sync

MaintenanceConfirmationCreateConfirmation_sync

Error Handling


Integration

This inbound operation belongs to the Manage Maintenance Confirmation In [Seite 272 ] inbound service interface.


Prerequisites

For more information, see Maintenance Confirmation [Seite 272 ] .

Processing

The EAM_SE_MC_CRT_RC Business Add-In (BAdI) is available for this operation.

Maintenance Master Data Processing

Technical Data

Entity Type



Use

Scheduled and unscheduled maintenance of machinery are examples of business transactions that could lead to maintenance problems.

For example, a maintenance technician is requested to perform the inspection of an industrial robot due after 10,000 hours. Some robot parts have to be exchanged. So the technician looks up the code ‘robot spare parts’ for the code group ‘robot inspection’ in the catalogue 'robot 01'.


To use the operations in the process component, you must use SAP ECC Maintenance

Notifications (PM-WOC-MN).

Maintenance Issue Category Catalogue

Technical Data




Software Component mySAP ERP enterprise services package (as of ECC-SE 600)

Definition

A hierarchically structured catalogue of categories, which classify maintenance-related issues for a particular maintenance aspect.

Use

Maintenance technicians can use the business object Maintenance Issue Category Catalogue to summarize any issues that might occur in a technical object in coded form.

Here is an example:

Catalogue: Error

ParentCategory (Code group): Broken robot

CategoryID (Code): Software



Maintenance Notifications (PM-WOC-MN) and have performed the basic Customizing settings for this component.

Manage Maintenance Issue Category Catalogue In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations for processing a catalog of maintenance issues.

Use

The Manage Maintenance Issue Category Catalogue In inbound service interface groups operations with which the maintenance technician can process catalogs of maintenance issues.

Integration

The Manage Maintenance Issue Category Catalogue In inbound service interface belongs to the Maintenance Master Data Processing [Seite 274 ] process component and the

Maintenance Issue Category Catalogue [Seite 274 ] business object.

Structure

The Manage Maintenance Issue Category Catalogue In inbound service interface contains the following inbound operation:



MaintenanceIssueCategoryCataloguebyIDQueryResponse_In ( Read Maintenance

Issue Category Catalogue Category [Seite 276 ] )

Read Maintenance Issue Category Catalogue

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceIssueCategoryCatalogue byIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_MAINTISSUECATIDQR

Definition

A query to and response from Maintenance Master Data Processing to read the catalogs for maintenance issues using the MaintenanceIssueCatagoryCatalogue.

The CategorieID corresponds to the code in SAP ECC, and the ParentCategoryID of the superior Category of a Category in the hierarchy corresponds to the code group. Due to the restriction that only a two-level hierarchy exists in SAP ECC, the ParentCategoryID corresponds to the code group.

Use

The Read Quality Issue Category Catalogue Catagory by ID inbound operation reads all the code groups of all catalog types.

Features


MaintenanceIssueCategoryCatalogueByIDQuery_sync

MaintenanceIssueCategoryCatalogueByIDResponse_sync


MaintencanceIssueCategoryCatalogueID (obligatory)



The following value are returned:

MaintenanceIssueCategoryCatalogueID (obligatory)

MaintenanceIssueCategoryTypeCode (obligatory)

MaintenanceIssueCategoryTypeName (optional)

MaintenanceIssueCategoryCatalogueName (optional)



MaintenanceIssueCategoryID (obligatory)

ParentMaintenanceIssueCategoryID (optional)

MaintenanceIssueCategoryName (optional)

MaintenanceIssueCategoryDescription (optional)


Integration

This inbound operation belongs to the Manage Maintenance Issue Category Catalogue In



Prerequisites

For more information, see Maintenance Issue Category Catalogue [Seite 274 ] .

Processing

The EAM_SE_MAINTISSUECATIDQR Business Add-In (BAdI) is available for this operation.

Query Maintenance Issue Category Catalogue In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for searching for catalogues about maintenance-related issues.

Use

The inbound service interface Query Maintenance Issue Category Catalogue In groups operations for searching catalogues about maintenance-related issues, restricted according to certain selection criteria.

Integration

The inbound service interface Query Maintenance Issue Category Catalogue In belongs to the process component Maintenance Master Data Processing [Seite 274 ] and the business object Maintenance Issue Category Catalogue [Seite 274 ] .

Structure

The Query Maintenance Issue Category Catalogue inbound service interface contains the following inbound operations:

MaintenanceIssueCategoryCatalogueSimpleByProfileMaitenanceRequestTypeCodeQ ueryResponse_In ( Find Maintenance Issue Category Catalogue by Profile

Maintenance [Seite 278 ] )



Find Catalogue by Maintenance Request Type

Technical Data

Entity Type





Category

Mode


Service operation

MaintenanceIssueCategoryCatalogueSimple

ByProfileMaintenanceRequestTypeCode



Inbound

Synchronous

ECC_MAINTISSUECAT1BYQR

Definition

A query to and response from Maintenance Master Data Processing to read the catalogs for maintenance issues using the MaintencanceRequestTypeCode .

A MaintenanceRequest corresponds to a maintenance request in SAP ECC and the

TypeCode corresponds to the notification type.

Use

The Find Catalogue by Maintenance Request Type Code inbound operation enables the maintenance technician to display an overview of the codes in the catalog for maintenance issues.

Features


MaintenanceIssueCategoryCatalogueSimpleByProfileMaintenanceRequestTypeCode

Query_sync

MaintenanceIssueCategoryCatalogueSimpleByProfileMaintenanceRequestTypeCode

Response_sync


ProfileMaintencanceRequestTypeCode (obligatory)



MaintenanceIssueCategoryCatalogueID (obligatory)

MaintenanceIssueCategoryTypeCode (obligatory)

MaintenanceIssueCategoryTypeName (optional)

MaintenanceIssueCategoryCatalogueName (optional)

Error Handling




Integration

This inbound operation belongs to the Query Maintenance Issue Category Catalogue In [Seite



Prerequisites

For more information, see Maintenance Issue Category Catalogue [Seite 274 ] .

Processing

The EAM_SE_MAINTISSUECAT1BYQR Business Add-In (BAdI) is available for this operation.

Material Inspection Processing

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

The processing of quality inspection steps that need to be taken to check if a material fulfills the specified requirements. This includes the following process steps:

Inspection creation

Documentation of inspection results

Usage Decision


To use the operations in the process component, you must implement SAP ECC Quality

Management (QM) .

Material Inspection

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

A document that describes how an inspection for a specific material is run. This inspection is also created in this document.

A Material Inspection corresponds to an inspection lot in SAP ECC .



Use

The business object Material Inspection makes it possible to carry out quality inspections for a material.



SAP ECC Quality Management (QM).

Manage Material Inspection In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations for processing inspection lots.


Use

The inbound service interface Manage Material Inspection In groups operations that the quality inspector can use to process inspection lots.

Integration

The inbound service interface Manage Inspection Material In belongs to the process component Material Inspection Processing [Seite 279 ] and the business object Material

Inspection [Seite 279 ] .

Structure

The Manage Inspection Material In inbound service interface groups the following inbound operations:

MaterialInspectionbyIDQueryResponse_In ( Read Material Inspection [Seite 281 ] )

MaterialInspectionDecisionCreateRequestConfirmation_In ( Create Material Inspection

Decision [Seite 281 ] )

MaterialInspectionSubsetOperationInspectionActivityCreateRequestConfirmation_In( C reate Subset Operation Inspection Activity [Seite 282 ] )

MaterialInspectionSubsetOperationInspectionActivitybyIDRequestResponse_In ( Read

Subset Operation Inspection Activity [Seite 283 ] )

MaterialInspectionSubsetOperationInspectionActivityFindingCreateRequestConfirmatio n_In ( Create Subset Operation Inspection Activity Finding [Seite 284 ] )

MaterialInspectionSubsetCreateRequestConfirmation_In ( Create Material Inspection

Subset [Seite 285 ] )



MaterialInspectionSubsetDecisionCreateRequestConfirmation_In ( Create Material

Inspection Subset Decision [Seite 286 ] )

Read Material Inspection

Technical Data

Entity Type





Category

Mode


Service operation

MaterialInspectionbyIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

Definition

Query to and response from Material Inspection Processing for reading an inspection lot.


Use

The inbound operation Read Material Inspection by ID enables a quality inspector to display the data on an inspection lot.

Features


MaterialInspectionbyIDQuery_sync

MaterialInspectionbyIDResponse_sync


Integration

This inbound operation belongs to the Manage Material Inspection In [Seite 280 ] inbound service interface.


Prerequisites

For more information, see Material Inspection [Seite 279 ] .

Create Material Inspection Decision

Technical Data



Entity Type



Name Space in ESR


Category

Mode


Service operation

MaterialInspectionDecisionCreateRequest

Confirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

Definition

Query to and confirmation from Material Inspection Processing to create usage decisions.

A Material Inspection Decision corresponds to a usage decision in SAP ECC .

Use

The inbound operation Create Material Inspection Decision enables the quality inspector to create a usage decision for the inspection lot.

Features


MaterialInspectionDecisionCreateRequest_sync

MaterialInspectionDecisionCreateConfirmation_sync

Error Handling


Integration



Prerequisites


Create Subset Operation Inspection Activity

Technical Data

Entity Type




Service operation

MaterialInspectionSubsetOperationInspectionActivity

CreateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global




ESR

Category

Mode



Inbound

Synchronous

Definition

Query to and confirmation from Material Inspection Processing to create inspection characteristics.

An Inspection Activity corresponds to an inspection characteristic in SAP ECC .

Use

The inbound operation Create Subset Operation Inspection Activity enables the quality inspector to create an inspection characteristic.

Features


MaterialInspectionSubsetOperationInspectionActivityCreateRequest_sync

MaterialInspectionSubsetOperationInspectionActivityCreateConfirmation_sync

Error Handling


Integration



Prerequisites


Read Subset Operation Inspection Activity

Technical Data

Entity Type





Category

Mode


Service operation

MaterialInspectionSubsetOperationInspection

ActivitybyIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous



Definition

Query to and response from Material Inspection Processing for displaying an inspection characteristic.


Use

The inbound operation Read Subset Operation Inspection Activity enables the quality inspector to display the details of an inspection characteristic.

Features


MaterialInspectionSubsetOperationInspectionActivitybyIDQuery_sync

MaterialInspectionSubsetOperationInspectionActivitybyIDResponse_sync

Error Handling


Integration



Prerequisites


Create Subset Operation Inspection Activity

Finding

Technical Data

Entity Type





Category

Mode


Service operation


ActivityFindingCreateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

Definition

A query to and response from Material Inspection Processing to record defects for a characteristic.



An Inspection Activity is the same as an inspection characteristic in SAP ECC .

Use

The Create Subset Operation Inspection Activity Finding inbound operation enables a quality inspector to record defects for a characteristic in an inspection lot.

Features


MaterialInspectionSubsetOperationInspectionActivityFindingCreateRequest_sync

MaterialInspectionSubsetOperationInspectionActivityFindingCreateConfirmation_sync

Error Handling


Integration



Prerequisites


Create Material Inspection Subset

Technical Data

Entity Type





Category

Mode


Service operation

MaterialInspectionSubsetCreateRequest



Inbound

Synchronous

Definition

Query to and response from Material Inspection Processing to create inspection points.

A Material Inspection Subset is an inspection point.

Use

The inbound operation Create Material Inspection Subset enables the quality inspector to create new inspection points for an already existing inspection lot.



Features


MaterialInspectionSubsetCreateRequest_sync

MaterialInspectionSubsetCreateConfirmation_sync

Error Handling


Integration



Prerequisites


Create Material Inspection Subset Decision

Technical Data

Entity Type





Category

Mode


Service operation

MaterialInspectionSubsetDecisionCreate



Inbound

Synchronous

Definition

Query to and confirmation from Material Inspection Processing to create valuations for inspection points.

A Material Inspection Subset is an inspection point in SAP ECC .

Use

The inbound operation Create Material Inspection Subset Decision enables the quality inspector to create a valuation for inspection points.

Features


MaterialInspectionSubsetDecisionCreateRequest_sync

MaterialInspectionSubsetDecisionCreateConfirmation_sync



Error Handling


Integration



Prerequisites


Material Inspection Action In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

A group of operations for recording results for characteristics.

Use

The inbound service interface Material Inspection Action In comprises operations that enable the quality inspector to record results for characteristics.

Integration

The inbound service interface Maintenance Action In belongs to the process component

Material Inspection Processing [Seite 279 ] and the business object Material Inspection [Seite

279 ] .

Structure

The inbound service interface Material Inspection Action In contains the following inbound operations:

MaterialInspectionSubsetOperationInspectionActivityResultRecordingRequestConfirm ation_In ( Record Subset Operation Inspection Activity Result [Seite 287 ] )

Record Subset Operation Inspection Activity

Result

Technical Data



Entity Type





Category

Mode


Service operation


ActivityResultRecordingRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

Definition

Query to and confirmation from Material Inspection Processing to create inspection results for characteristic types.


Use

The inbound operation enables a quality inspector to create inspection results for all characteristic types.

Features


MaterialInspectionSubsetOperationInspectionActivityResultRecordingRequest_sync

MaterialInspectionSubsetOperationInspectionActivityResultRecordingConfirmation_sy nc

Error Handling


Integration

This inbound operation belongs to the Material Inspection Action In [Seite 287 ] inbound service interface.


Prerequisites


Query Material Inspection In

Technical Data

Entity Type



(as of ECC-SE 600)



Category

Mode

Inbound

Synchronous

Definition

Group of operations that provide data about inspection lots.


Use

The inbound service interface Query Material Inspection groups operations that the quality inspector can use to search for inspection lots, restricted according to different selection criteria.

Integration

The inbound service interface Query Material Inspection In belongs to the process component

Material Inspection Processing [Seite 279 ] and the business object Material Inspection [Seite

279 ] .

Structure

The Query Material Inspection In inbound service interface groups the following inbound operations:

MaterialInspectionBasicDataByElementsQueryResponse_In ( Find Material Inspection

Basic Data by Elements [Seite 289 ] )

MaterialInspectionSubsetOperationByElementsQueryResponse_In ( Find Material

Inspection Subset Operation by Elements [Seite 291 ] )

MaterialInspectionSubsetOperationInspectionActivityBasicDataByElementsQueryResp onse_In ( Find Subset Operation Inspection Activity Basic Data by Elements [Seite

292 ] )

Find Material Inspection Basic Data by Elements

Technical Data

Entity Type





Category

Mode


Service operation

MaterialInspectionBasicDatabyElements



Inbound

Synchronous

Definition

Query to and response from Material Inspection Processing to retrieve inspection lot data.




Use

The inbound operation Find Material Inspection Basic Data by Elements provides the quality inspector with a worklist for inspection lots, restricted according to various selection criteria.

Features


MaterialInspectionBasicDatabyElementsQuery_sync

MaterialInspectionBasicDatabyElementsResponse_sync

The following selection criteria are possible:

MaterialInspectionID (optional)

TypeCode (optional)

DueDate (optional)

SelectionByMaterialInternalID (optional)

InclusionExclusionCode (optional)

IntervalBoundaryTypeCode (mandatory)

LowerBoundaryMaterialInternalID (optional)

UpperBoundaryMaterialInternalID (optional)

SelectionByPlantID (optional)



LowerBoundaryPlantID (optional)

UpperBoundaryPlantID (optional)

SelectionByBatchID (optional)



LowerBoundaryBatchID (optional)

UpperBoundaryBatchID (optional)

SupplierID (optional)

CustomerID (optional)

LifeCycleStatusCode (mandatory)

Error Handling


Integration

This inbound operation belongs to the Query Material Inspection In [Seite 288 ] inbound service interface.


SAP Documentation


Prerequisites


Enterprise SOA

Find Material Inspection Subset Operation by

Elements

Technical Data

Entity Type





Category

Mode


Service operation

MaterialInspectionSubsetOperationbyElements



Inbound

Synchronous

Definition

Query to and response from Material Inspection Processing for retrieving inspection operation data.

Use

The inbound operation Find Material Inspection Subset Operation by Elements provides the quality inspector with a worklist for inspection operations, restricted according to various selection criteria.

Features


MaterialInspectionSubsetOperationbyElementsQuery_sync

MaterialInspectionSubsetOperationbyElementsResponse_sync



TypeCode (optional)

DueDate (optional)








PlantID (optional)

SelectionByBatchID (optional)



LowerBoundaryBatchID (optional)

UpperBoundaryBatchID (optional)


CustomerID (optional)

SelectionByWorkCentreID (optional)



LowerBoundaryWorkCentreID (optional)

UpperBoundaryWorkCentreID (optional)

SelectionByWorkCentrePlantID (optional)



LowerBoundaryWorkCentrePlantID (optional)

UpperBoundaryWorkCentrePlantID (optional)

WorkCentreDescription (optional)

Error Handling


Integration



Prerequisites


Find Subset Operation Inspection Activity Basic

Data by Elements

Technical Data








Category

Mode



ActivityBasicDatabyElementsQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

Definition

Query to and response from Material Inspection Processing for retrieving inspection characteristic data.


Use

The inbound operation Find Subset Operation Inspection Activity Basic Data by Elements provides the quality inspector with a worklist for inspection characteristics, restricted according to various selection criteria.

Features


MaterialInspectionSubsetOperationInspectionActivityBasicDatabyElementsQuery_sync

MaterialInspectionSubsetOperationInspectionActivityBasicDatabyElementsResponse_ sync


MaterialInspectionID (mandatory)

SubsetID (Mandatory)

SubsetOperationID (mandatory)

SubsetOperationInspectionActivityID (mandatory)

Error Handling


Integration



Prerequisites




Material Inspection Sample

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

Sample required for an examination within an inspection lot.

A Material Inspection Sample corresponds to a physical sample in SAP ECC .

Use

A physical sample is examined during inspection procedures. A sample can be taken from a material independent of an inspection lot and, if necessary, be assigned to an inspection lot at a later time.




Manage Material Inspection Sample In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations for processing physical samples.


Use

The inbound service interface Manage Material Inspection Sample In groups operations that the quality inspector can use to process physical samples.

Integration

The inbound service interface Manage Material Inspection Sample In belongs to the process component Material Inspection Processing [Seite 279 ] and the business object Material

Inspection Sample [Seite 294 ] .

Structure

The inbound service interface Manage Material Inspection Sample In contains the following inbound operations:



MaterialInspectionSampleCreateRequestConfirmation_In ( Create Material Inspection

Sample [Seite 295 ] )

Create Material Inspection Sample

Technical Data

Entity Type





Category

Mode


Service operation

MaterialInspectionSampleCreate



Inbound

Synchronous

Definition

Query to and confirmation from Material Inspection Processing to create a physical sample.

Use

The inbound operation Create Material Inspection Sample enables the quality inspector to create a physical sample.

Features


MaterialInspectionSampleCreateRequest_sync

MaterialInspectionSampleCreateConfirmation_sync

Error Handling


Integration

This inbound operation belongs to the Manage Material Inspection Sample In [Seite 294 ] inbound service interface.


Prerequisites

For more information, see Material Inspection Sample [Seite 294 ] .



Query Material Inspection Sample In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that provide data about physical samples.


Use

The inbound service interface Query Material Inspection Sample In groups operations that provide data on physical samples, restricted according to different selection criteria.

Integration

The inbound service interface Query Material Inspection Sample In belongs to the process component Material Inspection Processing [Seite 279 ] and the business object Material

Inspection Sample [Seite 294 ] .

Structure

The inbound service interface Query Material Inspection Sample In contains the following inbound operations:

MaterialInspectionSamplebyElementsQueryResponse_In ( Find Material Inspection

Sample [Seite 296 ] )

Find Material Inspection Sample by Elements

Technical Data

Entity Type





Category

Mode


Service operation

MaterialInspectionSampleByElements



Inbound

Synchronous

Definition

A query to and response from Material Inspection Processing to provide data for physical samples.

A Material Inspection Sample is the same as a physical sample in SAP ECC .



Use

The Find Material Inspection Sample By Elements inbound operation provides the quality inspector with a list of physical samples, restricted according to various selection criteria.

Features


MaterialInspectionSampleByElementsQuery_sync

MaterialInspectionSampleByElementsResponse_sync

The following selection criteria are supported:

MaterialInspectionSampleID (optional)

SampleDrawingProcedureID(optional)


MaterialInternalID (optional)

PlantID (optional)

BatchID (optional)


TypeCode (optional)

CategoryCode (optional)

Error Handling


Integration

This inbound operation belongs to the Query Material Inspection Sample In [Seite 296 ] inbound service interface.


Prerequisites

For more information, see Material Inspection Sample [Seite 294 ] .

Outbound Delivery Processing

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

Logistical control process that involves the outbound delivery of goods to a product recipient.



Use

The process combines all tasks concerning the outbound delivery process (preparation and triggering execution) and enables communication with the product recipient and billing.


Prerequisites

To use the operations contained in the process component, you must run SAP ECC Shipping

(LE-SHP).

Outbound Delivery

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

Grouping together of goods that a vendor provides for shipping. The outbound delivery is the basis for the shipping notification and delivery note that are sent to the product recipient.

Use

Previous methods with which you could search for outbound deliveries use proprietary technologies.

To simplify communication between the shipping clerk and the Outbound Delivery Processing process component, new operations were defined that use commonly available technologies.

For example, a shipping clerk can perform analyses for his or her line manager. To obtain an overview of pending outbound deliveries, the shipping clerk can perform and display queries.


InboundDelivery

CustomerReturnsDelivery

VendorReturnsDelivery

Query Outbound Delivery

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous



Use

The Query Outbound Delivery inbound service interface groups together operations with which the shipping clerk can find outbound delivery data.

Integration

The Query Outbound Delivery inbound service interface belongs to the Outbound Delivery

Processing [Seite 297 ] process component and the Outbound Delivery [Seite 298 ] business object.

Structure

The Query Outbound Delivery inbound service interface contains the following inbound operation:

OutboundDeliverySimpleByCustomerQueryResponse_In ( Find Outbound Delivery

Simple by Customer [Seite 299 ] )

Find Outbound Delivery Simple by Customer

Technical Data

Entity Type





Category

Mode


Service operation

OutboundDeliverySimpleByCustomerQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_OUTBOUNDDELIVERY001QR

Definition

Query to and response from Outbound Delivery Processing to provide outbound delivery data for each customer.

Use

A shipping clerk uses Find Outbound Delivery Simple by Customer inbound operation to find and analyze data for individual outbound deliveries for a specific customer.

Features


OutboundDeliverySimpleByCustomerQuery_sync

OutboundDeliverySimpleByCustomerResponse_sync


The purchaser number assigned by the seller. In other words, the customer number stored in the system.

You can choose to set a restriction to a goods movement status.



Error Handling

If errors occur, the process is aborted and a corresponding message is sent to the application.


Prerequisites

For more information, see Outbound Delivery Processing [Seite 297 ] .

Processing

The Business Add-In (BAdI) SHP_SE_OUTBOUNDDELIVERYR001QR is available for this operation.

Product Model Management

Technical Data

Entity Type



ESA ECC-SE 600)

Definition

Product Model Management handles combined tasks, structures and documents that are required for the design, engineering and production of product variants.

Use

The Product Model Management process component enables you to provide applications to find and return Product Engineering and Production Assembly and Product Engineering And

Production Structure basic data for your business process.


Prerequisites


Product Engineering and Production Assembly

Technical Data

Entity Type





Definition

A Product Engineering and Production Assembly is a non-configurable product structure describing different variants of a product and their alternative compositions.

A product structure comprises all elements required in engineering and production to define and describe the components that are required to assemble a product.

Use

The Product Engineering and Production Assembly business object contains an operation that enables you to find identifying and administrative data of an item of a Product

Engineering and Production Assembly for your business process from given certain search criteria.


Product Engineering and Production Structure [Seite 303 ]

Query Product Engineering and Production

Assembly In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Query Product Engineering and Production Assembly In is a service interface that enables you to find identifying and administrative data of an assembly item of a Product Engineering and Production Assembly for your business process from given search criteria.

Use

The Query Product Engineering and Production Assembly In inbound service interface contains an operation that specifies search criteria to return identifying and administrative data for items of a Product Engineering and Production Assembly .

Operations in this inbound service interface are relevant to all search-service business purposes.



Integration

The Query Product Engineering and Production Assembly In inbound service interface belongs to the Product Model Management process component and to the Product

Engineering and Production Assembly business object.

Structure

The Query Product Engineering and Production Assembly In inbound service interface contains the

ProductEngineeringAndProductionAssemblyItemBasicDataByElementsQueryResponse_In

( Find Product Engineering and Production Assembly Item Basic Data by Elements [Seite

302 ] ) inbound operation.

Find Product Engineering and Production

Assembly Item Basic Data by Elements

Technical Data

Entity Type





Category

Mode


Operation

ProductEngineeringAndProductionAssemblyItem

BasicDataByElementsQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_PEPASBLYITEMBASICDATABYEQR

Definition

Find Product Engineering and Production Assembly Item Basic Data by Elements is an operation that searches for identifying and administrative data of assembly items.

Use

The Find Product Engineering and Production Assembly Item Basic Data by Elements inbound operation allows you to find the identifying and administrative data of an item for your business process using certain search criteria. For example, you can search using any combination of the following criteria: part or all of its ID part or all of its Product Engineering and Production Assembly ID its creation date its creation user its change date


SAP Documentation its change user

You can also define a maximum number of results you would like to retrieve.

Enterprise SOA

Features


ProductEngineeringAndProductionAssemblyItemBasicDataByElementsQuery_sync

ProductEngineeringAndProductionAssemblyItemBasicDataByElementsResponse_syn c


The message type

ProductEngineeringAndProductionAssemblyItemBasicDataByElementsQuery_sync receives search parameters for given search criteria, and the message type

ProductEngineeringAndProductionAssemblyItemBasicDataByElementsResponse_sync returns the identifying and administrative data.

For this inbound operation, the following Business Add-In (BAdI) is available in enhancement spot PPE_SPOT_SE_IPPE:

PPE_SE_PEPA_ITEM_BD_BYE_QR


Prerequisites

In Customizing you must have executed activity Activate SAP ECC Extensions, and set the status of component EA-PLM to “On”.

Product Engineering and Production Structure

Technical Data

Entity Type



Definition

A Product Engineering and Production Structure is a function unit describing the variants and the alternative decompositions of a product.

The decompositions are defined through the relationships to other function units. Subordinate function units represent semantic refinements of the superior function unit. Variants represent products that have the same functional purpose.

A tree of Product Engineering and Production Structures is a configurable product structure and is used to configure a product with many variants.



Use

The Product Engineering and Production Structure business object contains an operation that enables you to find identifiying and administrative data of a variant of a Product Engineering and Production Structure for your business process from given search criteria.


Product Engineering and Production Assembly [Seite 300 ]

Query Product Engineering and Production

Structure In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Query Product Engineering and Production Structure In is a service interface that enables you to find identifiying and administrative data of a variant of a Product Engineering and

Production Structure for your business process from given search criteria.

Use

The Query Product Engineering and Production Structure In inbound service interface contains an operation that specifies search patterns to return identifying and administrative data for variants of a Product Engineering and Production Structure . Operations in this inbound service interface are relevant to all search-service business purposes.

Integration

The Query Product Engineering and Production Structure In inbound service interface belongs to the Product Model Management process component and to the Product

Engineering and Production Structure business object.

Structure

The Query Product Engineering and Production Structure In inbound service interface contains the

ProductEngineeringAndProductionStructureVariantBasicDataByElementsQueryResponse_In

( Find Product Engineering and Production Structure Variant Basic Data by Elements [Seite

305 ] ) inbound operation.



Find Product Engineering and Production

Structure Variant Basic Data by Elements

Technical Data

Entity Type



Operation

ProductEngineeringAndProductionStructureVariant

BasicDataByElementsQueryResponse_In



Category

Mode


Inbound

Synchronous

ECC_PEPSVARBASICDATABYEQR

Definition

Find Product Engineering and Production Structure Variant Basc Data by Elements is an operation that searches for identifying data of variants and their administrative data.

Use

The Find Product Engineering and Production Structure Variant Basc Data by Elements inbound operation allows you to find the identifying and administrative data of a variant for your business process using certain search criteria.

For example:

• part or all of its ID

• part or all of its Product Engineering and Production Structure ID

• its creation date

• its creation user

• its change date

• its change user

Features


ProductEngineeringAndProductionStructureVariantBasicDataByElementsQuery_sync

ProductEngineeringAndProductionStructureVariantBasicDataByElementsResponse_s ync




The message type

ProductEngineeringAndProductionStructureVariantBasicDataByElementsQuery_sync receives search parameters for given search criteria, and the message type

ProductEngineeringAndProductionStructureVariantBasicDataByElementsResponse_sync returns identifying and administrative data.

For this inbound operation, the following Business Add-In (BAdI) is available in enhancement spot PPE_SPOT_SE_IPPE:

PPE_SE_PEPS_VAR_BD_BY_E_QR


Prerequisites

In Customizing you must have executed activity Activate SAP ECC Extensions , and set the status of component EA-PLM to “On”.

Production

Technical Data

Entity Type


Version

Process component mySAP ERP enterprise services package (as of

ECC-SE 600)

Definition

The Production process component combines all the activities required to manage the production execution process on the manufacturing shop floor.

Use

You can use this process component to retrieve production orders based on the search criteria, read and confirm production orders and for repetitive manufacturing confirmation.

This process component is used for all business objects related to Production .


The Production process component contains the following business objects:

Production Order

Production Confirmation

Repetitive Manufacturing Confirmation

Production Order

Technical Data

Entity Type


Version


ECC-SE 600)



Definition

An order to produce a specific quantity of materials within a pre-defined time. It contains all the information required for the actual execution of the production process.

Use

The Production Order business object contains operations with which you can provide user interfaces and input help for actual execution of a production. In a production area, there is a constant need for material requirements and used components. These materials should be available within a certain time frame. As a follow up, production schedulers and material requirement planners need to know the following details:

Production orders to be executed today

Work centers involved

Requirements from in-house, projects or from sales orders that can be fulfilled

In such cases, a production order is used to fulfill the need for material requirement.


Prerequisites

You have to use mySAP ERP in order to use the operations contained in this process component.

Query Production Order In

Technical Data

Entity Type


Version




ECC-SE 600)

Inbound

Synchronous

Definition

Query Production Order In service interface enables you to retrieve details of production order based on the selection criteria.

Use

The Query Production Order In inbound service interface includes operations that retrieve relevant production order information matching the given elements of a production order.

Integration

The Query Production Order In inbound service interface belongs to the Production [Seite

306 ] process component and the Production Order [Seite 306 ] business object.

Structure

This inbound service interface contains the following inbound operations:



ProductionOrderSimpleByElementsQueryResponse_In ( Find Production

Order by Elements [Seite 308 ] )

ProductionOrderSimpleByWorkCentreQueryResponse_In ( Find Production

Order by Work Center [Seite 309 ] )

Find Production Order By Elements

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode

Related

Web

Service

Definition

Operation

ProductionOrderSimpleByElementsQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_PRODUCTIONORDERSEQR

Definition

The Find Production Order By Elements operation retrieves details of production orders based on the elements.

Use

The Find Production Order By Elements inbound operation allows you to search and retrieve the valid settings of a production order using the search criterion By Elements . You can search the details of a production order by using a combination of the following criteria:

MaterialInternalID

PlantID

SupplyPlanningAreaID

MaterialRequirementsPlanningControllerID

ProductionSchedulerID

SalesOrderID

ProjectWorkBreakdownStructureElementID



If ERPProcessOrderRequiredIndicator is active and

ERPProductionOrderRequiredIndicator is inactive, then

SelectionByProjectWorkBreakdownStructureElementID is not allowed.

ProductionOrderTypeCode

ERPProductionOrderRequiredIndicator

ERPProcessOrderRequiredIndicator

Features


Production Order Simple By Elements Query

This message is a query to Production process component for production orders that match the given elements.

Production Order Simple By Elements Response

This response message retrieves the list of production orders that match the given elements.

Although this service's input message type contains an element MessageHeader/UUID , the service does not support idempotent behavior as described in the mySAP Service

Provisioning handbook. Since support for idempotent behavior may be added in the future, we recommend that you do not use this UUID element for the time being.


Prerequisites

You must have the following in the system:

A finished product material

A production and planning plant

Production or process orders for the material/materials provided in the search criteria

Processing

This service interface processes both production and process orders in the backend system.

Depending on the indicators, ERPProductionOrderRequiredIndicator and

ERPProcessOrderRequiredIndicator , corresponding orders relevant to that order type are returned.

The Business Add-In (BAdI) PORD_SE_PRODUCTIONORDERSEQR ( Definition to Get

Production Order List By Elements ) is available for this operation.

Find Production Order By Work Centre

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)

Operation

ProductionOrderSimpleByWorkCentreQueryResponse_In




Software

Component

Version in

ESR

Category

Mode

Related

Web

Service

Definition http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_PRODUCTIONORDERSWQR

Definition

The Find Production Order By WorkCentre operation retrieves production orders based on the work centre.

Use

The Find Production Order By WorkCentre inbound operation allows you to search and retrieve the valid settings of a production order using the search criterion By Work Centre .

You can search the details of a production order by using a combination of the following criteria:

WorkCentreID

PlantID

ERPProductionOrderRequiredIndicator

ERPProcessOrderRequiredIndicator

Features


Production Order Simple By Work Centre Query

This message is a query to the Production process component to retrieve the production orders that match the given work centre.

Production Order Simple By Work Centre Response

This response message retrieves the list of production orders that match the given work centre.




Prerequisites

You must have the following in the system:

Work Centre

Production and/or process order in order to get results.



Processing

This operation returns both production and process orders for which the query parameters retrieve data in the backend system.

The Business Add-In (BAdI) PORD_SE_PRODUCTIONORDERSWQR ( Definition to Get

Production Order Details By WorkCentre) is available for this operation.

Manage Production Order In

Technical Data

Entity Type


Version




ECC-SE 600)

Inbound

Synchronous

Definition

The Manage Production Order In service interface enables you to read the details of production order.

Use

The Manage Production Order In service interface contains an operation to read the values of production order in a production line.

Integration

The Manage Production Order In inbound service interface belongs to the Production [Seite

306 ] process component and the Production Order [Seite 306 ] business object.

Structure

This inbound service interface contains the inbound operation,

ProductionOrderByIDQueryResponse_In ( Read Production Order [Seite 311 ] )

Read Production Order

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Operation

ProductionOrderByIDQueryResponse_In http://sap.com/xi/APPL/SE/Global




Category

Mode

Related

Web

Service

Definition

Inbound

Synchronous

ECC_PRODUCTIONORDERIDQR

Definition

The Read Production Order operation enables you to read different elements of a production order.

Use

The Read Production Order operation reads and retrieves the details of a production order for a given ProductionOrderID . You can use these details for recording the number of production orders to be executed today.

Features


Production Order By ID Query

This message is a query to the Production process component to retrieve production order details for a given ProductionOrderID .

Production Order By ID Response

This response message retrieves the details of the production order for the given

ProductionOrderID .



Constraints

The Predecessor-Successor relationship has not been implemented for the process order.


Prerequisites

A Production/Process order with the ID provided in the query should be available in the system. The orders of type 10 and 40 only are supported in this operation.

Processing

This interface returns details for both production and process orders. The indicator returned can either be ProductionOrderID or a ProcessOrderID in the backend system.

This Business Add-In (BAdI) PORD_SE_PRODUCTIONORDERIDQR ( Definition to Read

Production Order Details ) is available for this operation.

Production Confirmation

Technical Data

Entity Type


ES for SAP ERP 2005

Business object mySAP ERP enterprise

312


Version services package (as of

ECC-SE 600)

Definition

Production Confirmation is a record of confirmed logistic process changes which result from the execution of a production process at a specific time. This includes the following changes:

Inventory

Plan adjustments

Resource utilizations

Service product consumptions

Work in-process quantity changes

Progress status changes

The confirmation records changes in production that refer to ProductionLot items.

Production

Confirmation updates the inventory (business object Inventory), Financial Accounting, and

Supply Chain Control.

Use

You use this business object to confirm productivity of a worker in a company. This includes confirmation of:

Quantity of intermediate/finished goods.

Setup and teardown efforts, power consumption, machine time and so on.

Process time as well as the goods movements of the consumed and produced materials


Prerequisites

The production or process order that needs to be confirmed must be available in system in order to execute the operations of this business object.

Production Confirmation In

Technical Data

Entity Type


Version




ESA ECC-SE 600)

Inbound

Synchronous

Definition

Query to and from manufacturing execution system to the Production process component for production confirmation.



Use

The Production Confirmation In service interface contains an operation that enables you to update/confirm an order with the following data:

Produced and consumed goods

Working hours

Work quantities to be confirmed

Integration

The Production Confirmation In inbound service interface belongs to the Production [Seite

306 ] process component and the Production Confirmation [Seite 312 ] business object.

Structure


ProductionConfirmationRequest_In ( Maintain Production Confirmation [Seite 314 ] )

Maintain Production Confirmation

Technical Data


ProductionConfirmationRequest_In Technical

Name in

Enterprise

Service

Repository

(ESR)

Namespace in

ESR

Software

Component

Version in

ESR

Category

Mode http://sap.com/xi/SAPGlobal/GDT


Inbound

Asynchronous

Definition

The Maintain Production Confirmation operation confirms a production or a process order.

Use

The Maintain Production Confirmation operation allows you to confirm the presence of a production or process order. This confirmation can take place after every event (Time Event) or after certain time (Time Ticket).

A request to Production process component from manufacturing execution system to update information regarding:

Produced and consumed goods

Working times

Work quantities to be confirmed



Features


Production Confirmation Request

This message is a query to the Production process component for creating a production confirmation. It contains information about the produced and consumed goods, working times and work quantities to be confirmed.




Prerequisites

A production or process order with status not set to Technically Completed or Closed should be available in the mySAP ERP system.

Manage Production Confirmation In

Technical Data

Entity Type


Version




ECC-SE 600)

Inbound

Synchronous

Definition

The Manage Production Confirmation In service interface e nables you to create and cancel a production confirmation.

Use

The Manage Production Confirmation In inbound service interface groups operations that send a request message from manufacturing system to Production component for production confirmation and canceling a production confirmation.

Integration

The Manage Production Confirmation inbound service interface belongs to the Production

[Seite 306 ] process component and the Production Confirmation [Seite 312 ] business object.

Structure

This inbound service interface contains the following inbound operations:

ProductionConfirmationCreateRequestConfirmation_In ( Create

Production Confirmation [Seite 316 ] )

ProductionConfirmationCancelRequestConfirmation_In ( Cancel

Production Confirmation [Seite 317 ] )



Create Production Confirmation

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode

Operation

ProductionConfirmationCreateRequestConfirmation_In http://sap.com/xi/SAPGlobal/GDT


Inbound

Synchronous

Definition

The Create Production Confirmation operation enables you to create a production confirmation.

Use

The Create Production Confirmation operation creates a production confirmation based on the parameters sent as part of ProductionConfirmationCreateRequest.

It contains information about the produced and consumed goods, working times and work quantities to be confirmed.

You can use this operation to return the key fields, confirmation number and counter of the production confirmation.

Features


Production Confirmation Create Request

This message is a query to the Production process component for creating a production confirmation. It contains information about the produced and consumed goods, working times and work quantities to be confirmed.

Production Confirmation Create Confirmation

This response message returns a confirmation to the manufacturing system with the confirmation number and confirmation counter.




Prerequisites

A production or process order with status not set to Technically Completed or Closed should be available in the mySAP ERP system.



Processing

This Business Add-In (BAdI) PORC_SE_PRODUCTIONCONFCRTRC ( Definition to Create

Production Confirmation ) is available for this operation.

Cancel Production Confirmation

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode

Operation

ProductionConfirmationCancelRequestConfirmation_In http://sap.com/xi/SAPGlobal/GDT

As of ECC-SE 600

Inbound

Synchronous

Definition

The Cancel Production Confirmation operation enables you to cancel an existing production confirmation.

Use

The Cancel Production Confirmation operation cancel an existing production confirmation based on the selected parameters sent as part of ProductionConfirmationCancelRequest.

Features


Production Confirmation Cancel Request_Sync

This message is a request to the Production process component for canceling a production confirmation already created.

Production Confirmation Cancel Confirmation_Sync

This response message returns a cancellation confirmation to the manufacturing execution system.






Prerequisites

ConfirmationGroupID and CounterValue exists in the system.

Processing

This Business Add-In (BAdI) PORC_SE_PRODUCTIONCONFCNCRC ( Definition to Cancel

Production Confirmation ) is available for this operation.

Production Confirmation Out

Technical Data

Entity Type


Version



Service interface mySAP ERP enterprise services package (As of

ECC-SE 500)

Inbound

Asynchronous

Definition

The Production Confirming Out service interface enables you to confirm production order confirmation.

Use

The Production Confirming Out is an outbound asynchronous interface which provides the confirmation of a Production Order Confirmation request also sent asynchronously as part of the Production Confirming Out interface.

Prerequisites

A production confirmation request must already be sent to manufacturing system.

Constraints

This service interface cannot be triggered by any external system.

Integration

The Production Confirmation Out service interface belongs to the Production [Seite 306 ] process component and the Production Confirmation [Seite 312 ] business object.

Structure

This inbound service interface contains the operation,

ProductionConfirmationConfirmation_Out ( Confirm Production Confirmation [Seite

318 ] )

Confirm Production Confirmation

Technical Data

Entity Type

Technical

Operation

ProductionConfirmationConfirmation_Out



Name

Namespace

Message

Direction

Transmission

Mode

Related Web

Service

Definition http://sap.com/xi/SAPGlobal/GDT

Inbound

Asynchronous

Definition

The Confirm Production Confirmation operation enables you to confirm production confirmation request message sent asynchronously.

Use

The Confirm Production Confirmation operation is triggered by the mySAP ERP system in response to a production confirmation request.

Features

The outbound operation processes the following message type:

Production Confirmation Confirmation

This message type contains the information about GroupID , CounterValue and

CreationDateTime .




Prerequisites

A production confirmation request is already sent asynchronously to the mySAP ERP system.

Processing

This Business Add-In (BAdI) PORC_SE_PRODCONFCRTRC_ASYN ( Definition to Create

Production Confirmation (Asynchronous)) is available for this operation.

Repetitive Manufacturing Confirmation

Technical Data

Entity Type


Version

Business object mySAP ERP enterprise service package (as of

ECC-SE 600)

Definition

A Repetitive Manufacturing Confirmation is the confirmation of the work process within repetitive manufacturing including the quantity of produced goods, the time consumed as well as the performed work quantities at predefined reporting points. In addition, a repetitive


SAP Documentation Enterprise SOA manufacturing confirmation can trigger goods movement postings for the consumed goods from stock to production as well as produced goods.

Use

A company wants its production workers to confirm their productivity at predefined reporting points. This includes the confirmation of quantities of finished goods, the confirmation of different activities, processing times, as well as the goods movements of the consumed and produced materials altogether with respect to the corresponding planned orders, sales orders, projects or production versions. So, in order to keep track of confirmation of activities, you need repetitive manufacturing confirmation.


Prerequisites


Repetitive Manufacturing Confirming In

Technical Data

Entity Type


Version




ESA ECC-SE 600)

Inbound

Asynchronous

Definition

Query to and from manufacturing execution system for repetitive manufacturing confirmation.

Use

The Repetitive Manufacturing Confirming In inbound service interface includes operations for creating and canceling repetitive manufacturing orders.

Integration

The Repetitive Manufacturing Confirming In inbound service interface belongs to the

Production [Seite 306 ] process component and the Repetitive Manufacturing Confirmation


Structure

The Repetitive Manufacturing Confirming In inbound service interface contains the inbound operation, RepetitiveManufacturingConfirmationRequest_In ( Maintain Repetitive

Manufacturing Confirmation [Seite 320 ] ).

Maintain Repetitive Manufacturing Confirmation

Technical Data

Entity Type

Technical

Name in

Enterprise

Operation

RepetitiveManufacturingConfirmationRequest_In



Service

Repository

(ESR)


Software

Component

Version in

ESR

Message

Direction

Transmission

Mode http://sap.com/xi/SAPGlobal/GDT

As of ECC-SE 600

Inbound

Asynchronous

Definition

The Maintain Repetitive Manufacturing Confirmation operation confirms a repetitive manufacturing order.

Use

The Maintain Repetitive Manufacturing Confirmation operation allows you to confirm the presence of a repetitive manufacturing order. A request to Production process component from manufacturing execution system to confirm information regarding:

Quantity of produced goods

Processing time as well as goods movements of the consumed and produced materials

Features

This inbound operation processes the following message type:

Repetitive Manufacturing Confirmation Request

This message creates a confirmation in repetitive manufacturing confirmation. It returns a unique identifier of a confirmation in repetitive manufacturing.



Manage Repetitive Manufacturing Confirmation In

Technical Data

Entity Type


Version




ECC-SE 500)

Inbound

Synchronous



Definition

The Manage Repetitive Manufacturing Confirmation In service interface enables you to create and cancel a repetitive manufacturing confirmation.

Use

The Manage Repetitive Manufacturing Confirmation In inbound service interface groups operations that send a request message from manufacturing system to Production process component for repetitive manufacturing confirmation and canceling a repetitive manufacturing confirmation.

Integration

The Manage Repetitive Manufacturing Confirmation In inbound service interface belongs to the Production [Seite 306 ] process component and the Repetitive Manufacturing Confirmation


Structure

This inbound service interface contains the following operations:

RepetitiveManufacturingConfirmationCreateRequestConfirmation_In

( Create Repetitive Manufacturing Confirmation [Seite 322 ] )

RepetitiveManufacturingConfirmationCancelRequestConfirmation_In

( Cancel Repetitive Manufacturing Confirmation [Seite 323 ] )

Create Repetitive Manufacturing Confirmation

Technical Data


RepetitiveManufacturingConfirmationCreateRequestConfirmation_In Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR http://sap.com/xi/SAPGlobal/GDT


Message

Direction

Transmission

Mode

Inbound

Synchronous

Definition

The Create Repetitive Manufacturing Confirmation operation enables you to create a repetitive manufacturing confirmation.



Use

Create Repetitive Manufacturing Confirmation creates a repetitive manufacturing confirmation based on the parameters sent as part of RepetitiveManufacturingConfirmationCreateRequest.

You can use this operation to return the unique identifier of a confirmation in repetitive manufacturing. This operation creates a confirmation for the following three scenarios of production:

Make-To-Order

Production-By-Lot

Make-To-Stock

Features


Repetitive Manufacturing Confirmation Create Request_Sync

This message is a query to Production process component for creating a repetitive manufacturing confirmation. It contains information about the confirmation of quantities of finished goods, the confirmation of different activities, processing times, as well as the goods movements of the consumed and produced materials altogether with respect to the corresponding planned orders, sales orders, projects or production versions.

Repetitive Manufacturing Confirmation Create Confirmation_Sync

This response message returns a confirmation to the manufacturing system with the confirmation number.




Prerequisites

You have executed the SAP ECC component PP-REM.

At least one material should allow repetitive manufacturing.

Processing

This Business Add-In (BAdI) REM_SE_REPMANUFACCONFCRTRC ( Definition to Create

Repetitive Confirmation Manufacturing ) is available for this operation.

Cancel Repetitive Manufacturing Confirmation

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)

Namespace in ESR

Operation

RepetitiveManufacturingConfirmationCancelRequestConfirmation_In http://sap.com/xi/SAPGlobal/GDT



Software

Component

Version in

ESR

Category

Mode

As of ECC-SE 600

Inbound

Synchronous

Definition

The Cancel Repetitive Manufacturing Confirmation operation enables you to cancel an existing repetitive manufacturing confirmation.

Use

The Cancel Repetitive Manufacturing Confirmation operation cancels an existing production confirmation based on the selected parameters sent as part of

RepetitiveManufacturingConfirmationCancelRequestConfirmation .

Features


Repetitive Manufacturing Confirmation Cancel Request_Sync

This message is a request to Production process component for canceling a repetitive manufacturing confirmation already created.

Repetitive Manufacturing Confirmation Cancel Confirmation_Sync

This response message returns a cancellation confirmation to the manufacturing execution system.




Prerequisites

You have executed the SAP ECC component PP-REM

Repetitive Manufacturing Confirmation already exists in the system for cancellation.

Processing

This Business Add-In (BAdI) REM_SE_REPMANUFACCONFCNCRC ( Definition to Cancel

Repetitive Manufacturing Confirmation ) is available for this operation.

Repetitive Manufacturing Confirmation Out

Technical Data

Entity Type


Version




ECC-SE 600)

Inbound

Asynchronous



Definition

The Repetitive Manufacturing Confirmation Out service interface enables you to confirm repetitive manufacturing confirmation sent asynchronously.

Use

The Repetitive Manufacturing Confirmation Out operation is triggered by the mySAP ERP system in response to a repetitive manufacturing confirmation request.

Integration

The Repetitive Manufacturing Confirmation Out service interface belongs to the Production

[Seite 306 ] process component and the Repetitive Manufacturing Confirmation [Seite 319 ] business object.

Structure

This inbound service interface contains the operation,

RepetitiveManufacturingConfirmationConfirmation_Out ( Confirm Repetitive

Manufacturing Confirmation [Seite 325 ] ).

Confirm Repetitive Manufacturing Confirmation

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Message

Direction

Operation

RepetitiveManufacturingConfirmationConfirmation_Out http://sap.com/xi/SAPGlobal/GDT

As of ECC-SE 600

Outbound

Transmission

Mode

Asynchronous

Definition

The Confirm Repetitive Manufacturing Confirmation operation enables you to confirm repetitive manufacturing confirmation request message sent asynchronously.

Use

The Confirm Repetitive Manufacturing Confirmation operation is triggered by the mySAP ERP system in response to a Repetitive Manufacturing Confirmation Request.

Features

The outbound operation processes the following message type:

Repetitive Manufacturing Confirmation Confirmation



This message type contains information about RepetitiveManufacturingConfirmationID .




Processing

This Business Add-In (BAdI) REM_SE_REPMANUFACCONFCRTRC ( Definition to Create

Repetitive Manufacturing Confirmation (Asynchronous) ) is available for this operation.

Production Model Management

Technical Data

Entity Type



ESA ECC-SE 600)

Definition

Production Model Management handles tasks required to maintain master data required for production, like Production Models , Production Bills of Material , and Production Bills of

Operations .

Use

The Production Model Management process component enables you to provide applications to find Bills of Material and Production Bills of Operations , and to read basic data of a variant of a Production Bill of Material together with its items for your business process.


Prerequisites


Production Bill of Material

Technical Data

Entity Type



Definition

A Production Bill of Material is a complete and structured list that defines and describes the components that are required for the production of a material or family of similar materials. It


SAP Documentation Enterprise SOA contains, for example, the quantity of the materials used. The Production Bill of Material can be used for configurable and non-configurable materials and is used in planning and execution.

Use

The Production Bill of Material business object contains operations that use the material and plant as search criteria to find the variant basic data of a Production Bill of Material .

The data stored in a Production Bill of Material serves as a basis for production planning activities. For example:

A design department (working with CAD) can base its work on bills of material

A material requirements planning department explodes bills of material on a certain date to calculate cost-effective order quantities for materials

A work scheduling department uses bills of material as a basis for operation planning and production control

A production order management department uses bills of material to plan the provision of materials

Query Production Bill of Material In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Query Production Bill of Material In is a service interface that enables you to find Production

Bills of Material (or variants of a Production Bill of Material ) for your business process from given search criteria.

Use

The Production Bill of Material In inbound service interface groups operations that enable you to find variants of a Production Bill of Material that represent a particular material. Operations in this inbound service interface are relevant to all search-service business purposes.

Integration

The Query Production Bill of Material In inbound service interface belongs to the Production

Model Management process component and to the Production Bill of Material business object.



Structure

The Query Production Bill of Material In inbound service interface contains the following inbound operations:

ProductionBillOfMaterialVariantBasicDataByMaterialAndPlantQueryResponse_In ( Find

Production Bill of Material Variant Basic Data by Material and Plant [Seite 328 ] )

ProductionBillOfMaterialVariantItemBasicDataByVariantIdentifyingElementsQueryRes ponse_In ( Read Production Bill of Material Variant Item Basic Data by Variant

Identifying Elements [Seite 329 ] )

Find Production Bill of Material Variant Basic Data by Material and Plant

Technical Data

Entity Type



Operation

ProductionBillOfMaterialVariantBasicDataByMaterial

AndPlantQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global




ESR

Category

Mode


Inbound

Synchronous

ECC_PRODBILLOFMATERIALVBDQR

Definition

Find Production Bill of Material Variant Basic Data by Material and Plant is an operation that searches for variants of Production Bills of Material that represent a given material in a given plant.

Use

The Find Production Bill of Material Variant Basic Data by Material and Plant inbound operation allows you to find Production Bills of Material , in particular their variants, which represent a material in a certain plant.

Features


ProductionBillOfMaterialVariantBasicDataByMaterialAndPlantQuery_sync

ProductionBillOfMaterialVariantBasicDataByMaterialAndPlantResponse_sync




The message type ProductionBillOfMaterialVariantBasicDataByMaterialAndPlantQuery_sync receives at least one of the identifying elements material ID, plant ID, variant ID, and usage code, together with a validity date, and the message type

ProductionBillOfMaterialVariantBasicDataByMaterialAndPlantResponse_sync returns identifying data for matching variants together with the identifying elements of their corresponding Production Bills of Material .

When the plant ID in

ProductionBillOfMaterialVariantBasicDataByMaterialAndPlantQuery_sync is filled with an initial value, the system returns variants that are not assigned to a plant.

When the plant ID in

ProductionBillOfMaterialVariantBasicDataByMaterialAndPlantQuery_sync is skipped or filled with the character “*” (asterisk), the system returns variants assigned to any plant that matches the other search parameters.

For this inbound operation, the following Business Add-In (BAdI) is available in enhancement spot CST_SPOT_SE_PBOM:

CST_SE_PBOM_VBD_MATNPLNT_QR

Find Variant Item Basic Data by Variant Identifying

Elements

Technical Data




ProductionBillOfMaterialVariantItemBasicData

ByVariantIdentifyingElementsQueryResponse_In



Category

Mode


Inbound

Synchronous

ECC_PRODBILLOFMATERIALIBDQR

Definition

Find Variant Item Basic Data by Variant Identifying Elements is an operation that reads a variant together with identifying data, quantities, and validity information about its items.

Use

The Find Variant Item Basic Data by Variant Identifying Elements inbound operation enables you to find the components with their required quantities that are needed to assemble a complex material, for example, for requirements-planning purposes, or to check product readiness before a product launch.



Features


ProductionBillOfMaterialVariantItemBasicDataByVariantIdentifyingElementsQuery_syn c

ProductionBillOfMaterialVariantItemBasicDataByVariantIdentifyingElementsResponse

_sync


The message type

ProductionBillOfMaterialVariantItemBasicDataByVariantIdentifyingElementsQuery_sync receives the identifying elements of a variant, for example, material ID, plant ID, variant ID, and usage code, together with a validity date, and the message type

ProductionBillOfMaterialVariantItemBasicDataByVariantIdentifyingElementsResponse_sync returns basic data of the variant together with identifying data, quantities, and validity information of its items according to the given validity date.

For this inbound operation, the following Business Add-In (BAdI) is available in enhancement spot CST_SPOT_SE_PBOM:

CST_SE_PBOM_IBD_VAR_QR

Manage Production Bill of Material In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Manage Production Bill of Material In is a service interface that contains an operation to read the basic data of a variant of a Production Bill of Material.

Use

The Manage Production Bill of Material In inbound service interface contains an operation that returns a variant together with identifying data, quantities, and validity information of its items.

Operations in this inbound service interface are relevant to all business purposes where the components of a complex material are needed, for example, to check readiness of a complex product.



Integration

The Manage Production Bill of Material In inbound service interface belongs to the Production

Model Management process component and to the Production Bill of Material business object.

Structure

The Manage Production Bill of Material In inbound service interface contains the

ProductionBillOfMaterialVariantItemByVariantIdentifyingElementsQueryResponse_In ( Read

Production Bill of Material Variant Data by Variant Identifying Elements [Seite 331 ] ) inbound operation.

Find Variant Item by Variant Identifying Elements

Technical Data

Entity

Type

Technical

Name in

Enterprise

Service

Repository

(ESR)

Namespace in ESR

Software

Component

Version in

ESR

Category

Mode

Related

Web

Service

Definition

Operation

ProductionBillOfMaterialVariantItemByVariantIdentifyingElementsQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_PRODBILLOFMATERIAL001QR

Definition

Read Production Bill of Material Variant Item by Variant Identifying Elements is an operation that reads a variant together with identifying data, quantities, and validity information of its items.

Use

The Read Production Bill of Material Variant Item by Variant Identifying Element inbound operation is used to find the components with their required quantities that are needed to assemble a complex material, for example, for requirements-planning purposes, or to check product readiness before a product launch.



Features


ProductionBillOfMaterialVariantItemByVariantIdentifyingElementsQuery_sync

ProductionBillOfMaterialVariantItemByVariantIdentifyingElementsResponse_sync


The message type

ProductionBillOfMaterialVariantItemByVariantIdentifyingElementsQuery_sync receives the identifying elements of a variant, for example, material ID, plant ID, variant ID, and usage code, together with a validity date, and the message type

ProductionBillOfMaterialVariantItemByVariantIdentifyingElementsResponse_sync returns the basic data and all other data of the variant together with identifying data, quantities, and validity information of its items according to the given validity date.


For this inbound operation the Business Add-In (BAdI)

CST_SE_PRODBILLOFMATERIAL001QR is available in enhancement spot

CST_SPOT_SE_PBOM.

Production Bill of Operations

Technical Data

Entity Type



Definition

A Production Bill of Operations is a description of a production process for manufacturing products. It contains all the processing or transformation steps that have to be executed. It also defines all the resources to be used with all the necessary technical specifications such as the standard times, capacity requirements, and work instructions.

Use

The Production Bill of Operations business object contains an operation that enables you to find the identifying data of a Production Bill of Operations and other elements for your business process from identifying elements or materials.

Query Production Bill of Operations In

Technical Data

Entity Type




SAP Documentation

Category

Mode

Inbound

Synchronous

Enterprise SOA

Definition

Query Production Bill of Operations In is a service interface that enables you to find the identifying data of a Production Bill of Operations and other elements for your business process from identifying elements or material.

Use

The Query Production Bill of Operations In inbound service interface contains an operation that specifies search criteria to return identifying data and other elements of a Production Bill of Operations . Operations in this inbound service interface are relevant to all search-service business purposes.

Integration

The Query Production Bill of Operations In inbound service interface belongs to the

Production Model Management process component and to the Production Bill of Operations business object.

Structure

The Query Production Bill of Operations In inbound service interface contains the

ProductionBillOfOperationsSimpleByIdentifyingElementsAndMaterialQueryResponse_In ( Find

Production Bill of Operations Simple by Identifying Elements and Material [Seite 333 ] ) inbound operation.

Find Production BOO Simple by Identifying

Elements and Material

Technical Data

Entity Type





Category

Mode


Operation

ProductionBillOfOperationsSimpleByIdentifying

ElementsAndMaterialQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_ProdBillOfOperationsSIMQR



Definition

Find Production Bill of Operations Simple by Identifying Elements and Material is an operation that searches for identifying data of Production Bills of Operations and other elements.

Use

The Find Production Bill of Operations Simple by Identifying Elements and Material inbound operation allows you to find identifying data and other elements of a Production Bill of

Operations for your business process using one or more of its identifying elements and/or one of its assigned materials as search criteria.

Features


ProductionBillOfOperationsSimpleByIdentifyingElementsAndMaterialQuery_sync

ProductionBillOfOperationsSimpleByIdentifyingElementsAndMaterialResponse_sync


The message type

ProductionBillOfOperationsSimpleByIdentifyingElementsAndMaterialQuery_sync receives search parameters for one or more identifying elements of the Production Bill of Operations and/or one of its assigned materials.

The message type

ProductionBillOfOperationsSimpleByIdentifyingElementsAndMaterialResponse_sync returns the identifying data of the matching Production Bills of Operations and other elements.

For this inbound operation, the following Business Add-In (BAdI) is available in enhancement spot CPR_SPOT_SE_PBOO:

CPR_SE_PBOO_SIMPLE_BY_IE_M_QR

Project Master Data Management

Technical Data

Entity Type



(as of ECC-SE 600)

Use

A project manager is responsible for a project, in which the scope, timeframe, and budget are exactly communicated and documented. However, certain events cause the scope of the project to change. The project manager therefore creates a ProjectChange to which he or she assigns standard reasons for the change using a catalogue.

A ProjectChange corresponds to a project claim in SAP ECC .




Prerequisites

To use the operations in this process component, you must implement SAP ECC Claim

Management (PS-CLM) and have performed the basic Customizing settings for this component.

Project Issue Category Catalogue

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

A hierarchically structured catalog which classifies project-related issues for a particular project aspect.

Use

The business object Project Issue Category Catalogue enables the project manager to assign standard issues for the changes to a project to a ProjectChange.

A ProjectChange corresponds to a Project Claim in SAP ECC.


ProjectChange

Manage Project Issue Category Catalogue In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for processing a catalog about project-related issues.

Use

The inbound service interface Manage Project Issue Category Catalogue In groups operations that the project manager can use to process catalogs about project-related issues.



Integration

The inbound service interface Manage Project Issue Category Catalogue In belongs to the process component Project Master Data Processing [Seite 334 ] and the business object

Project Issue Category Catalogue [Seite 335 ] .

Structure

The Manage Project Issue Category Catalogue In inbound service interface contains the following inbound operation:

ProjectIssueCategoryCatalogueCategoryByIDQueryResponse_In ( Read Project Issue

Category Catalogue Category [Seite 336 ] )

Project Issue Category Catalogue Category

Technical Data

Entity Type





Category

Mode

Related Web Service Definition Language

Service operation

ProjectIssueCategoryCatalogueCategoryByID



Inbound

Synchronous

ECC_PROJECTISSUECATIDQR

Definition

Query to and response from Project Master Data Processing for reading the

ProjectIssueCategoryCatalogueCategory from the catalog for project-related issues using the

CatalogueID.

The CategorieID corresponds to the code and code group in SAP ECC and the

ParentCategoryID to the hierarchically superior Category of a Category .

ParentCategoryID corresponds to the code group because in SAP ECC there is only a two-level hierarchy for restrictions.

Use

The inbound operation Read Project Issue Category Catalogue Category by ID reads all categories (code groups and codes) of all catalogue types.

Features


ProjectIssueCategoryCatalogueCategoryByIDQuery_sync

ProjectIssueCategoryCatalogueCategoryByIDResponse_sync


ProjectIssueCategoryCatalogueID (mandatory)







ProjectIssueCategoryTypeCode (mandatory)

ProjectIssueCategoryTypeName (optional)


ProjectIssueCategoryID (mandatory)

ParentProjectIssueCategoryID (optional)

ProjectIssueCategoryName (optional)

ProjectIssueCategoryDescription (optional)

Error Handling

If errors occur, the process terminates and a message is transferred to the application.

Integration

This inbound operation belongs to inbound service interface Manage Project Issue Category

Catalogue In [Seite 335 ] .


Prerequisites

For more information, see Project Master Data Management [Seite 334 ] .

Processing

Business Add-In (BAdI) PRS_SE_PROJECTISSUECATIDQR is available for this operation.

Query Project Issue Category Catalogue In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for searching for catalog about project-related issues.

Use

The inbound service interface Query Project Issue Category Catalogue In groups operations that the project member can use to perform a restricted search according to various selection criteria for catalog about project-related issues.



Integration

The inbound service interface Query Project Issue Category Catalogue In belongs to the process component Project Master Data Processing [Seite 334 ] and the business object

Project Issue Category Catalogue [Seite 335 ] .

Structure

The Query Project Issue Category Catalogue In inbound service interface contains the following inbound operation:

ProjectIssueCategoryCatalogueSimpleByProjectChangeTypeCodeQueryResponse_In

( Find Project Issue Category Catalogue Simple by Project Change Type Code [Seite

338 ] )

Find Project Issue Category Catalogue Simple by

Change Type

Technical Data

Entity Type





Category

Mode


Service operation

ProjectIssueCategoryCatalogueSimpleByProfile

ProjectChangeTypeCodeQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_PROJECTISSUECAT1BYQR

Definition

Query to and response from Project Master Data Processing to read the catalogs about project-related issues using ProjectChangeTypeCode.

A ProjectChange corresponds to the project claim in SAP ECC , the TypeCode to the type of project claim.

Use

The inbound operation Find Project Issue Category Catalogue Simple by Project Change

Type Profile enables the project manager to display an overview of the codes from the catalog used with reference to the type of project claim.

Features


ProjectIssueCategoryCatalogueSimpleByProfileProjectChangeTypeCodeQuery_sync

ProjectIssueCategoryCatalogueSimpleByProfileProjectChangeTypeCodeResponse_sy nc


ProfileProjectChangeTypeCode (mandatory)






ProjectIssueCategoryTypeCode (mandatory)

ProiectIssueCategoryTypeName (optional)


Error Handling


Integration

This inbound operation belongs to inbound service interface Query Project Issue Category

Catalogue In [Seite 337 ] .


Prerequisites

For more information, see Project Master Data Management [Seite 334 ] .

Processing

Business Add-In (BAdI) PRS_SE_PROJECTISSUECAT1BYQR is available for this operation.

Project Processing

Technical Data

Entity Type



Definition

A business process responsible for structuring, planning, and executing simple short-term measures and complex projects.

Use

The process component Project Processing enables you to plan, analyze, and monitor schedules, dates, and resources (such as staff, machines, and materials) in a project. A project stakeholder (for example, the project manager) requests changes to existing projects

(for example, project scope, time, funds, and planned effort).


Prerequisites

Before you can use the operations in this process component, you must run SAP ECC Project

System (PS)



Processing




Project

Technical Data

Entity Type

Software Component


Definition

Business plan with a fixed goal to be reached within an agreed time frame with a set budget, planned resources and agreed quality.

The project is characterized by being unique and having an element of risk.


Business Partner

Organisational Centre

Task


Prerequisites

To use the operations in this business object, you must implement the component Project

System (PS) and have performed the basic Customizing settings for this component. In addition, you must also have knowledge in the project system.

Query Project In

Technical Data

Entity Type

Software Component

ES for SAP ERP 2005


(as of ECC-SE 600)

340


Category

Mode

Inbound

Synchronous

Definition

Group of operations for finding projects.

Use

The inbound service interface Query Project In contains operations that the employee can use to find projects, restricted by various selection criteria.

Integration

The inbound service interface Query Project In belongs to process component Project

Processing [Seite 339 ] and business object Project [Seite 340 ] .

Structure

The inbound service Query Project In encompasses the following inbound operations:

ProjectActivityByWorkBreakdownStructureElementIDQueryResponse_In ( Find Project

Activity by Work Breakdown Structure Element ID [Seite 341 ] )

ProjectDescriptionByIDQueryResponse_In ( Find Project Description by ID [Seite 342 ] )

ProjectWorkBreakdownStructureElementByIDQueryResponse_In ( Find Project Work

Breakdown Structure Element by Project ID [Seite 343 ] )

ProjectWorkBreakdownStructureElementAttachmentByWorkBreakdownStructureElem entIDQueryResponse_In ( Read Project WBS-Element Attachment Details by WBS-

Element ID [Seite 344 ] )

ProjectActivityAttachmentByActivityIDAndNetworkIDQueryResponse_In ( Read Project

Activity Attachment Details by Activity and Network [Seite 345 ] )

ProjectPartyByIDAndPartyRoleCodeQueryResponse_In ( Find Project Party Details by

Project ID and Party Role Code [Seite 346 ] )

ProjectByPartyQueryResponse_In ( Find Project Details by Party [Seite 347 ] )

Find Project Activity by Work Breakdown

Structure Element

Technical Data

Entity Type





Category

Mode


Service operation

ProjectActivityByWorkBreakdownStructureElementID



Inbound

Synchronous

ECC_PROJECTABWQR



Definition

A request to and response from Project Processing to provide data by work breakdown structure element (WBS element).

Use

The inbound operation Find Project Activity by Work Breakdown Structure Element is used by the employee to find project activities by WBS element ID.

Features


ProjectActivityByWorkBreakdownStructureElementIDQuery_sync

ProjectActivityByWorkBreakdownStructureElementIDResponse_sync

Error Handling


Integration

This inbound operation belongs to inbound service interface Query Project In [Seite 340 ] .


Prerequisites

For more information, see Project [Seite 340 ] .

Processing

Business Add-In (BAdI) PRS_SE_PRJ_ABW_QR is available for this operation.

Find Project Description by ID

Technical Data

Entity Type





Category

Mode


Service operation

ProjectDescriptionByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_PROJECTPRJDESCBYIDQR

Definition

Query to and response from Project Processing to retrieve information specific to a project using the project ID.



Use

Employees can use the inbound operation Find Project Description by ID to search for information that is specific to a project (for example, name, description, cost center) per project ID.

Features


ProjectDescriptionByIDQuery_sync

ProjectDescriptionByIDResponse_sync

Error Handling


Integration

This inbound operation belongs to the Query Project [Seite 340 ] inbound service interface.


Prerequisites


Processing

You can use the Business Add-In (BAdI) PRS_SE_PRS_PRJ_DESC_BY_ID_QR for this operation.

Find Project Work Breakdown Structure Element by Project

Technical Data

Entity Type





Category

Mode


Service operation

ProjectWorkBreakdownStructureElementByID



Inbound

Synchronous

ECC_PROJECTWBSBYIDQR

Definition

A request to and response from Project Processing to provide data for a work breakdown structure element (WBS element) per project ID.



Use

The inbound operation Find Project Work Breakdown Structure Element by Project is used by the employee to find WBS elements according to project ID.

Features


ProjectWorkBreakdownStructureElementByIDQuery_sync

ProjectWorkBreakdownStructureElementByIDResponse_sync

Error Handling


Integration



Prerequisites


Processing

Business Add-In (BAdI) PRS_SE_PRJ_WBS_BY_ID_QR is available for this operation.

Read Project Work Breakdown Structure Element

Attachment

Technical Data

Entity Type





Category

Mode


Service operation

ProjectWorkBreakdownStructureElement

AttachmentByWorkBreakdownStructure

ElementIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_PROJECTWAWBSIDQR

Definition

A request to and response from Project Processing to provide attachment details for a work breakdown structure element (WBS element).

Use

The inbound operation Read Project Work Breakdown Structure Element Attachment is used by the employee to find attachment details for a WBS element by WBS element ID.



Features


ProjectWorkBreakdownStructureElementAttachmentByWorkBreakdownStructure

ElementIDQuery_sync

ProjectWorkBreakdownStructureElementAttachmentByWorkBreakdownStructure

ElementIDResponse_sync

Error Handling


Integration



Prerequisites


Processing

Business Add-In (BAdI) PRS_SE_PRS_PROJECTWAWBSIDQR is available for this operation.

Read Project Activity Attachment

Technical Data

Entity Type





Category

Mode


Service operation

ProjectActivityAttachmentByActivityIDAnd

NetworkIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_PROJECTAAAIDNIDQR

Definition

A request to and response from Project Processing to provide attachment details by activity

ID and network ID.

Use

The inbound operation Read Project Activity Attachment is used by the employee to find attachment details for a project activity by activity ID and network ID.

Features




ProjectActivityAttachmentByActivityIDAndNetworkIDQuery_sync

ProjectActivityAttachmentByActivityIDAndNetworkIDResponse_sync

Error Handling


Integration



Prerequisites


Processing

Business Add-In (BAdI) PRS_SE_PRS_PRJ_AAAIDNID_QR is available for this operation.

Find Project Party by ID and Party Role Code

Technical Data

Entity Type





Category

Mode


Service operation

ProjectPartyByIDAndPartyRoleCodeQuery

Response_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_PROJECTPARTYIDROLEQR

Definition

A request to and response from Project Processing to provide partner data by project ID and role code.

Use

The inbound operation Find Project Party by ID and Party Role Code is used by the employee to find partner data for a project and role.

Features


ProjectPartyByIDAndPartyRoleCodeQuery_sync

ProjectPartyByIDAndPartyRoleCodeResponse_sync

Error Handling




Integration



Prerequisites


Processing

Business Add-In (BAdI) PRS_SE_PRJ_PROJECTPRTYIDROLEQR is available for this operation.

Find Project ID by Party

Technical Data

Entity Type





Category

Mode


Service operation

ProjectByPartyQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_PROJECTPRJPARTYQR

Definition

Query to and answer from Project Processing to retrieve project data by partner.

Use

Employees can use the inbound operation Find Project Details by Party to search for project data, restricted by partner.

Features


ProjectByPartyQuery_sync

ProjectByPartyResponse_sync

Error Handling


Integration





Prerequisites


Processing

Business Add-In (BAdI) PRS_SE_PRS_PROJECTPRJPARTYQR is available for this operation.

Manage Project In

Technical Data

Entity Type

Software Component

Category

Mode


Inbound

Synchronous

Definition

Group of operations for processing projects.

Use

The inbound service interface Manage Project In contains the operations that the employee can use to process projects.

Integration

The inbound service interface Manage Project In belongs to process component Project

Processing [Seite 339 ] and business object Project [Seite 340 ] .

Structure

This inbound service encompasses the following inbound operations:

ProjectDescriptionByIDQueryResponse_In ( Read Project Description [Seite 348 ] )

ProjectWorkBreakdownStructureElementByWorkBreakdownStructureElementIDQuery

Response_In ( Read Project Work Breakdown Structure Element [Seite 349 ] )

ProjectActivityByActivityIDQueryResponse_In ( Read Project Activity [Seite 350 ] )

ProjectActivityChangeRequestConfirmation_In ( Change Project Activity [Seite 351 ] )

ProjectActivityChangeCheckQueryResponse_In ( Check Change Project Activity [Seite

352 ] )

Read Project Description

Technical Data



Entity Type





Category

Mode


Service operation

ProjectDescriptionByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_PROJECTPRJDESCBYIDQR

Definition

A request to and response from Project Processing to provide data for a project.

Use

The inbound operation Read Project Description enables an employee to display the information that is characteristic of a project, such as name, description, cost center, by using the identification.

Features


ProjectDescriptionByIDQuery_sync

ProjectDescriptionByIDResponse_sync

Error Handling


Integration

This inbound operation belongs to inbound service interface Manage Project [Seite 348 ] .


Prerequisites


Processing

Business Add-In (BAdI) PRS_SE_PRS_PRJ_DESC_BY_ID_QR is available for this operation.

Read Project Work Breakdown Structure Element

Technical Data

Entity Type




Service operation

ProjectWorkBreakdownStructureElement

ByWorkBreakdownStructureElementIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global




Category

Mode


Language


Inbound

Synchronous

ECC_PROJECTWBWQR

Definition

A request to and response from Project Processing to provide data of a work breakdown structure element (WBS element).

Use

The inbound operation Read Project Work Breakdown Structure Element is used by the employee to display data by WBS element ID.

Features


ProjectWorkBreakdownStructureElementByWorkBreakdownStructureElementIDQuery

_sync

ProjectWorkBreakdownStructureElementByWorkBreakdownStructureElementIDRespo nse_sync

Error Handling


Integration

This inbound operation belongs to inbound service interface Manage Project [Seite 348 ] .


Prerequisites


Processing

Business Add-In (BAdI) PRS_SE_PRJ_WBW_QR is available for this operation.

Read Project Activity

Technical Data

Entity Type





Category

Mode

Service operation

ProjectActivityByActivityIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous



Related Web Service Definition ECC_PROJECTACTBYACTIDQR

Definition

Query to and answer from Project Processing to retrieve project activity data for each activity

ID.

Use

Employees can use the inbound operation Read Project Activity by Activity ID to display project activity data for each activity.

Features


ProjectActivityByActivityIDQuery_sync

ProjectActivityByActivityIDResponse_sync

Error Handling


Integration

This inbound operation belongs to the Manage Project [Seite 348 ] inbound service interface.


Prerequisites


Processing

You can use the Business Add-In (BAdI) PRS_SE_PRJ_ACTBYID_QR for this operation.

Change Project Activity

Technical Data

Entity Type





Category

Mode


Service operation

ProjectActivityChangeRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_PROJECTACTCHGRC

Definition

A request to and response from Project Processing to change a project activity.



Use

The inbound operation Change Project Activity is used by the employee to change a project activity.

Features


ProjectActivityChangeRequest_sync

ProjectActivityChangeConfirmation_sync

Error Handling


Constraints

Although this operation’s input message type contains element MessageHeader/UUID , the operation does not support idempotent behavior as described in the mySAP Service

Provisioning Handbook.

Since support for idempotent behavior may be added in the future, we recommend that you do not use this UUID element for the time being.

Integration

This inbound operation belongs to inbound service interface Manage Project In [Seite 348 ] .


Prerequisites


Processing

Business Add-In (BAdI) PRS_SE_PRJ_ACH_RC is available for this operation.

Check Change Project Activity

Technical Data

Entity Type





Category

Mode


Service operation

ProjectActivityChangeCheckQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_PROJECTACTCHCQR

Definition

Query to and answer from Project Processing to check if a project activity can be changed.



Use

Employees can use the inbound operation Check Change Project Activity to check if a project activity with the data entered can be changed.

Features


ProjectActivityChangeCheckQuery_sync

ProjectActivityChangeCheckResponse_sync

Error Handling


Integration

This inbound operation belongs to the Manage Project [Seite 348 ] inbound service interface.


Prerequisites


Processing

You can use the Business Add-In (BAdI) PRS_SE_PRJ_ACC_QR for this operation.

Project Change

Technical Data

Entity Type

Software Component


Definition

Documents any deviations from the project plan for example, in deadlines or costs, for the purposes of project management. The most important points for which information should be entered are the following:

Reason for the deviation

Person or group responsible

Deviation costs

Action and measures to take due to the deviation

Use

The business object Project Change is used to document and track project deviations in time, budget, and scope and to explain these to the project managers.




Project

Sales Order

Business Partner


Prerequisites

To use the operations in this business object, you must implement the component Claim

Management (PS-CLM) and have performed the basic Customizing settings for this component.

Manage Project Change In

Technical Data

Entity Type

Software Component

Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations for processing Project Changes .

Use

The inbound service interface Manage Project Change In contains the operations that the employee can use to process Project Changes .

A Project Change corresponds to a project claim in SAP ECC .

Integration

The inbound service interface Manage Project Change In belongs to process component

Project Processing [Seite 339 ] and business object Project Change [Seite 353 ] .

Structure

The inbound service interface Manage Project Claim contains the following inbound operations:

ProjectChangeCreateRequestConfirmation_In ( Create Project Change [Seite 354 ] )

Create Project Change

Technical Data

Entity Type



Service operation

ProjectChangeCreateRequestConfirmation_In





Category

Mode



Inbound

Synchronous

ECC_PROJECTCHANGECRTRC

Definition

Query to and confirmation from Project Processing to create a Project Change .

A Project Change corresponds to a Project Claim in SAP ECC.

Use

Employees can use the inbound operation Create Project Change to create a Project Change as a starting point. In this way, they can record any variances in the project in real time and carry out detailed processing at a later date.

Features


ProjectChangeCreateRequest_sync

ProjectChangeCreateConfirmation_sync


ProjectChangeTypeCode

Error Handling

Field lengths and value lengths are checked, as well as whether any data was entered that is not supported (for example, schemeID).


Integration

This inbound operation belongs to the Manage Project Change [Seite 354 ] inbound service interface.


Prerequisites

For more information, see Project Change [Seite 353 ] .

Processing

You can use the Business Add-In (BAdI) PRS_SE_PRS_ PROJECTCHANGECRTRC for this operation.

Appropriation Request

Technical Data




Software Component mySAP ERP enterprise services package (as of ECC-SE 600)

Definition

A request for conducting an investment measure or other measure that has to be assessed and approved by one or more persons in an enterprise.

Use

The Appropriation Request business object makes it possible to implement one or more measures that initially result in costs but that generate revenue or provide other benefits after a longer time period has elapsed. These measures could be capital investment measures, research and development projects, or even large-scale maintenance and repair projects.

Appropriation Request Action In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Processes appropriation requests.

Use

The Appropriation Request Action In inbound service interface groups operations that the person responsible can use to approve, reject, or postpone appropriation requests.

Integration

The Appropriation Request Action In inbound service interface belongs to the Project


Structure

The Appropriation Request Action In inbound service interface groups the following inbound operations together:

AppropriationRequestApproveRequestConfirmation_In ( Approve Appropriation


AppropriationRequestPostponeRequestConfirmation_In ( Postpone Appropriation


AppropriationRequestRejectRequestConfirmation_In ( Reject Appropriation Request

[Seite 358 ] )



Constraints

The person responsible can only process appropriation requests that have For approval status.

Approve Appropriation Request

Technical Data

Entity Type





Category

Mode


Service operation

AppropriationRequestApproveRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_IMAPPROPRIATIONREQAPRRC

Definition

Approves an appropriation request.

Use

The Approve Appropriation Request inbound operation makes it possible for the person responsible to approve certain appropriation requests.

Features


AppropriationRequestApproveRequest_sync

AppropriationRequestApproveConfirmation_sync


Integration


Constraints

If approval levels are defined in Customizing for the appropriation request type of an appropriation request and event linkage is activated for the approval workflow, then the person responsible is not able to approve the appropriation request using this inbound operation.



Reject Appropriation Request

Technical Data

Entity Type





Category

Mode


Service operation

AppropriationRequestRejectRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_IMAPPROPRIATIONREQREJRC

Definition

Rejects an appropriation request.

Use

The Reject Appropriation Request inbound operation makes it possible for the person responsible to reject a given appropriation request.

Features


AppropriationRequestRejectRequest_sync

AppropriationRequestRejectConfirmation_sync


Integration


Postpone Appropriation Request

Technical Data

Entity Type





Category

Mode


Service operation

AppropriationRequestPostponeRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_IMAPPROPRIATIONREQPPNRC



Definition

Postpones approval of an appropriation request.

Use

The Postpone Appropriation Request inbound operation makes it possible for the person responsible to postpone approval for a given appropriation request. As a result, the status of the appropriation request is reset to Created .

Features


AppropriationRequestPostponeRequest_sync

AppropriationRequestPostponeConfirmation_sync


Integration


Manage Appropriation Request

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Queries master data and plan values.

Use

The Manage Appropriation Request inbound service interface contains an operation that reads the master data and plan values of appropriation requests.

Integration

The Manage Appropriation Request inbound service interface belongs to the Project


Structure

The Manage Appropriation Request inbound service interface contains the

AppropriationRequestByIDQueryResponse_In ( Read Appropriation Request [Seite 360 ] ) inbound operation.


SAP Documentation

Constraints


Enterprise SOA

Read Appropriation Request

Technical Data

Entity Type





Category

Mode


Service operation

AppropriationRequestByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_IMAPPROPRIATIONREQDTLQR

Definition

A query of data of an appropriation request.

Use

The Read Appropriation Request inbound operation reads the master data and plan data of an appropriation request and its variants, including the data of the preinvestment analysis.

Features


AppropriationRequestByIDQuery_sync

AppropriationRequestByIDResponse_sync


Integration

This inbound operation belongs to the Manage Appropriation Request [Seite 359 ] inbound service interface.

Constraints

This operation does not read the following data:

Business area, division, material group, plant, company, location, functional location

Assigned measures, assets, equipment

User-defined fields

User status

Verbal assessment, completion date, start-up date of the variants


SAP Documentation

Depreciation simulation data of the variants

Documents assigned to the variants

Enterprise SOA

Query Appropriation Request In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Searches for appropriation requests that fulfill certain selection criteria.

Use

The Query Appropriation Request In inbound service interface groups operations that the person responsible can use to search for appropriation requests based on selection criteria.

The plan data and master data of the appropriation requests is issued.

Integration

The inbound service interface Query Appropriation Request In belongs to process component

Project Processing [Seite 339 ] and business object Appropriation Request [Seite 355 ] .

Structure

The inbound service Query Appropriation Request In encompasses the following inbound operations:

AppropriationRequestVariantByApproverAndInApprovalStatusQueryResponse_In

( Find Appropriation Request for Approval by Approver and In Approval Status [Seite

361 ] )

AppropriationRequestVariantPlanValuesByProgrammeAndPlanningVersionQueryResp onse_In ( Find Appropriation Request Plan Values by Programme and Planning

Version [Seite 363 ] )

Constraints


Find Appropriation Request for Approval by

Approver and Approval Status

Technical Data



Entity Type





ESR

Category

Mode


Language

Service operation

AppropriationRequestVariantByApproverAndInApprovalStatus



Inbound

Synchronous

ECC_IMAPPROPRIATIONREQTBAQR

Definition

Searches for a particular user based on the appropriation requests that have For approval status.

Use

The Find Appropriation Request for Approval by Approver and In Approval Status inbound operation returns all appropriation requests for a given user that have For approval status.

The operation returns the following data of the appropriation requests:


Assigned investment program position

Variant of the appropriation request (also with For approval status) with its description, assigned plan versions and plan values

Features


AppropriationRequestVariantByApproverAndInApprovalStatusQuery_sync

AppropriationRequestVariantByApproverAndInApprovalStatusResponse_sync


Integration

This inbound operation belongs to inbound service interface Query Appropriation Request In

[Seite 361 ] .

Constraints

This operation does not return any appropriation requests for which approval levels are defined in Customizing and for which event linkage is activated for the approval workflow.


Prerequisites

An approver role is specified for the approver in partner management in the master data of the appropriation request. The system can determine this role from various sources. The system checks these sources one after the other when determining the role for the master record of the appropriation request. The system copies the first approver role that it finds into the master record of the appropriation request. The system checks the sources in the following sequence:



...

1. Business Add-Ins (BAdIs)

You can specify an approver role for each appropriation request type by implementing the IM_BEHAVIOUR BAdI.

For appropriation requests with appropriation request types 01 and 02, you want the approver in the master record of the appropriation request to have role I3. For appropriation requests with appropriation request types 03, you want the approver in the master record of the appropriation request to have role I4.

Implement the GET_BEHAVIOUR method as follows:

METHOD if_ex_im_behaviour~get_behaviour.

IF situation = 'IM_GET_APPROVER_ROLES'.

CONCATENATE '01' 'I3'

'02' 'I3'

'03' 'I4' INTO behaviour.

ENDIF.

ENDMETHOD.

2. Customizing for the approval levels

In Customizing for the approval process of appropriation requests, you can define approval levels for each appropriation request type and then assign these to roles. If more than one approval level is defined for an appropriation request type, then the system interprets the role of the first approval level as the approver role.

3. Customizing for the appropriation request type

In Customizing for the appropriation request type, you can define two roles that can be maintained directly in the master data of the appropriation request. The system interprets the second of these two roles as the approver role.

Find Appropriation Request Plan Values by

Programme and Planning Version

Technical Data






Category

Mode


AppropriationRequestVariantPlanValuesByProgrammeAnd

PlanningVersionQueryResponse_In

Inbound

Synchronous

ECC_IMAPPROPRIATIONREQPLAQR



Definition

Searches for appropriation requests using the investment program position and the plan version.

Use

The Find Appropriation Request Plan Values by Programme and Planning Version inbound operation returns all appropriation requests that are assigned to a given investment program position and which have a variant that is assigned to a given plan version with a given approval year. The operation returns the following data of the appropriation requests:


Approval status of the appropriation request

The unique variant of the appropriation request that has the entered plan version and approval year, along with the description of the variant

The plan values of this variant

Features


AppropriationRequestVariantPlanValuesByProgrammeAndPlanningVersionQuery_syn c

AppropriationRequestVariantPlanValuesByProgrammeAndPlanning

VersionResponse_sync


Integration

This inbound operation belongs to the Query Appropriation Request In [Seite 361 ] inbound service interface.

Purchase Order Processing

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

Process component Purchase Order Processing covers the creation and processing of purchase orders.

Use

The process component Purchase Order Processing enables the provision of applications that a buyer can use to create, display, and change purchase orders.




Prerequisites

Before you can use the operations in this process component, you must run SAP ECC

Purchasing (MM-PUR).

Processing


The data transferred by the request messages completely overwrites the corresponding objects in the databases of the back-end system. The response of the back-end system, therefore, is to expect a value for all elements that are found in the message types structure.






Purchase Order

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

A request from a buyer to an external vendor to deliver a specific quantity of materials or to perform a specific service at a specific point in time.

Use

Business object Purchase Order is used to procure products.

Query Purchase Order In

Technical Data





Category

Mode mySAP ERP enterprise services package

(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that enable a search for purchase orders that is restricted according to various criteria.

Use

The inbound service interface Query Purchase Order In contains the operations that the buyer can use to search for purchase orders according to various criteria.

Integration

The inbound service interface Query Purchase Order In belongs to process component

Purchase Order Processing [Seite 364 ] and business object Purchase Order [Seite 365 ] .

Structure

Inbound service interface Query Purchase Order In encompasses the following inbound operations:

PurchaseOrderBySellerAndProductAndOrganisationalQueryResponse_In ( Find

Purchase Order by Seller and Product and Organisational Data [Seite 366 ] )

PurchaseOrderByIDQueryResponse_In ( Find Purchase Order by ID [Seite 367 ] )

PurchaseOrderItemByAccountAssignment ( Find Purchase Order Item by Account


Find Purchase Order by Seller and Product and

Organisational Data

Technical Data

Entity Type





Category

Mode


Service operation

PurchaseOrderBySellerAndProductAnd

OrganisationalDataQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_PURCHASEORDER001QR

Definition

A request to and response from Purchase Order Processing to provide the data of purchase orders per vendor, material, and organization.



Use

The inbound operation Find Purchase Order by Seller And Product And Organisational Data enables the buyer to search for purchase orders by vendor, material, and organization.

Features


PurchaseOrderBySellerAndProductAndOrganisationalDataQuery_sync

PurchaseOrderBySellerAndProductAndOrganisationalDateResponse_sync

Error Handling


Integration

This inbound operation belongs to inbound service interface Manage Purchase Order [Seite

369 ] .


Processing

Business Add-In (BAdI) PUR_SE_PURCHASEORDER001QR is available for this operation.

Find Purchase Order by ID

Technical Data

Entity Type





Category

Mode


Service operation

PurchaseOrderByIDQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous


Definition

A request to and response from Purchase Order Processing to provide the data of a purchase order.

Use

The inbound operation Find Purchase Order By ID is used by the buyer to display a purchase order.

Features


PurchaseOrderByIDQuery_sync



PurchaseOrderByIDResponse_sync

Error Handling


Integration


369 ] .

Constraints

The following data is not displayed:

Conditions

Account assignment data

Service and limit data

Subcontracting data

Configuration data

Long texts

Import data

Address data

Data on version management

Shipping data

Partner functions (except VendorParty and BillFromParty)

Purchase order history


Processing


Find Purchase Order Item by Account Assignment

Technical Data

Entity Type





Category

Mode


Service operation

PurchaseOrderItemBy

AccountAssignmentQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous




Definition

A request to and response from Purchase Order Processing to provide purchase order items per account assignment object.

Use

The buyer uses the inbound operation Find Purchase Order Item By Account Assignment to select purchase order items according to account assignment objects.

Features


PurchaseOrderItemByAccountAssignmentQuery_sync

PurchaseOrderItemByAccountAssignmentResponse_sync

Error Handling


Integration

This inbound operation belongs to inbound service interface Query Purchase Order [Seite

365 ] .

Constraints

The following data is not displayed:

Conditions


Configuration data

Long texts

Import data

Address data


Shipping data




Processing


Manage Purchase Order In

Technical Data



Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that enable the processing of purchase orders.

Use

The inbound service interface Manage Purchase Order In contains the operations that the buyer can use to display, create, and change purchase orders.

Integration

The inbound service interface Manage Purchase Order In belongs to process component

Purchase Order Processing [Seite 364 ] and business object Purchase Order [Seite 365 ] .

Structure

Inbound service interface Manage Purchase Order In encompasses the following inbound operations:

PurchaseOrderCreateRequestConfirmation_In ( Create Purchase Order [Seite 370 ] )

PurchaseOrderChangeRequestConfirmation_In ( Change Purchase Order [Seite 371 ] )

Create Purchase Order

Technical Data

Entity Type





Category

Mode


Service operation

PurchaseOrderCreateRequestConfirmation_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_PURCHASEORDERCRTRC

Definition

A request to and confirmation from Purchase Order Processing to create a purchase order.

Use

The inbound operation Create Purchase Order is used by the buyer to create a purchase order.



Features


PurchaseOrderCreateRequest_sync

PurchaseOrderCreateConfirmation_sync

Error Handling


Integration


369 ] .

Constraints

The following data cannot be transferred on creation:

Conditions



Subcontracting data

Configuration data

Long texts

Import data

Address data


Shipping data




Processing

Business Add-In (BAdI) PUR_SE_PURCHASEORDERCRTRC is available for this operation.

Change Purchase Order

Technical Data

Entity Type




Service operation

PurchaseOrderChangeRequestConfirmation_In http://sap.com/xi/APPL/SE/Global




Category

Mode



Inbound

Synchronous

ECC_PURCHASEORDERCHGRC

Definition

A request to and confirmation from Purchase Order Processing to change a purchase order.

Use

The inbound operation Change Purchase Order is used by the buyer to change a purchase order.

Features


PurchaseOrderChangeRequest_syn

PurchaseOrderChangeConfirmation_syn

Error Handling


Integration


369 ] .

Constraints

The following data cannot be changed:

Conditions



Subcontracting data

Configuration data

Long texts

Import data

Address data


Shipping data






Processing

Business Add-In (BAdI) PUR_SE_PURCHASEORDERRCHGRC is available for this operation.

Strategic Investment Buy

Technical Data

Entity Type

Business object


(as of ECC-SE 600)

Definition

StrategicInvestmentBuy is used to simulate an optimal purchase order quantity and possible cost saving by comparing an offered discount with costs for additional storing of goods.

During simulation it takes also consumption, inventory and open purchase order quantity into account. If cost savings are higher than additional costs (for example, it is profitable), it finally proposes a purchase order quantity and order date.

StrategicInvestmentBuySimulateQueryResponse_In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

The StrategicInvestmentBuySimulateQueryResponse_In inbound service interface contains an operation that simulates cost savings and proposes an order quantity and an order date.

Integration

The inbound service interface Simulate Strategic Investment Buy In belongs to process component Purchase Order Processing [Seite 364 ] and business object Strategic Investment

Buy [Seite 373 ] .

Structure

This inbound service interface contains the

StrategicInvestmentBuySimulateQueryResponse_In [Seite 374 ] inbound operation.



Simulate Strategic Investment Buy

Technical Data

Entity Type





ESR

Category

Mode


Service operation

StrategicInvestmentBuySimulateQueryResponse_In http://sap.com/xi/EA-RETAIL/SE/Global


Inbound

Synchronous

ECC_STRATINVBUYSIMULQR

Definition

The Simulate Strategic Investment Buy inbound operation simulates cost savings and proposes an order quantity and an order date.

Use

This service operation is used to simulate an optimal purchase order quantity and possible cost saving by comparing an offered discount with costs for additional storing of goods.

During simulation it takes also consumption, inventory and open purchase order quantity into account. If cost savings are higher than additional costs (for example, it is profitable), it finally proposes a purchase order quantity and order date.

Features


Strategic Investment Buy Simulate Query

(StrategicInvestmentBuySimulateQuery_sync)

Strategic Investment Buy Simulate Response

(StrategicInvestmentBuySimulateResponseMessage_sync)

Integration

This inbound operation belongs to the Strategic Investment Buy Action In [Seite 373 ] inbound service interface.


Processing

Business Add-In (BAdI) WRET_SE_STRATIVBUYSIMUL_QR is available for this operation.

Purchase Request Processing

Technical Data

Entity Type



(as of ECC-SE 600)



Definition

The process component Purchase Request Processing encompasses the creation and changing of purchase requests, as well as the processing needed to determine suitable sources of supply. Purchase requests are created either manually or automatically, via, for example, maintenance orders, MRP runs, project requirements, or internal requests.

Then the corresponding follow-on documents, such as purchase orders, scheduling agreement releases, or outline agreements are created.

Use

The process component Purchase Request Processing enables the provision of applications that a buyer can use to create, display, and change purchase requests.


Prerequisites

Before you can use the operations in this process component, you must run SAP ECC

Purchasing (MM-PUR).

Processing


The data transferred by the request messages completely overwrites the corresponding objects in the databases of the back-end system. The response of the back-end system, therefore, is to expect a value for all elements that are found in the message types structure.






Purchase Request

Technical Data

Entity Type



(as of ECC-SE 600)



Definition

An instruction to the purchasing department to purchase specific materials or services in specific quantities within a specific time.

Use

Business object Purchase Request is used to record requirements in the system.

Query Purchase Request In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that enable a search for purchase requisition items that is restricted according to various criteria.

Use

The inbound service interface Query Purchase Request In contains the operations that the buyer can use to search for purchase request items according to various criteria.

Integration

The inbound service interface Query Purchase Request In belongs to process component

Purchase Request Processing [Seite 374 ] and business object Purchase Request [Seite 375 ] .

Structure

Inbound service interface Query Purchase Request In encompasses the following inbound operations:

PurchaseRequestItemByProductAndOrganizationalDataQueryResponse_In ( Find

Purchase Request Item by Product and Organisational Data [Seite 376 ] )

PurchaseRequestByIDQueryResponse_In ( Find Purchase Request by ID [Seite 377 ] )

PurchaseRequestByReleaseInformationQueryResponse_In ( Find Purchase Request by Release Information [Seite 378 ] )

PurchaseRequestItemByAccountAssignment ( Find Purchase Request Item by Account


Find Purchase Request Item by Product and

Organisational Data

Technical Data



Entity Type





Category

Mode


Service operation

PurchaseRequestItemByProductAnd

OrganisationalDataQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_PURCHASEREQITEM001QR

Definition

A request to and response from Purchase Request Processing to provide purchase request items per product and organization.

Use

The inbound operation Find Purchase Request Item by Product and Organisational Data enables the buyer to search for purchase request items by product and organization.

Features


PurchaseRequestItemByProductAndOrganisationalDataQuery_sync

PurchaseRequestItemByProductAndOrganisationalDataResponse_sync

Error Handling


Integration

This inbound operation belongs to inbound service interface Query Purchase Request [Seite

376 ] .


Processing

Business Add-In (BAdI) PUR_SE_PURHASEREQITEM001QR is available for this operation.

Find Purchase Request by ID

Technical Data

Entity Type





Category

Service operation

PurchaseRequestByIDQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound



Mode


Synchronous

ECC_PURCHASEREQEST002QR

Definition

A request to and response from Purchase Request Processing to provide purchase requests per document number and item number (ID).

Use

The inbound operation Purchase Request Processing is used by the buyer to display purchase requests according to document number and item number (ID).

Features


PurchaseRequestByIDQuery_sync

PurchaseRequestByIDResponse_sync

Error Handling


Integration


376 ] .

Constraints

The following data cannot be displayed:



Subcontracting data

Configuration data

Long texts

Address data



Processing

Business Add-In (BAdI) PUR_SE_PURCHASEREQUEST002QR is available for this operation.

Find Purchase Request by Release Information

Technical Data








Category

Mode


PurchaseRequestByReleaseInformation



Inbound

Synchronous

ECC_PURCHASEREQUEST003QR

Definition

A request to and response from Purchase Request Processing to provide purchase requests according to release information.

Use

The inbound operation Find Purchase Request by Release Information enables the buyer to search for purchase requests according to release information.

Features


PurchaseRequestByReleaseInformationQuery_sync

PurchaseRequestByReleaseInformationResponse_sync

Error Handling


Integration


376 ] .


Processing

Business Add-In (BAdI) PUR_SE_PURCHASEREQUEST003QR is available for this operation.

Find Purchase Request Item by Account

Assignment

Technical Data

Entity Type





Category

Service operation

PurchaseRequestItemByAccountAssignment



Inbound



Mode


Synchronous

ECC_PURCHASEREQITEM004QR

Definition

A request to and response from Purchase Request Processing to provide purchase request items per account assignment object.

Use

The buyer uses the inbound operation Find Purchase Request Item by Account Assignment to select purchase request items according to account assignment objects.

Features


PurchaseRequestItemByAccountAssignmentQuery_sync

PurchaseRequestItemByAccountAssignmentResponse_sync

Error Handling


Integration


376 ] .

Constraints

The following data cannot be displayed:


Subcontracting data

Configuration data

Long texts

Address data



Processing

Business Add-In (BAdI) PUR_SE_PURCHASEREQITEM004QR is available for this operation.

Manage Purchase Request In

Technical Data





Category

Mode mySAP ERP enterprise services package

(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations that enable the processing of purchase requisitions.

Use

The inbound service interface Manage Purchase Request In contains the operations that an employee can use to create and change purchase requests.

Integration

The inbound service interface Manage Purchase Request In belongs to process component

Purchase Request Processing [Seite 374 ] and business object Purchase Request [Seite 375 ] .

Structure

Inbound service interface Manage Purchase Request In encompasses the following inbound operations:

PurchaseRequestCreateRequestConfirmation_In ( Create Purchase Request [Seite

381 ] )

PurchaseRequestChangeRequestConfirmation_In ( Change Purchase Request [Seite

382 ] )

PurchaseRequestReleaseRequestConfirmation_In ( Release Purchase Request [Seite

383 ] )

Create Purchase Request

Technical Data

Entity Type





Category

Mode


Service operation

PurchaseRequestCreateRequestConfirmation_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_PURCHASEREQUESTCRTRC

Definition

A request to and confirmation from Purchase Request Processing to create a purchase request.

Use

The inbound operation Create Purchase Request is used by the requester to create a purchase request.



Features


PurchaseRequestCreateRequest_sync

PurchaseRequestCreateConfirmation_sync

Error Handling


Integration

This inbound operation belongs to inbound service interface Manage Purchase Request

[Seite 380 ] .

Constraints

The following data cannot be transferred on creation:



Configuration data

Long texts

Address data



Processing

Business Add-In (BAdI) PUR_SE_PURCHASEREQUESTCRTRC is available for this operation.

Change Purchase Request

Technical Data

Entity Type





Category

Mode


Service operation

PurchaseRequestChangeRequestConfirmation_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_PURCHASEREQUESTCHGRC

Definition

A request to and confirmation from Purchase Request Processing to provide a purchase request.



Use

The inbound operation Change Purchase Request is used by a requester to change a purchase request.

Features


PurchaseRequestChangeRequest_sync

PurchaseRequestChangeConfirmation_sync

Error Handling


Integration


[Seite 380 ] .

Constraints

The following data cannot be changed:



Subcontracting data

Configuration data

Long texts

Address data



Processing

Business Add-In (BAdI) PUR_SE_PURCHASEREQUESTCHGRC is available for this operation.

Release Purchase Request

Technical Data

Entity Type





Category

Service operation

PurchaseRequestReleaseRequestConfirmation_In http://sap.com/xi/APPL/SE/Global


Inbound



Mode


Synchronous

ECC_PURCHASEREQUESTRELRC

Definition

A request to and confirmation from Purchase Request Processing to release a purchase request.

Use

The inbound operation Release Purchase Request is used by the requester to release a purchase request.

Features


PurchaseRequestReleaseRequest_sync

PurchaseRequestReleaseConfirmation_sync

Error Handling


Integration


[Seite 380 ] .


Processing

Business Add-In (BAdI) PUR_SE_PURCHASEREQUESTRELRC is available for this operation.

Quality Issue Processing

Technical Data

Entity Type



Use

With the activities contained in the process component Quality Issue Processing, you can record when a product does not meet the quality requirement demanded and respond accordingly.


Prerequisites





Processing




Quality Issue Notification

Technical Data

Entity Type



Definition

A Quality Issue Notification reports that a product does not meet a particular quality requirement. The Quality Issue Notification includes instructions for taking appropriate measures.

Use

If there is an error or problem with a product, the quality inspector must inform the organization responsible so that corrective measures can be taken. This is what a Quality

Issue Notification is for. The Quality Issue Notification contains details of the error. When the error is corrected, employees record the steps that were taken.

The Quality Issue Notification corresponds to a quality notification in SAP ECC .


Prerequisites


Quality Notifications (QM-QN) and have performed the basic Customizing settings for this component.

Manage Quality Issue Notification In

Technical Data

Entity Type


Category


Inbound



Mode Synchronous

Definition

Group of operations for processing quality issue notifications.

Use

The inbound service interface Manage Quality Issue Notification In groups operations that quality inspectors can use to create, display, and change quality issue notifications.

Integration

The inbound service interface belongs to the process component Quality Issue Processing

[Seite 384 ] and to the business object Quality Issue Notification [Seite 385 ] .

Structure


QualityIssueNotificationCreateQueryConfirmation_In ( Create Quality Issue Notification

[Seite 386 ] )

QualityIssueNotificationByIDQueryResponse_In ( Read Quality Issue Notification [Seite

387 ] )

QualityIssueNotificationChangeQueryConfirmation_In ( Change Quality Issue

Notification [Seite 388 ] )

Create Quality Issue Notification

Technical Data

Entity Type





Category

Mode


Service Operation

QualityIssueNotificationCreateRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_QUALITYISSUENOTIFICACRTRC

Definition

Query to and response from Quality Issue Processing to create quality issue notifications.

Use

Employees in quality can use the inbound operation Create Quality Issue Notification to create a quality issue notification.

Features


QualityIssueNotificationCreateRequest_sync



QualityIssueNotificationCreateConfirmation_sync

Error Handling


Integration

This inbound operation belongs to the Manage Quality Issue Notification In [Seite 385 ] inbound service interface.


Prerequisites

For more information, see Quality Issue Notification [Seite 385 ] .

Processing

You can use the Business Add-In (BAdI) xyz (<Titel>) for this operation.

Read Quality Issue Notification

Technical Data

Entity Type





Category

Mode


Service operation

QualityIssueNotificationByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_QUALITYISSUENOTIFICAIDQR

Definition

Query to and response from Quality Issue Processing to supply data about a quality issue notification.

Use

Quality inspectors can use the inbound operation Read Quality Issue Notification to display a quality issue notification.

Features


QualityIssueNotificationByIDQuery_syn

QualityIssueNotificationByIDResponse_syn



Error Handling


Integration

This inbound operation belongs to the Manage Quality Issue Notification [Seite 385 ] inbound service interface.


Prerequisites


Processing

You can use the Business Add-In (BAdI) QUM_SE_SORTER_QIN for this operation.

Change Quality Issue Notification

Technical Data

Entity Type





Category

Mode


Service operation

QualityIssueNotificationChangeRequest



Inbound

Synchronous

ECC_QUALITYISSUENOTIFICACHGRC

Definition

Query to and response from Quality Issue Processing to change a quality issue notification.

Use

Employees in quality can use the inbound operation Change Quality Issue Notification to change a quality issue notification.

Features


QualityIssueNotificationChangeRequest_sync

QualityIssueNotificationChangeConfirmation_sync

Error Handling




Integration

This inbound operation belongs to the Manage Quality Issue Notification [Seite 385 ] inbound service interface.


Prerequisites


Processing

You can use the Business Add-In (BAdI) xyz (<Titel>) for this operation.

Query Quality Issue Notification In

Technical Data

Entity Type


Category

Mode



Inbound

Synchronous

Use

The Query Quality Issue Notification In inbound service interface contains operations with which a quality inspector can search for quality notifications according to certain criteria.

Integration

The Query Quality Issue Notification In inbound service interface belongs to the Quality Issue

Processing [Seite 384 ] process component and the Quality Issue Notification [Seite 385 ] business object.

Structure


QualityIssueNotificationSimpleByElementsQueryResponse_In ( Find Quality Issue

Notification By Elements [Seite 389 ] )

Find Quality Issue Notification by Elements

Technical Data

Entity Type





Service Operation

QualityIssueNotificationProductByElements





Category

Mode


Inbound

Synchronous

ECC_QUALITYISSUENOTIFICAPEQR

Definition

Query to and response from Quality Issue Processing to supply data about quality issue notifications.

Use

Quality inspectors can use the inbound operation Find Quality Issue Notification by Elements to search for quality issue notifications according to certain criteria.

Features


QualityIssueNotificationProductByElementsQuery_sync

QualityIssueNotificationProductByElementsResponse_sync

The following selection criteria exist:

TypeCode (optional)

RequestedProcessingPeriod (optional)






BuyerPartyInternalID (optional)

VendorPartyInternalID (optional)

ReleaseStatusCode (mandatory)

ClosureStatusCode (mandatory)

Error Handling


Integration

This inbound operation belongs to the Query Quality Issue Notification [Seite 389 ] inbound service interface.


Prerequisites




Processing

You can use the Business Add-In (BAdI) QUM_SE_SORTER_QIN_SIM_QR for this operation.

Sales Order Processing

Technical Data

Entity Type




Use

The process component Sales Order Processing enables the provision of applications that a seller can use to create, display, and change sales orders. The seller can also run trend analyses for customers and get an overview of sales orders that are blocked for delivery.


Prerequisites

Before you can use the operations in this process component, you must run SAP ECC Sales and Distribution (SD).

Processing






An order contains the items 10, 20, 30, 40, 50. With the request message for a chance operation, item 10 is to be changed, and item 30 is to be deleted.


Item 30 is deleted if you do not specify it.



Sales Order

Technical Data

Entity Type




Definition

An agreement between a vendor and a customer concerning the sale and delivery of goods, as well as any services that are associated with these processes, on a specific date, for a specific quantity, and for a specific price.

Query Sales Order In

Technical Data

Entity Type


Category

Mode



Inbound

Synchronous

Use

The inbound service interface SalesOrderProcessingQuerySalesOrder contains the operations that the seller can use to search for sales orders and sales order items according to various criteria.

Integration

The inbound service interface SalesOrderProcessingQuerySalesOrder belongs to process component Sales Order Processing [Seite 391 ] and business object Sales Order [Seite 392 ] .

Structure

Inbound service interface SalesOrderProcessingQuerySalesOrder encompasses the following inbound operations:

SalesOrderItemByBuyerAndProductQueryResponse_In ( Find Sales Order Item by

Buyer and Product [Seite 393 ] )

SalesOrderBasicDataByBuyerAndBasicDataQueryResponse_In ( Find Sales Order

Basic Data by Buyer and Basic Data [Seite 394 ] )

SalesOrderBasicDataByBuyerAndInvoicingBlockedQueryResponse_In ( Find Sales

Order Basic Data by Buyer and by Invoicing Blocked [Seite 396 ] )

SalesOrderBasicDataByBuyerAndCreditBlockedQueryResponse_In ( Find Sales Order

Basic Data by Buyer and Credit Blocked [Seite 397 ] )

SalesOrderBasicDataByBuyerAndIncompletenessQueryResponse_In ( Find Sales

Order Basic Data by Buyer and Incompleteness [Seite 398 ] )



SalesOrderBasicDataByBuyerAndDeliveryBlockedQueryResponse_In ( Find Sales

Order Basic Data by Buyer and Delivery Blocked [Seite 400 ] )

Find Sales Order Item by Buyer and Product

Technical Data

Entity Type





Category

Mode


Service operation

SalesOrderItemByBuyerAndProductQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_SalesOrder001QR

Definition

Query to and answer from Sales Order Processing to retrieve data for customers and material.

Use

A seller can use the inbound operation Sales Order Item by Buyer and Product to search for sales order items according to customer and material.


SalesOrderBuyerPartyInternalID – Customer number (sold-to party in the back end)

Value

SalesOrderSalesOrganisationPartyInternallD – Customer’s sales organization in the back end

Value

SalesOrderItemProductSellerID – Material number in the back end


SalesOrderBuyerPartyInternalID schemeAgencyID schemeID

SalesOrderSalesOrganisationPartyInternalID schemeAgencyID schemeID

Features


SalesOrderItemByBuyerAndProductQuery_sync



SalesOrderItemByBuyerAndProductResponse_sync

Error Handling

The input parameters are checked for consistency and plausibility. If the check is negative, a corresponding error message is published in the message log

Integration

This inbound operation belongs to the inbound service interface Query Sales Order [Seite

392 ] .


Prerequisites

For more information, see Sales Order Processing [Seite 391 ] .

Processing

You can use the Business Add-In (BAdI) SLS_SE_SALESORDER001QR for this operation.

Find Sales Order Basic Data by Buyer and Basic

Data

Technical Data

Entity Type





Category

Mode


Service operation

SalesOrderBasicDataByBuyerAndBasicData



Inbound

Synchronous

ECC_SalesOrder005QR

Definition

Query to and response from Sales Order Processing to retrieve basic data about sales orders, restricted according to customer and basic data.

Use

Sellers can use the inbound operation Find Sales Order Basic Data by Buyer and Basic Data to search for sales orders according to customer and basic data about the customer.

Features


SalesOrderBasicDataByBuyerAndBasicDataQuery_sync

SalesOrderBasicDataByBuyerAndBasicDataResponse_sync

The following value must be delivered:




Value

The following values can be delivered to restrict the selection:

SalesOrderSalesOrganisationPartyInternallD – Customer’s sales organization in the back end

Value

SalesOrderSalesOfficePartyInternallD – Sales office in the back end

Value

CustomerReturnSalesGroupPartyInternallD – Sales group in the back end

Value

CustomerReturnProcessingTypeCode – Order type in the back end

CustomerReturnSalesTermsDistributionChannelCode – Distribution channel in the back end

Value

CustomerReturnSalesTermsDivisionCode – Division in the back end

Value



SalesOrderSalesOrganisationPartyInternalID schemeAgencyID schemeID

SalesOrderSalesOfficePartyInternalID schemeAgencyID schemeID

SalesOrderSalesGroupPartyInternalID schemeAgencyID schemeID

SalesOrderSalesTermsDistributionChannelCode listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID



SalesOrderSalesTermsDivisionCode listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID

Error Handling


Integration

This inbound operation belongs to the inbound service interface Query Sales Order In [Seite

392 ] .


Prerequisites


Processing


Find Sales Order Basic Data by Buyer and by

Invoicing Blocked

Technical Data

Entity Type





Category

Mode


Service operation

SalesOrderBasicDataByBuyerAndInvoicing

BlockedQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_SalesOrder006QR

Definition

Query to and response from Sales Order Processing to retrieve basic data about sales orders that are blocked for invoicing, restricted according to customer.

Use

Sellers can use the inbound operation Find Sales Order Basic Data By Buyer and By

Invoicing Blocked to search for sales orders that are blocked for invoicing, restricted according to customer.



Features


SalesOrderBasicDataByBuyerAndInvoicingBlockedQuery_sync

SalesOrderBasicDataByBuyerAndInvoicingBlockedResponse_sync


SalesOrderBuyerPartyInternalID – customer number (sold-to party in the back-end system)

Value

The following values must not be used:


Error Handling


Integration


392 ] .


Prerequisites


Processing


Find Sales Order Basic Data by Buyer and Credit

Blocked

Technical Data

Entity Type





Category

Mode


Service operation

SalesOrderBasicDataByBuyerAndCredit

BlockedQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_SalesOrder008QR



Definition

Query to and response from Sales Order Processing to retrieve basic data about sales orders that are blocked because of a negative credit check, restricted according to customer.

Use

Sellers can use the inbound operation Find Sales Order Basic Data by Buyer and Credit

Blocked to search for sales orders that are blocked because of a negative credit check, restricted according to customer.

Features


SalesOrderBasicDataByBuyerAndCreditBlockedQuery_sync

SalesOrderBasicDataByBuyerAndCreditBlockedResponse_sync



Value



Error Handling


Integration


392 ] .


Prerequisites


Processing


Find Sales Order Basic Data by Buyer and

Incompleteness

Technical Data








Category

Mode


SalesOrderBasicDataByBuyerAnd

IncompletenessQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_SalesOrder007QR

Definition

Query to and answer from Sales Order Processing to retrieve basic data about incomplete sales orders according to customer.

Use

Sellers can use the inbound operation Find Sales Order Basic Data By Buyer and

Incompleteness to search for incomplete sales orders restricted according to customer.

Features


SalesOrderBasicDataByBuyerAndIncompletenessQuery_sync

SalesOrderBasicDataByBuyerAndIncompletenessResponse_sync



Value



Error Handling


Integration


392 ] .


Prerequisites


Processing




Find Sales Order Basic Data by Buyer and Delivery

Blocked

Technical Data

Entity Type





Category

Mode


Service operation

SalesOrderBasicDataByBuyerAndDeliveryBlocked



Inbound

Synchronous

ECC_SalesOrder003QR

Definition

Query to and response from Sales Order Processing to retrieve data about a customer and the orders blocked for delivery.

Use

A sellers can use the inbound operation Sales Order Basic Data by Buyer and Delivery

Blocked to search for a customer's sales orders that are blocked for delivery.



Value



Features


SalesOrderBasicDataByBuyerAndDeliveryBlockedQuery

SalesOrderBasicDataByBuyerAndDeliveryBlockedResponse

Error Handling

The input parameters are checked for consistency and plausibility. If the check is negative, a corresponding error message is published in the message log

Integration

This inbound operation belongs to the inbound service interface Query Sales Order [Seite

392 ] .



Constraints

Orders for a customer with delivery block at header level are selected, not orders with delivery block at schedule line level.


Prerequisites


Processing


Manage Sales Order In

Technical Data

Entity Type


Category

Mode



Inbound

Synchronous

Use

The inbound service interface ManageSalesOrder contains the operations that the sales clerk can use to process sales orders in sales and distribution.

Integration

The inbound service interface ManageSalesOrder belongs to process component Sales

Order Processing [Seite 391 ] and business object Sales Order [Seite 392 ] .

Structure

Inbound service interface ManageSalesOrder In encompasses the following inbound operations:

SalesOrderCreateRequestConfirmation_In ( Create Sales Order [Seite 401 ] )

SalesOrderItemByIDQueryResponse_In ( Read Sales Order Item [Seite 404 ] )

SalesOrderByIDQueryResponse_In ( Read Sales Order [Seite 405 ] )

SalesOrderItemScheduleLineRequestConfirmation_In ( Change Sales Order Item

Schedule Line [Seite 406 ] )

Create Sales Order

Technical Data

Entity Type

ES for SAP ERP 2005

Service operation

401






Category

Mode


SalesOrderCreateRequestConfirmation_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_SalesOrderCRTRC

Definition

Query to and confirmation from Sales Order Processing to create a sales order.

Use

The seller uses the inbound operation Create Sales Order to create a sales order for a customer.


ProcessingTypeCode – Order type in the back end (for example, OR for standard order)

BuyerParty-InternalID – Customer number (sold-to party in the back end)

Value

SalesOrganisationParty-InternalID – Customer’s sales organization in the back end

Value

SalesTerms-DistributionChannelCode – Customer’s distribution channel in the back end

Value

SalesTerms-DivisionCode – Customer’s division in the back end

Value

Item-Product-SellerID- Material number of the product in the back end

Item-TotalValues-RequestedQuantity-UnitCode – Sales unit of the product in the back end

Item-TotalValues-RequestedQuantity – Desired delivery quantity for the product in the back end


BuyerID: schemeAgencySchemeAgencyID schemeAgencyID schemeID

BuyerParty-InternalID schemeAgencyID schemeID



SalesOrganisationParty-InternalID schemeAgencyID schemeID

SalesTerms-DistributionChannelCode: listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID

SalesTerms-DivisionCode: listAgencyID listAgencySchemeID listVersionID listAgencySchemeAgencyID listID

Features


SalesOrderCreateRequest

SalesOrderCreateConfirmation

Error Handling

Sales Order Processing carries out input checks and error handling. If an error occurs, the corresponding message is published in the message log.

If an error occurs while the order is being processed, processing is canceled. In this case, no order is created.

Integration

This inbound operation belongs to the inbound service interface Manage Sales Order [Seite

401 ] .


Prerequisites


Processing

The order type controls the operation features (see online documentation for sales document type).

You can use the Business Add-In (BAdI) SLS_SE_SALESORDERCHGRC for this operation.



Read Sales Order Item

Technical Data

Entity Type





Category

Mode


Service operation

SalesOrderItemByIDQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_SalesOrder004QR

Definition

Query to and answer from Sales Order Processing to retrieve order item data.

Use

Sellers can use the inbound operation Read Sales Order to display a sales order item.


SalesOrderID – Sales document number in the back end

Value

SalesOrder-ID – Item number of the sales document in the back end

The following value must not be used:

SalesOrderID schemeAgencyID

Features


SalesOrderItemByIDQuery

SalesOrderItemByIDResponse

Error Handling

Sales Order Processing carries out input checks and error handling. If the order item cannot be displayed, the corresponding error message is published in the message log.

Integration


401 ] .


Prerequisites




Processing


Read Sales Order

Technical Data

Entity Type





Category

Mode


Service operation

SalesOrderByIDQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_SalesOrder002QR

Definition

Query to and answer from Sales Order Processing to retrieve order item data.

Use

Sellers can use the inbound operation Read Sales Order to display a sales order.


SalesOrder-ID – Number of the sales document in the back end

Value


SalesOrderID schemeAgencyID

Features


SalesOrderByIDQuery

SalesOrderByIDResponse

Error Handling

Sales Order Processing carries out input checks and error handling.

If the order cannot be displayed, the corresponding error message is published in the message log.

Integration


401 ] .




Prerequisites


Processing


Change Sales Order Item Schedule Line

Technical Data

Entity Type





Category

Mode


Service operation

SalesOrderItemScheduleLineChange

RequestConfirmation_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_SalesOrderCHGRC

Definition

A request to and confirmation from Sales Order Processing to change a schedule line of a sales order item.

Use

The inbound operation Change Sales Order Schedule Line is used by the seller to change a schedule line of an item in a sales order for a customer.


SalesOrder-ID – number of the sales document in the back-end system

SalesOrder-Item-ID – number of the sales document item in the back-end system

SalesOrder-Item-ScheduleLine-ID – schedule line number in the back-end system

The following value must not be used:

SalesOrder-ID schemeAgencyID

Features


SalesOrderItemScheduleLineChangeRequest

SalesOrderItemScheduleLineChangeConfirmation



Error Handling

Input checks and error handling are handled by Sales Order Processing.

If an error occurs, the message is published in the message log.

If an error occurs during order processing, processing is terminated. In this case, the schedule line is not changed.

Integration

This inbound operation belongs to inbound service interface Manage Sales Order In [Seite

401 ] .

Constraints


Processing

The back-end system supplies and calculates additional values. The confirmed quantity depends on the input values for RequestedQuantity and the availability situation.


Prerequisites


Processing

Business Add-In (BAdI) SLS_SE_SALESORDERCHGRC is available for this operation.

Site Logistics Processing

Technical Data

Entity Type



Definition

Preparing, physically carrying out, and confirming logistical processes at a location.

The logistical processes are based on logistics models. The processes include picking, packing, shipping, receiving, and other logistical services.

Goods Movement

Technical Data

Entity Type





Definition

Physical or logical movement of materials that causes a change in material stocks or assigns materials directly for use.

Use

A company can receive, use, produce, and move goods and issue them with or without reference to other business processes (such as purchasing or production).

These different goods movements must be posted in the company inventory management so that a company’s stock, the stock accounts in financial accounting, and cost accounting are always up-to-date and accurate.

Manage Goods Movement In

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations for processing goods movements.

Use

The inbound service interface Manage Goods Movement In contains the operations that a warehouse specialist can use to process goods movements.

Integration

The inbound service interface Manage Goods Movement In belongs to process component

Site Logistics Processing [Seite 407 ] and business object Goods Movement [Seite 407 ] .

Structure

Inbound service interface Manage Goods Movement In encompasses the following inbound operations:

GoodsMovementWithReferenceCreateRequestConfirmation_In ( Create Goods

Movement With Reference [Seite 409 ] )

GoodsMovementCreateRequestConfirmation_In ( Create Goods Movement [Seite

410 ] )

GoodsMovementCancelRequestConfirmation_In ( Cancel Goods Movement [Seite

415 ] )



Create Goods Movement With Reference

Technical Data

Entity Type





Category

Mode


Service operation

GoodsMovementWithReferenceCreateRequest

Confirmation_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_GOODSMOVEMENTCWRRC

Definition

Query to and confirmation from Site Logistics Processing to create a goods movement with reference to a preceding document.

Use

A storeperson can use the inbound operation Create Goods Movement with Reference to create a goods movement with reference to a preceding document.

Features


GoodsMovementWithReferenceCreateRequest_sync

GoodsMovementWithReferenceCreateConfirmation_sync


GoodsMovement-BaseBusinessTransactionDocumentID

GoodsMovement-BaseBusinessTransactionDocumentTypeCode

Error Handling


Integration

This inbound operation belongs to the Manage Goods Movement [Seite 408 ] inbound service interface.

Constraints

Only the following values are allowed for BaseBusinessTransactionDocumentTypeCode:

S102 (InboundDelivery)

S43 (OutboundDelivery)

S101 (CustomerReturnsDelivery)

Furthermore, the operation is only intended for the standard system.




Prerequisites

To use this operation, you must implement the component SAP ECC Materials Management

(MM) and SAP ECC Logistics Execution (LE).

Processing

You can use the Business Add-In (BAdI) INV_SE_GOODSMOVEMENTCWRRC for this operation.

Create Goods Movement

Technical Data

Entity Type





Category

Mode


Service operation

GoodsMovementCreateRequestConfirmation_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_GOODSMOVEMENTCRTRC

Definition

Query to and confirmation from Site Logistics Processing to create a goods movement.

Use

A storeperson can use the inbound operation Create Goods Movement to create a goods movement.

Features


GoodsMovementCreateRequest_sync

GoodsMovementCreateConfirmation_sync

The fields to be filled in depend on the type of goods movement as well as the Customizing.

The following fields are possible in the header:

PostingDate (mandatory)

DocumentCreationDate (optional)

Description (maximum 25 characters) (optional)

GoodsMovementCategoryCode (mandatory)

ExternalGoodsMovementReferenceDoucmentID (optional)

GoodsReceiptUssueSlipPrintTypeCode (optional)



The following fields are possible for the item:

GoodsMovementTypeCode (mandatory)

InventoryUsabilityCode (optional)

InventorySpecialStockTypeCode (optional)

GoodsMovementReasonCode (optional)

UnloadingPointName (optional)

GoodsReceiptName (optional)

PlantID (mandatory)

Description (maximum 50 characters) (optional)

SalesOrderID – mandatory if InventorySpecialStockTypeCode 1

SalesOrderItemID – mandatory if InventorySpecialStockTypeCode 1

ProjectWorkBreakdownStructureElementID – mandatory if

InventorySpecialStockTypeCode 2

The following other fields are also possible:

ProductRecipientParty

InternalID - mandatory if InventorySpecialStockTypeCode 5 or 7

SellerParty

InternalID – mandatory if InventorySpecialStockTypeCode 3, 6 or 8

Can be delivered automatically or manually for pipeline material

InventoryManagedLocation

InternalID – optional, only unique when combined with PlantID

Not necessary if InventorySpecialStockTypeCode 5, 7 or 8

Material

InternalID (mandatory)

StandardID – optional, EAN = SchemeAgencyID 9

BatchID (optional) ony unique when combined with ProductInternalID mandatory if material subject to batch management requirement

VendorBatchID, ExpirationDate and ProductionDate are optional

VendorBatchID (optional)

ExpirationDate (optional)

ProductionDate (optional)

SerialIDCreateAutomaticIndicator – optional, only possible when combined with

GoodsMovementCode 3 if the material is not yet serialized and serialization will take place at goods movement.



SerialNumber

SerialID (optional), only necessary for materials managed with serial numbers.

Not supplied if SerialIDCreateAutomatcIndicator is set

Quantity

EntryQuantity (mandatory)

AccountAssignment

CostCentreID – mandatory if GoodsMovementTypeCode 201

GeneralLedgerAccountID (optional)

ProductionOrder ID – mandatory if GoodsMovementTypeCode 261

MaintenanceOrderID – mandatory if GoodsMovementTypeCode 261

SalesOrderID – mandatory if GoodsMovementTypeCode 231

SalerOrderItemID – mandatory if GoodsMovementTypeCode 231

SalesOrderItemScheduleLineID – optional, for example, if

GoodsMovementTypeCode 231

ProfitCentreID (optional)

ProjectWorkBreakdownStructureElementID – mandatory if

GoodsMovementTypeCode 221

MasterFixedAssetID – mandatory if GoodsMovementTypeCode 241

FixedAssetID – optional, for example, if GoodsMovementTypeCode 241

FundsManagementFundID (optional)

FundsMangementCentreID (optional)

FundsMangementAccountID (optional)

CostingActivityID (optional)

ResourceClassID (optional)

GrantID (optional)

TradingPartnerAccountingBusinessAreaCode (optional)

ClearingCompanyID (optional)

ProjectNetworkID – mandatory if GoodsMovementTypeCode 281

ProjectActivityID – mandatory if GoodsMovementTypeCode 281

The following fields are returned:

MessageHeader

GoodsMovement

ID

Year



Log (mandatory)

MessageHeader and GoodsMovement are optional. The MessageHeader is only returned if it was not initial for the query.

GoodsMovement is only returned if the goods movement was successfully posted. If

GoodsMovement is returned, then ID and year are mandatory.

Error Handling


Integration


Constraints

The operation only posts goods movements (GoodsMovementCategoryCode 3).

Furthermore, the operation is only intended for the standard system.

A GoodsMovementTypeCode is only possible in combination with a

GoodsMovementCategoryCode.

Only the entry quantity is supported.

The table below provides an overview of which stock goods can be withdrawn from. The operation supports these goods movements only.

GoodsMovementTypeCode InventorySpecialStockTypeCode Stock

Consumption for cost center

201

Consumption for project

Consumption for sales order

Consumption for installation

Consumption for sales

Consumption for maintenance order or production order

221

231

241

251

261

1

2

3

4

5

—

3

—

3

—

1

2

3

2

3

—

—

3

4

—

Unrestricted stock

Vendor consignment stock

Pipeline

Unrestricted stock

Project stock


Unrestricted stock

Sales order stock

Project stock


Unrestricted stock


Unrestricted stock

Vendor-consignment stock

Unrestricted stock

Sales order stock

Project stock


Pipeline

Consignment stock at



Consumption for project network

Consignment for all account assignments

Withdrawal for scrapping from unrestricted stock

Withdrawal for scrapping from stock in quality inspection

553

Scrapping from blocked stock

281

291

551

555

2

3

4

—

1

—

1

2

3

2

3

5

4

—

1

7

8

—

1

2

3

5

7

8

—

1

2

3 customer

Unrestricted stock

Sales order stock

Project stock


Pipeline

Unrestricted stock

Sales order stock

Project stock


Pipeline material

Unrestricted stock

Sales order stock

Project stock


Consignment stock at customer

Returnable packaging with customer

Stock of material provided to vendor

Stock in quality inspection

Sales order stock

Project stock


Consignment stock at customer

Returnable packaging with customer

Stock of material provided to vendor

Blocked stock

Sales order stock

Project stock



Prerequisites

To use the operation, you must implement the component SAP ECC Materials Management

(MM) and the component whose business transaction you want to be able to carry out, for example, the component SAP ECC Production Planning (PP) for goods issue/consumption


SAP Documentation Enterprise SOA for production order, the component SAP ECC Controlling (CO) for goods issue/consumption for cost center.

You must also have performed the following settings in Customizing:

Standard Customizing for Inventory Management (MM-IM)

Customer-specific definition of the company structure

Processing

You can use the Business Add-In (BAdI) INV_SE_GOODSMOVEMENTCRTRC for this operation.

Cancel Goods Movement

Technical Data

Entity Type





Category

Mode


Service operation

GoodsMovementCancelRequestConfirmation_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_GOODSMOVEMENTCNCRC

Definition

Query to and confirmation from Site Logistics Processing to cancel a goods movement.

Use

A storeperson can use the inbound operation Cancel Goods Movement to cancel a goods movement.

Features


GoodsMovementCancelRequest_sync

GoodsMovementCancelConfirmation_sync


GoodsMovement-ID

GoodsMovement-Year of the goods movement to be canceled

PostingDate (optional)

To cancel individual document items, enter the item ID as well.

The following fields are returned:

MessageHeader

GoodsMovement



ID

Year

Log (mandatory)

MessageHeader and GoodsMovement are optional. The MessageHeader is only returned if it was not initial for the query.

GoodsMovement is only returned if the goods movement was successfully posted. If

GoodsMovement is returned, then ID and year are mandatory.

Error Handling


Integration


Constraints

You cannot cancel documents, that were posted with reference to a delivery that were posted automatically to a completion message for a production order

Furthermore, you cannot cancel any specific automatically generated document line items.

You can only cancel a goods movement once.


Prerequisites

To use the operation you must implement the component SAP ECC Materials Management

(MM) and the components that were needed to post the goods movement to be canceled.

You must also have performed the following settings in Customizing:

Standard Customizing for Inventory Management (MM-IM)

Customer-specific definition of the company structure

The operation can be used in both the standard system and the industry system.

Processing

You can use the Business Add-In (BAdI) INV_SE_GOODSMOVEMENTCNCRC for this operation.

Supply and Demand Matching

Purpose

Answer the following questions:

What does the component do in general?

Why does the customer need the component?


SAP Documentation

Subsequently delete the paragraphs in green.

Enterprise SOA


This section is optional.

Answer the following question: Under what business or technical conditions should the customer implement and use this component?


Integration



How is the component related to other components or functions?

Where does the component fit in the component hierarchy?

What other components does the customer need?


Features



What does the component do (details, specifics)?

What capabilities does it provide?


Constraints


Answer the following question: What does the component not do?


Example


Answer the following question: Can you give me an example of the use of this component?


Production Planning Order

Technical Data



Entity Type


Version


ECC-SE 600)

Definition

A Production Planning Order is an object that defines the intended production of a material in a specific quantity and at a specific availability date. The planning order also carries the expected component demand and capacity consumption, which are typically determined by

BOM and routing explosion. The requirement dates of components and capacities are determined via scheduling.

Use

A ProductionPlanningOrder is a request made to a planning area (SupplyPlanningArea) to initiate the production of a particular quantity of a material on a defined date. The production planning order contains planning, administrative, and descriptive attributes.

Within the material requirements planning, a production planning order is a request to initiate the in-house production of a particular quantity of a material on a defined date.

A production planning order reflects all planning aspects of an in-house production process for a material. Material requirements planners as well as production schedulers need to be able to get an overview over the production planning orders that are planned for covering internal and external requirements. They also need to know which material requirements on component level and which capacity requirements are caused by these production planning orders and are necessary.

Production planning order is not used to control the production of the material itself. For this purpose the production planning order can be converted into a production order.


Prerequisites


Query Production Planning Order In

Technical Data

Entity Type

Software

Component

Version

Message

Direction


ECC-SE 600)

Inbound

Transmission

Type

Synchronous

Definition

The Query Production Planning Order In service interface enables you to retrieve production planning order based on the selection criteria.



Use

The Query Production Planning Order In inbound service interface includes operations that read relevant production planning order information matching the given elements of a production planned order.

Integration

The Query Production Planning Order In inbound service interface belongs to the Supply and

Demand Matching [Seite 416 ] process component and to the Production Planned Order


Structure


ProductionPlanningOrderSimpleByElementsQueryResponse_In ( Find Production

Planning Order by Elements [Seite 419 ] ).

Find Production Planning Order By Elements

Technical Data

Entity Type

Technical

Name in

Enterprise service

Repository

(ESR)

Operation

ProductionPlanningOrderSimpleByElementsQueryResponse_In http://sap.com/xi/APPL/SE/Global Namespace in ESR

Software

Component

Version in

ESR

Category

Mode

As of ECC-SE 600

Inbound

Synchronous

Definition

The Find Production Planning Order By Elements operation retrieves production planned orders based on the selected elements.

Use

The Find Production Planning Order By Elements operation inbound operation allows you to search and retrieve the valid settings of an production planning order using a search criteria by elements. You can search the details of a production planning order by using a combination of the following criteria:

MaterialInternalID

SupplyPlanningAreaID

MaterialRequirementsPlanningControllerID

ProductionVersionID



BasicEndDate

Features


Production Planning Order Simple By Elements Query

This message is a query to Supply and Demand Matching process component for production planning orders that match the given elements.

Production Planning Order Simple By Elements Response

This response message retrieves the list of production planning orders that match the given elements.




Prerequisites

Production planning order exists in the system.

Processing

This Business Add-In (BAdI) PPLO_SE_PRODPLANORDERSEQR ( Definition to Get

Production Planning Order Details By Elements ) is available for this operation.

Manage Production Planning Order In

Technical Data

Entity Type

Software

Component

Version

Message

Direction

Transmission

Type


ECC-SE 600)

Inbound

Synchronous

Definition

The Manage Production Planning Order In service interface enables you to read production planning order.

Use

The Manage Production Planning Order In service interface contains an operation that enables you to read the values of production planned order in a production line.



Integration

The Manage Production Planning Order In inbound service interface belongs to the Supply and Demand Matching [Seite 416 ] process component and the Production Planned Order


Structure

This inbound service interface contains the inbound operation

ProductionPlanningOrderByIDQueryResponse_In ( Read Production Planning Order

[Seite 421 ] ).

Create Production Planning Order

Read Production Planning Order

Technical Data

Operation Entity

Type

Technical

Name in

Enterpris e Service

Reposito ry (ESR)

Name

Space in

ESR

Software

Compone nt

Version in ESR

Category

Mode

Related

Web

Service

Definition

ProductionPlanningOrderByIDQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_PRODPLANORDERIDQR

Definition

Read Production Planning Order operation enables you to read planned production order details for a given ProductionPlanningOrderID .

Use

The Read Production Planning Order inbound operation reads and retrieves the details of a planned production order for a given ProductionPlanningOrderID . You can use these details for planning and administrative records.



Features


Production Planning Order By ID Query

This message is a query to Supply and Demand Matching operation to retrieve details of a production planning order for a given ProductionPlanningOrderID .

Production Planning Order By ID Response

This response message retrieves the details of the production planned order for the given production planned order ID.




Prerequisites

Production planning order exists in the system.

Processing

The Business Add-in (BAdI) PPLO_SE_PRODPLANORDERIDQR ( Definition to Read

Production Planning Order Details ) is available for this operation.

Change Production Planning Order

Update Production Planning Order

Cancel Production Planning Order

Material Supply and Demand View

<Title Business Object Template>

Target group: ISV Developer, Business Process Modeler

Source: ARIS, PIC; Specification, Development

Description

Technical Name



Entity Type

Namespace

Software Component

Version

Definition

Keyblock: Mandatory

Source: ARIS, PIC

Insert ARIS or PIC definition. Do not change it; except for changes that have been allowed by the Terminology group.

Use

Keyblock: Optional

AP: What is the use of the business object with special focus on the business context?

What are the business or technical uses of this business object?

Under which business conditions is it used?

Integration

Keyblock: Mandatory (AP: Optional)

AP: What relationships exist to other business objects in the same or other process components? (Passt das auf ESA?)

Status and Action Management


Relevant für ESA??

Structure


Which nodes does the business object consist of?

What elements, queries, and actions does the root node of the business object have?

Constraints


Does the business object have any constraints?

Example:



Due to terminology differences the customer might not find the expected functions under the usual name.



Definition


Manage Material Supply and Demand View

This information object describes the compound service interfaces that are based on an message interface. Do not use this information object to describe core services for a business object.

Target group: ISV Developers, Architects, Business Solution Modelers

Source: ARIS, PIC, Specification, Design, Developer

<Technical data table>[DataMerge

]

Entity Type

Namespace

Software

Component

Version

Message

Direction

Transmission

Type

Service Interface

Service Interface

Inbound

Message

Transmission

Type

(Delete options that do not apply)

Asynchronous

Synchronous


A2A

B2B

Definition


Use the definition from the PIC document.



Use


For which business and/or technical purpose can this inbound service interface be used?

<Text>

Example: You use this inbound service interface to copy the time recording data that was recorded by an employee in an external time recording system to the process component Time and Labor Management in order to evaluate it.

Prerequisites


What business prerequisites must be fulfilled before this inbound service interface can be used?

<Text>

What configuration settings must have been made in order for this inbound service interface to be used for both general and specific purposes?

Integration


Which ESA objects are important in relation to this inbound service interface? For example, process components, integration scenarios, business objects.

Which BAdIs are available for this service operation? If there is more than one BAdI, use a bulleted list. Begin with the following standard formulation:

For this service operation, the following Business Add-Ins (BAdIs) are available:

If applicable: What additional information about the integration of the service interface is necessary? For example, additional information about connecting an external system.

<Text>

Für diese Service-Operation stehen Ihnen die folgenden Business Add-Ins (BAdIs) zur

Verfügung:

Structure

In this keyblock, describe the internal structure of the inbound service interface.


Which message interfaces are grouped together in this inbound service interface?

Start with the introductory sentence given below. First list all message interfaces in a non-numbered list and set a link to the documentation for the message interface that you have created.

This inbound service interface groups the following message interfaces:

<Message Interface_1>

Set a link to the documentation for message interface <message interface_1>.

< Message Interface _2>


< Message Interface _n>

Set a link to the documentation for message interface <message interface_n>.



<Text>

Error Handling


Describe only error handling which is common to all message interfaces of this service interface. Describe the error handling specific to the message interfaces in the message interface documentation.

Questions to be answered by the authors:

Which errors specific to service interface are known?

Describe briefly what happens under certain error conditions.

<Text>

Which error triggers which message(s)?

For further information concerning the message interface-specific error handling, see the message interface documentation.

Constraints


<Text>

Which technical or business constraints apply to this inbound service interface? Do not describe constraints that apply to the individual message interfaces.



<Text>

Read Material Supply and Demand View

Target group: ISV Developers, Business Process Modelers


Technical Data

Entity Type Service Operation

(Message Interface)

Semantical Name



Repository

Name Space

Software

Component

Message Direction Inbound




Message



Synchronous

Asynchronous


A2A

B2B

Corresponding Web

Service

Insert the technical name of the web service in the corresponding backend system.

Hint

To find out the transmission type and the message direction, check the radio buttons

Mode and Category in the object editor.

The functions of the service operations collected in one service interface can be very similar, e.g. service operations for creating or changing data. In this case, describe the prerequisites, structure, etc. in one service operation in detail. Describe the similar working service operations in a reduced manner and set a link to the detailed described service operation.

Definition


Insert ARIS or PIC definition.

Use


What are the business uses or technical uses of this service operation?

Under which business conditions is it used?

Begin with the following standard formulation

Begin with the following standard formulation:

English:

This inbound service operation < verb >…

German:

Diese Inbound-Service-Operation < V e rb >

<Text>

Features


What does this inbound service operation do, in detail?

What information does the inbound service operation expect from the inbound message? Are the data types used in the message types of this service operation used in a restricted manner?



What is the expected result of the inbound service operation?

Which message types does this inbound service operation receive

Is the service restart capable or not? Answer this question. Begin with the following standard formulation:

This inbound service interface is restart capable / is not restart capable.

Dieses Inbound-Service-Interface kann erneut gestartet werden.

If a service is not restart capable: Which service can be used to read current data in backend system to check if previous service was successful.



<Text>


Verfügung:

Error Handling


What error handling is implemented for this service operation? How does the service operation react to an error?

If there are standard procedures for error handling, you should only describe error handling procedures that are different here. Otherwise, it is sufficient to state that the operation has implemented standard error handling.

<Text>

Prerequisites


What business prerequisites must be fulfilled before this service operation can be used? Makes this service operation sense only in specific business processes?

What technical prerequisites must be fulfilled before this service operation can be used?

<Text>

What configuration settings must have been made in order for this service operation to be used for both general and specific purposes?

Integration

Keyblock: Optiona

If applicable: What additional information about the integration of the inbound service operation is necessary?

For example, integration with outbound services interfaces, and outbound service operations

<Text>



Constraints


<Text>

Which technical or business constraints apply to this inbound service operation?



<Text>

Product Availability Requirement

<Title Business Object Template>

Target group: ISV Developer, Business Process Modeler


Description

Technical Name

Entity Type

Namespace

Software Component

Version

Definition


Source: ARIS, PIC

Insert ARIS or PIC definition. Do not change it; except for changes that have been allowed by the Terminology group.

Use


AP: What is the use of the business object with special focus on the business context?

What are the business or technical uses of this business object?

Under which business conditions is it used?

Integration

Keyblock: Mandatory (AP: Optional)



AP: What relationships exist to other business objects in the same or other process components? (Passt das auf ESA?)

Status and Action Management


Relevant für ESA??

Structure


Which nodes does the business object consist of?

What elements, queries, and actions does the root node of the business object have?

Constraints


Does the business object have any constraints?

Example:

Due to terminology differences the customer might not find the expected functions under the usual name.



Definition


Manage Product Availability Requirement

This information object describes the compound service interfaces that are based on an message interface. Do not use this information object to describe core services for a business object.

Target group: ISV Developers, Architects, Business Solution Modelers


SAP Documentation

Source: ARIS, PIC, Specification, Design, Developer

<Technical data table>[DataMerge

]

Entity Type

Namespace

Software

Component

Version

Message

Direction

Transmission

Type

Message

Transmission

Type

Service Interface

Service Interface

Enterprise SOA

Inbound


Asynchronous

Synchronous


A2A

B2B

Definition


Use the definition from the PIC document.

Use


For which business and/or technical purpose can this inbound service interface be used?

<Text>

Example: You use this inbound service interface to copy the time recording data that was recorded by an employee in an external time recording system to the process component Time and Labor Management in order to evaluate it.

Prerequisites


What business prerequisites must be fulfilled before this inbound service interface can be used?

<Text>

What configuration settings must have been made in order for this inbound service interface to be used for both general and specific purposes?

Integration


Which ESA objects are important in relation to this inbound service interface? For example, process components, integration scenarios, business objects.






Verfügung:

If applicable: What additional information about the integration of the service interface is necessary? For example, additional information about connecting an external system.

<Text>

Structure

In this keyblock, describe the internal structure of the inbound service interface.


Which message interfaces are grouped together in this inbound service interface?

Start with the introductory sentence given below. First list all message interfaces in a non-numbered list and set a link to the documentation for the message interface that you have created.

This inbound service interface groups the following message interfaces:

<Message Interface_1>


< Message Interface _2>


< Message Interface _n>

Set a link to the documentation for message interface <message interface_n>.

<Text>

Error Handling


Describe only error handling which is common to all message interfaces of this service interface. Describe the error handling specific to the message interfaces in the message interface documentation.

Questions to be answered by the authors:

Which errors specific to service interface are known?

Describe briefly what happens under certain error conditions.

<Text>

Which error triggers which message(s)?

For further information concerning the message interface-specific error handling, see the message interface documentation.

Constraints


<Text>

Which technical or business constraints apply to this inbound service interface? Do not describe constraints that apply to the individual message interfaces.


SAP Documentation



<Text>

Enterprise SOA

Check Requirement



Technical Data


(Message Interface)

Semantical Name



Repository

Name Space

Software

Component



Message


Inbound


Synchronous

Asynchronous



Service

A2A

B2B


Hint






Definition



Use






English:


German:


<Text>

Features












<Text>


Verfügung:

Error Handling






<Text>

Prerequisites




<Text>


Integration

Keyblock: Optiona



<Text>

Constraints


<Text>




<Text>

Check Requirement and Reserve



Technical Data


(Message Interface)

Semantical Name



Repository



Name Space

Software

Component



Message



Service

Inbound


Synchronous

Asynchronous


A2A

B2B


Hint




Definition



Use






English:


German:


<Text>

Features














<Text>


Verfügung:

Error Handling




<Text>

Prerequisites




<Text>


Integration

Keyblock: Optiona





<Text>

Constraints


<Text>




<Text>

Cancel Requirement



Technical Data

Entity Type

Semantical Name



Repository

Name Space

Software

Component



Message



Service

Service Operation

(Message Interface)

Inbound


Synchronous

Asynchronous


A2A

B2B


Hint






Definition



Use






English:


German:


<Text>

Features














<Text>


Verfügung:

Error Handling




<Text>

Prerequisites




<Text>


Integration

Keyblock: Optiona



<Text>

Constraints


<Text>




<Text>



Enterprise Services for SAP ERP Financials

Accounting

Technical Data

Entity Type


Process component mySAP ERP enterprise services package (as of ESA ECC SE 501)

Definition

The creation of all relevant business transactions in accounting.

Use

The process component Accounting contains services for the following business objects from the following areas:

Controlling: Budget Monitoring Rule

Public Sector Management:

Funds Management Account

Funds Management Program

Funds Management Fund

Funds Management Functional Area

Constraints

The services available are limited to the business objects detailed in the section 'Use'.

Specifically, the Accounting process component does not contain services for the standard functions in accounting.


To enable you to use the service operations contained in the process component, you have to implement the following software components, depending on the area:

SAP ECC Enterprise Extension PLM, SCM, Financials (EA-APPL)

SAP ECC Enterprise Extension Public Sector (EA-PS)

Processing

Note the following behavior of the change and update operations of these process components when you use them: the data transferred by request messages overwrites only those affected objects in the databases of the back-end system that are also filled in the message structure. This also applies to the individual items of list-type elements.

This means that if optional elements are not filled in a request message, then the back-end system leaves the values as they are in the affected fields in the


SAP Documentation Enterprise SOA database. The only exception to this behavior is when these values are automatically updated due to changes to other data.

Cost Center Variance Budget Monitoring Rule

Technical Data

Entity Type


Business object mySAP ERP enterprise services package (as of ESA ECC SE 501)

Definition

Rule specifying the point at which the actual costs exceed a threshold value for the plan costs of a cost center, so that this then represents a critical variance.

Use

The business object Cost Center Variance Budget Monitoring Rule enables the person responsible for monitoring cost centers to determine threshold values for critical variances, and to then display any cost centers where a critical variance has occurred.


Cost Center Line Item Budget Monitoring Rule [Seite 450 ]

Profit Center Variance Budget Monitoring Rule [Seite 459 ]

Internal Order Variance Budget Monitoring Rule [Seite 476 ]

Cost Center Variance Budget Monitoring Rule Configuration [Seite 493 ]


Prerequisites

You are using the application component C ost Center Accounting (CO-OM-CCA).

For additional information on cost center accounting, see the SAP Library under SAP ERP

Central Component Financials Controlling (CO) Cost Center Accounting (CO-OM-

CCA) .

Use

This business object enables a non-SAP system to be connected to the Manager Self-Service application Variance Monitor . For additional information on the variance monitor, see the SAP

Library under SAP ERP Central Component Business Packages (Portal Content)

Business Package for Manager Self-Service (mySAP ERP) Workset: Budget Critical

Variances Variance Monitor .



Manage Cost Center Variance Budget Monitoring

Rule

Technical Data

Entity Type


Category

Mode

Service interface mySAP ERP enterprise services package (as of ESA ECC SE 501)

Inbound

Synchronous

Definition

Group of operations for creating, changing, deleting or reading the Cost Center Variance

Budget Monitoring Rule .

Use

The inbound service Manage Cost Center Variance Budget Monitoring Rule encompasses operations that make it possible to create, change or delete rules for critical variances from the plan for a cost center, and also to read existing rules with or without the current evaluation result for the rule.

Integration

The inbound service interface Manage Cost Center Variance Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Cost Center Variance

Budget Monitoring Rule [Seite 442 ] .

Structure

The Manage Cost Center Variance Budget Monitoring Rule inbound service interface contains the following inbound operations:

CostCentreVarianceBudgetMonitoringRuleCreateRequestConfirmation_In ( Create

Rule [Seite 444 ] )

CostCentreVarianceBudgetMonitoringRuleChangeRequestConfirmation_In ( Change


CostCentreVarianceBudgetMonitoringRuleCancelRequestConfirmation_In ( Cancel


CostCentreVarianceBudgetMonitoringRuleByIDQueryResponse_In ( Read Rule [Seite

446 ] )

CostCentreVarianceBudgetMonitoringRuleEvaluationResultByIDQueryResponse_In

( Read Rule Evaluation Result [Seite 447 ] )


This service interface enables a non-SAP system to be connected to the Manager Self-

Service application Variance Monitor .



Create Rule

Technical Data

Entity Type





Category

Mode


Service operation

CostCentreVarianceBudgetMonitoringRuleCreate


As of ESA ECC SE 501

Inbound

Synchronous

ECC_CostCtrVarBudMonRuleCrtRC

Definition

Creating a rule that displays when the variance of aggregated costs on a cost center becomes critical.

Use

The inbound operation Create Rule transfers a rule to the back-end system.

Features


CostCentreVarianceBudgetMonitoringRuleCreateRequest

CostCentreVarianceBudgetMonitoringRuleCreateConfirmation

Error Handling

The AcceptanceStatusCode of message type

CostCentreVarianceBudgetMonitoringRuleCreateConfirmation displays whether or not the rule has been successfully created. If not, a corresponding notification should be in the Log .

Integration

This inbound operation belongs to the inbound service interface Manage Cost Center

Variance Budget Monitoring Rule [Seite 443 ] .

Change Rule

Technical Data

Entity Type




ES for SAP ERP 2005

Service operation

CostCentreVarianceBudgetMonitoringRule

ChangeRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global

444

SAP Documentation


Category

Mode


Enterprise SOA


Inbound

Synchronous

ECC_CostCtrVarBudMonRuleChgRC

Definition

Changing a rule that displays when the variance of aggregated costs on a cost center becomes critical.

Use

The inbound operation Change Rule changes a rule in the back-end system.

Features


CostCentreVarianceBudgetMonitoringRuleChangeRequest

CostCentreVarianceBudgetMonitoringRuleChangeConfirmation

Error Handling


CostCentreVarianceBudgetMonitoringRuleChangeConfirmation displays whether or not the rule has been successfully changed. If not, a corresponding notification should be in the Log .

Integration



Cancel Rule

Technical Data

Entity Type


Repository (ESR)

Namespace in ESR


Category

Mode


Service operation


CancelRequestConfirmation_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_CostCtrVarBudMonRuleCncRC



Definition

Deletion of a rule that displays when the variance of aggregated costs on a cost center becomes critical.

Use

The inbound operation Cancel Rule deletes a rule in the back-end system.

Features


CostCentreVarianceBudgetMonitoringRuleCancelRequest

CostCentreVarianceBudgetMonitoringRuleCancelConfirmation

Error Handling


CostCentreVarianceBudgetMonitoringRuleCancelConfirmation displays whether or not the rule has been successfully deleted. If not, a corresponding notification should be in the Log .

Integration



Read Rule

Technical Data

Entity Type


Repository (ESR)

Namespace in ESR


Category

Modus


Service operation




Inbound

Synchronous

ECC_CostCtrVarBudMonRuleIDQR

Definition

Reading a rule that displays when the variance of aggregated costs on a cost center becomes critical.

Use

The inbound operation Read Rule reads the rule and its description with the ID found in the back-end system.



Features


CostCentreVarianceBudgetMonitoringRule ByIDQuery

CostCentreVarianceBudgetMonitoringRule ByIDResponse

Integration



Read Rule Evaluation Result

Technical Data

Entity Type





Category

Mode


Service operation


EvaluationResultByIDQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_CostCtrVarBudMonRuleRIDQR

Definition

Reading the evaluation results of a rule that displays when the variance of aggregated costs on a cost center becomes critical.

Use

The inbound operation Read Rule Evaluation Result reads the rule details of the evaluation result with the ID found in the back-end system. The actual costs, the plan costs and the

CriticalityCode ( Critical , Partially critical or Not critical ) are read from the evaluation result for the rule and also for each individual cost center. In addition, the actual and plan costs are read for each period.

Features


CostCentreVarianceBudgetMonitoringRule EvaluationResultByIDQuery

CostCentreVarianceBudgetMonitoringRule EvaluationResultByIDResponse

Integration





Query Cost Center Variance Budget Monitoring

Rule

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations to find Cost Center Variance Budget Monitoring Rule s with relevant selection criteria.

Use

The inbound service interface Query Cost Center Variance Budget Monitoring Rule encompasses operations that read rules for each person responsible for critical variances from the plan for a cost center, with or without the current evaluation result for the rule.

Integration

The inbound service interface Manage Cost Center Variance Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Cost Center Variance


Structure

The Query Cost Center Variance Budget Monitoring Rule inbound service interface contains the following inbound operations:

CostCentreVarianceBudgetMonitoringRuleSimpleByOwnerQueryResponse_In ( Find

Rule by Owner [Seite 448 ] )

CostCentreVarianceBudgetMonitoringRuleEvaluationResultByOwnerQueryResponse_

In ( Find Rule Evaluation Result by Owner [Seite 449 ] )




Find Rule by Owner

Technical Data



SAP Documentation





Category

Mode


Enterprise SOA


SimpleByOwnerQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_CostCtrVarBudMonRuleSiOwQR

Definition

Search based on the person responsible for the rules that display when the variance of the aggregated costs on a cost center becomes critical.

Use

The inbound operation Find Rule by Owner reads all rules and the description of the rules of a particular person responsible from the back-end system.

Features


CostCentreVarianceBudgetMonitoringRuleSimpleByOwnerQuery

CostCentreVarianceBudgetMonitoringRuleSimpleByOwnerResponse

Integration

This inbound operation belongs to the inbound service interface Query Cost Center Variance


Find Rule Evaluation Result by Owner

Technical Data

Entity Type





Category

Mode


Service operation


EvaluationResultByOwnerQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_CostCtrVarBudMonRuleROwQR



Definition

Search based on the person responsible for the evaluation results of the rules that display when the variance of the aggregated costs on a cost center becomes critical.

Use

The inbound operation Find Rule Evaluation Result by Owner reads all rules and the details of the evaluation results of a particular person responsible from the back-end system. The actual costs, the plan costs and the CriticalityCode ( Critical , Partially critical or Not critical ) are read from the evaluation results for each rule and also for each individual cost center. In addition, the actual and plan costs are read for each period.

Features


CostCentreVarianceBudgetMonitoringRuleEvaluationResultByOwnerQuery

CostCentreVarianceBudgetMonitoringRuleEvaluationResultByOwnerResponse

Integration



Cost Center Line Item Budget Monitoring Rule

Technical Data

Entity Type



Definition

Rule that specifies a threshold value over which a posting to a cost center is critical.

Use

The business object Cost Center Line Item Budget Monitoring Rule enables the person responsible for monitoring cost centers to determine threshold values for critical postings, and to then display any cost centers where a critical posting has occurred.


Cost Center Variance Budget Monitoring Rule [Seite 442 ]

Profit Center Line Item Budget Monitoring Rule [Seite 467 ]

Internal Order Line Item Budget Monitoring Rule [Seite 484 ]

Cost Center Line Item Budget Monitoring Rule Configuration [Seite 495 ]




Prerequisites




CCA) .

Use

This business object enables a non-SAP system to be connected to the Manager Self-Service application Posting Monitor . For additional information on the posting monitor, see the SAP



Postings Posting Monitor .

Manage Cost Center Line Item Budget Monitoring

Rule

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for creating, changing, deleting or reading the Cost Center Line Item


Use

The inbound service Manage Cost Center Line Item Budget Monitoring Rule encompasses operations that make it possible to create, change or delete rules for critical postings on a cost center, and also to read existing rules with or without the current evaluation result for the rule.

Integration

The inbound service interface Manage Cost Center Line Item Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Cost Center Line Item


Structure

The Manage Cost Center Variance Budget Monitoring Rule inbound service interface contains the following inbound operations:

CostCentreLineItemBudgetMonitoringRuleCreateRequestConfirmation_In ( Create

Rule [Seite 452 ] )



CostCentreLineItemBudgetMonitoringRuleChangeRequestConfirmation_In ( Change

Rule [Seite 453 ] )

CostCentreLineItemBudgetMonitoringRuleCancelRequestConfirmation_In ( Cancel

Rule [Seite 453 ] )

CostCentreLineItemBudgetMonitoringRuleByIDQueryResponse_In ( Read Rule [Seite

454 ] )

CostCentreLineItemBudgetMonitoringRuleEvaluationResultByIDQueryResponse_In

( Read Rule Evaluation Result [Seite 455 ] )



Service application Posting Monitor .

Create Rule

Technical Data

Entity Type





Category

Mode


Service operation

CostCentreLineItemBudgetMonitoringRule



Inbound

Synchronous

ECC_CostCtrPosBudMonRuleCrtRC

Definition

Creating a rule that displays when the posting to a cost center becomes critical.

Use


Features


CostCentreLineItemBudgetMonitoringRuleCreateRequest

CostCentreLineItemBudgetMonitoringRuleCreateConfirmation

Error Handling


CostCentreLineItemBudgetMonitoringRuleCreateConfirmation displays whether or not the rule has been successfully created. If not, a corresponding notification should be in the Log .



Integration

This inbound operation belongs to the inbound service interface Manage Cost Center Line

Item Budget Monitoring Rule [Seite 451 ] .

Change Rule

Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_CostCtrPosBudMonRuleChgRC

Definition

Changing a rule that displays when the posting to a cost center becomes critical.

Use


Features


CostCentreLineItemBudgetMonitoringRuleChangeRequest

CostCentreLineItemBudgetMonitoringRuleChangeConfirmation

Error Handling


CostCentreLineItemBudgetMonitoringRuleChangeConfirmation displays whether or not the rule has been successfully changed. If not, a corresponding notification should be in the Log .

Integration



Cancel Rule

Technical Data


SAP Documentation

Entity Type





Category

Mode


Enterprise SOA

Service operation




Inbound

Synchronous

ECC_CostCtrPosBudMonRuleCncRC

Definition

Deletion of a rule that displays when the posting to a cost center becomes critical.

Use


Features


CostCentreLineItemBudgetMonitoringRuleCancelRequest

CostCentreLineItemBudgetMonitoringRuleCancelConfirmation

Error Handling


CostCentreLineItemBudgetMonitoringRuleCancelConfirmation displays whether or not the rule has been successfully deleted. If not, a corresponding notification should be in the Log .

Integration



Read Rule

Technical Data

Entity Type





Category

Mode

Service operation




Inbound

Synchronous


SAP Documentation


Enterprise SOA

ECC_CostCtrPosBudMonRuleIDQR

Definition

Reading a rule that displays when the posting to a cost center becomes critical.

Use


Features


CostCentreLineItemBudgetMonitoringRuleByIDQuery

CostCentreLineItemBudgetMonitoringRuleByIDResponse

Integration




Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_CostCtrPosBudMonRuleRIDQR

Definition

Reading the evaluation result of a rule that displays when the posting to a cost center becomes critical.

Use

The inbound operation Read Rule Evaluation Result reads the rule details of the evaluation result with the ID found in the back-end system. The following details are read from the evaluation result:

Number of postings that violate the rule

Document number and text



Document date

Document item number and text

Amount

Posting date

Cost center to which the document line was posted

Reference document number

Creator

Company code

Cost element

G/L account

Features


CostCentreLineItemBudgetMonitoringRuleEvaluationResultByIDQuery

CostCentreLineItemBudgetMonitoringRuleEvaluationResultByIDResponse

Integration



Query Cost Center Line Item Budget Monitoring

Rule

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations to find Cost Center Line Item Budget Monitoring Rule s with relevant selection criteria.

Use

The inbound service interface Query Cost Center Line Item Budget Monitoring Rule encompasses operations that read rules for each person responsible for critical postings to a cost center, with or without the current evaluation result for the rule.



Integration

The inbound service interface Query Cost Center Line Item Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Cost Center Line Item


Structure

The Query Cost Center Line Item Budget Monitoring Rule inbound service interface contains the following inbound operations:

CostCentreLineItemBudgetMonitoringRuleSimpleByOwnerQueryResponse_In ( Find

Rule by Owner [Seite 457 ] )

CostCentreLineItemBudgetMonitoringRuleEvaluationResultByOwnerQueryResponse_I n ( Find Rule Evaluation Result by Owner [Seite 458 ] )





Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_CostCtrPosBudMonRuleSiOwQR

Definition

Search based on the person responsible for the rules that display when a posting on a cost center becomes critical.

Use


Features


CostCentreLineItemBudgetMonitoringRuleSimpleByOwnerQuery

CostCentreLineItemBudgetMonitoringRuleSimpleByOwnerResponse



Integration

This inbound operation belongs to the inbound service interface Query Cost Center Line Item



Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_CostCtrPosBudMonRuleROwQR

Definition

Search based on the person responsible for the evaluation results of the rules that display when a posting on a cost center becomes critical.

Use

The inbound operation Find Rule Evaluation Result by Owner reads all rules and the details of the evaluation results of a particular person responsible from the back-end system. The following details are read from the evaluation results:

Number of postings that violate the rules


Document date


Amount

Posting date

Cost center to which the document line was posted


Creator

Company code

Cost element

G/L account



Features


CostCentreLineItemBudgetMonitoringRuleEvaluationResultByOwnerQuery

CostCentreLineItemBudgetMonitoringRuleEvaluationResultByOwnerResponse

Integration



Profit Center Variance Budget Monitoring Rule

Technical Data

Entity Type



Definition

Rule specifying the point at which the actual costs exceed a threshold value for the plan costs of a profit center, so that this then represents a critical variance.

Use

The business object Profit Center Variance Budget Monitoring Rule enables the person responsible for monitoring profit centers to determine threshold values for critical variances, and to then display any profit centers where a critical variance has occurred.





Profit Center Variance Budget Monitoring Rule Configuration [Seite 498 ]


Prerequisites

You are using the application component Profit Center Accounting (EC-PCA) . For additional information on profit center accounting, see the SAP Library under SAP ERP Central

Component Financials Enterprise Controlling (CO) Profit Center Accounting (EC-

PCA) .

Use







Manage Profit Center Variance Budget Monitoring

Rule

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for creating, changing, deleting or reading the Profit Center Variance


Use

The inbound service interface Manage Profit Center Variance Budget Monitoring Rule encompasses operations that make it possible to create, change or delete rules for critical variances from the plan for a profit center, and also to read existing rules with or without the current evaluation result for the rule.

Integration

The inbound service interface Manage Profit Center Variance Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Profit Center Variance


Structure

The Manage Profit Center Variance Budget Monitoring Rule inbound service interface contains the following inbound operations:

ProfitCentreVarianceBudgetMonitoringRuleCreateRequestConfirmation_In ( Create

Rule [Seite 461 ] )

ProfitCentreVarianceBudgetMonitoringRuleChangeRequestConfirmation_In ( Change

Rule [Seite 462 ] )

ProfitCentreVarianceBudgetMonitoringRuleCancelRequestConfirmation_In ( Cancel

Rule [Seite 462 ] )

ProfitCentreVarianceBudgetMonitoringRuleByIDQueryResponse_In ( Read Rule [Seite

463 ] )

ProfitCentreVarianceBudgetMonitoringRuleEvaluationResultByIDQueryResponse_In







Create Rule

Technical Data

Entity Type





Category

Mode


Service operation

ProfitCentreVarianceBudgetMonitoringRule



Inbound

Synchronous

ECC_ProfCtrVarBudMonRuleCrtRC

Definition

Creating a rule that displays when the variance of aggregated costs on a profit center becomes critical.

Use


Features


ProfitCentreVarianceBudgetMonitoringRuleCreateRequest

ProfitCentreVarianceBudgetMonitoringRuleCreateConfirmation

Error Handling


ProfitCentreVarianceBudgetMonitoringRuleCreateConfirmation displays whether or not the rule has been successfully created. If not, a corresponding notification should be in the Log .

Integration

This inbound operation belongs to the inbound service interface Manage Profit Center




Change Rule

Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_ProfCtrVarBudMonRuleChgRC

Definition

Changing a rule that displays when the variance of aggregated costs on a profit center becomes critical.

Use


Features


ProfitCentreVarianceBudgetMonitoringRuleChangeRequest

ProfitCentreVarianceBudgetMonitoringRuleChangeConfirmation

Error Handling


ProfitCentreVarianceBudgetMonitoringRuleChangeConfirmation displays whether or not the rule has been successfully changed. If not, a corresponding notification should be in the Log .

Integration



Cancel Rule

Technical Data

Entity Type




ES for SAP ERP 2005

Service operation



462

SAP Documentation


Category

Mode


Enterprise SOA


Inbound

Synchronous

ECC_ProfCtrVarBudMonRuleCncRC

Definition

Deletion of a rule that displays when the variance of aggregated costs on a profit center becomes critical.

Use


Features


ProfitCentreVarianceBudgetMonitoringRuleCancelRequest

ProfitCentreVarianceBudgetMonitoringRuleCancelConfirmation

Error Handling


ProfitCentreVarianceBudgetMonitoringRuleCancelConfirmation displays whether or not the rule has been successfully deleted. If not, a corresponding notification should be in the Log .

Integration



Read Rule

Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_ProfCtrVarBudMonRuleIDQR



Definition

Reading a rule that displays when the variance of aggregated costs on a profit center becomes critical.

Use


Features


ProfitCentreVarianceBudgetMonitoringRuleByIDQuery

ProfitCentreVarianceBudgetMonitoringRuleByIDResponse

Integration




Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_ProfCtrVarBudMonRuleRIDQR

Definition

Reading the evaluation results of a rule that displays when the variance of aggregated costs on a profit center becomes critical.

Use


CriticalityCode ( Critical , Partially critical or Not critical ) are read from the evaluation result for the rule and also for each individual profit center. In addition, the actual and plan costs are read for each period.

Features




ProfitCentreVarianceBudgetMonitoringRuleEvaluationResultByIDQuery

ProfitCentreVarianceBudgetMonitoringRuleEvaluationResultByIDResponse

Integration



Query Profit Center Variance Budget Monitoring

Rule

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations to find Profit Center Variance Budget Monitoring Rule s with relevant selection criteria.

Use

The inbound service interface Query Profit Center Variance Budget Monitoring Rule encompasses operations that read rules for each person responsible for critical variances from the plan for a profit center, with or without the current evaluation result for the rule.

Integration

The inbound service interface Query Profit Center Variance Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Profit Center Variance


Structure

The Query Profit Center Variance Budget Monitoring Rule inbound service interface contains the following inbound operations:

ProfitCentreVarianceBudgetMonitoringRuleSimpleByOwnerQueryResponse_In ( Find


ProfitCentreVarianceBudgetMonitoringRuleEvaluationResultByOwnerQueryResponse

_In ( Find Rule Evaluation Result by Owner [Seite 466 ] )







Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_ProfCtrVarBudMonRuleSiOwQR

Definition

Search based on the person responsible for the rules that display when the variance of the aggregated costs on a profit center becomes critical.

Use


Features


ProfitCentreVarianceBudgetMonitoringRuleSimpleByOwnerQuery

ProfitCentreVarianceBudgetMonitoringRuleSimpleByOwnerResponse

Integration

This inbound operation belongs to the inbound service interface Query Profit Center Variance



Technical Data

Entity Type





Service operation





SAP Documentation

Category

Mode


Enterprise SOA

Inbound

Synchronous

ECC_ProfCtrVarBudMonRuleROwQR

Definition

Search based on the person responsible for the evaluation results of the rules that display when the variance of the aggregated costs on a profit center becomes critical.

Use

The inbound operation Find Rule Evaluation Result by Owner reads all rules and the details of the evaluation results of a particular person responsible from the back-end system. The actual costs, the plan costs and the CriticalityCode ( Critical , Partially critical or Not critical ) are read from the evaluation results for each rule and also for each individual profit center. In addition, the actual and plan costs are read for each period.

Features


ProfitCentreVarianceBudgetMonitoringRuleEvaluationResultByOwnerQuery

ProfitCentreVarianceBudgetMonitoringRuleEvaluationResultByOwnerResponse

Integration



Profit Center Line Item Budget Monitoring Rule

Technical Data

Entity Type



Definition

Rule that specifies a threshold value over which a posting to a profit center is critical.

Use

The business object Profit Center Line Item Budget Monitoring Rule enables the person responsible for monitoring profit centers to determine threshold values for critical postings, and to then display any profit centers where a critical posting has occurred.







Profit Center Line Item Budget Monitoring Rule Configuration [Seite 500 ]


Prerequisites



PCA) .

Use





Manage Profit Center Line Item Budget Monitoring

Rule

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for creating, changing, deleting or reading the Profit Center Line Item


Use

The inbound service Manage Profit Center Line Item Budget Monitoring Rule encompasses operations that make it possible to create, change or delete rules for critical postings on a profit center, and also to read existing rules with or without the current evaluation result for the rule.

Integration

The inbound service interface Manage Profit Center Line Item Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Profit Center Line Item


Structure

The Manage Profit Center Variance Budget Monitoring Rule inbound service interface contains the following inbound operations:



ProfitCentreLineItemBudgetMonitoringRuleCreateRequestConfirmation_In ( Create

Rule [Seite 469 ] )

ProfitCentreLineItemBudgetMonitoringRuleChangeRequestConfirmation_In ( Change

Rule [Seite 470 ] )

ProfitCentreLineItemBudgetMonitoringRuleCancelRequestConfirmation_In ( Cancel

Rule [Seite 471 ] )

ProfitCentreLineItemBudgetMonitoringRuleByIDQueryResponse_In ( Read Rule [Seite

471 ] )

ProfitCentreLineItemBudgetMonitoringRuleEvaluationResultByIDQueryResponse_In





Create Rule

Technical Data

Entity Type





Category

Mode


Service operation

ProfitCentreLineItemBudgetMonitoringRule



Inbound

Synchronous

ECC_ProfCtrPosBudMonRuleCrtRC

Definition

Creating a rule that displays when the posting to a profit center becomes critical.

Use


Features


ProfitCentreLineItemBudgetMonitoringRuleCreateRequest

ProfitCentreLineItemBudgetMonitoringRuleCreateConfirmation



Error Handling


ProfitCentreLineItemBudgetMonitoringRuleCreateConfirmation displays whether or not the rule has been successfully created. If not, a corresponding notification should be in the Log .

Integration

This inbound operation belongs to the inbound service interface Manage Profit Center Line


Change Rule

Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_ProfCtrPosBudMonRuleChgRC

Definition

Changing a rule that displays when the posting to a profit center becomes critical.

Use


Features


ProfitCentreLineItemBudgetMonitoringRuleChangeRequest

ProfitCentreLineItemBudgetMonitoringRuleChangeConfirmation

Error Handling


ProfitCentreLineItemBudgetMonitoringRuleChangeConfirmation displays whether or not the rule has been successfully changed. If not, a corresponding notification should be in the Log .

Integration





Cancel Rule

Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_ProfCtrPosBudMonRuleCncRC

Definition

Deletion of a rule that displays when the posting to a profit center becomes critical.

Use


Features


ProfitCentreLineItemBudgetMonitoringRuleCancelRequest

ProfitCentreLineItemBudgetMonitoringRuleCancelConfirmation

Error Handling


ProfitCentreLineItemBudgetMonitoringRuleCancelConfirmation displays whether or not the rule has been successfully created. If not, a corresponding notification should be in the Log .

Integration



Read Rule

Technical Data

Entity Type



ES for SAP ERP 2005

Service operation


ByIDQueryResponse_In

471

SAP Documentation



Category

Mode


Enterprise SOA http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_ProfCtrPosBudMonRuleIDQR

Definition

Reading a rule that displays when the posting to a profit center becomes critical.

Use


Features


ProfitCentreLineItemBudgetMonitoringRuleByIDQuery

ProfitCentreLineItemBudgetMonitoringRuleByIDResponse

Integration




Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_ProfCtrPosBudMonRuleRIDQR

Definition

Reading evaluation result of a rule that displays when the posting to a profit center becomes critical.



Use




Document date


Amount

Posting date

Profit center to which the document line was posted


Creator

Company code

Cost element

G/L account

Features


ProfitCentreLineItemBudgetMonitoringRuleEvaluationResultByIDQuery

ProfitCentreLineItemBudgetMonitoringRuleEvaluationResultByIDResponse

Integration



Query Profit Center Line Item Budget Monitoring

Rule

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous



Definition

Group of operations to find Profit Center Line Item Budget Monitoring Rule s with relevant selection criteria.

Use

The inbound service interface Query Profit Center Line Item Budget Monitoring Rule encompasses operations that read rules for each person responsible for critical postings to a profit center, with or without the current evaluation result for the rule.

Integration

The inbound service interface Query Profit Center Line Item Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Profit Center Line Item


Structure

The Query Profit Center Line Item Budget Monitoring Rule inbound service interface contains the following inbound operations:

ProfitCentreLineItemBudgetMonitoringRuleSimpleByOwnerQueryResponse_In ( Find


ProfitCentreLineItemBudgetMonitoringRuleEvaluationResultByOwnerQueryResponse_

In ( Find Rule Evaluation Result by Owner [Seite 475 ] )





Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_ProfCtrPosBudMonRuleSiOwQR

Definition

Search based on the person responsible for the rules that display when a posting on a profit center becomes critical.



Use


Features


ProfitCentreLineItemBudgetMonitoringRuleSimpleByOwnerQuery

ProfitCentreLineItemBudgetMonitoringRuleSimpleByOwnerResponse

Integration

This inbound operation belongs to the inbound service interface Query Profit Center Line Item



Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_ProfCtrPosBudMonRuleROwQR

Definition

Search based on the person responsible for the evaluation results of the rules that display when a posting on a profit center becomes critical.

Use




Document date


Amount

Posting date



Profit center to which the document line was posted


Creator

Company code

Cost element

G/L account

Features


ProfitCentreLineItemBudgetMonitoringRuleEvaluationResultByOwnerQuery

ProfitCentreLineItemBudgetMonitoringRuleEvaluationResultByOwnerResponse

Integration



Internal Order Variance Budget Monitoring Rule

Technical Data

Entity Type



Definition

Rule specifying the point at which the actual costs exceed a threshold value for the plan costs of an internal order, so that this then represents a critical variance.

Use

The business object Internal Order Variance Budget Monitoring Rule enables the person responsible for monitoring internal orders to determine threshold values for critical variances, and to then display any internal orders where a critical variance has occurred.





Internal Order Variance Budget Monitoring Rule Configuration [Seite 503 ]




Prerequisites

You are using the application component Internal Orders (CO-OM-OPA).

For additional information on internal orders, see the SAP Library under SAP ERP Central Component

Financials Controlling (CO) Internal Orders (CO-OM-OPA) .

Use





Manage Internal Order Variance Budget

Monitoring Rule

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for creating, changing, deleting or reading the Internal Order Variance


Use

The inbound service interface Manage Internal Order Variance Budget Monitoring Rule encompasses operations that make it possible to create, change or delete rules for critical variances from the plan for an internal order, and also to read existing rules with or without the current evaluation result for the rule.

Integration

The inbound service interface Manage Internal Order Variance Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Internal Order


Structure

The Manage Internal Order Variance Budget Monitoring Rule inbound service interface contains the following inbound operations:

InternalOrderVarianceBudgetMonitoringRuleCreateRequestConfirmation_In ( Create

Rule [Seite 478 ] )



InternalOrderVarianceBudgetMonitoringRuleChangeRequestConfirmation_In ( Change

Rule [Seite 479 ] )

InternalOrderVarianceBudgetMonitoringRuleCancelRequestConfirmation_In ( Cancel

Rule [Seite 480 ] )

InternalOrderVarianceBudgetMonitoringRuleByIDQueryResponse_In ( Read Rule

[Seite 480 ] )

InternalOrderVarianceBudgetMonitoringRuleEvaluationResultByIDQueryResponse_In





Create Rule

Technical Data

Entity Type





Category

Mode


Service operation

InternalOrderVarianceBudgetMonitoringRule



Inbound

Synchronous

ECC_IntOrdrVarBudMonRuleCrtRC

Definition

Creating a rule that displays when the variance of aggregated costs on an internal order becomes critical.

Use


Features


InternalOrderVarianceBudgetMonitoringRuleCreateRequest

InternalOrderVarianceBudgetMonitoringRuleCreateConfirmation

Error Handling


InternalOrderVarianceBudgetMonitoringRuleCreateConfirmation displays whether or not the rule has been successfully created. If not, a corresponding notification should be in the Log .



Integration

This inbound operation belongs to the inbound service interface Manage Internal Order


Change Rule

Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_IntOrdrVarBudMonRuleChgRC

Definition

Changing a rule that displays when the variance of aggregated costs on an internal order becomes critical.

Use


Features


InternalOrderVarianceBudgetMonitoringRuleChangeRequest

InternalOrderVarianceBudgetMonitoringRuleChangeConfirmation

Error Handling


InternalOrderVarianceBudgetMonitoringRuleChangeConfirmation displays whether or not the rule has been successfully changed. If not, a corresponding notification should be in the Log .

Integration





Cancel Rule

Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_IntOrdrVarBudMonRuleCncRC

Definition

Deletion of a rule that displays when the variance of aggregated costs on an internal order becomes critical.

Use


Features


InternalOrderVarianceBudgetMonitoringRuleCancelRequest

InternalOrderVarianceBudgetMonitoringRuleCancelConfirmation

Error Handling


InternalOrderVarianceBudgetMonitoringRuleCancelConfirmation displays whether or not the rule has been successfully deleted. If not, a corresponding notification should be in the Log .

Integration



Read Rule

Technical Data

Entity Type




ES for SAP ERP 2005

Service operation



480

SAP Documentation


Category

Mode


Enterprise SOA


Inbound

Synchronous

ECC_IntOrdrVarBudMonRuleIDQR

Definition

Reading a rule that displays when the variance of aggregated costs on an internal order becomes critical.

Use


Features


InternalOrderVarianceBudgetMonitoringRuleByIDQuery

InternalOrderVarianceBudgetMonitoringRuleByIDResponse

Integration




Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_IntOrdrVarBudMonRuleRIDQR

Definition

Reading the evaluation results of a rule that displays when the variance of aggregated costs on an internal order becomes critical.



Use


CriticalityCode ( Critical , Partially critical or Not critical ) are read from the evaluation result for the rule and also for each individual internal order. In addition, the actual and plan costs are read for each period.

Features


InternalOrderVarianceBudgetMonitoringRuleEvaluationResultByIDQuery

InternalOrderVarianceBudgetMonitoringRuleEvaluationResultByIDResponse

Integration



Query Internal Order Variance Budget Monitoring

Rule

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations to find Internal Order Variance Budget Monitoring Rule s with relevant selection criteria.

Use

The inbound service interface Query Internal Order Variance Budget Monitoring Rule encompasses operations that read rules for each person responsible for critical variances from the plan for an internal order, with or without the current evaluation result for the rule.

Integration

The inbound service interface Query Internal Order Variance Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Internal Order Variance


Structure

The Query Internal Order Variance Budget Monitoring Rule inbound service interface contains the following inbound operations:



InternalOrderVarianceBudgetMonitoringRuleSimpleByOwnerQueryResponse_In ( Find


InternalOrderVarianceBudgetMonitoringRuleEvaluationResultByOwnerQueryRespons e_In ( Find Rule Evaluation Result by Owner [Seite 484 ] )





Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_IntOrdrVarBudMonRuleSiOwQR

Definition

Search based on the person responsible for the rules that display when the variance of the aggregated costs on an internal order becomes critical.

Use


Features


InternalOrderVarianceBudgetMonitoringRuleSimpleByOwnerQuery

InternalOrderVarianceBudgetMonitoringRuleSimpleByOwnerResponse

Integration

This inbound operation belongs to the inbound service interface Query Internal Order





Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_IntOrdrVarBudMonRuleROwQR

Definition

Search based on the person responsible for the evaluation results of the rules that display when the variance of the aggregated costs on an internal order becomes critical.

Use

The inbound operation Find Rule Evaluation Result by Owner reads all rules and the details of the evaluation results of a particular person responsible from the back-end system. The actual costs, the plan costs and the CriticalityCode ( Critical , Partially critical or Not critical ) are read from the evaluation results for each rule and also for each individual internal order. In addition, the actual and plan costs are read for each period.

Features


InternalOrderVarianceBudgetMonitoringRuleEvaluationResultByOwnerQuery

InternalOrderVarianceBudgetMonitoringRuleEvaluationResultByOwnerResponse

Integration



Internal Order Line Item Budget Monitoring Rule

Technical Data

Entity Type





Definition

Rule that specifies a threshold value over which a posting to an internal order is critical.

Use

The business object Internal Order Line Item Budget Monitoring Rule enables the person responsible for monitoring internal orders to determine threshold values for critical postings, and to then display any internal orders where a critical posting has occurred.





Internal Order Line Item Budget Monitoring Rule Configuration [Seite 505 ]


Prerequisites




Use





Manage Internal Order Line Item Budget

Monitoring Rule

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for creating, changing, deleting or reading the Internal Order Line Item




Use

The inbound service interface Manage Internal Order Line Item Budget Monitoring Rule encompasses operations that make it possible to create, change or delete rules for critical postings on an internal order, and also to read existing rules with or without the current evaluation result for the rule.

Integration

The inbound service interface Manage Internal Order Line Item Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Internal Order

Line Item Budget Monitoring Rule [Seite 484 ] .

Structure

The Manage Internal Order Variance Budget Monitoring Rule inbound service interface contains the following inbound operations:

InternalOrderLineItemBudgetMonitoringRuleCreateRequestConfirmation_In ( Create

Rule [Seite 486 ] )

InternalOrderLineItemBudgetMonitoringRuleChangeRequestConfirmation_In ( Change

Rule [Seite 487 ] )

InternalOrderLineItemBudgetMonitoringRuleCancelRequestConfirmation_In ( Cancel

Rule [Seite 488 ] )

InternalOrderLineItemBudgetMonitoringRuleByIDQueryResponse_In ( Read Rule

[Seite 489 ] )

InternalOrderLineItemBudgetMonitoringRuleEvaluationResultByIDQueryResponse_In





Create Rule

Technical Data

Entity Type





Category

Mode


Service operation

InternalOrderLineItemBudgetMonitoringRule



Inbound

Synchronous

ECC_IntOrdrPosBudMonRuleCrtRC



Definition

Creation of a rule that displays when the posting to an internal order becomes critical.

Use


Features


InternalOrderLineItemBudgetMonitoringRuleCreateRequest

InternalOrderLineItemBudgetMonitoringRuleCreateConfirmation

Error Handling


InternalOrderLineItemBudgetMonitoringRuleCreateConfirmation displays whether or not the rule has been successfully created. If not, a corresponding notification should be in the Log .

Integration

This inbound operation belongs to the inbound service interface Manage Internal Order Line


Change Rule

Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_IntOrdrPosBudMonRuleChgRC

Definition

Changing a rule that displays when the posting to an internal order becomes critical.

Use


Features


InternalOrderLineItemBudgetMonitoringRuleChangeRequest



InternalOrderLineItemBudgetMonitoringRuleChangeConfirmation

Error Handling


InternalOrderLineItemBudgetMonitoringRuleChangeConfirmation displays whether or not the rule has been successfully changed. If not, a corresponding notification should be in the Log .

Integration



Cancel Rule

Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_IntOrdrPosBudMonRuleCncRC

Definition

Deletion of a rule that displays when the posting to an internal order becomes critical.

Use


Features


InternalOrderLineItemBudgetMonitoringRuleCancelRequest

InternalOrderLineItemBudgetMonitoringRuleCancelConfirmation

Error Handling


InternalOrderLineItemBudgetMonitoringRuleCancelConfirmation displays whether or not the rule has been successfully deleted. If not, a corresponding notification should be in the Log .

Integration





Read Rule

Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_IntOrdrPosBudMonRuleIDQR

Definition

Reading a rule that displays when the posting to an internal order becomes critical.

Use


Features


InternalOrderLineItemBudgetMonitoringRuleByIDQuery

InternalOrderLineItemBudgetMonitoringRuleByIDResponse

Integration




Technical Data

Entity Type





Service operation





SAP Documentation

Category

Mode


Enterprise SOA

Inbound

Synchronous

ECC_IntOrdrPosBudMonRuleRIDQR

Definition

Reading evaluation result of a rule that displays when the posting to an internal order becomes critical.

Use




Document date


Amount

Posting date

Internal order to which the document line was posted


Creator

Company code

Cost element

G/L account

Features


InternalOrderLineItemBudgetMonitoringRuleEvaluationResultByIDQuery

InternalOrderLineItemBudgetMonitoringRuleEvaluationResultByIDResponse

Integration



Query Internal Order Line Item Budget Monitoring

Rule

Technical Data


SAP Documentation

Entity Type


Category

Mode

Enterprise SOA


Inbound

Synchronous

Definition

Group of operations to find Internal Order Line Item Budget Monitoring Rule s with relevant selection criteria.

Use

The inbound service interface Query Internal Order Line Item Budget Monitoring Rule encompasses operations that read rules for each person responsible for critical postings to an internal order, with or without the current evaluation result for the rule.

Integration

The inbound service interface Query Internal Order Line Item Budget Monitoring Rule relates to process component Accounting [Seite 441 ] and to business object Internal Order Line Item


Structure

The Query Internal Order Variance Budget Monitoring Rule inbound service interface contains the following inbound operations:

InternalOrderLineItemBudgetMonitoringRuleSimpleByOwnerQueryResponse_In ( Find


InternalOrderLineItemBudgetMonitoringRuleEvaluationResultByOwnerQueryResponse

_In ( Find Rule Evaluation Result by Owner [Seite 492 ] )





Technical Data

Entity Type





Category

Mode

ES for SAP ERP 2005

Service operation




Inbound

Synchronous

491

SAP Documentation


Enterprise SOA

ECC_IntOrdrPosBudMonRuleSiOwQR

Definition

Search based on the person responsible for the rules that display when a posting on an internal order becomes critical.

Use


Features


InternalOrderLineItemBudgetMonitoringRuleSimpleByOwnerQuery

InternalOrderLineItemBudgetMonitoringRuleSimpleByOwnerResponse

Integration

This inbound operation belongs to the inbound service interface Query Internal Order Line



Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_IntOrdrPosBudMonRuleROwQR

Definition

Search based on the person responsible for the evaluation results of the rules that display when a posting on an internal order becomes critical.

Use






Document date


Amount

Posting date

Internal order to which the document line was posted


Creator

Company code

Cost element

G/L account

Features


InternalOrderLineItemBudgetMonitoringRuleEvaluationResultByOwnerQuery

InternalOrderLineItemBudgetMonitoringRuleEvaluationResultByOwnerResponse

Integration



Cost Center Variance Budget Monitoring Rule

Configuration

Technical Data

Entity Type



Definition

Configuration data that is used to create or change a Cost Center Variance Budget Monitoring

Rule .

Use

The business object Cost Center Variance Budget Monitoring Rule Configuration contains, depending on the user and purpose of the rule, the possible input values when the rules are defined for the following parameters:

Cost center ( AllowedCostCentre )


SAP Documentation

Cost center group ( AllowedCostCentreGroup )

Cost element ( AllowedCostElement )

Cost element group ( AllowedCostElementGroup )

Currency ( AllowedCurrency )



Enterprise SOA


Prerequisites




CCA) .

In Customizing for Manager Self-Service (mySAP ERP) , you have made the necessary settings under Personalization .

Query Cost Center Variance Budget Monitoring

Rule Configuration

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Request with suitable selection criteria for Cost Center Variance Budget Monitoring Rule

Configuration s.

Use

The inbound service interface Query Cost Center Variance Budget Monitoring Rule

Configuration contains an operation that reads the possible input values for each person responsible.

Integration


Configuration relates to process component Accounting [Seite 441 ] and to business object

Cost Center Variance Budget Monitoring Rule Configuration [Seite 493 ] .



Structure


Configuration contains the inbound operation

CostCentreVarianceBudgetMonitoringRuleConfigurationByOwnerQueryResponse_In ( Find

Cost Center Variance Budget Monitoring Rule Configuration by Owner [Seite 495 ] )

Find Cost Center Variance Budget Monitoring Rule

Configuration by Owner

Technical Data

Entity Type





Category

Mode


Service operation


ConfigurationByOwnerQueryResponse_In http://sap.com/xi/EA-APPL/SE/Global


Inbound

Synchronous

ECC_CostCtrVarBudMonRuleCOwQR

Definition

Search based on the person responsible for the Cost Center Variance Budget Monitoring

Rule Configuration s.

Use

The inbound operation Find Cost Center Variance Budget Monitoring Rule Configuration by

Owner reads all possible input values for a particular person responsible from the back-end system. This provides the person responsible with the read values when creating or changing a Cost Center Variance Budget Monitoring Rule .

Features


CostCentreVarianceBudgetMonitoringRuleConfigurationbyOwnerQuery

CostCentreVarianceBudgetMonitoringRuleConfigurationbyOwnerResponse

Integration


Budget Monitoring Rule Configuration [Seite 494 ] .

Cost Center Line Item Budget Monitoring Rule


SAP Documentation

Configuration

Technical Data

Entity Type


Enterprise SOA


Definition

Configuration data that is used to create or change a Cost Center Line Item Budget

Monitoring Rule .

Use

The business object Cost Center Line Item Budget Monitoring Rule Configuration contains, depending on the user and purpose of the rule, the possible input values when the rules are defined for the following parameters:

Cost center ( AllowedCostCentre )

Cost center group ( AllowedCostCentreGroup )






Cost Center Variance Budget Monitoring Rule Configuration [Seite 493 ]


Prerequisites




CCA) .


Query Cost Center Line Item Budget Monitoring


Technical Data

Entity Type




SAP Documentation

Category

Mode

Inbound

Synchronous

Enterprise SOA

Definition

Request with suitable selection criteria for Cost Center Line Item Budget Monitoring Rule

Configuration s.

Use

The inbound service interface Query Cost Center Line Item Budget Monitoring Rule


Integration



Cost Center Line Item Budget Monitoring Rule Configuration [Seite 495 ] .

Structure



CostCentreLineItemBudgetMonitoringRuleConfigurationByOwnerQueryResponse_In ( Find

Cost Center Line Item Budget Monitoring Rule Configuration [Seite 497 ] ).

Find Cost Center Line Item Budget Monitoring

Rule Configuration by Owner

Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_CostCtrPosBudMonRuleCOwQR

Definition

Search based on the person responsible for the Cost Center Line Item Budget Monitoring




Use

The inbound operation Find Cost Center Line Item Budget Monitoring Rule Configuration by

Owner reads all possible input values for a particular person responsible from the back-end system. This provides the person responsible with the read values when creating or changing a Cost Center Line Item Budget Monitoring Rule [Seite 450 ] .

Features


CostCentreLineItemBudgetMonitoringRuleConfigurationbyOwnerQuery

CostCentreLineItemBudgetMonitoringRuleConfigurationbyOwnerResponse

Integration



Profit Center Variance Budget Monitoring Rule

Configuration

Technical Data

Entity Type



Definition

Configuration data that is used to create or change a Profit Center Variance Budget

Monitoring Rule [Seite 459 ] .

Use

The business object Profit Center Variance Budget Monitoring Rule Configuration contains, depending on the user and purpose of the rule, the possible input values when the rules are defined for the following parameters:

Profit center ( AllowedProfitCentre )

Profit center group ( AllowedProfitCentreGroup )

G/L account ( AllowedChartOfAccountsItem )

G/L account group ( AllowedChartOfAccountsItemGroup )




Profit Center Line Item Budget Monitoring Rule Configuration [Seite 500 ]




Prerequisites



PCA) .


Query Profit Center Variance Budget Monitoring


Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Request with suitable selection criteria for Profit Center Variance Budget Monitoring Rule

Configuration s.

Use

The inbound service interface Query Profit Center Variance Budget Monitoring Rule


Integration



Profit Center Variance Budget Monitoring Rule Configuration [Seite 498 ] .

Structure



ProfitCentreVarianceBudgetMonitoringRuleConfigurationByOwnerQueryResponse_In ( Find

Profit Center Variance Budget Monitoring Rule Configuration by Owner [Seite 499 ] ).

Find Profit Center Variance Budget Monitoring




Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_ProfCtrVarBudMonRuleCOwQR

Definition

Search based on the person responsible for the Profit Center Variance Budget Monitoring


Use

The inbound operation Find Profit Center Variance Budget Monitoring Rule Configuration by

Owner reads all possible input values for a particular person responsible from the back-end system. This provides the person responsible with the read values when creating or changing a Profit Center Variance Budget Monitoring Rule [Seite 459 ] .

Features


ProfitCentreVarianceBudgetMonitoringRuleConfigurationbyOwnerQuery

ProfitCentreVarianceBudgetMonitoringRuleConfigurationbyOwnerResponse

Integration



Profit Center Line Item Budget Monitoring Rule

Configuration

Technical Data

Entity Type





Definition

Configuration data that is used to create or change a Profit Center Line Item Budget


Use

The business object Profit Center Line Item Budget Monitoring Rule Configuration contains, depending on the user and purpose of the rule, the possible input values when the rules are defined for the following parameters:

Profit center ( AllowedProfitCentre )

Profit center group ( AllowedProfitCentreGroup )

G/L account ( AllowedChartOfAccountsItem )

G/L account group ( AllowedChartOfAccountsItemGroup )




Profit Center Variance Budget Monitoring Rule Configuration [Seite 498 ]


Prerequisites



PCA) .


Query Profit Center Line Item Budget Monitoring


Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Request with suitable selection criteria for Profit Center Line Item Budget Monitoring Rule

Configuration s.



Use

The inbound service interface Query Profit Center Line Item Budget Monitoring Rule


Integration



Profit Center Line Item Budget Monitoring Rule Configuration [Seite 500 ] .

Structure



ProfitCentreLineItemBudgetMonitoringRuleConfigurationByOwnerQueryResponse_In ( Find

Profit Center Line Item Budget Monitoring Rule Configuration [Seite 502 ] ).

Find Profit Center Line Item Budget Monitoring


Technical Data

Entity Type





Category

Mode


Service operation




Inbound

Synchronous

ECC_ProfCtrPosBudMonRuleCOwQR

Definition

Search based on the person responsible for the Profit Center Line Item Budget Monitoring


Use

The inbound operation Find Profit Center Line Item Budget Monitoring Rule Configuration by

Owner reads all possible input values for a particular person responsible from the back-end system. This provides the person responsible with the read values when creating or changing a Profit Center Line Item Budget Monitoring Rule [Seite 467 ] .

Features


ProfitCentreLineItemBudgetMonitoringRuleConfigurationbyOwnerQuery

ProfitCentreLineItemBudgetMonitoringRuleConfigurationbyOwnerResponse



Integration



Internal Order Variance Budget Monitoring Rule

Configuration

Technical Data

Entity Type



Definition

Configuration data that is used to create or change an Internal Order Variance Budget


Use

The business object Internal Order Variance Budget Monitoring Rule Configuration contains, depending on the user and purpose of the rule, the possible input values when the rules are defined for the following parameters:

Order ( AllowedInternalOrder )

Order group ( AllowedInternalOrderGroup )






Internal Order Line Item Budget Monitoring Rule Configuration [Seite 505 ]


Prerequisites







Query Internal Order Variance Budget Monitoring


Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Request with suitable selection criteria for Internal Order Variance Budget Monitoring Rule

Configuration s.

Use

The inbound service interface Query Internal Order Variance Budget Monitoring Rule


Integration



Internal Order Variance Budget Monitoring Rule Configuration [Seite 503 ] .

Structure



InternalOrderVarianceBudgetMonitoringRuleConfigurationByOwnerQueryResponse_In ( Find

Internal Order Line Item Budget Monitoring Rule Configuration by Owner [Seite 504 ] )

Find Internal Order Variance Budget Monitoring


Technical Data

Entity Type





Category

Mode

Service operation




Inbound

Synchronous


SAP Documentation


Enterprise SOA

ECC_IntOrdrVarBudMonRuleCOwQR

Definition

Search based on the person responsible for the Internal Order Variance Budget Monitoring


Use

The inbound operation Find Internal Order Variance Budget Monitoring Rule Configuration by

Owner reads all possible input values for a particular person responsible from the back-end system. This provides the person responsible with the read values when creating or changing an Internal Order Variance Budget Monitoring Rule [Seite 476 ] .

Features


InternalOrderVarianceBudgetMonitoringRuleConfigurationbyOwnerQuery

InternalOrderVarianceBudgetMonitoringRuleConfigurationbyOwnerResponse

Integration


Variance Budget Monitoring Rule Configuration [Seite 504 ] .

Internal Order Line Item Budget Monitoring Rule

Configuration

Technical Data

Entity Type



Definition

Configuration data that is used to create or change an Internal Order Line Item Budget


Use

The business object Internal Order Line Item Budget Monitoring Rule Configuration contains, depending on the user and purpose of the rule, the possible input values when the rules are defined for the following parameters:

Order ( AllowedInternalOrder )

Order group ( AllowedInternalOrderGroup )








Internal Order Variance Budget Monitoring Rule Configuration [Seite 503 ]


Prerequisites





Query Internal Order Line Item Budget Monitoring


Technical Data

Entity Type


Service interface

Category

Mode mySAP ERP enterprise services package (as of ESA ECC SE 501)

Inbound

Synchronous

Definition

Request with suitable selection criteria for Internal Order Line Item Budget Monitoring Rule

Configuration s.

Use

The inbound service interface Query Internal Order Line Item Budget Monitoring Rule


Integration



Internal Order Line Item Budget Monitoring Rule Configuration [Seite 505 ] .

Structure



InternalOrderLineItemBudgetMonitoringRuleConfigurationByOwnerQueryResponse_In ( Find

Internal Order Line Item Budget Monitoring Rule Configuration by Owner [Seite 507 ] )



Find Internal Order Line Item Budget Monitoring


Technical Data

Entity Type



Service operation


ConfigurationByOwnerQueryResponse_In



Category

Mode



Inbound

Synchronous

ECC_IntOrdrPosBudMonRuleCOwQR

Definition

Search based on the person responsible for the Internal Order Line Item Budget Monitoring


Use

The inbound operation Find Internal Order Line Item Budget Monitoring Rule Configuration by

Owner reads all possible input values for a particular person responsible from the back-end system. This provides the person responsible with the read values when creating or changing a Internal Order Line Item Budget Monitoring Rule [Seite 484 ] .

Features


InternalOrderLineItemBudgetMonitoringRuleConfigurationbyOwnerQuery

InternalOrderLineItemBudgetMonitoringRuleConfigurationbyOwnerResponse

Integration


Item Budget Monitoring Rule Configuration [Seite 506 ] .

Funds Management Account

Technical Data

Entity Type



(as of ECC-SE 600)



Definition

Account in Funds Management that represents the functional grouping of expenditures and revenues within a financial management area.

Use

The Funds Management Account business object provides the interfaces that are required to create, change, read, and search for accounts in Funds Management.


Funds Management Functional Area [Seite 523 ]

Funds Management Fund [Seite 518 ]

Funds Management Program [Seite 512 ]

Query Funds Management Account

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Query for selecting accounts.

Use

The Query Funds Management Account inbound service interface comprises operations that return the attributes of accounts.


Manage Funds Management Account [Seite 509 ]

Prerequisites

You must define the necessary settings in the Implementation Guide (IMG) of Public Sector

Management for Master Data.

Integration

The Query Funds Management Account inbound service interface belongs to the Accounting

[Seite 441 ] process component and the Funds Management Account [Seite 507 ] business object.

Structure

The Query Funds Management Account inbound service interface contains the following inbound operation:

FundsManagementAccountSimpleByElementsQueryResponse_In ( Find Funds

Management Account by Elements [Seite 509 ] ).



Find Funds Management Account by Elements

Technical Data

Entity Type





Category

Mode


Service operation

FundsManagementAccountSimpleByElements-

QueryResponse_In http://sap.com/xi/EA-PS/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_FMAccountSimpleByElemsQR

Definition

Lists Funds Management accounts that match the selection criteria defined in the query.

Use

The Find Funds Management Account by Elements inbound operation combines operations that return a list of accounts.

Constraints

Selection using single fields takes priority over selection using intervals. For example, if the query includes a ValidityEndDate and a SelectionByValidityEndDate, the system will use the

ValidityEndDate.

Features


FundsManagementAccountSimpleByElementsQuery_sync

FundsManagementAccountSimpleByElementsResponse_sync

StandardFaultMessage

Prerequisites

You must have created accounts in the system.

Integration

This inbound operation belongs to the Query Funds Management Account [Seite 508 ] inbound service interface.

Notes for SAP Backend System Administration

Business Add-In (BAdI) FM_SE_ACCOUNTBYELEMENTSQR (Inbound/Outbound processing BAdI for FM AccountByElementsQueryResponse) is available for this operation.

Manage Funds Management Account

Technical Data





Category

Mode mySAP ERP enterprise services package

(as of ECC-SE 600)

Inbound

Synchronous

Definition

Manages Funds Management accounts.

Use

The Manage Funds Management Account inbound service interface comprises operations that enable an account to be created or changed.


Query Funds Management Account [Seite 508 ]

Prerequisites



Integration

The Manage Funds Management Account inbound service interface belongs to the

Accounting [Seite 441 ] process component and the Funds Management Account [Seite 507 ] business object.

Structure

The Manage Funds Management Account inbound service interface groups the following inbound operations:

FundsManagementAccountCreateRequestConfirmation_In ( Create Funds

Management Account [Seite 510 ] )

FundsManagementAccountChangeRequestConfirmation_In ( Change Funds

Management Account [Seite 511 ] )

FundsManagementAccountByIDQueryResponse_In ( Read Funds Management

Account [Seite 512 ] )

Create Funds Management Account

Technical Data

Entity Type





Category

Mode

Service operation

FundsManagementAccountCreateRequest-

Confirmation_In http://sap.com/xi/EA-PS/SE/Global

As of ECC-SE 600

Inbound

Synchronous



Related Web Service Definition ECC_FMAccountCrtRC

Definition

Creates Funds Management accounts.

Use

The Create Funds Management Account inbound operation creates an account.

Features


FundsManagementAccountCreateRequest_sync

FundsManagementAccountCreateConfirmation_sync


Integration

This inbound operation belongs to the Manage Funds Management Account [Seite 509 ] inbound service interface.


Business Add-In (BAdI) FM_SE_ACCOUNTCRTRC (Inbound/Outbound processing BAdI for

FMAccountCreateRequestConfirmation) is available for this operation.

Change Funds Management Account

Technical Data

Entity Type





Category

Mode


Service operation

FundsManagementAccountChangeRequest-

Confirmation_In http://sap.com/xi/EA-PS/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_FMAccountChgRC

Definition

Changes Funds Management accounts.

Use

The Change Funds Management Account inbound operation changes an account.

Features


FundsManagementAccountChangeRequest_sync

FundsManagementAccountChangeConfirmation_sync




Integration



Business Add-In (BAdI) FM_SE_ACCOUNTCHGRC (Inbound/Outbound processing BAdI for

FMAccountChangeRequestConfirmation_In) is available for this operation.

Read Funds Management Account

Technical Data

Entity Type





Category

Mode


Service operation

FundsManagementAccountByIDQuery-

Response_In http://sap.com/xi/EA-PS/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_FMAccountByIDQR

Definition

Reads Funds Management accounts.

Use

The Read Funds Management Account inbound operation returns all attributes of an account.

Features


FundsManagementAccountByIDQuery_sync

FundsManagementAccountByIDResponse_sync


Integration



Business Add-In (BAdI) FM_SE_ACCOUNTBYIDQR (Inbound/Outbound processing BAdI for

FM AccountByIDQueryResponse) is available for this operation.

Funds Management Program

Technical Data



Entity Type


Business object mySAP ERP enterprise services package (as of ESA ECC-SE 600)

Definition

A funded program in Funds Management describes the operative subdivision of targets of institutions into activities that budget and monitor revenues and expenditures in order to prevent the budget being exceeded.

Use

The business object Funds Management Program is used to create, change, read, and search for funded programs.



Query Funds Management Program

Technical Data

Entity Type


Category

Mode

Service interface mySAP ERP enterprise services package (as of ESA ECC-SE 600)

Inbound

Synchronous

Definition

Query for selecting funded programs.

Use

The Query Funds Management Program inbound service interface comprises operations that return the attributes of funded programs.


Manage Funds Management Program [Seite 515 ]

Prerequisites

You must define the necessary settings for master data in the Implementation Guide (IMG) of

Public Sector Management .

Integration

The Query Funds Management Program inbound service interface belongs to the Accounting

[Seite 441 ] process component and the Funds Management Program [Seite 512 ] business object.

Structure

The Query Funds Management Program inbound service interface contains the following inbound operation: FundsManagementProgramSimpleByElementsQueryResponse_In

( Find Funds Management Program by Elements [Seite 514 ] ).



Find Funds Management Program by Elements

Technical Data

Entity Type





Category

Mode

Corresponding Web Service

Definition

Service operation

FundsManagementProgramSimpleByElementsQueryResponse_In http://sap.com/xi/EA-PS/SE/Global


Inbound

Synchronous

ECC_FMProgramSimpleByElemsQR

Definition

Lists funded programs that match the selection criteria defined in the query.

Use

The inbound operation Find Funds Management Program by Elements comprises operations that return a list of funded programs.

Features


FundsManagementProgramSimpleByElementsQuery

FundsManagementProgramSimpleByElementsResponse


Prerequisites

You must have created master data for Funds Management.

Integration

This inbound operation belongs to the Query Funds Management Program [Seite 513 ] inbound service interface.

Constraints

Selection by interval is not possible in SP00.


Business Add-In (BAdI) FM_SE_PROGRAMBYELEMENTSQR ( Inbound/Outbound processing BAdI for FM ProgramByElementsQueryResponse ) is available for this operation.



Manage Funds Management Program

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Manages funded programs.

Use

The Manage Funds Management Program inbound service interface comprises operations that enable a funded program to be created or changed.


Query Funds Management Program [Seite 513 ]

Integration

The Manage Funds Management Program inbound service interface belongs to the

Accounting [Seite 441 ] process component and the Funds Management Program [Seite 512 ] business object.

Structure

The Manage Funds Management Program inbound service interface comprises the following inbound operations:

FundsManagementProgramCreateRequestConfirmation_In ( Create Funds

Management Program [Seite 515 ] )

FundsManagementProgramChangeRequestConfirmation_In ( Change Funds

Management Program [Seite 516 ] )

FundsManagementProgramByIDQueryResponse_In ( Read Funds Management

Program [Seite 517 ] )

Create Funds Management Program

Technical Data




FundsManagementProgramCreateRequestConfirmation_In

Namespace in ESR http://sap.com/xi/EA-PS/SE/Global


Category Inbound




Definition

ECC_FMProgramCrtRC

Definition

Creates funded programs.

Use

The Create Funds Management Program inbound operation is used to create funded programs.

Features


FundsManagementProgramCreateRequest

FundsManagementProgramCreateConfirmation


Integration

This inbound operation belongs to the Manage Funds Management Program [Seite 515 ] inbound service interface.


Business Add-In (BAdI) FM_SE_PROGRAMCRTRC ( Inbound/Outbound processing BAdI for

FM ProgramCreateRequestConfirmation ) is available for this operation.

Change Funds Management Program

Technical Data

Entity Type


Definition

Service operation



FundsManagementProgramChangeRequestConfirmation_In



Category

Mode

Inbound

Synchronous

ECC_FMProgramChgRC

Definition

Changes funded programs.

Use

The Change Funds Management Program inbound operation is used to change funded programs.



Features


FundsManagementProgramChangeRequest

FundsManagementProgramChangeConfirmation


Integration



Business Add-In (BAdI) FM_SE_PROGRAMCHGRC ( Inbound/Outbound processing BAdI for

FM ProgramChangeRequestConfirmation ) is available for this operation.

Read Funds Management Program

Technical Data

Entity Type





Category

Mode

Corresponding Web Service Definition

Service operation

FundsManagementProgramByIDQueryResponse_In http://sap.com/xi/EA-PS/SE/Global


Inbound

Synchronous

ECC_FMProgramByIDQR

Definition

Reads funded programs.

Use

The Read Funds Management Program inbound operation returns all attributes of a funded program.

Features


FundsManagementProgramByIDQuery

FundsManagementProgramByIDResponse




Integration



Business Add-In (BAdI) FM_SE_PROGRAMBYIDQR ( Inbound/Outbound processing BAdI for

FM ProgramByIDQueryResponse ) is available for this operation.

Funds Management Fund

Technical Data

Entity Type



Definition

A fund in Funds Management is a source of funds that budgets and controls expenditures and revenues in order to prevent the budget being exceeded.

A Fund Management Fund represents an organization’s internal view on fund sources and can be categorized according to the source, for example, as fiduciary funds. It does not represent any organizational unit.

Use

The business object Funds Management Fund represents receivables or parts of receivables for internal reporting purposes.



Query Funds Management Fund

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Query for selecting funds.



Use

The Query Funds Management Fund inbound service interface comprises an operation that returns the attributes of funds.


Manage Funds Management Fund [Seite 520 ]

Prerequisites

You must define the necessary settings for master data in the Implementation Guide (IMG) of

Public Sector Management .

Integration

The Query Funds Management Fund inbound service interface belongs to the Accounting

[Seite 441 ] process component and the Funds Management Fund [Seite 518 ] business object.

Structure

The Query Funds Management Fund inbound service interface contains the following inbound operation: FundsManagementFundSimpleByElementsQueryResponse_In ( Find Funds

Management Fund by Elements [Seite 519 ] ).

Find Funds Management Fund by Elements

Technical Data

Entity Type





ESR

Category

Mode


Definition

Service operation

FundsManagementFundSimpleByElementsQueryResponse_In http://sap.com/xi/EA-PS/SE/Global


Inbound

Synchronous

ECC_FMFundSimpleByElemsQR

Definition

Lists funds that match the selection criteria defined in the query.

Use

The inbound operation Find Funds Management Fund by Elements comprises operations that return a list of funds.

Features


FundsManagementFundSimpleByElementsQuery



FundsManagementFundSimpleByElementsResponse


Prerequisites

You must have created master data for Funds Management.

Integration

This inbound operation belongs to the Query Funds Management Fund [Seite 518 ] inbound service interface.

Constraints

Selection by interval is not possible in SP00.


Business Add-In (BAdI) FM_SE_FUNDBYELEMENTSQR ( Inbound/Outbound processing

BAdI for FM FundByElementsQueryResponse ) is available for this operation.

Manage Funds Management Fund

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Manages funds.

Use

The Manage Funds Management Fund inbound service interface comprises operations that enable a fund to be created or changed.


Query Funds Management Fund [Seite 518 ]

Integration

The Manage Funds Management Fund inbound service interface belongs to the Accounting

[Seite 441 ] process component and the Funds Management Fund [Seite 518 ] business object.

Structure

The Manage Funds Management Fund inbound service interface comprises the following inbound operations:



FundsManagementFundCreateRequestConfirmation_In ( Create Funds

Management Fund [Seite 521 ] )

FundsManagementFundChangeRequestConfirmation_In ( Change Funds

Management Fund [Seite 522 ] )

FundsManagementFundByIDQueryResponse_In ( Read Funds Management Fund

[Seite 522 ] )

Create Funds Management Fund

Technical Data

Entity Type





Category

Mode


Service operation

FundsManagementFundCreateRequestConfirmation_In http://sap.com/xi/EA-PS/SE/Global


Inbound

Synchronous

ECC_FMFundCrtRC

Definition

Creates funds.

Use

The Create Funds Management Fund inbound operation is used to create funds.

Features


FundsManagementFundCreateRequest

FundsManagementFundCreateConfirmation


Integration

This inbound operation belongs to the Manage Funds Management Fund [Seite 520 ] inbound service interface.


Business Add-In (BAdI) FM_SE_FUNDCRTRC ( Inbound/Outbound processing BAdI for FM

FundCreateRequestConfirmation ) is available for this operation.



Change Funds Management Fund

Technical Data




FundsManagementFundChangeRequestConfirmation_In



Category

Mode http://sap.com/xi/EA-PS/SE/Global


Inbound

Synchronous

Corresponding Web Service Definition ECC_FMFundChgRC

Definition

Changes funds.

Use

The Change Funds Management Fund inbound operation is used to change funds.

Features


FundsManagementFundChangeRequest

FundsManagementFundChangeConfirmation


Integration



Business Add-In (BAdI) FM_SE_FUNDCHGRC ( Inbound/Outbound processing BAdI for FM

FundChangeRequestConfirmation ) is available for this operation.

Read Funds Management Fund

Technical Data

Entity Type





Service operation

FundsManagementFundByIDQueryResponse_In http://sap.com/xi/EA-PS/SE/Global




Category

Mode


Inbound

Synchronous

ECC_FMFundByIDQR

Definition

Reads funds.

Use

The Read Funds Management Fund inbound operation returns all attributes of a fund.

Features


FundsManagementFundByIDQuery

FundsManagementFundByIDResponse


Integration



Business Add-In (BAdI) FM_SE_FUNDBYIDQR ( Inbound/Outbound processing BAdI for FM

FundByIDQueryResponse ) is available for this operation.

Funds Management Functional Area

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

Functional area in Funds Management that is budgeted and controlled for all expenditures and revenues in order to stay in budget. A functional area corresponds to a task involved in achieving an organization’s goal, such as administration, public safety, education or research.

Use

The Funds Management Functional Area business object is used to create, change, read, and search for functional areas.


Funds Management Account [Seite 507 ]





Query Funds Management Functional Area

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Query for selecting functional areas.

Use

The Query Funds Management Functional Area inbound service interface comprises operations that return the attributes of functional areas.


Manage Funds Management Functional Area [Seite 525 ]

Prerequisites



Integration

The Query Funds Management Functional Area inbound service interface belongs to the

Accounting [Seite 441 ] process component and the Funds Management Functional Area


Structure

The Query Funds Management Functional Area inbound service interface contains the following inbound operation:

FundsManagementFunctionalAreaSimpleByElementsQueryResponse_In ( Find

Funds Management Functional Area by Elements [Seite 524 ] ).

Find Funds Management Functional Area by

Elements

Technical Data

Entity Type





ESR

Service operation

FundsManagementFunctionalAreaSimpleByElements-


As of ECC-SE 600



Category

Mode


Inbound

Synchronous

ECC_FMFunctionalAreaSimplEleQR

Definition

Lists Funds Management functional areas that match the selection criteria defined in the query.

Use

The Find Funds Management Functional Area by Elements inbound operation combines operations that return a list of functional areas.

Features


FundsManagementFunctionalAreaSimpleByElementsQuery_sync

FundsManagementFunctionalAreaSimpleByElementsResponse_sync


Prerequisites

You must have created functional areas in the system.

Integration

This inbound operation belongs to the Query Funds Management Functional Area [Seite 524 ] inbound service interface.


Business Add-In (BAdI) FM_SE_FUNCAREABYELEMENTSQR (Inbound/Outbound processing BAdI for FundsManagement FunctionalAreaByElementsQueryResponse) is available for this operation.

Manage Funds Management Functional Area

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Inbound

Synchronous

Definition

Manages Funds Management functional areas.

Use

The Manage Funds Management Functional Area inbound service interface comprises operations that enable a functional area to be created or changed.




Query Funds Management Functional Area [Seite 524 ]

Integration

The Manage Funds Management Functional Area inbound service interface belongs to the

Accounting [Seite 441 ] process component and the Funds Management Functional Area


Structure

The Manage Funds Management Functional Area inbound service interface groups the following inbound operations:

FundsManagementFunctionalAreaCreateRequestConfirmation_In ( Create

Funds Management Functional Area [Seite 526 ] )

FundsManagementFunctionalAreaChangeRequestConfirmation_In ( Change

Funds Management Functional Area [Seite 527 ] )

FundsManagementFunctionalAreaByIDQueryResponse_In ( Read Funds

Management Functional Area [Seite 527 ] )

Create Funds Management Functional Area

Technical Data

Entity Type





Category


Service operation

FundsManagementFunctionalAreaCreate-

RequestConfirmation_In http://sap.com/xi/EA-PS/SE/Global

As of ECC-SE 600

Inbound

ECC_FMFunctionalAreaCrtRC

Definition

Creates Funds Management functional areas.

Use

The Create Funds Management Functional Area inbound operation creates a functional area.

Features


FundsManagementFunctionalAreaCreateRequest_sync

FundsManagementFunctionalAreaCreateConfirmation_sync




Integration

This inbound operation belongs to the Manage Funds Management Functional Area [Seite



Business Add-In (BAdI) FM_SE_FUNCAREACRTRC ( Inbound/Outbound processing BAdI for

FundsManagementFunctionalAreaCreateRequestConfirmation ) is available for this operation.

Change Funds Management Functional Area

Technical Data




FundsManagementFunctionalAreaChange-

RequestConfirmation_In



Category

Mode


Inbound

Synchronous

ECC_FMFunctionalAreaChgRC

Definition

Changes Funds Management functional areas.

Use

The Change Funds Management Functional Area inbound operation changes a functional area.

Features


FundsManagementFunctionalAreaChangeRequest_sync

FundsManagementFunctionalAreaChangeConfirmation_sync


Integration




Business Add-In (BAdI) FM_SE_FUNCAREACHGRC ( Inbound/Outbound processing BAdI for FundsManagementFunctionalAreaChangeRequestConfirmation ) is available for this operation.

Read Funds Management Functional Area

Technical Data



Entity Type





Category

Mode


Service operation

FundsManagementFunctionalAreaByID-


As of ECC-SE 600

Inbound

Synchronous

ECC_FMFunctionalAreaByIDQR

Definition

Reads Funds Management functional areas.

Use

The Read Funds Management Functional Area inbound operation returns all attributes of a funded functional area.

Features


FundsManagementFunctionalAreaByIDQuery_sync

FundsManagementFunctionalAreaByIDResponse_sync


Integration




Business Add-In (BAdI) FM_SE_FUNCAREABYIDQR ( Inbound/Outbound processing BAdI for FundsManagementFunctionalAreaByIDQueryResponse ) is available for this operation.

Financial Accounting View Of Project

Technical Data

Entity Type


Business object mySAP ERP enterprise services package (as of ECC SE 600)

Definition

Representation of a project and its structure in the area Accounting [Seite 441 ] .

Use

The business object Financial Accounting View Of Project enables you to represent a cProjects project in the process component Accounting, meaning displaying the project elements and their account assignment objects. You can enter budget information for the account assignment objects. The business object is not industry-specific.


SAP Documentation


Project [Seite 340 ]

Organisational Centre [Seite 133 ]


Prerequisites

You are using SAP cProjects ( mySAP ERP Release 2005 or higher).

Enterprise SOA

Query Financial Accounting View Of Project In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Request for Financial Accounting View Of Projects with particular selection criteria.

Use

The inbound service Query Financial Accounting View Of Project In contains an operation that requests one or more instances of the view Financial Accounting View Of Project depending on the selection criteria.


Manage Financial Accounting View Of Project In [Seite 530 ]

Integration

The inbound service interface Query Financial Accounting View Of Project In relates to the process component Accounting [Seite 441 ] and to the business object Financial Accounting

View Of Project [Seite 528 ] .

Structure

The inbound service interface Query Financial Accounting View Of Project In contains the inbound operation FinancialAccountingViewOfProjectSimpleByProjectIDQueryResponse_In

( Find Financial Accounting View Of Project by Project ID [Seite 529 ] ).

Find Financial Accounting View Of Project by

Project ID

Technical Data






FinancialAccountingViewOfProjectSimpleByProjectID

QueryResponse_In

Namespace in ESR http://sap.com/xi/APPL/SE/Global

Software Component Version in ESR As of ESA ECC SE 600

Category

Mode


Inbound

Synchronous

ECC_FAVOPSPIQR

Definition

Search for an account assignment object in the highest level on which a cProjects project has been assigned in SAP ECC .

Input: ID of the cProjects project definition

Output: IDs of the relevant instances for Financial Accounting View Of Project

Use

The inbound operation Find Financial Accounting View Of Project by Project ID requests using the project ID all instances of the view Financial Accounting View Of Project that have been created for a cProjects project.

Features


FinancialAccountingViewOfProjectSimpleByProjectIDQuery_sync

FinancialAccountingViewOfProjectSimpleByProjectIDResponse_sync


Integration

This inbound operation belongs to the Query Financial Accounting View of Project In [Seite


Manage Financial Accounting View Of Project In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Makes detailed information for a project available.



Use

The inbound service interface Manage Financial Accounting View Of Project In encompasses operations that read the information for the structure of a cProjects project and, for example, an account assignment object.


Query Financial Accounting View Of Project In [Seite 529 ]

Integration

The inbound service interface Manage Financial Accounting View Of Project In relates to the process component Accounting [Seite 441 ] and to the business object Financial Accounting

View Of Project [Seite 528 ] .

Structure

The inbound service interface Manage Financial Accounting View Of Project In contains the following inbound operations:

FinancialAccountingViewOfProjectByIDQueryResponse_In ( Read Financial

Accounting View Of Project Structure [Seite 531 ] )

FinancialAccountingViewOfProjectStructureByIDQueryResponse_In ( Read Financial

Accounting View Of Project [Seite 532 ] )


The values for the elements MappingCode and ControllingTypeCode that are located at the initial nodes of message data types

FinancialAccountingViewOfProjectByIDResponseMessage_sync and

FinancialAccountingViewOfProjectStructureByIDResponseMessage_sync are dependent on the controlling method. The controlling method is found from the project type that is entered in

Customizing under Integration with Other mySAP.com Components Collaboration

Projects Controlling Define Controlling Scenario .

Read Financial Accounting View of Project

Structure

Technical Data

Entity Type





Category

Mode


Definition

Service operation

FinancialAccountingViewOfProjectStructureByIDQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_FAVOPSTRUQR



Definition

Reading of structure information with details of the account assignment objects in SAP ECC to which the costs of the elements of cProjects projects have been assigned.

Input: ID of the PS project definition, internal orders

Output: a) PS project definition b) Internal orders or WBS element c) Other relevant account assignments

Use

The inbound operation Read Financial Accounting View Of Project Structure enables you to represent structure information for a cProjects project, meaning the account assignment of elements of a cProjects project to account assignment objects.

Features


FinancialAccountingViewOfProjectStructureByIDQuery_sync

FinancialAccountingViewOfProjectStructureByIDResponse_sync


Integration

This inbound operation belongs to the Manage Financial Accounting View of Project In [Seite


Read Financial Accounting View Of Project

Technical Data

Entity Type





ESR

Category

Mode


Service operation

FinancialAccountingViewOfProjectByIDQueryResponse_In http://sap.com/xi/APPL/SE/Global


Inbound

Synchronous

ECC_FAVOPIDQR

Definition

Reading of structure information for cProjects projects and budget information for account assignment objects.

Input: ID of the PS project definition, internal orders



Output: a) PS project definition b) Internal orders or WBS elements c) Other relevant account assignments d) Budget for each account assignment object

Use

The inbound operation Read Financial Accounting View Of Project enables you to represent structure information for a cProjects project, meaning the account assignment of elements of a cProjects project to account assignment objects. In addition, it supplies budget information for the account assignment objects.

Features


FinancialAccountingViewOfProjectByIDQuery_sync

FinancialAccountingViewOfProjectByIDQueryResponse_sync


Integration

This inbound operation belongs to the Manage Financial Accounting View of Project In [Seite


Budget Processing

Technical data

Entity type

Software component

Process Component mySAP ERP enterprise services package (as of ESA ECC-SE 600)

Definition

Manages and changes an approved budget in Funds Management.

Use

The process component Budget Processing is used to manage a budget already approved.

This includes changes and adjustments of the budget such as supplements, returns, transfers, revenues increasing the budget, or shifting budget distribution between months of a year.

Each adjustment is recorded in a budget document. These documents can be included in a workflow to maintain the dual control principle. Once the documents have been approved, they can no longer be changed, they can only be reversed.

The budget and budget changes can be structured and monitored using the following options:

Budget type

Enables the budget to be structured down to the individual and totals level in accordance with customer-defined criteria.



Budget document types

Enables the budget documents to be subdivided and numbered in accordance with customer-defined criteria.

Consistency check

Each budget document is checked to see whether it fulfils the pre-defined rules that ensure the customer-defined consistency of the budget. This can result in the changes being rejected.

Budget Document

Technical data

Entity type

Software component


Definition

A budget document returns budget changes that occur from a budgeting process and documents them. Typical budgeting processes are: entering original budget, supplementing budget, returning budget, revenues increasing the budget, and budget transfers.

Use

The business object Budget Document can be used to create budget documents.

Manage Budget Document In

Technical Data

Entity Type

Software Component

Category

Mode


Inbound

Synchronous

Definition

Manages budget documents.

Use

The inbound service interface Manage Budget Document comprises an operation that creates budget documents.

Prerequisites

You must activate Funds Management and create master data.



You must define the necessary settings in the implementation guide (IMG) of Public Sector

Management for Budgeting .

Integration

The inbound service interface Manage Budget Document belongs to the process component

Budget Processing [Seite 533 ] and business object Budget Document [Seite 534 ] .

Structure

The inbound service interface Manage Budget Document contains the following inbound operation: BudgetDocumentCreateRequestConfirmation_In ( Create Budget

Document [Seite 535 ] ).

Create Budget Document

Technical data

Entity type

Technical name in Enterprise Service

Repository (ESR)

Namespace in ESR

Software component version in ESR

Category

Mode

Corresponding Web Service Definition

Definition

Creates budget documents.

Use

The inbound operation Create Budget Document creates a budget document.

Features


BudgetDocumentCreateRequest_sync

Service operation

BudgetDocumentCreateRequestConfirmation_I n http://sap.com/xi/EA-PS/SE/Global


Inbound

Synchronous

ECC_BudgetDocumentCrtRC

BudgetDocumentCreateConfirmation_sync


Only values 1 (posted) and 2 (preposted) are allowed for element

BudgetDocumentLifecycleStatusCode in message type

BudgetDocumentCreateRequest_sync .

Integration

This inbound operation belongs to the inbound service interface Manage Budget Document

[Seite 534 ] .




Business Add-In (BAdI) FM_SE_BUDGET_DOCUMENTCRTRC ( Inbound/Outbound processing BAdI for BudgetDocumentCreateRequestConfirmation_In ) is available for this operation.

Processing

You can only use the ID in BudgetDocumentCreateRequest if you have activated the external number assignment in the implementation guide (IMG) of Public Sector

Management .

The elements OriginalEntryDocumentID and OriginalEntryDocumentTypeCode correspond with the fields AWORG (reference organizational units), AWTYP (reference process), AWSYS ( logical system of original document), and AWKEY (r eference key ) in the back-end system.

Back-end system Service

AWORG

AWTYP

AWSYS

AWKEY

OriginalEntryDocumentTypeCode

OriginalEntryDocumentID , Attribute SchemeAgencyID

First ten characters of OriginalEntryDocumentID

11 th

and following characters of OriginalEntryDocumentID

Note that some terms in the back-end system and ESR are different (see table):

Backend system ESR

Budgeting Process Budget Category Code

Document Status

Budget Category

Value Type

Budget Document Lifecycle Status Code

Budget Register Code

Budget Amount Role Code

Constraints

You cannot enter periods. The distribution across periods is always even (distribution key 1).

The active budget version (version 000) is always used.

Contract Accounting Receivables Payables

Processing

Technical Data

Entity type

Software component

Process component mySAP ERP enterprise services package (as of ESA ECC-SE 600)

Definition

The processing of receivables and payables (postings) in the form of a contract account.



Usage

You can use the process component Contract Accounting Receivables Payables Processing to prepare applications that support users working with data in the contract account environment.

The following functions are possible:

Create, read, and process contract accounts

Create cash security deposits


Prerequisites

The implementation of SAP ECC Industry Extension Contract Accounting is a prerequisite for using the operations contained in the process component.

Processing

The process component Contract Accounting Receivables Payables Processing enables the communication of data from the following components:

Invoicing for SAP Utilities (IS-U-IN)

SAP ECC Industry Extension Telecommunications

Contract Account

Technical Data

Entity type



Definition

An account for managing the postings of one or more business partners. The contract account contains guidelines and control data for processing receivables and payables.

Usage

This business object enables the creation and management of contract account master data.

In Contract Accounts Receivable and Payable (FI-CA) , each business partner posting is allocated to one business partner and to one contract account.



Business partner-dependent procedures that are used for posting and processing document items of the relevant account are determined in the contract account master record. This includes specifications for payment and dunning, for example.

Manage Contract Account In

Technical Data

Entity type


Category

Mode


Inbound

Synchronous

Definition

Request to and confirmation from contract account for provision of contract account data.

Usage

The inbound service interface Manage Contract Account In groups together operations that read information that is relevant for the contract account from the system.

Structure

The inbound service interface Manage Contract Account In contains the inbound operation

ContractAccountPaymentTermsByIDQueryResponse_In ( Read Contract Account

Payment Terms ).

Read Contract Account Payment Terms

Technical Data

Entity type Service operation

ContractAccountPaymentTermsByIDQueryResponse_In

Technical name in Enterprise Service


Name space in ESR http://sap.com/xi/FI-CA/SE/Global

Version of software component in ESR As of ESA ECC-SE 600

Category

Mode

Corresponding web service definition

Inbound

Synchronous

FKK_CONTRACTACCOUNTPAYTERMSQR

Definition

Request to and confirmation from contract account for provision of information on the payment conditions.

Usage

The inbound operation Read Contract Account Payment Terms provides information on payment conditions for a contract account.


SAP Documentation

Features


ContractAccountPaymentTermsByIDQuery

ContractAccountPaymentTermsByIDResponse

Processing

The operation reads the payment conditions for a contract account.

Enterprise SOA

Query Contract Account In

Technical Data

Entity type


Category

Mode


Inbound

Synchronous

Definition

Request to contract account for provision of contract account data.

Usage

Query Contract Account In groups together operations that read information that is relevant for the contract account from the system.

Structure

The inbound service interface Query Contract Account In contains the inbound operation

ContractAccountAccountBalanceByCustomerQueryResponse_In ( Find Contract

Account Balance ).

Find Contract Account Balance

Technical Data

Entity type

Technical name in Enterprise


Name space in ESR

Version of software component in ESR

Category

Mode

Service operation

ContractAccountAccountBalanceByCustomerQueryResponse_In http://sap.com/xi/FI-CA/SE/Global


Inbound

Synchronous




FKK_CONTRACTACCOUNT_BALANCE_QR

Definition

Request to and confirmation from contract account for provision of information on the account balance of the business partner.

Usage

The inbound operation Read Contract Account Balance provides information on the balance of one or more of a business partner’s contract accounts.

This information gives you an overview of open and due items for a customer.

Features


ContractAccountAccountBalanceByCustomerQuery

ContractAccountAccountBalanceByCustomerResponse

Processing

The operation reads the balances of a business partner’s contract accounts. It finds open and due items as well as items that are 30, 60, or 90 days overdue.

Cash Deposit Request

Technical Data

Entity type



Definition

The Cash Deposit Request is an accounting document that is created when a utility company requests a cash security deposit payment from a customer.

Manage Cash Deposit Request

Technical Data

Entity type


Category

Mode


Inbound

Synchronous

Definition

Management of cash security deposit requests.



Usage

The inbound service interface Manage Cash Deposit Request groups together operations that are relevant for the management of cash security deposit requests.

Structure

The inbound service interface Manage Cash Deposit Request contains the inbound operation

CashDepositRequestCreateRequestConfirmation_In ( Create Cash Deposit

Request ).

Create Cash Deposit Request

Technical Data

Entity type





Category

Mode


Service operation

CashDepositRequestCreateRequestConfirmation_In http://sap.com/xi/FI-CA/SE/Global


Inbound

Synchronous

FKK_CASHDEPOSITREQUESTCRTRC

Definition

Request and confirmation for creating a cash security deposit.

Usage

The inbound operation Create Cash Deposit Request enables the creation of cash security deposit requests.

Features


CashDepositRequestCreateRequest

CashDepositRequestCreateConfirmation

Processing

The operation creates a cash security deposit using data for the contract account, contract, start date, reason for request, and amount of request (including currency).

In order to determine a reconciliation key for posting the cash security request document, the SAP backend system checks the standard specification of event 1113 to determine whether you have defined a reconciliation group for the relevant user name in Customizing. If no reconciliation group has been defined, the system cannot determine a reconciliation key.


SAP Documentation

Credit Management

Enterprise SOA

SAP A2A Interface CreditWorthinessQuery_In

Description

The interface CreditWorthinessQuery_In requests information about the creditworthiness of business partners. It uses the following message types:

CreditWorthinessQuery : Determines the structure of the creditworthiness query of a business partner.

CreditWorthinessResponse : Determines the structure of the response message containing the required details about the creditworthiness (for example, score and credit limit) of a business partner.

The application that wants information on the creditworthiness of a business partner (for example, Accounts Receivable Accounting or Sales and Distribution ) sends a query to SAP

Credit Management , and SAP Credit Management returns the required information such as the score and recommended credit limit for the business partner. This information influences, for example, the decision in the requesting application as to whether or not to have business dealings with this business partner.

Querying System

CreditWorthinessQuery

CreditWorthinessResponse

SAP Credit

Management



Message Interfaces

CreditWorthinessQuery_In (inbound, synchronous)

When an application sends a creditworthiness query, the message interface is the inbound interface to SAP Credit Management . The query is synchronous. The message interface uses the message types CreditWorthinessQuery and CreditWorthinessResponse .

Message Types

CreditWorthinessQuery

This message type uses the data type CreditWorthinessQueryMessage that represents a message for querying creditworthiness.

CreditWorthinessResponse

This message type uses the data type CreditWorthinessMessage that represents a response to the creditworthiness query.

Data Types

CreditWorthinessQueryMessage

The figure below shows the data type CreditWorthinessQueryMessage that contains an entry of the data type CreditWorthinessQuery .



Credit

Worthiness

QueryMessage

CreditWorthiness

Query

CreditWorthinessQueryMessage

CreditWorthinessQuery

CreditSegmentInternalId

CheckedAmount

CheckingRuleCode

CheckingServityCode

CreditAgencyReportRetrieval

PermissionIndicator

DebtorPary

CreditorParty

SellerParty

ProductCategory

The data type CreditWorthinessQuery contains the following elements:

CreditSegmentInternalId – Credit segment in SAP Credit Management

GDT: CreditSegmentInternalID

CheckedAmount – Amount to be checked (such as the order value)

GDT: Amount

CheckingRuleCode – Encoded display of the rule to be used to determine the creditworthiness

GDT: CreditWorthinessCheckingRuleCode

CheckingServityCode – Encoded display of the severity of the check procedure to be used

GDT: CreditWorthinessCheckingSeverityCode

CreditAgencyReportRetrievalPermissionIndicator – Indicator to show whether or not a business partner has granted permission for credit information to be obtained about him or her



GDT: CreditAgencyReportRetrievalPermissionIndicator

DebtorParty – Customer whose creditworthiness is to be determined

GDT (InternalId): PartyInternalID

CreditorParty – Not used in SAP Credit Management

SellerParty – Not used in SAP Credit Management

ProductCategory – Not used in SAP Credit Management

CreditWorthinessMessage

The figure below shows the data type CreditWorthinessMessage that contains an entry of the data type CreditWorthiness .

Credit

Worthiness

Message

CreditWorthiness

CreditWorthinessMessage

CreditWorthiness


Indicator

CheckingDescription

DebtorPartyBlockedIndicator

DebtorPartySpecialAttention

RequiredIndicator

DebtorPary

CreditorParty

SellerParty

ProductCategory

Rating

RiskClass

CreditLimit

CreditExposure



The data type CreditWorthiness contains the following elements:



Indicator – Specification of whether there is a creditworthiness for the business partner for the query parameters specified

GDT: CreditWorthinessIndicator

CheckingDescription – Description of the flow of a creditworthiness check

GDT: Description

DebtorPartyBlockedIndicator – Specification of whether the business partner is blocked in SAP Credit Management

GDT: Indicator

DebtorPartySpecialAttentionRequiredIndicator – Specification of whether the business partner should be subject to special attention

GDT: Indicator

DebtorParty – Customer whose creditworthiness was determined

GDT: PartyInternalID




Rating – Score of a business partner determined by SAP Credit Management and valid for a specific period

Rating contains the following elements:

Code – Coded display of the score value

GDT: CreditRatingCode

ValidityPeriod – Validity period of the score value

GDT: DateTimePeriod

RiskClass – Payment default risk determined by SAP Credit Management and valid for a specific period

RiskClass contains the following elements:

Code – Coded display of the risk class

GDT: CreditRiskClassCode

ValidityPeriod – Validity period of the risk class

GDT: DateTimePeriod

CreditLimit – Credit valid for a business partner for a specific period

CreditLimit contains the following elements:

Amount – Amount of the credit

GDT: Amount



ValidityPeriod – Validity period of the credit

GDT: DateTimePeriod

CreditExposure – Current credit exposure of the business partner

CreditExposure contains the following element:

Amount – Amount of the credit exposure

GDT: Amount

Mapping Objects

Interface Mapping UkmCreditQuery_CreditWorthinessQuery

This interface mapping connects SD systems with release version 4.6C or 4.70 to the credit check in SAP Credit Management . It is delivered with the XI content of the software component version FINBASIS_300 from support package 06. It maps the interface of the

RFC module UKM_CREDIT_QUERY to the interface CreditWorthinessQuery_In.

Message Mapping UkmCreditQuery_CreditWorthinessQuery

The interface mapping with the same name described above uses this message mapping.

The message mapping is also delivered with the XI content of the software component version FINBASIS_300 from support package 06.

SAP A2A Interfaces CreditCommitment_In and

CreditCommitment_Out

Description

These interfaces provide SAP Credit Management with information about commitments.

An application that has information about commitments of business partners sends this information to SAP Credit Management according to the company’s own rules or when requested to do so. The inbound information is collected and consolidated, thus enabling company-wide monitoring of the credit limits.

There is a difference between commitment notification and commitment query. With commitment notification, the application sends the information at non-specific intervals to SAP

Credit Management . With commitment query, SAP Credit Management actively requests the information from the application concerned.



SAP Credit

Management

CreditCommitmentNotification

Commitment

Notification

System with

Information about

Commitments

Commitment

Query

CreditCommitmentQuery

CreditCommitmentResponse


CreditCommitmentNotification_In (inbound, asynchronous)

When an application sends its information about commitments, the message interface is the inbound interface into SAP Credit Management . The message interface consists of the message type CreditCommitmentNotification .

CreditCommitmentQuery_Out (outbound, synchronous)

This message interface is used when SAP Credit Management requests information about commitments from the applications connected. Message type CreditCommitmentQuery is used for the query, whereas message type CreditCommitmentResponse represents the notification.

Message Types

CreditCommitmentNotification

This message type uses the data type CreditCommitmentMessage that represents a message for transferring a business partner’s existing commitments.

CreditCommitmentQuery

This message type uses the data type CreditCommitmentQueryMessage that represents a message for querying a business partner’s existing commitments.



CreditCommitmentResponse

This message type uses the data type CreditCommitmentMessage that represents a message for transferring a business partner’s existing payment obligations (commitments).

Data Types

CreditCommitmentMessage

The figure below shows the data type CreditCommitmentMessage that contains one or more entries of the data type CreditCommitment .



The data type CreditCommitment contains the following elements:



TypeCode – Credit exposure category with the following standard values:

100 – Sales value (order value)



200 - Receivables

300 – Special credit exposure

400 – Value of goods supplied

500 – Special credit exposure

GDT :

CreditCommitmentTypeCode

Amount – Amount

GDT: Amount

SecuredAmount – Hedged amount

GDT: Amount

UnsecuredAmount – Unhedged amount

GDT: Amount

ValidityDate – Validity date

GDT: Date

AmounceBalanceIndicator – Indicates whether it is a balance or a commitment

GDT: AmountBalanceIndicator

AmountDifferenceIndicator – Indicates whether the amount is a difference amount

GDT: AmountDifferenceIndicator

DebtorParty – Description of the customer whose payment obligations are reported


CredtorParty – Not used in SAP Credit Management



PendingCommitment – Related information about a payment obligation is grouped together to avoid temporary data inconsistencies when the commitment is updated in

SAP Credit Management . The credit exposure is not updated immediately when the first message of a group is received; instead, it is stored in a temporary area until the following message(s) confirm this commitment.

PendingCommitment contains the following elements:

GroupID – Identifier that links together related CreditCommitment messages

GDT: BusinessTransactionDocumentGroupID

CompletedIndicator – Indicates whether the business transaction is complete (in other words, whether the last message of the group has been received and the temporary commitment can be deleted).

GDT: BusinessTransactionCompletedIndicator

InvoiceReference – Reference to an outbound invoice document

GDT: BusinessTransactionDocumentReference



OutboundDeliveryReference – Reference to an outbound delivery document


SalesOrderReference – Reference to a sales order


IncomingPaymentReference – Reference to an incoming payment


AccountingDocumentReference – Reference to an accounting document


PredecessorReference – Reference to a preceding document

CreditCommitmentQueryMessage

The figure below shows the data type CreditCommitmentQueryMessage that contains one or more entries of the data type CreditCommitmentQuery .

CreditCommitmentQueryMessage

CreditCommitment

QueryMessage

CreditCommitmentQuery

CreditCommitment

Query


ValidityDate

DebtorParty

CreditorParty

SellerParty

ProductCategory

The data type CreditCommitmentQuery contains the following elements:

CreditSegmentInternalId – Credit segment in SAP Credit Management for which the connected systems send the commitments


ValidityDate – Validity date

GDT: Date



DebtorParty – Description of the customer whose payment obligations are to be reported





Mapping Objects

Interface Mapping UkmCommitmentsPush_CreditCommitmentNotification

This interface mapping connects Accounts Receivable Accounting systems or SD systems with release version 4.6C or 4.70 to SAP Credit Management . It is delivered with the XI content of the software component version FINBASIS_300 from support package 06. It maps the interface of the RFC module UKM_COMMMITMENTS_PUSH to the interface

CreditCommitmentNotification_In.

Message Mapping UkmCommitmentsPush_CreditCommitmentNotification

The interface mapping with the same name described above uses this message mapping.

The message mapping is also delivered with the XI content of the software component version FINBASIS_300 from support package 06.

SAP A2A Interface

CreditPaymentBehaviourSummaryNotification_In

Definition

CreditPaymentBehaviourSummary transfers information about the payment behavior or business partners.



System with Information about

Payment Behavior

CreditPaymentBehaviourSummary

SAP Credit

Management


CreditPaymentBehaviourSummaryNotification_In (inbound, asynchronous)

When an application sends its payment behavior summaries, the message interface is the inbound interface into SAP Credit Management . The message interface uses the message types CreditPaymentBehaviourSummaryNotification and

CreditPaymentBehaviourSummaryFault .

Message Types

CreditPaymentBehaviourSummaryNotification

This message type consists of the data type CreditPaymentBehaviourSummaryMessage that represents a message for transmitting the payment behavior summaries for business partners.

CreditPaymentBehaviourSummaryFault

This message type uses the data type ExchangeFaultData that carries out a standard transfer of exceptions that arise in SAP Credit Management .

Data Types

CreditPaymentBehaviourSummaryMessage

The figure below shows the data type CreditPaymentBehaviourSummaryMessage that contains one or more entries of the data type CreditPaymentBehaviourSummary .


SAP Documentation

CreditPayment

Behaviour

Summary

Message

Enterprise SOA

CreditPayment

Behaviour

Summary

CreditPaymentBehaviourSummaryMessage

CreditPaymentBehaviourSummary


DebtorParty

CreditorParty

SellerParty

ProductCategory

LastPayment

OldestOpenItem

MaximumLevelDunnedOpenItem

DunningCounterValue

CumulatedReceivablesAmount

DaysOfSalesOutstandingDuration

OverdueOpenItemsPercent

LastTwelveMonthsMaximum

CreditExposureAmount

LesTwelveMonthsMaximum

SalesVolumeAmount

WithoutDiscountPayments

WithDiscountPayments

The CreditPaymentBehaviourSummary data type contains the following elements:



DebtorParty – Description of the customer whose payment behavior summaries are reported




CreditorParty – The party that owns a receivable from a customer; can be used to derive the credit segment

SellerParty – The party that has sold a product to the customer; can be used to derive the credit segment

ProductCategory – The product category of the product sold to the customer; can be used to derive the credit segment

LastPayment – Payment amount and date of last payment

OldestOpenItem – Highest open item amount with due date

MaximumLevelDunnedOpenItem – Open item with highest dunning level

DunningCounterValue – Number of dunned, outstanding receivables due from the customer

GDT: DunningCounterValue

CumulatedReceivablesAmount – Cumulative receivables total that can also be subjected to interest with a fictitious interest rate

GDT: Amount

DaysOfSalesOutstandingDuration – Receivables total measured in days sales of business with the customer

GDT: Duration ( specification in days)

OverdueOpenItemsPercent – Percentage of the amount of all overdue open items of the total amount of all open items of the customer

GDT: Percent

LastTwelveMonthsMaximumCreditExposureAmount – Highest credit exposure of the customer in the last twelve months

GDT: Amount

LastTwelveMonthsSalesVolumeAmount – Sales with the customer in the last twelve months

GDT: Amount

WithoutDiscountPayments – Key figures for payments of the customer where there was a complete or partial loss of cash discount (not taking cash discount can indicate poor liquidity)

WithDiscountPayments – Key figures for payments of the customer where maximum cash discount was taken (claiming cash discount can indicate sufficient liquidity)

Mapping Objects

No mapping objects exist for the interface.




BusinessPartnerIDByElementsQuery_Out

Description

This interface enables you to request the identification (ID) of a business partner at an information provider. You need this ID to obtain external credit information.

The interface has two message types:

BusinessPartnerIDByElementsQuery_sync structures the message for requesting the ID of the business partner.

BusinessPartnerIDByElementsResponse_sync structures the response list with the hit list for the business partners required.

SAP Credit

Management

BusinessPartnerIDByElementsQuery_sync

BusinessPartnerIDByElements

Response_sync

Information

Provider


BusinessPartnerIDByElementsQuery_Out (outbound, synchronous)

If SAP Credit Management requests the ID of a business partner, the message interface is the outbound interface. The query to the external information system takes place synchronously. The message interface consists of the message types

BusinessPartnerIDByElementsQuery and

BusinessPartnerIDByElementsResponse .



Message Types

BusinessPartnerIDByElementsQuery_sync

This message type consists of the data type

BusinessPartnerIDByElementsQueryMessage that represents a message for requesting the ID of a business partner.

BusinessPartnerIDByElementsResponse_sync


BusinessPartnerIDByElementsResponseMessage that represents a response to the request for the ID of a business partner.

Data Types

BusinessPartnerIDByElementsQueryMessage

The data type BusinessPartnerIDByElementsQueryMessage contains an entry of the data type MessageHeader and an entry of the data type

BusinessPartnerIDSelectionByElements .

The data type MessageHeader contains the following elements:

SenderParty – Sender of the message ( SAP Credit Management system)

GDT: BusinessDocumentMessageHeaderParty

RecipientParty – Recipient of message


The BusinessPartnerIDSelectionByElements data type contains the following elements:

ReasonCode – Reason for the query

GDT: CreditAgencyReportQueryReasonCode

ServiceID – Identifier of the required service assigned by the information provider

(according to the service catalog of the information provider)

GDT: ProductPartyID

LanguageCode – Language key

PartyStandardID – ID of the party to be identified, assigned by the information provider. For example, DUNS number.

GDT: PartyStandardID

PartyPartyID – ID of the business partner assigned by another party

GDT: PartyPartyID

Address – Address

The address is categorized by the

BusinessPartnerIDSelectionByElementsAdress data type. It consists of the following elements:

OrganisationFormattedName – Name of the company

GDT: OrganisationName

PersonName – Name of the person



GDT: PersonName

PhysicalAddress – Postal address

CountryCode – Abbreviation for the country

GDT: CountryCode

RegionCode – Abbreviation for the region

GDT: RegionCode

StreetPostalCode – Postal code of the street

GDT: PostalCode

CompanyPostalCode – Postal code of the company

GDT: PostalCode

CityName – City

GDT: LANGUAGEINDEPENDENT_MEDIUM_Name

DistrictName – District

GDT: LANGUAGEINDEPENDENT_MEDIUM_Name

StreetName – Street

GDT: StreetName

HouseID – House number

GDT: HouseID

Communication – Communication data

TelephoneNumber – Telephone number

GDT: PhoneNumber

MobileNumber – Cell phone number

GDT: PhoneNumber

FacsimileNumber – Fax number

GDT: PhoneNumber

EmailAddress – e-mail address

GDT: EMailAddress

WebAddress – Web address

GDT: WebAddress

BirthPlaceName – Place of birth

GDT: MEDIUM_Name

OriginCountryCode – Country of birth

GDT: CountryCode

BirthDate – Date of birth if the party to be identified is a natural person

GDT: Date



GenderCode – Gender

GDT: GenderCode

SpouseAddress – Address of spouse

IDT: BusinessPartnerIDSelectionByElementsAddress

SpouseGenderCode – Gender of spouse

GDT: GenderCode

SpouseBirthDate – Date of birth of spouse

GDT: Date

FoundationDate – Date of foundation if the party to be identified is a company

GDT: Date

BusinessPartnerIDByElementsResponseMessage

The data type BusinessPartnerIDByElementsResponseMessage contains one entry of the data type MessageHeader , one or several entries of the data type BusinessPartner , and one entry of the data type Log .

For the elements of the data type MessageHeader see the data type

BusinessPartnerIDByElementsQuery above.

The BusinessPartner data type contains the following elements:

InternalID – Internal ID of a party


PartyID – ID of the party to be identified, assigned by the information provider. For example, DUNS number.

GDT: PartyID

Address – Address

OrganisationFormattedName – Name of the company

GDT: OrganisationName

PersonName – Name of the person

GDT: PersonName

PhysicalAddress – Postal address

BirthPlaceName – Place of birth

GDT: MEDIUM_Name

OriginCountryCode – Country of birth

GDT: CountryCode

BirthDate – Date of birth if the party to be identified is a natural person

GDT: Date

GenderCode – Gender

GDT: GenderCode



FoundationDate – Date of foundation if the party to be identified is a company

GDT: Date

SearchRank – Ranking of the search result

TotalNumberValue – Number

Data type Log : Series of log messages about the process flow of the ID search.

GDT: Log

Mapping Objects


SAP A2A Interfaces

CreditAgencyMonitorQuery_Out and

CreditAgencyMonitorNotification_In

Description

You use this interface to get external credit monitoring information from an information provider.

The interface has two message types:

CreditAgencyMonitorQuery structures the message for requesting external credit monitoring information

CreditAgencyMonitorResponse structures the response message with the required information.



SAP Credit

Management

CreditAgencyMonitorQuery

CreditAgencyMonitorResponse

Information

Provider


CreditAgencyMonitorQuery_Out (outbound, synchronous)

If SAP Credit Management requests external credit monitoring information, the message interface is the outbound interface. The query to the external information system takes place synchronously. The message interface consists of the message types

CreditAgencyMonitorQuery_sync and CreditAgencyMonitorResponse_sync .

Message Types

CreditAgencyMonitorQuery_sync

This message type consists of the data type CreditAgencyMonitorQueryMessage that represents a message for requesting external credit monitoring information.

CreditAgencyMonitorResponse_sync

This message type consists of the data type CreditAgencyMonitorResponseMessage that represents a response to the request for external credit monitoring information.

Data Types

CreditAgencyMonitorQueryMessage

The figure below shows the data type CreditAgencyMonitorQueryMessage that contains one entry of the data type MessageHeader and one entry of the data type

CreditAgencyMonitorQuery .



CreditAgencyMonitorQueryMessage

CreditAgency

MonitorQuery

Message

MessageHeader

CreditAgency

MonitorQuery

ID

ReferenceID

CreationDateTime

SenderParty

RecipientParty

MessageHeader

CreditAgencyMonitorQuery

ReasonCode

DebtorParty

Service


ID – Unique identifier for the message

GDT: MessageID

ReferenceID – Unique identifier for the response message delivered in

CreditAgencyMonitorResponse

GDT: MessageID

CreationDateTime – Date and time of creation of the message

GDT: DateTime

SenderParty – Sender of the message ( SAP Credit Management system)






The CreditAgencyMonitorQuery data type contains the following elements:

ReasonCode – Reason for the query

GDT: CreditAgencyReportQueryReasonCode

DebtorParty – The party (debtor) about whom credit information is to be given

DebtorParty contains the following elements:

StandardID – Standardized identifier for the party to be checked

GDT: PartyStandardID

CreditAgencyID – Identifier for the party to be checked; assigned by the information provider

GDT: PartyPartyID

Address – Address of the party to be checked

GDT: Address , whereby FunctionalTitleName, DepartmentName, Office,

TaxJurisdictionCode, TimeZoneDifferenceValue, GeoCoordinates are not used

IncorporationDate – Date of foundation if the party to be checked is a company

GDT: Date

BirthDate – Date of birth if the party to be checked is a natural person

GDT: Date

Service

– Type and scope of the required service

Service contains the following elements:

CreditAgencyID – Identifier of the required service assigned by the information provider (according to the service catalog of the information provider)

GDT: ProductPartyID

LanguageCode – Language in which the results of the service requested are to be delivered

GDT: LanguageCode

ReadIndicator – Indicator as to whether the entry was read or not

GDT: Indicator

ReportingPeriod – Date for which the information provider has provided the external credit monitoring information

GDT: UPPEROPEN_DatePeriod

ReceiptPeriod – Date on which the external credit monitoring information was retrieved


TestRunIndicator – Test indicator with the consequence that the data retrieved is not marked as read

GDT: Indicator



CreditAgencyDocumentID –Identification of the information provider for a single message

GDT: BusinessTransactionDocumentID

CreditAgencyMonitorResponse

The figure below shows the data type CreditAgencyMonitorResponseMessage that contains one entry of the data type MessageHeader , one entry of the data type Log , and one or more entries of the data type CreditAgencyMonitorResponse .



CreditAgency

MonitorResponse

Message

MessageHeader

CreditAgency

MonitorResponse

CreditAgencyMonitorResponseMessage

ID

ReferenceID

CreationDateTime

SenderParty

RecipientParty

MessageHeader

CreditAgencyMonitor

Response

CreditAgencyDocumentID

DebtorParty

CreditRating

CreditRiskClass

Scoring

CreditLimit

LegalEvent

LOG




CreditAgencyMonitorQuery above.

Data type Log : Summary of information about the process flow of the creation of the external credit monitoring information.

GDT: Log

The data type CreditAgencyMonitorResponse contains the following elements:

DebtorParty – Summary of the information about the party about whom credit information is to be given

CreditRating – Rating value for a party determined by the information provider and valid for a specific period


Scoring – Result of the rating of a party with regard to its creditworthiness using a scorecard specified by an information provider

CreditLimit – Credit limit valid for a party for a specific period

LegalEvent – A legal event concerning the creditworthiness of a party

Mapping Objects



CreditAgencyMonitorNotification (inbound, asynchronous)

If SAP Credit Management receives external credit monitoring information asynchronously, the message interface is the inbound interface. The message interface contains the message type CreditAgencyMonitorNotification .

Message Types

CreditAgencyMonitorNotification

This message type consists of the data type CreditAgencyMonitorNotification that represents external credit monitoring information.

Data Types

CreditAgencyReportQuery

The data type CreditAgencyMonitorNotification consists of the above mentioned data types MessageHeader and CreditAgencyMonitor .


CreditManagementAccountByIDQuery_In

Description

This interface is used to transfer the data from SAP Credit Management .



It uses the following message types:

CreditManagementAccountByIDQueryMessage structures the message for requesting the credit data.

CreditManagementAccountByIDResponseMessage structures the response message.

Querying

System

SAP Credit

Management

CreditManagementAccountByIDQuery

CreditManagementAccountByIDResponse


CreditManagementAccountByIDQuery_In (outbound, synchronous)

If SAP Credit Management requests credit data, the message interface is the outbound interface. The response to the query system is synchronous. The message interface consists of the message types CreditManagementAccountByIDQuery and

CreditManagementAccountByIDResponse .

Message Types

CreditManagementAccountByIDQuery

This message type contains the data type

CreditManagementAccountByIDQueryMessage that represents a message for requesting credit data.

CreditManagementAccountByIDResponse

This message type contains the data type

CreditManagementAccountByIDResponseMessage that represents a response to the request for credit data.



Data Types

CreditManagementAccountByIDQueryMessage

The data type CreditManagementAccountByIDQueryMessage contains one entry of the data type MessageHeader , one entry of the data type Selection , and a language key.


ID – Identifier for the message

GDT: MessageID

ReferenceID – Identifier for the response message delivered in

CreditAgencyMonitorResponse

GDT: MessageID

CreationDateTime – Date and time of creation of the message

GDT: DateTime

SenderParty – Sender of the message (querying system)




The Selection data type contains the following elements:

DebtorPartyInternalID – Party (debtor) about whom information is to be given




LanguageCode – Language in which the results of the service requested are to be delivered

GDT: LanguageCode

CreditManagementAccountByIDResponseMessage

The data type CreditManagementAccountByIDResonseMessage contains one entry of the data type MessageHeader , one entry of the data type CreditManagementAccount , and one entry of the data type Log .


CreditManagementAccountByIDQueryMessage above.

Data type Log : Series of log messages about the processing of the query

GDT: Log

The CreditManagementAccount data type contains the following elements:

DebtorPartyInternalID – Identification of the party




CreditSegmentDescription – Name of the credit segment



GDT: MEDIUM_Description

CreditWorthinessCheckingRuleCode – Rule for scoring

GDT: CreditWorthinessCheckingRuleCode

CreditWorthinessCheckingSchemeCode – Rule for the credit check

GDT: CreditWorthinessCheckingSchemeCode

SpecialAttentionRequiredIndicator – Special attention

GDT: Indicator

BlockedIndicator – Business partner is blocked in SAP Credit Management

GDT: Indicator

BlockingReasonCode – Block reason

GDT: CreditBlockingReasonCode

BlockingReasonCodeDescription – Description of the block

GDT: MEDIUM_Description


CreditRating is categorized by the data type

CreditManagementCreditAccountRating and contains the following elements:

Code – Coded display of the score value

GDT: CreditRatingCode

ValidityPeriod – Validity period of the score value


CreditRiskClass – Payment default risk determined by SAP Credit Management and valid for a specific period

CreditRiskClass is categorized by the data type

CreditManagementAccountCreditRiskClass and contains the following elements:

Code – Coded display of the risk class

GDT: CreditRiskClassCode

ValidityPeriod – Validity period of the risk class


CreditLimitAmount – Amount of the credit

GDT: Amount

CreditLimitValidityPeriod – Validity period of the credit


CreditExposure – Current utilization of the credit limit of the business partner

CreditExposure is categorized by the data type

CreditManagementAccountCreditExposure and contains the following elements:



Amount – Amount of the utilization

GDT: Amount

Percent – Utilization in percent

GDT: Percent

DynamicCheckHorizonEndDate – End date of the credit horizon

GDT: Date

PaymentBehaviourSummary – Payment behavior of the business partner

For more information about PaymentBehaviourSummary , see SAP A2A Interface

CreditPaymentBehaviourSummaryNotification_In [Seite 553 ] .

CommitmentTotal – Credit exposure of the business partner

Mapping Objects



CreditManagementAccountChangeNotification_In

Description

This interface is used to change specific credit data.



System with

Changes to Credit

Account

CreditManagementAccountChange

SAP Credit

Management


CreditManagementAccountChangeNotification_In (inbound, asynchronous)

If an application wants to change the credit data, the message interface is the inbound interface to SAP Credit Management . The message interface uses of the message type

CreditManagementAccountChangeNotification .

Message Types

CreditManagementAccountChangeNotification

This message type uses the data type

CreditManagementAccountChangeNotificationMessage .

Data Types

CreditManagementAccountChangeNotificationMessage

The data type CreditManagementAccountChangeNotificationMessage contains one entry of the data type MessageHeader and one entry of the data type

CreditManagementAccountChange .

For the elements of the data type MessageHeader , see SAP A2A Interface

CreditManagementAccountByIDQuery_In [Seite 567 ] .

The CreditManagementAccountChange data type contains the following elements:



DebtorInternalID – Customer whose data is to be changed



GDT: DebtorInternalID

BlockedIndicator – Indicates whether the credit account is blocked or not

GDT: Indicator

BlockingReasonCode – Reason for the block in SAP Credit Management


SpecialAttentionRequiredIndicator – Indicates whether this credit account requires special attention

GDT: Indicator

Mapping Objects



CreditWorthinessCriticalPartiesQuery_In

Description

This interface describes business partners that are rated as critical with regard to their creditworthiness. The interface consists of the following actions:

Sending a query ( CreditWorthinessCriticalPartiesQuery )

Receiving a response that contains a list of critical business partners

( CreditWorthinessCriticalPartiesResponse )

These interfaces are motivated by the necessity of providing Financial Accounting with a list of business partners whose score is negative, for example.

An application, Contract Accounts Receivable and Payable (FI-CA), for example, sends a query with a number of business partners to SAP Credit Management .

SAP Credit

Management provides a negative customer list with business partners with negative ratings.



Querying System

CreditWorthinessCriticalPartiesQuery

CreditWorthinessCriticalPartiesResponse

SAP Credit

Management


CreditWorthinessCriticalPartiesQuery_In (inbound, synchronous)

If an application requests a list of the critical business partners, the message interface is the inbound interface to SAP Credit Management . The list of critical partners is delivered to the querying system synchronously via the interface. The message interface uses the message types CreditWorthinessCriticalPartiesQuery and

CreditWorthinessCriticalPartiesResponse .

Message Types

CreditWorthinessCriticalPartiesQuery


CreditWorthinessCriticalPartiesQueryMessage , which represents a message for querying the quantity of critical business partners.

CreditWorthinessCriticalPartiesResponse

This message type uses the data type CreditWorthinessCriticalPartiesMessage that represents a response to the query regarding the quantity of critical partners.

Data Types


The figure below shows the data type

CreditWorthinessCriticalPartiesQueryMessage that contains one or more entries of the data type CreditWorthinessCriticalPartiesQuery .



CreditWorthiness

CriticalParties

QueryMessage

CreditWorthiness

CriticalParties

Query

CreditWorthinessCriticalPartiesQueryMessage



DebtorPartyInterval

CreditorParty

SellerParty

ProductCategory

The data type CreditWorthinessCriticalPartiesQuery contains the following elements:



DebtorPartyInterval – Business partner interval to be checked for critical partners





The figure below shows the data type

CreditWorthinessCriticalPartiesReponseMessage that contains one or more entries of the data type CreditWorthinessCriticalPartiesResponse .



CreditWorthiness

CriticalParties

ResponseMessage

CreditWorthiness

CriticalParties

Response

CreditWorthinessCriticalPartiesResponseMessage



DebtorParty

CreditorParty

SellerParty

ProductCategory

The data type CreditWorthinessCriticalPartiesResponse contains the following elements:



DebtorParty – Critical business partner




Mapping Objects





CreditWorthinessChangeInformation_Out

Description

CreditWorthinessChangeInformation is a message that contains information about changes to the creditworthiness of a business partner.

Once a credit limit or rating check has been performed for a connected system, interested applications that are connected to SAP Credit Management are provided with new information. For example, the current and earlier rating values of a business partner are sent or messages from the creditworthiness check, such as the reason for a negative result.

SAP Credit

Management

Connected

System

CreditWorthinessChangeInformation


CreditWorthinessChangeInformation_Out (outbound, asynchronous)

If an event that is to be published externally is triggered in SAP Credit Management , the message interface is the outbound interface. The message interface uses the message type

CreditWorthinessChangeInformation .

Message Types

CreditWorthinessChangeInformation

This message type uses the data type CreditWorthinessChangeMessage that represents a message with changed information from SAP Credit Management .



Data Types

CreditWorthinessChangeMessage

The figure below shows the data type CreditWorthinessChangeMessage that contains one or more entries of the data type CreditWorthinessChange .

The data type CreditWorthinessChange contains the following elements:



ReasonCode – Reason for the change

CheckingDescription – Description of the flow of a creditworthiness check

GDT: Description

DebtorParty – Description of the customer whose payment behavior summaries are reported





Rating – Valid score of a business partner determined by SAP Credit Management and valid for a specific period

RiskClass – The risk of non-payment determined by SAP Credit Management and valid for a specific period; can be connected to closing

CreditLimit – Credit limit valid for a business partner for a specific period

CreditExposure – Existing credit exposure of a business partner valid for a specific period

DebtorPartyBlockedIndicator – Specification of whether the business partner is blocked in SAP Credit Management

GDT: Indicator

BlockingReasonCode – Reason for the block in SAP Credit Management


SpecialAttentionIndicator – Specification of whether the business partner should be subject to special attention

GDT: Indicator

Mapping Objects


Use

No recipients of events that are sent from SAP Credit Management are delivered with the standard. For an example implementation of a customer-specific module that receives and processes events in an SAP system connected to SAP Credit Management by XI, see SAP

Note 813285.



Due Item Processing

Technical Data

Entity Type



Definition

Collection, administration and monitoring of receivables or payables from deliveries or services, and the related sales or withholding tax.

Use

The process component Due Item Processing is used to collect and clear receivables or payables from deliveries, services, and taxes, and to initiate the payment process for these.

The process makes it possible to create the reports, for example tax returns. In addition, it provides services so that outstanding receivables can be collated and dunned.

Due Payment

Technical Data

Entity Type



Definition

Payment request or payment confirmation relating to settlement items (receivables or payables) from goods and services.

Use

The business object DuePayment is used for creating payment requests or confirmations for receivables or payables, and contains the information necessary for this.

Manage Due Payment In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Instruction to pay open payables.



Use

The inbound service interface Manage Due Payment In contains an operation that receives payment instructions and returns a payment confirmation.

Integration

The inbound service interface Manage Due Payment In belongs to the process component

Due Item Processing [Seite 579 ] and to the business object Due Payment [Seite 579 ] .

Structure

The inbound service interface contains the inbound operation

DuePaymentCreateRequestConfirmation_In ( Create Due Payment [Seite 580 ] ).

Create Due Payment

Technical Data

Entity Type





Category

Mode


Operation

DuePaymentCreateRequestConfirmation_In http://sap.com/xi/APPL/SE/Global

ESA ECC SE 600

Inbound

Synchronous

ECC_DuePaymentCrtRC

Definition

Instruction to pay open payables.

Use

The inbound operation Create Due Payment receives payment instructions, and returns a confirmation of receipt.

The payment instruction is normally created by a biller, who selects one or more of his open payables for payment, and then specifies a payment method. If he also selects credits, these are offset against the selected payables, and payment is only arranged for the remaining amount.

Features

This inbound service operation processes the following message types:

DuePaymentCreateRequest_sync

Although the input message type of this operation contains a

MessageHeader/UUID element, the operation does not support idempotent behavior as described in the mySAP Service Provisioning handbook. Since support for idempotent behavior may be added in the future, we recommend that you do not use this UUID element for the time being.

DuePaymentCreateConfirmation_sync




If the payment has not been assigned to a particular payable, the message

DuePaymentCreateRequest_sync contains the following information:

Business partner arranging the payment

Company that issued the bill

Currency in which the bill was made out

Amount of payment

If the payment has been assigned to one or more payables, the message

DuePaymentCreateRequest_sync contains the following information:

The payables assigned to the payment that are represented by at least one split item

Partial amount of a payable, if the total amount of a payable is not cleared

Open amount of a receivable or payable at the time of the payment instruction

Selected method of payment

Bank or credit card information for payment processing

The message DuePaymentCreateConfirmation_sync contains the following information:

Related payment instruction

Entry whether the payment instruction has been accepted

Integration

This inbound operation belongs to the inbound service interface Manage Due Payment In

[Seite 579 ] .

Constraints

BankStandardID (IBAN) is not supported.

StandardID (SWIFT) is not supported.

CheckDigitValue is not supported.

The identifier of the payment instruction is not returned.

Note the information on constraints outlined in SAP Note 955496 .


To change the input and output values, you need Business Add-In

EBPP_SE_DUE_PAYMENT_CREATE_REQ.

You can use this Business Add-In, for example, to implement a heuristic that determines the company code of the customer. This is necessary if the customer exists in several company codes, and has not specified a company code with the request, as the system is unable to determine the company code in this instance.

To make payment by credit card possible, the assignment in the Business Add-In of the

PaymentCard TypeCode specified in the request must be mapped to the credit card types maintained in configuration table TVCIN .



Trade Receivables Payables Account

Technical Data

Entity Type



Definition

Grouping element of Due Item Processing for creating and reporting of all receivables or payables from goods and services of a company with respect to a business partner.

It contains guidelines for and agreements with a business partner regarding the cash payment and dunning of receivables and payables.

Use

The business object Trade Receivables Payables Account contains guidelines for and agreements with a business partner regarding the payment and dunning of receivables and payables.

For a Enterprise Services for SAP ERP, the effects of business transactions on the inventory of receivables and payables from goods and services are continuously recorded in the business object Trade Receivables Payables .

It does not itself contain individual flows or totals.

Query Trade Receivables Payables Account In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Query of open and paid items of a customer.

Use

The inbound service interface Query Trade Receivables Payables Account In encompasses operations that receive inquiries from the bill recipient regarding his open and paid receivables and payables. They then return the corresponding receivables and payables from the biller to the bill recipient.

Integration

The inbound service interface Query Trade Receivables Payables Account In belongs to the process component Due Item Processing [Seite 579 ] and to the business object Trade

Receivables Payables Account [Seite 582 ] .

Structure

The inbound service interface encompasses the following inbound operations:



TradeReceivablesPayablesAccountCustomerOpenItemByCustomerQueryRe sponse_In ( Find Open Item by Customer [Seite 583 ] )

TradeReceivablesPayablesAccountCustomerClearedItemByCustomerQuer yResponse_In ( Find Cleared Item by Customer [Seite 585 ] )

Find Open Item by Customer

Technical Data

Entity Type





Category

Mode


Operation

TradeReceivablesPayablesAccount-

CustomerOpenItemByCustomer-


ESA ECC SE 600

Inbound

Synchronous

ECC_TRPAccountOpenItemByCusQR

Definition

Query of open items of a customer.

Use

The inbound operation Find Open Item by Customer receives inquiries the from bill recipient regarding his open receivables and payables. It then returns the corresponding receivables and payables and also the balance from the biller to the bill recipient.

Features


TradeReceivablesPayablesAccountCustomerOpenItemByCustomerQuery_sync

TradeReceivablesPayablesAccountCustomerOpenItemByCustomerResponse_sync


The message TradeReceivablesPayablesAccountCustomerOpenItemByCustomer-

Query_sync contains the following information:

Business partner, who is bill recipient

Company that issues the bill

Currency in which the receivables and payables should be specified

The message TradeReceivablesPayablesAccountCustomerOpenItemByCustomer-

Response_sync contains the following information:

General information:

Currency in which the receivables and payables are specified




Description of the business partner who is the bill recipient

Total amount of all open receivables

Total amount of all open payables

Total balance of all open receivables and payables

Information on the individual payables that are represented by at least one split item, for example:

Document number

Creation date

Total amount in required display currency and original currency

Open amount in required display currency and original currency

Deductions, for example discounts

Due date

Description

Hyperlink to the business document that underlies the payable.

Information on the individual receivables that are represented by at least one split item, for example:

Document number

Creation date

Amount in required display currency and original currency

Validity date

Description

Hyperlink to the business document that underlies the receivable.

Integration

This inbound operation belongs to the inbound service interface Query Trade Receivables

Payables Account In [Seite 582 ] .

Constraints

ReportingCurrency is not supported.

See SAP Note 955498 on this.



EBPP_SE_TRADE_RECEIV_OPEN_RDQR.




Find Cleared Item by Customer

Technical Data

Entity Type

Technical Name in Enterprise Services Repository

(ESR)



Category

Mode


Operation

TradeReceivablesPayablesAccountCustomerClea redItemByCustomerQueryResponse_In http://sap.com/xi/APPL/SE/Global

ESA ECC SE 600

Inbound

Synchronous

ECC_TRPAccountCleaItemByCusQR

Definition

Query of paid items of a customer.

Use

The inbound operation Find Cleared Item by Customer receives inquiries the from bill recipient regarding his paid receivables and payables. It then returns the corresponding receivables and payables from the biller to the bill recipient.

Features


TradeReceivablesPayablesAccountCustomerClearedItemByCustomerQuery_sync

TradeReceivablesPayablesAccountCustomerClearedItemByCustomerResponse_sync


The message TradeReceivablesPayablesAccountCustomerClearedItemByCustomer-

Query_sync contains the following information:


Company that issued the bill

Period in which the due dates of the receivables and payables ought to fall (optional)

Currency in which the receivables and payables should be specified

The message TradeReceivablesPayablesAccountCustomerClearedItemByCustomer-

Response_sync contains the following information:

General information:

Currency in which the receivables and payables are specified

Period in which the due dates of the receivables and payables fall


Description of the business partner who is the bill recipient

Information on the individual payables that are represented by at least one split item, for example:



Identifier

Creation date


Due date

Description

Reference to the business document that underlies the payable.


Identifier

Creation date


Validity date

Description

Reference to the business document that underlies the receivable.


Identifier

Validity date

Execution status


Description of payment method

Payment method

Bank or credit card information (optional)

Information on clearing of payments, receivables and payables

Identifier

Status

Assignment which payables are cleared by which payments

Assignment which payables are cleared by which receivables

Integration

This inbound operation belongs to the inbound service interface Query Trade Receivables

Payables Account In [Seite 582 ] .

Constraints

It is not always possible to provide complete credit card information and bank details

Specification of the display currency ( ReportingCurrency ) is not yet supported.



Note the information on constraints outlined in SAP Note 955497 .



EBPP_SE_TRADE_RECEIV_CLEA_RDQR.


Expense and Reimbursement Management

Technical Data

Entity Type




Definition

A process component for the management of employee expense reports and expense reimbursements to those employees.

Use

The Expense and Reimbursement Management process component generally has the following features:

Reviewing of expense reports of internal or external employees

Consideration of legal requirements and corporate policies

Payment of reimbursement amounts to employees

Transfer of expense reports to the Financial Accounting system

Transfer of taxable amounts to the Payroll system (for internal employees only)

The mySAP ERP enterprise services package software component merely provides the service interfaces for designating substitutes for expense reports. For more information, see

Query Expense Arrangement [Seite 588 ] and Manage Expense Arrangement [Seite 590 ] .

Expense Arrangement

Technical Data

Entity Type






Definition

A business object for configuring and determining employee data relevant for expense reports.

Use

The Expense Arrangement business object is generally used to determine the per diem amounts for the expense reports of an employee, and to configure the standard cost assignments in the company.

An expense reporter can designate one or more substitute reporter(s) who are able to enter expense reports in his or her place. Expense arrangements contain the data necessary for this purpose.

The mySAP ERP enterprise services package software component merely provides the service interfaces for designating substitutes for expense reporters. For more information, see

Query Expense Arrangement [Seite 588 ] and Manage Expense Arrangement [Seite 590 ] .

Query Expense Arrangement In

Technical Data

Entity Type


Category

Mode



Inbound

Synchronous

Definition

An interface for determining substitutes for expense reports.

Use

The Query Expense Arrangement In inbound service interface combines operations that find the present expense arrangement of an employee and, as a result, determine which substitutes are assigned for the expense report.

An expense reporter substitute is an employee who is authorized by another employee

(expense reporter) to report his or her expenses for a specific time period. The system saves the assignment of one or more substitutes in the expense arrangement of the employee that designates those substitutes.


Manage Expense Arrangement [Seite 590 ]

Integration

The Query Expense Arrangement In inbound service interface belongs to the Expense and

Reimbursement Management [Seite 587 ] process component and to the Expense

Arrangement [Seite 587 ] business object.

This inbound service interface along with the Manage Expense Arrangement inbound service interface forms the Expense Reporter Substitute Interface , which is needed in an A2X process (between SAP and composite applications) to find and create a substitute for expense reporting, or to cancel a substitute.



Structure

The inbound service interface groups the following inbound operations together:

ExpenseArrangementSimpleByEmployeeQueryResponse_In ( Find Expense

Arrangement by Employee [Seite 589 ] )

ExpenseArrangementExpenseReporterSubstituteByExpenseArrangement-

QueryResponse_In ( Find Expense Reporter Substitute by Expense Arrangement [Seite

590 ] )

The inbound operations use ExpenseArrangementID as a synonym for

ExpenseReporterID .

Find Expense Arrangement by Employee

Technical Data

Entity Type





Category

Mode


Service operation

ExpenseArrangementSimpleByEmployee-

QueryResponse_In http://sap.com/xi/Travel/SE/Global


Inbound

Synchronous

ECC_PTRMEXPARRGNGMNTBYIDQR

Definition

An operation that finds the expense arrangement for an employee.

Use

The Find Expense Arrangement by Employee inbound operation passes the expense arrangement for the specified employee.

Features

This operation processes the following message types:

ExpenseArrangementSimpleByEmployeeQuery

ExpenseArrangementSimpleByEmployeeResponse


Integration

This inbound operation belongs to the Query Expense Arrangement [Seite 588 ] inbound service interface.



Find Expense Reporter Substitute by Expense

Arrangement

Technical Data

Entity Type





Category

Mode


Service operation

ExpenseArrangementExpenseReporter-

SubstituteByExpenseArrangementQuery-

Response_In http://sap.com/xi/Travel/SE/Global


Inbound

Synchronous

ECC_PTRMSUBSTITUTEBYIDQR

Definition

An operation that finds existing expense report substitutes for an employee.

Use

The Find Expense Reporter Substitute by Expense Arrangement inbound operation passes the expense reporter substitutes designated in the expense arrangement of an employee

(expense reporter).

Features



Query


Response


Integration

This inbound operation belongs to the Query Expense Arrangement [Seite 588 ] inbound service interface.

Manage Expense Arrangement

Technical Data



SAP Documentation


Category

Mode

Enterprise SOA mySAP ERP enterprise services package


Inbound

Synchronous

Definition

A service interface for creating or canceling a substitute for expense reports.

Use

The Manage Expense Arrangement inbound service interface combines operations that enable an expense reporter to designate another employee as his or her substitute for reporting expenses for a specific time period, or to cancel such a substitute.

The system saves the assignment of one or more substitutes in the expense arrangement of the employee who designates those substitutes.


Query Expense Arrangement [Seite 588 ]

Integration

The Manage Expense Arrangement inbound service interface belongs to the Expense and

Reimbursement Management [Seite 587 ] process component and to the Expense

Arrangement [Seite 587 ] business object.

This inbound service interface along with the Query Expense Arrangement inbound service interface forms the Expense Reporter Substitute Interface , which is needed in an A2X process (between SAP and composite applications) to find and create a substitute for expense reporting, or to cancel a substitute.

Constraints

Note the following constraints:

Only the expense reporter can create and cancel his or her own substitutes.

The personnel numbers of employees and their substitutes must be eight (8) digits in length.

Structure

The Manage Expense Arrangement inbound service interface groups the following inbound operations together:

ExpenseArrangementExpenseReporterSubstituteCreateRequestConfirmation

( Create Expense Reporter Substitute [Seite 592 ] )

ExpenseArrangementExpenseReporterSubstituteCancelRequestConfirmation

( Cancel Expense Reporter Substitute [Seite 593 ] )

The inbound operations use ExpenseArrangementID as a synonym for

ExpenseReporterID .



Create Expense Reporter Substitute

Technical Data

Entity Type





Category

Mode


Service operation


SubstituteCreateRequestConfirmation_In http://sap.com/xi/Travel/SE/Global


Inbound

Synchronous

ECC_PTRMSUBSTITUTECRTRC

Definition

An operation to create a substitute reporter for expense reports.

Use

The Create Expense Reporter Substitute inbound operation passes the expense reporter’s substitute and the applicable time period for the expense reporter who is to be substituted.

An expense reporter can have multiple substitute reporters.

If the substitute is already defined for a different time period, the system merely updates the substitution time period.

Features

The Create Expense Reporter Substitute inbound operation processes the following message types:

ExpenseArrangementExpenseReporterSubstituteCreateRequest

Although this service's input message type contains an element

MessageHeader/UUID , the service does not support idempotent behavior as described in the mySAP Service Provisioning handbook. Since support for idempotent behavior may be added in the future, we recommend that you do not use this UUID element for the time being.

ExpenseArrangementExpenseReporterSubstituteCreateConfirmation


If the e-mail address is specified in infotype 105, subtype 10 (e-mail), the system notifies the substitute via e-mail (and sends a copy to the employee who created or canceled the substitute). To enable the system to send an e-mail message, the INT node in SAPconnect:

Administration (transaction SCOT) needs to be configured accordingly.

Integration

This inbound operation belongs to the Manage Expense Arrangement [Seite 590 ] inbound service interface.



Cancel Expense Reporter Substitute

Technical Data

Entity Type





Category

Mode


Service operation


SubstituteCancelRequestConfirmation_In http://sap.com/xi/Travel/SE/Global


Inbound

Synchronous

ECC_PTRMSUBSTITUTECNCRC

Definition

An operation to cancel a substitute reporter for expense reports.

Use

The Cancel Expense Reporter Substitute inbound operation passes for an expense reporter the expense reporter’s substitute who should no longer act as a substitute for expense reports.

The system removes the substitute from the expense arrangement of the expense reporter.

Features

The Cancel Expense Reporter Substitute inbound operation processes the following message types:

ExpenseArrangementExpenseReporterSubstituteCancelRequest

ExpenseArrangementExpenseReporterSubstituteCancelConfirmation


Integration

This inbound operation belongs to the Manage Expense Arrangement [Seite 590 ] inbound service interface.

Internal Control Management

Technical Data

Entity Type


Process component

As of FINBASIS 600 SP07



Definition

Assessment and sign-off of the internal control system to achieve compliance with the software requirements laid out in the Sarbanes-Oxley Act (SOA).

Use

The Internal Control Management process component gives you the option of making applications available that you can use in the Management of Internal Controls (MIC) component to document controls, processes, and management controls, and to sign off on all of these.

The interfaces offer the following:

You can selectively enrich the processes accepted from an organizational unit with P-

CO-R-C information and with financial statement assertions.

You can perform assessments externally and have them validated, while transferring the results to MIC.

You can create and change issues in MIC, and you can have remediation plans validated externally.

You can perform sign-off in an external system.


Prerequisites

To use the interfaces of this process component, you need to have implemented the

FINBASIS 600 software component as of Support Package 7, and you also have to be using the Management of Internal Controls (FIN-CGV-MIC) application component.

All central settings must have been made for MIC. The organizational units need to have accepted the settings relevant for your needs.

Processing

The following information is relevant for all operations belonging to this process component:

Idempotent Behavior

Although the input message types of the operations of this process component contain a

MessageHeader/UUID element, the operations do not support idempotent behavior as described in the mySAP Service Provisioning handbook. Since support for idempotent behavior may be added in the future, we recommend that you do not use this UUID element for the time being.

Behavior of Change and Update Operations

The data transferred by request messages overwrites only those affected objects in the databases of the backend system that are also filled in the message structure. This also applies to the individual items of list-like elements.

The effect is that if optional elements are not filled in a request message, then the backend system leaves the existing values as they are in the affected fields on the database. The only exception to this behavior is when these values are automatically updated due to changes to other data.



Business Process Internal Control

Technical Data

Entity Type


Business object


Definition

View of a business process with regard to internal controls. Only those business processes are relevant for internal controls that are directly or indirectly related either to financial reporting or to disclosure controls and procedures.

Use

In Management of Internal Controls (MIC), there is a need not only for the documentation of all existing controls within one company, but also a need to test and assess the completeness and correctness of those controls. Most of these controls belong to a business process

( Business Process Internal Control) . Certain information about the business process is essential for being able to assess these controls. Therefore the data of the business process can be requested from an external audit system.


Prerequisites

The processes are created in MIC.

Manage Business Process Internal Control In

Technical Data

Entity Type


Category

Mode

Service Interface


Inbound

Synchronous

Definition

Group of operations that create, change, delete, or update a Business Process Internal

Control or parts of it.

Use

The inbound service interface groups operations that receive the following data:

Information about the Business Process Internal Control business object.

Assignment of the process to control objectives, risks, and controls (P-CO-R-C structure)

Assignment of the process to account groups, controls, and financial statement assertions



Prerequisites

Structure setup is complete in MIC.

Integration

The Manage Internal Control Business Process In inbound service interface belongs to the

Internal Control Management [Seite 593 ] process component and to the Business Process

Internal Control [Seite 595 ] business object.

Structure


BusinessProcessInternalControlByIDQueryResponse_In ( Read Business Process

Internal Control [Seite 596 ] )

BusinessProcessInternalControlControlActivityObjectiveRiskControlActivityRiskAssign mentByIDQueryResponse_In ( Read Business Process Internal Control Risk


BusinessProcessInternalControlItemControlActivityChartOfAccountsItemGroupAsserti onByIDQueryResponse_In ( Read Business Process Internal Control Account Group

[Seite 598 ] )

Read Business Process Internal Control

Technical Data

Entity Type





Category

Mode


Operation

BusinessProcessInternalControlByIDQueryRes ponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_BPIC_QR

Definition

Reads information of a Business Process Internal Control.

Use

The Read Business Process Internal Control inbound operation receives the:

Data of the process

Roles of the process

Process steps of the process

Management controls of the superordinate process group

Assigned account groups of the process



Features


BusinessProcessInternalControlByIDQuery_sync

This message contains the following data:

MessageHeader that does not have to be filled

The ID of the process, which must be filled

An optional time restriction using StartDate/EndDate

BusinessProcessInternalControlByIDResponse_sync

StandardFaultMessage

Integration

This inbound operation belongs to the Manage Business Process Internal Control In [Seite


Read Business Process Internal Control Risk

Assignment

Technical Data

Entity Type





Category

Mode


Operation

BusinessProcessInternalControlControlActivity

ObjectiveRiskControlActivityRiskAssignmentBy

IDQueryResponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_BPIC_CORC_QR

Definition

Reads the P-CO-R-C structure of a Business Process Internal Control .

Use

The Read Business Process Internal Control Risk Assignment inbound operation receives information on the assignment of a control objective (CO) and its risks (R) belonging to a process, as well as the assignment of controls (C) to the risks.

The operation receives the following data:

Header data (ID, name) of the process

Header data of the assigned control objectives

Header data of the assigned risks



Header data of the controls assigned to the risks

Features


BusinessProcessInternalControlControlActivityObjectiveRiskControlActivityRiskAssign mentByIDQuery_sync





BusinessProcessInternalControlControlActivityObjectiveRiskControlActivityRiskAssign mentByIDResponse_sync


Integration



Read Business Process Internal Control Account

Technical Data

Entity Type





Category

Mode


Operation

BusinessProcessInternalControlItemControlAct ivityChartOfAccountsItemGroupAssertionByID

QueryResponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_BPIC_ACC_ASSERT_QR

Definition

Reads the account groups and financial statement assertions of a Business Process Internal

Control.

Use

The Read Business Process Internal Control Account Group inbound operation receives information about the assignment of account groups and financial statement assertions to a process, as well as the assignment of the financial statement assertions to controls.

The operation receives the following data:



Header data (ID, name) of the process

Header data of the assigned process steps

Header data of the assigned process steps that are controls

Header data of the account groups with their financial statement assertions that are assigned to controls

Features


BusinessProcessInternalControlItemControlActivityChartOfAccountsItemGroupAsserti onByIDQuery_sync





BusinessProcessInternalControlItemControlActivityChartOfAccountsItemGroupAsserti onByIDResponse_sync


Integration



Control Activity Assessment

Technical Data

Entity Type


Business object


Definition

Evaluation of an action for a control purpose that is performed within a business process. This evaluation is performed for internal controls and comprises the assessment of the completeness and likelihood of error in the design of the control activity.

Use

In Management of Internal Controls (MIC), there is a need not only for the documentation of all existing controls within one company, but also a need to test and assess the completeness and correctness of those controls. For controls that are assigned to a business process, validation of the assessment of these controls can be performed as a self service from an external system. The assessment itself can be requested from an external system, such as another audit system.


SAP Documentation


Prerequisites

The given assessment is scheduled in MIC.

Enterprise SOA

Query Control Activity Assessment In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations for searching with helpful selection criteria across individual interfaces of

Control Activity Assessment .

Use

The Query Control Activity Assessment In inbound service interface groups operations that can be used to query assessments of controls.

Integration

The Query Control Activity Assessment In inbound service interface belongs to the Internal

Control Management [Seite 593 ] process component and to the Control Activity Assessment


Structure

The inbound service interface contains the

ControlActivityAssessmentByBusinessProcessInternalControlIDQueryResponse_In inbound operation ( Find Control Activity Assessment by Internal Control [Seite 600 ] ).

Find Control Activity Assessment by Internal

Control

Technical Data

Entity Type





Category

Operation

ControlActivityAssessmentBy

BusinessProcessInternalControlIDQueryRespo nse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound


SAP Documentation

Mode


Enterprise SOA

Synchronous

FINB_CA_ASSMNT_BY_BPIC_QR

Definition

Reads each Control Activity Assessment that has controls belonging to a Business Process

Internal Control .

Use

The Find Control Activity Assessment by Internal Control inbound operation receives all assessments within a timeframe for all controls that belong to a process.

Features


ControlActivityAssessmentByBusinessProcessInternalControlIDQuery_sync




The timeframe, which must be filled

ControlActivityAssessmentByBusinessProcessInternalControlIDResponse_sync


Integration

This inbound operation belongs to the Query Control Activity Assessment In [Seite 600 ] inbound service interface.

Manage Control Activity Assessment In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations that create, change, delete, or update a Control Activity Assessment or parts of it.



Use

The Manage Control Activity Assessment In inbound service interface groups operations that can be used to read the assessment of a control. This enables validation of assessments, for example.

Integration

The Manage Control Activity Assessment In inbound service interface belongs to the Internal



Structure


ControlActivityAssessmentByIDQueryResponse_In inbound operation ( Read Control Activity

Assessment [Seite 602 ] ).

Read Control Activity Assessment

Technical Data

Entity Type





Category

Mode


Operation

ControlActivityAssessmentByIDQueryRespons e_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_CA_ASSMNT_BY_ID_QR

Definition

Reads information of a Control Activity Assessment .

Use

The Read Control Activity Assessment inbound operation receives all data of an assessment.

Features


ControlActivityAssessmentByIDQuery_sync



The ID of the assessment, which must be filled

ControlActivityAssessmentByIDResponse_sync




Integration

This inbound operation belongs to the Manage Control Activity Assessment In [Seite 601 ] inbound service interface.

Action Control Activity Assessment In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations that execute activities on Control Activity Assessment .

Use

The Action Control Activity Assessment In inbound service interface groups operations that can be used to validate the assessment of a control.

Integration

The Action Control Activity Assessment In inbound service interface belongs to the Internal



Structure


ControlActivityAssessmentValidateRequestConfirmation_In inbound operation ( Validate

Control Activity Assessment [Seite 603 ] ).

Validate Control Activity Assessment

Technical Data

Entity Type





Category

Mode


Operation

ControlActivityAssessmentValidateRequestCon firmation_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_CA_ASSMNT_VALIDATE_QR



Definition

Validates the assessment of a control.

Use

The Validate Control Activity Assessment inbound operation receives data that can be used to store the validation of an assessment in MIC.

Features


ControlActivityAssessmentValidateRequest_sync



ID of the assessment, which must be filled

StatusCode; sets the status and must be filled, either with 3 for Rework or 4 for

Validated

ValidationCommentNote , does not have to be filled, passes on comment for validation

ControlActivityAssessmentValidateConfirmation_sync


Integration

This inbound operation belongs to the Action Control Activity Assessment In [Seite 603 ] inbound service interface.

Business Process Internal Control Assessment

Technical Data

Entity Type


Business object


Definition

Evaluation considering internal controls. This evaluation comprises the assessment of the completeness and likelihood of error in the design of a business process.

Use

In Management of Internal Controls (MIC), there is a need not only for the documentation of all existing controls within one company, but also a need to test and assess the completeness and correctness of those controls. In addition, the business process, to which the control activities belong, is assessed. This assessment can be performed as a self service from an external audit system.


SAP Documentation


Prerequisites

Assessment of the process design is scheduled in MIC.

Enterprise SOA

Manage Business Process Internal Control

Assessment In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations that create, change, delete, or update a Business Process Internal

Control Assessment or parts of it.

Use

The Manage Business Process Internal Control Assessment In inbound service interface groups operations that can be used to read and execute assessments.

Integration

The Manage Business Process Internal Control Assessment In inbound service interface belongs to the Internal Control Management [Seite 593 ] process component and to the

Business Process Internal Control Assessment [Seite 604 ] business object.

Structure


BusinessProcessInternalControlAssessmentByIDQueryResponse_In ( Read Business

Process Internal Control Assessment [Seite 605 ] )

BusinessProcessInternalControlAssessmentChangeRequestConfirmation_In ( Change

Business Process Internal Control Assessment [Seite 606 ] )

BusinessProcessInternalControlAssessmentAttachmentByIDQueryResponse_In

( Read Business Process Internal Control Assessment Attachment [Seite 608 ] )

BusinessProcessInternalControlAssessmentAttachmentCreateRequestConfirmation_I n ( Create Business Process Internal Control Assessment Attachment [Seite 607 ] )

BusinessProcessInternalControlAssessmentAttachmentCancelRequestConfirmation_I n ( Cancel Business Process Internal Control Assessment Attachment [Seite 609 ] )



SAP Documentation

Assessment

Technical Data

Entity Type





Category

Mode


Enterprise SOA

Operation

BusinessProcessInternalControlAssessmentBy

IDQueryResponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_BPIC_ASSMNT_QR

Definition

Reads information of a Business Process Internal Control Assessment.

Use

Die Read Business Process Internal Control Assessment inbound operation receives data for process design assessment.

Features


BusinessProcessInternalControlAssessmentByIDQuery_sync




BusinessProcessInternalControlAssessmentByIDResponse_sync


Integration

This inbound operation belongs to the Manage Business Process Internal Control

Assessment In [Seite 605 ] inbound service interface.

Change Business Process Internal Control

Assessment

Technical Data

Entity Type



Operation

BusinessProcessInternalControlAssessmentCh angeRequestConfirmation_In


SAP Documentation



Category

Mode


Enterprise SOA http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_BPIC_ASSMNT_CHGRC

Definition

Change to a Business Process Internal Control .

Use

The Change Business Process Internal Control Assessment inbound operation receives a change request and executes it.

Features


BusinessProcessInternalControlAssessmentChangeRequest_sync




BusinessProcessInternalControlAssessmentChangeConfirmation_sync


Create Internal Control Assessment Attachment

Technical Data

Entity Type





Category

Mode


Operation

BusinessProcessInternalControlAssessmentAtt achmentCreateRequestConfirmation_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_BPIC_AS_ATTACH_CRTRC

Definition

Creates an attachment to a Business Process Internal Control Assessment



Use

The Create Internal Control Assessment Attachment inbound operation receives data for creating a link or document that is then attached to a process assessment.

Features


BusinessProcessInternalControlAssessmentAttachmentCreateRequest_sync




DocumentCategoryCode, which must be filled, either with 2 for a document, or

3 for a link

DocumentName, which must be filled (contains the name of the attachment)

FileContentBinaryCode, which must be filled if a document is uploaded, but which is not allowed to be filled if a link is uploaded. The field contains the document contents as XSTRING.

DocumentPathName, which must be filled if a link is uploaded, but which is not allowed to be filled if a document is uploaded. The field contains the URL of the link.

BusinessProcessInternalControlAssessmentAttachmentCreateConfirmation_sync



Assessment Attachment

Technical Data

Entity Type





Category

Mode


Operation

BusinessProcessInternalControlAssessmentAtt achmentByIDQueryResponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_BPIC_AS_ATTACH_QR

Definition

Reads the attachments of a Business Process Internal Control.



Use

The Read Business Process Internal Control Assessment Attachment inbound operation receives all documents and links that were assigned as attachments to an assessment, its issues, and their remediation plans.

Features


BusinessProcessInternalControlAssessmentAttachmentByIDQuery_sync




BusinessProcessInternalControlAssessmentAttachmentByIDResponse_sync


Cancel Business Process Internal Control

Assessment Attachment

Technical Data

Entity Type





Category

Mode


Operation

BusinessProcessInternalControlAssessmentAtt achmentCancelRequestConfirmation_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_BPIC_AS_ATTACH_CNCRC

Definition

Deletes an attachment to a Business Process Internal Control Attachment .

Use

The Cancel Business Process Internal Control Assessment Attachment inbound operation receives a request for deleting a link or document that was attached to an assessment, and then the operation executes this request.

Features


BusinessProcessInternalControlAssessmentAttachmentCancelRequest_sync






DocumentCategoryCode, which must be filled

AttachmentID, which must be filled

You receive the AttachmentID and DocumentCategoryCode using the

BusinessProcessInternalControlAssessmentAttachmentByIDQueryResponse_In request.

BusinessProcessInternalControlAssessmentAttachmentCancelConfirmation_sync


Management Control Assessment

Technical Data

Entity Type


Business object


Definition

Evaluation of an action for a control purpose that is performed independently of individual business processes on a management level. This evaluation is performed under the aspect of internal control and comprises the assessment of the completeness and likelihood of error in the design of the management control.

Use

In Management of Internal Controls (MIC), there is a need not only for the documentation of all existing controls within one company, but also a need to test and assess the completeness and correctness of those controls. For permanent controls that do not belong to a single business process, the assessment and test of these management controls can be processed using self service in an external system.


Prerequisites

Assessment of management controls is scheduled in MIC.

Query Management Control Assessment In

Technical Data

Entity Type


Service interface

As of FINBASIS 600


SAP Documentation

Category

Mode

Inbound

Synchronous

Enterprise SOA

Definition

Group of operations for searching with helpful selection criteria across individual interfaces of

Management Control Assessment .

Use

The Query Management Control Assessment In inbound service interface groups operations that can be used to query assessments and tests of management controls.

Integration

The Query Management Control Assessment In inbound service interface belongs to the

Internal Control Management [Seite 593 ] process component and to the Management Control

Assessment [Seite 610 ] business object.

Structure


ManagementControlAssessmentSimpleByElementsQueryResponse_In ( Find Management

Control Assessment by Manager [Seite 611 ] ) inbound operation.

Find Management Control Assessment by

Elements

Technical Data






Category

Mode


ManagementControlAssessmentSimpleByElem entsQueryResponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_MC_ASSMNT_BY_ELEMENTS_QR

Definition

Reads every Management Control Assessment that has management controls belonging to a certain organizational unit or process group.

Use

The Find Management Control Assessment by Elements inbound operation receives all assessments and tests within a timeframe for all management controls that belong to a certain organizational unit or process group.



Features


ManagementControlAssessmentSimpleByElementsQuery_sync



A time limitation using StartDate/EndDate , which must be filled

An organizational unit, which only has to be filled for management controls on the organizational unit level

A process group, which only has to be filled for management controls on the process group level

ManagementControlAssessmentSimpleByElementsResponse_sync


Integration

This inbound operation belongs to the Query Management Control Assessment In [Seite 610 ] inbound service interface.

Manage Management Control Assessment In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations that create, change, delete, or update a Management Control

Assessment or parts of it.

Use

The Manage Management Control Assessment inbound service interface groups operations that can be used to assess or test management controls.

Integration

The Manage Management Control Assessment inbound service interface belongs to the

Internal Control Management [Seite 593 ] process component and to the Management Control

Assessment [Seite 610 ] business object.

Structure




ManagementControlAssessmentByIDQueryResponse_In ( Read Management Control

Assessment [Seite 613 ] )

ManagementControlAssessmentChangeRequestConfirmation_In ( Change

Management Control Assessment [Seite 614 ] )

Read Management Control Assessment

Technical Data

Entity Type





Category

Mode


Operation

ManagementControlAssessmentByIDQueryRe sponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_MC_ASSMNT_BY_ID_QR

Definition

Reads the information of a Management Control Assessment .

Use

The Read Management Control Assessment inbound operation receives all data of an assessment or for a test of a management control.

Features


ManagementControlAssessmentByIDQuery_sync



The ID of the assessment or test, which must be filled

ManagementControlAssessmentByIDResponse_sync


Integration

This inbound operation belongs to the Manage Management Control Assessment In [Seite




Change Management Control Assessment

Technical Data

Entity Type





Category

Mode


Operation

ManagementControlAssessmentChangeReque stConfirmation_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_MC_ASSMNT_CHGRC

Definition

Changes a Management Control Assessment .

Use

The Change Management Control Assessment inbound operation receives data that can be used to change and validate an assessment or a test of management controls.

Features


ManagementControlAssessmentChangeRequest_sync


MessageHeader , not required

Title , optional

Note , optional, corresponds to Comment field

Status , optional; possible values:

2 = Review

3 = Rework

4 = Validated

5 = Submitted

TestExecutionDate , optional, only for tests of management controls

ValidationNote , optional, modifiable only in Review status

ManagementControlAssessmentChangeConfirmation_sync


Integration

This inbound operation belongs to the Manage Management Control Assessment In [Seite




Internal Control Issue

Technical Data

Entity Type


Business object


Definition

Shortcoming related to a control, a management control, or a business process that has been discovered by an internal control assessment.

Use

In Management of Internal Controls (MIC), there is a need not only for the documentation of all existing controls within one company, but also a need to test and assess the completeness and correctness of those controls. When the control assessor detects a problem during his assessment, he can report this issue in an external audit system and thereby enter the issue in MIC.

Query Internal Control Issue In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations for searching with helpful selection criteria across individual interfaces of the Internal Control Issue .

Use

The Query Internal Control Issue In inbound service interface groups operations that can be used to query issues that were identified during assessment and test of the internal control system.

Prerequisites

Issues are entered in MIC.

Integration

The Query Internal Control Issue In inbound service interface belongs to the Internal Control

Management [Seite 593 ] process component and to the Internal Control Issue [Seite 615 ] business object.



Structure


InternalControlIssueSimpleByReportingLineUnitQueryResponse_In ( Find Issue by

Reporting Line Unit [Seite 616 ] )

InternalControlIssueByManagementControlAssessmentQueryResponse_In ( Find Issue by Management Control Assessment [Seite 617 ] )

Find Issue by Reporting Line Unit

Technical Data

Entity Type





Category

Mode


Operation

InternalControlIssueSimpleByReportingLineUni tQueryResponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_IC_ISSUE_BY_RLU_QR

Definition

Reads every Internal Control Issue belonging to an organizational unit.

Use

The Find Issue by Reporting Line Unit inbound operation receives the data needed for reading all issues that were reported within an organizational unit for a given timeframe.

Features


InternalControlIssueSimpleByReportingLineUnitQuery_sync



The ID of the organizational unit, which must be filled

Timeframe (start and end date), which does not have to be filled. If you do not enter a timeframe, then the system reads the data for the currently valid timeframe.

InternalControlIssueSimpleByReportingLineUnitResponse_sync




Integration

This inbound operation belongs to the Query Internal Control Issue In [Seite 615 ] inbound service interface.

Find Issue by Management Control Assessment

Technical Data

Entity Type





Category

Mode


Operation

InternalControlIssueByManagementControlAss essmentQueryResponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_IC_ISSUE_BY_MCA_QR

Definition

Reads every Internal Control Issue for a Management Control Assessment .

Use

The Find Issue by Management Control Assessment inbound operation receives the data needed for reading all issues that were reported during the assessment or testing of a management control.

Features


InternalControlIssueByManagementControlAssessmentQuery_sync



The ID of the assessment of the management control, which must be filled

InternalControlIssueByManagementControlAssessmentResponse_sync


Integration

This inbound operation belongs to the Query Internal Control Issue In [Seite 615 ] inbound service interface.



Manage Internal Control Issue In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations that create, change, delete, or update an Internal Control Issue or parts of it.

Use

The Manage Internal Control Issue In inbound service interface groups operations that can be used to report, change, delete, or read issues that were identified during assessment and test of the internal control system.

Integration

The Query Internal Control Issue In inbound service interface belongs to the Internal Control

Management [Seite 593 ] process component and to the Internal Control Issue [Seite 615 ] business object.

Structure


InternalControlIssueByIDQueryResponse_In ( Read Issue [Seite 618 ] )

InternalControlIssueCreateRequestConfirmation_In ( Create Issue [Seite 619 ] )

InternalControlIssueChangeRequestConfirmation_In ( Change Issue [Seite 620 ] )

InternalControlIssueCancelRequestConfirmation_In ( Cancel Issue [Seite 621 ] )

Read Issue

Technical Data

Entity Type





Category

Mode


ES for SAP ERP 2005

Operation

InternalControlIssueByIDQueryResponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_IC_ISSUE_BY_ID_QR

618


Definition

Reads an Internal Control Issue .

Use

The Read Issue inbound operation reads the data of an issue.

Features


InternalControlIssueByIDQuery_sync



The ID of the issue, which must be filled

InternalControlIssueByIDResponse_sync


Integration

This inbound operation belongs to the Manage Internal Control Issue In [Seite 618 ] inbound service interface.

Create Issue

Technical Data

Entity Type





Category

Mode


Operation

InternalControlIssueCreateRequestConfirmatio n_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_IC_ISSUE_CRTQR

Definition

Creates an Internal Control Issue .

Use

The Create Issue inbound operation receives data that can be used to report an issue in MIC.

You can enter an issue for all assessments in the system:

Control Activity Assessment [Seite 599 ]



Business Process Internal Control Assessment [Seite 604 ]

Management Control Assessment [Seite 610 ]

Features


InternalControlIssueCreateRequest_sync



ID of the assessment for which the issue is being created (required entry)

The name of the issue, which does not have to be filled

A comment ( Note ) for the issue, which does not have to be filled

Priority of the issue, which can be filled with: 1 for low , 2 for medium or 3 for high

The implication ( ImplicationNote ), which does not have to be filled

The compensating control ( CompensatingControlNote ), which does not have to be filled

The processor of the issue, which does not have to be filled

InternalControlIssueCreateConfirmation_sync


Integration

This inbound operation belongs to the Manage Internal Control Issue In [Seite 618 ] inbound service interface.

Change Issue

Technical Data

Entity Type





Category

Mode


Operation

InternalControlIssueChangeRequestConfirmati on_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_IC_ISSUE_CHGQR



Definition

Changes an Internal Control Issue .

Use

The Change Issue inbound operation receives data that can be used to change an issue in

MIC.

Features


InternalControlIssueChangeRequest_sync




The name of the issue, which does not have to be filled

The status of the issue, which does not have to be filled

A comment ( Note ) for the issue, which does not have to be filled

Priority of the issue, which can be filled with: 1 for low , 2 for medium or 3 for high

The implication ( ImplicationNote ), which does not have to be filled

The compensating control ( CompensatingControlNote ), which does not have to be filled

A comment, if a remediation plan is not required for the issue

( NoRemediationPlanNote )

The processor of the issue, which does not have to be filled

InternalControlIssueChangeConfirmation_sync


Integration

This inbound operation belongs to the Manage Internal Control Issue In inbound service interface.

Cancel Issue

Technical Data

Entity Type





ES for SAP ERP 2005

Operation

InternalControlIssueCancelRequestConfirmatio n_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

621

SAP Documentation

Category

Mode


Inbound

Synchronous

FINB_IC_ISSUE_CNCQR

Enterprise SOA

Definition

Deletes an Internal Control Issue .

Use

The Cancel Issue inbound operation receives data that can be used to delete an issue in MIC.

Features


InternalControlIssueCancelRequest_sync




InternalControlIssueCancelConfirmation_sync


Integration

This inbound operation belongs to the Manage Internal Control Issue In inbound service interface.

Entries for Internal Control Issue Allowed

Responsible In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations that provide a list of allowed entries, restricted by additional criteria, for the user of an Internal Control Issue .

Use

The Entries for Internal Control Issue Allowed Responsible In inbound service interface groups operations that determine the person who is allowed to process an issue.



Integration

The Entries for Internal Control Issue Allowed inbound service interface belongs to the

Internal Control Management [Seite 593 ] process component and to the Internal Control Issue


Structure


InternalControlIssueAllowedResponsibleQueryResponse_sync ( Find Allowed Responsible

[Seite 623 ] ) inbound operation.

Find Allowed Responsible

Technical Data

Entity Type





Category

Mode


Operation

InternalControlIssueAllowedResponsibleQuery

Response_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_IC_ISSUE_RESPONSIBLE_QR

Definition

Reads the person responsible for an Internal Control Issue .

Use

The Find Allowed Responsible inbound operation receives data that can be used to select the processor of an issue.

Features


InternalControlIssueAllowedResponsibleQuery_sync



The name of the person ( ResponsibleName ) as text search field (by string). For example, if you enter Mill , then the system returns Mills, Miller , and so on.

A start and end date (for a time restriction), which does not have to be filled

InternalControlIssueAllowedResponsibleResponse_sync




Integration

This inbound operation belongs to the Entries for Internal Control Issue Allowed Responsible

In [Seite 622 ] inbound service interface.

Internal Control Remediation Plan

Technical Data

Entity Type


Business object


Definition

Plan defining measures to remediate an internal control issue.

Use

In Management of Internal Controls (MIC), there is a need not only for the documentation of all existing controls within one company, but also a need to test and assess the completeness and correctness of those controls. When the control assessor detects a problem during his assessment, he reports this issue, which then has to be corrected using a remediation plan.

Once the remediation plan is created, the owner of the issue has to validate the remediation plan before the plan can be executed. This validation can take place as a self service from an external system.

Manage Internal Control Issue Remediation Plan In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations that create, change, delete, or update an Internal Control Issue

Remediation Plan or parts of it.

Use

The Manage Internal Control Issue Remediation Plan In inbound service interface groups operations that can be used to read a remediation plan. This enables validation of the remediation plan, for example.

Prerequisites

There is a remediation plan in MIC with the status Review .



Integration

The Manage Internal Control Issue Remediation Plan In inbound service interface belongs to the Internal Control Management [Seite 593 ] process component and to the Internal Control

Issue Remediation Plan [Seite 624 ] business object.

Structure


InternalControlIssueRemediationPlanByIDQueryResponse_sync ( Read Remediation Plan

[Seite 625 ] ) inbound operation.

Read Remediation Plan

Technical Data

Entity Type





Category

Mode


Operation

InternalControlIssueRemediationPlanByIDQuer yResponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_IC_ISSUE_REMPLAN_QR

Definition

Reads an Internal Control Issue Remediation Plan .

Use

The Read Remediation Plan inbound operation receives data of a remediation plan.

Features


InternalControlIssueRemediationPlanByIDQuery_sync



The ID of the remediation plan, which must be filled

InternalControlIssueRemediationPlanByIDResponse_sync


Integration

This inbound operation belongs to the Manage Internal Control Issue Remediation Plan In




Action Internal Control Issue Remediation Plan In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations that execute activities on Internal Control Issue Remediation Plan .

Use

The Action Internal Control Issue Remediation Plan In inbound service interface groups operations that can be used to validate the assessment of a remediation plan.

Integration

The Action Internal Control Issue Remediation Plan In inbound service interface belongs to the Internal Control Management [Seite 593 ] process component and to the Internal Control

Issue Remediation Plan [Seite 624 ] business object.

Structure


InternalControlIssueRemediationPlanValidateRequestConfirmation_sync ( Validate

Remediation Plan [Seite 626 ] ) inbound operation.

Validate Remediation Plan

Technical Data

Entity Type





Category

Mode


Operation

InternalControlIssueRemediationPlanValidateR equestConfirmation_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_IC_ISSUE_REMPLAN_RC

Definition

Validates an Internal Control Issue Remediation Plan .



Use

The Validate Remediation Plan inbound operation receives data that can be used to validate a remediation plan.

Features


Internal Control Issue Remediation Plan Validate Request



ID of the remediation plan, which must be filled

StatusCode , which sets the status and must be filled, either with 4 for Rework or

5 for Validated

ValidationCommentNote , which adds a comment to the validation and does not have to be filled

Internal Control Issue Remediation Plan Validate Confirmation


Integration

This inbound operation belongs to the Action Internal Control Issue Remediation Plan In


Internal Control Sign-Off

Technical Data

Entity Type


Business object

As of FINBASIS 600

Definition

Confirmation that an internal control system is implemented and that the internal control activities were documented and assessed, and these assessments did not raise any issues that negatively influence correctness of the financial reports.

Use

In Management of Internal Controls (MIC), there is a need not only for the documentation of all existing controls within one company, but also a need to test and assess the completeness and correctness of those controls. At the end of the fiscal year, the executive board is required to sign-off on the completeness and correctness of all internal controls. This sign-off can be performed as a self service from an external system.



Query Internal Control Sign-Off In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations for searching with helpful selection criteria across individual interfaces of the Internal Control Sign-Off .

Use

The Query Internal Control Signoff In inbound service interface groups operations that can be used to query sign-off data.

Prerequisites

Sign-off was performed in MIC.

Integration

The Query Internal Control Signoff In inbound service interface belongs to the Internal Control

Management [Seite 593 ] process component and to the Internal Control Sign-Off [Seite 627 ] business object.

Structure


SubordinateInternalControlSignoffByInternalControlSignoffQueryResponse_In ( Find

Subordinate Internal Control Sign-Off by Internal Control Sign-Off [Seite 628 ] ) inbound operation.

Find Subordinate Internal Control Sign-Off by

Internal Control Sign-Off

Technical Data

Entity Type





Category

Mode


Operation

SubordinateInternalControlSignoffByInternalCo ntrolSignoffQueryResponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_SUBORDINATE_SIGNOFF_QR



Definition

Reads every Internal Control Sign-Off of the lower-level organizational units.

Use

The Find Subordinate Internal Control Sign-Off by Internal Control Sign-Off inbound operation receives data for signing off on lower-level organizational units. Sign-off for the higher-level organizational units is not possible until sign-off is completed for all lower-level organizational units.

Features


SubordinateInternalControlSignoffByInternalControlSignoffQuery_sync



ID of the sign-off, which does not have to be filled, since the search can use the organizational unit and timeframe instead

ID of the organizational unit, which does not have to be filled, since the search can use the ID of the sign-off instead

The timeframe using StartDate/EndDate , which does not have to be filled, since the search can use the ID of the sign-off instead

SubordinateInternalControlSignoffByInternalControlSignoffResponse_sync


Integration

This inbound operation belongs to the Query Internal Control Sign-Off In [Seite 628 ] inbound service interface.

Manage Internal Control Sign-Off In

Technical Data

Entity Type


Category

Mode

Service interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations that create, change, delete, or update an Internal Control Sign-Off or parts of it.



Use

The Manage Internal Control Sign-Off In inbound service interface groups operations that can be used to read and perform sign-off.

Integration

The Manage Internal Control Sign-Off In inbound service interface belongs to the Internal

Control Management [Seite 593 ] process component and to the Internal Control Sign-Off


Structure


InternalControlSignoffByIDQueryResponse_In ( Read Sign-Off [Seite 630 ] )

InternalControlSignoffAttachmentCreateRequestConfirmation_In ( Create Sign-Off

Attachment [Seite 631 ] )

InternalControlSignoffAttachmentByIDQueryResponse_In ( Read Sign-Off Attachment

[Seite 632 ] )

InternalControlSignoffAttachmentCancelRequestConfirmation_In ( Cancel Sign-Off

Attachment [Seite 633 ] )

Read Sign-Off

Technical Data

Entity Type





Category

Mode


Operation

InternalControlSignoffByIDQueryResponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_SIGNOFF_BY_ID_QR

Definition

Reads an Internal Control Sign-Off .

Use

The Read Sign-Off inbound operation reads the sign-off data.

Features


InternalControlSignoffByIDQuery_sync








InternalControlSignoffByIDResponse_sync


Integration

This inbound operation belongs to the Manage Internal Control Sign-Off In [Seite 629 ] inbound service interface.

Create Sign-Off Attachment

Technical Data

Entity Type





Category

Mode


Operation

InternalControlSignoffAttachmentCreateReque stConfirmation_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_SIGNOFF_ATTACH_CRTRC

Definition

Creates an attachment for an Internal Control Sign-Off .

Use

The Create Sign-Off Attachment inbound operation receives data that can be used to attach a document or link to a sign-off.

Features


InternalControlSignoffAttachmentCreateRequest_sync








DocumentCategoryCode , which must be filled, either with 2 for a document, or

3 for a link

DocumentName , which must be filled (contains the name of the attachment)

FileContentBinaryCode , which must be filled if a document is uploaded, but which is not allowed to be filled if a link is uploaded. The field contains the document contents as XSTRING.

DocumentPathName , which must be filled if a link is uploaded, but which is not allowed to be filled if a document is uploaded. The field contains the URL of the link.

InternalControlSignoffAttachmentCreateConfirmationt_sync


Read Sign-Off Attachment

Technical Data

Entity Type





Category

Mode


Operation

InternalControlSignoffAttachmentByIDQueryRe sponse_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_SIGNOFF_ATTACH_QR

Definition

Reads the attachments for an Internal Control Sign-Off .

Use

The Read Sign-Off Attachment inbound operation receives all documents and links that were entered in MIC when sign-off was performed.

Features


InternalControlSignoffAttachmentByIDQuery_sync








InternalControlSignoffByAttachmentIDResponse_sync


Cancel Sign-Off Attachment

Technical Data

Entity Type





Category

Mode


Operation

InternalControlSignoffAttachmentCancelReque stConfirmation_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_SIGNOFF_ATTACH_CNCRC

Definition

Deletes an attachment of an Internal Control Sign-Off .

Use

The Cancel Sign-Off Attachment inbound operation receives data that can be used to delete a document or link that was attached to a sign-off.

Features


InternalControlSignoffAttachmentCancelRequest







SAP Documentation

DocumentCategoryCode , which must be filled

AttachmentID , which must be filled

You receive the AttachmentID and DocumentCategoryCode using the

InternalControlSignoffAttachmentByIDQueryResponse_In request.

InternalControlSignoffAttachmentCancelConfirmation


Enterprise SOA

Action Internal Control Sign-Off In

Technical Data

Entity Type


Category

Mode

Service Interface

As of FINBASIS 600

Inbound

Synchronous

Definition

Group of operations that execute activities on Internal Control Sign-Off .

Use

The Action Internal Control Sign-Off In inbound service interface groups operations that can be used to perform sign-off for an organizational unit.

Prerequisites

Sign-off is scheduled in MIC.

Integration

The Action Internal Control Sign-Off In inbound service interface belongs to the Internal

Control Management [Seite 593 ] process component and to the Internal Control Sign-Off


Structure


InternalControlSignoffPerformRequestConfirmation_In ( Perform Sign-Off [Seite 634 ] ) inbound operation.

Perform Sign-Off

Technical Data

Entity Type

ES for SAP ERP 2005

Operation

634

SAP Documentation





Category

Mode


Enterprise SOA

InternalControlSignoffPerformRequestConfirma tion_In http://sap.com/xi/MICSOA/Global

As of FINBASIS 600

Inbound

Synchronous

FINB_SIGNOFF_PERFORM_RC

Definition

Executes the Internal Control Sign-Off .

Use

The Perform Sign-Off inbound operation receives data that can be used to perform sign-off.

Features


InternalControlSignoffPerformRequest_sync



The ID of the sign-off, which must be filled

SignoffCompletedIndicator , which must be filled and which indicates that signoff was performed

A comment ( Note ) for the sign-off, which does not have to be filled

InternalControlSignoffPerformConfirmation_sync


Payment Processing

Technical Data

Entity Type



(as of ESA ECC SE 600)

Definition

Handles all incoming and outgoing payments and represents the main data base for the liquidity status.

Use

The Payment Processing process component is the central component for the standard processing of payment transactions for all processes in a company or a group of companies.



Payment Processing supports the communication with house banks and business partners that is required for processing.

The mySAP ERP enterprise services package software component merely provides the service interfaces for requesting authorization from clearing houses or banks and for settlement of payments by payment cards.


Processing



This means that if optional elements are not filled in a request message, then the back-end system leaves the values as they are in the affected fields in the database. The only exception to this behavior is when these values are automatically updated due to changes to other data.

Payment Card Payment Authorisation

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

Authorization for payments by payment cards given by a clearing house to a payee.

Use

The Payment Card Payment Authorisation business object is used to query preauthorization to or request authorization from clearing houses or banks for payments by payment cards.

After the authorization process with the clearing house or bank has been completed, the settlement can be done to complete the payment transaction.


Clearing House Payment Order [Seite 640 ]

Payment Card Payment Authorisation Out

Technical Data

Entity Type


Category


(as of ECC-SE 600)

Outbound



Mode Synchronous

Definition

Queries preauthorization to or requests authorization from clearing houses or banks.

Use

The Payment Card Payment Authorisation Out outbound service interface comprises operations that query preauthorization or request authorization for payments by payment cards.


Payment Card Payment Settling In [Seite 642 ]

Payment Card Payment Settling Out [Seite 641 ]

Integration

The Payment Card Payment Authorisation Out outbound service interface belongs to the

Payment Processing [Seite 635 ] process component and the Payment Card Payment

Authorisation [Seite 636 ] business object.

Structure

The Payment Card Payment Authorisation Out outbound service interface groups the following outbound operations:

PaymentCardPaymentAuthorisationPreAuthorisationQueryResponse_Out

( Request Payment Card Payment Pre Authorisation [Seite 637 ] )

PaymentCardPaymentAuthorisationRequestConfirmation_Out ( Request

Payment Card Authorisation [Seite 638 ] )

PaymentCardPaymentAuthorisationCancelRequestConfirmation_Out

( Request Payment Card Authorisation Cancellation [Seite 639 ] )

Request Payment Card Payment Pre Authorisation

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Category

Service operation

PaymentCardPaymentAuthorisation_Pre-

AuthorisationQueryResponse_Out http://sap.com/xi/APPL/SE/Global

As of ECC-SE 600

Outbound



Mode

Related

Web

Service

Definition

Definition

Queries preauthorization to clearing houses or banks.

Synchronous

–

Use

The Request Payment Card Payment Pre Authorisation outbound operation queries preauthorization for payments by payment cards.

Features

This outbound operation processes the following message types:

PaymentCardPaymentAuthorisationPreAuthorisationQuery_sync

PaymentCardPaymentAuthorisationPreAuthorisationResponse_sync


Integration

This outbound operation belongs to the Payment Card Payment Authorisation Out [Seite 636 ] outbound service interface.


If your SAP system acts as a service consumer (meaning that your SAP system uses this outbound operation to query preauthorization to clearing houses or banks), you have to provide a function module that executes the outbound operation, and assign it in Customizing.

You can use the BLAP_CCARD_AUTH function module that converts the data that is sent to and received from clearing houses or banks calls the Business Add-In (BAdI) BLAP_PRE_AUTH_IN (BADI for mapping from XI to

ERP) or BLAP_PRE_AUTH_OUT (BADI for mapping from ERP to XI) executes the outbound operation

The BLAP_CCARD_AUTH function module is available as of mySAP ERP 2005, Add-On for

Enterprise Services (ECC-SE 600), Support Package 3.

You assign the function module in Customizing for Sales and Distribution by choosing Billing

Payment Cards Authorization and Settlement Maintain Clearing House Set

Authorization / Settlement Control Per Account .

Request Payment Card Authorisation

Technical Data

Entity Type




Service operation

PaymentCardPaymentAuthorisationRequest-

Confirmation_Out http://sap.com/xi/APPL/SE/Global




Category

Mode


As of ECC-SE 600

Outbound

Synchronous

–

Definition

Requests authorization from clearing houses or banks.

Use

The Request Payment Card Authorisation outbound operation requests authorization for payments by payment cards.

Features


PaymentCardPaymentAuthorisationRequest_sync

PaymentCardPaymentAuthorisationConfirmation_sync


Integration



If your SAP system acts as a service consumer (meaning that your SAP system uses this outbound operation to request authorization from clearing houses or banks), you have to provide a function module that executes the outbound operation, and assign it in Customizing.

You can use the BLAP_CCARD_AUTH function module that converts the data that is sent to and received from clearing houses or banks calls the Business Add-In (BAdI) BLAP_AUTH_IN (BADI for mapping from XI to ERP) or BLAP_AUTH_OUT (BADI for mapping from ERP to XI) executes the outbound operation

This BLAP_CCARD_AUTH function module is available as of mySAP ERP 2005, Add-On for





Request Payment Card Authorisation Cancellation

Technical Data

Entity Type




Service operation

PaymentCardPaymentAuthorisationCancel-

RequestConfirmation_Out http://sap.com/xi/APPL/SE/Global




Category

Mode


As of ECC-SE 600

Outbound

Synchronous

–

Definition

Requests clearing houses or banks to cancel authorization of payments by payment cards.

Use

The Request Payment Card Authorisation Cancellation outbound operation cancels the authorization of payments by a payment card.

Features


PaymentCardPaymentAuthorisationCancelRequest_sync

PaymentCardPaymentAuthorisationCancelConfirmation_sync


Integration


Clearing House Payment Order

Technical Data

Entity Type



(as of ECC-SE 600)

Definition

Order for clearing a collection of payment card payments to a clearing house or bank.

Use

The Clearing House Payment Order business object is used to perform the settlement of payments by payment cards.

Process Flow

Once a company has accepted a payment by payment card from a business partner

(customer), the company sends an order with the payment data and card data using a

ClearingHousePaymentOrderRequest [Seite 641 ] message to a clearing house for card payments.

Finally, the clearing house returns a confirmation message to the company using a

ClearingHousePaymentOrderConfirmation [Seite 643 ] message. The confirmation message contains information about the settlement success of the payment card payment.


Payment Card Payment Authorisation [Seite 636 ]



Prerequisites

The corresponding authorization request must have been successfully confirmed by the clearing house or bank.

Payment Card Payment Settling Out

Technical Data

Entity Type


Category

Mode


(as of ECC-SE 600)

Outbound

Asynchronous

Definition

Request for settlement of a payment by payment card which has been authorized previously and is used in a payment order to a clearing house or bank.

Use

The Payment Card Payment Settling Out outbound service interface comprises operations that request settlement of payments by payment cards from clearing houses or banks.


Payment Card Payment Settling In [Seite 642 ]

Payment Card Payment Authorisation Out [Seite 636 ]

Prerequisites

The payment must have been authorized by the clearing house or bank.

Integration

The Payment Card Payment Settling Out outbound service interface belongs to the Payment

Processing [Seite 635 ] process component and the Clearing House Payment Order [Seite


Structure

The Payment Card Payment Settling Out outbound service interface provides the

ClearingHousePaymentOrderRequest_Out ( Request Payment Card Payment [Seite

641 ] ) outbound operation.

Request Payment Card Payment

Technical Data

Entity Type





Service operation

ClearingHousePaymentOrderRequest_Out http://sap.com/xi/APPL/SE/Global

As of ECC-SE 600



Category

Mode


Outbound

Asynchronous

–

Definition

Requests settlement of payments by payment cards from clearing houses or banks.

Use

The Request Payment Card Payment outbound operation requests the settlement of payments by payment card which have been authorized previously.

Features

This outbound operation processes the ClearingHousePaymentOrderRequest message type.

Prerequisites

The corresponding authorization request must have been successfully confirmed by the clearing house or bank.

Integration

This outbound operation belongs to the Payment Card Payment Settling Out [Seite 641 ] outbound service interface.


If your SAP system acts as a service consumer (meaning that your SAP system uses this outbound operation to request settlement of payments by payment cards from clearing houses or banks), you have to provide a function module that executes the outbound operation, and assign it in Customizing.

You can use the BLAPS_CCARD_SET function module that converts the data that is sent to clearing houses or banks calls the Business Add-In (BAdI) BLAPS_REQUEST (BAdI for ClearingHouse-

PaymentOrderRequest)

If errors occur during the operation, you will find references to the exceptions in table

T_EXCEPTION_REF. If conversion errors occur, the exceptions show the original values.

executes the outbound operation

The BLAPS_CCARD_SET function module is available as of mySAP ERP 2005, Add-On for





Payment Card Payment Settling In

Technical Data





Category

Mode mySAP ERP enterprise services package

(as of ECC-SE 600)

Inbound

Asynchronous

Definition

Confirmation for a settlement request from clearing houses or banks.

Use

The Payment Card Payment Settling In inbound service interface comprises operations that allow clearing houses or banks to confirm payment orders.


Payment Card Payment Settling Out [Seite 641 ]

Payment Card Payment Authorisation Out [Seite 636 ]

Prerequisites

Settlement of the payment by payment card must have been requested.

Integration

The Payment Card Payment Settling In inbound service interface belongs to the Payment

Processing [Seite 635 ] process component and the Clearing House Payment Order [Seite


Structure

The Payment Card Payment Settling In inbound service interface provides the

ClearingHousePaymentOrderConfirmation_In ( Change Clearing House Payment

Order based On Confirmation [Seite 643 ] ) inbound operation.

Change Clearing House Payment Order Based On

Confirmation

Technical Data

Entity Type





Category

Mode


Service operation

ClearingHousePaymentOrderConfirmation_In http://sap.com/xi/APPL/SE/Global

As of ECC-SE 600

Inbound

Asynchronous

–

Definition

Confirms settlement requests.



Use

The Change Clearing House Payment Order Based On Confirmation inbound operation is used by clearing houses or banks to confirm settlement requests.

Related Operation

Request Payment Card Payment [Seite 641 ]

Features


ClearingHousePaymentOrderConfirmation

StandardMessageFault

Integration

This inbound operation belongs to the Payment Card Payment Settling In [Seite 642 ] inbound service interface.


If your SAP system acts as a service consumer (meaning that your SAP system uses this inbound operation to confirm settlement requests), you have to assign the

CREDIT_CARD_SETTLEMENT_RSP function module in Customizing for Sales and

Distribution by choosing Billing Payment Cards Authorization and Settlement

Maintain Clearing House Set Authorization / Settlement Control Per Account .

The CREDIT_CARD_SETTLEMENT_RSP function module is available as of mySAP ERP

2005, Add-On for Enterprise Services (ECC-SE 600), Support Package 3.

Enterprise Services for SAP ERP Human Capital

Management

Personnel Administration

Technical Data

Entity Type



Definition

Manages all employee-related data in the company and includes all fundamental Personnel

Management administrative processes that take place within a company.

Use

An administrator’s primary task within a company is handling information requests. These information requests usually occur ad hoc and outside of the system, for example, by telephone. Information from the process component is also used to provide downstream processes, such as payroll.

You can use the Personnel Administration process component to provide services for queries relating to information on employee data.




Prerequisites



Employment

Technical Data

Entity Type



Definition

Originates due to one or more valid work agreements. Whereas the work agreement only consists of the specific agreements between the employer and employee concerning the work performed, the Employment relationship comprises the complete legal relationship between the contracting parties.

Use

The Employment business object is a fundamental object that cannot be assigned to a specific process component. It is, for example, used in the Personnel Administration process component, as well as in Time Management or in Compensation . The business object includes data that is relevant for all of the employee's work agreements with the employer, for example, the work permit and degree of challenge.

Constraints

All service operations in this business object for the recording of employee-related data process the data of one employee, that is, you can only ever process one personnel number.

The service operations for supplying data to reporting applications can, however, process multiple personnel numbers.


Work Agreement [Seite 647 ]

Employee [Seite 97 ]


Prerequisites

You use the SAP ECC Enterprise Extension Human Capital Management (EA-HR).

Manage Employment

Technical Data

Entity Type


Service interface

SAP ERP enterprise services package (as of ECC-

SE 501)



Category

Mode

Inbound

Synchronous

Definition

Query to, and response from Employment to access the country in which an employee's employment relationship exists.

Use

The Manage Employment inbound service interface contains an operation that provides the country, or a list of all the countries, in which an employee has an employment relationship.

Integration

This inbound service interface is part of the Personnel Administration [Seite 644 ] process component and the Employment [Seite 645 ] business object.

Structure

The Manage Employment inbound service interface includes the

EmploymentCountryByEmployeeQueryResponse_In inbound operation ( Find

Employment Country by Employee [Seite 646 ] ).

Find Employment Country by Employee

Technical Data

Entity Type






Version in ESR

Category

Mode


Definition

Operation

EmploymentCountryByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 501

Inbound

Synchronous

ECC_EmploymentCountryByEmpQR

Definition

Retrieves the country in which an employee is employed.

Use

The Find Employment Country by Employee inbound operation reads the relevant country for an employee's employment relationship.

Features


EmploymentCountryByEmployeeQuery



If you fill the Employee_ID in this message, the system first determines all existing WorkAgreement_IDs that are linked to this Employee_ID and reads the respective country of employment for each of these Work Agreements .

If you fill the WorkAgreement_ID, the system determines the country of employment for this Work Agreement .

If you fill the Employee_ID and the WorkAgreement_ID, the system checks whether the WorkAgreement_ID belongs to this Employee_ID. If this is the case, the system reads the country of employment for this Work Agreement .

EmploymentCountryByEmployeeResponse

The message returns the country indicators, sorted using the following criteria:

WorkAgreement_ID

Country indicator

The output is based on key dates. The country indicator returned is formatted according to the standard ISO 3166.

StandardMesssageFault

Error Handling




Integration

This inbound operation belongs to the Manage Employment [Seite 645 ] inbound service interface.


Processing


Work Agreement

Technical Data

Entity Type


Business object mySAP ERP enterprise services package (as of ECC_SE 501)

Definition

Agreement between employer and employee which obliges the employee to provide labor, and obliges the employer to render the agreed remuneration.

The Work Agreement determines the type of work. It establishes an Employment relationship and is the basis for further details, such as remuneration or working times, that are specified in other objects.



Use

The Work Agreement business object contains all relevant data on a work agreement between an employee and an employer. An employee can have multiple work agreements with one employer.


Employment [Seite 645 ]

Employee [Seite 97 ]

Each Employee is assigned one or more Employment relationships. Each employment relationship is assigned a Work Agreement .


Prerequisites


Query Work Agreement In

Technical Data

Entity Type


Category

Mode


ECC-SE 501)

Inbound

Synchronous

Definition

Group of operations for retrieving WorkAgreement_IDs and administrative and organizational data about an employee, using individual WorkAgreement interfaces.

Use

Every employee in an organization receives a user name for the system. A system user is assigned a unique Employee_ID and a unique WorkAgreement_ID. These IDs are used in

Personnel Administration to indicate employees and all of their work agreements.

The Query Work Agreement In inbound service interface contains operations that provide the assignments between employees and their WorkAgreements as well as administrative and organizational data.

Integration

This inbound service interface is part of the Personnel Administration [Seite 644 ] process component and the Work Agreement [Seite 647 ] business object.

Structure

The Query Work Agreement In inbound service interface contains the following inbound operations:

WorkAgreementSimpleByElementsQueryResponse_In ( Find Work Agreement by Elements [Seite 649 ] )



WorkAgreementAdministrativeAndOrganisationalDataByEmployeeQueryR esponse_In ( Find Administrative and Organisational Data by Employee [Seite 650 ] )

Find Work Agreement by Elements

Technical Data

Entity Type





Category

Mode


Definition

Operation

WorkAgreementSimpleByElementsQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ECC-SE 600

Inbound

Synchronous

ECC_WorkAgSimpleRElementsQR

Definition

Retrieves an employee's Work Agreements .

Use

The Find Work Agreement by Elements inbound operation reads an employee's

WorkAgreement_IDs depending on certain selection criteria.

Features


WorkAgreementSimpleByElementsQuery

You can choose from a range of selection parameters. You must fill one of these parameters in this message. If you enter several parameters, you must make sure that the combination of parameters is meaningful. The system determines the

WorkAgreement_IDs of all of the employee's work agreements.

Employee_ID

UserAccount_ID

If you fill only the UserAccount_ID (system user), the query first determines the associated Employee_ID and all of the related WorkAgreement_IDs.

You can also use the following selection parameters:

SelectionByEmployee_GivenName

SelectionByEmployee_FamilyName

SelectionByReportingLineUnit_Name

SelectionByPosition_Description

SelectionByCostCenter_ID



SelectionByEmployee_WorkplaceAddressPhoneNumberExtensionID

SelectionByEmployee_WorkplaceAddressBuildingID

SelectionByEmployee_AddressOfficeRoomID

SelectionByIdentity_UserAccountID

The following applies to these selection parameters:

The default value for the InclusionExclusionCode is I ( Inclusion ).

The default value for the IntervallBoundaryTypeCode is 1 ( Single value ).

WorkAgreementSimpleByElementsResponse

The WorkAgreement_IDs are output based on a key date.

Error Handling

The specified selection parameter does not exist for the key date entered.

The specified combination of selection parameters is not valid.

A WorkAgreement_ID could not be found for the specified selection parameters.

Constraints

The value for the InclusionExclusionCode must always be I ( Inclusion ).

The value for the IntervalBoundaryTypeCode must always be 1 ( Single value ).

If you specified the UserAccount_ID and SelectionByIdentity_UserAccountID as selection parameters, these values must be identical.

Integration

This inbound operation belongs to the Query Work Agreement In [Seite 648 ] inbound service interface.


Prerequisites

If you want to use the system user (UserAccount_ID) as the selection criterion, you must have maintained the Communication infotype (0105) for your employees in the SAP back-end system.

Processing


If neither of the selection parameters is filled, the system uses the system user currently logged on (SY_UNAME) as the Identity_UserAccountID.

Find Administrative and Organisational Data by

Employee

Technical Data




Technical

Name in

Enterprise

Service

Repository

(ESR)


WorkAgreementAdministrativeAndOrganisationalDataByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

Software

Component

Version in

ESR

Category

As of ECC-SE 600

Mode

Related

Web

Service

Definition

Inbound

Synchronous

ECC_WorkAgAdmOrgByEmpQR

Definition

Provides administrative and organizational data for an employee's Work Agreement .

Use

The Find Administrative and Organisational Data by Employee inbound operation reads information from the Organisational Assignment infotype (0001).

Features


WorkAgreementAdministrativeAndOrganisationalDataByEmployeeQuery

In this message, you have to fill the Employee_ID or the WorkAgreement_ID. If you only fill the Employee_ID, the system first determines all existing WorkAgreement_IDs that are linked to this Employee_ID and reads the administrative and organizational data from here. If you fill the WorkAgreement_ID, the system determines the specific data for this Work Agreement .

WorkAgreementAdministrativeAndOrganisationalDataByEmployeeRespon se


WorkAgreement_ID

Validity Period

Hiring Date

Work Contract (WorkAgreementTypeCode)

AdmininistrativeCategoryCode

OrganisationalAssignment

Validity Period



Staffing Percentage

Main Assignment

PositionAssignment

ID

Name

CostCentre

ID

Name

The cost center is only provided for the position indicated as the main assignment.

PersonnelSubAreaAssignment

Validity Period Personnel Subarea

Personnel Area

Personnel Subarea

Employment Percentage

Validity Period

The OrganisationalAssignment defines the time-dependent assignment of a Work

Agreement to the organizational structure of a company, using a position hierarchy.

The PositionAssignment defines the assignment of an employee to a position within the organizational structure, using the WorkAgreement . The PositionAssignment also includes an employee's staffing percentage for a position, and specifies whether it is the main assignment ( Main Position Indicator ). Only one position can be indicated as the main position assignment.

To determine the staffing percentage, the system compares the Capacity Utilization

Level from the Basic Pay infotype (0008) with the staffing percentage from the Planned

Working Time infotype (0007). If both values are identical, the Employment Percentage is filled with this value. If the two values are not identical, the system outputs a suitable message.

The PersonnelSubAreaAssignment defines an employee's assignment to a personnel subarea in a validity period. The personnel subarea represents a part of the personnel area delimited under personnel administrative, time management, and payroll perspectives.

Error Handling

The Employee_ID entered does not exist for the Work Agreement validity period entered.

The WorkAgreement_ID entered does not exist for the Work Agreement validity period entered.


Integration

This inbound operation belongs to the Query Work Agreement [Seite 648 ] inbound service interface.




Processing

If you have not specified a validity period in the query, the system uses the lowest system date (18000101) as the start date and the highest system date (99991231) as the end date for the validity period.

The Business Add-In (BAdI) PAD_ESA_WRKADMN_CONV ( Conversions for Proxy: Work

Agreement Admin./Org.

) is available for this operation. For more information about this BAdI, see the Implementation Guide for Enterprise Services under Personnel Administration .

Time and Labour Management

Technical Data

Entity Type



Definition

Management of employees’ planned working times and recording and valuation of completed activities and absence times.

Use

The Time and Labour Management process component enables you to provide applications that support the users in fulfilling their duty to document their working times and absence times. This can include the following functions, for example:

Recording and processing requests for leave

Displaying time accounts

Providing input help with information about the completed activities

Providing functions for automatically recording undocumented working times

Displaying the recorded data for an employee’s information or for reporting of employee times

The employee times processed with the operations of the Time and Labour Management process component can also contain information about the completed activities. This information can be transferred to downstream business processes such as controlling, invoicing, project or order confirmations, or payroll.


Prerequisites



Processing

The Time and Labour Management process component enables communication with data of the following mySAP ERP application components:



Entry of absences in Time Data Recording and Administration in Time Management

(PT-RC) together with the Employee Self-Service component (CA-ESS)

Entry of working times in the Cross-Application Time Sheet (CA-TS)

You can use the operations of this process component to read and edit employee times from the SAP system.

The employee times in the Time Sheet are always evaluated as productive times, provided that they are not given Time Management time sheet attributes, meaning that the posted times refer to periods in which the employee was working for the company.

If the employee times are given Time Management time sheet attributes, they can describe productive times (attendances), absences, and employee remuneration information.

The employee times are depicted in the messages of this process component as follows:

Representation of Employee Times in the Service-Oriented Architecture

Data Source EmployeeTimeItem

CategoryCode

1

EmployeeTimeItem

TypeCode

1

EmployeeTimePlanning

CategoryCode

3 Planned Working

Time

Productive time without Time

Management time sheet attribute

Data record for the Attendances infotype (2002)

Data record for the Absences infotype (2001)

Data record for the Employee

Remuneration

Information infotype (2010)

1

2

3

6

Initial

Employee remuneration information subtype

Not relevant

Attendance subtype Not relevant

Absence subtype Not relevant

Not relevant

Employee Time Sheet

Technical Data

Entity Type



Definition

Summary of Employee Time Sheets of an individual employee in relation to an assigned

Employee Time Agreement .



Use

This business object allows you to record working times for an employee.

All business processes that affect employees working times need information about the employee's completed work. This includes, for example, business processes for paying employees, for monitoring the progress of projects, or for invoicing.

When recording working times, employees do not only record information about the length of working times, but also information on the business processes they worked on. This information is then important for supporting the subsequent business processes. To make recording this information easier, the Employee Time Sheet provides the permitted values for the employee.

The operations of this business object enable you to:

Create, change, and delete data records

Import employee times to the data entry area of your application that were not recorded using your application

Check the plausibility of the data entered

Import information from Customizing

Incorporate picklists to aid data entry

Import data for reporting purposes

Generate data records that are documented with standard account assignments [Seite

662 ] according to determined rules.

All operations of this business object that are used to record employee times each process the data for one or more Employee Time Agreements of an employee. The operations for supplying data to reporting applications can, however, process multiple employees.

Constraints

The business object does not provide any services for using the user interfaces to approve the recorded employee times.


Prerequisites


You have set up the Time Sheet in the mySAP ERP system.

You have set up the required authorizations for the Time Sheet for your employees.

Unlike in the standard system, for the operations of this business object you also require authorizations for infotype 0328 for employees who only record their own employee times. For more information about this infotype, see the documentation for the Time Sheet .

Processing

The operations of this business object allow you to import or process the most frequently used CATSDB data.

The employee times in the Time Sheet are always evaluated as productive times, provided that they are not given Time Management time sheet attributes, meaning that the posted times refer to periods in which the employee was working for the company. If employee times


SAP Documentation Enterprise SOA have Time Management time sheet attributes, or as a result of profile settings, have a default type of attendance/absence, you can identify productive times (attendances), absences and employee remuneration information.

In the operation message structures of this business object, the data types

EmployeeTimeItemCategoryCode and EmployeeTimeItemCategoryTypeCode represent this as follows:

Using the Data Types EmployeeTimeItemCategoryCode and

EmployeeTimeItemCategoryTypeCode

EmployeeTimeItemCategoryCode EmployeeTimeItemCategoryTypeCode Description

1

2

3

Initial

Attendance subtype

Absence subtype

Productive time without

Time

Management time sheet attribute

Data record for the

Attendances infotype

(2002)

Data record for the

Absences infotype

(2001)

6 Employee remuneration information subtype

Data record for the

Employee

Remuneration

Information infotype

(2010)

Example: Message Choreography for the

Employee Time Sheet

The following example shows you how the message choreography for entering employee times might look on the user interface with the operations of the Employee Time Sheet [Seite

654 ] and Employee Time Sheet Configuration [Seite 699 ] business objects.

...

At the end of a given week, an employee wants to enter the times they worked on the current day. They also want to complete the time entry for that week.

1. The employee calls the Cross-Application Time Sheet .

The employee wants to post the times they worked for a project to that project’s network activity.

The application requires the following values from the back-end system: a. The information about the field selection to set up a suitable data entry profile on the user interface. You can get these values using the Read Employee Time

Sheet Configuration [Seite 700 ] operation.


SAP Documentation Enterprise SOA b. The information about the employee times the employee already entered. You can get these values using the Find Employee Time Sheet by Employee [Seite

665 ] operation.

c. The information about the network activities to which the employee is permitted to post their employee times. You can get the permitted values for the input help for posting the employee times to a network activity by using the Find allowed

Network by Employee [Seite 668 ] operation.

2. The employee has entered their times. The employee wants to check the entries before they save. To do so, use the Check Change Time Sheet [Seite 659 ] operation.

3. The employee corrects any errors.

4. The employee saves the data. To do so, use the Change Time Sheet [Seite 658 ] operation.

Before the back-end system can automatically fill any unrecorded times, the entered employee times have to be saved in the back-end system.

5. The employee wants to automatically record all the times they worked for their cost center for the entire week. To be able to use this function, the employee has defined a

Rule for the Standard Account Assignment , in which they have specified their cost center as the account assignment for a specific time period. To send the request to the system for recording employee times with a standard account assignment, use the

Complete Employee Time Sheet [Seite 663 ] operation.

Manage Employee Time Sheet In

Technical Data

Entity Type


Category

Mode

Service interface


ECC-SE 501)

Inbound

Synchronous

Definition

Group of operations for creating, changing, reading or updating the Employee Time Sheet In , or parts of it.

Use

The Manage Employee Time Sheet In inbound service interface groups operations that enable you to record, change and delete employee times for an employee, as well as check currently edited employee times. This also includes the notes that are recorded for an employee time.

Integration

The Manage Employee Time Sheet In inbound service interface belongs to the Time and

Labour Management [Seite 653 ] process component and the Employee Time Sheet [Seite




Structure

The Manage Employee Time Sheet In inbound service interface groups the following inbound operations:

EmployeeTimeSheetChangeRequestConfirmation_In ( Change Time Sheet

[Seite 658 ] )

EmployeeTimeSheetChangeCheckQueryResponse_In ( Check Change Time

Sheet [Seite 659 ] )

Change Time Sheet

Technical Data

Entity Type





ESR

Category

Mode


Service operation

EmployeeTimeSheetChangeRequestConfirmation_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetChgRC

Definition

Change Employee Time Sheet .

Use

The Change Time Sheet inbound operation is used to create, change, or delete the employee times of a personnel number.

Features


EmployeeTimeSheetChangeRequest

EmployeeTimeSheetChangeConfirmation


In the messages of this operation you can use the FullWorkingDayIndicator instead of or in addition to EmployeeTimeValidity . In both cases, you receive the Duration of an

EmployeeTimeValidity that corresponds to the day's planned working time.


EmployeeTimeValidity a nd/or FullWorkingDayIndicator

Quantity

Amount



All supplied WorkAgreements must be assigned to the same employee.

You can also use this operation to update data records that were not created by your application. For example, your users can change, in your system, data records created for them in the back-end system by a time administrator or supervisor, or those recorded in a third-party system and uploaded to your back-end system. To identify such records, you can mark the data changed by your application with a separate external key. The operation then returns this to the back-end system.

This operation allows you to supply an external key. The relevant

EmployeeTimeID and the EmployeeTimeItemID are the only means by which the operation can uniquely identify a data record with the ActionCode 02

( Change ) and 03 ( Delete ).

You can use the Find Times for Employee Time Sheet by Elements [Seite 707 ] operation to determine the EmployeeTimeID and the EmployeeTimeItemID with the external key .


Processing

To check the data that is transferred to the SAP back-end system, the system runs all the checks that take place when employee times are recorded in the SAP back-end system.

The system processes the set of employee times transferred to the service operation as a whole. If there is an error in at least one of the records, the whole set of records is rejected.

The service returns the changed data. If you enrich the data in the back-end system, this information is also delivered.

The Business Add-In (BAdI) TS_CHANGE_CONV ( Conversions for Proxy: Change

TimeSheet ) is available for this operation.

Check Change Time Sheet

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeTimeSheetChangeCheckQueryResponse_In

Inbound

Synchronous

ECC_EmpTimSheetChgChkQR

Definition

Simulates changes to an Employee Time Sheet .



Use

The Check Change Time Sheet inbound operation allows you to check created, changed or deleted data in an application for recording employee times. You can use it, for example, to provide a function with which users can individually check newly edited employee times. This simplifies processing for them should errors occur.


You can use this operation to run the same checks for all transferred data records of a personnel number that are run by the Change Time Sheet [Seite 658 ] operation.

Features


EmployeeTimeSheetChangeCheckQuery

EmployeeTimeSheetChangeCheckResponse


In the related messages of the operations of this service interface you can use the

FullWorkingDayIndicator instead of or in addition to EmployeeTimeValidity . In both cases, you receive the Duration of an EmployeeTimeValidity that corresponds to the day's planned working time.


EmployeeTimeValidity a nd/or FullWorkingDayIndicator

Quantity

Amount

All supplied WorkAgreements must be assigned to the same employee.


Processing

The operation checks all transferred employee times. It checks the employee times in their entirety. The operation also checks the times that are assigned a standard account assignment.

The operation returns a table of the checked data records. The table is required because the messages may relate to field contents that were added and that may not yet be in the input table.

The Business Add-In (BAdI) TS_CHANGE_CHECK_CONV ( Conversions for Proxy:

Change Check TimeSheet ) is available for this operation.

Employee Time Sheet Action In

Technical Data





Category

Mode mySAP ERP enterprise services package (as of ECC-SE 501)

Inbound

Synchronous

Definition

Group of operations that perform actions on the Employee Time Sheet In .

Use

The Employee Time Sheet Action In inbound service interface groups operations that, in the back-end system, calculate the employee times that are assigned a standard account assignment. The employee times are calculated for the specified employee and the specified period. The generated employee times are returned to the application. This allows users to import the completely documented periods.

Prerequisites

On your user interface you provide a function with which users can document the employee times with a Standard Account Assignment for a period.

Integration

The Employee Time Sheet Action In inbound service interface belongs to the Time and



Structure

The service interface contains the CompleteEmployeeTimeSheetIn inbound operation

( Complete Employee Time Sheet [Seite 663 ] ).


Prerequisites

You implement the standard account assignment function. For more information, see

Standard Account Assignments with the Time Sheet (CATS) [Seite 662 ] .

The working times to be assigned a standard account assignment are calculated in the back-end system. Therefore, the times of days that are not to be assigned a standard account assignment are already in the back-end system. This is the only way the system can calculate the difference between planned working time and documented working times for a day, and transfer these times to the standard account assignment.

Processing

The system saves the calculated working times to the database. If data records exist on the database with a standard account assignment for the period, the system deletes them.

Only when all days can be successfully processed are the data records saved in the back-end system.



Standard Account Assignments with the Time

Sheet (CATS)

Purpose

You can use this function to create data records for the Cross-Application Time Sheet (CATS) in the SAP back-end system. These data records use defined rules to document undocumented periods of a day with standard account assignments.

This function is not available in the standard Cross-Application Time Sheet.

You can only use it together with mySAP enterprise services package.

The rules for standard account assignments specify how the undocumented times are to be posted. One rule for standard account assignments can contain more than one standard account assignment. In the rule, you specify the percentages to which you want the individual account assignments to be distributed over the undocumented time.

An employee works for several projects. You want all working times that have not been documented to be posted to the employee’s master cost center (100%).

An employee works mainly on one project. A certain percentage of working time is spent on additional activities for the master cost center.

You therefore want the working times that have not been documented in a particular period to be distributed between the project (70%) and the master cost center (30%).

The SAP back-end system generates employee times, which are assigned a standard account assignment in this function, only with hours. The function does not provide information about clock times. You should note this restriction if you use Time Evaluation and valuate employees’ working times according to the clock times. If this is the case, you may want to reconsider the use of a standard account assignment.

Data records that have a standard account assignment are indicated on the database by the

EXTAPPLICATION field, in the WSR parameter.

Prerequisites

The SAP back-end system determines the undocumented times by means of the difference between the target hours and the documented hours. Therefore, you have to ensure that the determination of target hours for employees is triggered using the data entry profile of the Time Sheet.

You set this up in Customizing for the Time Sheet.

You have provided in your application a user interface for defining the rules for standard account assignment.

Employees must be able to enter on the user interface the period to which the rule applies.

You have provided in your application a function on the user interface to fill the undocumented times. In this function, employees must be able to specify:

The standard account assignment

The period that has to be filled

The account assignments that are specified in the rules must result in a data record that can be saved in the time sheet, in other words, the rules must not be inconsistent.

There must be no more than one rule for the standard account assignment for each period and employee. There may, however, be periods in which no rule is entered for


SAP Documentation Enterprise SOA an employee. This procedure is comparable to the time constraint class 2 in SAP

Human Capital Management.

Process Flow

...

The following describes the process of the standard account assignment when you use the

SAP Cross-Application Time Sheet (CATS).

1. On the user interface, an employee defines a rule for a period (such as a year) after which the undocumented working times are to be documented using standard account assignments.

2. These rules are transferred to the SAP back-end system by the Employee Time Sheet

Action [Seite 660 ] service interface, dependent on the system user and that person’s personnel number(s) or work agreements. The SAP back-end system saves the rule in the SAP databa se table CATS_DEF_ACCOUNT (CATS Default Accounting).

3. The employee has recorded employee times for a week which requires special account assignments to be entered. The remaining time is to be distributed to the standard account assignment.

4. In the user interface, the employee chooses the function for distributing the employee times to the standard account assignment and specifies the period.

5. The data is transferred to the SAP back-end system by means of the service operation.

The SAP back-end system calculates the number of hours to be distributed over the specified standard account assignments, and stores the corresponding data records on the database. Data records with a standard account assignment are indicated on the database by means of the EXTAPPLICATION, and the WSR parameter.

6. The employee times calculated in this way are transferred to the application.

7. The employee records additional employee times with a special account assignment for a period that was already documented by a standard account assignment.

8. The employee again chooses the function for filling the undocumented times with the standard account assignment.

9. In the back-end system, the SAP back-end system deletes the old data records for the changed days, and calculates the new standard account assignment. It saves the data records on the database and transfers the recalculated and deleted data back to the application.

10. After some time, the employee is assigned to a new project. The employee changes the rule in the application.

11. The new rule is transferred to the SAP back-end system.

12. The SAP back-end system deletes the old rule and replaces it with the new one.

Complete Employee Time Sheet

Technical Data

Entity Type




Service operation

EmployeeTimeSheetCompleteRequestConfirmation_In http://sap.com/xi/EA-HR/SE/Global




Category Inbound

Mode


Synchronous

ECC_EmpTimSheetCompRC

Definition

Completes the Employee Time Sheet .

Use

The Complete Employee Time Sheet inbound operation triggers the automatic creation of employee times with a standard account assignment in the back-end system .

The back-end system completes the requested periods to be booked and returns the working times with a standard account assignment to the application.

Features


EmployeeTimeSheetCompleteRequest

This message type is used to transfer the request to document the employee times with a standard account assignment for the specified employee and period to the back-end system .

The EmployeeID or the WorkAgreementID must be filled. If only the EmployeeID is filled, the standard account assignments are automatically generated for all of the employee’s WorkAgreements.

EmployeeTimeSheetCompleteConfirmation


Integration

This inbound operation belongs to the Employee Time Sheet Action [Seite 660 ] inbound service interface.


Prerequisites

Before you can send the request to the back-end system, a rule for the standard account assignment must be created for the employee in the back-end system. The processing of this rule definition takes place using the Manage Employee Time Agreement [Seite 692 ] service interface.

Processing

The system processes the period transferred to the operation in its entirety. If there is an error on at least one of the days, the whole set of records is rejected. If there are multiple rules for standard account assignment stored in the back-end system, the working times are assigned the standard account assignment stored on the applicable day.

The Business Add-In (BAdI) TS_COMPLETE_CONV ( Conversions for Proxy:

Complete Time Sheet ) is available for this operation.



Query Employee Time Sheet In

Technical Data

Entity Type


Category

Mode

Service interface

SAP enterprise services package (as of ECC-

SE 501)

Inbound

Synchronous

Definition

Group of operations to find the Employee Time Sheet In with relevant selection criteria using individual interfaces.

Use

The Query Employee Time Sheet In inbound service interface groups operations that read the recorded employee times and the corresponding long texts for each employee and period.

Integration

The Query Employee Time Sheet In inbound service interface belongs to the Time and



Structure

The Query Employee Time Sheet In inbound service interface contains the

EmployeeTimeSheetByEmployeeQueryResponse _In inbound operation ( Find

Employee Time Sheet By Employee [Seite 665 ] ).

Find Employee Time Sheet by Employee

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeTimeSheetByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetEmpQR

Definition

Finds an Employee Time Sheet for an individual employee.



Use

The Find Employee Time Sheet by Employee inbound operation reads an employee's recorded employee times. You can use this operation to display these employee times on the data entry user interface.


For reporting or a list output of the recorded times of multiple employees, use the Find Times for Employee Time Sheet by Elements [Seite 707 ] inbound operation.

Features


EmployeeTimeSheetByEmployeeQuery

In these messages, either the Employee_ID or the WorkAgreement_ID must be filled. If only the Employee_ID is filled, the operation returns all EmployeeTimeSheet s that are available for the employee’s relevant work agreements.

EmployeeTimeSheetByEmployeeResponse

If DatePeriod is not filled, the operation returns the employee times that were recorded for the current day.

You can use the FullWorkingDayIndicator instead of or in addition to

EmployeeTimeValidity . In both cases, you receive the Duration of an

EmployeeTimeValidity that corresponds to the day's planned working time.


EmployeeTimeValidity and/or FullWorkingDayIndicator

Quantity

Amount


Integration

This inbound operation belongs to the Query Employee Time Sheet [Seite 665 ] inbound service interface.


Processing

This operation returns all of an employee’s times that have one of the following processing statuses in the SAP back-end system:

In process

Released for approval

Approved

Approval rejected

The Business Add-In (BAdI) TS_QUERY_CONV ( Conversions for Proxy: Query By

Employee ) is available for this operation.



Entries for Employee Time Sheet In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations that provide a list of permitted entries, restricted by further criteria.

Use

The inbound service interface Entries for Employee Time Sheet In contains operations that import the permitted values for an employee for the input help in the user interface.

Prerequisites

You have previously used the Read Employee Time Sheet Configuration [Seite 700 ] operation to read the fields for representing the input help on the user interface.

Integration

The Entries for Employee Time Sheet In inbound service interface belongs to the Time and



Find Allowed Receiving Cost Centres by Employee

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeTimeSheetAllowedReceivingCostCentre

ByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetAlRCstCtrEmpQR

Definition

Finds the permitted Receiving Cost Centers for an individual employee.



Use

The Find Allowed Receiving Cost Centers by Employee inbound operation provides the permitted cost centers for an individual employee, as well as the related values. You can use this operation to offer the cost centers in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedReceivingCostCentreByEmployeeQuery

In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the

AllowedReceivingCostCenters for all of the employee's work agreements.

EmployeeTimeSheetAllowedReceivingCostCentreByEmployeeResponse


Integration

This inbound operation belongs to the Entries for Employee Time Sheet [Seite 667 ] inbound service interface.


Prerequisites

To be able to use this function, the values must be available in the time sheet worklist. The following prerequisites must therefore be fulfilled:

You have to specify in Customizing that you want to use a worklist and how you want to fill the worklist. The In process since method is particularly effective for this purpose.

The values for the corresponding search help field must be available in the employee’s worklist.

Processing

The operation delivers the cost center (data element KOSTL).

The system also takes account of the values in the worklist that were read by an SAP enhancement.

The Business Add-In (BAdI) CATS_ESA_PICKLS ( Populate ESA Picklists ) is available for this operation. You can use it in the response message to fill an additional column containing information.

Find Allowed Network by Employee

Technical Data

Entity Type





Service operation

EmployeeTimeSheetAllowedNetworkBy

EmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global




Category

Mode


Inbound

Synchronous

ECC_EmpTimSheetAlNetEmpQR

Definition

Finds the permitted Networks for an individual employee.

Use

The Find Allowed Network by Employee inbound operation provides the permitted networks for an individual employee, as well as the related values. You can use this operation to offer the networks in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedNetworkByEmployeeQuery

In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the AllowedNetworks for all of the employee's work agreements.

EmployeeTimeSheetAllowedNetworkByEmployeeResponse


Integration



Prerequisites




Processing

The operation provides the following data

Network Number (data element NW_AUFNR)

Activity Number (data element VORNR)

Subactivity Number (data element UVRNR)





Find Allowed Order by Employee

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeTimeSheetAllowedOrderByEmployee

QueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetAlOrdEmpQR

Definition

Finds the permitted Orders for an individual employee.

Use

The Find Allowed Order by Employee inbound operation provides the permitted receiving orders for an individual employee, as well as the related values. You can use this operation to offer the receiving orders in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedOrderByEmployeeQuery

In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the AllowedOrders for all of the employee's work agreements.

EmployeeTimeSheetAllowedOrderByEmployeeResponse


Integration



Prerequisites






Processing

The operation provides the following data:

Receiving Order (data element EAUFNR)

Activity Number (data element VORNR)

Subactivity (data element UVORN)

The system also takes account of the values in the worklist that are read by an SAP enhancement.


Find Allowed Work Break Down Structure Element by Employee

Technical Data


Technical

Name in

Enterprise

Service

Repository

(ESR)

EmployeeTimeSheetAllowedWorkBreakDownStructureElementByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global Namespace in ESR

Software

Component

Version in

ESR


Category

Mode

Related

Web

Service

Inbound

Synchronous

ECC_EmpTimSheetAlWBDStEEmpQR

Definition

Finds the permitted Work Break Down Structure Element s for an individual employee.

Use

The Find Allowed Work Break Down Structure Element by Employee inbound operation provides the permitted work break down structure elements (WBS elements) for an individual employee, as well as the related values. You can use this operation to offer the work break down structure elements in a picklist on the user interface.

Features




EmployeeTimeSheetAllowedWorkBreakDownStructureElementByEmployeeQuery


AllowedWorkBreakDownStructureElement s for all of the employee's work agreements.

EmployeeTimeSheetAllowedWorkBreakDownStructureElementByEmployeeResponse


Integration



Prerequisites




Processing

The operation delivers the work break down structure element (WBS element) (data element PS_POSID).

The system also takes account of the values in the worklist that are read by a customer enhancement.


Find Allowed Measure Unit by Employee

Technical Data

Entity Type



Service operation

EmployeeTimeSheetAllowedMeasureUnitByEmployee

QueryResponse_In



Category

Mode


Inbound

Synchronous

ECC_EmpTimSheetAlMsrUntEmpQR

Definition

Finds the permitted Units of Measurement for an individual employee.



Use

The Find Allowed Measure Unit by Employee inbound operation provides the permitted units of measure for an individual employee, as well as the related values. You can use this operation to offer the units of measure in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedMeasureUnitByEmployeeQuery

In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the AllowedMeasureUnits for all of the employee's work agreements.

EmployeeTimeSheetAllowedMeasureUnitByEmployeeResponse


Integration



Processing

The operation delivers the unit of measurement (data element MSEHI). The system determines the units of measurement from the V_CATS_MY_UNITS table ( Units Used in CATS notebook ).


Find Allowed Employee Time Item Types by

Employee

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeTimeSheetAllowedEmployeeTimeItem

TypeByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetAlEmpTITyEmpQR

Definition

Finds the permitted Employee Time Item Types for an individual employee.



Use

The Find Allowed Employee Time Item Types by Employee inbound operation provides the permitted attendance and absence types and wage types for employee remuneration information for the employee. You can use this operation to offer the attendance/absence types and wage types in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedEmployeeTimeItemTypeByEmployeeQuery


AllowedEmployeeTimeItemTypes for all of the employee's work agreements.

EmployeeTimeSheetAllowedEmployeeTimeItemTypeByEmployeeResponse


Integration



Processing

The operation provides the following data:

Attendance/Absence Type (data element AWART) The system determines the attendance and absence types that are valid for the employee using the

V_T554S_ESSEX table ( ESS: Deactivate Attendance/Absence Types ). For more information, see the Implementation Guide for Employee Self Service and choose:

Service-Specific Settings Working Time Record Working Time Select Allowed

Absence Types .

Wage Types that are, on one hand permitted for the employee, and on the other hand are determined for recording employee remuneration information.


Find Allowed Resource Class by Employee

Technical Data

Entity Type





Category

Mode

Service operation

EmployeeTimeSheetAllowedResourceClassBy



Inbound

Synchronous



Related Web Service ECC_EmpTimSheetAlResClsEmpQR

Definition

Finds the permitted Resource Classes for an individual employee.

Use

The Find Allowed Resource Class by Employee inbound operation provides the permitted resource classes for an individual employee, as well as the related values. You can use this operation to offer the ResourceClasses in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedResourceClassByEmployeeQuery

In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the AllowedResourceClasses for all of the employee's work agreements.

EmployeeTimeSheetAllowedResourceClassByEmployeeResponse


Integration



Processing

The operation delivers the activity type (data element LSTAR). The system determines the activity type by means of the master cost center that is specified for the employee in the Organizational Assignment (0001) or Time Sheet Defaults infotype (0315). It outputs all activity types that are scheduled for the cost center on the current date.


Find Allowed Purchase Orders by Employee

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeTimeSheetAllowedPurchaseOrderBy



Inbound

Synchronous

ECC_EmpTimSheetAlPurOrdEmpQR



Definition

Finds the permitted Purchase Orders for an individual employee.

Use

The Find Allowed Purchase Orders by Employee inbound operation provides the permitted sending orders for an individual employee, as well as the related values. You can use this operation to offer the sending purchase orders in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedPurchaseOrderByEmployeeQuery

In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the AllowedPurchaseOrders for all of the employee's work agreements.

EmployeeTimeSheetAllowedPurchaseOrderByEmployeeResponse


Integration



Prerequisites




Processing

The operation provides the Sending Purchase Order (data element SEBELN) and the

Sending Purchase Order Item (data element SEBELP).



Find Allowed Controlling Key Figures by

Employee

Technical Data




Technical

Name in

Enterprise

Service

Repository

(ESR)

Namespace in

ESR

Software

Component

Version in ESR

Category

Mode

Related Web

Service

EmployeeTimeSheetAllowedControllingKeyFiguresByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetAlCtrlKFigEmpQR

Definition

Finds the permitted Controlling Key Figures for an individual employee.

Use

This inbound operation provides the permitted statistical key figures for an individual employee as well as related values. You can use this operation to offer the statistical key figures in input help on the user interface.

Features


EmployeeTimeSheetAllowedControllingKeyFiguresByEmployeeQuery


AllowedControllingKeyFigures for all of the employee's work agreements.

EmployeeTimeSheetAllowedControllingKeyFiguresByEmployeeResponse


Integration



Processing

The operation delivers the statistical key figure (data element STAGR). The system reads all summitry statistical key figures.




Find Allowed Service Products by Employee

Technical Data

Entity Type





Service operation

EmployeeTimeSheetAllowedServiceProductByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Version in ESR


Category

Mode

Inbound

Synchronous

Related Web Service ECC_EmpTimSheetAlSerPrdEmpQR

Definition

Finds the permitted Service Products for an individual employee.

Use

The Find Allowed Service Products by Employee inbound operation provides the permitted service products for an individual employee, as well as the related values. You can use this operation to offer the service products in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedServiceProductByEmployeeQuery

In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the AllowedServiceProducts for all of the employee's work agreements.

EmployeeTimeSheetAllowedServiceProductByEmployeeResponse


Integration



The operation delivers the activity number (data element ASNUM). The system uses the Time Sheet Defaults infotype (0315) to determine the activity number for the employee.




Find Allowed Warranty Goodwill Types by

Employee

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)

Namespace in

ESR

Software

Component

Version in

ESR

Category

Mode

Related Web

Service

Service operation

EmployeeTimeSheetAllowedWarrantyGoodwillTypeByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetAlWrtGwlTyEmpQR

Definition

Finds the permitted Warranty Goodwill Types for an individual employee.

Use

The Find Allowed Warranty Goodwill Types by Employee inbound operation provides the permitted accounting indicator for an individual employee, as well as the related values. An accounting indicator is a criteria that can differentiate costs and revenues within service processing in Controlling. In addition to differentiating between cost elements, the accounting indicator is an additional differentiation criteria. You can use it to account for costs incurred and revenue obtained, for example, according to revenue, warranty or goodwill.

You can use this operation to offer the accounting indicators in a picklist on the data entry user interface.

Features


EmployeeTimeSheetAllowedWarrantyGoodwillTypeByEmployeeQuery


AllowedWarrantyGoodwillTypes for all of the employee's work agreements.

EmployeeTimeSheetAllowedWarrantyGoodwillTypeByEmployeeResponse


Integration





Processing

The operation delivers the a ccounting indicator (data element BEMOT).


Find Allowed Receiving Funds Management

Functional Areas by Employee

Technical Data


Technical

Name in

Enterprise

Service

Repository

(ESR)

EmployeeTimeSheetAllowedReceivingFundsManagementFunctionalAreaByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global Namespace in ESR

Software

Component

Version in

ESR

Category

Mode


Inbound

Synchronous

ECC_EmpTimSheetAlRecFdMFAEmpQR Related

Web

Service

Definition

Finds the permitted Receiving Funds Management Functional Areas for an individual employee.

Use

The Find Allowed Receiving Funds Management Functional Areas by Employee inbound operation provides the permitted functional areas of a receiving funds management for an individual employee, as well as the related values. You can use this operation to offer the functional areas in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedReceivingFundsManagementFunctionalAreaByEmployee

Query




AllowedReceivingFundsManagementFunctionalAreas for all of the employee's work agreements.

EmployeeTimeSheetAllowedReceivingFundsManagementFunctionalAreaByEmployee

Response


Integration



Prerequisites



The values for the corresponding search help field must be available in the employee’s worklist. The system also takes account of the values in the worklist that are read by a customer enhancement.

Processing

The operation delivers the functional area (data element FKBER).


Find Allowed Receiving Funds by Employee

Technical Data

Entity Type






Version in ESR

Service operation

EmployeeTimeSheetAllowedReceivingFundByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Category

Mode

Inbound

Synchronous

Related Web Service ECC_EmpTimSheetAlRecFundEmpQR

Definition

Finds the permitted Receiving Funds for an individual employee.



Use

The Find Allowed Receiving Funds by Employee inbound operation provides the permitted funds for an individual employee, as well as the related values. You can use this operation to offer the funds in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedReceivingFundByEmployeeQuery

In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the AllowedReceivingFunds for all of the employee's work agreements.

EmployeeTimeSheetAllowedReceivingFundByEmployeeResponse


Integration



Prerequisites




Processing

The operation provides the fund (data element BP_GEBER).

The system also takes account of the values in the worklist that are read by an SAP enhancement.


Find Allowed Receiving Grants by Employee

Technical Data

Entity Type





Service operation

EmployeeTimeSheetAllowedReceivingGrantByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global




Version in ESR


Category

Mode

Inbound

Synchronous

Related Web Service ECC_EmpTimSheetAlRecGrtEmpQR

Definition

Finds the permitted Receiving Grants for an individual employee.

Use

The Find Allowed Receiving Grants by Employee inbound operation provides the permitted receiving grants for an individual employee, as well as the related values. You can use this operation to offer the grants in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedReceivingGrantByEmployeeQuery

In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the AllowedReceivingGrants for all of the employee's work agreements.

EmployeeTimeSheetAllowedReceivingGrantByEmployeeResponse


Integration



Prerequisites




Processing

The operation delivers the grant (data element GM_GRANT_NBR).





Find Allowed Receiving Costing Activities by

Employee

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode

Related Web

Service

Service operation

EmployeeTimeSheetAllowedReceivingCostingActivityByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetAlRecCoActEmpQR

Definition

Finds the permitted Receiving Costing Activities for an individual employee.

Use

The Find Allowed Receiving Costing Activities by Employee inbound operation provides the permitted receiving costing activities for an individual employee, as well as the related values.

You can use this operation to offer the receiving costing activities in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedReceivingCostingActivityByEmployeeQuery


AllowedReceivingCostingActivities for all of the employee's work agreements.

EmployeeTimeSheetAllowedReceivingCostingActivityByEmployeeResponse


Integration





Prerequisites




Processing

The operation delivers the business process (data element CO_PRZNR).



Find Allowed Currencies by Employee

Technical Data

Entity Type






Version in ESR

Category

Mode


Service operation

EmployeeTimeSheetAllowedCurrencyByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetAlCurrEmpQR

Definition

Finds the permitted Currencies for an individual employee.

Use

The Find Allowed Currencies by Employee inbound operation provides the permitted currency keys for an individual employee, as well as the related values. You can use this operation to offer the currency keys in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedCurrencyByEmployeeQuery



In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the AllowedCurrencie s for all of the employee's work agreements.

EmployeeTimeSheetAllowedCurrencyByEmployeeResponse


Integration



The operation delivers the currency key (data element WAERS).


Find Allowed Task Types by Employee

Technical Data

Entity Type






Version in ESR


Transfer Mode


Service operation

EmployeeTimeSheetAllowedTaskTypeByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetAlTskTyEmpQR

Definition

Finds the permitted Task Types for an individual employee.

Use

The Find Allowed Task Types by Employee inbound operation provides the permitted task types for an individual employee, as well as the related values. You can use this operation to offer the task types in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedTaskTypeByEmployeeQuery

You have to fill the Employee_ID or the WorkAgreement_ID . If you only fill the

Employee_ID , the system determines the AllowedTaskTypes for all of the employee's work agreements.



EmployeeTimeSheetAllowedTaskTypeByEmployeeResponse


Integration



Processing


Find Allowed Task Levels by Employee

Technical Data

Entity Type






Version in ESR

Category

Mode


Service operation

EmployeeTimeSheetAllowedTaskLevelByEmployeeQueryResponse_In, http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetAlTskLvlEmpQR

Definition

Finds the permitted Task Levels for an individual employee.

Use

The Find Allowed Task Levels by Employee inbound operation provides the permitted task levels for an individual employee, as well as the related values. You can use this operation to offer the task levels in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedTaskLevelByEmployeeQuery


Employee_ID , the system determines the AllowedTaskLevels for all of the employee's work agreements.

EmployeeTimeSheetAllowedTaskLevelByEmployeeResponse




Integration



Processing

The system uses the Time Sheet Defaults infotype (0315) to determine the activity number for the employee.


Find Allowed Task Components by Employee

Technical Data

Entity Type




Service operation

EmployeeTimeSheetAllowedTaskComponentByEmployeeQueryResponse_In


Software



Category

Mode

Inbound

Synchronous

Related Web Service ECC_EmpTimSheetAlTskCmpEmpQR

Definition

Finds the permitted Task Components for an individual employee.

Use

The Find Allowed Task Components by Employee inbound operation provides the permitted task components for an individual employee, as well as the related values. You can use this operation to offer the task components in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedTaskComponentByEmployeeQuery

In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the AllowedTaskComponents for all of the employee's work agreements.



EmployeeTimeSheetAllowedTaskComponentByEmployeeResponse


Integration



Processing

The operation delivers the task component (data element CATSTASKCOMPONENT).

Find Allowed Receiving Sales Orders by Employee

Technical Data

Entity Type


Service

Repository

(ESR)

Namespace in

ESR

Software

Component

Version in ESR

Category

Mode

Related Web

Service

Service operation

EmployeeTimeSheetAllowedReceivingSalesOrderByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimSheetAlRSalOrdEmpQR

Definition

Finds the permitted Receiving Sales Orders for an individual employee.

Use

The Find Allowed Receiving Sales Orders by Employee inbound operation provides the permitted receiving sales orders for an individual employee, as well as the related values. You can use this operation to offer the sales orders in a picklist on the user interface.

Features


EmployeeTimeSheetAllowedReceivingSalesOrderByEmployeeQuery


Employee_ID , the system determines the AllowedReceivingSalesOrder for all of the employee's work agreements.



EmployeeTimeSheetAllowedReceivingSalesOrderByEmployeeResponse


Integration



Prerequisites

To be able to use this operation, the values must be available in the Time Sheet worklist. The following prerequisites must therefore be fulfilled:



Processing

The operation delivers the Receiver Sales Order (data element EKDAU).



Find Allowed Projects by Employee

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeTimeSheetAllowedProjectBy



Inbound

Synchronous

ECC_EmpTimSheetAlPrjEmpQR

Definition

Finds the permitted projects for an employee.



Use

The Find Allowed Projects by Employee inbound operation provides the permitted projects for an individual employee, as well as the related values. You can use this operation to offer the projects in a picklist on the user interface.

Features

The Find Allowed Projects by Employee inbound operation processes the following message types:

EmployeeTimeSheetAllowedProjectByEmployeeQuery_sync

In this message, either the Employee_ID or the WorkAgreement_ID must be filled. If you only fill the Employee_ID , the system determines the projects for all of the employee's work agreements.

You do not need to specify a date in the message type. However, you should ensure that you only import the currently valid projects into the back-end system

EmployeeTimeSheetAllowedProjectByEmployeeResponse_sync

In addition to the reference to a project, the response message contains references to either a work breakdown structure element (WBS Element), or to a receiver order.

Retain these values in the application to ensure the unique identification of a project.


Integration



Processing

If you do not specify a date in the query message, the system determines the currently valid projects, depending on the time sheet’s current valid data entry period. The system determines this using the period type given for the employee’s data entry profile in

Customizing.

Employee Time Agreement

Technical Data

Entity Type



Definition

Summarizes the legal regulations agreed with an employee and relevant for time management.



Use

The Employee Time Agreement business object provides the agreements and rules that are valid for an employee upon fulfilling working times. Each Employee Time Agreement represents an employee's individual work relationship with an employer. The agreements and rules can come from individual agreements of a work agreement, but can also come from company policies and collective agreements, for example.

Rules determine the following for each employee:

Employee's annual leave entitlement

Duration of daily working time to be performed

Guidelines for recording employee times. This can include, for example, guidelines that determine whether an employee may exceed or fall short of the planned working time when recording times.

The defined agreements are a prerequisite for subsequent processes such as recording time, managing time accounts and time evaluation. They affect the layout of the user interfaces to be provided as, for example, they make certain information or functions, such as displaying the daily planned working time on the user interface, necessary.

Employee-specific Time and Labour Management business objects, such as EmployeeTime or EmployeeTimeCalendar , always refer to an EmployeeTimeAgreement .

Manage Employee Time Agreement In

Technical Data

Entity Type


Category

Mode

Service interface


ECC-SE 501)

Inbound

Synchronous

Definition

Group of operations that create, change, delete or update an Employee Time Agreement In , or parts of it.

Use

The Manage Employee Time Agreement In inbound service interface groups operations that can process the following information:

Imports specifications for recording employee times

Read, create and delete Rules for Standard Account Assignment

Only one Rule for Standard Account Assignment is permitted for each period and work agreement of an employee.



Prerequisites

You implement the Standard Account Assignment function.

You provide a function in your user interface with which users can import, create and delete the Standard Account Assignment for a particular period.

Integration

The Manage Employee Time Agreement In inbound service interface belongs to the Time and

Labour Management [Seite 653 ] process component and the Employee Time Agreement


Structure

The Manage Employee Time Agreement In inbound service interface groups the following operations:

CreateTimeRecordingCompletionRule ( Create Time Recording Completion Rule

[Seite 693 ] )

CancelTimeRecordingCompletionRule ( Cancel Time Recording Completion

Rule [Seite 695 ] )

ReadTimeRecordingCompletionRule ( Read Time Recording Completion Rule

[Seite 696 ] )

ReadTimeRecordingProvisions ( Read Time Recording Provisions [Seite 697 ] )


For information about processing standard account assignment in the SAP system, see Standard Account Assignments with the Time Sheet (CATS) [Seite

662 ] .

Create Time Recording Completion Rule

Technical Data


Technical

Name in

Enterprise

Service

Repository

(ESR)

EmployeeTimeAgreementTimeRecordingCompletionRuleByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global Namespace in ESR

Software

Component

Version in

ESR

Category

Mode


Inbound

Synchronous



Related

Web

Service

ECC_EmpTimAgrTimRecCoRuleCrtRC

Definition

Creates Time Recording Completion Rules (Rules for Standard Account Assignment) .

Use

The Create Time Recording Completion Rule inbound operation transfers the Rules for

Standard Account Assignment for an individual employee to the back-end system. This allows you to, using these rules, create automatic employee times in the back-end system.

Features


EmployeeTimeAgreementTimeRecordingCompletionRuleCreateRequest

EmployeeTimeAgreementTimeRecordingCompletionRuleCreateConfirmation


One of the following specifications must be in the request and confirmation message:

ActivityAllocationAndCostAssignment

ServiceProvisionAndResourceConsumption

LogisticConfirmation

ExternalServiceAcknowledgement

DifferentPayment

If employees have multiple work agreements, they can create a Rule for

Standard Account Assignment for each work agreement.

Prerequisites

Your back-end system is able to automatically fill working times that contain no data with employee times that are assigned with the supplied standard account assignment.

Integration

This inbound operation belongs to the Manage Employee Time Agreement [Seite 692 ] inbound service interface.


For information about automatically generating employee times for the Time

Sheet , see Standard Account Assignments with the Time Sheet (CATS) [Seite

662 ] .

Prerequisites

Although the WorkAgreementID is indicated as optional in the

EmployeeTimeAgreementTimeRecordingCompletionRuleCreateRequest message type, it is required for transferring data to the SAP Cross-Application Time Sheet (CATS).



Processing

The back-end system checks the transferred rule using the following factors:

There must be only one Rule for Standard Account Assignment for each period and work agreement However, periods that do not have a Rule for Standard Account

Assignment defined are permitted

When creating a rule, the back-end system delimits any existing rule for the period with the start date -1 of the new rule

The percentage values entered in a rule must not exceed 100%. They may total less than 100%

Cancel Time Recording Completion Rule

Technical Data


Technical

Name in

Enterprise

Service

Repository

(ESR)


EmployeeTimeAgreementTimeRecordingCompletionRuleCancelRequestConfirmation_In http://sap.com/xi/EA-HR/SE/Global

As of ESA ECC-SE 501 Software

Component

Version in

ESR

Category

Mode

Related

Web

Service

Inbound

Synchronous

ECC_EmpTimAgrTimRecCoRuleCncRC

Definition

Deletes a Time Recording Completion Rule (Rule for Standard Account Assignment) .

Use

The Cancel Time Recording Completion Rule inbound operation deletes the valid Rule for

Standard Account Assignment for an individual employee in the back-end system. If employees have multiple work agreements, they must delete the Rule for Standard Account

Assignment for each period and work agreement.

Features


EmployeeTimeAgreementTimeRecordingCompletionRuleCancelConfirmation

EmployeeTimeAgreementTimeRecordingCompletionRuleCancelRequest




Integration



For information about automatically generating employee times for the time sheet, see Standard Account Assignments with the Time Sheet (CATS) [Seite

662 ] .

Prerequisites


EmployeeTimeAgreementTimeRecordingCompletionRuleCancelRequest message type, it is required for communicating with the SAP Cross-Application Time Sheet (CATS).

Processing

Only one Rule for Standard Account Assignment is permitted for each period and work agreement of the employee. However, periods that do not have a Rule for Standard Account

Assignment are permitted.

Read Time Recording Completion Rule

Technical Data


Technical

Name in

Enterprise

Service

Repository

(ESR)

EmployeeTimeAgreementTimeRecordingCompletionRuleByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global Namespace in ESR

Software

Component

Version in

ESR

Category

Mode


Inbound

Synchronous

ECC_EmpTimAgrTimRecCoRuleEmpQR Related

Web

Service

Definition

Reads the Time Recording Completion Rule (Rule for Standard Account Assignment) .



Use

The Read Time Recording Completion Rule inbound operation transfers the Rules for

Standard Account Assignment for an individual employee from the back-end system to the application. You can use the operation to, for example, inform users on the user interface about the Rules for Standard Account Assignment they have created.

Features


EmployeeTimeAgreementTimeRecordingCompletionRuleByEmployeeQuery

In this message either the Employee_ID or the WorkAgreement_ID must be filled. If only the Employee_ID is filled, the operation returns all

EmployeeTimeAgreementTimeRecordingCompletionRules that are available for the employee’s relevant work agreements.

EmployeeTimeAgreementTimeRecordingCompletionRuleByEmployeeResponse


Integration



For information about automatically generating employee times for the time sheet, see Standard Account Assignments with the Time Sheet (CATS) [Seite

662 ] .

Prerequisites


EmployeeTimeAgreementTimeRecordingCompletionRuleByEmployeeResponse message type, it is required for processing using the SAP Cross-Application Time Sheet (CATS).

Read Time Recording Provisions

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)

Namespace in

ESR

Software

Component

Version in

ESR

Service operation

EmployeeTimeAgreementTimeRecordingProvisionsByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global




Category

Mode

Related Web

Service

Inbound

Synchronous

ECC_EmpTimAgrTimRecProEmpQR

Definition

Reads the Time Recording Provisions .

Use

The Read Time Recording Provisions inbound operation transfers the permitted guidelines for recording time for an individual employee to the application. You defined these guidelines when setting up the system to control time recording and to check recorded employee times in the back-end system.

Features


EmployeeTimeAgreementTimeRecordingProvisionsByEmployeeQuery

In this message either the Employee_ID or the WorkAgreement_ID must be filled. If only the Employee_ID is filled, the operation returns all

EmployeeTimeAgreementTimeRecordingProvisions that are available for the employee’s relevant work agreements.

EmployeeTimeAgreementTimeRecordingProvisionsByEmployeeResponse



Processing

The operation provides the following Customizing settings from the data entry profile that is valid for the employee from the SAP system:

Release Future Times (data element CATSFUTURE)

Release on Saving (data element CATSFREEAT)

System Reaction to Entering More Than 24 Hours per Day (data element

CATSMAXHRR)

System Reaction to Exceeding the Target Time over Tolerance (data element

CATSOVERRE)

Limit for Exceeding the Target Time in Percent (data element CATSOVERTA)

System Reaction to Falling Short of the Target Time Under Tolerance (data element

CATSUNDERR)

Limit for Falling Short of the Target Time in Percent (data element CATSUNDERT)

To determine the data entry profile that is valid for the employee, the system first checks whether a profile has been entered in the user parameter CVR. If there is no profile in the user parameter, the system uses the ESS profile. If there is no ESS profile, the system issues an error message.



Employee Time Sheet Configuration

Technical Data

Entity Type



Definition

Functional and user interface relevant arrangement of an Employee Time Sheet , related to the requirements of a company. The Employee Time Sheet Configuration consists of settings for the Employee Time Sheet .

Use

The Employee Time Sheet Configuration business object contains operations with which you can provide appropriate user interfaces and input help, depending on the business processes that you want to supply with employee times. It provides information on the valid field selections for an employee, as well as simple checks for recording employee times.


Employee Time Sheet [Seite 654 ]


Prerequisites

To use this business object you must have modified the Field Selections for recording employee times in SAP Cross-Application Time Sheet (CATS) Customizing to fit the requirements of the respective business processes.

Constraints

Not all cross-application time sheet settings are transferred to the interface. The system checks the settings that are not transferred when posting the data to the back-end system.

Manage Employee Time Sheet Configuration In

Technical Data

Entity Type


Category

Mode

Service interface


ECC-SE 501)

Inbound

Synchronous

Definition

Group of operations for creating, changing, reading or deleting the Employee Time Sheet

Configuration In .



Use

The Manage Employee Time Sheet Configuration In inbound service interface includes an operation that reads the relevant information for structuring a user interface from the system set-up for an employee.

Integration

The Manage Employee Time Sheet Configuration In inbound service interface belongs to the

Time and Labour Management [Seite 653 ] process component and the Employee Time Sheet

Configuration [Seite 699 ] business object.

Structure

The Manage Employee Time Sheet Configuration In inbound service interface contains the

EmployeeTimeSheetConfigurationByEmployeeQueryResponse_In inbound operation ( Read Employee Time Sheet Configuration [Seite 700 ] ).

Read Employee Time Sheet Configuration

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeTimeSheetConfigurationByEmployee



Inbound

Synchronous

ECC_EmpTimSheetConfEmpQR

Definition

Reads the Employee Time Sheet Configuration .

Use

The Read Employee Time Sheet Configuration inbound operation returns the valid settings for an individual employee for selecting the fields for employee time recording. You can use it to import the relevant fields for employee time recording and to offer a picklist for these fields.

This means that you can tailor the number of fields displayed on the user interface to suit the business processes to which data is transferred and employees tasks.

The operation assumes that an employee only ever uses one data entry profile for each user or work agreement.


You use the operations of the Entries for Employee Time Sheet [Seite 667 ] service interface to import the individual valid values for the picklists for each employee.

Features




EmployeeTimeSheetConfigurationByEmployeeQuery


EmployeeTimeSheetConfiguration for all of the employee's work agreements.

EmployeeTimeSheetConfigurationByEmployeeResponse

This message assumes that you have defined a field selection for recording employee time using data entry profiles in your back-end system.


The Read Employee Time Sheet Configuration inbound operation determines the system settings for each of the employee's work agreements. It also provides information on the characteristics defined in the field selection of each field.

Prerequisites

If you set up multiple data entry profiles for each work agreement for your employees, you must provide a corresponding function for selecting the data entry profile in your application.

Integration

This inbound operation belongs to the Manage Employee Time Sheet Configuration [Seite



Prerequisites

You have set up a corresponding data entry profile in the SAP back-end system for the necessary user interfaces.

You have compiled a suitable field selection for this data entry profile.

Processing

The operation reads the fields from the field selection that you created in Customizing for the data entry profiles of the employees. This also includes customer fields.

Information about the ready-for-input status and tool tips, texts, and field lengths is provided.

The operation displays the fields as follows:

Multi-purpose fields and related fields are displayed uniquely. The activity and subactivity are used in this way for several fields (order, network). To display the relationship to the main fields, the back-end system renames the affected fields to indicate whether an activity belongs to an order or a network. When entering data, users can confirm only to the activity of one type, otherwise the back-end system issues an error message.

The system specifies customer fields for the time sheet with the name you entered in the component in the CI_CATSDB customer include.

To determine the data entry profile that is valid for the employee, the SAP back-end system first checks whether a profile has been entered in the user parameter CVR. If no profile is specified in the user parameter, the system uses the ESS profile. If there is no ESS profile, the system issues an error message.

The Business Add-In (BAdI) TS_CONFIG_CONV ( Conversions for Proxy: Time Sheet

Configuration ) is available for this operation.



Employee Time Calendar

Technical Data

Entity Type



Definition

A calendar representation of the evaluation results of the recorded employee times.

Use

The Employee Time Calendar business object provides the durations of time that are necessary for a particular evaluation step.

Manage Employee Time Calendar In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations that create, change, delete or update an Employee Time Calendar In , or parts of it.

Use

The Manage Employee Time Calendar In inbound service interface contains an operation that can import the planned working times for an employee.

Integration

The Manage Employee Time Calendar In inbound service interface belongs to the Time and

Labour Management [Seite 653 ] process component and the Employee Time Calendar [Seite


Structure

The Manage Employee Time Calendar In inbound service interface contains the

EmployeeTimeCalendarPlannedWorkingTimeByEmployeeQueryResponse_In inbound operation ( Read Employee Time Calendar Planned Working Time [Seite 703 ] ).



Read Employee Time Calendar Planned Working

Time

Technical Data

Entity Type




Service operation

EmployeeTimeCalendarPlannedWorkingTimeByEmployeeQueryResponse_In


Software



Category

Mode

Related Web

Service

Inbound

Synchronous

ECC_EmpCalPldWkgTimEmpQR

Definition

Transfers the planned working times from the Employee Time Calendar .

Use

The Read Employee Time Calendar Planned Working Time inbound operation enables you to import the planned working times of an individual employee for a particular period.

You can use this information, for example, in a user interface to display the duration of working times to document each day for the employees and to evaluate the recorded employee times. Employees are supported so that they do not exceed or fall short of the planned working time for a day.

Features


EmployeeTimeCalendarPlannedWorkingTimeByEmployeeQuery

In this message either the Employee_ID or the WorkAgreement_ID must be filled. If only the Employee_ID is filled, the operation returns all planned working times that are available for the employee’s relevant work agreements.

EmployeeTimeCalendarPlannedWorkingTimeByEmployeeResponse


Prerequisites

You have saved the employee's planned working times in your back-end system.

Integration

This inbound operation belongs to the Manage Employee Time Calendar [Seite 702 ] inbound service interface.




Prerequisites

You have selected the With Target Hours field in Time Sheet (CATS) Customizing in the required data entry profiles.

In the data entry profile you have determined how planned working hours are determined from Time Management , or have set up the SAP enhancement

CATP0001.

Constraints

This operation allows you to import the planned working times only using Time Sheet

Customizing. It is not possible to directly access the employee's Personal Work Schedule from Time Management .

Query Employee Time Calendar In

Technical Data

Entity Type


Category

Mode

Service interface


ECC-SE 600)

Inbound

Synchronous

Definition

Group of operations to find the Employee Time Calendars In with relevant selection criteria using individual interfaces.

Use

The Query Employee Time Calendar In inbound service interface contains an operation that can determine the availability of an employee.

Integration

The Query Employee Time Calendar In inbound service interface belongs to the Time and

Labour Management [Seite 653 ] process component and the Employee Time Calendar [Seite


Structure

The Query Employee Time Calendar In inbound service interface contains the Find

Availability by Employee [Seite 705 ] inbound operation.



Find Availability by Employee

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeTimeCalendarAvailabilityByEmployee



Inbound

Synchronous

ECC_EmpTimCalAvailEmpQR

Definition

Imports an individual employee’s availability.

Use

The Find Availability by Employee inbound operation imports information for a particular period and employee; whether an employee is available for the period, or if he or she can be scheduled for activities.

You can use this operation to provide your managers, project leads and supervisors with an application for quickly importing the availability status of employees in their group.

Features

The Find Availability by Employee inbound operation processes the following message types:

EmployeeTimeCalendarAvailabilityByEmployeeQuery_sync

In this message, in addition to a period, the SelectionbyEmployeeID or the

SelectionbyWorkAgreementID must be specified as a selection criterion.

EmployeeTimeCalendarAvailabilityByEmployeeResponse_sync

The following availability statuses are possible:

4 – Available

5 – Not Available

6 – Partially Available

7 – Availability Not Determined


Integration

This inbound operation belongs to the Query Employee Time Calendar [Seite 704 ] inbound service interface.




Processing

To determine the availability status, the SAP back-end system first reads the data from the

TimeAvailSchedule BAPI. For each hour of the day, the BAPI checks whether the employee should be at work and whether or not he or she is actually at work at this time.

For more information, see the documentation for the function module or the

BAPI_TIMEAVAILSCHEDULE_BUILD method (generate list of employee availability).

The system then reads employees’ absences from the request database. The system checks whether requests that have not yet been approved are in the request database. If it finds requests that have not yet been approved, it outputs the status Availability Not Determined.

For each hour of the day, the system then checks the availability status determined by the

BAPI and from this determines the status that is output for the whole day. That is, even if an employee is absent for just one hour during the day, the status output for the employee is

Temporarily Absent.

Employee Time

Technical Data

Entity Type



Definition

Document on working times of an internal or external employee. In addition to planned and actual working times and activities carried out for the company, it also documents absence times, break times, and availability times.

Use

The Employee Time business object documents the recorded employee times. This allows you to display recorded employee times on user interfaces, or vacation and shift planning.

Depending on the business process in which the Employee Time is used or processed, it contains information for use in Controlling, for confirmations for projects or orders, invoicing, payroll, and to determine availability.


Processing

This business object processes the following employee times from the ERP system:

Data Sources for Employee Times from the ERP System

Application Component

Time Sheet (CA-TS)

Time Management (PT)

Data Source

CATSDB

Absences infotype (2001)



Attendances infotype (2002)

Employee Remuneration Information infotype

(2010)

Query Employee Time In

Technical Data

Entity Type


Category

Mode

Service interface


ECC-SE 501)

Inbound

Synchronous

Definition

Group of operations to find the Employee Time with relevant selection criteria using individual interfaces.

Use

The Query Employee Time In inbound service interface contains an operation that can import employee times, depending on the information provided for subsequent business processes for multiple employees.

Integration

The Query Employee Time In inbound service interface belongs to the Time and Labour

Management [Seite 653 ] process component and the Employee Time [Seite 706 ] business object.

Structure

The Query Employee Time In inbound service interface contains the

EmployeeTime ForEmployeeTimeSheetByElementsQueryResponse_In inbound operation ( Find Times for Employee Time Sheet By Elements [Seite 707 ] ).

Find Times for Employee Time Sheet by Elements

Technical Data

Entity Type





Service operation

EmployeeTimeForEmployeeTimeSheetByElementsQueryResponse_In http://sap.com/xi/EA-HR/SE/Global




Version in ESR

Category

Mode


Definition


Inbound

Synchronous

ECC_EmpTimFEmpTimSheetEleQR

Definition

Reads Employee Times for the Employee Time Sheet depending on the given elements.

Use

The Find Times for Employee Time Sheet by Elements inbound operation imports employee times (including long texts) of one or more employees. You can select the employee times using the information about the subsequent business processes.

You can use this operation, for example, to import the recorded employee times into an application for reporting employee times for particular projects or orders.


If you want to import employee times to support recording employee times, the Find

Employee Time Sheet by Employee [Seite 665 ] operation is most suitable.

If you want to import employee times with human resources information, you can use the

Read Employee Time by Employee [Seite 709 ] operation.

Features


EmployeeTimeForEmployeeTimeSheetByElementsQuery

EmployeeTimeForEmployeeTimeSheetByElementsResponse


Integration

This inbound operation belongs to the Query Employee Time [Seite 707 ] inbound service interface .


Processing

You use this operation to import employee times that are saved in the Time Sheet

(CATS) database.

The Business Add-In (BAdI) ET_QUERY_TS_CONV ( Conversions for Proxy: Query

By Elements ) is available for this operation.

Manage Employee Time In

Technical Data



Entity Type


Category

Mode

Service interface


ECC-SE 501)

Inbound

Synchronous

Definition

Group of operations for creating, changing, reading or deleting Employee Times or parts of it.

Use

The Manage Employee Time In inbound service interface contains an operation that can import employee times with time management information and information for subsequent business processes for one or more employees.

Integration

The Manage Employee Time In inbound service interface belongs to the Time and Labour

Management [Seite 653 ] process component and the Employee Time [Seite 706 ] business object.

Structure

The Manage Employee Time In inbound service interface contains the

EmployeeTimeByEmployeeQueryResponse_In inbound operation ( Read Employee Time by Employee [Seite 709 ] ).

Read Employee Time by Employee

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeTimeByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmployeeTimeByEmployeeQR

Definition

Reads an employee's Employee Times .

Use

The Read Employee Time by Employee inbound operation imports employee times for one or more employees together with time management information. You select employee times according to employees or their work agreements.



You can use this operation, for example, to import the recorded employee times into an application for reporting employee times and thereby differentiate between various types of attendances and absences. You can use this operation to evaluate absences or overtime levels.


If you want to import employee times with the EmployeeTimeSheet to support recording employee times, the Find Employee Time Sheet by Employee [Seite 665 ] operation is most appropriate.

If you want to evaluate employee times that were recorded using the

EmployeeTimeSheet , use the Find Times for Employee Time Sheet by Elements

[Seite 707 ] operation.

Features


EmployeeTimeByEmployeeQuery

If you do not specify the SelectionPeriod , you receive all available employee times that match the specified selection criteria.

If you do not specify the EmployeeTimeItemCategoryCodeInterval or the

EmployeeTimeItemTypeCodeInterval , you receive all categories of employee times that match the specified selection criteria.

EmployeeTimeByEmployeeResponse

One of the following elements must be filled in this message:

ValuationTerms

ActivityAllocationAndCostAssignment

ServiceProvisionAndResourceConsumption

LogisticConfirmation

ExternalServiceAcknowledgement

DifferentPayment


Integration

This inbound operation belongs to the Manage Employee Time [Seite 708 ] inbound service interface.


Processing

The operation imports employee times from the following Time Management infotypes:


Absences infotype (2001)

Employee Remuneration Information infotype (2010)



Employee Time Account

Technical Data

Entity Type



Definition

A summary, managed by the employee time valuation, of valuated employee times and periodic valuations.

Use

The Employee Time Account business object provides information on an employee's time accounts.


Prerequisites

You have made the necessary Customizing settings for the Leave Request .

For more information about the leave request, see

The SAP Library: Personnel Management Employee Self-Service

Applications Working Time Leave Request

The Implementation Guide for Personnel Management Employee

Self-Service Service-Specific Settings Working Time Leave

Request

Processing

The system determines the time accounts using Customizing for the Leave Request .

Query Employee Time Account In

Technical Data

Entity Type


Category

Mode

Service interface


ECC-SE 501)

Inbound

Synchronous

Definition

Group of operations to find the Employee Time Account with relevant selection criteria using individual interfaces.



Use

The Query Employee Time Account In inbound service interface contains an operation that can import the time accounts of one or more employees.

Integration

The Query Employee Time Account In inbound service interface belongs to the Time and

Labour Management [Seite 653 ] process component and the Employee Time Account [Seite


Structure

The Query Employee Time Account In inbound service interface contains the

EmployeeTimeAccountForEmployeeByEmployeeQueryResponse_In operation ( Find

Employee Time Account for Employee [Seite 712 ] ).

Find Employee Time Account for Employee

Technical Data

Entity Type



Repository

Namespace


Version

Category

Mode


Service operation

EmployeeTimeAccountForEmployeeByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpTimAccountFEmpEmpQR

Definition

Finding Employee Time Accounts for an employee.

Use

The Find Employee Time Account for Employee inbound operation determines the time accounts for an employee. The account could be the leave account or overtime account of the employee, for example. You can use this operation for the following purposes:

You want to assist employees in entering leave requests. You therefore make a list available on the user interface, where employees can see their valid and deductible time accounts.

You want to offer your employees an application they can use to get information on their valid and deductible time accounts.

You want to provide the approvers of leave requests with a list containing information on an employee's time accounts.

For each time account, you receive information on the most important balances:

Total entitlement for validity period



Already used up to key date

Already requested and booked

Requested

Total of requested and booked

Remaining leave without requested leave on key date

Remaining leave without requested leave

Remaining leave without requested and booked leave

Features


EmployeeTimeAccountForEmployeeByEmployeeQuery


EmployeeLeaveRequestConfigurations for all of the employee's work agreements.

EmployeeTimeAccountForEmployeeByEmployeeResponse

The message gets the time accounts, sorted using the following criteria:

Time account

Validity period

Deduction period

Unit used to manage the time accounts (hours or days)


Integration

This inbound operation belongs to the Query Employee Time Account [Seite 711 ] inbound service interface.


Prerequisites

You have made the necessary Customizing settings for the leave request.

Processing

In the standard system, the system determines the time accounts using the entries you made in the following IMG activities:

Specify Display of Absence Quotas

Specify Display of Attendance Quotas

If you want to import additional time accounts from other data sources, you can implement the

PT_ABS_REQ ( Control Processing of Leave Requests ) BAdI. However, the BAdI runs only if you made the necessary Customizing settings for the leave request.



Employee Leave Request

Technical Data

Entity Type



Definition

A form used by employees to inform approvers about leave and obtain approval, depending on the business process.

Use

The Employee Leave Request business object enables the processing of leave requests. It requires a system architecture in which leave requests and absence type actual times are entered as separate database objects in the system.

Leave requests are objects that carry information about the request, such as information about the persons involved, the approval status, or the attached notes.

Leave requests that have already been booked are objects that represent leave as actual times in the back-end system. They contain information about the leave itself. Additional information that an administrator has added is also included, such as information about cost assignment or continued pay.

You can use this business object, for example, if you want to connect user interfaces for processing absence times such as vacation, or time in lieu of overtime, to the back-end system. The interface architecture assumes that employee times are recorded using an

Employee Self-Service Web application. Employees send requests for vacation or other absences to their supervisors.

Managers receive the leave requests and approve or reject them. Employees can then change or cancel the request or resulting absence. Additional information, such as the remaining leave entitlement, is available to both employees and supervisors, which facilitates the creation and approval of requests.

If errors occur during processing, an expert in time data processing, such as a time administrator or personnel administrator, can be involved in the process. However, these roles are not supported by the business object operations.

The business object operations enable you to link the following types of user interfaces:

Requesting leave and processing requests

Information about leave requests

Approving leave requests


For more information about leave that has been booked in the database, see the Employee

Time [Seite 706 ] business object’s operations.




Prerequisites

You have set up the Time Data Recording and Administration function in the ERP system.

You have configured the Leave Request Employee Self-Service Web application. A prerequisite for the Web application is that you use SAP ECC Enterprise Extension

Human Capital Management (EA-HR).

For all of this business object’s operations that change or simulate changes to the datasets of the back-end system, the user is identified using the System User Name and Personnel Number assignment in the Communication infotype (0105), subtype

0001 ( System User Name SAP System (SY_UNAME) ).

Processing

This business object’s operations enable the connection to the functions of the Leave

Request Employee Self-Service Web application. The leave requests are processed using the request database of the Leave Request .




The Implementation Guide for Personnel Management Employee

Self-Service Service-Specific Settings Working Time Leave

Request

In the data types of this business object, you can process data from the following data sources:


Description EmployeeTimeItem

CategoryCode

2

EmployeeTimeItem

CategoryTypeCode

Attendance subtype Data record for the



3 Absence subtype

Note the following:

For the Leave Request functions, it is assumed that leave requests with the following statuses are not processed further:

POSTED

WITHDRAWN

STOPPED

The Employee Leave Request messages enable request messages with these statuses to be sent. Therefore, you should ensure on your user interface and for any other usage of the messages that users cannot perform any actions on leave requests with this status.



Example: Message Choreography for the

Employee Leave Request

The following example shows you how the message choreography for entering leave requests might look on the user interface with the operations of the Employee Leave Request

[Seite 714 ] and Employee Leave Request Configuration [Seite 739 ] business objects.

...

An employee wants to send a request for annual leave to their personnel officer.

1. The employee accesses the leave request Employee Self-Service Web Application .

The application requires the following values from the back-end system: a. Settings from the system set-up that control the filling out of leave requests.

You can get these values using the Read Employee Leave Request

Configuration by Employee [Seite 741 ] operation.

b. Default values for the application to fill the absence type and the start and end date in the form.

You can get these values using the Find Default Request by Owner [Seite 736 ] operation.

c. Information on time accounts. To allow employees to see how much remaining leave entitlement they have, the time accounts are also displayed in the application for information purposes.

You can get these values using the Find Employee Time Account for Employee

[Seite 712 ] operation.

d. The responsible approver for the employee. You can use the appropriate operation to issue the responsible approver direct in the application. You can also use it to provide a function with which employees can manually search for an approver.

You can get these values using the Find Allowed Approvers by Identifying

Elements [Seite 734 ] operation.

2. An employee enters their annual leave. The employee wants to check the entries before sending.

You can use the Check Create Employee Leave Request [Seite 722 ] operation for this.

3. The employee sends the request.

You can use the Create Employee Leave Request [Seite 719 ] operation for this.

4. The employee's personnel officer is informed about the new leave request. He or she opens an application with a list of the current leave requests requiring approval, or accesses the leave request concerned from his or her worklist.

You can use the Find Employee Leave Request by Participant [Seite 737 ] operation for this.

5. The personnel officer approves the request.

You can use the Approve Employee Leave Request [Seite 730 ] operation for this.

6. A week later the employee decides to cancel their leave request after changing their plans. He or she opens an application that lists his or her leave requests and absences for the current year.

To do this you use the Find Employee Leave Request by Participant [Seite 737 ] operation to import the leave requests and the Read Employee Time by Employee

[Seite 709 ] operation to import absences booked.

Additionally, request further information from the back-end system that simplifies creating leave requests, as described above.



7. The employee creates a request to delete an absence.

You can use the Create Employee Leave Request [Seite 719 ] operation for this.

8. The approval process progresses as described above.

Manage Employee Leave Request In

Technical Data

Entity Type


Category

Mode

Service interface


ECC-SE 501)

Inbound

Synchronous

Definition

Group of operations that create, change, delete, or update an Employee Leave Request , or parts of it.

Use

The Manage Employee Leave inbound service interface groups operations that make the following possible:

Processing of leave requests

Reading leave requests

Request to change or cancel leave that is already booked as actual time in the system

Simulation of these functions

You use the operations of this inbound service interface to create user interfaces for requesting leave and changing and canceling leave requests and absences. For these functions, you can also enable employees to check the plausibility of the data by simulating the actions before sending the request.

Integration

The Manage Employee Leave inbound service interface belongs to the Time and Labour

Management [Seite 653 ] process component and the Employee Leave Request [Seite 714 ] business object.

Structure

The Manage Employee Leave inbound service interface groups the following inbound operations:

EmployeeLeaveRequestCreateRequestConfirmation_In ( Create Employee

Leave Request [Seite 719 ] )

EmployeeLeaveRequestCreateCheckQueryResponse_In ( Check Create

Employee Leave Request [Seite 722 ] )

EmployeeLeaveRequestUpdateRequestConfirmation_In ( Change Employee




EmployeeLeaveRequestUpdateCheckQueryResponse_In ( Check Change


EmployeeLeaveRequestCancelRequestConfirmation_In ( Cancel Employee


EmployeeLeaveRequestCancelCheckQueryResponse_In ( Check Cancel


EmployeeLeaveRequestByIDQueryResponse_In ( Read Employee Leave


Note the following comments that are valid for most of the operation messages:

The ID element identifies a request’s unique key, the LeaveEmployeeTimeReference is a reference to leave that is already booked.

The ChangeStateID element is used to check whether the message actions have been performed on the leave request that has the highest version number. If there is a newer version in the back-end system than is specified in the message, the message is not processed. The LogItemCategoryCode with the code value CON.ORC

(Outdated

Response Conflict) is set (in the data type log).

In this way you can ensure that the employees can edit only the most recent version of a leave request.

For the request messages of the service interface, the person placing the request does not necessarily need to be listed in the message structure . If the

EmployeeLeaveRequestParticipantCode 1 is not filled, the operations assume that the back-end system determines the person placing the request from the system user ID.

The WorkAgreementID , EmployeeID , and FormattedName of the person placing the request are determined in the back-end system from the data that is stored about the person’s system user.

The system uses the EmployeeLeaveRequestParticipantCode 2 to transfer the approver of a request.

Notes are used to enable those persons involved in the leave request process to inform others involved in the process about something.

An employee provides a reason for requesting vacation at short notice.

An approver provides a reason for rejecting a leave request.


Prerequisites

When processing leave requests in the back end, the system checks the Customizing settings that you have made for leave requests. The following settings especially dictate whether the system can successfully process a user action and which elements of the message structure must be filled:

Requester May Change Next Agent

Not Necessary to Enter Next Agent

EEs Not Permitted to Submit Requests

No Changes to Leave Permitted



No Deletion of Leave Permitted

If you have selected the Not Necessary to Enter Next Agent field in Customizing, you do not need to fill the approver in the request message. You must automatically determine the approver in the back-end system as a prerequisite.

You need to fill the approver only for the leave requests that are indicated in the Customizing settings as requiring approval.

For more information, see

The Implementation Guide for leave requests in the Specify Processing Process for

Types of Leave activity

The documentation for Employee Leave Request Configuration [Seite 739 ] .

Processing

For operations that make changes to the leave requests or booked absences, only the system user who owns the leave requests or absences is allowed to perform actions on the leave requests, in other words, the user whose personnel number is listed in the Personnel Number

Owner field in the request database. If an employee attempts to edit the data of another employee, the system displays an error message.

Note the following:

For the leave request functions, it is assumed that leave requests with the following statuses are not processed further:

POSTED

WITHDRAWN

STOPPED

The employee leave request messages enable request messages with these statuses to be sent. Therefore, you should ensure on your user interface and for any other usage of the messages that users cannot perform any actions on leave requests with this status.

Create Employee Leave Request

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeLeaveRequestCreateRequestConfirmation_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpLeaveReqCrtRC



Definition

Creation of an Employee Leave Request .

Use

The Create Employee Leave Request inbound operation creates a leave request for an employee. This can include the following leave request types:

New leave request

Request to change leave that is already booked

Request to cancel leave that is already booked


You can use the Change-/Check Change Employee Leave Request and Cancel- /Check

Cancel Employee Leave Request operations to perform actions on the leave requests. In addition to creating new Leave Requests , you use this operation to perform actions that change leave requests that have already been approved and booked in the system.

Features

The Create Employee Leave Request inbound operation processes the following message types:

EmployeeLeaveRequestCreateRequest

Other elements must be filled, depending on whether the message is a new leave request, or a request to change or cancel leave that has already been booked. In all cases: If the leave request has to be approved, the

EmployeeLeaveRequestParticipantRoleCode 2 and the WorkAgreementID must be filled with information about the leave request approver.

New leave request

EmployeeTimeItemCategoryCode

EmployeeTimeItemTypeCode

Validity

If a note has been created: Text

ActionCode and LeaveEmployeeTimeReference may not be filled.


ActionCode 02 ( = Change)

LeaveEmployeeTimeReference



Validity



ActionCode 03 (=Delete)





Detailed information is not required to cancel an existing leave request. It is sufficient to provide a reference to the leave request.

EmployeeLeaveRequestCreateConfirmation

Message elements that you are required to fill in confirmation messages also depend on whether the message is a new leave request, or a request to change or cancel leave that has already been booked:

New leave request

All elements belonging to this structure are entered, except for the following:

ActionCode


Elements for notes. You need only enter these if a note has been created.




Elements for EmployeeTimeAccounts: You need only enter these for deductible leave.




Elements for the leave request:



Validity

EmployeeTimeAccountTypeCode

EmployeeTimeAccountLineItemTypeCode

Quantity


Prerequisites

You have provided the following functions on your user interface:

Data entry user interface for creating new leave requests

Data entry user interface for selecting leave requests that have already been booked



Data entry user interface for changing or canceling leave requests that have already been booked

You use the Read Employee Time by Employee [Seite 709 ] operation to read leave requests that have already been booked.

Integration

This inbound operation belongs to the Manage Employee Leave [Seite 717 ] inbound service interface.


Prerequisites

When you defined the processing processes for each absence type in Customizing for leave requests, you specified whether leave requests that have already been booked can be changed or canceled.

Check Create Employee Leave Request

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeLeaveRequestCreateCheckQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpLeaveReqCrtChkQR

Definition

Simulation of the creation of an Employee Leave Request .

Use

The Check Create Employee Leave Request inbound operation simulates the creation of an employee’s leave request. This can include the following leave request types:

New leave request



You can use this function to enable employees to check on the user interface whether the data is correct before they send it to the leave request approver. The employees can thus check if the data was entered correctly and saved to the back-end system without problems.


This operation has the same functionality as the Create Employee Leave Request operation, except that the data is not saved in the back-end system. For more information on the Check



Create Employee Leave Request inbound operation, see Create Employee Leave Request

[Seite 719 ] .

Features

The Check Create Employee Leave Request inbound operation processes the following message types:

EmployeeLeaveRequestCreateCheckQuery

EmployeeLeaveRequestCreateCheckResponse


Prerequisites

You have provided your users with a function on the user interface with which they can check their entries.

Integration


Change Employee Leave Request

Technical Data

Entity Type




Service operation

EmployeeLeaveRequestUpdateRequestConfirmation_In http://sap.com/xi/EA-HR/SE/Global


ESR


Category

Mode

Inbound

Synchronous

Related Web Service Definition ECC_EmpLeaveReqChgRC

Definition

A change in an Employee Leave Request .

Use

The Change Employee Leave Request inbound operation enables you to change leave requests. You use this service to provide users with the following functions:

Changing of a leave request before the approver has approved it.

Changing of a leave request after the approver has rejected the original request.

Note: The booking of approved leave requests as actual times (absences) in the system is mostly carried out asynchronously. In this case you also need this operation if a leave request has already been approved but not yet booked.



Features

The Change Employee Leave Request inbound operation processes the following message types:

EmployeeLeaveRequestUpdateRequest

The RoleCode 2 and the WorkAgreementID changed the request’s approver.

must be entered if the user has

EmployeeLeaveRequestUpdateConfirmation

The fields you must fill in these request and confirmation messages depends on the following factors:

The type of request (cancellation request, change request)

The actions that an employee has taken (for example, change approver, change period)

Therefore, only an attached note can be changed if a request is canceled, for example.


Prerequisites

You have provided users with a user interface that contains a list of the current leave requests. Users can choose a request from this list. Additional functions enable users to change the submitted data.

For more information, see Find Employee Leave Request by Participant [Seite 737 ] .

Integration


Check Change Employee Leave Request

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeLeaveRequestRejectCheckQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpLeaveReqChgChkQR

Definition

Simulation of the changing of an Employee Leave Request .



Use

The Check Change Employee Leave Request inbound operation simulates the changing of an employee’s leave request.

You can use this function to enable employees to check on the user interface whether the data is correct before they send it to the leave request approver. The employees can thus check if the data was entered correctly and saved without problems to the back-end system.


This operation has the same functionality as the Change Employee Leave Request operation, except that the requests are not saved in the backend system. For more information on the

Check Change Employee Leave Request inbound operation, see Change Employee Leave


Features

The Check Change Employee Leave Request inbound operation processes the following message types:

EmployeeLeaveRequestUpdateCheckQuery

EmployeeLeaveRequestUpdateCheckResponse


Prerequisites

You have provided your users with a function on the user interface with which they can check their entries.

Integration


Cancel Employee Leave Request

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeLeaveRequestCancelRequestConfirmation_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpLeaveReqCncRC

Definition

Cancellation of an Employee Leave Request .



Use

The Cancel Employee Leave Request inbound operation enables you to cancel leave requests that have not yet been approved. You can use this operation to provide users with the following functions on a user interface:

Cancellation of a leave request before the approver has approved it.

Cancellation of a leave request after the approver has rejected the original request.

Note: Approved leave requests are usually posted asynchronously to the system as actual times (absences); meaning that a certain amount of time passes before approved leave requests are posted to the system as absences.

This operation also deletes leave requests that have been approved but are not yet posted.

Features

The Cancel Employee Leave Request inbound operation processes the following message types:

Note that the sender is not listed in the messages of an operation. To avoid misuse, you must ensure that only the owner of a leave request can cancel it in the back-end system, or on the interface.

This is ensured in the SAP back-end system.

EmployeeLeaveRequestCancelRequest

EmployeeLeaveRequestCancelConfirmation


Prerequisites

You have provided users with a user interface that contains a list of the current leave requests. Users can choose a request from this list. For more information on reading the leave requests, see Find Employee Leave Request by Participant [Seite 737 ] .

You have also provided your users with a function with which they can cancel a selected request.

Integration



Processing

The system determines the sender of the message using the system user name and the entry in the Communication (0105) infotype. If the sender of the message is not the employee who is the owner of the leave request, the system issues an error message. A leave request in the

SAP system can therefore only be canceled by the employee who is the owner of the request.



Check Cancel Employee Leave Request

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeLeaveRequestCancelCheckQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpLeaveReqCncChkQR

Definition

Simulation of the cancellation of an Employee Leave Request .

Use

The Check Cancel Employee Leave Request inbound operation simulates the cancellation of an employee’s leave request.

You can use this function to enable employees to use the user interface before they cancel a request to check, for example, the effects that canceling a request will have on their time accounts. The prerequisite is that you previously import the employee's time account with the appropriate operations.


This operation has the same functionality as the Cancel Employee Leave Request operation, except that requests are not deleted from the database. For more information on the Check

Cancel Employee Leave Request inbound operation, see Cancel Employee Leave Request

[Seite 725 ] .

Features

The Check Cancel Employee Leave Request inbound operation processes the following message types:

EmployeeLeaveRequestCancelCheckQuery

EmployeeLeaveRequestCancelCheckResponse


Prerequisites

You have provided your users with a function on the user interface with which they can check the deletion of their requests.

Integration




Read Employee Leave Request In

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeLeaveRequestByIDQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpLeaveReqIDQR

Definition

Reading of an Employee Leave Request .

Use

The Read Employee Leave Request In inbound operation reads the history and detailed information of an employee’s leave request.

You can use it if you want to display the history of a leave request on the user interface. You can use this for the following purposes, for example:

For an employee whose leave request was rejected by the approver, you want to display the original request in the application for information purposes.

You want to provide approvers with all existing versions of a leave request to assist them in approving a leave request. In this way, approvers can track the individual changes.


You use the Find Employee Leave Request by Participant [Seite 737 ] In operation to read the leave requests and their most recent versions.

Features

The Read Employee Leave Request In inbound operation processes the following message types:

EmployeeLeaveRequestByIDQuery

This message does not contain any elements that identify the query requester.

EmployeeLeaveRequestByIDResponse


Integration





Processing

The system uses the system user to determine the requester of the query. It then checks whether the requester is the owner or the approver of the request. If the requester is neither the owner or the approver, the system issues an error message.

Employee Leave Request Action In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations that execute actions on the Employee Leave Request .

Use

The Employee Leave Request Action In inbound service interface groups operations that enable the approval or rejection of leave requests.

You can use the operations of this service interface to provide persons with HR responsibility within your company (approvers) with a user interface for approving leave requests.

Prerequisites

You process leave requests that require approval.

You provide the approvers with a user interface in which the leave requests requiring approval by the approver are listed. On this user interface, approvers can decide for each leave request whether they will approve the request.

You can use the Find Employee Leave Request by Participant [Seite 737 ] operation to read the leave requests waiting for approval by an approver.

The system provides you with several operations for approving and rejecting leave requests. Therefore, you do not need to enter information about the approval decision

(rejected yes/no) in the request messages of the operations. Your back-end system must be able to set the status depending on the operation used.

Integration

The Employee Leave Request Action In inbound service interface belongs to the Time and

Labour Management [Seite 653 ] process component and the Employee Leave Request [Seite


Structure

The Employee Leave Request Action In inbound service interface groups the following inbound operations:



EmployeeLeaveRequestApproveRequestConfirmation_In ( Approve


EmployeeLeaveRequestApproveCheckQueryResponse_In ( Check Approve


EmployeeLeaveRequestRejectRequestConfirmation_In ( Reject Employee


EmployeeLeaveRequestRejectCheckQueryResponse_In ( Check Reject



Processing

The leave requests can be approved or rejected only by the users who are listed in the request database as approvers of the request. The system determines the approver using the link stored in the Communication infotype (0105) between the system user name and the personnel number.

This technology means that you cannot automatically determine the personnel officer's substitute. (The only exception is if you are using the SAP Business Workflow .) Therefore, you can realize substitutions only if the requester enters the new (substituting) approver in the application. You change the approver using the Change Employee Leave Request [Seite 723 ] operation.

Approve Employee Leave Request

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeLeaveRequestApproveRequestConfirmation_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpLeaveReqAppRC

Definition

Approval of an Employee Leave Request .

Use

The Approve Employee Leave Request inbound operation sets an employee’s leave request to the Approved status.

You use this operation to transfer a positive approval decision to the back-end system. If required, you can also send an approver's note.

Features

The Approve Employee Leave Request inbound operation processes the following message types:



EmployeeLeaveRequestApproveRequest

This message does not contain any elements that identify the approver.

EmployeeLeaveRequestApproveConfirmation


Integration

This inbound operation belongs to the Employee Leave Request Action [Seite 729 ] inbound service interface.


Processing

The system determines the personnel number of the approver of the request with the system user. It then checks that it is listed as the approver in the request. Only if this is the case does the system set the request to approved . In other cases it issues an error message.

Check Approve Employee Leave Request

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeLeaveRequestApproveCheckQueryResponse_In

Inbound

Synchronous

ECC_EmpLeaveReqAppChkQR

Definition

Simulation of the approval of an Employee Leave Request .

Use

The Check Approve Employee Leave Request inbound operation simulates the transfer of a positive approval decision for a leave request to the back-end system.

You can use this operation to enable the approvers to check on the user interface whether the data can be successfully posted before they send the approvals.


This operation has the same functionality as the Approve Employee Leave Request operation, except that the positive approval decision is not saved in the back-end system.

Features

The Check Approve Employee Leave Request inbound operation processes the following message types:

EmployeeLeaveRequestApproveCheckQuery



EmployeeLeaveRequestApproveCheckResponse


Prerequisites

You provide your approvers with a function on the user interface with which they can check their approval decision.

Integration


Reject Employee Leave Request

Technical Data

9.

Entity Type

11.


Service Repository

13.

Namespace

15.

Software Component Version

17.


19.

Transfer Mode

21.


10. Service operation

12. EmployeeLeaveRequestRejectRequestConfirma tion_In

14. http://sap.com/xi/EA-HR/SE/Global

16. As of ESA ECC-SE 501

18. Inbound

20. Synchronous

22. ECC_EmpLeaveReqRejRC

Definition

Rejection of an Employee Leave Request .

Use

The Reject Employee Leave Request inbound operation sets an employee’s leave request to the status Rejected .

You use this operation to transfer a negative approval decision to the back-end system. If required, you can also enter an Approver’s Note.

Features

The Reject Employee Leave Request inbound operation processes the following message types:

EmployeeLeaveRequestRejectConfirmation

This message does not contain any elements that identify the approver.

EmployeeLeaveRequestRejectRequest


Integration





Processing

The system determines the personnel number of the approver of the request with the system user. It then checks that it is listed as the approver in the request. Only if this is the case does the system set the request to rejected . In other cases it issues an error message.

Check Reject Employee Leave Request

Technical Data

Entity Type





Category

Mode


Service operation

EmployeeLeaveRequestRejectCheckQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpLeaveReqRejChkQR

Definition

Simulation of the rejection of an Employee Leave Request .

Use

The Check Reject Employee Leave Request inbound operation simulates the transfer of a negative approval decision for a leave request to the back-end system.

You use this operation to enable the approvers to check on the user interface whether the data can be successfully posted before they send the rejection.


This operation has the same functionality as the Reject Employee Leave Request operation, except that negative approval decisions are not saved in the back-end system.

Features

The Check Reject Employee Leave Request inbound operation processes the following message types:

EmployeeLeaveRequestRejectCheckQuery

EmployeeLeaveRequestRejectCheckResponse


Prerequisites

You provide your approvers with a function on the user interface with which they can check their approval decision.



Integration


Entries for Employee Leave Request In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations that provide a list of permitted entries, restricted by further criteria, for the

Employee Leave Request .

Use

The Entries for Employee Leave Request In inbound service interface groups operations that read data from the back-end system that supports users when they enter data for leave requests.

Integration

The Entries for Employee Leave Request In inbound service interface belongs to the Time and Labour Management [Seite 653 ] process component and the Employee Leave Request


Structure

The Entries for Employee Leave Request In inbound service interface groups the following inbound operations:

EmployeeLeaveRequestAllowedApproverByIdentifyingElementsQueryRes ponse_In ( Find Allowed Approvers by Identifying Elements [Seite 734 ] )

DefaultEmployeeLeaveRequestByOwnerQueryResponse_In ( Find Default

Request by Owner [Seite 736 ] )

Find Allowed Approvers by Identifying Elements

Technical Data




Technical

Name in

Enterprise

Service

Repository

(ESR)

Namespace in

ESR

Software

Component

Version in ESR

Category

Mode

Related Web

Service

Definition

EmployeeLeaveRequestAllowedApproverByIdentifyingElementsQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpLeaveReqAllAppIdEQR

Definition

Finds the permitted approver of an Employee Leave Request for an individual employee.

Use

The Find Allowed Approvers by Identifying Elements inbound operation determines the permitted approver of an employee's leave request from the back-end system.

You use this operation if you want to list the approver on the user interface for display or change purposes.

You can also use the Manage Employee Leave [Seite 717 ] service interface operation to change the approver of a leave request.

In addition to using an employee's personnel number as a search criteria, this operation allows you to enter information to determine an approver, such as a search text, their name or personnel number. A list of search results is returned.

Features

The Find Allowed Approvers by Identifying Elements inbound operation processes the following message types:

EmployeeLeaveRequestAllowedApproverByIdentifyingElementsQuery

EmployeeLeaveRequestAllowedApproverByIdentifyingElementsResponse


Prerequisites

The prerequisite for using this operation is that you allow your employees to: individually enter the approver of a leave request overwrite the default value for the approver

To enter the additional search criteria and select the approver from the results list, you must provide an appropriate user interface.



Integration

This inbound operation belongs to the Entries for Employee Leave Request [Seite 734 ] inbound service interface.

Find Default Request by Owner

Technical Data

Entity Type






Version in ESR

Category

Mode


Definition

Service operation

DefaultEmployeeLeaveRequestByOwnerQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_DefEmpLeaveReqOwnQR

Definition

Finding an Employee Leave Request with default values for a specific employee.

Use

The Find Default Request by Owner inbound operation determines the settings from the system administration for an employee. You can use this operation for the following purposes:

For a new leave request that is to be created, you want to provide a default value for the absence type being created, such as the Leave absence type.

You want to provide a date for the start and end date as a default value. The start and end date are identical here.

Features

The Find Default Request by Owner inbound operation processes the following message types:

DefaultEmployeeLeaveRequestByOwnerQuery

You can enter either the EmployeeID or the WorkAgreementID . If you enter the

Employee_ID only, the system determines all default values that are valid for the employee's work agreements.

DefaultEmployeeLeaveRequestByOwnerResponse

In the message structure, the elements for the note are listed. You can ignore them in this context.




Integration

This inbound operation belongs to the Entries for Employee Leave Request [Seite 734 ] inbound service interface.


Processing

The system reads the default value for the absence type from the Specify Processing

Processes for Types of Leave IMG activity. The system reads the first entry that you created in Customizing. The system determines the default value for the start date (and at the same time the end date) of the request from the Specify How Leave Is Displayed and Default

Values IMG activity.

Query Employee Leave Request

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations to find the Employee Leave Request with relevant selection criteria using individual interfaces.

Use

The Query Employee Leave Request inbound service interface contains an operation with which you can read the leave requests of employees based on certain selection criteria.

Integration

The Query Employee Leave Request inbound service interface belongs to the Time and

Labour Management [Seite 653 ] process component and the Employee Leave Request [Seite


Structure

The Query Employee Leave Request inbound service interface contains the

EmployeeLeaveRequestByParticipantQueryResponse_In inbound operation ( Find

Employee Leave Request by Participant [Seite 737 ] ).

Find Employee Leave Request by Participant

Technical Data








Category

Mode


EmployeeLeaveRequestByParticipantQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpLeaveReqParctQR

Definition

Finding the Employee Leave Requests for each role in the leave request’s process.

Use

The Find Employee Leave Request by Participant inbound operation reads the latest versions of employees’ leave requests. Reading this data depends on the role that the user has on the interface. The following roles are available:

Employee ( Employee Leave Request Participant Role Code 1 )

Approver ( Employee Leave Request Participant Role Code 2 )

You can also restrict the result of the query to a specific period depending on the employees, the work agreements, and the status of the leave request.

You can use this operation for the following purposes, for example:

You want to let employees display a list of their leave requests for the current year.

You can provide this list in the form of an overview from which an employee can select a leave request in order to change or delete it.

You want to let your approvers display a list of the leave requests that they are to approve. The approver can then approve or reject the leave requests from this list.

You want to provide a user interface for reporting about the leave requests.


If you want to read detailed information about the history of a request, use the Read

Employee Leave Request [Seite 728 ] operation.

Features

The Find Employee Leave Request by Participant inbound operation processes the following message types:

EmployeeLeaveRequestByParticipantQuery

EmployeeLeaveRequestByParticipantResponse


Integration

This inbound operation belongs to the Query Employee Leave Request [Seite 737 ] inbound service interface.


Note the following:



For the Leave Request functions, it is assumed that leave requests with the following statuses are not processed further:

POSTED

WITHDRAWN

STOPPED

The Employee Leave Request messages enable request messages with these statuses to be sent. Therefore, if you want to read the leave requests, you must ensure on your user interface that leave requests with these statuses cannot be read, displayed or edited.

Employee Leave Request Configuration

Technical Data

Entity Type



Definition

Functional and user interface relevant arrangement of an Employee Leave Request , related to the specific requirements of the company.

Use

The Employee Leave Request Configuration business object delivers information that is required for the structure of a user interface for the leave request and that supports the correct entry of the leave requests. To a certain extent, this information constitutes a form that contains certain defaults for creation. This includes, for example, whether the approver is visible or can be overwritten in the application.


The leave requests are created, processed, approved, and reported using the operations of the Employee Leave Request [Seite 714 ] business object.


Prerequisites

You have set up the Time Data Recording and Administration function in the ERP system.

You have configured the Leave Request Employee Self-Service Web application. A prerequisite for the Web application is that you use SAP ECC Enterprise Extension

Human Capital Management (EA-HR).

Processing

This business object’s operations enable the connection to the functions of the Leave

Request Employee Self-Service Web application. The leave requests are processed using the request database of the leave request.






The Implementation Guide: Personnel Management Employee Self-

Service Service-Specific Settings Working Time Leave Request

In the data types of this business object, you can process data from the following data sources:


Description EmployeeTimeItem

CategoryCode

2 Data record for the



3

EmployeeTimeItemType

Code

Attendance subtype

Absence subtype

Manage Employee Leave Request Configuration In

Technical Data

Entity Type


Category

Mode

Service interface


ECC-SE 501)

Inbound

Synchronous

Definition

Group of operations for importing configuration information on Employee Leave Requests , or parts of it.

Use

The Manage Employee Leave Request Configuration In inbound service interface contains an operation that gets information from the system settings for creating a form for entering and processing leave requests.

Integration

The Manage Employee Leave Request Configuration In inbound service interface belongs to the Time and Labour Management [Seite 653 ] process component and the Employee Leave

Request Configuration [Seite 739 ] business object.

Structure

The Manage Employee Leave Request Configuration In inbound service interface contains the EmployeeLeaveRequestConfigurationByEmployeeQueryResponse_In inbound operation ( Read Employee Leave Request Configuration by Employee [Seite 741 ] ).



Read Employee Leave Request Configuration by

Employee

Technical Data

Entity Type






Version in ESR

Category

Mode


Definition

Service operation

EmployeeLeaveRequestConfigurationByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpLeaveReqConfEmpQR

Definition

Reading of Employee Leave Request Configuration for a single employee.

Use

The Read Employee Leave Request Configuration by Employee inbound operation reads information from the system settings for a single employee. You can use this information to offer a form on the user interface that is already as completely filled-out as possible. In addition, you can perform checks of the data entered, or, for example, you can offer a certain logic on the user interface that is dependent on the given absence. This makes it easier for the employee to enter a leave request and reduces errors.

You can specify the following information:

Which absence types the employee is allowed to request

Whether the approver of the leave request is visible

Whether the approver of the leave request is modifiable

Which actions of the employee are allowed (for instance, deleting or changing a leave request)

How long an absence is allowed to be (partial day, full day, several days)

Features

The Read Employee Leave Request Configuration by Employee inbound operation processes the following message types:

EmployeeLeaveRequestConfigurationByEmployeeQuery


EmployeeLeaveRequesConfigurations for all of the employee's work agreements.

EmployeeLeaveRequestConfigurationByEmployeeResponse

The message returns the Customizing settings for each work agreement of the employee.




Integration

This inbound operation belongs to the Manage Employee Leave Request Configuration [Seite



Processing

The operation reads the Customizing settings for the leave request and the absence type.

When the database is updated (create, change or delete a leave request in the system), the system checks all Customizing settings that are not supplied by this operation.

Compensation Management

Technical Data

Entity Type


Process component mySAP ERP enterprise services package (as of ECC-SE 501, SP02)

Definition

Enables companies to plan and define employee remuneration data on the basis of reward strategies, including performance-based and competency-based pay, variable pay plans, bonuses and long-term incentives. Supports companies in defining and putting into practice compensation structures throughout their lines of business.

Use

The Compensation Management process component enables your company to support its users in reviewing and monitoring the compensation objects to which employees have been assigned. To this end, users can query the estimated annual salary of a particular employee, or the compensation structure grade to which the employee has been assigned. Users are equally able to query the attendant long-term incentives that apply for the employee.


Prerequisites


Enterprise Extension Human Capital Management (EA-HR). It is also recommended that you perform all applicable system settings in Customizing for Compensation Management (PA-

CM).

Employee Compensation Agreement

Technical Data

Entity Type


Business object mySAP ERP enterprise services package (as of ECC-SE 501, SP02)



Definition

An Employee Compensation Agreement is the set of rules governing an employee’s compensation.

Use

The Employee Compensation Agreement business object records individual items at the employee level that correspond to compensation-relevant rules, which, in turn, have been established for the employee on the basis of a specific employment or work agreement assignment. As a repository for compensation-relevant information at the employee level, this business object can be queried to obtain statistics – such as the estimated annual salary – that relate to the employee compensation agreement. The business object equally enables users to determine compensation structure grade assignments, as well as long-term incentive plans.


Prerequisites

To use the operation contained in the business object, you must implement SAP ECC


Employee Compensation Agreement Statistics In

Technical Data

Entity Type


Category

Mode

Service interface mySAP ERP enterprise services package (as of ECC-SE 501, SP02)

Inbound

Synchronous

Definition

Group of operations for obtaining statistical information that pertains to compensation at the level of the individual employee.

Use

The Employee Compensation Agreement Statistics In inbound service interface groups operations that enable users to query compensation data that is recorded for the employee in the corresponding Employee Compensation Agreement .

Integration

The Employee Compensation Agreement Statistics In inbound service interface belongs to the Compensation Management [Seite 742 ] process component and the Employee

Compensation Agreement [Seite 742 ] business object.

Structure

The Employee Compensation Agreement Statistics In inbound service interface contains the

EmployeeCompensationAgreementEstimatedAnnualSalaryByEmployeeQueryResp onse_In inbound operation ( Employee Compensation Agreement Estimated Annual Salary

[Seite 744 ] ).



Employee Compensation Agreement Estimated

Annual Salary

Technical Data


Technical

Name in

Enterprise

Service

Repository

(ESR)

EmployeeCompensationAgreement

EstimatedAnnualSalaryByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global Namespace in ESR

Software

Component

Version in

ESR

Category

As of ESA ECC-SE 501, SP02

Mode

Related

Web

Service

Inbound

Synchronous

ECC_EmpCompAgEstAnnSalEmpQR

Definition

Estimate the annual salary of an employee on the basis of his or her Employee

Compensation Agreement .

Use

The Employee Compensation Agreement Estimated Annual Salary inbound operation reads the Employee Compensation Agreement and derives from it that employee’s annual salary, as well as the corresponding currency. This inbound operation can determine this information either for a single work agreement identifier, or for every work agreement identifier that is linked to a particular employee identifier on a key date.

Features

The Employee Compensation Agreement Estimated Annual Salary inbound operation processes the following message types:

EmployeeCompensationAgreementEstimatedAnnualSalaryByEmployeeQuery_sync

EmployeeCompensationAgreementEstimatedAnnualSalaryByEmployeeResponse_syn c


Prerequisites

Before this service operation can be employed, either the work agreement identifier or the employee identifier must be specified as an input parameter. If both identifiers are specified, then the work agreement identifier must be valid for that employee identifier.



Integration

This inbound operation belongs to the Employee Compensation Agreement Statistics [Seite



Processing

If no key date is specified, then the system applies the current date as the default value.

Manage Employee Compensation Agreement

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for managing data that pertains to the compensation of individual employees in the context of companywide compensation elements.

Use

The Manage Employee Compensation Agreement inbound service interface groups operations that enable users to manage employee-level compensation data more efficiently by analyzing the assignment of the individual Employee Compensation Agreement to company-level compensation elements, such as compensation structure grade assignments, or long-term incentive plans.

Integration

The Manage Employee Compensation Agreement inbound service interface belongs to the

Compensation Management [Seite 742 ] process component and the Employee

Compensation Agreement [Seite 742 ] business object.

Structure

The Manage Employee Compensation Agreement inbound service interface groups the following inbound operations:

EmployeeCompensationAgreementCompensationStructureGradeAssignmen tByEmployeeQueryResponse_In ( Read Compensation Structure Grade


EmployeeCompensationAgreementLongTermIncentivePlanByEmployeeQuer yResponse_In ( Read Long Term Incentive Plan [Seite 747 ] )

Read Compensation Structure Grade Assignment

Technical Data




Technical

Name in

Enterprise

Service

Repository

(ESR)


Software

Component

Version in

ESR

Category

Mode

Related

Web

Service


CompensationStructureGradeAssignmentByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpCompAgCompStrGrAstEmpQR

Definition

Read the compensation structure grade assignment of an employee on the basis of his or her

Employee Compensation Agreement .

Use

The Read Compensation Structure Grade Assignment inbound operation reads the Employee

Compensation Agreement and derives from it that employee’s assignment(s) to corresponding compensation structure grade(s). This inbound operation can determine this information either for a single work agreement identifier, or for every work agreement identifier that is linked to a particular employee identifier on a key date.

Features

The Read Compensation Structure Grade Assignment inbound operation processes the following message types:

EmployeeCompensationAgreementCompensationStructureGradeAssignmentByEmplo yeeQuery_sync

EmployeeCompensationAgreementCompensationStructureGradeAssignmentByEmplo yeeResponse_sync


Prerequisites


Integration

This inbound operation belongs to the Manage Employee Compensation Agreement [Seite





Processing


Read Long Term Incentive Plan

Technical Data


Technical

Name in

Enterprise

Service

Repository

(ESR)



LongTermIncentivePlanByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global

As of ESA ECC-SE 501, SP02 Software

Component

Version in

ESR

Category

Mode

Related

Web

Service

Definition

Inbound

Synchronous

ECC_EmpCompAgLgTrmIncPlnEmpQR

Definition

Read the Employee Compensation Agreement to determine the long-term incentive plans that are valid for the employee.

Use

The Read Long Term Incentive Plan inbound operation reads the Employee Compensation

Agreement and derives from it that employee’s assignment(s) to corresponding long-term incentive plans. This inbound operation can determine this information either for a single work agreement identifier, or for every work agreement identifier that is linked to a particular employee identifier on a key date.

Features

The Read Long Term Incentive Plan inbound operation processes the following message types:

EmployeeCompensationAgreementLongTermIncentivePlanByEmployeeQuery_sync

EmployeeCompensationAgreementLongTermIncentivePlanByEmployeeResponse_sy nc




Prerequisites


Integration

This inbound operation belongs to the Manage Employee Compensation Agreement [Seite



Processing


Benefits Administration

Technical Data

Entity Type


Process component mySAP ERP enterprise services package (as of ESA ECC-SE 501, SP02)

Definition

Manages all administrative aspects within a company that relate to employee benefits, including benefit plan enrollment and eligibility, master data storage and reporting.

Use

The Benefits Administration process component equips your company to provide its users with applications that enable them to monitor the various benefit plans in which an employee has enrolled. By means of the services that this process component offers, users can perform queries for a variety of benefit plans, including:

Health plans

Insurance plans

Savings plans

Credit plans

Miscellaneous plans

Stock purchase plans

Flexible spending accounts

Flexible spending account claims

For each type of benefit plan named above, documentation is provided below for the corresponding service operation offered by this process component.




Prerequisites


Enterprise Extension Human Capital Management (EA-HR). It is also recommended that you perform all applicable system settings in Customizing for Benefits Administration (PA-BN).

Employee Benefits Participation

Technical Data

Entity Type


Business object mySAP ERP enterprise services package (as of ECC-SE 501, SP02)

Definition

An Employee Benefits Participation is a set of rules and selections describing the employee’s participation in a benefit program.

Use

The Employee Benefits Participation business object enables users to query benefit plan information, as required, for employees who have enrolled in the relevant plans. Participation information can also be obtained, by means of this business object, for dependents and beneficiaries, where applicable.


Prerequisites

To use the operation contained in the business object, you must implement SAP ECC


Manage Employee Benefits Participation In

Technical Data

Entity Type


Category

Mode


Inbound

Synchronous

Definition

Group of operations for obtaining participation information that pertains to benefit plans for employees, dependents and beneficiaries.

Use

The Manage Employee Benefits Participation In inbound service interface groups operations that enable users to query participation data that is recorded for the employee (and any dependents or beneficiaries) in the corresponding Employee Benefits Participation .



Integration

The Manage Employee Benefits Participation In inbound service interface belongs to the

Benefits Administration [Seite 748 ] process component and the Employee Benefits

Participation [Seite 749 ] business object.

Structure

The Manage Employee Benefits Participation In inbound service interface groups the following inbound operations:

The

EmployeeBenefitsParticipationHealthPlanByEmployeeQueryResponse_I n inbound operation ( Read Health Plan [Seite 750 ] )

The

EmployeeBenefitsParticipationInsurancePlanByEmployeeQueryRespons e_In inbound operation ( Read Insurance Plan [Seite 751 ] )

The

EmployeeBenefitsParticipationSavingsPlanByEmployeeQueryResponse_

In inbound operation ( Read Savings Plan [Seite 752 ] )

The

EmployeeBenefitsParticipationCreditPlanByEmployeeQueryResponse_I n inbound operation ( Read Credit Plan [Seite 753 ] )

The

EmployeeBenefitsParticipationMiscellaneousPlanByEmployeeQueryRes ponse_In inbound operation ( Read Miscellaneous Plan [Seite 754 ] )

The

EmployeeBenefitsParticipationStockPurchasePlanByEmployeeQueryRes ponse_In inbound operation ( Read Stock Purchase Plan [Seite 755 ] )

The

EmployeeBenefitsParticipationFlexibleSpendingAccountByEmployeeQu eryResponse_In inbound operation ( Read Flexible Spending Account [Seite 756 ] )

The

EmployeeBenefitsParticipationFlexibleSpendingAccountClaimByEmplo yeeQueryResponse_In inbound operation ( Read Flexible Spending Account Claim

[Seite 757 ] )

Read Health Plan

Technical Data

Entity Type






Version in ESR

Category

Mode

Service operation

EmployeeBenefitsParticipation

HealthPlanByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous



Related Web Service ECC_EmpBenPartHealthPlanEmpQR

Definition

Read the Employee Benefits Participation business object to determine the health plans that are valid for the employee.

Use

The Read Health Plan inbound operation provides the health plan data of an employee. It also provides the data of any dependents that an employee has enrolled in the corresponding health plan(s).

Features

The Read Health Plan inbound operation processes the following message types:

EmployeeBenefitsParticipationHealthPlanByEmployeeQuery_sync

EmployeeBenefitsParticipationHealthPlanByEmployeeResponse_sync


Prerequisites


Integration

This inbound operation belongs to the Manage Employee Benefits Participation [Seite 749 ] inbound service interface.


Processing


Read Insurance Plan

Technical Data






InsurancePlanByEmployeeQueryResponse_In



Component

Version in ESR

Category

Mode

Related Web

Service

Inbound

Synchronous

ECC_EmpBenPartInsPlanEmpQR



Definition

Read the Employee Benefits Participation business object to determine the insurance plans that are valid for the employee.

Use

The Read Insurance Plan inbound operation provides the insurance plan data of an employee. It also provides the data of any beneficiaries that an employee has registered within the corresponding insurance plan(s).

Features

The Read Insurance Plan inbound operation processes the following message types:

EmployeeBenefitsParticipationInsurancePlanByEmployeeQuery_sync

EmployeeBenefitsParticipationInsurancePlanByEmployeeResponse_sync


Prerequisites


Integration



Processing


Read Savings Plan

Technical Data

Entity Type




Service operation


SavingsPlanByEmployeeQueryResponse_In


Software



Category

Mode

Inbound

Synchronous

Related Web Service ECC_EmpBenPartSavPlanEmpQR

Definition

Read the Employee Benefits Participation business object to determine the savings plans that are valid for the employee.



Use

The Read Savings Plan inbound operation provides the savings plan data of an employee. It also provides the data of any beneficiaries that an employee has registered within the savings plan(s), as well as the corresponding investment details.

Features

The Read Savings Plan inbound operation processes the following message types:

EmployeeBenefitsParticipationSavingsPlanByEmployeeQuery_sync

EmployeeBenefitsParticipationSavingsPlanByEmployeeResponse_sync


Prerequisites


Integration



Processing


Read Credit Plan

Technical Data

Entity Type




Service operation


CreditPlanByEmployeeQueryResponse_In



Version in ESR http://sap.com/xi/EA-HR/SE/Global


Category

Mode

Inbound

Synchronous

Related Web Service ECC_EmpBenPartCrePlanEmpQR

Definition

Read the Employee Benefits Participation business object to determine the credit plans that are valid for the employee.

Use

The Read Credit Plan inbound operation provides the credit plan data of an employee.



Features

The Read Credit Plan inbound operation processes the following message types:

EmployeeBenefitsParticipationCreditPlanByEmployeeQuery_sync

EmployeeBenefitsParticipationCreditPlanByEmployeeResponse_sync


Prerequisites


Integration



Processing


Read Miscellaneous Plan

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)

Namespace in

ESR

Software

Component

Version in ESR

Category

Mode

Related Web

Service

Service operation


MiscellaneousPlanByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpBenPartMiscPlanEmpQR

Definition

Read the Employee Benefits Participation business object to determine the miscellaneous plans that are valid for the employee.



Use

The Read Miscellaneous Plan inbound operation provides the miscellaneous plan data of an employee. It also provides the data of any dependents or beneficiaries that an employee has registered within the miscellaneous plan(s), as well as the corresponding investment details.

Features

The Read Miscellaneous Plan inbound operation processes the following message types:

EmployeeBenefitsParticipationMiscellaneousPlanByEmployeeQuery_sync

EmployeeBenefitsParticipationMiscellaneousPlanByEmployeeResponse_sync


Prerequisites


Integration



Processing


Read Stock Purchase Plan

Technical Data

Entity Type

Technical

Name in

Enterprise

Service

Repository

(ESR)

Namespace in

ESR

Software

Component

Version in ESR

Category

Mode

Related Web

Service

Service operation


StockPurchasePlanByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpBenPartStkPurPlanEmpQR



Definition

Read the Employee Benefits Participation business object to determine the stock purchase plans that are valid for the employee.

Use

The Read Stock Purchase Plan inbound operation provides the stock purchase plan data of an employee. It also provides the data of any beneficiaries that an employee has registered within the corresponding plan(s).

Features

The Read Stock Purchase Plan inbound operation processes the following message types:

EmployeeBenefitsParticipationStockPurchasePlanByEmployeeQuery_sync

EmployeeBenefitsParticipationStockPurchasePlanByEmployeeResponse_sync


Prerequisites


Integration



Processing


Read Flexible Spending Account

Technical Data


Technical

Name in

Enterprise

Service

Repository

(ESR)


FlexibleSpendingAccountByEmployeeQueryResponse_In



Component

Version in

ESR

Category

Mode

Inbound

Synchronous



Related

Web

Service

ECC_EmpBenPartFlxSpAccEmpQR

Definition

Read the Employee Benefits Participation business object to determine the flexible spending account data that is valid for the employee.

Use

The Read Flexible Spending Account inbound operation provides the flexible spending account data of an employee, assuming that the employee has established such an account.

Features

The Read Flexible Spending Account inbound operation processes the following message types:

EmployeeBenefitsParticipationFlexibleSpendingAccountByEmployeeQuery_sync

EmployeeBenefitsParticipationFlexibleSpendingAccountByEmployeeResponse_sync


Prerequisites


Integration



Processing


Read Flexible Spending Account Claim

Technical Data

Entity Type






Version in ESR

Category

Mode


Service operation


FlexibleSpendingAccountClaimByEmployeeQueryResponse_In http://sap.com/xi/EA-HR/SE/Global


Inbound

Synchronous

ECC_EmpBenPartFlxSpAccClmEmpQR



Definition

Read the Employee Benefits Participation business object to determine the flexible spending account claim data that is valid for the employee.

Use

The Read Flexible Spending Account Claim inbound operation provides the flexible spending account claim data of an employee, assuming that the employee has established such an account and submitted a claim on it.

Features

The Read Flexible Spending Account Claim inbound operation processes the following message types:

EmployeeBenefitsParticipationFlexibleSpendingAccountClaimByEmployeeQuery_sync

EmployeeBenefitsParticipationFlexibleSpendingAccountClaimByEmployeeResponse_ sync


Prerequisites


Integration



Processing


Enterprise Services for SAP for Utilities

Measurement Processing

Technical Data

Entity type



Definition

Processing of meter reading data.

Usage

Amongst other things, the process component Measurement Processing enables the automation of the following business process for meter reading by the customer:



A utility company sends a customer an e-mail requesting them to read their meter. In the email attachment, there is an interactive form where the customer can enter the meter reading result. The customer sends the e-mail with the attachment back to the utility company. The utility company processes the data in the system.

Electronic processing has replaced manual processing. Previously, meter reading results were sent in on cards and entered manually.


Prerequisites

The implementation of SAP ECC Industry Extension Utilities, Waste & Recycling is a prerequisite for using the operations contained in the process component.

Read SAP note 951468 and if necessary implement the note.

Processing

The process component Measurement Processing enables communication with data from the following mySAP ERP application components:

Meter Reading for the Utilities Industry (IS-U/DM-MR)

Meter Reading Card

Technical Data

Entity type



Definition

Meter reading card for transferring meter reading data.

Usage

The business object Meter Reading Card contains operations that enable meter reading data to be transferred.

Manage Meter Reading Card In

Technical Data

Entity type


Category

Mode


Inbound

Synchronous

Definition

Management of meter reading cards.



Usage

The inbound service interface Manage Meter Reading Card groups together operations that are relevant for the management of meter reading cards.

Structure

The inbound service interface Manage Meter Reading Card In contains the inbound operation

MeterReadingCardChangeRequestConfirmation_In ( Meter Reading Card Change ).

Meter Reading Card Change

Technical Data

Entity type




Software component version in ESR

Category

Mode


Service operation

MeterReadingCardChangeRequestConfirmatio n_In http://sap.com/xi/IS-U/SE/Global


Inbound

Synchronous

ISU_MeterReadingCardChgRC

Definition

Request and confirmation for processing meter reading data.

Usage

The inbound operation Meter Reading Card Change enables meter reading data to be received and processed.

Features


MeterReadingCardChangeRequest

MeterReadingCardChangeConfirmation

Error Handling

Subsequent processes ensure that the received meter reading data is validated.

Utilities Contract Processing

Technical Data

Entity type





Definition

Management of the utility contract data.

Usage

You can use the process component Utilities Contract Processing to prepare applications that support users working with data in the utility contract environment.

Amongst others, the following functions are possible:

Read and change utility contract data


Prerequisites

The implementation of SAP ECC Industry Extension Utilities, Waste & Recycling is a prerequisite for using the operations contained in the process component.

Utility Contract

Technical Data

Entity type



Definition

A utility contract is a master data object that contains control data that belongs to a utility service.

Usage

This business object enables the management of the utility contract master data.

Manage Utility Contract In

Technical Data

Entity type


Category

Mode


Inbound

Synchronous

Definition

Management of Utility Contracts

Usage

The inbound service interface Manage Utility Contract In groups together operations that are relevant for the management of utility contracts.



Structure

The inbound service interface Manage Utility Contract In contains the inbound operation

UtilityContractBasicDataByIDQueryResponse_In ( Read Utility Contract Basic

Data ).

Read Utility Contract Basic Data

Technical Data

Entity type





Category

Mode


Service operation

UtilityContractBasicDataByIDQueryResponse_I n http://sap.com/xi/IS-U/SE/Global


Inbound

Synchronous

ISU_UTILITYCONTRACTBASICDATAQR

Definition

Request to and confirmation from process component for provision of information on the basic data.

Usage

The inbound operation Read Utility Contract Basic Data provides the basic data for the utility contract.

Features


UtilityContractBasicDataByIDQuery

UtilityContractBasicDataByIDResponse

Processing

The operation uses the contract number to read the basic data of a utility contract (contract text, division, move-in data).

Enterprise Services for SAP for Insurance

Claims Management



Insurance Claim Processing

Technical Data

Entity Type


Process Component mySAP ERP Enhancement Package 1

Definition

With the Insurance Claim Processing process component, notices of loss sent by policyholders and claimants to an insurance company can be transferred electronically and processed further. Notices of loss no longer have to be captured manually by clerks.

Use

The Insurance Claim Processing process component enables you to process claims for the following areas of insurance:

Automobile

Workers Compensation

Homeowner

Liability

Constraints

Currently the functionality is limited to the creation of claims and claim notifications.

Insurance Claim

Technical Data

Entity Type


Business Object mySAP ERP Enhancement Package 1

Definition

An Insurance Claim contains information about a loss or injury that is necessary for an insurance company to create a claim. It is the basis for processing of a claim or loss.

Use

The Insurance Claim business object contains operations that you can use to create claims.

Manage Insurance Claim In

Technical Data

Entity Type


Service Interface mySAP ERP Enhancement Package 1



Category

Mode

Inbound (for synchronous mode)

Inbound/outbound (for asynchronous mode)

Synchronous / asynchronous

Definition

The Manage Insurance Claim In service interface processes claim data that has been reported to the insurance company.

Use

The Manage Insurance Claim In service interface groups operations that create claims based on the data reported to the insurance company by the claimant.

Integration

The Manage Insurance Claim In service interface belongs to the Insurance Claim Processing

[Seite 763 ] process component and to the Insurance Claim [Seite 763 ] business object.

Structure

The Manage Insurance Claim In service interface contains the operation

InsuranceClaimCreateRequestConfirmation ( Create Insurance Claim [Seite 764 ] ).

Create Insurance Claim

Technical Data

Entity Type





Category

Mode


Operation

InsuranceClaimCreateRequestConfirmation_In http://sap.com/xi/FS-CM/SE/Global

As of ECC-VPACK 601


Inbound/outbound (for asynchronous mode)

Synchronous/asynchronous

ISI_INSURANCECLAIMCRTRC

Definition

The Create Insurance Claim operation handles requests for the creation of claims coming from a processing system for First Notice of Loss (FNOL) or First Report of Injury (FROI).

Use

The Create Insurance Claim operation creates an insurance claim based on incoming data from a First Notice of Loss (FNOL) or First Report of Injury (FROI).

First Notice of Loss (FNOL) and First Report of Injury (FROI)

In the case of a loss, an insured requests an indemnification by an insurance company for the incurred loss from an insured peril. A loss can be damage through an insured’s negligent acts


SAP Documentation Enterprise SOA and/or omissions resulting in bodily injury and/or property damage to a third party, damage to an insured’s property, or an amount that an insurance company has an obligation to pay.

The insured person informs the insurance company about the loss with a First Notice of Loss

(FNOL). In the case of the workers compensation line of business, this information is called

First Report of Injury (FROI). This notice is part of the standard insurance provisions defining the insured’s obligations after a loss. It is the starting point for the management of a claim.

Features


InsuranceClaimCreateRequest_sync

An InsuranceClaimCreateRequest is a message from an FNOL/FROI processing system to SAP Claims Management with the purpose of establishing a claim, which is the starting point of a claim process.

InsuranceClaimCreateConfirmation_sync

An InsuranceClaimCreateConfirmation is a message from SAP Claims Management to an FNOL/FROI processing system about the creation of a claim.

Integration

This operation belongs to the Manage Insurance Claim [Seite 763 ] inbound service interface.

Insurance Claim Notification

Technical Data

Entity Type


Business Object mySAP ERP Enhancement Package 1

Definition

An Insurance Claim Notification contains information about a loss or injury that is necessary for an insurance company to create a First Notice of Loss (FNOL) or First Report of Injury

(FROI) claim notification.

Use

The Insurance Claim Notification business object contains operations that you can use to create a claim notification.

Manage Insurance Claim Notification

Technical Data

Entity Type


Category

Service Interface mySAP ERP Enhancement Package 1




Mode Synchronous

Definition

The Manage Insurance Claim Notification service interface processes claim notification data that has been reported to the insurance company.

Use

The Manage Insurance Claim Notification service interface groups operations that create claim notifications based on the data reported to the insurance company by the claimant.

Integration

The Manage Insurance Claim Notification service interface belongs to the Insurance Claim

Processing [Seite 763 ] process component and to the Insurance Claim Notification [Seite 765 ] business object.

Structure

The Manage Insurance Claim Notification service interface contains the operation

InsuranceClaimNotificationRequestConfirmation ( Create Insurance Claim

Notification [Seite 766 ] ).

Create Insurance Claim Notification

Technical Data

Entity Type





Category

Mode


Operation

InsuranceClaimNotificationRequestConfirmation http://sap.com/xi/FS-CM/SE/Global

As of ECC-VPACK 601


Synchronous

ISI_INSURANCECLAIMNOTIFCARTRC

Definition

The Create Insurance Claim Notification operation handles requests for the creation of claim notifications coming from a processing system for First Notice of Loss (FNOL) or First Report of Injury (FROI).

Use

The Create Insurance Claim Notification operation creates an insurance claim notification based on incoming data from a First Notice of Loss (FNOL) or First Report of Injury (FROI).

First Notice of Loss (FNOL) and First Report of Injury (FROI)

In the case of a loss, an insured requests an indemnification by an insurance company for the incurred loss from an insured peril. A loss can be damage through an insured’s negligent acts and/or omissions resulting in bodily injury and/or property damage to a third party, damage to an insured’s property, or an amount that an insurance company has an obligation to pay.



The insured person informs the insurance company about the loss with a First Notice of Loss

(FNOL). In the case of the workers compensation line of business, this information is called

First Report of Injury (FROI). This notice is part of the standard insurance provisions defining the insured’s obligations after a loss. It is the starting point for the management of a claim.

Features


InsuranceClaimNotificationRequest_sync

An InsuranceClaimNotificationRequest_sync is a message from an FNOL/FROI processing system to SAP Claims Management with the purpose of establishing a claim notification, which is the starting point of a claim process.

InsuranceClaimNotificationConfirmation_sync

An InsuranceClaimNotificationConfirmation_sync is a message from SAP Claims

Management to an FNOL/FROI processing system about the creation of a claim notification.

Integration

This operation belongs to the Manage Insurance Claim Notification [Seite 765 ] inbound service interface.


Enterprise Services Documentation

Enterprise Services for

SAP ERP 2005

Other Application (Consumer)

SOAP (over HTTP)

HTTP Communication Layer

Web Service Enabling Layer mySAP Application

Applications on SAP Web Application Server

Database

Consumer

Provider

CSI Set of Data

Database

Consumer

Pair of

Services

Actual

Service

Verification

Service

Database

Provider

Identity

Related documents

Add this document to collection(s)

Add this document to saved

Suggest us how to improve StudyLib