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.
- Access: Administrators can view and manage user accounts.
- 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 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:
-
Click on Add New button situated at the top right corner of the page.
-
Enter a descriptive name in the API Access Key Name field.
ノートAPI Access Key Name is a compulsory field.
-
(Optional) Enter a summary under Description field to help you better understand what the client is intended for.
-
Click Create.
-
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:
-
Click on the menu at the end of a Third Party Client row.
-
Click Regenerate option.
-
Click Confirm when prompted by a confirmation dialog box.
-
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:
-
Click on the menu at the end of a Third Party Client row.
-
Click Revoke option.
-
Click Confirm when prompted by a confirmation dialog box.
The client will be deleted and removed from the Third Party Management table.