Admin Guide

Logging into the system after installation

During installation, a temporary user with the role of "admin" (password Qwerty123) is created in the system with installation permission. The "Remember me" flag allows you to save entered credentials in a browser or on a device.
We recommend changing the user's password before the system is put into use.
Log into the system as a user with the role of "admin."

Trial period

After Test IT is installed, it can be used by 25 users for 30 days. If you purchase a license, all data in the system during that period will be saved. When a user logs in as an administrator, they will see a notification about how much time is left until the end of the trial period.

Admin panel

To go to the Admin section, click on the avatar or the three dots in the upper right corner, then select "Administration" from the pop-up menu.

Users

In the "Users" tab you have access to a list of all users from AD and local users, as well as an "Add" button for adding a local user:
To the right of the "Reset filters" button there is a "gear" symbol that allows you to configure the columns that are displayed. Settings are saved for the current browser.
Clicking on a line with a local user opens a window for editing the user.
The left column with "checkbox" controls allows you to select multiple local users, and remove them from the system by pressing the "Delete" button.
The validity of the values that have been entered is checked in the modal window for adding and editing users.

Groups

In the "Groups" tab you can create and edit names and descriptions for local groups, add users to groups and delete them, filter users, and configure columns:
To add users to the current group (the one highlighted in the left-hand column), check the boxes next to the desired users in the right-hand column, then press the button
:
To delete users from the current group, select the users you want to delete from the user list in the middle of the screen and press "Delete":

Import of test documentation from TestRail

In the "Import" tab, you can import XML files exported from TestRail. Test documentation can be uploaded to a new project as well as to an existing one.
You can upload several files at once and track their progress. Once the file processing is complete, the imported project will be displayed in the Test IT project list.
Test IT supports standard types of XML uploads from TestRail, you can download tests with checks and expected results, as well as the ones separated by steps.

JIRA Server integration

Before connecting integration, you need to install the "Test IT" plugin. The plugin installation instructions are available here.
Once you create a new integration sometimes it might take a few hours for it to connect completely on Jira's end.
For Jira integration to work correctly, you need to set the FRONTEND_URL variable in the .env file.
On the "Integration with Jira" tab, you can create, edit, delete connections to Jira and use a button to sync all projects using this connection to Jira.
Click on the "Create" button to open a pop-up with connection settings.
In the "Name" field, enter the name of the connection which will be reflected in the Test IT UI.
In the "URL" field, enter the full JIRA address including the protocol and port (if necessary). The fields "Login" and "Password" must be filled with the credentials of the JIRA account administrator
After entering information in the fields, click "Test". If the information has been entered correctly, you will be able to click "Save". In case of an error in the fields, an error message will appear next to the test button.
Integration with JIRA can then be used to connect the TestIT project to JIRA

JIRA Cloud integration

Integration with Next-Gen projects (team-managed projects) is not supported.
Once you create a new integration sometimes it might take a few hours for it to connect completely on Jira's end.
For Jira integration to work correctly, you need to set the FRONTEND_URL variable in the .env file.
You need to configure the Jira Cloud account in advance:
1) Create hiddenSteps and testResultId fields (once for the whole system)
a) Go to Jira project settings / "Fields"
b) Create fields with names hiddenSteps and testResultId
Field type - a multi-line text field:
c) Apply the field to all screens that are used in projects that will be integrated with Test IT.
d) Repeat the steps above for the testResultId attribute.
2) Create task type (one time for the whole system)
a) Go to "System Settings / Issues".
b) Create a new task type by clicking the button "Add issue type". The name of the task type is TestCase.
Result:
3) Add Issue type to the project (for each project)
a) Switch to settings of the project to be integrated with Test IT.
b) Select "Issue types".
c) Add the created issue type to the scheme.
It is important that the new Issue type is present in all necessary schemes, otherwise, duplication will not work.
d) Click on the TestCase issue type and add the hiddenSteps field to it.
4) Get a Jira token
a) Open the Administration panel in the "Account Settings" section.
b) Open the "Security" section.
3) Create a token.
Please note that the token cannot be retrieved after closing the window.
5) Conditions for creating integration with Jira Cloud in the administrative section of Test IT
a) The user login must be specified fully (with @mail.mail).
b) Password = Jira token.

Azure DevOps integration

Azure DevOps versions starting with Azure DevOps Server 2020 and Azure DevOps Services are supported
To connect Azure DevOps to Test IT, go to the Integrations section at the Administration panel and click Create -> Azure DevOps. At the New connection window specify the following values:
    Integration name
    Azure DevOps URL (https://dev.azure.com/ - for Azure DevOps Cloud version)
    Organization name (it must match the organization of the token)
    Token from Azure DevOps
Once all the fields are filled in, click Test and then click Save if the connection is successful.
To generate a token, at Azure DevOps in the upper right corner click on the user profile picture, click Security, then go to Personal access tokens from the menu at the left. Press on the New token button and specify the following:
    Token name
    Organization
    Token lifetime
    Access rights:
      Graph - read
      Work items - read/write
Then click Create and copy the generated token.
To generate a token in Azure DevOps Cloud, press the button to the left of the user profile picture in the upper right corner, and in the drop-down menu click Personal access tokens. A token is created the same way as in Azure DevOps Server.

System roles

In the "System roles" tab, you can add roles to users and groups:
    They can be added and displayed in the table using the input field in which user logins or group names are entered.
    Roles can be assigned to users and groups by checking their boxes.
    The admin role makes it possible to gain access to all functionality; the user role is required to log into the system in the absence of the admin role, the project manager role gains access to creating new projects without access to the administrative part of TestIT; a user cannot log in without a role.
    When a role is unassigned from a user (by unchecking the checkbox), their session is automatically terminated, i.e. they will be returned to the system login page.
    A user cannot assign a role to themselves (clicking on the checkbox will lead to an error).
    If a user is added via AD/LDAP to a group that has permissions in our system, synchronization may take up to 20 minutes.

Project roles

On this page, you can view access rights for pre-defined roles, create new roles and edit role rights.
Predefined roles: ProjectAdmin - full access to all project functionality, including its configuration.
TestManager - all project functionality is available, except its settings.
TestDesigner - the role for users who work with the test library, access to other functionality is closed (except for Queries). Please note, this role doesn't let the user delete test cases but make changes only.
TestEngineer - with this role, the user will have access to all sections, but without the right to delete items.
TestExecutor - a role for launching and passing manual tests and autotests. Responsibility area - "Test plans / Execution" tab.
Observer - minimum access to the project, items viewing only.
Test IT sections with configurable access restriction:
    Project editing – section of project setting and configuration, where modifications and change of project description are available; addition of user and project team attributes; setting of an external server project integration (Jira).
    Test library – an archive section of the project’s test documentation (test cases, checklists, shared steps).
    Configurations – section for creating and setting of configurations within the project (Within which tests will be carried out)
    Test plans – section of archiving project test plans, for creation, filling, and task-allocation between users.
    Test execution – section for performing test plans which enables to record test case results as well as launch autotests.
    Test plan report – section of categorized reports on test plan results.
    Reports - section of consolidated reporting for the project
    Autotests library – section of automated tests
    Filters – section for creating filtered queries to search amongst different test cases of the project.
Levels of Access:
Levels of project access can be configured in the table in which rows are sections of Test IT and columns are roles' names. In order to assign or change the right to a section, choose the value from the drop-down menu of the cell.
    Forbidden – the user will not have access to the section either via UI or API, the UI will not allow redirecting to the section; when using a direct link, access will also be forbidden. UI elements related to it will be hidden. If you request a forbidden item via API, the access request error will appear
    View – the user will have access to the section but they won't be able to delete or edit anything; the interface will also include an option to redirect to the section; when using a direct link, access will be granted. UI elements that allow altering the content will be hidden. Errors will occur when trying to edit the data via API (except for GET requests)
    Editing – allows previewing, creating, and editing sections and work items except for deleting them. The user is granted access to the section, the interface has an option to redirect to it. Direct link transition is allowed. UI elements that enable the creation and editing of the section contents are also enabled. Deleting is not allowed. UI elements that allow deleting section contents will be hidden. For example, the user can edit the text in a step of the test case but they can't delete the whole test case. In the case of configuring the project, there's no way to archive the project or restore it; all other actions are allowed. Errors will occur when trying to delete the data via API (DELETE requests).
    Full access – includes the right to preview, create, edit and delete sections as well as work items. UI elements that allow creation, editing, and deleting section contents are enabled.
To create a new role, click the "Create role" button and enter a role name. A role will be created with minimal rights, which can be changed by clicking on a pencil icon next to the role name.
Some rights to items cannot be forbidden, for example, you can't restrict access to the Test library or restrict access to "Queries".

AD/LDAP

In the "AD/LDAP" tab you can edit the active directory (or LDAP) connection. The tab also contains a button that can be used to force synchronization. Reading and synchronization occur every 5 minutes.
In the AD/LDAP settings, you can specify a user/group scheme to support most services.
Fields description Name - connection name in the administration section of Test IT. Example: "My connection". Settings / Search Base - Node in LDAP for searching users and groups. Example: "dc=testit,dc=software". Settings / Host - The hostname of the server that runs LDAP. Example: "198.162.43.21". Settings / Ports - LDAP server port. Example: "389". Settings / Distinguished Name - Username to connect to LDAP server. Example: "[email protected]". Settings / Password - User password. Example: "Qwerty123". SSL - Secure protocol connection User Schema / User Name - Username attribute (sAMAccountName). Example: "Michael Smith". User Schema / Distinguished Name - Unique username attribute. Example: "CN=Michael Smith, OU=TestIT,DC=testit,DC=software". User Schema / Display Name - An attribute that is used for loading the full username. Example: "Michael Smith". User Schema / First Name - An attribute that is used for loading the username. Example: "Michael". User Schema / Last Name - An attribute that is used for loading the user's last name. Example: "Smith". User Schema / Email - An attribute that is used for loading the user's email. Example: "[email protected]". User Schema / Membership - An attribute of the user's group membership. Example: "CN=MyGroup,OU=Testit,DC=testit,DC=software". User Schema / Id - An attribute used to track the identity of a user when renamed. Example: "878ce8b7-2713-41a9-a765-5e3905ab5ef2". User Schema / Common Name - An attribute used to load the username. Example: "Michael Smith". User Schema / Filter - A filter used to search user's objects. Example: "(&(userAccountControl=*)(!(objectClass=computer)))". Group Schema / Members - An attribute used to load group members from the group. Example: "member". Group Schema / Name - A group name attribute. Example: "SmallGroup". Group Schema / Id - the group ID. Example: "878ce8b7-2713-41a9-a765-5e3905ab5ef2". Group Schema / Common Name - An attribute used to load the group name. Example: "MyLittleGroup". Group Schema / Filter - A filter used for searching the group objects. Example: "(groupType=*)".
There is a way to add users to AD from one group only.
User Schema: An example of a filter for users from one group:
1
(&(objectCategory=Person)(sAMAccountName=*)(memberOf=CN=Group-Michael,OU=Michael-test,OU=subsection2,OU=Susbsection1,DC=mtest,DC=com))
Copied!
An example of a filter that adds users from nested groups:
1
(&(objectCategory=Person)(sAMAccountName=*)(memberOf:1.2.840.113556.1.4.1941:=CN=Group-Michael,OU=Michael-test,OU=subsection2,OU=Subsection1,DC=testit,DC=com))
Copied!
Group Schema: A filter for one group (the name starts with ..):
1
(&(objectCategory=group)(name=Group-Michael*))
Copied!
In the AD/LDAP connection section, you can create multiple connections or make a default connection.
The default connection will be displayed on the login page as the primary connection.

OpenID Connect authorization

Test IT allows you to sign in using an external provider that supports the OpenID Connect protocol.
To create this kind of connection, fill in all the required fields, provide the service base domain "Authority" that is used for authorization, and add an endpoint for receiving the OpenID Connect configuration.
In addition to this, you also need to provide "Client_id" and "Client_secret" that you can get from the provider. Also, it's necessary to provide the required scopes to obtain information about users from the external system. Minimum required scopes: openid, profile, email.
Specify the Callback URL at the external system by replacing the domain below with yours: https://{test_it_domain}/api/auth/signin-oidc.
Once the OpenID Connect provider is added, the option to log in using it will appear on the login page.
A user who signs in using the OpenID Connect provider will be registered in the system and assigned the User role if free licenses are available.

Licenses

You can add a license key in the "Licenses" tab:
    To get a key, contact [email protected] from the email linked to your account on the Test IT website. Enter the Server id in the body or header of the email
    Copy the Server id by pressing the button on the right-hand side of it
    Once you've got the key, copy and paste it into the window that appears when you press the "Add" button
    The added key is displayed in the table of the "Licenses" section. The license status is updated automatically depending on the key validity period.
Above the table, you can see the number of active users. It’s a count of active users with license status “Active”.

Attributes

You can add global attributes, global attributes templates, and transform/replace/merge project attributes into global attributes in the "Attributes" tab. Global attributes are just like project attributes but can be applied throughout the whole system. So you can create a global attribute once and use it in any project. In the "Global" section are displayed all global attributes available in the system.
To add a global attribute, press the "Add" button and then just like with adding project attributes, specify its name, type, and enable/disable the "Required attribute" option.
There are edit, delete buttons, and the number of projects, where the global attribute is used, displayed on the attribute card. If you click on the "Usages" label, a list of projects where the attribute is used will show up. By clicking on the name of a project from the list will open a tests library of this project in a new tab.
By clicking on the "Change presentation view" round button at the left of the "Global" section, attributes cards will turn into list items and vice versa.
There is a way to filter by attributes types and by projects where attributes are added. Also, there is an attributes search by their names so it's easy to find the right attribute among hundreds of others. By marking a checkbox of one or several global attributes there is an option to create a template from the selected attributes.
In the "Project" section are displayed project attributes from all the projects in the system.
Just like with global attributes, you can view in which project a project attribute is used. Also, there is an attribute's status showing up - enabled/disabled. If the project was archived, the project's attributes will be displayed with a value "Usages 0". Project attributes can be edited in the "Custom attributes" tab of the project only. A project attribute can be turned into a global one in two clicks. When transforming a project attribute to a global attribute there are options for renaming it and enabling/disabling the "Required attribute" option.
Once checkboxes next to a few project attributes are marked, options for merging and replacing them with a global attribute will show up. The attributes of the same type can be selected only. To replace the selected attributes with a global attribute, you'd need to choose the attribute you want to replace them with from the list of all global attributes with the same type. In case of replacing attributes of the "Options" type, you'd be prompted to map the values of selected project attributes with the values of a global attribute that they will be replaced with or you can choose not to map some attributes' values and in this case, such values will be lost. After replacing the selected project attributes with a global attribute, this attribute will be added to all the projects where the selected attributes have been used. Initial project attributes will be deleted. When merging several project attributes into a new global attribute, there are options for specifying the new attribute's name and enable/disable the "Required attribute" option. In the case of merging attributes of the "Options" type, there is a way to add new values, edit the existing ones, rearrange them, and choose the default value. Once the project attributes are merged, they'll turn into a global attribute.
To ease the work with the same sets of attributes, you can create attributes templates. In the "Templates" section are displayed sets of global attributes which can be used in any project. So it's possible to add to a project and delete from a project several attributes at a time which is getting the project settings up to speed.
Just like with global attributes, you can edit, delete attributes templates, and view in which projects they're used.
To create a template, click "Add", specify its name, select global attributes from the list at the left, and press "Save". To delete an attribute from the template, just click on the attribute's name once again or click on the trashcan icon at the right in the attribute's card which was added to the template. Also, when adding attributes to the template, there is a search for attributes by their names available.

Projects

When you click on the Test IT logo in the upper left corner, a project list will appear in which you can create a new project and edit an existing one, as well as configure access permissions to it.
There is a "Project manager" role in the System roles section. A user with this role has full access to creating, editing, and configuring the project, but cannot access the administration panel.
Last modified 9d ago