Artifacts

The Artifacts page displays all artifacts on CloudBees CD/RO. To view the artifact list, navigate to DevOps essentials Artifact management Artifacts.

View the artifact list

The following is a description of the options at the top of the artifact list.

Field Name	Description
Add artifact	Opens the New Artifact Details screen, refer to the Create or edit artifacts section to create a new artifact.
Filters:	Select the Default filter link to display the list of existing filters. Select the Add new filter icon to create and define new filter criteria. Select the Edit filter link to rename an existing filter.
Find…	(Optional) Enter a name or partial text to filter the list. This field is case-sensitive.
Tags	The list of tags available for the artifact. There is a search field available to help quickly search the list.

Field Name

Description

Add artifact

Opens the New Artifact Details screen, refer to the Create or edit artifacts section to create a new artifact.

Filters:

Select the Default filter link to display the list of existing filters.

Select the Add new filter icon to create and define new filter criteria.

Select the Edit filter link to rename an existing filter.

Find…

(Optional) Enter a name or partial text to filter the list. This field is case-sensitive.

Column Name	Description / Actions
Name	The name of the artifact. A system-generated name created by combining the Group id and Artifact key components.
Group id	The user-generated group name for this artifact. This field may consist of alphanumeric characters, spaces, underscores, hyphens, and periods.
Artifact Key	The "key" component of the artifact name.
Actions	Actions you can perform on the artifact, including the following: Details: Open the Edit Artifact screen to modify the artifact on this row. Properties: This opens the Properties screen. Properties are the objects related to the artifact. Do one of the following: Select the to create the directory for the property. Directory – Enter name for the directory to be added. Place into… – This determines the directory (property sheet) to contain the property. For more information about properties, refer to Properties. Select the + to “Add Property” to the object and complete the fields shown: Property name – Name for the property. Expandable – Enable to allow this property to be referenced for expansion. Place into… – This determines the directory (property sheet) to contain the property. Description – This is a description of the property. Value – Declare a value for the property. Access control: Displays the privileges assigned to the artifact. You can also view the inherited privileges. Select the + to add a privilege. Complete the Type field and indicate the permission level (inherit, allow, or deny) for each category (read, modify, execute, and change permissions). Change History: Displays the change history associated with the artifact. Delete: Delete the artifact.

Create or edit artifacts

Navigate to DevOps essentials Artifact management Artifacts.
- To create a new artifact, select Add artifact.
- To edit an existing artifact, select the Actions menu for the artifact, and then select Details.

Complete the following fields on the New Artifact or Edit Artifact pop-up screen.

Field Name Description

Field Name	Description
Name	Auto-generated name from combining the Group id and Artifact key components.
Group id	Enter a group name of your choice for this artifact. A Group id (groupId) acts as a namespace for grouping related artifacts. The idea is that artifact "sdk" for group "platform" can co-exist with artifact "sdk" in group "ui" without there being any name collisions. This field is limited to alphanumeric characters, spaces, underscores, hyphens, and periods.
Artifact key	Enter an identifier of your choice for this artifact. This field is limited to alphanumeric characters, spaces, underscores, hyphens, and periods.
Description	(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with `<html> … </html>` tags. Allowable HTML tags are `<a>`, `<b>`, `<br>`, `<div>`, `<dl>`, `<font>`, `<i>`, `<li>`, `<ol>`, `<p>`, `<pre>`, `<span>`, `<style>`, `<table>`, `<tc>`, `<td>`, `<th>`, `<tr>`, and `<ul>`. For example, the following HTML: `<p> <span style="font-family: Arial;"> <i>Note:</i> For more information about the <b>abc</b> object, see <a href="https://www.google.com/">https://www.google.com</a>. </span> </p>` ▼ renders as follows: `<i>Note</i>: For more information about the <b>abc</b> object, see https://www.google.com.` ▼
Artifact Version Name Template	A template for the names of artifact versions published to this artifact. For example: `$[/myArtifactVersion/groupId]:$[/myArtifactVersion/artifactKey]:$[/myArtifactVersion/version]` produces a name like `platform:sdk:1.0.0-36`. Only absolute property paths and `/myArtifactVersion` - based paths are supported. If not specified, the "Artifact Version name template" server setting is used.

Name

Auto-generated name from combining the Group id and Artifact key components.

Group id

Enter a group name of your choice for this artifact. A Group id (groupId) acts as a namespace for grouping related artifacts. The idea is that artifact "sdk" for group "platform" can co-exist with artifact "sdk" in group "ui" without there being any name collisions. This field is limited to alphanumeric characters, spaces, underscores, hyphens, and periods.

Artifact key

Enter an identifier of your choice for this artifact. This field is limited to alphanumeric characters, spaces, underscores, hyphens, and periods.

Description

(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with <html> … </html> tags. Allowable HTML tags are <a>, <b>, <br>, <div>, <dl>, <font>, <i>, <li>, <ol>, <p>, <pre>, <span>, <style>, <table>, <tc>, <td>, <th>, <tr>, and <ul>.

For example, the following HTML:

<p>
<span style="font-family: Arial;">
  <i>Note:</i> For more information about the <b>abc</b> object, see
         <a href="https://www.google.com/">https://www.google.com</a>.
</span>
</p>▼

renders as follows:

<i>Note</i>: For more information about the <b>abc</b> object, see https://www.google.com.▼

Artifact Version Name Template

A template for the names of artifact versions published to this artifact.

For example: $[/myArtifactVersion/groupId]:$[/myArtifactVersion/artifactKey]:$[/myArtifactVersion/version] produces a name like platform:sdk:1.0.0-36. Only absolute property paths and /myArtifactVersion - based paths are supported. If not specified, the "Artifact Version name template" server setting is used.

Once the Details screen is complete, do one of the following:

Select OK to create the new Artifact.

Select the Publish Artifact Version link from the New Artifact screen, and complete the following fields:

Select the Artifact Name from the dropdown menu provided.
Enter Version value in the field provided. This is a required entry.
Select the Repository from the dropdown menu provided.
Enable the checkbox to Enable Compression. This is optional and disabled by default.
Select the Artifact Files to be uploaded (at least one is required):
- File upload: Select Choose Files to select the appropriate file to be uploaded.
- Folder upload: Select Choose Files to select the appropriate folder to be uploaded.

(Optional) Select Add for the Dependent Artifact Version(s) option. You can only list one dependent artifact version per line, and each entry must be in the form of a value. Select Add for additional lines.

All dependent artifact versions must exist for this artifact version to be retrievable. When this artifact version is successfully retrieved, its dependent artifact versions are also retrieved.

Select OK.

Select the artifact you created from the Artifacts list. The Artifact versions screen is displayed.
Select Upload artifact version.

(Edit an Artifact only) To add or edit artifact permissions, select the Access control option from the Actions menu.

Delete artifacts

There are two ways to delete artifacts.

Navigate to DevOps essentials Artifact management Artifacts.
Do one of the following:
- To delete a single artifact or multiple artifacts:
  - Select the checkbox next to the desired artifact(s).
  - Select Delete artifacts at the bottom of the page.
- To delete a specific artifact:
  - Select the Actions menu for the artifact to be deleted, and then select Delete.