Creating a repository for file storage and knowledge management

Create connections between Pega Platform and repositories to provide centralized storage, versioning, and metadata support for file storage and knowledge management, for example, to store and source file attachments in cases.

This content applies only to on-premises deployments and applications. For Cloud services and applications, an S3 repository is created fo ryou.

Note: To create a repository, your access group must have the PegaRULES:RepositoryAdministrator role. To use a repository, your access group must have the PegaRULES:RepositoryUser role.

The information you enter when you create the connection determines the file specification, also referred to as a file spec. A file spec is an alias, that is, a way to reference file locations that is independent of the physical file storage. A file spec is resolved based on configured file storages, such as repositories. You can view repositories with valid file specs on the File Storage landing page.

  1. In Dev Studio, click Create > SysAdmin > Repository.
  2. Enter a short description of the repository and the repository name and click Create and open.
  3. In the Definition tab, click Select and select the repository type.
  4. Configure your repository type by performing the following actions:
  5. Configure your Amazon S3 repository by performing the following actions:
    1. In the Bucket field, enter the S3 bucket location where artifacts are stored.
    2. In the Authentication profile field, enter the name of the authentication profile to connect to the repository. To create an authentication profile, click the target icon to the right of the Authentication profile field.
      Note: Do not select the Provide secret access key by reference in clear text check box when creating an authentication profile for a repository. This check box is only used when entering Global Resource Settings, and Global Resource Settings are not supported for repositories.
    3. In the Root path field, enter the location of the root folder on S3.
    4. Skip to step 9.
  6. Configure your File system repository by performing the following actions:
    1. In the Resource path field, enter the path under which artifacts are stored on a file system.
      Note: Each node's operating system must detect the resource path in order to import and export artifacts.
    2. Skip to step 9.
  7. Configure your Microsoft Azure repository by performing the following actions:
    1. In the Container field, enter the name of the container registry.
    2. In the Authentication profile field, enter or select the authentication profile to connect to the Azure repository. To create an authentication profile, click the target icon to the right of the Authentication profile field.
    3. In the Root path field, enter the location of the root folder in Azure.
    4. Skip to step 9.
  8. For on-premises deployments, configure your Pega repository by performing the following actions. For Pega Cloud applications, a repository is created and configured for you during provisioning.
    Note: The Pega repository type is shown only if you are using the Deployment Manager, otherwise, you must enable it. For more information, see Enabling the Pega repository type.
    Note: Do not use Pega repositories if you are using Deployment Manager with multiple pipelines per application version. You receive an error and cannot publish the branch into the application, because you cannot select the pipeline into which you want to publish and merge branches. Instead, use the Merge Branches wizard to start pipelines. For more information, see Submitting a branch into a pipeline.
    1. Host ID – The location of the Pega node. It must start with http:// or https:// and must end with PRRestService. For example: http://10.1.5.207:8181/prweb/PRRestService
    2. Optional: In the Use authentication section, specify whether the repository authenticates the user.
    3. Optional: In the Authentication Profile section, specify the authentication profile. If there is no authentication profile, the username must have PRPC:Administrators as an access group.
    4. In the Security section, configure security:
      Secure protocol
      the lowest level of security that can be used. If this minimum level of security is not available, the repository call fails with an error message.
      Truststore
      a Truststore record that contains the server certificate to use in the TLS/SSL handshake.
      Keystore
      a Keystore record that stores the Pega Platform client's private/public key pair that is used by the server to authenticate the client.
  9. Click Test connectivity to verify the credentials.
  10. Click Save.