1. Home
  2. OpKey Help
  3. 17. User Profile and Admin Console
  4. 17.2 Admin Console

17.2 Admin Console

Overview:

OpKey Web Admin page allows you to manage Users, Projects, Groups, Queued Sessions, Agents, etc. You should have Admin privileges to manage Projects, Groups, Queued Sessions, Agents, etc. Admin page also allows you to work on Single Sign-On (SSO) feature using Okta & ADFS.

Quick Start Screencast:

Profile

The profile section allows you to update the User Name and Password of your own. You can set your profile picture but the image file must be in .png, .jpg, .jpeg and .gif format.

  • Navigate to the Admin panel and click on Profile.
  • Edit name and click on Update (if you want to update your profile name only).
  • Edit name, enter new password & click on Update (if you want to update your profile name & password both).

Single Sign-on

Single Sign-On (SSO) is an advanced feature that allows you to manage our team’s identity across all the SaaS products that are being used in the organization. SSO services allow the user to use one set of login credentials (e.g., email and password) to access multiple applications. The service authenticates the end-user credentials only once for all the applications according to the rights given to the user and eliminates further prompts when the user switches applications during the same session. For details about Single Sign-on, please refer: Single Sign-On in OpKey

User Management

User Management section is accessible to the user(s) having admin rights which display user information like active users, user limit, name, user name, email address, login access, type, and actions. It allows you to add new user(s), edit user, Delete User & release lock for the selected user. You can search a particular user by typing name, user name or email of that user in the search bar. It includes two sub-sections named Login Audit Trails & User Audit Trails.

Here, you can view all the listed users along with their account details. List of Active Users and User Limit is shown on the top. You can customize the list of the number of user items being displayed on the page.

  • Create User: 

Click on Create User icon to add a new user. Enter all required fields and then click on Create. You can provide admin rights to newly created user.

  • View Groups:

Click on View Groups icon to view the groups of the user.

  • Update user: 

Click on Update User icon to edit details (Name, Email, & Password), accessibility (Allow User To log in, IsAdmin) of a user. Click Update.

  • Release lock for this user: 

Click on the Release lock for this user icon to release the lock from all the artifacts locked by the user. Click on OK to continue.

U4 release lock for this user

  • Delete User: 

Click on the Delete User icon and then click OK to validate the same.

U5 Delete User

  • Set User Platform Permission: 

Now an OpKey Admin user can restrict the accessibility of desired platform(s) to a normal user while providing accessibility of a default login platform. In case of user login on any other platform (other than default login platform), he will be redirected to the default platform. However, the normal user must be given at least a default login platform accessibility.

  • Select the platform which you want to restrict the user.
  • Select the Default Access Platform for the selected user.
  • Click on Apply to apply the settings.

 

Login Audit Trails

Login Audit Trails information under User Management of OpKey Web displays detailed information about the login and logout status of OpKey Web Users working on the specified OpKey Web domain. Login Audit Trails information is displayed in a tabular format in which column names are UserName, Task, Source, and Date/Time. The user Name column denotes the name of the user for whom the task has been performed. Task column denotes the task (Login/Logout) performed by the user. Source column denotes the source or platform on which task has been performed. The Date/Time column denotes the date and time when the task was performed. Showing Date/Time details are as per the time zone of OpKey Web user.

    • Click on the Refresh button to refresh the Login Audit Trails.

 

    • Only 400 records of Login Audit Trails are displaying on a page. Click on Next to view other records.

 

    • You can filter the Login Audit Trails record as per the specified Date range under the search bar. To do so, enter From & To date and click on Search.

 

    • To refine the Login Audit Trails record displaying, you can select a date range (From & To) of 90 days only. In case you select a date range out of 90 days, a warning message appears that “Only 90 days Audit Trails can be viewed, you have selected … days.

 

    • You can export the list of Login Audit Trails. To do so, click on Export to Excel and fill From & To dates and click on OK.

 

    • The given date (From & To) in the Search Bar of Login Audit Trails, will be displayed on the Export To Excel popup window in From & To field.

 

  • If you have not refined/filtered Login Audit Trails then the showing Date range in Export To Excel window will be as follows:

                 1. From: First date of the current month

                 2. To: Current date of the current month

  • Once Login Audit Trails has been exported in Excel format, you can view them.

User Audit Trails

User Audit Trails under the User Management section of the OpKey Web provides detailed information about the task performed for OpKey Web users working on the specified OpKey Web domain. Audit Trails information is displayed in a tabular format in which column names are Task, UserName, Field, Old Value, New Value, By User & Date/Time. Task column denotes the task performed. The user Name column denotes the name of the user for whom the task has been performed. The field column denotes the field in which the task has been performed. The old Value column denotes the previous value of the field before performing the task. The new Value column denotes the current modified value of the field after performing the task. By User, column denotes the user who has performed the task whereas Date/Time column denotes the date and time when the task was performed. Showing Date/Time details are as per the time zone of OpKey Web user.

    • Click on the Refresh button to refresh the User Audit Trails.

 

    • Only 400 records of User Audit Trails are displaying on a page. Click on Next to view other records.

 

    • You can filter the User Audit Trails record as per the specified Date range under the search bar. To do so, enter From & To date and click on Search.

 

    • To refine the User Audit Trails record displaying, you can select a date range (From & To) of 90 days only. In case you select a date range out of 90 days, a warning message appears that “Only 90 days Audit Trails can be viewed, you have selected … days.

 

    • You can export the list of User Audit Trails. To do so, click on Export to Excel and fill From & To dates and click on OK.

 

    • The given date (From & To) in the Search Bar of User Audit Trails, will be displayed on the Export To Excel popup window in From & To field.

 

  • If you have not refined/filtered User Audit Trails then the showing Date range in Export To Excel window will be as follows:

                      1. From: First date of the current month

                      2. To: Current date of the current month

  • Once User Audit Trails has been exported in Excel format, you can view them.

Group Management

Group Management under the Admin Console of OpKey allows you to manage groups of users. Here you can view the list of existing Groups along with details alike Service Provider, Name, Projects, OpKey Admin privileges & Actions. You can edit & delete existing groups as per requirement but you should have Admin privileges to do that. For details about the Group management, please refer: Group Management

Project Management

Here, you can see all the listed projects along with few details (Name, AuditTrail, DR Encryption, Plugins, Users and Actions), Create New Project, Update Project, and Delete Project. You can search for a listed project by typing Project Name or AuditTrails. You can customize the list of the number of project items being displayed on the page.

  • Create Project: 

Click on Create Project icon to create a new project. Fill all required fields and then click on the Create button.

  • Update Project: 

Click on Update project icon and then edit all required fields of the project. Click on Update.

  • Assign folder/file permissions for SSO groups and users

An OpKey user having admin privileges can restrict a group(s) or user(s) from accessing an artifact or folder of the project. This feature is available for OpKey Web and Portal environment. To use this feature, click on Assign folder/file permission for SSO groups and users button of the desired project and apply privileges, as required.

Select platform (Web or Job Portal) from dropdown > select desired folder or file > mark checkbox to the respective user(s) & then click on Apply.

  • Delete Project:

Click on Delete Project icon and then click on OK to validate.

PM4 Delete Project

SMTP Mail on Assigning Project to a user

While working with OpKey, when you (as an admin) assign a project to a particular user (Non-admin), there a mail will be sent to that user regarding the assigned project.

    • Let us see how to assign a project to a user.

 

    • Go to the Project Management tab under the Admin panel of OpKey Web.

 

    • Click on Create User. Fill all required fields.

 

  • Click on Select Users dropdown under User (Email/Username) option.

  • A list of all the users (non-admin) is displayed in the list. Select user(s) to whom you want to assign the desired project.

    • Enter valid password & click on Create.

 

  • A mail notification has been sent to the specified user(s) regarding the assigned project.

  • In case, any project is removed from a user, then a corresponding mail is sent to that user.

 

Project Audit Trails

Project audit Trails under Project Management of OpKey Web provides detailed information about the task performed on a particular project. Project audit Trails is displayed in a tabular format in which column names are Task, Project Name, Field Name, Old Value, New Value, Date/Time & By User.

Task column denotes the task performed by the user. Project Name column denotes the name of the project on which task has been performed. Field Name column denotes the name of the particular field in which task has been performed. The old Value column denotes the old value of the field when the task was not performed. The New Value column denotes the new value of the field when the task was finished. source or platform through which task has been performed. The Date/Time column denotes the date and time when the task was performed on the project. By User, column denotes the name of the Admin user who performed the task on the project. Showing Date/Time details are as per the time zone of OpKey Web user.

    • Click on the Refresh button to refresh the Project Audit Trails.

 

    • Only 400 records of Project Audit Trails are displaying on a page. Click on Next to view other records.

 

    • You can filter the Project Audit Trails record as per the specified Date range under the search bar. To do so, enter From & To date and click on Search.

 

    • To refine the Project Audit Trails record displaying, you can select a date range (From & To) of 90 days only. In case you select a date range out of 90 days, a warning message appears that “Only 90 days Audit Trails can be viewed, you have selected … days.

 

    • You can export the list of Project Audit Trails. To do so, click on Export to Excel and fill From & To dates and click on OK.

 

    • The given date (From & To) in the Search Bar of Project Audit Trails, will be displayed on the Export To Excel popup window in From & To field.

 

  • If you have not refined/filtered Project Audit Trails then the showing Date range in Export To Excel window will be as follows:

                        1. From: First date of the current month

                        2. To: Current date of the current month

  • Once Project Audit Trails has been exported in Excel format, you can view them.

17.2.5.2 Project Workspace Audit Trails

Project workspace audit Trails under Project Management provides detailed information about the task performed on a particular project. Project workspace audit trails are displayed in a tabular format in which column names are TaskOld Value, New Value, Platform, Path, Component Type, By User & Date/Time.

Task column denotes the task performed by the user. The old Value column denotes the old value of the field when the task was not performed. The new Value column denotes the new value of the field when the task was finished. The platform column denotes the type of platform or environment in which the user has worked. The component Type column denotes the type of component or artifact on which the user has worked. By User, column denotes the name of the Admin user who performed the task on the particular project. The Date/Time column denotes the date and time when the task was performed on the project.

  • Select Project from the dropdown list.
  • Project Workspace Audit Trails are showing for the desired project.

    • You can filter the Project Workspace Audit Trails record as per the specified Date range under the search bar. To do so, enter From & To date and click on Search.

 

    • You can export the list of Project Audit Trails. To do so, click on Export to Excel and fill From & To dates and click on OK.

 

    • The given date (From & To) in the Search Bar of Project Audit Trails, will be displayed on the Export To Excel popup window in From & To field.

 

  • If you have not refined/filtered Project Audit Trails then the showing Date range in Export To Excel window will be as follows:

                        1. From: First date of the current month

                        2. To: Current date of the current month

  • Click on Export.

  • Your Project Workspace Audit Trails are exported to Excel file successfully.

17.2.5.3 Manage State

From Manage State console under Project Management, you can manage the state of the artifact (Draft, Published or any other). By default, there are two states: Draft & Published. Draft & Published states cannot be modified, deleted, moved up or moved down.

Here, you can view State, name of the user who created it along with the modification date & time information with the time zone.

You can add your own state by clicking on the Add button. You can delete, move up & move down the added States.

17.2.5.4 State Audit Trails

State Audit Trails information under Project Management of OpKey Web displays detailed information about the existing States for a particular project. State Audit Trails information is displayed in a tabular format in which column names are Task, Field, old Value, New Value, By User & Date/Time.

Task column denotes the type of task performed. The field column denotes the type of State on which task has been performed. Old value & New Value denotes the old and new values of the States. User column denotes the User Id who performed task whereas date / Time column denotes the Date & time when the task was performed.

  • Click on the Refresh button to refresh the State Audit Trails.
  • Only 400 records of State Audit Trails are displaying on a page. Click on Next to view other records.
  • You can filter the State Audit Trails record as per the specified Date range under the search bar. To do so, enter From & To date and click on Search.
  • To refine the State Audit Trails record displaying, you can select a date range (From & To) of 90 days only. In case you select a date range out of 90 days, a warning message appears that “Only 90 days State Trails can be viewed, you have selected … days.
  • You can export the list of State Audit Trails. To do so, click on Export to Excel and fill From & To dates and click on OK.
  • The given date (From & To) in the Search Bar of State Audit Trails, will be displayed on the Export To Excel popup window in From To field.
  • If you have not refined/filtered State Audit Trails then the showing Date range in Export To Excel window will be as follows:

                 1. From: First date of the current month

                 2. To: Current date of the current month

  • Once State Audit Trails has been exported in Excel format, you can view them.

Session Management

From here, you can view the list of all the queued sessions with details (Executed On, Session, Project, Type, Artifact Name, Status, Build, Plugin, Agent & Actions). You can refresh grid, delete selected session(s) & view Artifact path. Enter the session name to the search bar to search for a session. You can customize the list of number of project items being displayed on the page.

You can view list of Executing/Finished sessions. To do so, click on Executing/Finished sessions tab.

Click on View artifact path to view the artifact path.

Agent Management

An OpKey Admin user can view the list of OpKey Agents (online & offline) registered in the same domain, in the Agent Management section under Admin Panel. Admin user also has the right to delete any agent, if that agent is not busy at the time of deletion.

  • Go to the Admin Panel & click on Agent Management.
  • Click on the Delete icon to delete an agent. You can search an agent by entering the name of the agent in the search bar.

License Management

License Management in OpKey is a new section added in OpKey under the Admin Console. The License Management section reflects the license information of the different OpKey components (allowed users, OpKey web, Accelerator, Job Portal, Impact Analysis, MBT, Sparkin and Agent). From here, you can upgrade the license of the OpKey components.

License Management is divided into three parts: Component License, Platform License, and Feature License.

  • Component License displays the license information about the Number of Users and Agent License.
  • Platform License shows information about the license status & validity of OpKey platforms like OpKey Web, Job Portal, Accelerator, and Impact Analysis.
  • Feature License displays the license information about the additional OpKey features like MBT (Model-Based Testing) & Sparkin.

  • From here, you can request for the OpKey license & upgrade your OpKey license as well.
  • If you want to request for the license then click on the Request License button. A popup window opens that asks you to contact the OpKey support team at support@opkey.com to extend the license. Once the license request mail is received at the OpKey support team, they will acknowledge it and generate the requested license. Further, they will share the license file with you.

  • Once you received the license file from the OpKey support team, you can upgrade the license by clicking on the Upgrade License button.
  • Click on the Upgrade License button, a popup window appears with a message “Your OpKey license details will get updated as per the added license keys. Do you want to continue?“. Click on Yes to proceed.

  • When you click on Yes, you will be redirected to browse and select the OpKey license file.
  • Select the OpKey License file and click on the Open to add the OpKey license.

  • Your OpKey license will get updated as per the added license keys.

File Transfer History

Now, there is a new tab named as File Transfer History in the admin section of the OpKey. Here, you can view the history details of common actions like export, replica, import, sync, etc. performed on a particular project in a tabular form. You can download logs of performed action by clicking on the Download Logs button but this button will be visible only for a week (7 days) from the date of action performed.

  • Navigate to the admin section and click on the File Transfer History tab. Here, you can view the history related to the transferred files.
  • Select Project and have a look at the file transfer history details in tabular form.
  • Operation Name is the name of the file transfer operation you have performed, Action By depicts the name of the user who performed the operation whereas Date/Time displays the date and the time when the operation was performed. Download Logs button enables you to download the logs of the operation but this button is visible only for a week (7 days) from the date of action performed.

  • Have a look at the downloaded logs here below:

 

Was this article helpful to you? Yes 1 No