Product Definitions Not Compiling After Configurator Package Upgrade

Symptom

After upgrading the CloudSense Configurator (cscfga) package to R36 or later, clicking the "Compile Model" button on a Product Definition page throws an error. The compilation fails because the button references the deprecated CaptureProductModel Visualforce page.

The old "Compile Model" button no longer functions after the upgrade.

Cause

The Configurator package upgrade deprecated the CaptureProductModel page and replaced it with a new compilation mechanism. The old "Compile Model" button still exists on the Product Definition page layout but points to the removed page, causing the error.

The new compilation button is called "Compile Online Rules & UI" and is automatically added to the Product Definition page layout during the upgrade.

Resolution

Step 1: Use the new "Compile Online Rules & UI" button

On the Product Definition page, locate the "Compile Online Rules & UI" button (it should already be present after the upgrade). Click this button instead of the old "Compile Model" button.

After compilation completes, verify that attachments were generated on the Product Definition record.

Step 2: Verify compilation was successful

Run the following SOQL query to check that attachments (compiled artifacts) exist for your Product Definitions:

SELECT Id, Name,
  (SELECT Name, CreatedDate FROM Attachments ORDER BY CreatedDate DESC)
FROM cscfga__Product_Definition__c
WHERE Id = '<PRODUCT_DEFINITION_ID>'

If attachments with recent timestamps appear, the compilation was successful.

Step 3: (Optional) Bulk compile using Apex API

For bulk compilation of multiple Product Definitions, use the Apex API instead of clicking the button for each one individually:

// Example: Compile a list of Product Definitions
List<Id> pdIds = new List<Id>{ '<PD_ID_1>', '<PD_ID_2>' };
// Use the appropriate cscfga bulk compilation API

Refer to the Configurator User Guide on the CloudSense Support Portal for the full API reference:
Support Portal → Article 333 → Telco End-User Documentation Directory

Step 4: (Optional) Remove the old "Compile Model" button

To avoid confusion, remove the deprecated "Compile Model" button from the Product Definition page layout:

1. Go to Setup → Object Manager → Product Definition → Page Layouts
2. Edit the relevant page layout
3. Remove the "Compile Model" button from the layout
4. Save the layout

Step 5: Handle "Compile Online Rules & Custom UI" (if present)

Some orgs may also have a custom link called "Compile Online Rules & Custom UI". This is a separate custom link — check with your development team whether it is still required. If the org previously used both standard and custom compilation, confirm with your team which compilation path is current.

How Compilation Works

The "Compile Online Rules & UI" button serializes the Product Definition's rules, attributes, and UI configuration into JavaScript artifacts stored as Attachment records on the cscfga__Product_Definition__c record. These compiled attachments are consumed by the Configurator Service at runtime for rule execution.

The old "Compile Model" button pointed to a deprecated Visualforce page (CaptureProductModel) from the Product Designer package, which has been deprecated since version 1.10. The Product Lifecycle Manager tracks whether definitions are up to date with their compiled artifacts.

For batch compilation of multiple Product Definitions, use the cscfga package's bulk compilation Apex APIs (refer to the Configurator User Guide on the CloudSense Support Portal, Article 333).

Additional Notes

• The Configurator User Guide (available on the CloudSense Support Portal) provides detailed documentation on Product Definition compilation methods, including Apex APIs for batch processing.
• After upgrading, it is recommended to recompile all Product Definitions to ensure they are compatible with the new package version.
• If the "Compile Online Rules & UI" button is not visible on the Product Definition page, check the page layout to ensure the button was added during the upgrade. If missing, add it manually through page layout configuration.