Artifactory

This topic explains how to use JFrog Artifactory with artifacts stored in folders or with Maven or NuGet as an artifact source.

Note: Deployment Automation 6.3.3 and later supports Artifactory virtual repositories. To get versions from an Artifactory virtual repository, use the Download Artifacts step of the DA VFS plugin. You can download only the versions created with DA 6.3.3 and later.

Artifactory — Folder Based

To download files from Artifactory directories, provide the properties for the Artifactory — Folder Based source configuration type when you create a component. For details on creating components, see Create components.

To view properties and usage for the Artifactory source configuration type, navigate to Automation > Source Config Types and select the type from the list.

Before you can use the Artifactory — Folder Based type:

  1. On the Artifactory server, navigate to Admin > General Configuration > Folder Download Settings.
  2. Select Enable Folder Download.

The Artifactory — Folder Based properties

In Deployment Automation, specify the following properties for Artifactory with artifacts stored in folders as an artifact source.

Property Description
Server URL The base URL for the Artifactory server, for example:
http://serverName:8081/artifactory
Username The username for accessing the Artifactory server.
Password The password for accessing the Artifactory server.
Repository The repository name.
Module The module path to the artifacts in a specified repository.
Latest Artifact Count The maximum number of latest artifact versions to be imported.
Version Name Pattern (Optional) If specified, only versions with names matching this regular expression are imported.
Preserve Execute Permissions (Optional) If selected, file execute permissions are saved with the files.
Import versions automatically

This option enables you to set periodic imports. Deployment Automation will automatically poll for new versions based on the Quiet Period and Polling Period.

The Quiet Period indicates the time (in minutes) during which there's no polling, and it starts after the last polling period that detected changes.

The Polling Period indicates the time between polls (in seconds).

For example, with Quiet Period set to 60 and Polling Period set to 300, Deployment Automation will poll for new versions every 300 seconds. After detecting and importing changes, it will pause polling for 60 minutes.

Copy to CodeStation

This option creates a tamper-proof copy of the artifacts and stores them in the embedded repository called CodeStation.

The option is selected by default. For optimal use of Deployment Automation, ensure that the option remains selected.

If you clear the Copy to CodeStation option, Deployment Automation will save pointers to versions rather than the versions themselves. This enables you to track versions and save space on your Deployment Automation server but limits your ability to download individual versions.

For details on maintaining versions in external sources, see Maintain versions externally.

Use Latest Component Properties for Version Download

(Optional) When the component version artifacts are downloaded, the system uses component properties set for the component at download time rather than those set at the time of version creation.

Regardless of whether this option is selected, component version properties remain as they are when the version is created.

Back to top

Artifactory — Maven / NuGet

To download artifacts from Artifactory local or virtual repositories, provide the properties for the Artifactory — Maven / NuGet source configuration type when you create a component. For details on creating components, see Create components.

To view properties and usage for the Artifactory source configuration type, navigate to Automation > Source Config Types and select the type from the list.

Deployment Automation 6.3.3 and later: We recommend that you work with Artifactory local repositories through the DA VFS plugin instead of the JFrog Artifactory plugin.

The following table describes the properties for Artifactory with Maven or NuGet as an artifact source.

Property Description
Server URL The base URL for the Artifactory server, for example:
http://serverName:8081/artifactory
Username The username for accessing the Artifactory server.
Password The password for accessing the Artifactory server.
Repository The name of Maven or NuGet repository.
Package Type

Select the type of package to be used as the repository, Maven or NuGet.

Group ID

Maven: Enter the group ID of the artifact, such as com.mycompany or com/mycompany.

Group ID is the <groupid> parameter in the Maven dependency within the Artifactory artifact.

NuGet: Leave this field blank.

Artifact ID or nuget.id

Enter the name of the artifact to be imported.

Maven: Enter the artifact ID, such as mypackage-test.

Artifact ID is the <artifactid> parameter in the Maven dependency within the Artifactory artifact.

NuGet: Enter the value of the artifact nuget.id property, such as EntityFramework.

File Name Pattern (Optional) If specified, only files with names matching this regular expression are imported.
Latest Artifact Count The maximum number of latest artifact versions to be imported.
Version Name Pattern (Optional) If specified, only versions with names matching this regular expression are imported. For a snapshot repository, specify the snapshot version, for example, 1.0-SNAPSHOT.
Preserve Execute Permissions (Optional) If selected, file execute permissions are saved with the files.
Import versions automatically

This option enables you to set periodic imports. Deployment Automation will automatically poll for new versions based on the Quiet Period and Polling Period.

The Quiet Period indicates the time (in minutes) during which there's no polling, and it starts after the last polling period that detected changes.

The Polling Period indicates the time between polls (in seconds).

For example, with Quiet Period set to 60 and Polling Period set to 300, Deployment Automation will poll for new versions every 300 seconds. After detecting and importing changes, it will pause polling for 60 minutes.

Copy to CodeStation

This option creates a tamper-proof copy of the artifacts and stores them in the embedded repository called CodeStation.

The option is selected by default. For optimal use of Deployment Automation, ensure that the option remains selected.

If you clear the Copy to CodeStation option, Deployment Automation will save pointers to versions rather than the versions themselves. This enables you to track versions and save space on your Deployment Automation server but limits your ability to download individual versions.

For details on maintaining versions in external sources, see Maintain versions externally.

Use Latest Component Properties for Version Download

(Optional) When the component version artifacts are downloaded, the component properties set for the component at download time are used rather than the properties set at the time of version creation.

Regardless of whether this option is selected, component version properties remain as they are when the version is created.

Caution: To use this option for a repository which you have already downloaded from, make sure that the following settings remain unchanged, as the option doesn't work otherwise:

  • Repository

  • Group ID (Maven only)

  • Artifact ID or nuget.id

Note: To use Apache Maven without Artifactory as your source configuration type, see Maven.

Back to top

See also: