Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Configuring a keystore by using a file reference

Updated on March 15, 2022

To configure a keystore, you can reference a keystore file from a file location.

Before you begin: You must create a keystore data instance in Pega Platform with Keystore location equal to Reference to file before you can configure the keystore.
  1. Open a keystore from the navigation panel by clicking RecordsSecurityKeystore and selecting a file reference keystore from the instance list.
  2. In the Keystore file path field, enter the path to the keystore file, for example: C:\keystores\JWTKeys.jks.
  3. In the Keystore type list, select the keystore file type.
    • Java KeyStore (JKS)
    • Public Key Cryptography Standards (PKCS12)
    • JSON Web Key (JWK)
  4. Select the password source for the keystore.
    • Fixed password – After you select Fixed password, in the Keystore password field, enter the password to the keystore file.
    • Clipboard property – After you select Clipboard property, in the Clipboard password property field, enter the name of the clipboard property that you want to get the password from, for example, operatorID.pyPassword.
    • Function – After you select Function, in the Function field, enter the rule utility function to be invoked to get the password. The function must comply with the following syntax: @(RuleSetName:RuleUtilityLibraryName).RuleUtilityFunctionName, for example, @(myApp:PasswordUtil).getPassword().
  5. Select the refresh strategy for your keystore.
    • Reload once per interaction – Disable caching of the keystore file. Choose this if the keystore might change unexpectedly.
    • Cache keystore (default) – Cache the keystore, with the caching time set to 3600 seconds. You can override the caching time in the Reload after field.
  6. Click Save.

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us