Team Shortcut

What is a team shortcut?

Team shortcuts is a powerful tool that minimizes the friction between configuring images for users without remembering each setup step.

Software development teams usually collaborate and work off of one or multiple repositories, and they need to utilize the artifacts built from these repos into the image. The relative path for the artifact remains the same, as everyone builds from the same repo, where each developer clones the repo, which is usually the developer’s choice.

Teams can create a variable that represents this path from the root, and reference every artifact you build from that source repository. When team members use the image, they configure this single team shortcut, and the system automatically resolves all paths relative to the shortcut.

For example: In your image, you want to refer to an artifact built at:

/Users/user1/Documents/Code/organization/repo-name/package-name/target/artifact.kab

and

/Users/user1/Documents/Code/organization/repo-name/package-name2/target/artifact2.kab

Here, you would create a team shortcut for the repo, which references repo location as repo-location, and you will map your image to use artifact from:

{{repo-location}}/package-name/target/artifact.kab

and

{{repo-location}}/package-name2/target/artifact2.kab

So, next time your team members use the same image, they will have to update the team shortcut to point to their repo location, and the image will refer to the artifact at a defined location without needing to reconfigure each artifact separately.

Team Shortcuts

Access team shortcut settings

  1. Log in to KOS Studio.
  2. Select Settings  from top navigation (in the upper right corner of the screen).
  3. Select Team Shortcuts from the Settings Menu.

Create a team shortcut

  1. Log in to KOS Studio.
  2. Select Settings from top navigation (in the upper right corner of the screen).
  3. Select Team Shortcuts from the Settings Menu.
  4. Click on the “Create new shortcut” button in the Team Shortcut Manager.
  5. Enter the following details
    1. Name: Input a Unique name.
    2. Description: Enter the description for the Team Shortcut.
    3. Access: The lock radio button will be locked for editing before it can be unlocked. (This is an admin-only feature).
  6. Once the details are filled in, Click on the Select Location button.
  7. Select folder modal window will open.
  8. Navigate through the folders and select the folder you want to designate as the team shortcut folder.
  9. Click on the Update button.

Editing a team shortcut

  1. Log in to KOS Studio.
  2. Select Settings from top navigation (in the upper right corner of the screen).
  3. Select Team Shortcuts from the Settings Menu.
  4. Click on the Team shortcut that you want to edit.
  5. Click on the Edit icon against the name of the shortcut.
  6. Edit the details from the following list:
    1. Name: Input a Unique name.
    2. Description: Enter the description for the Team Shortcut.
    3. Access: (This is an admin-only feature).
    4. Lock: The lock radio button will be locked for editing the details, but the user can still set the local directory for the team shortcut.
    5. Hide: This will hide the Team shortcut in the file/folder selection modal window. Once it is hidden, this team shortcut cannot be used for new images, but older images will be able to use them. Click on the Update button to update the details.

Delete a team shortcut

  1. Log in to KOS Studio.
  2. Select Settings from top navigation (in the upper right corner of the screen).
  3. Select Team Shortcuts from the Settings Menu.
  4. Click on the Team shortcut that you want to delete.
  5. Click on the delete icon against the name of the Team shortcut.
  6. To delete a team shortcut, ensure it is not in use in any images and is not locked.

Set(or edit) a local directory

  1. Log in to KOS Studio.
  2. Select Settings  from top navigation (in the upper right corner of the screen).
  3. Select Team Shortcuts from the Settings Menu.
  4. Click on the Team shortcut that you want to set as a local directory.
  5. Click on the edit icon against the ‘Directory on this computer‘
  6. Select the local folder you want to set as a team directory.
  7. Click on the Save button.
  8. This local setting is specific to the computer and impacts only the current computer on which the user is logged in.

Delete the Local directory

  1. Log in to KOS Studio.
  2. Select Settings  from top navigation (in the upper right corner of the screen).
  3. Select Team Shortcuts from the Settings Menu.
  4. Click on the Team shortcut that you want to set a local directory.
  5. Click on the delete icon against ‘Directory on this computer.’