Summary: The Dry run is the most critical safety feature in Speakap User Sync. It simulates the results of your data mappings and structural changes before they take effect, so your network stays accurate and secure.
1. When to use a Dry run
There are two levels of Dry runs you must perform to successfully update your network:
- Within mapping settings: when you modify a Group mapping or Role mapping, the system performs a Dry run within that specific settings window before it allows you to save your changes.
- On the main User Sync dashboard: to make your changes effective in Speakap, you must perform a final Dry run from the main User Sync page. This is the only way to make all your changes effective and push them to the live Speakap environment.
2. Understanding Dry run results
After clicking Perform dry run, the system analyzes your HR data against your current rules and presents a summary.
- Summary tab: a high-level overview of the sync health. If the simulation succeeds but detects data issues, you will see a "Dry run finished with warnings!" message. You can download the warnings as a CSV file for further analysis.
- Requests to network: this tab shows exactly how many mutations (creates, updates, or deletes) will be sent to Speakap. If there have been no changes to your HR file or rules, it displays "There have been no changes."
- Updates compared to current sync: highlights the specific differences between the current data in Speakap and the latest imported HR data.
3. Identifying data errors and warnings
The Dry run is your best tool for catching inconsistent data before it affects your users. Common flags include:
- Inactive users: users marked as false based on your Active rule in Column mapping (for example internal.status == "Active").
- Invalid or missing email: accounts that cannot be invited because the email field is empty or formatted incorrectly.
- Missing names: users who cannot be created because their family or given names are missing.
- Structural gaps: users who do not fit into any Business Unit or Group based on your current mapping expressions. These show up as "Missing BU". Review these carefully to make sure all your users get access to Speakap. If your settings do not allow users without a Business Unit, these users will not get an account, and existing users can even lose access and be suspended.
4. Granular data inspection
For every warning or change, you can click the Payload. This shows the raw data that would be applied to the network.
- Groups tab: lists all groups and how many users are assigned to each. Expand a group to see the specific members (XID, Name, Department) included.
- Users tab: a full list of synced individuals. Expanding a user profile shows their assigned Groups, Emails, Addresses, and the specific Rules that placed them there.
5. Applying changes
The system only lets you push changes if the Dry run detects a difference between the HR source and the current Speakap state. This design prevents unintentional data mutations and asks you to verify and confirm the synchronization.
- Button visibility: if no changes are detected, the Apply button does not appear. If changes are detected, a red Apply [X] changes button appears.
- Verification step: click the Apply button. To prevent accidental clicks, a confirmation window appears.
- Numerical confirmation: you must manually insert the numerical value of the changes being made (for example, if there is 1 change, type "1") into the input field.
- Final execution: click Apply changes again to finalize the process and update the live network.
Still stuck?
Email us at technicalimplementations@speakap.nl with your network name and the warnings CSV from your Dry run, and we'll help you out.