Document toolboxDocument toolbox

Header

Project Creation

📚 This guide delves into the nuances of project management in Qualitia Automation Studio (QAS), a cornerstone for successful test automation. It provides step-by-step instructions to create new projects, manage existing ones, and assign users to different projects.

The guide also shares best practices for efficient project management, and provides visual guidance with screenshots, for a more hands-on understanding.

Prerequisites:

You must have administrative access to QAS, which grants you the necessary permissions to manage projects.

🔀 Procedural steps

This section covers how to create a new project, view and update an existing project.

👁️‍🗨️ View Project Details

To view the details of a project:

  1. Login to QAS - Client.

  2. Access Projects from left navigation to view Project Explorer screen, where you view all existing Projects.

  3. Click a Project to view the Project Details.

  4. The details include information such as:

    1. Project Type

    2. Project Name

    3. Description

    4. Integration

    5. Configuration

👥 Create Project

To create a new project:

  1. Login to QAS - Client.

  2. Access Projects from left navigation to view Project Explorer screen, where you view all existing Projects.

  3. From the Projects section, click Create Project. This opens a Create Project window. Enter the following:

    1. Project Type: Select one of the below project types.

      1. Web/Mobile Project

      2. Desktop Project

      3. Salesforce Project

    2. Project Name: Provide an intuitive name for the project.

    3. Description: A brief description of the project.

The Project Type and Project Name cannot be edited once you create, so be mindful and select the right project type and provide a meaningful name.

  1. Click Save; otherwise, click Discard.

When a project is created, users with administrative privileges are automatically assigned to it by default.

For MAC users, desktop projects will neither be visible nor allow any operations to be performed.

👥 Update Project

You can update a project the following ways:

Method 1

  1. Login to QAS - Client.

  2. Access Projects from left navigation to view Project Explorer screen, where you can view existing projects.

  3. Hover your mouse over a Project to view the Edit Project option.

  4. Clicking Edit Project opens an Edit Project window.

  5. Update the following:

    1. Description: A brief description of the project.

    2. Status checkbox: Select the checkbox to make the project Active; otherwise, deselect the checkbox.

  6. Click Save to proceed; otherwise, click Discard.

Method 2

  1. Click on a specific Project to edit.

  2. This will open the Project Details Section. Click Edit Project, a pencil icon.

  3. Follow steps 4 through 6 mentioned in Method 1.

💡 Golden Nuggets: Best Practices for Project Management

 Project is a crucial part of project management and organization. Here are some best practices to consider: 

  1. Unique: Project names should be unique to each project. This helps to avoid confusion and potential mismanagement.

  2. Avoid Sensitive Information: It's best to avoid using sensitive information such as client names, confidential project details, or strategic plans in project names. This information can be easily viewed and used for malicious purposes.

  3. Easy to Remember: Project names should be easy to remember, but not so straightforward that they reveal sensitive details.

  4. Appropriate Length: A project name that is too short may not provide sufficient information, while one that is too long may be difficult to remember. A good range to consider is between 6 to 14 characters.

  5. Avoid Special Characters and Spaces: Some systems might not support special characters or spaces in project names, or they might create difficulties when integrating with other systems hence prohibited. Underscores are accepted.

  6. Consistent Format: If you're managing a large number of projects, consider using a consistent format for project names. This could be based on project type or department (e.g., Marketing_Project_SEOAutomation or Philips_Project_IOTAutomation), which can make managing and organizing projects easier.

  7. Avoid Offensive Words: Project names should be professional and not include any offensive or inappropriate words.

  8. Review: Regularly review project status to maintain progress and prevent delays. Keep project information up to date to facilitate communication and collaboration.

  9. Archive vs. Delete: If your project is temporarily on hold, consider archiving it instead of deleting. If the project is permanently closed or completed, you can consider deleting it.

🔧 Got Trouble? Let’s Fix!

  1. If you cannot create a project, check your administrative permissions and ensure you have the necessary permissions.

  2. Project page loads depending on project.json file in “QualitiaServer“ folder under ProgramFiles. When you are updating the projects, and if by any chance your system got shutdown, this could corrupt the project.json file. Re-running the Readiness Utility will fix the issue.

  3. Getting error "Early EOF" while project setup after replacing the server workspace: You might get this error while project setup if the credentials through which the VM was logged-in is different from which the Web Services were started. To avoid getting this error you have to make sure that the same log in credential is used for VM as well as web services.
    To fix this error, update the Log On configurations of web-service with appropriate localadmin user following the below steps:

    • Open services and go to qualitia-web-service.

    • Right click on qualitia-web-service and open Properties.

    • Once the Properties window is open, go to Log On screen and add credentials after selecting the button next to This account.

      image-20240904-050730.png

       

    • Click Apply to save the changes.

    • Now go to C:\Users\{username}\AppData\Local\Qualitia Automation Studio - Client\workspace\projects and open git.

    • Insert the command git clone "http://IP:8887/qas-repositories/projectname". Use your machine's IP address and project name in place of “IP“ and “projectname” in the link.

    • Open Services and restart qualitia-web-service.

    • Once the project gets cloned then close the folder and open Qualitia - Client to setup the project.

  4. After completing the Qualitia installation and license key deployment, an error may occur when loading a project in the Project tab. This issue has been observed under specific conditions.

    Pre-conditions that may lead to this issue:

    1. The server and client were installed on the same machine, which is not recommended for customer environments.

    2. The machine was configured so that even the user profile folders were owned by the admin user, which appears to be a specific configuration on the server machine in the customer's organization.

    Resolution: This issue is tied to the specific setup of the machine, and a general fix cannot be provided as the configuration is controlled by the customer. To avoid this issue, ensure the following:

    • Install the server and client on separate machines.

    • Ensure that user profiles and folders are not restricted to admin-only access.

    Following these recommendations should prevent the issue from occurring.

📞📚 Here to Help: Support and Resources

If you have questions that are not addressed in the documentation, you may raise them in the Qualitia Community.

 

Footer