Assets

Introduction

What are Assets?

Assets are basically a clone of a service project including all its implementation code and configuration that can be used to jumpstart development. Assets can provide other users a ready-made project or just a base template (e.g., individual standards) to build their own projects.

Assets can be provided internally (shared by other development teams) or externally. They are stored in so-called “Asset Catalogs” where each is represented by a Git repository hosted by you or an external party. The owner of the Git repository can define access permissions individually.

What you can do with Assets?

After you created a service project from an asset you can edit or extend it to your needs, and then share the edited project as a new asset. As your service project evolves, you can share it multiple times in different versions or even overwrite already shared versions of this project.

If there are multiple asset catalogs configured, you can share the same project to different catalogs.

In case you configure an external asset catalog hosted by a different party, this catalog will most likely be read-only. This means, you can only use this catalog to create projects from its assets but not to share projects.

The asset catalogs for which a user has access are shown in the Asset Catalogs page. The overview allows filtering for dedicated Git providers and catalog types.

Tip:

Users have to provide a Git token for the respective asset catalog repositories in their User Settings.

How can I use an asset?

Adding an asset catalog

Warning:

This task requires the user to be in the role of dc_admin.

To provide users with the option to share service projects as asset or create new projects based on these shared assets there needs to be at least one asset catalog with write access configured. Follow the same steps in case you want to connect to an externally hosted asset catalog.

  • Go to the Admin Settings by clicking on the Settings icon in the header bar
  • Click on Asset Catalogs
  • Click on Add catalog
  • Specify a unique alias for this asset catalog
  • Set one or more tags (optional)
  • Select the Git provider that hosts this asset catalog
  • Enter the repository group of the repository that holds the asset catalog data
  • Enter the repository key of the repository that holds the asset catalog data
  • Provide a description (optional)
  • Choose "Create new asset catalog if not exists" in case you want to create a new Git repository for that new catalog

Removing an asset catalog

Warning:

This task requires the user to be in the role of dc_admin.

To remove an asset catalog, use the three-dots menu on a catalog's table row and click on Remove.

Editing an asset catalog

Warning:

This task requires the user to be in the role of dc_admin.

To edit an asset catalog, use the three-dots menu on a catalog's table row and click on Edit.

Browsing an asset catalog

By clicking on a card visualizing the asset catalog you will receive a detail view of the asset catalog and the included assets as well as additional information on the catalog. Searching and filtering is similar to the Project Overview.

Asset overview

Aside of the shown information on an asset card you can use the three dots in the upper right of the card to

  • Create a new project from this asset
  • Remove an asset from this asset catalog (requires dc_admin role)
Tip:

The asset card will be disabled if the user does not have a read access

Asset details

By clicking on the asset card visualizing the asset you will receive a detail view of the asset

  • Name
  • Acronym
  • Version
  • Contributor
  • Exported on
  • Tags
Note:

For assets created from a Domain Service Project also API Operations, Domain Services and Integration Services are displayed.

Create project from asset

By clicking on "Create project from asset" you will be guided to Create Project.

Remove asset from catalog

Warning:

This task requires the user to be in the role of dc_admin.

Once you locate the catalog, press the three dots on the right and click the (- Remove) button. Confirm the "Remove Asset from Catalog" dialog.