ValidateUpdateSetParentDependencies
Summarize
Summary of ValidateUpdateSetParentDependencies
TheValidateUpdateSetParentDependenciesvalidator in ServiceNow identifies workflows that call the current workflow as a subflow and checks if those parent workflows are being edited in separate update sets that are still in progress. It warns users about potential deployment risks when related workflows are modified independently in different update sets, which could lead to incompatibility issues during migration to another instance.
Show less
Key Features
- Detects if a workflow and its parent workflows are being edited in different active update sets.
- Issues a warning to prevent deployment conflicts and incompatibilities.
- Validates only update sets that are In progress or currently checked out, ignoring closed update sets.
- Provides clear messages indicating whether dependency issues exist.
- Runnable and publishable to integrate into workflow validation processes.
Risks Addressed
If a parent workflow and its subflow are edited separately in different update sets, deploying only one update set can cause:
- Incompatibility due to mismatched workflow versions or data types (e.g., changed return values).
- Runtime validation failures if dependent workflows are missing or outdated on the target instance.
- Unexpected behavior in workflow execution, potentially causing process failures.
Suggested Actions
To avoid deployment and compatibility issues, ServiceNow customers should:
- Modify and deploy dependent workflows together in the same update set.
- If separate update sets must be used, ensure all related update sets are migrated concurrently.
- Alternatively, merge dependent workflows into a single update set before completing migration.
Practical Solutions
Solution 1: Migrate Together
- Set the target update set as current.
- Check out and republish all related workflows to include them in this update set.
- Complete the update set and migrate using standard update set procedures.
Solution 2: Move Dependent Workflows Between Update Sets
- Identify the update set containing the parent workflow.
- Move dependent subflows to this update set via the Customer Updates related list.
- This ensures all dependencies reside in the same update set for consistent migration.
Additional Information
The validator triggers when:
- A published subflow exists in a different in-progress update set than its parent workflow.
- A subflow is checked out by a different user working on a separate update set from the parent workflow.
Warnings appear in workflow logs to help identify and resolve these conflicts before migration.
The ValidateUpdateSetParentDependencies validator identifies all the workflows that call the current workflow as a subflow and determines if any of those parent workflows are being edited in a different update set that is in progress.
This warning informs the user that this workflow and one or more workflows that depend on this workflow are being actively modified in a way that will not deploy concurrently to another instance without additional effort.
Validation summary
- Risk: If a parent workflow is edited in one update set and its dependent subflow is edited in another, the two workflows might not be compatible when moved to a different instance. Making independent changes, such as editing common or expected values, can make the two workflows incompatible.
- Severity Level: Warning
- Valid Result: Valid
- Valid Message: There were no Update Set dependency issues found.
- Invalid Result: Invalid
- Invalid Message: This workflow has dependent workflows that are in a different update set.
- Suggested Action: Modify and deploy both workflows in the same update set. If you must modify dependencies in separate update sets, use one of these methods:
- Ensure that all update sets migrate concurrently.
- Prior to deploying the main flow update set, merge the dependencies into one update set before setting that update set to complete.
- Publishable: Yes
- Runnable: Yes
- Related Information: Workflow movement with update sets
Troubleshooting
A workflow is added to an update set only when the workflow is published. This validator issues a warning when either of the following conditions exist:
- A published subflow is in a different update set than the parent workflow and that update set is In progress.
- A subflow is checked out by another user, who is working in a different update set than the current user.
Example
Following is an example of an at-risk development scenario in which two users create dependencies between workflows in different update sets.
User A:
- Sets Update Set A to the current update set.
- Checks out Workflow A.
- Changes the return value of the String type in Workflow A to a Reference/User type.
- Publishes Workflow A, causing an entry into Update Set A.
User B:
- Sets Update Set B to the current update set.
- Checks out Workflow B.
- Includes Workflow A as a subflow.
- Uses the user reference return value from Workflow A as an approval assignment.
- Publishes Workflow B, causing an entry into Update Set B.
Risks
- User B moves Update Set B to a different instance that has an older version of Workflow A. The return value is not a user reference, which causes the outcome of Workflow B to be different than it was when tested in development.
- User B moves Update Set B to a new instance that does not have a version of Workflow A. Workflow B experiences a validation failure at runtime and cannot execute. A log entry is added to the workflow log of the current record.
Possible solutions
Solution 1
Migrate the parent workflow and all dependent workflows to a new instance together using the same update set.
- Set the update set to the one you want to migrate to new instances.
- Check out and republish the workflows that need to be included. Note:This action forces an entry into the current update set.
- Complete the update set with all dependencies.
- Follow standard procedures for migrating update sets to local instances. For information about update sets, see System update sets.
Solution 2
Move dependent workflows between update sets.
- Identify the update set containing the main workflow to be migrated.
- Navigate to .
- Find and select the update set that contains the dependencies to the main workflow.
- In the Customer Updates related list, select the workflow version of the subflow you want to move.
- Select the update set containing the parent workflow in the Update set field. If this field is not on the Customer Update form, configure the form and add the field.
- Click Update. The base system moves the dependent subflow to the update set selected.
- Repeat steps 4-6 to add additional dependent subflows to the parent flow update set.