Creating and updating product configurations
You and your administrators can create and update some supported product configurations yourselves using the PingOne Advanced Services admin console or administrative API. Learn more about using the API in Accessing the PingOne Advanced Services admin console and administrative API
Supported configurations currently include PingFederate HTML templates, which are used to customize your user-facing pages, and language packs, which are used to localize messages for your users.
| To use this functionality, you must be using platform version 2.2.0 or later with the PingFederate 2.2.1 update. If you are upgrading from an earlier version and your configurations were managed using GitOps orchestration, know that we will migrate your configurations to self-service during the upgrade process. |
Keep the following in mind:
-
After you create or update a configuration, it will take some time for the changes to become available.
-
When you upgrade to another version, files you’ve customized won’t be overwritten with the default files that come with the upgrade. Consequently, we recommend reviewing your customizations and comparing them to the upgrade defaults to determine which version you’d prefer to use. To ensure future upgrades go smoothly, we also recommend keeping customizations to a minimum.
-
Configurations are automatically replicated to child regions in PingOne Advanced Services.
-
Only the last 20 configuration uploads are available for rollback.
-
The Resetting to Default option resets PingOne Advanced Services back to its out-of-the-box defaults and removes all version history.
Configuring product configurations
To create new configurations, complete these steps:
Steps
-
Access the Product Configurations page by selecting it from the navigation.
-
Select the appropriate configuration type line item and click Configure.
-
Select the
.zipfile that contains all the customized files for the configuration.The files within the
.zipfile will be extracted and sent directly into the appropriate configuration directory on the servers, while maintaining the file’s internal structure. Consequently, there’s no need for you to include the root directory in this file.Ensure that this file contains all of your customized files, and not just the most recent changes to the previous upload, because your configurations won’t merge with existing files. Instead, they replace them entirely.
-
When finished, click Save.
Updating product configurations
To update existing configurations, complete these steps:
Steps
-
Access the Product Configurations page by selecting it from the navigation.
-
Select the appropriate configuration type line item, and then click Deployed under Download Configuration to download the current version that contains all of your files.
-
Make your updates in the downloaded file.
-
If you no longer want to customize a file, remove it from the downloaded file.
-
You can get the product default files by downloading the software distributions from
pingidentity.com.
-
-
Click the Pencil icon and select the
.zipfile you just updated.Ensure that this file contains all of your customized files, and not just the most recent changes to the previous upload, because your configurations won’t merge with existing files. Instead, they replace them entirely. -
When finished, click Save.
Rollback product configurations
To rollback product configurations to previous versions, complete these steps:
Steps
-
Access the Product Configurations page by selecting it from the navigation.
-
Select the appropriate configuration type line item.
-
Select the Versions tab and the More options icon, and then select Download next to the appropriate version to download it.
-
Review the
.zipfile to ensure it contains everything needed for the configuration.When you’re ready, return to the console, select the More options icon, and click Rollback.
-
Select the acknowledgment checkbox, then click Rollback when prompted.
Your product configuration is returned to the previous version.