Configure the tutorial system#
Prepare your system so that you can complete the tutorial.
Before you begin the tutorial, make sure that you review the Prerequisites. To complete the tutorial, your UrbanCode™Velocity user ID must have sufficient permissions to create value streams and configure plug-in integrations. The UrbanCode products, including UrbanCodeVelocity, use team- and role-based security. Teams own user-created objects, such as value streams and deployment plans. All team members can access team-owned objects, although team members might have different permissions. Some users might only be able to view team objects while other users can create and edit them. Permissions are granted to roles. When you add users to a team, they inherit the permissions granted to their assigned roles. Users can be in multiple roles on a team. It's typical for a team member to be in the Team Administrator role in addition to any other role that they might be assigned. Users can also be on multiple teams and be in different roles on each one. On the tutorial team, your user ID should be assigned to a role with the required permissions.
Note: If you are the UrbanCodeVelocity administrator, you can use the Default team. The system admin role is automatically assigned to this team, and it has all permissions.
In addition to a team and a role, you need access to a a Jira project and connection information, such as the project name and URL.
To prepare the tutorial team, complete the following steps:
- Create a team that you can use throughout the tutorial. If you do not have administrative privileges, ask your administrator to create a
Tutorialsteam for you.
- On the
Tutorialsteam, assign your user ID to the
Lead Developerrole or a group that has this role. A
Tutorialsteam is ideal for new users who are onboarding by working though the tutorials. You might want to create an user ID that is only assigned to the
Tutorialsteam, and can be used by all new users.
Setting up a Jira project#
To integrate Jira into the tutorial value stream, you need a Jira project and Jira API key. If you already have a Jira project, you can use that for the tutorial. If you do not have a project already setup, you can follow the instructions provided below.
Using the free-to-try Jira Cloud, I created a Kanban-type project. I named my project
Delta and Jira assigned the project code
DEL to my project. Make sure to note your project code because we use it later in the tutorial.
My default Kanban project provided the following workflow statuses:
- Selected for Development
- In progress
The first three statuses will correspond to stages in the tutorial value stream. This highlights an important UrbanCodeVelocity concept: value streams represent the tools that you use during the project's lifecycle. We do this by identifying objects in the external tools, such as statuses, modes, or states, that can be represented in the value stream. Jira issue statuses are easily represented by value stream stages, as we demonstrate in this tutorial. As Jira issues change status and move through the Jira workflow, their corresponding value stream items move through the UrbanCodeVelocity stages.
Create a Jira task-type issue. Note that instead of creating an empty project, as I did, you can create a project filled with sample issues.
Using your Jira ID, create a Jira API key. You create Jira keys at:
https://id.atlassian.com/manage/api-tokens. Copy the API key because you will use it to configure the tutorial integration.
New issues are assigned a status of
Backlog and appear in the Backlog part of the Jira workflow. Jira issues with this status will appear in the tutorial value stream Backlog stage. The ID Jira assigned to the issue in my
DEL project is DEL-1. Jira issues are identified by the project code and unique number. UrbanCodeVelocity also uses the ID to track value stream items or particles.
Parent topic: Create a value stream