This the multi-page printable view of this section. Click here to print.
The admin app is where PanHunter users and projects are managed.
Users are classified either as a Standard User or as a Global administrator.
Within a project, from least to most capabilities, users are divided into Guests, Data Analysts, Data Managers, and Project Leaders. Each project role gets all the capabilities of the previous ones.
Global Administrators, unless specified otherwise, get the capabilities of all of the roles.
A user can exist without additional connection to a project, though the utility is quite limited, with the most obvious utility being the contact form. Capabilities in this section are those accessible to all PanHunter users.
The Api Key section in the sidebar leads to the page where users can manage their API Key. API keys allow developers to access PanHunter from scripts or custom apps.
The API key page allows the creation of an API Key if no API Key currently exists. Clicking on Create New Api Key will display the newly created key exactly once, with a button to copy it to the clipboard.
The API key identifier, creation date, and delete button will be displayed. It is not possible to view the full API key: if it is lost at this point, it will be necessary to delete the current key and create a new API key.
One possible application for our API keys would be connecting custom applications to PanHunter. The API Key lets developers obtain PanHunter information via its APIs. APIs exist to retrieve project and user information, or data stored in PanHunter.
The API keys are used by adding the header
X-API-KEY: <api key>
to an HTTP request made to the PanHunter API.
A contact form is accessible to all users.
This contact form, once filled, sends the information given to the PanHunter support team (panhunter_support@evotec.com).
Users can access the contact form either by going directly to the admin app and selecting Contact or by clicking the “Contact” icon in PanHunter. This icon should appear both on the start page and within the apps and is displayed in the following picture within the red square.
The form will autofill some of the information depending on how it is reached.
The following sections will give a few more details about each of the parameters:
Required.
Autofills with the user’s first name and last name if available.
The name of the person the PanHunter support team team should communicate with.
Required.
Autofills with the user’s registration e-mail.
The e-mail to use for further contacts.
Optional.
Autofills if the contact form was reached via a link in a PanHunter App.
The project where the user noticed what they want to communicate to the support team.
Optional.
Autofills if the contact form was reached via a link in a PanHunter App.
The app where the user noticed what they want to communicate to the support team.
Required.
Defaults to Support Request.
The user can select whether their communication should be classified as a Support Request, a Bug Report, or Feedback.
Optional.
Autofills if the contact form was reached via a link in a PanHunter App.
The URL for a snapshot of PanHunter.
A snapshot saves the state of PanHunter at the time when it was taken, allowing for a quick reproduction of the user’s setup.
Optional.
Message to the support team.
All of the sections of the app a user has accessed to to are displayed in a hideable sidebar. Clicking on “Projects” unfolds a subsection with the names of the projects a current user has access to. Clicking on one of these project names leads to that particular project’s details.
The sidebar can be displayed or hidden by clicking either the arrow in the bottom left of the app or the three lines at the top left.
There is an icon at the top of the screen allowing change to light mode (a sun) or to dark mode (a moon) depending on the current mode.
The PanHunter link brings a user back to the PanHunter Start Page.
Clicking on the person symbol in the top right corner displays the current user’s username and a logout button.
Clicking the person again hides the username and the logout button
A project guest can view things within a project, but not run any analysis themselves - this is mainly for showcasing a project to someone, letting them interact with already performed analyses.
All members of a project can see basic information of that project, by going to Projects in the sidebar and clicking on the corresponding project name.
A user can see the project name, description, additional information set by project leaders in project details, and project metrics.
The name of the project is in the top row in the project Information tab. The following lines are the project description.
This is information about the project that project leaders can set or edit. This information is:
This is information obtained from the files in the project. This information is:
A data analyst can run analysis and use existing data, but cannot actually insert or remove data such as sample tables or abundance data.
They are allowed to view other users in their project with their roles.
Project members except guests can see all the members of a project, along with their role, by selecting a project in the sidebar, and then going to the users tab.
A project leader can manage users ,manage apps, manage policies in a project, and even delete a project.
A project leader can see and edit the apps on the start page of a project in the Applications tab of that project.
Going to Project > Applications shows which apps will be displayed on this project’s start page. Hovering the cursor over one of the app icons displays the app description.
Clicking Edit in the top right corner allows to modify the start page content. Here the apps can be moved around to arrange the apps of the project start page differently.
Clicking on x next to an app allows its removal.
Clicking on one of the squares in the grid, whether empty or not, brings up an App selection menu. Hovering over one of these apps displays the corresponding description, like when the apps are present in the grid. This menu contains both the apps created by Evotec and whatever custom apps were added in the Project-Specific App tab, such as the Example Project App in this image.
In the grid:
A project leader can add or remove custom project apps by going to the Project Apps tab within a project.
To create a new app, click on the green + button in the top right corner. A simple form will be displayed.
A project leader must fill in an App Name and an App ID and optionally a Description. If present, the description is displayed when hovering over the app in the Start Page, and when Selecting PanHunter Apps.
In the Project Apps tab, a list of Project-Specific Apps of this project are displayed, with App Name, App Id, and a Delete button for each app.
A project leader can edit the project information on the project information page. The fields that can be modified become editable by clicking the pencil symbol next to the corresponding field text. A project leader can edit the project name, description, status (active or maintenance), billing code, and the internal reference.
The information tab consists of the details, metrics, and configuration of your project. As the first step, you can fill in the title of your project and a modified description by clicking on the pencil icon.
Here, you can fill in all the basic informations regarding your project:
This tab gives you the metrics data about your project such as:
Here, you get the option to delete your whole project. Use this with caution! You must enter your project name here and press the delete button highlighted below after following the mentioned points in the example picture.
Remember: A project, once deleted, cannot be recovered
On the Activities page, a project leader gets access to usage information on the projects they lead.
Clicking Plot Settings in the bottom right corner reveals a menu governing all graphs on the page, allowing to choose the time period covered and the granularity of the interval displayed.
To access this, go to Activities in the sidebar,and go to the Projects tab and scroll down.
Displayed is a table with the names of the projects, the number of users who ever accessed this project, and the number of users who accessed this project in the last 30 days.
Selecting a row displays additional plots with the number of active users, and number of active hours, for this project.
To access this, go to Activities in the sidebar, go to the Projects tab and scroll down. Then, select the desired project from the Select a Project dropdown list.
Displayed is a table with the names of the apps, the number of users who ever accessed this app, and the number of users who accessed this app in the last 30 days.
Selecting a row displays additional plots with the number of active users, and number of active hours, for this app.
To delete a project, go to the project’s Information page.
For confirmation, enter the name of the project in the provided text box and click on “I understand the consequences, delete this project”. After confirming one last time, the deletion is executed.
A project, once deleted, cannot be recovered.
A project leader can add or remove project policies that must be accepted to get involved in a project.
A project leader can upload a policy by clicking “Choose File”, selecting the policy PDF from their local machine (other formats are currently not supported), and clicking the “Upload” button.
A list of existing policies can be seen, with the policy name, a download button to view the policy, and a delete button to remove the policy displayed.
Clicking on one of the policies reveals the list of Project Users, with the date they agreed to this policy, or, if not found, “Not yet agreed”.
📝 Note: Global policy files are added in the Global Policies section, while project specific policy files are added in their respective project section within the Projects sidebar tab.
A project leader can not only view the users within a project, they can also add users, delete users, or change the roles of existing users. To do this, they should select a project in the sidebar, and go to the Users tab.
This tab provides a list of users and their role in the project.
Adding users can be done by clicking on the “+” button, and editing and deleting users can be done via the action column visible to project leaders.
To add users, a project leader should click on the “+” button, enter the registration e-mail of a PanHunter user, and select the desired role from the drop-down list.
Click the “+” button in the pop-up window next to the specified user enables adding further users, and the “trash symbol” button to remove any users not to add.
Once the project leader confirms, the pop-up window closes and the users are added to the project.
📝 Note: User email addresses first need to be registered to the instance. In case you can’t find user email address, please contact the instance admin or PanHunter Support.
To edit a user´s role, a project leader should click on “Edit” in that user´s row, select the new role from the drop-down list, and confirm.
To delete a user, a project leader should click on the “Trash icon” symbol, and confirm their decision. That user is then removed from the project, though they remain a PanHunter user.
On the Activities page, an administrator can see how many users regularly login to PanHunter, how many projects currently exist, and get additional information on overall app usage in addition to the project information a project leader has access to. Hovering over one of the plot bars gives exact numbers.
Clicking Plot Settings in the bottom right corner reveals a menu governing all graphs on the page, allowing to choose the time period covered and the granularity of the interval displayed.
Displayed are the number of active projects (projects present in at least one user’s browser tabs), number of active users (users with PanHunter open), and number of active hours (total amount of time in hours that PanHunter was opened in user’s browser tabs). This data is aggregated across all projects. To get more information about a specific project, see here.
To access this, go to Activities, go to the Global tab and scroll down.
Displayed is a table with the names of the apps, the number of users who ever accessed this app, and the number of users who accessed this app in the last 30 days.
Selecting a row displays additional plots with the number of active users, and number of active hours, for this app.
This data is aggregated across all projects. To get access to information about an app within a project, see here.
You reach the Admin App via your initials in the to right corner and then clicking Admin App.
To create a new project, an user must go to the New Project tab in their side bar and fill in and submit the corresponding form.
At minimum, a project name, a project identifier, at least one species and at least one project leader must be selected.
Once this is done, the project is created within the admin app and set to be in maintenance, and our support team is notified of the project to setup.
The following sections will give a few more details about each of the parameters:
Mandatory for project creation. Can later be altered within a project.
A name for the project, displayed and editable on the Project Information page once reached via the sidebar. This is the label in the sidebar corresponding to the project. This is also displayed on the PanHunter Start Page allowing project selection.
Mandatory for project creation. Cannot be altered after creation.
A unique identifier used internally within PanHunter to identify a project. Only allows lowercase letters or numbers.
Mandatory for project creation. Cannot be added or removed from a project after creation.
Which species PanHunter should support for this project. One or more species must be selected at creation, via the abbreviation of their latin name. Currently supported are: * Hs (Homo sapiens, human) * Mm (Mus musculus, house mouse) * Rn (Rattus norvegicus, brown rat) * Ss (Sus scrofa, pig)
Mandatory for project creation. The requestor is automatically added and cannot be removed while filling the form.
Can later be altered within a project.
Users set to be Project Leaders for a project at its creation. At least one must be selected. Users can be selected via their registration e-mail address in PanHunter. Project leaders will be displayed as Scientific Project Leaders within the project´s information.
Optional. Can later be altered within a project.
A field allowing entry of a billing code if desired.
Optional. Can later be altered within a project.
A field allowing entry of an internal reference if desired.
Optional. Can later be altered within a project.
A field allowing entry of a description for the project if desired.
Optional. Cannot be altered after creation.
If toggled on, this will signal our support team to create appropriate folders for patient data while performing project setup. This allows us follow General Data Protection Regulation (GDPR).