Skip to main content

System

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

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.

ServiceDescription
DAI APIAvailability of the Eggplant DAI API, which is the main API of the product.
DAI SUTAllows you to define SUTs for use by the scheduler and configuration services.
DAI Task SchedulerAllows you to run scheduled executions.
DAI Test ConfigAllows you to run test configurations for execution.
DAI Modeler ServiceSupports the test case builder.
DAI CloudAvailability of DAI Cloud SUT, which is used by test configurations.
DAI IAM ServiceAllows API requests and integrations with correct secure credentials to run on Eggplant DAI.

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.

    note

    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.

Logs

From System > Access, Administrators can manage user accounts and permissions.

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 the 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 Delete 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.

note

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