Custom Multi-Part REST API Based Repository For Document Upload From Constellation Based Application

General
1

Hello,

I have followed the below instructions and created a custom repository for document upload.

Implementing Custom Repository Extension APIs | Support Center ?

Below are my questions if anyone can assist that would be great.

1. I have created my custom repository following your instructions. My custom repository is organization specific repository where I am supposed to send them files via multi-part REST API. So, in this scenario, what file path do I need to give to the new repository I have created?

2. But I see my new repository in the integration tab of my application and when I select and click on browse, it says, there is a problem in your repository.

2. I also don’t know what changes I am supposed to do in this pyRepoConfiguration section rule that I have saved as in my custom repository class? I understand that this section is useful to provide the host, file path, branch or etc attributes in this section, but for REST API, everything will be configured inside the REST rule. Can someone clarify if anyone know or did this kind of scenario?

3. In Constellation, when user uploads multiple documents, on what page list do we loop our code? I believe Pega will call multiple times this code for each document user uploads so I don’t need to worry about looping the page list. Please correct me if I am wrong.

4. I understand that pyNewFile is the way for Pega to communicate your external repository. That means, I need to send the required pycontent of the file along with file name etc from this activity to my rest api data page. But on what page context will I get this data? What is the filepage here that I see? Do we need to use the pyNewFileAttachment.pyAttachStream for the pycontent by defining this page in pages & classes? Please clarify.

  1. Inside the repository rule, when i click on validate or test connectivity it fails, so for a rest api based repository, what would be the host name, as we use the MuleSoft gateway url not the direct repository api url in our org.
2

I recommend to use custom DX Component and leverage DX APIs to upload the attachment through Multipart and associate the attachment id to the case id. The Upload supports multipart document attachment upload to your Repository. Ensure the Repository configurations are configured in the Application rule.

Supercharge Your Digital Channels: The Ultimate Guide to Pega Constellation DX APIs

Attachments (Step1)

  • Method: POST
  • URL: https://{LabInstanceURL}/prweb/app/retail-banking/api/application/v2/attachments/upload
  • Category: Attachments
  • Sample API Request: appendUniqueIdToFileName: true
    file: (binary)

Attachments (Step2)

  • Method: POSt
  • URL: https://{LabInstanceURL}/prweb/app/retail-banking/api/application/v2/cases/{CasInseKey}/attachments
  • Category: Attachments
    Sample API Request:
{
  "attachments": [
    {
      "type": "File",
      "category": "File",
      "ID": "60b079d2-eb1d-404d-a6dd-c61d7607561c",
      "filename": "AlertLog_Dec27.txt"
    }
  ]
}