Artifact Management
Artifact Management is the tool used to manage an artifact and its instances by the administrative user of the organization. In KOS terminology an artifact represents a concept, not a file. For example, a device may need an admin ui. It hasn’t been written yet; there is no code, no KAB, or anything else other than the concept of the admin UI itself. It is possible to talk about it, schedule it, and plan for it even though it doesn’t exist yet.
An instance in KOS is a KAB file, a particular artifact version. When you write the admin ui code and build a KAB, that is an instance. There can be many instances of an artifact. For example, there may be version 1.0, 1.1 and so on. Even for a given version, there may be multiple instances. For example, there may be an x86 and arm variant of version 1.0 of a given artifact.
The Artifact Manager is a location where Admins can manage these artifacts and their instances, update descriptions and access, and go so fast as to enable deprecating and deleting older instances.
|
Artifact Management is only available to KOS studio admin user. |
Access artifact management
-
Log in to KOS Studio.
-
Select Settings
from top navigation (in the upper right corner of the screen) > Artifact Management
Create a new artifact
-
Log in to KOS Studio.
-
Select Settings
from top navigation (in the upper right corner of the screen) -
Select Artifact Management from the settings menu.
-
Click on the ‘Create New Artifact’ button.
-
Fill in the necessary information.
-
Name: Input a unique name for the Artifact (required).
-
Description: Add a brief description (optional).
-
Restricted: Turning on this will restrict the artifact visibility to only the selected projects.
-
Layer: Select the Checkbox if this Artifact is a “Layer Artifact.” .Click on the ‘Create’ Button at the bottom of the screen.
-
|
Please note
Once artifact is created it can not be marked as a layer. |
Edit an artifact
-
Log in to KOS Studio.
-
Select Settings
from top navigation (in the upper right corner of the screen) -
Select Artifact Management from the settings menu.
-
Click on the artifact to edit in the artifact management tool.
-
Click on the edit icon
on the tool’s right-side pane. -
Make necessary changes to any of the following.
-
Name: Edit the unique name for the Artifact (required).
-
Description: Provide a brief description (optional).
-
Restricted: Turning on this will restrict the artifact visibility to only the selected projects.
-
Lock: Turning on this will restrict further editing of this artifact.
-
Hide: This option conceals the artifact in other tools. While existing devices using this artifact remain unaffected, this prevents this artifact from being used in the future, creating a clean break from dependence on a deprecated artifact.
-
-
Click on the ‘Update’ button.
Delete an artifact
-
Log in to KOS Studio.
-
Select Settings
from top navigation (in the upper right corner of the screen) -
Select Artifact Management from the settings menu.
-
Click on the artifact that needs to be deleted in the artifact management tool.
-
Click on the delete icon
on the right side of the tool. -
Enter the artifact name to be deleted as mentioned in the confirmation dialog.
-
Click on the Confirm button.
|
Consider Following
|
Assign a restricted artifact to project(s)
If an artifact is marked as Restricted, it must then be assigned to a project. This allows users to add it to images within that project.
-
Log in to KOS Studio.
-
Select Settings
from top navigation (in the upper right corner of the screen) -
Select Artifact Management from the settings menu.
-
Click on the restricted artifact, which needs to be assigned to a project.
-
Click on the ‘Projects' table on the right side pane of the Artifact Management window.
-
Select the project(s) that need access to the selected artifact.
Add a published artifact to a group
-
Log in to KOS Studio.
-
Select Settings
from top navigation (in the upper right corner of the screen) -
Select Artifact Management from the settings menu.
-
Click on the artifact that needs to be added to a group
-
Click on the add button
on the right side of the windows. -
Enter the name of the Group to which you wish the artifact to be added.
-
If the group exists, select its name from the provided dropdown list. If it does not exist, opt for the “Add New Group” option visible in the dropdown.
-
This will add the Artifact to the selected Group.
Change group for a published artifact
-
Log in to KOS Studio.
-
Select Settings
from top navigation (in the upper right corner of the screen) -
Select Artifact Management from the settings menu.
-
Click on the artifact that needs to be moved to a new group
-
Click on the add button
on the right side of the windows. -
Enter the name of the group to which you wish the artifact to be moved to.
-
If the Group exists, select its name from the provided dropdown list. If it does not exist, opt for the “Add New Group” option visible in the dropdown.
-
This will change the group of artifacts.
Remove artifact from a group
-
Log in to KOS Studio.
-
Select Settings
from top navigation (in the upper right corner of the screen) -
Select Artifact Management from the settings menu.
-
Click on the artifact that needs to be removed from the current group.
-
Click on the add button
on the right side of the window. -
Click on the Delete
to remove the artifact from the current group.
