Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

2.1 Dashboard

The Dashboard shows all the data that is relevant to the projects and issues, it also provides many graphs for the user to analyze the current situation easily.

2.2 Projects

...

Projects: Main

When the user first opens the Projects page, this is the first page that shows up called Project Listing Page. Users can view all the current projects from this page.

2.2.1 Create

...

Projects: Create

Users can create a new project on this page. First, they need to click the “+” button to open a new project.

...

Projects: Create Table

Users need to fill in relevant details on each row. Please be noted if there is a * sign in specific columns. In those columns, users must provide the relevant details otherwise the project cannot be created. Please note that the value in the * row cannot be changed after creating.

Firstly, users need to add Project Name, Project Code, Project Key, Project Type, Project Category, Lead Default Assignee, and Description. Users can also provide an URL link if there is one. Lastly, users can also choose file or avatar they desire.

After clicking the “Create” button, the project will be created and shown on the main listing page.

2.2.2 Edit

...

Projects: Edit

If the user wants to change the project detail, they can open the detail edit table by clicking the project row from the user listing.

2.2.2.1 Details

...

Projects: Edit Details
The editing table allows the user to edit or delete the current project. It also consists of three sidebars which are Details, People, and Issue Types.

The Details page displays all the details filled in at the creation time. The user is allowed to edit The Projects Page in the Issue Tracker Applet is an essential tool for managing and organizing projects within your organization. This page provides a comprehensive view of all ongoing projects, allows users to create new projects, and offers detailed functionality for managing project teams, issue types, and project settings. The Dashboard also plays a vital role here by offering visual insights into the current status of all projects and issues, helping users analyze progress easily.

When a user opens the Projects Page, they are first presented with the Project Listing Page, where they can view all active projects. This page is the central hub for tracking, updating, and managing project details.

Table of Contents
minLevel1
maxLevel6
outlinefalse
stylenone
typelist
printabletrue

Creating a New Project

Users will need to create a new project in the Issue Tracker Applet when a new initiative, task, or objective arises that requires tracking, managing, and organizing multiple issues, tasks, or work efforts. The creation of a new project helps ensure that all related activities, teams, and resources are aligned and properly managed throughout the life of the project.

To create a new project, users can click on the “+” button on the Project Listing Page, which opens a new project creation interface. Users are required to fill in several important fields before the project can be created

...

Projects: Create

Mandatory Fields

  • Project Name: A unique name for the project.

  • Project Code: A short, often alphanumeric code used for quick reference.

  • Project Key: A key that uniquely identifies the project across the system.

  • Project Type: Defines the nature of the project (e.g., internal, external, client-specific).

  • Project Category: Classifies the project into categories (e.g., Marketing, Development, Sales).

  • Lead Default Assignee: The primary person assigned to manage the project.

  • Description: A brief overview of the project’s objectives, scope, and goals.

  • URL Link (Optional): If the project has an associated web page or resource, users can add a link here.

  • File/Avatar (Optional): Users can upload a file or avatar to represent the project visually.

After filling out the required information, the user can click the Create button to add the project to the listing. The project will then appear in the main project list for easy access and management.

...

Projects: Create Table

Editing and Managing a Project

If users need to update or make changes to an existing project, they can do so by selecting the project from the listing and opening the Edit Project Table. This allows users to modify project details and make adjustments as necessary.

...

Projects: Edit

Details Tab

Displays all the information entered during the project creation process. Here, users can edit fields such as Project Name, Project Key, Project Type, Project Category, Lead Default Assignee, and Description.

2.2.2.2 Projects

...

Projects: Edit Details

People Tab: Managing Team Members

The People tab allows you to view who are the people working on this project. Also, you may search for someone by typing their name or username.

2.2.2.2.1 Create

...

Projects: People Create

The create button allows you to add new user(s) to the project.

...

Projects: People Create Information

When you click on the create button, this page will appear, which allows you to choose users to add to the project, choose the rank, and write a description. Lastly, click on + ADD USER(S) to add the user(s).

2.2.2.2.2 Edit

...

Projects: People Edit

You can click on a user row to edit the user informationTab is a crucial feature for managing team members associated with a specific project. It provides an organized way to view and manage who is working on the project, ensuring that the right individuals are assigned to the right tasks. This tab not only allows users to search for specific team members but also enables the assignment of roles and responsibilities, making collaboration seamless across the project.

...

Projects: People

Key Features

View Team Members

In the People Tab, users can view a complete list of all team members currently working on the project. This overview allows for quick identification of team members and their assigned roles, ensuring that everyone knows their responsibilities and what tasks they are managing.

Add New Team Members

To add a new team member to the project, users simply need to click the Create button within the People Tab.

...

Projects: People Create

  • Once clicked, the user can:

    • Select Team Members: Choose existing users from the organization’s list.

    • Assign Roles: Define the role of the team member within the project (e.g., developer, project manager, tester, designer).

    • Provide Descriptions: Add specific details or descriptions regarding the member’s responsibilities, helping clarify their contribution to the project.

...

Projects: People Create Information

Edit Team Member Details

  • Once a team member has been added to the project, users can click on the row corresponding to that individual to edit their information. This includes:

    • Editing Rank: The role or rank within the project can be updated, for example, if someone is promoted or their responsibilities change.

    • Updating Descriptions: Additional context or updates on the member’s duties can be added to better align expectations or responsibilities.

...

Projects: People Edit Information

When you click on the user row, you can view the username, and edit the rank and description.

2.2.2.3 Issue Types

...

Projects: Issues Type

The Issue Types tab allows you to view issue types on the project. Also, you may search for the issue type by typing its name or code.

2.2.2.3.1 create

...

Projects: Issue type Create

The create button allows you to add new Issue Type(s) to the project.

...

Projects: Issue Type(s) Create Information

...

Use Case Example: Sales Project

Let’s say you are managing a Sales Campaign project. In this case, you might have specific issue types that relate to the sales process. For example:

  • Issue Type: Sales Lead – This could represent any tasks or problems related to generating or following up with sales leads.

  • Issue Type: Client Meeting – This could represent issues related to scheduling or managing client meetings.

  • Issue Type: Product Inquiry – This could be used for tasks related to inquiries about the products.

By clicking the Create button in the Issue Types Tab, you can define these types, write descriptions for each, and add them to the Sales Campaign project. This setup ensures that all team members understand what types of issues they may encounter while working on the project.

Benefits of Using the Issue Types Tab:

  • Customization: Tailor the types of issues according to the needs of each project, whether it's related to Sales, Marketing, or any other department-specific tasks.

  • Efficient Workflow: Categorizing issues by type ensures that the team can easily identify and prioritize tasks based on their nature. It also helps in assigning the right people to handle specific types of work.

  • Reporting and Filtering: With defined issue types, users can generate targeted reports. For instance, a project manager can easily filter for Sales Leads and generate a report showing the number of leads processed in a given time period.

...

Projects: Issues Type

Create Issue Types

To add a new issue type, users need to click the Create button in the Issue Types Tab. This will open a page where users can define the new issue type. The following actions are required:

...

Projects: Issue type Create

  • Choose Issue Types: Select the type of issue (e.g., Bug, Task, Feature Request, etc.).

  • Write a Description: Provide a brief description of the issue type, detailing its purpose and scope within the project.

  • After entering the relevant details, users can click + ADD ISSUE TYPE(S) to add the selected issue type

...

2.2.2.3.2 edit

...

  • to the project.

...

Projects: Issue Type(s) Create Information

Edit

...

You can click on an issue type row to edit the issue type information.

Issue Type

Once issue types are added to a project, users can edit them by clicking on the specific issue type row in the Issue Types Tab. This allows users to update the issue type information, including:

  • Issue Type Name: The title or name of the issue type (e.g., "Sales Lead", "Marketing Task").

  • Description: The detailed description that explains the purpose or scope of the issue type.

...

Projects: Issue Type Edit Information

When you click on the user row, you can view the issue type name, and edit the description.

2.2.3 Search

...

Projects: Search

...

Notification Tab

The Notification Tab is a powerful feature within the Projects Page of the Issue Tracker Applet. It allows users to set up automated email notifications for specific events related to issues in a project. This ensures that team members stay informed about any updates, changes, or actions taken on an issue, even if they are not actively using the app at that moment.

  • Use Case Example:

    • A user creates an issue and assigns it to a team member. If the assignee hasn't opened the Issue Tracker Applet, they might miss the notification about the new issue. By using the Notification Tab, the system will automatically send an email notification to the assignee, alerting them about the new task assigned to them. This ensures that they are promptly informed, even without actively checking the app.

Key Features of the Notification Tab:

  • Event-Based Notifications:

    • The Notification Tab allows users to set notifications for predefined events related to issues. These events include actions like:

      • Issue Created: When a new issue is created.

      • Issue Updated: When an issue is updated or modified.

      • Issue Assigned: When an issue is assigned to a team member.

      • And other events such as Issue Closed, Issue Reopened, etc.

  • Choosing Who to Notify:

    • Users can specify who will be notified when a certain event occurs by checking the relevant boxes. Available options for recipients include:

      • Current Assignee: The person who is assigned the issue.

      • Current Reporter: The person who created or reported the issue.

      • Project Lead: The person leading the project associated with the issue.

      • Current User: The currently logged-in user.

      • Custom Email: For cases where specific individuals or teams outside the predefined roles need to be notified (e.g., notifying the admin team or a particular department).

  • Subscribers List:

    • The Subscribers section in the Notification Tab shows all users who are set to receive notifications for the selected event. When setting up a notification, you can choose to add multiple recipients, ensuring that everyone who needs to be informed is included.

  • Automatic Email Notifications:

    • Once the notification settings are configured and saved, the system will automatically send email notifications when the specified event occurs. This eliminates the need for manual updates and ensures that everyone is kept in the loop.

...

For example, if a new issue is created, and the Current Assignee box is checked, the assignee will automatically receive an email informing them about the issue assigned to them. This is particularly helpful for keeping everyone up to date, even if they haven't yet opened the applet.

...

By using the Projects Page, users can easily assign roles, monitor progress, and ensure that all necessary tasks are completed on time. The ability to link issues to specific project types, filter tasks, and generate reports based on these categorizations allows for a more streamlined workflow, tailored to the needs of each project.

The Issues page allows users to track, update, and assign tasks within projects, ensuring timely completion. Whether it's a bug, task, or feature request, users can monitor status and manage responsibilities to keep projects on track.