Skip to main content

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

How to use the DCO Compatibility tool

Suggest edit Updated on June 10, 2020

The DCO Compatibility tool allows you to automatically verify that your built-on application will work seamlessly with DCO when you build or extend your application.  The tool scans the application and identifies rules that may cause compatibility issues when used with DCO tools.

This article describes:

  • How to access the tool
  • The error and warning conditions
  • How to mitigate those conditions

Accessing and running the tool

To access the tool, go to Designer Studio >  Application >  Tools >Check DCO Compatibility. When you click the menu item, the tool verifies the current application.

If there are no issues, the following  pop-up dialog appears:

compatrun1.png

You can also verify a built-on application by selecting it from the drop-down list and clicking Run.

Errors and Warnings

If there compatibility issues, the dialog displays error and warning messages as shown in this example:

compatrun2.png

 The dialog contains four columns:

  • Condition icons: Error pzerror_icon.png or Warning pzwarningicon_errorsection.png icons that indicate the condition.
    • An Error means that a rule is invalid (cannot be saved) or that it does not operate properly. You must correct error conditions in order to prevent DCO failures.
    • A  Warning means that there is a variance from design guardrails or best practices. Where possible, revise the rule or other rules to remove the variance, which can improve performance, maintainability, user productivity, or usability.
  • Rule Name: A link to the rule containing the error. Click the link to open the form.
  • Type: The Rule-based class to which the rule belongs.
  • Error/Warning: Text that describes the reason and a short explanation of how to correct the issue.

The following table describes the errors and warnings.

You cannot re-use or extend this case type in a new application built with DCO tools.

class> does not have a case type rule defined" warning.

Condition

 Message

Reason

How to fix

If not fixed

Error

 <application:version> fails validation on save.

This application contains one or more error conditions that prevent it from being saved.Open the form and click Save. Correct the issues that appear on the rule form.You cannot build on top of this application or extend it using DCO tools.
Error

<class> fails validation  on save.

This class contains one or more error conditions that prevent it from being saved.Open the form and click Save. Correct the issues that appear on the form.You cannot use this class and processes within this class in a new application built with DCO tools.
Error <flow> fails validation on save.This flow contains one or more error conditions that prevent it from being saved.Open the form and click Save. Correct the issues that appear on the form.You cannot re-use or extend this flow in a new application built with DCO tools
Error

<section>  fails validation on save.

This section contains one or more error conditions that prevent it from being saved.Open the form and click Save. Correct the issues that appear on the form.You cannot re-use or extend this section in a new application built with DCO tools
Error

<property>  fails validation on save.

This property contains one or more error conditions that prevent it from being saved.Open the form and click Save. Correct the issues that appear on the form.You cannot re-use or extend this property in a new application built with DCO tools.
Error

 <rule> belongs to a class that restricts rules that may use it as an Applies To class, and the rule is set as an extension.

This rule meets both of these conditions:

  • Has an availability status of Extension.
  • Belongs to a class which has RuleSet restrictions enabled. This means that are restrictions on which rules can use this class as an Applies To class

 Do either of the following:

  • Open the form and click the Extension label on the form header to open the edit dialog.  

    extension1.png Change the Extension setting in the Status field (in most situations, set it to blank). Click OK to close the dialog and save the rule.
  • Open the Class form to which this rule belongs and click the Advanced tab. Remove the relevant RuleSet from the RuleSets array.
You cannot re-use or extend this rule in a new application using DCO tools.
Error

This application has <class> added as a duplicate work type.

A work class should be listed only once on the Work Types array on the Application rule form.

Open the form and open the Details tab. On the Work Types array, delete the duplicate row and save the rule.

Application Express will produce an error.

Error

 This application has <class> added as a work type but its corresponding class is an abstract class.

Only concrete work classes should be listed on the Work Types array on the Application rule form.

Open the form and open the Details tab. On the Work Types array, delete the row containing the abstract class and save the rule.

Application Express  will produce an error.

Error

 <rule> is marked as an extension as well as a final rule.

This rule should not have both  settings.

Open the form and click the Final or Extension label on the form header to open the dialog. Change the Availability orStatus settings. Click OK and save the rule.

Application Express  will produce an error.

ErrorApplication Name cannot contain special characters.Please make a copy of  <application>The application name Key Part must start  with a letter and use only letters, digits, ampersands, underscores, and dash characters.

Copy the rule (Save As) and use a valid name.


 Remember to update access groups, specifications, and requirements associated with this application.

You cannot link specifications and requirements to rules in this application.
Error<Applies-to class> 's case type failed validation on save. Please fix the validation errors.The case type record has errors that prevent it from being saved.Open the case type's form and click Save. Correct the issues that appear.You cannot re-use or extend this case type in a new application built with DCO tools. 
Warning

<class> does not have a case type rule defined.

 

This work class does not have a case type rule. As a result, the class does not appear as a case type in the Case Explorer, and cannot employ case management processing.

In addition, the system will likely generate the  "<class> does not inherit from Work-Cover-"  warning.

 Do the following:

  • Verify that the class inherits from Work-Cover-. If not, modify the Class rule form. See the warning "<class> does not inherit from Work-Cover-" described below.
  • Create a new case type rule. Select the class on the Application Explorer, right click, and select the New > Process > Case Type menu item, and create the rule.  Open the Case Explorer, select the case type, and configure the settings in the Case Designer landing page.

You cannot take advantage of   Case Management functions and features, which increase efficiency, consistency, and visibility of case processes.

Warning<application> includes PegaRULES application as its parent. Please ensure this is the desired behavior.This configuration will cause Application Express to add to the current application all the standard rules from the PegaRULES application RuleSets.Open the application form, clear the Include Parent checkbox on the General tab and save the record.

Records in the PegaRULES application RuleSets (which include reports, correspondence, specifications, extensions, and so on) will appear in your developer tools and application documentation.

Warning <class> does not inherit from Work-Cover- This class does not appear in the Case Explorer.

  

Do both of the following:

  • Open the class form from the Application Explorer. On the General tab, specify Work-Cover- in the Class Inheritance field. Save the rule.
  • On the Application Explorer, verify that the class has a case type rule. If not, create one. See the warning "<class> does not have a case type rule defined" described above.
 You cannot take advantage of   Case Management functions and features, which increase efficiency, consistency, and visibility of case processes.
Warning <flow> is a Visio flow.This flow's process diagram is configured in Visio, which is deprecated in V7.1.

Convert your process diagram to Process Modeler. Open the flow. On the Diagram tab, click the modelerwithtext.png button and save the rule.

Note: You cannot revert to Visio after you save the flow.

This flow appears in view-only mode; it cannot be edited or use Case Management features.

 Warning <property> is marked as an extension.This property should not have a  Status setting of Extension. Open the form Open the form and click the Extension label on the form header to open the edit dialog.   Change the Extension setting in the Status field (in most situations, set it to blank). Click OK to close the dialog and save the rule.System performance will be impaired due to the presence of duplicate property definitions.
Warning<class>  definition has a blank labelThe Description field on the Class rule form should contain a value.Open the rule, enter a value in the Description field, and save.This description is displayed when Framework is presented to users.
WarningThe resusable part <class>  of this implementation class name is longer than 28 characters.This class name should contain fewer than 28 characters if you intend to extend the class using  the Application Express tool.

Technical users only

Use the Rename a Class wizard to refactor the class structure (go to Designer Studio >  System  > Tools > Refactor Rules > Rename a Class ).

Application Express cannot create applications using class names that exceed  28 characters.

The system incorporates this value into the names of the class group and data class when the application is generated.

WarningVersion <application version>  is not in the format ##.##.## nor ##.##The application version Key Part  should include major and minor version numbers (optionally, a patch number). Each must be two digits and separated by a period (.)

Create a copy (Save As) of this application and use a valid version number.


Remember to update access groups, specifications, and requirements associated with this application

Incorrect application version formats cause sorting issues when using Application Express.
Warning

This application is missing a work prefix for the case type <applies-to class>. Please add a prefix for this case type on the Cases and Data tab of the application rule.

The system the uses the default prefixes ( "C-"  for Work-Cover-  or "W-"  for Work-).On the Application form's Cases and Data tab, Enter a unique value in the Work ID Prefix field for each case type. 

The case ID's that appears on user forms and reports use a default prefix. If there are multiple case types using  default values, it is difficult to identify the case type to which a case belongs.

This is not a best practice and usually not the desired behavior.

Warning

This application has work class names that are too long by <n characters>.  Please consider refactoring them.

Work class names cannot be longer than 56 characters.

Technical users only

Use the Rename a Class wizard to refactor the class structure (go to Designer Studio >  System  > Tools > Refactor Rules > Rename a Class ).

You will not be able to extend this application with Application Express. The number of characters you use depends upon the names in the class structure (organization, division, unit, application name, and so on)
Warning

The class group has no keys defined. This will prevent case creation for: <case type>

The Key Definition List on on the Class Group form's Key tab  has no values.Enter at least one key value. In almost all cases, use the same key on the Class form's

General tab.

 

The system produces an error when you:

  • Launch a starting flow in this class group.
  • Attempt to save the class record or any other class that derives from this class.
Did you find this content helpful? YesNo

100% found this useful

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us