Here are some best practices that you could follow to manage your errors.
Contents
- Set notifications
- Set override trace data
- Set auto-resolve
- Set auto-recover rate limit errors
- Set roles and permissions
- Apply tags
- Assign errors
Set notifications
You or anyone on your team can be notified when errors occur in a flow. The Celigo platform enables you to set notifications for integrations, flows, and also when connections go offline. If you are an admin, you can set these notifications for users in your account in the Users tab. As an admin, you can set notifications for yourself in the Notifications tab based on the priority of flows or other criteria.
The email notification provides the environment, integration, and flow where an error occurred. When the error occurs in the Sandbox environment, then it is mentioned in the email subject.
Notifications strategy: Options for notifying other business process owners or departments
Because email subscriptions are limited to integrator.io account email addresses, you may want to consider the following strategies:
- Provide a group alias (group email address) for your account’s email address in integrator.io.
- Add stakeholder accounts with Monitor-level access. This may help alleviate licensing or access concerns because these users will not be able to modify integrations. You can then configure Notification settings for each account.
You can combine these strategies to meet your organization's needs. For example, let's say you want all members of the Fulfillment Center to receive notifications, but you do not want them to be able to modify integrations. You can invite a group email address for the Fulfillment Center to your account and configure this user account in integrator.io with Monitor-level access. You can then configure email subscription settings for that user account.
For instructions to set notifications, see Get error notifications via email (You only) and Configure error notification emails for other users.
Set override trace data
It’s important for you to ensure that the trace data is set. The trace key is unique and enables you to identify error records. You can view the trace key in the Errors page to look up the record in the source and correct the data.
For instructions to set/override trace keys, see Set a custom trace key to uniquely identify a record
Set auto-resolve
Auto-resolve is a setting that is enabled by default at the flow level. It helps to resolve intermittent errors automatically. Also, when a connection is down, it automatically polls the endpoint and detects when the connection comes back online. If you’ve disabled auto-resolve for a specific reason, it’s good practice to enable it again afterward.
Auto-resolve is based on the trace key, so it’s important to have your trace key set.
The following table explains flow scenarios where the Auto-resolve feature automatically takes care of duplicate errors (see also: video walkthrough). Each scenario is independent; the scenarios are not linked to each other.
Flow scenario | Without Auto-resolve | With Auto-resolve | Explanation for Auto-resolve |
---|---|---|---|
An open error exists for a record in a flow step. Now when the flow is run again, a new error occurs for the record with the same trace key. | Both the new and previous errors display in the Open errors tab for the flow step. | Only the new error is shown in the Open errors tab. The previous error is auto-resolved and moved to the Resolved errors tab. |
The latest error represents the most relevant blocker. The previous error is not relevant. |
An open error exists for a record in a flow step. Now when the flow is run again, the record with the same trace key gets processed successfully because of fixes in the source data or flow setup. | The previous error will continue to be seen in the Open errors tab. | No error will be seen in the Open errors tab. The previous error is auto-resolved and moved to the Resolved errors tab. |
Since the record is successfully processed, no further action is required. The previous error is not relevant. |
An open error exists for a record in a flow step. Now, when the flow is run again, the record with the same trace key gets executed as an ignored record. | The previous error will continue to be seen in the Open errors tab. | No errors will be seen in the Open errors tab. The previous error is auto-resolved and moved to the Resolved errors tab. | Since the record is executed as an ignored record, there will be no error. The previous error is not relevant. |
For instructions to enable/disable flows, see Auto-resolve errors.
Set auto-recover rate limit errors
Rate limiting means that an endpoint sets a limit and only receives a specific number of API calls during a given time, say, per second, minute, or the like for efficient processing. Rate limit is also referred to as governance limit by some endpoint applications, such as NetSuite and Salesforce.
When you exceed the limit, then your connection will receive rate limit errors. To automatically try and resolve this issue, enable the Auto-recover rate limit errors connection setting for smoother flow runs without the need for manual intervention. The Celigo platform uses the target concurrency level that you set based on your endpoint’s rate limit policy and automatically retries and resolves these errors, saving considerable time.
For new connections, this setting is enabled by default. For existing connections, you can enable the setting.
For instructions to enable/disable this setting, see Automatically recover rate limit errors.
Set roles and permissions
The Celigo platform allows you to set access and permissions for users in your account. Developing an error management plan helps to ensure that errors are monitored and managed effectively across your organization. You can assign permissions and access for users to monitor and manage errors perhaps based on their expertise with the Celigo platform, endpoint apps, priority of flows, or priority of errors (P1, P2,...), or any other consideration that's important in your scenario.
For instructions to set permissions, Manage account and integration permissions
Apply tags
You can apply tags to errors so that your team can collaboratively resolve errors. You can use tags to label and provide details, for instance, based on priority or status. This could make it easier for your team to decide on how best to allocate time and effort for error resolution. You can create and apply tags based on what works best for your team.
For instructions to apply tags, see Tag errors.
Assign errors
You can assign errors in an integration to existing or new users for quick troubleshooting. When an error is assigned to a team member, a notification is sent to the assignee. The assignee can then plan and investigate the error.
Anyone on the team who has access to the integration can unassign errors even if they haven't assigned them but do so carefully.
For more information, see Assign errors.
Comments
0 comments
Please sign in to leave a comment.