Environment Module

Availability of functionality depends on the license and may not be available in all deployments.

The module is used to manage request templates. It allows:

• viewing the version of the selected request on the available environments,

• migrating the request template (together with its dependencies) between environments,

• reverting the last migration of the request on a specific environment (rollback),

• running the selected request on the selected environment in the simulator (see Request Simulator),

• downloading the business package (the request template together with the dependencies necessary to run it on the environment).

Displaying request information on environments

After opening the module, the button is displayed REQUEST.

Figure 1. "Environments" tab

After selecting a request from the list, the published and highest version of the request will be displayed on each of the available environments:

Figure 2. State of the request on individual environments

Running the request

Clicking the button next to the published version redirects to the request simulator module, automatically selecting the environment from which the redirect was made.

Template migration

To migrate a request together with dependencies to a higher environment, click the arrow between the tiles:

Figure 3. Arrow migrating the request to a higher environment

This will migrate and publish the template in the highest version to the specified environment. Additionally, files necessary for the correct operation of the request will be imported to the environment into the appropriate directories.

Template migration is performed only on the first environment, due to the common database for all LAN instances. The dependencies for the request, however, are delivered to all instances.

Validation during template migration

Before migrating the template together with dependencies, environment consistency is validated. The validator checks whether dependencies imposed on the target environment will not introduce inconsistencies. If the validator encounters any issues, it will display a list and the content of warnings to the user. At this point, the user can decide whether they still want to force the migration to the target environment.

Figure 4. Migration error message

Environment action menu

To open the environment action menu, press the button Open action menu located in the top right corner of the environment tile.

Figure 5. Environment action menu

Export template

Clicking the action menu option Export package will build a zip file containing the request template in the latest version on that environment together with the dependencies needed to run it.

Figure 6. Menu containing the package export command

The file will be saved in the Nexus repository. In response, a popup with a link to the package in Nexus will appear in the browser.

Figure 7. Window with a link to the package

• Exporting the template from the repository is performed from the first environment, due to the common database for all LAN instances.

• The visibility of the export option is controlled by a flag from the environment configuration (bundleExporter).

Environment rollback

The option Rollback is used to restore on a given environment the latest backup of the directories with request dependencies. Backups are created when any request with dependencies is migrated to the environment. Each environment has its own backup for each previously migrated request.

• Template rollback is performed only on the first environment, due to the common database for all LAN instances.

• The visibility of this option is controlled by a flag from the environment configuration (migrationTarget).

If no migration has been finalized before, the option will be grayed out, because there is no available package that could be restored.

Environment configuration

The list of available environment "tiles" should be configured in the file whose path should be provided in the package installation parameters (EXIMEE_CONSOLE_ENVIRONMENTS_CONFIGURATION_PATH). The order of the provided environments also determines the migration direction.

[
  {
    "name": "Environment1",
    "lanHosts": [
      "lan.adres.test"
    ],
    "migrationTarget": false,
    "bundleExporter": false
  },
  {
    "name": "Environment2",
    "lanHosts": [
      "lan.test.eximee",
      "lan2.test.eximee"
    ],
    "migrationTarget": true,
    "bundleExporter": true
  }
]

Meaning of individual attributes:

• name – the environment name displayed on the tile.

• lanHosts – an array of LAN instances on a given environment (important that these are only hosts – without e.g. protocol http:// or port).

• migrationTarget – a flag indicating whether requests can be migrated to a given environment.

• bundleExporter – a flag indicating whether a request package with dependencies can be exported from a given environment.