Tags are labels that you can provide for errors in any step of a flow. (For open errors, tags are available only in the unified error view.) You can create and apply tags to categorize and prioritize errors. Use tags for status or any other info that helps to effectively communicate and collaborate with your team for error resolution. Before you start using tags, consider and plan how best you can create and apply tags using the tag button.
You can see the tag button at the top of the error list and within any row in the message and details making it easy to tag several errors or a single error. The tag shows beside a message when you move your cursor in a row.
Tag errors
Tagging actions
All tagging actions are done from the Errors list (Open and Resolved errors tabs) in a flow step. Some of these actions are applicable at the account level, and others only at the flow step level.
- When you create, rename, or delete a tag in the list from a flow step, it not only applies to errors in the flow step but also to all errors in the account. (Global actions – account level)
- When you apply or remove (clear) a tag from an error in a flow step, it only applies to the error in that flow step. (Local actions - flow step level)
You can create a tag and apply it to an error in one go, or you can create all the tags first and then apply them to errors later.
Tagging guidelines
When you're creating tags, keep in mind,
- The maximum limit of tags that you can create in an account is 1000.
- The maximum number of tags that you can apply to an error is 3.
- The maximum character limit for a tag is 100.
- Tag names are case insensitive to avoid duplicating tags. If you've got a tag "URGENT," then you cannot create another tag named "urgent" or "urGEnt" or the like.
- A user with any access, such as admin, monitor, manage, or custom can create, rename, delete, apply, or remove tags. Any user in the account can rename, and delete a tag, even if they haven't created the tag.
- A user can also create, delete, and manage tags in the Sandbox environment.
Tagging approach & tag list
When you or any user creates a tag in a flow step, it is added to a list that is available and can be seen by all users in the account. A tag in the list can be applied to any error in the account. You can choose to tag errors in an ad hoc or planned manner.
- Ad hoc tagging: If you've few integrations/errors and a small team, you can create tags whenever you want to provide more details to an error without investing too much time in planning. You can create tags as you view errors to collaboratively resolve them. For example: "Action required: Jira <ID>" or "On hold: under discussion." You can create, rename, or delete tags that are not relevant or usable and might not have to worry too much about whether they're used in other errors in the account.
-
Planned tagging: If you've got many integrations/errors and a large team, your admin or any assigned user could be the primary person responsible for creating and managing tags. If you'd like to use tags consistently and correctly across integrations, you could discuss details within your team and document them. For example, you could create tags based on:
- Error status in a workflow, such as New/To do; In progress/To be done; Resolved/Done; Done (resolution documented).
- Error priority for resolution, such as P1, P2, P3, P4.
Use tagging in any manner that works best for you. Create a list of tags based on your approach to resolving errors, integrations, and team size.
Create and apply tags to an error
if you choose a flexible ad hoc approach to tagging, you can both create and apply tags in one go to an error. Build your tag list as you or any user creates tags. See also, tagging guidelines.
Note: When you create a tag and apply it in one go to an error, the new tag created is available for all errors in the account, but it is applied only to the selected error or errors in the flow step.
- Click the tag button next to an error.
- Enter the name of your tag, for example, "To be done."
- Click the Create new tag link shown above. The tag gets added to the list with the box next to it selected by default. Repeat steps 2 & 3 to create more than one tag.
- Click Apply. The tag is added to the error.
Tip: You can also tag multiple errors as a batch.
Note: You can replace existing tags but this can be done only if you select two or more errors that have different tags, then select new tags and apply them.
Create tags, and apply them later to an error
If you choose a planned approach to tagging, you can do tagging in two steps. First, create the tags and build a list; then later, you or any user can select and apply a tag to an error. See also, tagging guidelines.
First, create a list of tags.
- Follow steps 1-3 in the procedure above. Note that when any tag is added to the list, it is auto-saved.
- After you've added the tags, click outside the Tag errors box to exit tagging. Now the tags are added to the list, but they're not applied to any error.
Later, select and apply the tags to errors as required.
- Click the tag button next to an error.
- From the list, select any tags you want to apply.
- Click Apply. The tags are added to the error as shown. You can apply a maximum of only three tags to an error.
Tip: You can also tag multiple errors as a batch.
Automatic application of tags – scenarios
Tags are automatically applied in some scenarios,
- When errors have the same retry data (Table 1). The retry data key is a unique ID that's associated with an error's retry data. For instance, see it in the GET errors response for a flow step. You can use the retry data key to retry the data.
- When errors have the same trace key and no retry data key (Table 2)
Note: The scenarios in the tables below work the same whether you're applying or removing/clearing tags.
The below table (Table 1) indicates when tags are automatically applied for errors with the same retry data key.
Scenarios | How it works… |
---|---|
Open errors |
|
Resolved errors |
|
The below table (Table 2) indicates when tags are automatically applied for errors with the same trace key and no retry data key.
Scenarios | How it works… |
---|---|
Open errors |
|
Resolved errors |
|
Rename tags
You can rename a tag from any flow step. When you rename a tag, the new name is shown in the tag list and in other errors in which it was applied in the account. That is, the change is made globally within the account.
- Click any tag in the list.
- In the edit box, make changes.
- Click outside the Tag errors box after you've made the changes. Now, the new name is shown in all errors in which was applied.
Delete tags
You can delete a tag from any flow step. When you delete a tag, it is deleted from the tag list and from other errors in which it was applied in the account. That is, the deletion is made globally within the account.
You can delete only one tag at a time.
- Click the delete button near a tag in the tag list.
- After reading the confirmation message, click Delete. Now, the tag is deleted from that error and all errors in which it was applied in the account.
Remove tags
After you apply a tag to an error, you can clear or remove the tag from the error in a flow step at any time. The removal of the tag from an error only applies to that flow step. See also, Tagging scenarios.
Note: You can use Clear tags if you want to remove all tags from an error in one go.
- Select an error.
- Click the tag button.
- From the list, clear the checkbox next to the tag, for example, "P1: Urgent."
- Click Apply. The tag is removed from the error.
Apply or remove/clear tags from multiple errors as a batch
You can select multiple errors and apply or remove/clear tags from them as a batch. If required, you can sort or filter errors to quickly view and select multiple errors.
- Select the box next to the errors that you want to tag.
- Click the tag button at the top of the list.
- Select any existing tags, for instance, "Testing." (Or, you can create a new tag by entering the name and clicking the Create new tag link. Repeat the steps if you want to create more than one tag.) Note that this step is to apply a tag; however, if you want to remove or clear a tag, you can clear the box next to a tag.
- Click Apply.
Filter tags
Filtering is done based on the OR-based search, that is, if you select "To be done" and "On Hold" checkboxes, the filter result will show errors with:
- only "To be done" tag
- only "On Hold" tag
- both "To be done" and "On Hold" tags
You can use a filter to view errors and get a quick big picture based on the tags you've selected as filter criteria. For instance, you can select "P1: Urgent" to view any urgent errors that still require resolution.
- Click the filter button.
- From the list, select the checkbox next to the tag for filtering.
- Click Apply. You can see errors with the tag "P1: Urgent."
To clear the filter, click the filter button again and click Clear filter.
Comments
Please sign in to leave a comment.