ValidateUpdateSetDependencies
Summarize
Summary of ValidateUpdateSetDependencies
The ValidateUpdateSetDependencies validator in ServiceNow identifies subflows within a workflow and checks if any are being edited in different, in-progress update sets. This validation helps prevent compatibility issues when deploying workflows and their dependencies across instances. It warns users when workflows and dependent subflows are modified separately, which can cause deployment conflicts or runtime failures.
Show less
Key Features
- Detects subflows edited in different update sets than their parent workflows.
- Issues warnings only for update sets that are currently In Progress or checked out by users working in different update sets.
- Does not monitor closed update sets.
- Provides validation results with clear messages indicating whether dependencies are managed correctly.
- Publishable and runnable within ServiceNow workflows.
Risks and Validation Results
Risk: Independent changes to parent workflows and their subflows in separate update sets can lead to incompatibilities when moved to different instances.
Severity Level: Warning
Valid Result: No update set dependency issues found.
Invalid Result: Workflow has dependent workflows in a different update set, signaling potential deployment issues.
Suggested Actions
To avoid deployment and runtime problems, modify and deploy parent workflows and dependent subflows within the same update set. If separate update sets are necessary, ensure all related update sets migrate concurrently or merge dependencies into one update set before completing migration.
Troubleshooting and Example Scenario
Warnings occur when a published subflow resides in a different in-progress update set than its parent workflow, or when subflows are checked out by users working in separate update sets. For example, if User A modifies a subflow in one update set and User B includes that subflow in a parent workflow in another update set, deploying only one update set to a new instance can cause workflow failures or unexpected behavior.
Practical Solutions
- Solution 1: Migrate the parent workflow and all dependent subflows together in the same update set. Check out and republish workflows to force entries into the update set, then complete and migrate the update set following standard procedures.
- Solution 2: Move dependent workflows into the same update set as the parent workflow by editing the update set assignment in the Customer Updates related list, ensuring all dependencies are grouped for consistent migration.
The ValidateUpdateSetDependencies validator identifies all the subflows called in the current workflow and determines if any of those subflows are being edited in a different (in progress) update set.
This warning informs the user that this workflow and one or more of its dependencies are being actively modified in a way that will not deploy concurrently to another instance without additional effort.
For information about update sets, see Create and select an update set.
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 to 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 completing that update set.
- 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, 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.
Solution 2
Move dependent workflows between update sets.
- Identify the update set containing the main workflow to be migrated.
- Navigate to System Update Sets > Local Update Sets.
- 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 and 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.