Validate products and editions in Advanced Product Designer

Advanced Product Designer validates products and editions when a product is saved, helping prevent promotion errors and schema issues. Validation includes product schema and content checks, edition schema checks, and edition relationship checks.

When you save a product, APD validates the product and its editions. The following topics list several of the validations performed, but there are many others.

Validate products in Advanced Product Designer

Advanced Product Designer product validation catches schema, content, and deployment-breaking changes before promotion. Product validation covers schema requirements, content checks, and change or removal checks against recently deployed packages.

When you save a product, APD validates the schema, changes and removals, and content.

Validate the product schema

When validating the product schema, APD checks to see if:
  • uuid exists (If not, it is generated.)
  • code exists and is different from the line code
  • name exists for all languages
  • abbreviation exists and is all uppercase

Validate product changes and removals

APD makes sure that certain content has not been removed or changed relative to a package that is in production or will be in production shortly. Such removals and changes include:
  • Removal of coverages, attributes, and so on
  • Change of code (for all elements)
  • Change of sequence (for all arrayed elements)
Changes and removals such as these may cause conflicts or errors when a package is promoted.
To perform this validation, APD compares the deployment of the package under development to the most recently deployed package on a non-development planet. For example, assume the following deployments are available:
  • DEV [Package 10] (Working package/planet)
  • DEV [Package 9]
  • UAT [Package 9]
  • PROD [Package 8]
In this case, APD compares DEV [Package 10] to UAT [Package 9] because UAT [Package 9] will be in production shortly. If any changes or removals have been made to DEV [Package 10] relative to UAT [Package 9], errors will occur when DEV [Package 10] is promoted to UAT and PROD.

Validate product content

When validating product content, APD makes sure that:
  • costDefinitions have no duplicate codes
  • currencyConfig availability is defined
  • currencyConfig has no duplicates
  • tags have no duplicates
  • blanketDefinitions have no duplicates
  • blanketDefinitions have no duplicate clause codes or subclauses
  • line prefix is all uppercase

Validate editions in Advanced Product Designer

Advanced Product Designer edition validation checks edition schema and product or common ruleset links when products are saved. Edition validation prevents invalid edition structures from causing save errors and broken product relationships.

When you save a product, APD validates its editions' schema and relation.

Validate the edition schema

When validating the edition schema, APD checks to see if:
  • schemaVersion exists
  • name exists
  • code exists
  • product (ProductEdition) exists

Validate the edition relation

When validating the edition relation, APD checks to see if:
  • product defined within the edition exists
  • commonRuleset defined within the edition exists