Skip to main content

 –

Integrating REST connectors with your implementation application

Suggest edit Updated on March 16, 2021

To execute an end-to-end functionality of the service cases, configure REST connectors with the real-time integration or simulated activities provided in the application.

In the absence of a real-time integration, REST connectors are configured with simulation activities to integrate the service cases successfully. The following service cases use REST connectors to update other systems (such as payment gateway or fulfillment systems).

REST connectors with simulation activity

Service CaseREST Connector Service NameSimulation ActivityDescription
Change Service LocationValidateAvailability OfServiceSimulateAvailability OfServiceChecks service availability
Change Service Location

ValidateAvailability

OfAppointments

SimulateAvailability

OfAppointments

Checks for field service agents appointments availability
Change Service LocationSendFulfillmentDetailsFulfillmentResponseSends fulfillment details to downstream applications
Change Service LocationGetWorkOrderDetailsSimulatedWork OrderDetailsGets work order details from downstream applications
Change Service Location

CheckCompatability

OfProduct

SimulateCompatable

OfOrder

Checks selected product compatibility
Create OrderValidateAvailability OfService

SimulateAvailability

OfOrder

Checks service availability
Create OrderUpdateScheduledTasksSimulatedScheduledTasksSends appointment details to downstream applications
Create OrderSendFulfillmentDetailsFulfillmentResponseSends fulfillment details to downstream applications
Create OrderGetWorkOrderDetailsSimulatedWork OrderDetailsGets work order details from downstream applications
Create Order

CheckCompatability

OfProduct

SimulateCompatable OfOrderChecks selected product compatibility
Upgrade DeviceSendFulfillmentDetailsCSCFulfillmentResponseSends fulfillment details to downstream applications
Transfer LineVerifyCreditHistoryCSCVerifyCredit HistoryResponseChecks Credit History of customer
Transfer LineUpdateInventoryDetailsCSCBillingResponseUpdates inventory details to downstream applications
Transfer LineSendBillingDetailsCSCBillingResponsesends bill details to billing application
Payment Integration (CF-Work)SendPaymentDetailsPaymentResponseSends payment details to payment gateway. Used in Transfer line, Upgrade device, New Customer Acquisition Journey, and Make payment service cases.
Auto Payment Request

CSCAutoPayment

RestConnector

CSCPaymentResponseSends payment details to payment gateway. Used in Auto-Payment service case.
Change Service

ValidateEligibilityAnd

Compatibility

SimulateEligibilityAnd

Compatibility

Checks selected product eligibility and compatibility
Change ServiceCPSCCreateOrderSimulateCreateOrderSends order request to downstream applications
Change ServiceChangeServiceConnectorUpdateChange ServiceDetailsGets order request details from downstream applications
Add New Service

ValidateEligibilityAnd

Compatibility

SimulateEligibilityAnd

Compatibility

Checks selected product eligibility and compatibility
Add New ServiceCPSCCreateOrderSimulateCreateOrderSends order request to downstream applications
Add New ServiceAddNewServiceConnectorUpdateAddNew ServiceDetailsGets order request details from downstream applications
Cancel ServiceCPSCCreateOrderSimulateCreateOrderSends order request to downstream applications
Cancel ServiceCancelServiceConnectorUpdateCancel ServiceDetailsGets order request details from downstream applications
Get Work OrderGetWorkOrderDetailsMapWorkOrderDetailsGets work order details from downstreamapplications
Check Credit historyVerifyCreditHistoryVerifyCredit HistoryResponseChecks Credit History of customer
Submit order to fulfillment applicationSendFulfillmentDetailsMapFulfillmentResponseSends fulfillment details to downstream applications

Follow these steps to simulate a REST connector:

  1. In the Explorer panel, click Records.
  2. Click Integration-Connectors > Connect REST.
  3. In the Service Name column, click the filter icon, enter the REST connector service name from the REST connectors with respective simulation activity table into the Search Text field, and then click Apply.
  4. Select the REST connector service name item from the list that corresponds to the service case in the Applies To column. Result: The Connect REST: Validate Eligibility And Compatibility page opens.
  5. On the Service tab, click Simulations at the bottom of the work area.
  6. Enter the Simulation Activity in the text field, and then select the Global radio button.
  7. Click Apply Changes.
  8. Repeat the steps for other service cases listed in the table.
  9. Click Save to save and update the service cases.
What to do next:

After you validate the service cases in your simulation environment, ensure that you update the REST Connectors in your new implementation application. For more information, see Creating a REST integration.

Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us