Documentation

Artifact Browser

What is an artifact?

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.

What is artifact browser?

Artifact Browser is the tool in KOS Studio that provides a detailed view of the artifacts and instances that are available to the user, without putting at risk the details and definitions of these artifacts and their instances.

Access artifact browser

  1. Open and log in to KOS Studio

  2. From the top navigation, click on 'Tools'.

  3. Select Artifact Browser from the Tools menu. Artifact Browser is displayed in a new window.

View a published artifact for your organization

  1. Open and log in to KOS Studio

  2. From the top navigation, click on 'Tools'.

  3. Select Artifact Browser from the Tools menu.

  4. Click on the Published tab in the Artifact Browser window.

  5. Click on the expand icon expand in front of the Group name if the artifact is under a group.

  6. Click on the published artifact on which you want to view the details.

  7. The details displayed on the right side of the pane will include information:

    1. Artifact Name: Name of the artifact.

    2. Description: Description of the artifact.

    3. Last updated date: The timestamp when the artifact was last updated.

    4. Publisher: Name of the Organisation which published this artifact.

    5. Versions: Will list out all the versions of the artifact instances published.

View an instance for the published artifact

  1. Open and log in to KOS Studio

  2. From the top navigation, click on 'Tools'.

  3. Select Artifact Browser from the Tools menu.

  4. Click on the Published tab in the Artifact Browser window.

  5. Click on the expand icon expand in front of the Group name if the artifact is under a group.

  6. Click on the published artifact on which you want to view the instance details.

  7. Click on the expand icon expand in front of the Version number on the right-side panel under the Artifact name

  8. Click on the expand icon expand in front of the instance of with a qualifier you want to view.

  9. The section begins by displaying the following information for the opened instance:

    1. Description: Description of the artifact instance.

    2. File Size: File size of the artifact instance.

    3. Immutable: True if the publisher cannot overwrite the artifact instance; false if the publisher can.

    4. Instance ID: Instance ID is header information of the Artifact published

    5. KAB ID: KAB ID is header information of the artifact published

    6. Kab Type: Mentions the type of the Kab file, a layer kab or non-layer kab

    7. Artifact Store: The store name of the artifact where the instance is published.

View an artifact from the market

  1. Open and log in to KOS Studio

  2. From the top navigation, click on 'Tools'.

  3. Select Artifact Browser from the Tools menu.

  4. Click on the Market tab in the Artifact Browser window.

  5. Click on the expand icon expand in front of the Org name

  6. Click on the published artifact on which you want to view the details.

  7. The details displayed on the right side of the pane will include the following information:

    1. Artifact Name: Name of the artifact.

    2. Description: Description of the artifact.

    3. Last updated date: The timestamp when the artifact was last updated.

    4. Publisher: Name of the Organisation which published this artifact.

    5. Versions: Will list out all the versions of the artifact instances published.

View an instance from the market

  1. Open and log in to KOS Studio

  2. From the top navigation, click on 'Tools'.

  3. Select Artifact Browser from the Tools menu.

  4. Click on the Market tab in the Artifact Browser window.

  5. Click on the expand icon expand in front of the Org name

  6. Click on the Artifact on which you want to view the instance details.

  7. Click on the expand icon expand in front of the Version number on the right-side panel under the Artifact name

  8. Click on the expand icon expand in front of the instance of with a qualifier you want to view.

  9. The section begins by displaying the following information for the opened instance:

    1. Description: Description of the artifact instance.

    2. File Size: File size of the artifact instance.

    3. Immutable: True if the publisher cannot overwrite the artifact instance; false if the publisher can.

    4. Instance ID: Instance ID is header information of the Artifact published

    5. KAB ID: KAB ID is header information of the artifact published

    6. Kab Type: Mentions the type of the Kab file, a layer kab or non-layer kab

    7. Artifact Store: The store name of the artifact where the instance is published.

Previous
Next
On this page
Java Development
Seamlessly transition from Legacy+ systems to Freestyle microdosing and advanced distributed dispense systems.
UI Development
Using KOS SDKs, integrating Consumer and Non-consumer facing UIs becomes seamless, giving you less hassle and more time to create.
Video Library
Meet some of our development team, as they lead you through the tools, features, and tips and tricks of various KOS tools.
Resources
Familiarize yourself with KOS terminology, our reference materials, and explore additional resources that complement your KOS journey.
Copyright © 2024 TCCC. All rights reserved.