Managing custom issue statuses Follow
Issue statuses track the state of an issue throughout a project. All projects include the standard statuses Open, In progress, Solved, and Closed, however, you can also create custom statuses that are specific to your project's needs.
Creating and managing custom statuses involves three tools:
- Workflows, which are groups of statuses.
- Statuses, which are the statuses applied to an issue.
- Issue types, which tie a workflow to a specific issue.
These tools are in Revizto Workspace under the Issue Workflows tab in your project. The Issue Workflows tab is only available in Revizto+ licenses for project administrators; it will be hidden for all other users. Additionally, editing workflows is only available in cloud and shared location projects; local projects do not have the ability to add or edit custom statuses until published to the cloud.
Project administrators can manage workflows, issue types, and statuses in Revizto Workspace. To access them:
- Sign in to ws.revizto.com.
- If you are a member of several licenses, ensure that the correct license is selected.
- Go to Tools, then select My Projects.
- Open the project and then, on the top toolbar, select Issue Workflows .
This will open a page with two tabs: Workflows, where you can manage workflows and statuses, and Issue types, where you can manage issue types.
In this article:
- Getting started
- Managing workflows
- Managing issue types
- Managing statuses
- Custom statuses in the issue tracker
- Backwards compatibility
Getting started
Creating a set of custom statuses for the first time requires creating a workflow, issue type, and statuses; processes that are described throughout this article. These processes lead into one another as, once the workflow has been created, you will be able to create statuses and issue types from within the workflow itself.
Below is an outline of which sections to follow to create a set of custom statuses:
- First, create the workflow.
- Next, create an issue type. Creating an issue type from the Edit workflow page will automatically assign it to that workflow.
- Finally, create the statuses.
Note: The new workflow will automatically include the standard statuses (Open, In progress, Solved, and Closed). You can delete these statuses following the steps under Deleting statuses from workflows.
This will set up a brand new set of custom statuses for use in your project. For a rundown of how these statuses can be used on issues, refer to Custom statuses in the issue tracker.
Managing workflows
A workflow is a group of statuses that can be assigned to issues in the project. Once a workflow is assigned to an issue through an issue type, as described in Managing issue types, the statuses in the workflow can be applied to the issue.
All projects automatically include the Standard workflow which contains the standard statuses (Open, In progress, Solved, and Closed) and cannot be deleted. To meet your project's individual needs, you can build your own custom workflows where you can create and organize custom statuses.
You can access, create, and manage workflows from the Issue Workflows > Workflows tab in Revizto Workspace as detailed in the following sections:
Creating workflows
The first step in setting up custom statuses is creating a workflow. Workflows can be created from scratch as described below, or they can be duplicated as described under Duplicating workflows.
To create a workflow:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Workflows tab, click New workflow.
- Enter the workflow name and a description.
- Click Create.
After the new workflow has been created, you will be taken to the Edit workflow page for the new workflow. On this page you can edit the name and description of the workflow, set automatic statuses for issues that are resolved or reopened through clash automation, and add issue types to the workflow as described under Managing issue types. This is also where you can add statuses to your workflow as described under Managing statuses.
Note: All newly created workflows automatically include the standard statuses (Open, In progress, Solved, and Closed). These can be kept or they can be deleted from the workflow following the steps under Deleting statuses from the workflow.
Duplicating workflows
Any workflow in a project can be duplicated to create a new version with the same description and statuses.
Note: You can only duplicate a workflow within the same project. To import or export issue workflows from or to a different project, use the Project > Import Settings/Export Settings feature in the Revizto application.
To duplicate a workflow:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Find the workflow you want to copy and then, in the Actions column, click Duplicate .
A new workflow will be created directly under the original workflow with "(Copy)" at the end of its name. The new workflow will have the same description and statuses as the original, however it will not have any issue types assigned to it. You can create a new issue type for the workflow or assign one as described under Managing issue types. Once a workflow has been duplicated, you can fully edit the new workflow and its statuses as described in Editing workflows and Managing statuses.
Editing workflows
You can edit the name, description, and settings for clash issue statuses of any workflow other than the Standard workflow. Since the Standard workflow is the basic set of required statuses, it cannot be edited or changed.
To edit a workflow's name, description, or clash settings:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Workflows tab, find the workflow that you want to edit.
- In the Actions column, click Edit . This will open the Edit workflow page.
- Click Edit next to the field that you want to edit.
- Make the relevant changes and click the Save button above the field.
- Once all edits are complete, you can exit the Edit workflow window by clicking Back.
Workflows can also be edited by adding or removing issue types and statuses as described under Managing issue types and Managing statuses. Additionally, statuses in the workflow can be reordered by dragging.
Deleting workflows
Any workflow other than the Standard workflow can be deleted from a project. Since the Standard workflow is the basic set of required statuses, it cannot be deleted.
Note: You can hide the Standard workflow from the issue tracker by reassigning or deleting all issue types from the workflow as described under Managing issue types.
When deleting a workflow, you will be prompted to select a replacement workflow. You might also be prompted to select replacement statuses for any statuses that do not appear in both the deleted and replacement workflows. This ensures that any issues using a status from the deleted workflow will be given a new, relevant status instead of being left empty or with an obsolete status.
To delete a workflow:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Workflows tab, find the workflow that you want to delete.
- In the Actions column, click Delete .
- If one or more issue types are associated with the workflow, you will be prompted to assign those issue types to a new workflow. Select the replacement workflow from the list.
- Click Next.
- If the issue types' new workflow has different statuses from the previously assigned workflow, you will be prompted to select replacement statuses for statuses that do not appear in both workflows. Select a replacement status for each listed status.
- Click Next.
- Click Confirm deletion.
Managing issue types
An issue type ties a workflow to an issue in the issue tracker, allowing the workflow's statuses to be used on that issue. An issue's assigned issue type will be shown on the issue, allowing you to see the name and description of that issue type (the workflow name and description will not be visible). It's important, therefore, to create clear and detailed issue types. Additionally, an individual issue type can only be assigned to one workflow, allowing each type to represent a specific use case for those statuses. A workflow, however, can have multiple issue types assigned to it so you can utilize a set of statuses across multiple use cases.
All projects automatically include the Standard issue type, which is assigned to the Standard workflow and set as the default issue type when a new project is created. You cannot edit or reassign the Standard issue type, however, you can delete it, which removes it from the Standard workflow. The default issue type is the type automatically assigned to an issue in the issue tracker if a type is not assigned manually. Any issue type can be set as the default instead of the Standard issue type, though this will not remove the Standard issue type from any issues it's assigned to.
Issue types can be viewed in the workflow they are assigned to or in the Issue types tab. In the Issue types tab you can filter issue types by Active, Deleted, and All to see any issue types that are or have been used in the project.
You can access, create, and manage issue types from the Issue Workflows > Issue types tab in Revizto Workspace as detailed in the following sections:
- Creating issue types
- Assigning issue types to workflows
- Editing issue types
- Deleting issue types
- Understanding the Navisworks clash issue type
Creating issue types
New issue types can be created two ways: from a workflow or from the Issue workflows > Issue types tab. Either way of creating an issue type will add it to a chosen workflow. Once it's added, the workflow and any statuses it contains will be available for use on issues in the issue tracker.
Note: Issue type names cannot be edited, so ensure the name is correct when creating it. Issue type names are unique to a project and case-sensitive.
Creating issue types from a workflow
To create an issue type from a workflow:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Workflows tab, find the workflow that you want to add an issue type to.
- In the Actions column, click Edit . This will open the Edit workflow page.
- Click Add type in the bottom-left corner of the Edit workflow page.
- Click New issue type at the bottom of the Add issue types window.
- Select the issue type's icon and color and enter a name and description.
Note: The issue type icon and name will be displayed on issue in the issue tracker, however, there will not be any workflow information there.
- If you want to make this new type the default issue type, select the Set this issue type as default checkbox. This will replace the existing default issue type.
- Click Save.
The new issue type will be added to the workflow once it has been saved.
Creating issue types from the Issue types tab
To create an issue type from the Issue types tab:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Issue types tab, click New issue type.
- Select the issue type's icon and color and enter a name and description.
Note: The issue type icon and name will be displayed on the issue in the issue tracker, however, there will not be any workflow information there.
- Choose a workflow to assign the issue type to.
- If you want to make this new type the default issue type , select the Set this issue type as default checkbox. This will replace the existing default issue type.
- Click Save.
The new issue type will be added to the assigned workflow once it has been saved.
Assigning issue types to workflows
An issue type must always have an assigned workflow, however, it can be reassigned to a new workflow at any time. It's important to note that, while a workflow can have multiple issue types assigned to it, an individual issue type can only be assigned to one workflow. Reassigning an existing issue type, therefore, will remove it from its previously assigned workflow.
The Standard issue type is the only issue type that cannot be reassigned. It is automatically assigned to the Standard workflow and cannot be assigned to any other workflow. The Standard issue type can only be removed from the Standard workflow by deleting it, following the steps under Deleting issue types.
Issue types can also be reassigned to a new workflow by editing the issue type itself, as described under Editing issue types.
To assign an existing issue type to a workflow:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Workflows tab, find the workflow that you want to assign the issue type to.
- In the Actions column, click Edit . This will open the Edit workflow page.
- Click Add type in the bottom-left corner of the Edit workflow page.
- From the list of available issue types, select the checkboxes next to the types that you want to add to the workflow.
- Select Next.
- You might be prompted to select replacement statuses for statuses that were present in the issue type's previously assigned workflow. Select replacement statuses from the new workflow and click Next.
- Click Confirm to save your changes.
Editing issue types
You can edit the icon, description, and assigned workflow for any issue type other than the Standard issue type and Navisworks clash issue type. An issue type's icon, description, and assigned workflow can be edited from the Issue types tab under Issue workflows. Similar to statuses, however, an issue type's name cannot be changed once it has been created. If you need to change the name of an issue type, create a new issue type following the steps under Creating issue types. You can then assign the new type to the relevant workflow and delete the previous issue type following the steps under Deleting issue types.
To edit the icon, description, or workflow of an issue type:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Issue types tab, find the issue type that you want to edit.
- In the Actions column, click Edit .
- Make the relevant edits and click Save. You can edit all fields except Name.
- If you changed the assigned workflow, you might be prompted to choose replacement statuses for statuses that are not in the new workflow. Select a replacement status for each listed status.
- Click Next.
- If you changed the assigned workflow, click Save to confirm the change. Since an issue type can only be assigned to one workflow, this will replace the issue type's previously assigned workflow with the new workflow.
Deleting issue types
Any issue type can be deleted from a project. Since issue types categorize issues and assign status options, you will need to select a replacement issue type for issues associated with the type that is being deleted. This ensures any issues belonging to the deleted issue type will be given a new issue type and relevant status.
A replacement issue type will not be automatically assigned to a deleted issue type's workflow, potentially leaving the workflow without an assigned type. If a workflow does not have an assigned issue type it will not be available to use on any issues in the project, however, it will also not be deleted or otherwise changed.
To delete an issue type:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Issue types tab, find the issue type that you want to delete.
- In the Actions column, click Delete .
- In the New issue type field, select a replacement issue type for all issues, stamp templates, and clash tests that use the issue type being deleted.
- Click Next.
- If the replacement issue type is associated with a different workflow than the workflow of the issue type being deleted, you will be prompted to replace any statuses that are not in the new workflow. Select a replacement status for each listed status.
- Click Next.
- Click Confirm deletion.
You can view deleted issue types in the Issue types tab by filtering by "Deleted" in the upper-left corner. Deleted issue types can be restored by clicking Restore in the Actions column next to the issue type. Restored issue types will be automatically reassigned to the workflow they were assigned to before being deleted.
Understanding the Navisworks clash issue type
All issues created from Navisworks clashes will be automatically given the issue type Navisworks clash. The Navisworks clash issue type is associated with the Standard workflow so the standard issue statuses (Open, In progress, Solved, and Closed) will be available for use on all issues with that type. This issue type cannot be changed on any issue created from a Navisworks clash, meaning only the standard statuses can be used for those issues. It is also specific to projects with Navisworks clashes and will only be visible on projects with Navisworks clashes.
For more information on Navisworks clashes, refer to Syncing Navisworks clashes with Revizto.
Managing statuses
All statuses—custom and standard—are kept in workflows and can be viewed from the Issue Workflows > Workflows tab in the Statuses column of the workflow they are associated with. Statuses can be added to a workflow by either creating them in the desired workflow or by importing an existing status into another workflow. Imported statuses are the same in all workflows and cannot be edited independently from each other; editing an imported status in one workflow will edit it in all workflows it's a part of. If you need a status that can be independently edited, you will need to create a new status.
You can access, create, and manage statuses from the Issue Workflows > Workflows tab in Revizto Workspace, as detailed in the following sections:
- Creating statuses
- Importing statuses
- Editing statuses
- Changing status names or categories
- Deleting statuses from workflows
Creating statuses
You can create a custom status within a workflow.
To create a status:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Workflows tab, find the workflow that you want to add a status to.
- In the Actions column, click Edit . This will open the Edit workflow page.
- Click Add status at the bottom of the Edit workflow page.
- In the New status field, type the name of the status you want to create.
Note: Status names cannot be edited later, so ensure the name is written correctly. Status names are unique to a project and case-sensitive.
- The status name you type in will appear as an option labeled "New status". Select the status.
- Click Add. This will open the Create status window.
- Enter the status description.
- In the Category field, select a category for the status:
-
- To do. Statuses in this category indicate open issues that have not been acted on yet.
- Tracking. Statuses in this category indicate in-progress issues (for example, they are being worked on or investigated in some way).
- Completed. Statuses in this category indicate issues that do not need any further action (for example, closed or resolved). Issues with a "completed" status will be hidden from the issue tracker by default.
The status category is used for filtering issues in the issue tracker and dashboards so it's important to correctly categorize statuses based on their intended use and meaning. Additionally, the status category determines the access rights a user needs to set the status. For more information on user access rights, see Project access rights.
- Under Select color, choose the background and text colors for the status.
- Click Add to finish adding the status to the workflow.
Statuses can be reordered within a workflow by dragging them. The order of statuses in the workflow is the order that is shown in the issue tracker when changing an issue's status.
Importing statuses
Importing a status brings an existing status in the project into a new workflow. An imported status is the same everywhere it is used and cannot be edited individually within a workflow, though it can be reordered in the workflow as needed.
Note: An imported status can be deleted individually from a workflow without deleting the status entirely following the steps under Deleting statuses from workflows.
Statuses can be imported to a workflow individually through the Add status function, or imported in bulk through the Import from another workflow function.
Importing individual statuses
To import an individual status:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Workflows tab, find the workflow that you want to import the statuses into.
- In the Actions column, click Edit . This will open the Edit workflow page.
- Click Add status at the bottom of the Edit workflow page.
- In the New status field, type the name of the status you want to import.
- From the search results, select the status.
- Click Add.
Importing multiple statuses
To import multiple statuses:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Workflows tab, find the workflow that you want to add the statuses to.
- In the Actions column next to the workflow, click Edit . This will open the Edit workflow page.
- Click Import from another workflow under the list of statuses.
- Select the source workflow for the statuses.
- Select the checkboxes next to the statuses that you want to import.
Note: If you have previously imported a status from that workflow into the current workflow, that status will be listed but will not be available to select.
- Click Add.
Editing statuses
Once a status has been created, its name and category cannot be changed. If you need to change the name or category of a status, refer to Changing status names and categories. A status's description and color, however, can be edited at any time.
Since standard statuses (Open, In progress, Solved, and Closed) are basic, required statuses, they cannot be edited. These statuses will be marked with a lock icon instead of an Edit button in the workflow.
To edit the description or color of a status:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Workflows tab, find the workflow that has the status that you want to edit.
- In the Actions column next to the workflow, click Edit . This will open the Edit workflow page.
- On the status side of the page, click Edit next to the status that you want to edit.
- Make the relevant edits and click Save.
Note: If the status has been imported into any other workflows, it will be updated in those workflows as well.
Changing status names or categories
Once a status has been created, its name and category cannot be changed. If you need to change the name or category of a status, you will have to remove the incorrect status and create a new, correct status in all relevant workflows. The steps for changing a status name and status category are slightly different, so follow the appropriate instructions below for your situation.
Changing status names
To change the name of a status in a workflow:
- Create a new status with the correct name, following the steps under Creating statuses.
- Delete the incorrect status, following the steps under Deleting statuses from workflows. When prompted to select a replacement status, select the new status created in step 1.
All issues using the incorrect status from that specific workflow will be transferred over to the new, correct status. If the incorrect status is used in multiple workflows, repeat the steps above in all workflows with the status.
Changing status categories
A workflow cannot have two statuses with the same name, so changing a status category requires adding a temporary status to act as a bridge between deleting the incorrect status and creating the correct status. To change the category of a status in a workflow:
- Create a new, temporary status with the correct status category and a unique name, following the steps under Creating statuses.
- Delete the incorrect status, following the steps under Deleting statuses from workflows. When prompted to select a replacement status, select the temporary status created in step 1.
- Create a new status with the correct status category and name, following the steps under Creating statuses. This will be the new, correct status from now on.
- Delete the temporary status created in step 1, following the steps under Deleting statuses from workflows. When prompted to select a replacement status, select the new, correct status created in step 3.
All issues using the incorrect status from that specific workflow will be transferred over to the new, correct status. If the incorrect status is used in multiple workflows, repeat the steps above in all workflows with the status.
Deleting statuses from workflows
While editing statuses is limited, deleting statuses from workflows is not. Almost all statuses can be deleted from individual workflows, including standard statuses and imported statuses. The exception is that standard statuses cannot be deleted from the Standard workflow specifically. Otherwise, deleting a standard or imported status from an individual workflow will remove it from that workflow without affecting that status overall or in any other workflow.
Note: There is no option to delete a status across all workflows. If you need to delete a status from multiple workflows, delete it individually from each workflow.
All workflows must have at least two statuses, with one in the "To do" or "Tracking" status category, and one in the "Completed" status category. If deleting a status will leave the workflow with only one status or status category, the status cannot be deleted until after a status of the unrepresented category has been added.
To delete a status from a workflow:
- Open the project in Revizto Workspace and navigate to Issue Workflows.
- Under the Workflows tab, find the workflow that has the status that you want to delete.
- In the Actions column, click Edit . This will open the Edit workflow page.
- On the status side of the page, click Delete next to the status that you want to delete.
- You will be prompted to select a replacement status for all issues currently using that status and workflow. Select a replacement status from the list.
- Click Delete.
Custom statuses in the issue tracker
After custom statuses have been set up for your project in Revizto Workspace, they will be available for use in the issue tracker environment.
The individual statuses available on an issue are determined by the issue type assigned to the issue when it is created (either manually or from a stamp template). Only the issue type is visible in the issue tracker, not the workflow, which is why it is important to give the issue type a useful name, description, and icon. The issue's assigned issue type will be signaled by the icon in the upper-left corner of the issue summary and listed under the Type field in the info pane. Hovering over the Type field will show the issue type's description.
If you have the correct access rights, you can change the issue type by clicking Edit next to the Type field. If you change the issue type, you might be prompted to change the issue's status to a status associated with the new issue type.
Within the issue's info pane, the status of the issue can be set based on the user's access rights and the assigned issue type. The access rights needed to set a status are determined by the status category (To do, Tracking, or Completed). For more information on user access rights, see Project access rights. If you have the correct access rights, you can change the status of an issue by clicking Edit next to the Status field.
Issue type, status, and status category (To Do, Tracking, or Completed) can all be used to filter issues. To find these issue filters, go to Filters > Custom Filter and search for Type, Status, or Status category in the list of filter options. The project's issue types, statuses, and status categories will be available as checkboxes under their respective filters.
Backwards compatibility
Custom statuses became available with Revito 5.14. When using Revizto 5.13 or earlier, only standard statuses are available. If a project with custom statuses is opened in Revizto 5.13 or earlier, statuses will be converted to standard statuses based on their status categories:
- To do statuses will be displayed as Open.
- Tracking statuses will be displayed as In progress.
- Completed statuses will be displayed as Closed.
This also applies in the opposite direction. An issue created in version 5.13 or earlier is given the default issue type when opened in version 5.14. If the default issue type is linked to the Standard workflow or another workflow that includes the standard status being used, the status assigned to the issue will be the same when opened in version 5.14. However, if the standard status from version 5.13 or earlier is not available in the default issue type's workflow in version 5.14, the unavailable standard status will change to the first available status of the relevant category in the default issue type.
Example: If an issue's status is Open in 5.13 but there is no Open status in the default issue type assigned to that issue in 5.14, the status will be updated to the first status in the "To do" category.
Comments
0 comments
Article is closed for comments.