ProtocalBuffer with REST API
We would like to send message in binary format to external API using protoBuf . The component called "Pega Support for Protocol Buffer" was downloaded from Marketplace and imported into Pega region and added the ruleset version PegaProtoBufSupport & to the application stack .
In order to test it , The cmponent has provided the sample application rules called (AddressBook) , when i tried to make a call using the provided test activity and getting the exception java.lang.ClassNotFoundException: com.pega.proto.example.AddressBook.It seems to be the component jar file doesn't have these classes , what is the process of converting the proto message to Pega class ( com.pega.proto.*).
***Edited by Moderator Rupashree S. to add Capability tags***
Updated: 17 Sep 2024 10:44 EDT
Pegasystems Inc.
GB
@BRAHMESH@ this is a Pega Marketplace offering.
The Pega Support for Protocol Buffer component allows Pega developers to call Protocol Buffer based REST services. It enables Pega REST connectors to generate binary protobuf requests and consume binary protobuf responses. To convert the proto message to a Pega class you need to follow these steps: 1. Generate Sample JSON Payloads: Use the Protocol Buffer messages to generate sample JSON payloads. This can be used in the REST connector wizard for generating the Pega data model. 2. Generate Binary Protocol Buffer Messages: Convert the Pega clipboard pages to binary Protocol Buffer messages. 3. Generate Pega Clipboard Pages: Convert binary Protocol Buffer messages back to Pega clipboard pages. It seems that the exception java.lang.ClassNotFoundException: com.pega.proto.example.AddressBook indicates that the necessary classes are not found in the component jar file. Ensure that the jar file containing these classes is correctly imported and available in your Pega environment.
Please contact the Product Owner listed on the Marketplace offering page:
Pega Support for Protocol Buffer
@issas please can you provide the necessary help here?
Pegasystems Inc.
US
@BRAHMESH@ you are probably trying to use TestAddressBook activity. Please use TestAddressBookWithSchema instead, TestAddressBookWithSchema uses the protocol buffer schema instead of java classes.
If you still want to run TestAddressBook, you need to generate java classes from your protocol buffer schema, import them into Pega and restart your application server.
Here is the process to call a protocol buffer endpoint from Pega:
@BRAHMESH@ you are probably trying to use TestAddressBook activity. Please use TestAddressBookWithSchema instead, TestAddressBookWithSchema uses the protocol buffer schema instead of java classes.
If you still want to run TestAddressBook, you need to generate java classes from your protocol buffer schema, import them into Pega and restart your application server.
Here is the process to call a protocol buffer endpoint from Pega:
- Generate a protobuf schema form ptotobuf messages: protoc -o output_file_name --include_imports input_file_name - (Optional) Generate a jar file form ptotobuf messages: protoc -java_out output_file_name input_file_name - (Optional) Import the generated Jar file and restart Pega application server. - Create a new `Rule-ProtoBuf-Schema` instance: - Upload the generated protobuf schema file. - Generate request and response sample JSON and save them in your local drive - Save the Rule-ProtoBuf-Schema rule. - Run the REST connector wizard and add the request and response sample files in the Data Model step. - Complete the REST wizard. - Modify the generated REST connector: - Request: - Change the content-type header to application/octet-stream - Select Clipboard for Map from - Use .request.body_POST.ProtoRequestMessageBytes_ for Map from - Change `Map as` to `Binary` - Response: - Select `Clipboard` for `Map to` - Use .response_POST.ProtoResponseMessageBytes_ for Map to key - Create an activity to invoke the connector.