VCR REST Connectivity

Transcription

1 VCR REST Connectivity Pega Smart Dispute for Issuers 7.21 December 2017 Introduction This document explains how Pega Smart Dispute for Issuers connects to VCR using REST connectors. VCR supports POST method only for REST. Visa provides WADL files for REST interface. As of Pega 7.2.1, the Connector and Metadata Wizard do not support WADL files. As a result, you have the following options: 1. Manually create 100+ REST connectors. 2. Create re-usable REST connectors: One set for TI and another for SI. Pega Smart Dispute for Issuers uses this approach, as it can re-use the existing Request and Response data transform rules and also eliminate the need to maintain multiple REST connectors. Data model The REST connectors use the clipboard page RestRequestPage to map the request and the response. This page will be of class PegaCard-Int-Visa-RTSI-TI-Services- or PegaCard-Int- Visa-RTSI-SI-Services- depending on the category of the connector being invoked. The embedded page RestRequest contains the request, and the embedded page RestResponse contains the response. Both are Single Page properties created in the PegaCard-Int-Visa class with a page definition of $ANY, as these properties are able to hold requests and responses related to any of the operations. The RestRequest page is populated in the data transform rule MapRestRequestPage. This data transform is available in both the PegaCard-Int-Visa-RTSI-TI-Services- and PegaCard- Int-Visa-RTSI-SI-Services- classes, and the appropriate rule will be picked up based on the connector. Tech Note 1

2 The RestResponse page contains the response from the Connect-REST. It is then mapped to the pytempresponsepage using the data transform MapRESTResponse for mapping back to the work object. The REST connector then uses the RestRequest and RestResponse pages to complete the interaction. VCR supports attachments through multipart form data. In order to generate multi part attachment in SD, both the request data and documents should be treated as attachments and attached to the pyrequestattachmentpage before the Connect-REST is invoked. REST Connectors Smart Dispute uses the following connect rules to connect to VCR: Tech Note 2

3 1. VCR_REST_CONNECTOR: Two rules with this name exist in PegaCard-Int-Visa-RTSI-SI- Services- and PegaCard-Int-Visa-RTSI-TI-Services- class to send a plain application/json request where attachments are not required. 2. VCR_REST_CONNECTOR_FOR_ATTACHMENTS: Two rules with this name exist in PegaCard-Int-Visa-RTSI-SI-Services- and PegaCard-Int-Visa-RTSI-TI-Services- class to send multipart request where attachments are required. 3. RestRuleForJSONGeneration: This Connect-REST rule is only used to convert request clipboard page to JSON string without any pxobjclass properties in the generated JSON. This generated JSON string will then be passed as an attachment to the pyrequestattachmentpage to generate a multipart request. In the above screenshot, the TI REST connector shows the request tab. This generates the REST request in application/json format that will be used when no attachments are required. Tech Note 3

4 In the following screenshot, the TI REST connector shows the response tab. VCR_REST_CONNECTOR_FOR_ATTACHMENTS for SI category. No data is mapped on the Post Request tab. JSON is generated through activities and mapped on to pyrequestattachmentpage. Tech Note 4

5 The response is mapped to the RestResponse page, as in the VCR_REST_Connector rule. Flow updates The flow rule VCRConnector of PegaCard-Sd-Dispute- has been modified to include the SOAP connector flow and the REST connector flow rules. The dynamic system setting VCR_Connectivity will decide whether to use SOAP or REST. The customer can update this setting to suit their preference. Tech Note 5

6 The CallRESTConnector flow is similar to the CallSOAPConnector flow, which in turn calls the InvokeRESTConnector through the InvokeRESTConnector flow rule. The CallRESTConnector activity rule contains the Connect-REST method, which invokes the appropriate REST Connector based on the scenario. Tech Note 6

7 This activity performs the following steps: It generates the necessary request clipboard page by invoking the request data transform corresponding to the connector being invoked. It generates the RestRequestPage by copying the contents of pytempdatapage to the RestRequestPage and removing the request header. The RequestHeader should not be sent for VCR REST connectivity. The RestRequestPage contains the property RestRequest, which holds the actual request data. The date fields on this page will still be in Pega date format yyyymmdd ; however, VCR requires that the date fields be sent in YYYY-MM-DD format. The activity also processes the date fields prior to sending the request to the REST connector. The REST end point URL needs to be generated dynamically and passed to the connector rule instead of hard coding the URL on the REST Connector. This activity dynamically generates the end point URL. This activity also evaluates the when rule SendMultiPartRequest. If this when rule returns a value of true, the activity rule MulitPartRESTConnector of PegaCard-Sd-Dispute-Visawill be invoked. This activity performs the following operations: Tech Note 7

8 1. Generates the JSON string from the request clipboard page using the RestRuleForJSONGeneration Connect-REST rule and removes the pxobjclass from the generated JSON 2. Populates the first part of pyrequestattachmentpage with the generated JSON string to be sent as an attachment 3. Invokes the Connect-REST rule VCR_REST_CONNECTOR_FOR_ATTACHMENTS After receiving the response, the response is mapped back to the pytempresponsepage using the data transform rule MapRESTResponse. Then the Response DT is called for mapping the response back to the work object. Generating a REST multipart request VCR expects a multipart request for certain REST services, such as SubmitDisputeQuestionnaire. A multipart request contains several parts one for the request data and one or more parts for attachments. To generate a multipart request, the different parts should be available as attachments on the pyrequestattachmentpage. The number of parts generated in the REST request will be equal to the number of attachments on the pyrequestattachmentpage. This is achieved in Smart Dispute by sending the RequestData as a JSON file. No JSON file is generated for the RequestData, but the first part on the pyrequestattachmentpage will be populated as an attachment. The name of the file will be RequestData.json. As shown in the screenshot above, the request data will be base64 encoded and added to the pyrequestattachmentpage. Tech Note 8

9 The remaining actual document attachments would already have been populated on the pyrequestattachmentpage as part of the UploadDisputeAttachmentDescriptor activity rule. When the Connect-REST rule is invoked, Pega will read all the attachments on the pyrequestattachmentpage and convert them as parts, generating a multipart request. Note: Hotfix HFix-36607: CONNECT-REST issue with multipart form-data content type should not be installed. If installed, it encodes the data that is being sent as an attachment, thereby corrupting the request data. If this hotfix is already installed, the request body should not be encoded using base64 format in Step 3 and 4 or using the MultiPartRESTConnector activity rule. Smart Dispute generates a multipart request for the following VCR operations: SubmitDisputeQuestionnaireOperation CreateDisputeResponseOperation CreateDisputePreCompOperation CreateDisputePreCompResponseOperation CreateDisputePreArbOperation CreateDisputePreArbResponseOperation SubmitDisputeFilingOperation Tech Note 9

10 If a multipart request is required for any other VCR service, that service name can be added to the when rule SendMultiPartRequest. Note that although all VCR services can be configured in multipart request format, it is mandatory only for certain services. Multipart request slightly increases the request generation time because additional rules need to be invoked to generate a multipart request. Smart Dispute supports multipart request generation only for mandatory services. Changes to the Pega VCR Services data type The Pega VCR Services data type is used to perform a single point lookup for fetching the Request and Response data transforms, and simulation request and response data transforms for both SOAP and REST connectivity. For REST connectivity, a new column RESTEndPointURL has been added to this data type, which will contain the resource path for the operation. Tech Note 10

11 2018 Pegasystems Inc., Cambridge, MA All rights reserved. Trademarks For Pegasystems Inc. trademarks and registered trademarks, all rights reserved. All other trademarks or service marks are property of their respective holders. For information about the third-party software that is delivered with the product, refer to the third-party license file on your installation media that is specific to your release. Notices This publication describes and/or represents products and services of Pegasystems Inc. It may contain trade secrets and proprietary information that are protected by various federal, state, and international laws, and distributed under licenses restricting their use, copying, modification, distribution, or transmittal in any form without prior written authorization of Pegasystems Inc. This publication is current as of the date of publication only. Changes to the publication may be made from time to time at the discretion of Pegasystems Inc. This publication remains the property of Pegasystems Inc. and must be returned to it upon request. This publication does not imply any commitment to offer or deliver the products or services described herein. This publication may include references to Pegasystems Inc. product features that have not been licensed by you or your company. If you have questions about whether a particular capability is included in your installation, please consult your Pegasystems Inc. services consultant. Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain inaccuracies or typographical errors, as well as technical inaccuracies. Pegasystems Inc. shall not be liable for technical or editorial errors or omissions contained herein. Pegasystems Inc. may make improvements and/or changes to the publication at any time without notice. Any references in this publication to non-pegasystems websites are provided for convenience only and do not serve as an endorsement of these websites. The materials at these websites are not part of the material for Pegasystems products, and use of those websites is at your own risk. Information concerning non-pegasystems products was obtained from the suppliers of those products, their publications, or other publicly available sources. Address questions about non-pegasystems products to the suppliers of those products. This publication may contain examples used in daily business operations that include the names of people, companies, products, and other third-party publications. Such examples are fictitious and any similarity to the names or other data used by an actual business enterprise or individual is coincidental. This information is the property of: Pegasystems Inc. One Rogers Street Cambridge, MA USA Phone: (617) Fax: (617) Pega Smart Dispute for Issuers Document: VCR REST Connectivity Software Version: 7.21 Updated: December 2017 Tech Note 11