ivy:deploy-to-engine

The auto deployment directory of the engine. Must match the ivy engine system property 'deployment.directory'

The path to the Axon Ivy Engine to which we deploy the file.
The path can reference a remote engine by using UNC paths e.g. \\myRemoteHost\myEngineShare

Engine url for deployment over HTTP or HTTPS

The file to deploy. Can either be a *.iar project file or a *.zip file containing a full application (set of projects). By default the packed IAR from the ch.ivyteam.ivy.maven.IarPackagingMojo.GOAL is used.

The deploy method

Possible values:

• DIRECTORY: use filesystem to deploy to local engine
• HTTP: use HTTP or HTTPS to deploy to a remote engine

The file that contains deployment options.

Example options file content:

deployTestUsers: auto
target:
  version: RELEASED
  state: ACTIVE_AND_RELEASED

Inside the options file you can use property placeholders. The options file may look like this:

deployTestUsers: ${ivy.deploy.test.users}
target:
  version: AUTO
  state: ${ivy.deploy.target.state}

All options in this file are optional. You only need to specify options that overwrite the default behavior.

If configured, all Maven properties are ignored and only values in this file are used.

See also: Engine Guide

Id of server configured in settings.xml that specifies the administrator user name and password used to authenticate in case of HTTP deployment. If you're using an encrypted maven password with a settings-security.xml, you may need to define the location of this file with the property 'settings.security' (default location is ~/.settings-security.xml)

The target file format as which the project will be deployed into the process model version (PMV).

• AUTO: Keep the format of the origin project file if possible. Deploys IAR or ZIP projects into a ZIP process model version.
  But if the target PMV already exists as expanded directory, the new version will be expanded as well.
• PACKED: Enforce the deployment of a project as zipped file. Normal (expanded) project directories will be compressed into a ZIP during deployment.
• EXPANDED: Enforce the deployment of a project as expanded file directory.
  This is recommended for projects that change the project files at runtime. E.g. projects that use the Content Management (CMS) write API.
  The expanded format behaves exactly like projects deployed with Axon Ivy 7.0 or older. You might choose to deploy expanded projects in order to avoid java.nio.file.ReadOnlyFileSystemException at runtime.
  Warning: Expanded projects will perform slower at runtime and are therefore not recommended.

The target state of all process model versions (PMVs) of the deployed projects.

• ACTIVE_AND_RELEASED: PMVs are activated and released after the deployment
• ACTIVE: PMVs are activated but not released after the deployment
• INACTIVE: PMVs are neither activated nor released after the deployment

The target version controls on which process model version (PMV) a project is re-deployed.

Matching:

• In all cases the library identifier (group id and project/artifact id) of the PMV and the project has to be equal.
• If multiple PMVs match the target version then the PMV with the highest library version is chosen.
• If no PMV matches the target version then a new PMV is created and the project is deployed to the new PMV.

Possible values:

• AUTO: a project is re-deployed if the version of the PMV is equal to the project's version.
• RELEASED: a project is re-deployed to the released PMV. The version of the PMV and the project does not matter
• Maven version range: a project is re-deployed if the version of the PMV matches the given range. Some samples:
  • , - Matches all version.
  • ,2.5] - Matches every version up to 2.5 inclusive.
  • (2.5, - Matches every version from 2.5 exclusive.
  • [2.0,3.0) - Matches every version from 2.0 inclusive up to 3.0 exclusive.
  • 2.5 - Matches every version from 2.5 inclusive.

If set to true then test users defined in the projects are deployed to the engine. If set to auto then test users will only deployed when engine runs in demo mode. Should only be used for testing.

This option is only in charge if security system is set to Ivy Security System. This means if the security system is Active Directory or Novell eDirectory test users will never deployed.

The maximum amount of seconds that we wait for a deployment result from the engine

The name of an ivy application to which the file is deployed.

Location where ivy engines in required version can be extracted to.

If the Engine does not yet exist, it can be automatically downloaded.

Location where an unpacked (may pre-configured) ivy Engine in the required version exists.

If parameter is not set it will be a sub-directory of the engineCacheDirectory.

If the Engine does not yet exist, it can be automatically downloaded.

The ivy Engine version or version-range that must be used. Must be equal or higher than "12.0.0" Examples:

• "6.1.2" means ivyVersion = 6.1.2
• "[6.1.0,7.0.0)" means 6.1.0 <= ivyVersion < 7.0.0
• "(6.0.0,]" means ivyVersion > 6.0.0

Set to true to skip the deployment to the engine.

Configure if the test engine gets copied to the maven target folder. With this you can start each test cycle with a clean engine. Integration tests may leave resources like deployed projects behind which may lead to unwanted side effects on the next test cycle.

• COPY_FROM_CACHE = copy the engine if it comes from the ch.ivyteam.ivy.maven.AbstractEngineMojo.engineCacheDirectory.
• MODIFY_EXISTING = don't copy the engine, this could lead to unforeseen behaviour if the same engine is used multiple times.
• COPY_FROM_TEMPLATE = always copy the engine. If you have a preconfigured engine in the ch.ivyteam.ivy.maven.AbstractEngineMojo.engineDirectory it will be copied as well.
  • Note: that we advise you to move the configuration of such engine to the build cycle itself instead of using a preconfigured one.

If set to true it will download the latest available minor version