Skip to main content

Managing Models

Designer > Models is the central repository for models. It's the starting point for managing the content, settings, and testing for all your models. From here, you can:

See Building a Model to learn how to plan and build your first model.

Find and View a Model​

All existing models are displayed on the Models page in alphabetical order.

  • To filter the list, just enter full or partial model names in the search box.
  • To check that you've found the right model, click View to preview the model.

Add a New Model​

Create a new model from scratch or import and reuse an existing model.

Create a New Model​

Follow these instructions to create a new model from scratch.

  1. From Models, click Create New.
  2. Enter a unique model name without spaces. Only the following special characters are supported: underscore (_), tilde (~), and hyphen (-).
  3. From the Model Access list, select the access group that you want to have permissions to update the model, run tests on the model or view the test results.
  4. Click Save. The Model workspace opens ready for you to start building your new model.

Import a Model​

To save time, reuse elements from existing models instead of recreating them. This is particularly useful when sharing models with other team members, for debugging, and taking backups.

New Feature

From Eggplant DAI 6.1 onwards, you can also use Save As in the Model workspace to use an existing model as a template for a new one.

  1. Export the json file from the model that you want to reuse.
  2. From Models, click Import.
  3. Click Choose file to browser to and open the exported json file on your local machine.
  4. Enter a new name for your model.
  5. From the Model Access list, select the access group that you want to have permissions to update the model, run tests on the model or view the test results.
  6. Click Save. The Model workspace opens ready for you to start updating the imported model.
note

The new model is no longer associated with a Eggplant Functional suite so you will need to relink it.

Before you can include your model in a test configuration and run a set of tests, you must associate it with an Eggplant Functional suite.

note

To avoid changes from being overwritten, always upload any scripts that you’ve updated in an execution environment before you run tests from the runner.

To link a suite to a model:

  1. Go to Models and find the model that you need to update.
  2. Click Link a suite to run this model.
  3. From the Suite Association list, select the suite you want to link the model to and click Save.

Use the same method to link a new suite to an existing model.

Edit a Model​

When you want to return to an existing model to update it:

  1. Go to Models and find the model that you're interested in.
  2. Click Edit. The Model workspace opens ready for you to start updating the model.

Update an Access Group​

You can change the access group for an existing model to allow different individuals or teams to update the model, run tests or view test results.

  1. Go to Models and find the model that you're interested in.
  2. From the actions menu on the model, select Edit Group.
  3. From the Group list, select the new access group that you want to add to your model and click Save.

Delete a Model​

You can easily remove a model that you no longer need. Before you do, consider exporting the model json so that you can reuse any work you've already done.

  1. Go to Models and find the model that you're interested in.
  2. From the actions menu on the model, select Delete. The model is deleted along with any link to an Eggplant Functional suite. The suite is not removed.

Run Tests Against a Model​

Running tests against a model as you build can make it easier to identify and resolve any issues.

  1. Go to Models and find the model that you're interested in.
  2. From the actions menu on the model, select Run. The Live Run page opens with your model selected ready to configure your test.

View Test Results​

You can easily view detailed results for tests run against any of your existing models.

  1. Go to Models and find the model that you're interested in.
  2. From the actions menu on the model, select View Results. The test results page opens showing the details of each test run in date order.

View the Version History​

When you save a model in the Model workspace, a new version is created along with a customisable tag name. To see details of the version history for a model:

  1. Go to Models and find the model that you're interested in.
  2. From the actions menu on the model, select Version History. A list of model versions is displayed.

Revert to a Previous Version​

Model versions are preserved so that you can switch between them.

  1. Open the version history for the model you're interested in.
  2. Click Revert next to the version that you want to restore. The selected version is reloaded and you return to the Models page.
  3. To revert to a previous version of the model, select the version you want to open and click Revert.

Export a Model​

You can export any of your existing models in json file format so that you can reuse them.

  1. Go to Models and find the model that you want to export.
  2. From the actions menu on the model, select Export. A json file then downloads with the same name as the current model ready for import.