Installation & Configuration
This page describes information about the installation & configuration of the Yest for Jira app. If you are interested in Yest Desktop please visit this page.
On this page :
Installation & configuration for Jira Server
Installation via the Marketplace
You can install the Yest for Jira app from the Marketplace. For this select Manage apps -> Find new apps. Search for "Yest" and click to install it.
Configuration of a project for Yest
The Yest for Jira app requires the installation of an issue type called Yest Workflow. It allows the edition and sharing of a business workflow. So to be able to create a Yest workflow in a project, the project must reference to the issue type Yest Workflow.
For this purpose, you can use the Project configuration page created by the Yest for Jira app. It is accessible from the administration page (select Manage apps → [YEST] Configure).
Please note that if you have an ad blocker installed on your browser, it may prevent the Project configuration page from being displayed. Its deactivation on this page resolves the problem.
This configuration page allows you to:
install the issue types and issue link types required to configure a project for Yest.
configure any existing Jira project for Yest. For this just click on 'Associate' button.
Please note that a project configuration for Yest will update the issue type scheme of the project, and this scheme can be shared with several projects.
Please read the section "Issue type scheme management for Yest projects" for more information.
Installing the Yest for Jira 3.1.0 or earlier
If you have installed a version of the app 3.1.0 or earlier, the Yest for Jira app users will have an access to the Yest tab created by the app. This tab allows, among other things, to access the app's documentation and import business workflows (example workflows or BPMN.iO workflows).
The Yest tab appears only for users who has read permission for at least one project configured for Yest.
Installing the Yest for Jira 3.1.1 or later
If you have installed a version of the app 3.1.1 or later, projects configured for Yest will have a Yest menu created by the app. This menu allows, among other things, to access the app's documentation and import business workflows (example workflows or BPMN.iO workflows).
Installation & configuration for Jira Cloud
Installation via the Marketplace
You can install the Yest for Jira app from the Marketplace. For this select Jira settings → Apss → Find new apps. Search for "Yest" and click to install it.
Configuration of a project for Yest
The Yest for Jira automatically installs an issue type called Yest Workflow. It allows the edition and sharing of a business workflow. So to be able to create a Yest workflow in a project, the project must reference to the issue type Yest Workflow.
For this purpose, you can use the Project configuration page created by the Yest for Jira app. It is accessible from the administration page (select Apps → [YEST] Configure).
Please note that if you have an ad blocker installed on your browser, it may prevent the Project configuration page from being displayed. Its deactivation on this page resolves the problem.
On this page you can find all your projects and their compatibility with Yest.
Referencing an issue type depends on the project type:
for a next-gen project, you need to create the issue type manually (with the name 'Yest Workflow') in this project (click on 'Configure' to access the project configuration page).
for a classic project, just click on 'Associate'.
Issue type scheme management for Yest projects
Configuring a project for Yest adds the issue type “Yest Workflow” to the issue type scheme of the project and this scheme can be shared with several projects. Thus, by configuring a project for Yest, all projects sharing the same issue type scheme will be configured for Yest as well.
To avoid the impact on other projects, you can create a specific issue type scheme for Yest projects. For this :
Create a new issue type scheme ‘Yest issue type scheme’
Associate this new scheme with the projects eligible for Yest
Configure one of the projects associated with this scheme for Yest. This configuration will update the 'Yest issue type scheme'. Thus all projects eligible for Yest will be configured at once.
For more information on the issue type scheme and the association of issue types with projects, you can visit this link.
Permission management
To manage a Yest workflow, Yest for Jira uses an attachment named 'workflow.yest'. The creation of Yest workflow adds an attachment to your issue and the modification of the Yest workflow content requires the replacement of this attachment. So users need the following permissions:
Action | Permission |
---|---|
Create a workflow | Create Attachments |
Modify your own workflow | Delete Own Attachments |
Modify the workflow created by other users | Delete All Attachments |
Solution proposition:
Create an user group ‘yest-user’
Add the Yest for Jira app users to the group
Give attachments deletion permissions to this user group.
To give the necessary rights to several projects configured for Yest, you can create a specific permission scheme 'Yest permission scheme' and associate it with all projects eligible for Yest.
For more information on managing permissions, you can visit this link.