Overview
Market Management is a specialized tool in KOS Studio designed for organizations who publish artifacts to the KOS Market. The market allows organizations to share their tools and applications with other KOS users, either publicly to all users or restricted to specific customer organizations. This tool consolidates all market-related operations in one centralized location, making it easy to manage your market artifacts, customer access, and repository settings.
Note: Market Management is only available to organizations that have permission to publish artifacts to the market. If you do not see this tool in your Settings menu, your organization has not been configured as a market organization.
KOS supports two types of market place artifacts:
- Test Artifact: Test Artifact instances can be used by the third party organization as they are iterating to create a release. This provides and early access to enable cross collaboration between different teams without need of an released version of the artifact but instances from the test artifacts can not be used to create a production release.
- Production Artifact: These artifacts indicate the production ready code for third parties to use.
Along with types KOS supports two level of access:
- Restricted access: Artifacts marked as restricted can only be accessed by organizations who have explicitly given access to said artifact by the KOS Admin for owner organization.
- Unrestricted access: Artifacts marked as unrestricted are available for all organizations to use via market.
This articles walks you through the common operations you can perform via market management tool.
Accessing Market Management
To open Market Management:
- Click on Settings in the main KOS Studio toolbar
- Select Admin from the Settings menu
- Click on Market Management
A new window titled “Market Manager” will appear.
Understanding the Interface
Market Management is organized into three main tabs:
- Artifacts (default view) – Manage your market artifacts
- Customers – Manage customer organizations and their access
- Stores – Configure repositories where market artifacts are stored
You can switch between these tabs seamlessly, and any backend updates will be reflected as soon as you navigate to each tab.
Working with Market Artifacts
The Artifacts tab is selected by default when you open Market Management. This is where you manage all artifacts published to the market.
Viewing Market Artifacts
The artifact list displays:
- All artifacts published by your organization to the market
- Visual indicators for hidden and locked artifacts
- Organizational structure with groups and subgroups
- Non-grouped artifacts appear first (sorted alphanumerically), followed by grouped artifacts
The first artifact in the list is automatically selected, and its details appear in the right panel.
Requesting a New Market Artifact
To add a new artifact to the market, you must submit a request to the KOS Global Admin team:
- Click the Add Market Artifact button
- In the request form, provide:
Requester Information:
- Your name (required)
- Your email address (required)
Market Artifact Information:
- Artifact name (required)
- Artifact description (required)
- Restricted status – Whether access should be limited to specific customers
- Test artifact – Whether this is a test/development artifact
- Layer – Whether this is a Layer KAB
- Click Send Request
Important Notes:
- The “Send Request” button remains disabled until all required information is provided
- You must use your own KOS Studio email address as the requester
- Once submitted, your request is sent to the Global Admin team who will create the market artifact for you
- If submission fails due to an invalid email or system error, an appropriate error message will be displayed
Viewing Artifact Details
When you select an artifact, the detail view displays:
- Artifact name and description
- Last update time
- Test artifact indication
- Releasability status
- Restriction status (Public or Restricted)
- List of published versions
Version Information:
- Versions are marked as deprecated if all instances in that version are deprecated
- Select a version to view its instances and their qualifiers
Managing Customer Access for Restricted Artifacts
For restricted artifacts, you can control which customer organizations have access:
- Select the restricted artifact
- Click on Customer Permissions in the detail view
- Review the list of customers (sorted alphabetically)
Adding Customer Access:
- Find a customer without access to the artifact
- Click the option to add that customer
- The customer will now have access (online connection required)
Removing Customer Access:
- Find a customer with access
- Click the option to remove that customer
- The customer will lose access (online connection required)
Filtering Customers:
- Use “Show only customers with access” to filter the list
- Toggle back to see all customers linked to your organization
Editing Market Artifacts
To edit an artifact:
- Select the artifact from the list
- Click the Edit button (requires online connection)
- In the edit view, you can modify:
- Description (optional)
- Group – Organize artifacts using group assignments
- Lock status – Prevent further modifications
- Click Update to save your changes
Note: The artifact name cannot be changed after creation. You cannot edit locked artifacts.
Organizing with Groups
Groups help organize your market artifacts for easier navigation:
Adding or Editing Groups:
- Select an artifact
- Use the group combobox in the edit view
- Assign the artifact to a group or change its group assignment
Artifacts are displayed with their group names in the list, making it easy to find related artifacts.
Important Restrictions
You cannot delete market artifacts. Once an artifact is added to the market, it becomes a permanent part of the marke catalog. This ensures stability for customers who may be using your artifacts in their projects.
Managing Customers
The Customers tab allows you to manage the organizations that have access to your market artifacts.
Viewing Customers
When you select the Customers tab, you’ll see a list of all customer organizations connected to your market. Select any customer to view:
- Customer name
- Date the connection was established
- Current status (Active or Suspended)
- List of restricted artifacts they have access to (sorted alphabetically)
Adding a Customer
To connect with a new customer organization:
- Click the Add Customer button
- In the “Connect to a customer” modal, enter:
- Authority (required) – The unique authority key that links your organization to the customer
- Note (optional) – Additional information about this customer
- Click Confirm
Note: If the authority key doesn’t match any existing organization, you’ll receive an error message: “This authority does not belong to any organization.”
Managing Customer Access to Artifacts
For each customer, you can control which restricted artifacts they can access:
Adding Artifact Access:
- Select the customer
- Review the list of restricted artifacts
- Find an artifact the customer doesn’t have access to
- Click to add access to that artifact (online connection required)
Removing Artifact Access:
- Select the customer
- Review the artifacts they currently have access to
- Click to remove access from specific artifacts (online connection required)
Filtering Artifacts:
- View only artifacts the customer has access to
- Toggle back to see all restricted artifacts
Editing Customer Details
To edit customer information:
- Select the customer from the list
- Click the Edit button (requires online connection)
- In the “Update customer” modal, you can modify:
- Description (optional)
- Click Update
Note: The customer name cannot be changed.
Suspending Customer Access
To temporarily suspend a customer’s access to your market:
- Select the active customer
- Click Suspend Customer (requires online connection)
- In the warning modal, confirm your action
- The customer will lose access to all restricted market artifacts while suspended
Restoring a Suspended Customer:
- Select the suspended customer
- Click Restore to reactivate their access
Deleting a Customer
To permanently remove a customer from your market:
- Select the customer
- Click Delete (requires online connection)
- In the validation modal, review the consequences
- Type the organization name to confirm
- Click Delete
Warning: To restore a deleted customer, you will need to re-enter their authority key and reconnect them.
Empty State
If you haven’t connected with any customers yet, you’ll see clear instructions on how to add your first customer.
Managing Market Stores
The Stores tab allows you to configure the repositories where your market artifacts are stored.
Viewing Stores
The Stores view displays all configured repositories with:
- Store name (sorted alphabetically)
- Type (Maven or HTTP)
- Location (URL)
Requesting a New Market Store
To add a new repository for market artifacts, you must submit a request:
- Click the Create Market Store button
- In the request form, provide:
- Name (required, no spaces allowed)
- Contact (required) – Your email address
- Type (required) – Select Maven or HTTP
- Description (optional)
- Click Create
Important Notes:
- The “Create” button remains disabled until all required fields are valid
- You must use your KOS Studio email address
- Once submitted, your request is sent to the Global Admin team
- If submission fails, an appropriate error message will be displayed
Working Offline
Market Management continues to function with limited capabilities when KOS Studio loses connection to the KOS Server. An offline indicator will appear when the connection is lost, and disabled features will be clearly marked.
Tips for Effective Market Management
- Use Groups for Organization: Organize your market artifacts into logical groups (by product line, feature set, or target audience) to help customers find what they need
- Manage Restricted Access Carefully: Use restricted artifacts for proprietary or premium tools that should only be available to specific customers
- Keep Descriptions Current: Maintain detailed, up-to-date descriptions for all artifacts to help customers understand their purpose and functionality
- Plan Store Requests: Contact the Global Admin team in advance when you need new market stores to ensure timely setup
