Upgrade (Agents)

Upgrading the Agents Accelerator should be treated as a project change rather than routine maintenance. Once the accelerator has been implemented as part of a customer solution, an upgrade may overwrite certain objects while leaving other configurations unchanged. Therefore, each upgrade must be carefully assessed, taking into account the customer's current accelerator version and any customizations.

Prerequisites

Before starting the upgrade, ensure that all of the following prerequisites are met:

1. Access and Permissions

You must have access to both PlatformManager and the target partition, as the Agents Accelerator is deployed from the PlatformManager Marketplace.

2. Target Partition Readiness

Confirm that the target partition is ready for upgrade:

• Ensure that the following accelerators are deployed:

  • Sales Insights (v1.13.0 or later)

  • Customer Insights (v1.11.3 or later)

  • Agents Accelerator (v1.0 or later)

• Verify that your Pricefx application is running version 15 or later and that the required core data (Products, Customers, and Transactions) is available and updated regularly. Otherwise, you will not be able to deploy the Agents Accelerator from the PlatformManager Marketplace.

• Ensure that both DEV and QA environments are available for upgrade testing.

  • If a DEV environment is not available, perform all upgrade activities described in this guide in the QA environment instead.

3. Pricefx Studio Readiness

Ensure that Pricefx Studio is available for the source code and fetch workflows used during the upgrade.

This includes:

• Pricefx Studio version 16.2 or later.

4. Project Knowledge Readiness

Before starting the upgrade, gather the information required to assess the upgrade impact.

4.1 Currently Installed Agents Accelerator Version

• Identify the currently installed version of the Agents Accelerator.

• If the installation process was followed correctly, your Git project repository should contain a commit indicating the installed version. The commit message typically follows this format:

PFAGENTS-123 Installation of Agents Accelerator 1.6

• If no such commit exists, see 2. Identify Deployed Accelerators Version for alternative methods to determine the installed version.

• You can also verify the version using the deployedAccelerators Company Parameter. During deployment, PlatformManager stores the deployed accelerator version in the Company Parameter table.
  Example:

{"processedActions":{"Group":["ActIn_WatchersContributor","ActIn_WatchersManager","ActIn_WatchersAnalyst"],"ModuleCategory":["Agents","ActionPlans"],"CustomFormType":["AG_ActionPlan"],"CalculationLogic":["AG_PAChartSimpleActionLogic+2018-01-01","AG_Flex__Step_Summary__Tab_Default+2018-01-01","AG_ActionTaskLib_QuoteCreation+2018-01-01","AG_Datamart_ScopeDataConfigurator+2018-01-01","AG_Copilot_Recommendation_ContextLinkingLogic+2018-01-01","AG_Datamart_DetectionRulesConfigurator+2018-01-01","AG_Datamart_Evaluations+2018-01-01","AG_Flex__Result_Calculations+2018-01-01","AG_DashboardSimpleAction_AnalyticDashboard+2018-01-01","AG_ActionTaskLib_UpdatePSPPriceInPG+2018-01-01","AG_AnalyticDashboards_Lib+2018-01-01","AG_ActionDefinition_AdvancedAssignmentConfigurator+2018-01-01","AG_FlexEngine_DealsOutsideGuidelines+2020-01-01","HighchartsLibrary+2000-01-01","AG_Datamart_Data_Evaluations+2018-01-01","AG_Flex__Step_Definition__Configurator+2018-01-01","AG_Flex__Step_ActionDefinition__Tab_Default+2018-01-01","AG_ActionTaskExecutor_UpdatePSPPriceInPG+2019-01-01","AG_Dashboard_ActionDefinition+2018-01-01","AG_Datamart_Summary+2018-01-01","AG_ActionLogic+2018-01-01","AG_Action_AgentActionReview_EmbeddedDashboard+2018-01-01","AG_Dashboard_DataScopeDefinition_PreparationCalculation+2018-01-01","AG_DetectionRules_InsightConfigurator+2018-01-01","AG_Flex__ActionDefinition_Configurator+2018-01-01","HighchartsPortletLibrary+2020-01-01","SharedAccLibForAgents+2010-01-01","AG_Copilot_Recommendation_ActionDashboardLogic+2018-01-01","AG_ActionDefinitionEditorConfigurator+2018-01-01","AG_Datamart_ResultsCalculation+2018-01-01","AG_Flex__Step_Definition__Tab_Default+2018-01-01","AG_ActionPlanHeader_Configurator+2018-01-01","AG_FlexLib+2018-01-01","AG_Dashboard_Evaluations+2018-01-01","AG_FlexEngine_QuoteApprovalVelocity+2020-01-01","AG_ActionPlanHeader+2018-01-01","AG_Dashboard_ActionDefinitionConfigurator+2018-01-01","AG_ActionTask_ContextLinking_Builder+2018-01-01","AG_Dashboard_ScopeData+2018-01-01","AG_Action_AnalyticDashboard+2018-01-01","AG_Datamart_DetectionRules+2018-01-01","AG_Datamart_ActionDefinitionConfigurator+2018-01-01","AG_Dashboard_SchedulerConfigurator+2018-01-01","AG_Flex__Evaluations+2018-01-01","AG_PSP_Integration+2020-01-01","AG_Dashboard_ResultsCalculation+2018-01-01","HighmapsLibrary+2019-01-01","AG_ActionTaskWizard_UpdatePSPPriceInPG+2019-01-01","AG_Datamart_ActionDefinition+2018-01-01","AG_Library+2018-01-01","AG_Datamart_SchedulerConfigurator+2018-01-01","AG_Dashboard_ScopeDataConfigurator+2018-01-01","AG_Copilot_Recommendation_ActionLogic+2018-01-01","AG_Datamart_ScopeData+2018-01-01","AG_AnalyticDashboard_AgentActionReview+2018-01-01","AG_Dashboard_DetectionRules+2018-01-01","AG_Flex__Scheduler_Configurator+2018-01-01","AG_Dashboard_DetectionRulesConfigurator+2018-01-01","AG_Dashboard_Summary+2018-01-01","AG_Dashboard_Data_Evaluations+2018-01-01","AG_Flex__Data_Evaluations+2018-01-01","AG_Flex__Step_Schedule__Tab_Default+2018-01-01","AG_MCP_Tools+2020-01-01","AG_FlexEngine_PriceGuidanceComplianceAgent+2020-01-01","SharedLibForAgents+2010-01-01"],"BusinessRole":["ActIn_WatchersContributor","ActIn_WatchersManager","ActIn_WatchersAnalyst"],"Dashboard":["AG_Action_AnalyticDashboard","AG_DashboardSimpleAction_AnalyticDashboard","AG_Action_AgentActionReview_EmbeddedDashboard","AG_Copilot_Recommendation_ActionDashboard","AG_AnalyticDashboard_AgentActionReview"],"ActionItemAttribute":["attributeExtension___pfxAcc_AG_othersImpact","attributeExtension___pfxAcc_AG_profitImpactMeasureName","attributeExtension___pfxAcc_AG_trendsImpact","attributeExtension___pfxAcc_AG_trendsImpactMeasureName","attributeExtension___pfxAcc_AG_benchmarkImpact","attributeExtension___pfxAcc_AG_revenueImpactMeasureName","attributeExtension___pfxAcc_AG_targetImpactMeasureName","attributeExtension___pfxAcc_AG_costsImpactMeasureName","attributeExtension___pfxAcc_AG_costsImpact","attributeExtension___pfxAcc_AG_currency","attributeExtension___pfxAcc_AG_revenueImpact","attributeExtension___pfxAcc_AG_othersImpactMeasureName","attributeExtension___pfxAcc_AG_benchmarkImpactMeasureName","attributeExtension___pfxAcc_AG_targetImpact","attributeExtension___pfxAcc_AG_profitImpact"],"PricingParameter":["AG_Configurations+2018-01-01 MATRIX ATTRIBUTES","AG_Configurations+2018-01-01","AG_Configurations+2018-01-01 DATA"],"DataSource":["AG_ActionTask_UpdatePSPPriceInPG"],"ConfigurationWizard":["pfxAcc_AG_ActionTask_UpdatePSPPriceInPG"],"ModelClass":["AG_Datamart","AG_Flex","AG_Dashboard"],"Preference":["DashboardReact_AG_AnalyticDashboard_AgentActionReview+AG_Default","8.MC-DataScope-DataScope_Default+dm_watcher_default","DashboardReact_AG_Action_AgentActionReview_EmbeddedDashboard+AG_Default_Action","DashboardReact_AG_AnalyticDashboard_AgentAssessmentOverview+AG_Default","PricingMatrixValuesAG_Configurations+default"],"WorkflowFormula":["AG_DefaultWorkflow+2018-01-01"],"Internationalization":["en"],"AdvancedConfiguration":["MCP_role_ag_tool_manager","enableCopilot","pfxContextualAction_AG_PASimpleAction","pfxContextualAction_AG_DashboardWatcher","MCP_tool_pricefx_acc_ag_get_datamart_product_transactions","ai_dashboard_description_AG_AnalyticDashboard_AgentActionReview","chartContextualMenu","pfxAcc_AG_actionItem_impactDefinition_attributeExtension_mappings","pfxAcc_AG_Engines_Config__PriceGuidanceComplianceAgent","pfxContextualAction_AG_PAChartsWatcher","pfxAcc_AG_Action_Tasks_Config__QuoteCreation","pfxAcc_AG_Action_Tasks_Config__UpdatePSPPriceInPG","pfxContextualAction_AG_DashboardSimpleAction","MCP_tool_pricefx_acc_ag_get_agents_customer_transactions","pfxAcc_AG_Engines_Config__DealsOutsideGuidelines","enableDashboardAIAssistant","pfxAcc_AG_Engines_Config__QuoteApprovalVelocity","ai_dashboard_description_AG_Action_AgentActionReview_EmbeddedDashboard","MCP_tool_pricefx_acc_ag_get_datamart_customer_transactions","ai_dashboard_description_AG_AnalyticDashboard_AgentAssessmentOverview"]},"templateVersion":"1.6.0"}

• If you are still unable to determine the installed version, contact Support. They can verify it using the internal Accelerator Usage Finder tool.

4.2 Project Customizations

• Determine whether the project contains customizations beyond the standard Agents Accelerator delivery.

• If you are unsure whether the project has been customized, see How To Detect Customizations.

• Although the official recommendation is not to customize the Agents Accelerator, it is important to identify any existing customizations before upgrading. This allows you to back up the project and reapply any required changes after the upgrade, if necessary.

5. Source Control and Backup Readiness

5.1 Back Up the Project Source Code

Back up the project by following 3. Ensure Accelerator Objects Are Backed Up or Already Stored in Git | Accelerator in Scope was Already Installed.

Verify that backups of the following accelerator source code are available in Git:

• Sales Insights Accelerator

• Customer Insights Accelerator

• Agents Accelerator

• Shared Library Accelerator

• Dashboard Library Accelerator

5.2 Back Up Existing Agents

Back up the existing agents by exporting them and storing the exported archive in a SharePoint folder or attaching it to the corresponding Jira ticket. This ensures that the original agent definitions are available if a rollback is required.

To export agents:

1. In the target partition, from the Pricefx navigation menu.

2. Go to Pricefx Agents > Agents.

3. Select the agents you want to back up.

4. Click Export.

5. Save the generated .zip file to a SharePoint folder or attach it to the corresponding Jira ticket.
   Example:

Upgrade Steps

Make sure all prerequisites are met before proceeding.

Upgrade Overview

The upgrade process consists of the following high-level steps:

1. Prepare and assess the upgrade in the DEV environment (or QA if a DEV environment is not available).

2. Deploy the upgrade to DEV using PlatformManager, then commit the changes to Git.

3. Perform the required manual post-upgrade steps in DEV, then commit the changes to Git.

4. Reapply any project customizations, if applicable, and commit the changes to Git.

5. Perform an initial round of smoke testing in DEV (or QA if a DEV environment is not available).

6. Merge the changes into the main Git branch (typically master) so that the deployment pipeline can promote the upgrade to QA and PROD.
   See Pricefx Git Workflow for more information.

7. Validate the upgrade in QA. Skip this step if you do not have a DEV environment and performed testing in QA during step 5.

8. Repeat the validation in the PROD environment.

Deploy the Latest Version of Agents Accelerator and Commit to Git

1. In the PlatformManager Marketplace, select the Agents Accelerator package.

2. Select the target partition. Use your DEV environment whenever possible (or QA if a DEV environment is not available).

3. Select the latest available version (the topmost entry in the list).

4. Click Deploy.

   

Fetch Updated Source Code

1. Open IntelliJ IDEA with the Pricefx Studio plugin installed.

2. Open the Fetch tool window.

3. 

   Select the agents-accelerator component folder.

   This component folder should already exist because it was fetched during the backup process described in the prerequisites.

4. Click Select all entities and their objects that exist in the selected directory ( ).

5. Clear the Internationalization entity.

   

6. Click Fetch.

Commit Upgrade to Git

1. Create a new Git branch for the upgrade based on the main branch (typically master).

   It is safe to apply the upgraded source code on top of existing project customizations, provided that all required backups have been completed as described in Source Control and Backup Readiness.

2. Commit the fetched changes to the new branch using a commit message similar to the following:

PFAGENTS-123 Upgrade to Agents Accelerator 1.6

Replace the ticket number and accelerator version as appropriate.

Deploy Latest Version of Agents Accelerator Dashboards and Commit to Git

Deploy Package

1. In the PlatformManager Marketplace, select the Agents Accelerator Dashboards package.

2. Select the target partition. Use your DEV environment whenever possible (or QA if a DEV environment is not available).

3. Select the latest available version (the topmost entry in the list).

4. Click Deploy.

   

Fetch Updated Source Code

1. Open IntelliJ IDEA with the Pricefx Studio plugin installed.

2. Open the Fetch tool window.

   

3. Select the agents-accelerator-dashboards component folder.

   This component folder should already exist because it was fetched during the backup process described in the prerequisites.

4. Click Select all entities and their objects that exist in the selected directory ( ).

5. Clear the Internationalization entity.

   

6. Click Fetch.

Commit Upgrade to Git

1. Switch to the upgrade branch created in Step 1.
   This branch should already contain the commit for the Agents Accelerator upgrade.

2. Commit the fetched changes using a commit message similar to the following:

PFAGENTS-123 Upgrade to Agents Accelerator Dashboards 1.6

Replace the ticket number and dashboard package version as appropriate.

Deploy Latest Version of Dashboard Library Accelerator and Commit to Git

Deploy Package

1. In the PlatformManager Marketplace, select the Dashboard Library Accelerator package.

2. Select the target partition. Use your DEV environment whenever possible (or QA if a DEV environment is not available).

3. Select the latest available version (the topmost entry in the list).

4. Click Deploy.

   

Fetch Updated Source Code

1. Open IntelliJ IDEA with the Pricefx Studio plugin installed.

2. Open the Fetch tool window.

   

3. Select the dashboard-library-accelerator component folder.

   This component folder should already exist because it was fetched during the backup process described in the prerequisites.

4. Click Select all entities and their objects that exist in the selected directory ( ).

5. Click Fetch.

Commit Upgrade to Git

1. Switch to the upgrade branch created in Step 1.
   By this point, the branch should already contain the commits for upgrading both the Agents Accelerator and the Agents Accelerator Dashboards.

2. Commit the fetched changes using a commit message similar to the following:

PFAGENTS-123 Upgrade to Dashboard Library Accelerator 1.6.2

Replace the ticket number and accelerator version as appropriate.

Migrate Watchers (Optional)

If the Actionable Insights Accelerator was previously installed, migrate the existing Watcher model objects to Agent model objects by following the instructions in Migrate Watcher Model Objects to Agent Model Objects.

Perform Manual Post-Upgrade Steps

Some configuration changes must be applied manually after the deployment. If you already have backups of the configuration files described below, reapply them and skip the corresponding steps. Otherwise, create or update the configurations as described.

Update Company Parameters

Update the AG_Configurations Company Parameter:

(Optional) Configure Copilot

If you want to enable Copilot (AI Assistant) integration with Agents, create the required Advanced Configuration Options and configure the following settings:

• enableCopilot

• enableDashboardAIAssistant

Review Business Role Assignments

The business role labels for the Actionable Insights Accelerator have been renamed to Agents for consistency. After upgrading, review all user role assignments and update them as follows:

Fetch the Updated Configuration

1. Open IntelliJ IDEA with the Pricefx Studio plugin installed.

2. Open the Fetch tool window.

   

3. Fetch the configuration changes described above into your project.

Commit Changes

Commit the updated configuration to the upgrade branch using a commit message similar to the following:

PFAGENTS-123 Manual post-upgrade configuration

Replace the ticket number as appropriate.

Reapply Project Customizations

If project customizations were identified during the prerequisite assessment, reapply them to the upgraded project before proceeding with testing.

The following workflow is recommended:

1. Check out the Git branch containing the project customizations identified in How to Detect Customizations.

2. Merge this branch with the upgrade branch that contains the latest Agents Accelerator upgrade.

3. Resolve any merge conflicts.

4. Verify that the merged branch includes the upgrade commits for all accelerator packages. The commit history should include entries similar to the following:

PFAGENTS-123 Upgrade to Agents Accelerator 1.6
PFAGENTS-123 Upgrade to Agents Accelerator Dashboards 1.6
PFAGENTS-123 Upgrade to Dashboard Library Accelerator 1.6.2

Replace the ticket number and versions as appropriate.

5. Test the merged project to verify that both the upgrade and the project customizations work as expected.

How to Verify Upgrade

After completing the upgrade and reapplying any project customizations, create a merge request for the upgrade branch.

Once the merge request has been approved and merged, wait for the deployment pipeline to promote the changes to the QA and PROD environments. Then validate the upgrade by performing smoke and regression testing in QA.

1. Start by running the same post-deployment tests that are performed after a new installation.
   For details, see the Post-Deployment in the Installation (Agents Accelerator) | Post Deployment.

2. In addition, perform the following verification steps:

   1. Verify that the Agent Assessment Overview and dashboards are available and display data correctly.
      For details about the dashboard contents, see Agents Dashboards (Agents).

   2. Verify that Copilot behaves as expected for the target release by following these guides:

      • Create Agent inside Pricefx Copilot

      • Using Copilot for Ongoing Guidance

If the QA validation is successful, repeat the required smoke and regression tests in the PROD environment.

Known Limitations and Risks

Keep the following considerations in mind when planning and performing an upgrade:

• Agents Accelerator upgrades are not simple plug-in replacements. They modify an implemented customer solution and may require impact analysis, regression testing, and the reapplication of project-specific customizations.

• Customizing the Agents Accelerator is not recommended. Projects that modify the standard accelerator code or structure carry additional technical and organizational risk during upgrades. Customizations must be carefully identified, reviewed, and validated after the upgrade.

• Dashboard compatibility depends on the Pricefx core version. Due to packaging changes introduced between Agents Accelerator versions 1.2 and 1.2.3, the target partition must be running Pricefx 15 or later before the dashboard packages can be deployed successfully.

Rollback Guidance

Always create and verify backups before starting an upgrade.

1. Stop the Rollout

If smoke tests fail or a critical issue is identified, stop the rollout immediately. Keep the upgrade branch intact for failure analysis.

2. Restore the Project from Git

Identify the rollback baseline:

• Use the last backup commit created during Source Control and Backup Readiness, immediately before the first upgrade commit.

• Create a dedicated rollback branch (for example, pfxagents_rollback) from this baseline.

3. Redeploy the Previous Version

In Pricefx Studio:

1. Open the Deploy tool window.

2. Deploy each affected component to the target partition:

   • agents-accelerator

   • agents-accelerator-dashboards

   • dashboard-library-accelerator

3. Click Select all entities and their objects that exist in the selected directory ( ).

4. Clear the Internationalization entity.

5. Click Deploy.

4. Remove Objects Introduced by the Upgrade

Redeploying an older version overwrites existing objects but does not remove objects introduced by the newer version.

Compare the upgrade branch with the rollback baseline and manually remove any objects that exist only in the upgraded version.

5. Restore Agents (If required)

If agents created or modified during the failed upgrade no longer function correctly:

1. Open the Agents page.

2. Click ⋯ > Import.

3. Import the backup .zip file created during Source Control and Backup Readiness.

   

If the existing agents continue to function correctly, this step can be skipped.

6. Restore Manual Configuration Changes

Reverse any manual configuration changes that were applied during the upgrade.

This includes:

• Restoring the deployedAccelerators Company Parameter to the previous accelerator version by updating the templateVersion value.

  

• Restoring the AG_Configurations Company Parameter to its pre-upgrade state, or removing it if it did not exist before the upgrade.

• Reverting any Copilot configuration changes:

  • Remove enableCopilot and enableDashboardAIAssistant if they were created during the upgrade.

  • Otherwise, restore their previous values.

• Reverting any additional partition-level changes, such as application preferences, permissions, or other manual configuration changes.

7. Restore Business Roles (Optional)

If the environment previously used the Actionable Insights Accelerator, restore the original business roles by:

• Reassigning users from the [Agents] roles back to the corresponding [Actionable Insights] Watchers roles.

• Removing the [Agents] roles if they were introduced solely by the failed upgrade.

8. Validate Rollback

Verify that the restored environment functions correctly by following the validation procedure described in How to Verify the Upgrade. Before attempting another production rollout, repeat the required validation in the QA environment.

Responsibilities and Escalation

Customer Responsibilities

The customer is responsible for:

• Providing a suitable QA or sandbox environment for upgrade validation.

• Ensuring that the target environment and core business data are ready for the upgrade.

• Providing visibility into any project-specific customizations or operational constraints.

• Performing business acceptance testing after successful smoke and regression testing.

Partner Responsibilities

The implementation partner is responsible for:

• Assessing the upgrade path and identifying all required manual upgrade steps.

• Confirming the currently installed Agents Accelerator version.

• Executing and validating the upgrade in a non-production environment before deploying to production.

• Performing all required manual post-upgrade steps.

• Reapplying and validating approved project-specific customizations.

• Coordinating QA validation and the production rollout.

Pricefx Responsibilities and Escalation

For activation, implementation, and ongoing support, contact the Agents team at agentactivation@pricefx.com.

Escalate the upgrade to the appropriate Pricefx team if:

• The correct upgrade path or compatibility requirements are unclear.

• The customer solution contains non-standard customizations that may affect the upgrade.

• Smoke or regression testing reveals functional issues after the upgrade.

• Additional assistance is required to diagnose or resolve upgrade-related problems.

See Also

• How to Detect Customizations (Agents)

• Troubleshooting and FAQ (Agents)

• Upgrade (Customer Insights)

• Upgrade (Sales Insights)