17. CP objects tagging by additional attributes

A user can manage custom sets of "key-values" attributes for data storage and files. These custom attributes could be used for an additional description of the object and make the search process easier by using attributes as tags.

To edit object's attributes, you need to be an OWNER of the object. For more information see 13. Permissions.

You can also manage attributes via CLI. See 14.2. View and manage Attributes via CLI.

How to navigate to Attributes panel of different objects:

Note: if you were changing the data storage file's attributes, you could return to data storage's attribute by clicking CP_ObjectsTaggingByAdditionalAttributes control.

Add attributes

  1. Navigate to the Attributes panel of a selected object.
  2. Click the + Add button.
    CP_ObjectsTaggingByAdditionalAttributes
  3. Enter an attribute key and value.
  4. Click the Add button:
    CP_ObjectsTaggingByAdditionalAttributes
  5. Added attribute will appear at the Attributes panel:
    CP_ObjectsTaggingByAdditionalAttributes

Add JSON object into the attribute value

Also, you can add more complex attributes than just strings.
In the "Value" field you can specify a raw JSON object, that will be transformed into the pretty-view table.
View an example:

  1. Navigate to the Attributes panel of a selected object.
  2. Click the + Add button.
  3. Enter an attribute key.
    CP_ObjectsTaggingByAdditionalAttributes
  4. Enter the JSON object as the attribute value, click the Add button:
    CP_ObjectsTaggingByAdditionalAttributes
  5. Added attribute will appear at the Attributes panel:
    CP_ObjectsTaggingByAdditionalAttributes
    As the value - the link will be displayed that shows the summary count of first-level JSON records.
  6. Click the value link - the pretty-view detailed table will be opened for the added attribute:
    CP_ObjectsTaggingByAdditionalAttributes
  7. If the raw JSON has more than one level, downstream records will be shown as the link Object. You can hover over it and view the downstream records:
    CP_ObjectsTaggingByAdditionalAttributes
  8. If you want to edit such attribute value - click the EDIT button. The raw JSON will be opened:
    CP_ObjectsTaggingByAdditionalAttributes
    You can edit it and click the SAVE button to save changes.
    CP_ObjectsTaggingByAdditionalAttributes

Add predefined values from dictionaries

Another way to add attribute key and value - not to specify them manually and select from predefined list of System Dictionaries.

Firstly, the sets of key and possible values should be created by admins as corresponding dictionaries in special section of the System Settings, e.g.:
CP_ObjectsTaggingByAdditionalAttributes

After the dictionary is created, it can be used for the tag creation. For that, you should click the "Key" field during the attribute creation and select the dictionary name in the list. After that, the corresponding list of dictionary values becomes available for specifying as the attribute "Value":
CP_ObjectsTaggingByAdditionalAttributes
CP_ObjectsTaggingByAdditionalAttributes

Note: currently, described functionality is available for admins only

See more details and examples in System Dictionaries.

Edit attributes

  1. Navigate to the Attributes panel of a selected object.
  2. Click the attribute key or value field:
    CP_ObjectsTaggingByAdditionalAttributes
  3. Change the attribute key or value:
    CP_ObjectsTaggingByAdditionalAttributes
  4. Press the Enter key or just click out of the active field.
  5. Edited attribute will appear at the Attributes panel:
    CP_ObjectsTaggingByAdditionalAttributes

Delete attributes

  1. Navigate to the Attributes panel of a selected object.
  2. Click the Trash icon to delete a particular attribute.
    Note: click the Remove all button to delete all attributes.
    CP_ObjectsTaggingByAdditionalAttributes

Automatic tagging

In the Cloud Pipeline files are automatically tagged with the following attributes when uploading them to the data storage via CLI/GUI (see a CLI example 14.3. Manage Storage via CLI):

Name in GUI Name in CLI Value
Owner CP_OWNER The value of the attribute will be set as a user ID.
Source CP_SOURCE The value of the attribute will be set as a local path used to upload.
Note: this attribute is set only if a file is uploaded through CLI.

CP_ObjectsTaggingByAdditionalAttributes

Note: The exception is that the storage is based on FS share. Files in such data storage don't have attributes at all.

Besides, files are automatically tagged with the following attributes when uploading them to the data storage as a result of a pipeline run:

Name in GUI Name in CLI Value
Owner CP_OWNER User ID
Source CP_SOURCE Local path used to upload data
RunID CP_RUN_ID Run ID
Pipeline CP_JOB_NAME Pipeline name
CP_JOB_ID  Pipeline ID
Pipeline version CP_JOB_VERSION Pipeline version
Pipeline configuration CP_JOB_CONFIGURATION Pipeline configuration
Docker image CP_DOCKER_IMAGE Tool (docker image) that was used
Compute CP_CALC_CONFIG Instance type

Example of the Attributes panel for the such file:
CP_ObjectsTaggingByAdditionalAttributes