System

System provides resources to help you to manage your Eggplant DAI server or hosted installation:

• Status: At-a-glance summary of key information about your DAI system and its status.
• API Access: Administrators can view and manage third party clients access key for DAI service endpoints.
• Git Connections: Users can view and manage Git connections.
• Access: Administrators can create users and manage users.
• My Account: Manage your account details, including your password, profile details, and multi-factor authentication.
• Logs: Administrators can download server logs for troubleshooting.
• Licenses: Administrators can view and manage DAI licenses.
• Agent Tools: Download an agent installer for your platform so that you can set up an execution environment.
• Settings: Administrators can manage DAI settings.

Status

All users can view key information about the DAI system and its status, including the:

• DAI version
• Any differences between DAI client and server system times
• Service availability.

Service Status

System > Status is a good place to begin troubleshooting system issues. View the current status of all services running on the Egpplant DAI server.

Service	Description
DAI API	Availability of the Eggplant DAI API, which is the main API of the product.
DAI SUT	Allows you to define SUTs for use by the scheduler and configuration services.
DAI Task Scheduler	Allows you to run scheduled executions.
DAI Test Config	Allows you to run test configurations for execution.
DAI Suites	Allows you to view and manage suites that have been uploaded by your DAI Design Agent.
DAI Execution	Centrally manages test execution.
DAI Modeler Service	Supports the test case builder.
DAI Cloud	Availability of DAI Cloud SUT, which is used by test configurations.
DAI API Clients Service	Allows API requests and integrations with correct secure credentials to run on Eggplant DAI.
DAI Notification Service	Availability of notification service.

Managing Third Party Client

This feature allows users to create a Keycloak client on demand and download the corresponding client id/secret. The client is required for third-party API access. The main use case is in Eggplant Cloud. For on-prem installs, users can already access credentials via command-line script.

Creating a Third Party Client

In System > API Access, you will find the Third Party Client Management table.

To set up a new Third Party Client, follow these steps:

1. Click on Add New button situated at the top right corner of the page.

2. Enter a descriptive name in the API Access Key Name field.

   ノート

   API Access Key Name is a compulsory field.

3. (Optional) Enter a summary under Description field to help you better understand what the client is intended for.

4. Click Create.

5. A dialog prompting for a client id/secret download will be rendered. You can click Download to download a CSV file and save it to your local drive.

The new Third Party Client appears in the API Access tab. From here, you can choose to Regenerate or Revoke the client by clicking the menu at the end of the row.

Regenerating a Third Party Client

In System > API Access, you will find the Third Party Client Management table. By clicking the menu at the end of a row in the table, you will see the option Regenerate, which allows you to download your client id/secret, if you have not done so during the client creation process.

To download the client id/secret, follow these steps:

1. Click on the menu at the end of a Third Party Client row.

2. Click Regenerate option.

3. Click Confirm when prompted by a confirmation dialog box.

4. Click Download.

A new copy of CSV file containing the client id/secret will be downloaded and saved in your local drive.

Revoking a Third Party Client

In System > API Access, you will find the Third Party Client Management table. By clicking the menu at the end of a row in the table, you will see the option Revoke, which allows you to delete the client from the table.

To delete a client, follow these steps:

1. Click on the menu at the end of a Third Party Client row.

2. Click Revoke option.

3. Click Confirm when prompted by a confirmation dialog box.

The client will be deleted and removed from the Third Party Management table.

Manage Git Connections

Users can view and manage Git connections allowing suites to be loaded from your Git Hosting Provider.

Managing Access

From System > Access, Administrators can create users and manage users.

Managing Your Account Details

From System > My Account, any user can update their account details, including updating their profile and changing their password.

Downloading Server Logs

From System > Logs, Administrators can download server logs to send to Eggplant Support for troubleshooting.

Click Download to download a zip file of all server logs to your Downloads folder.

Managing Licenses

From System > Licenses, Administrators can view and manage the licenses for their Eggplant DAI Server or hosted installation.

See License Administration to learn how to view and assign licenses that you have bought, and to generate license keys.

View Licenses in Use

Systems > Licenses lets you see the details of all licenses that are in use, including the expiry date.

Add a New License

To add a new license, you must first generate a license key from Keysight's license management portal. When you've received your license key by email:

1. From Licenses, click Add.
2. Enter the license key and read Keysight's End User License Agreement (EULA).
3. Click Agree. If the license key is invalid, contact Support.

Delete an Existing License

You may want to remove a license from your Eggplant installation or deployment. For example, if the license has expired or you have allocated the license to another Host ID.

1. Click next to the license that you want to remove.
2. Confirm the deletion.

Downloading Agent Installers

System > Agent Tools lets you download the agent installer of your choice in order to run SenseTalk snippets with Eggplant Functional. See Configure an Execution Environment to learn how to install and configure an agent.

ノート

Click View All Execution Environments to access the Environments page that displays all the configured execution environments for this server.

Manage DAI Settings

System > Settings allows administrators to manage DAI configuration.

Configurations allows you to set up/edit settings used by DAI features, such as SMTP settings.

Global test config notifications settings

You may turn this setting off to prevent all email notifications from being sent when test configurations are executed.

Diagnostics & usage data collection

You may turn this setting ON to enable or OFF to disable diagnostics and usage data collection.

ノート

If Report Usage Statistics is disabled, users cannot change this setting.

SMTP Settings

You may configure your SMTP server to send password reset links and test configuration email notifications.

ノート

You cannot change the settings on Eggplant Cloud. You can only use preconfigured SMTP settings.

1. Click Edit SMTP Settings.

2. Enter details for your SMTP mail server:

   • Host: Hostname of the SMTP server that you want to use to send emails in Eggplant DAI, e.g. smtp.yourserver.com.
   • Port: Port number that Eggplant DAI can connect to on the SMTP server.
   • From Display Name: A user-friendly name for the 'From' address (optional).
   • From: Email address that appears in the SMTP-header for emails sent within Eggplant DAI.
   • Reply to Display Name: A user-friendly name for the 'Reply to' address (optional).
   • Reply to: Alternative email address for replies to the emails sent by Eggplant DAI (optional).
   • Envelope From: Email address used for undelivered emails sent by Eggplant DAI (optional).
   • Enable SSL, Enable StartTLS, Enable Authentication: Select the methods by which you would like to secure the connection to your SMTP server.
   • Username and Password: Credentials for an account on your SMTP server.

3. To save the SMTP settings, click Test Connection. If the connection is successful, you will receive a confirmation message.

Revoking permission for managing SMTP Settings

In some cases, customers might not want DAI administrators to have permissions to manage SMTP settings and for those to be manageable only by the System Administrator.

Follow these steps to revoke the permission from all DAI admin users.

1. Navigate to the Admin Console. For example: http://localhost:8000/auth/admin/master/console.
2. Log in using the System Administrator credentials from the original server.
3. Go to Realm Roles select the dai:admin role.
4. Go to Associated Roles
5. Select realm_role:iam:sys_admin.
6. Click Unassign
7. Click Remove on the confirmation dialog that appears.

ノート

The permissions update will take effect the next time credentials are regenerated, so DAI administrators who are currently logged in will still have the permissions to edit SMTP settings for a few minutes.