Health Check Error: Invalid SugarBPM Field Use

    Overview

    The Health Check wizard must be run when upgrading in order to evaluate whether your instance is suitable for upgrade. The Health Check wizard detects a variety of issues that may affect your ability to upgrade. This article will cover how to resolve an “Invalid SugarBPM Field Use” error reported by the health check.

    Note: This error was titled “Invalid Advanced Workflow Field Use” prior to Sugar 9.x.

    Symptoms

    This error generates an output similar to the following in health check:

    HC-sugarbpm invalid field use

    Resolution

    As the SugarBPM functionality evolves, certain fields and field types that were available in earlier versions may be prohibited in later versions for data integrity purposes. Please refer to the SugarBPM Blacklist section below for a list of the blacklisted items in SugarBPM modules and the Sugar version in which they were removed.

    The error indicates that the health check has discovered blacklisted fields in a Process Business Rule or Action for a Process Definition in your instance. This issue will need to be fixed before proceeding with the upgrade.

    Click the Export Log link below the health check results to view the log file detailing the records and elements causing the error. If you are prompted to download the log instead, please save the file to your local machine then view the errors. We will use the following log line as an example:

    [2016-02-09T15:28:09-08:00] INFO -----
    Accounts->date_modified field is not a valid business rule conclusions field.
    Business Rule Name: Users and such
    ID: 4381f1b4-9a47-4ef8-abf6-56a6d0bcb45f
    -----

    This example reveals that the invalid reference was found in a conclusion element of a process business rule record. The conclusion modifies the date_modified field, which has been blacklisted for use in conclusions as of 7.6.2.0. The listed ID (4381f1b4-9a47-4ef8-abf6-56a6d0bcb45f) then identifies the specific record within the module (e.g. Process Business Rule conclusions) where the issue exists. To address this error, navigate to the SugarBPM record which references the blacklisted field and either remove the record or remove the invalid field reference (e.g. remove the conclusion that affects the date_modified field).

    Once the necessary changes have been made, please navigate to Admin > Repair and perform a “Quick Repair and Rebuild” to ensure that the changes are synced between the application and database.

    Perform the health check again to confirm that the error is no longer reported.

    SugarBPM Blacklist

    The following table lists the blacklisted items in SugarBPM modules and the Sugar version in which they were removed:

    Module Element Type Blacklisted Items Sugar Version
    All SugarBPM modules Fields contact
    deleted
    favorite_link
    following_link
    system_id
    mkto_sync
    mkto_id
    mkto_lead_score
    parent_type
    user_name
    user_hash
    user_sync
    7.6.0+
    is_admin
    password
    portal_active
    portal_app
    portal_name
    7.6.2+
    Field Types image
    password
    7.6.0+
    file 7.6.2+
    Process Business Rules: Conclusions Fields created_by
    date_entered
    date_modified
    duration_hours
    duration_minutes
    modified_user_id
    repeat_type
    7.6.2+
    Process Definitions: Change Field Actions Fields created_by
    date_entered
    date_modified
    modified_user_id
    7.6.2+
    in Troubleshooting Health Check Output

    Reach out to us for help