Manage Property Sets
Create, assign, and manage property sets for structured artifact metadata across Federation members.
Create and manage property sets that define structured metadata for artifacts. In a Federation, property set definitions aren't synchronized across members, but individual artifact properties are synchronized.
Who can perform this task: Platform Administrators
Prerequisites:
- Admin access to the JFrog Platform
Using the Platform UI
- Create a Property Set
- Edit a Property Set
- Delete a Property Set
- Assign a Property Set to a Repository
Create a Property Set
Define a new property set and the individual properties it contains.
To create a new property set:
- In the Administration module, navigate to Artifactory Settings > Property Sets.
- Click New Property Set.
- Enter a unique Name for the property set.
- Click Add Property to define properties within the set.
| Field | Description |
|---|---|
| Property Name | A unique name for the property (for example, build.status, release.stage). |
| Property Type | Select from: Any Value, Single Select, or Multi Select. |
| Default Value | Optional default value for the property. |
| Predefined Values | For Single Select or Multi Select types, define the list of allowed values. |
- Add as many properties as needed.
- Click Save.
Edit a Property Set
Modify an existing property set's properties.
To edit a property set:
- Click the property set name to open it.
- Modify property definitions, add new properties, or remove existing ones.
- Click Save.
Delete a Property Set
Remove a property set that's no longer needed.
To delete a property set:
- Select the property set.
- Click Delete.
You can't delete a property set if it's currently assigned to a repository.
Assign a Property Set to a Repository
Apply a property set to a specific repository so its properties are available for artifacts in that repository.
To assign a property set to a repository:
- In the Administration module, click Repositories.
- Select the repository to configure.
- In the Advanced tab, locate the Property Sets field.
- Select the property sets to assign.
- Click Save.
Using the REST API
Retrieve property sets from the global configuration:
GET /artifactory/api/system/configurationProperty sets are defined in the propertySets section of the returned YAML.
Manage artifact-level properties using the Item Properties REST APIs (replace {repoKey} and {itemPath} with the target repository and item path):
PUT /artifactory/api/storage/{repoKey}/{itemPath}?properties=key=valueFor example:
PUT /artifactory/api/storage/libs-release-local/com/myapp/1.0/app.jar?properties=release.stage=productionFederation Considerations
- Property set definitions are not synchronized: The
propertySetsconfiguration is listed in the Synchronized Metadata Reference as a setting that isn't synchronized among Federation members. You must create the same property set definitions on each member independently. - Artifact properties are synchronized: While property set definitions are local, the actual properties assigned to individual artifacts and folders are synchronized across Federation members. When you set a property on an artifact, that property value propagates to all members.
- Assignment consistency: For a consistent user experience, assign the same property sets to the Federated repository on each member. If a property set exists on one member but not another, users on the member without the definition can still see synchronized property values but can't use the UI to manage them through the property set interface.
- Predefined values: If you use predefined values (Single Select or Multi Select), ensure the same values are defined on all members. Otherwise, synchronized property values may not match the predefined list on some members.
Define property sets on all Federation members before creating Federated repositories. This ensures a consistent experience when users assign or filter by properties on any member.
Frequently Asked Questions
This section provides answers to frequently asked questions.
FAQs
Q: Are property set definitions synchronized across Federation members?
A: No. You must create the same property set definitions independently on each member. Only the property values assigned to artifacts synchronize automatically. See Federation Considerations.
Q: Can I delete a property set that's assigned to a repository?
A: No. You must remove the assignment from the repository before you can delete the property set.
Q: What happens if a predefined value differs between Federation members?
A: Synchronized property values may not match the predefined list on a member where that value isn't defined, which can cause inconsistent filtering or display.
Q: How do I retrieve property sets programmatically?
A: Send a GET request to /artifactory/api/system/configuration; property sets are returned in the propertySets section.
Related Topics
Updated about 7 hours ago
