How to create a Service SOAP


I am asked to create a Service SOAP - receives Work ID and returns Work status. This sounds simple but I am new to integration and not sure how exactly I should create. For example, if I have MyCo-MyApp-Work-PurchaseRequest class, in Service Wizard I need to enter "Data Class". What data class is this supposed to be? Could someone write down steps in brief so I can have better understandings? I do not need link to help or PDN but any screenshot or code based on real use case would be appreciated.



Keep up to date on this post and subscribe to comments

July 6, 2018 - 1:44am


Please find complete understanding of SOAP service below.

When you have a requirement to implement a SOAP web service to expose your application to other applications, you do this by creating a service. SOAP web services communicate using the SOAP protocol and pass XML messages from one application to another. Your application needs to convert that XML message to Pega objects to process them and then convert those Pega objects back to XML after the processing is complete.


A SOAP service uses a combination of rules to process a request. The rules you use are:

Service activity: An activity that performs the steps of what you want done in the service

XML Parser: Map data from an XML message into clipboard property values

XML Stream: Assembles and sends an XML document in an email message, a SOAP message, a file, or other types of messages

Service Package: Groups one or more service rules that are designed to be developed, tested, and deployed together


These rules work together to process a request and send a response back to another application. It follows below steps.


1.A client application sends a request to your application.


2.The service listener listens for incoming requests. This functionality is provided by either the Web Server, Application Server, or Pega Listener.


3.The service listener receives the request and instantiates the Service API to provide communication with Pega. Then, via the Service API, control is handed to Pega.


4.Pega looks up the service package and related service rule, using the access group that is specified in the service package.


5.Pega then establishes the service requestor, and optionally performs authentication based on security credentials that are passed in the request. Once authenticated, service processing continues using the authenticated user’s access group, not the access group that is contained in the service package.


6.The request is mapped, using the instance of an XML Parser rule, onto the clipboard according to the specifications contained in the service rule.


7.Control is passed to the service activity, which provides the logic for the service.


8.Using the XML Parser rule, the service rule maps the clipboard data to form the response data.


9.The service listener receives the response from the Service API.


10.The service listener sends the response back to the application that made the request.


11.The client application receives the request.


Please let me know If you need implementation steps as well.



July 8, 2018 - 10:37am
Response to Abhinav7

Thanks. Yes I am looking for specific implementation steps.

July 10, 2019 - 6:06am
Response to Abhinav7

Hi @Abhinav7 It is very helpful to understand the process. Also could you please add the implementation step to understand what classes we have to create and which class we have to create rules like Parse xml and service activity. ??? 


August 6, 2018 - 6:05am

July 18, 2019 - 4:02am


The attached document might help you.

Thank You,

July 18, 2019 - 5:15am
Response to dasn1

Hi Can I get a similar document for JMS integration creation? 

July 19, 2019 - 6:26am


I have not yet tried configuring JMS integration. Below link might help you.

Thank You,