How do I configure the asset types to publish custom assets to Developer Portal?

About this task

Before publishing custom assets to Developer Portal, you must configure the asset type. You can add an asset type and configure its properties from the Manage asset types page.

This use case starts when you want to add a custom asset type and ends when you add the require asset type and configure its properties.

In this example, consider adding the asset type, Microservice with the following properties:
  • Overview. A rich text field that states the overview of the asset (Microservice). This is an optional field.
  • Microservice document. An option to upload a file (Microservice document). This is an optional field.
  • Published On. A date time field to provide the date of the asset publish. This is an optional field.
  • Author. A text field that provides the asset's author name. This is a mandatory field.

To add the asset type with the specified details

  1. Click the menu option icon from the title bar and click Manage asset types.
  2. Click Add type.
  3. Provide Microservice in the Name field.
  4. Provide a description in the Description field.
  5. Add the fields based on the information about custom assets that you want to publish.

    When you add an asset of the defined type, you must specify values for the configured properties.

    To add the Overview field:
    1. Click Add properties.
    2. Provide Overview in the Name field.
    3. Provide Microservice Overview in the Display name field.
    4. Select Rich text from the Select property type field.
    5. Click Add.
    To add the Microservice document field:
    1. Click Add properties.
    2. Provide Document in the Name field.
    3. Provide Microservice Document in the Display name field.
    4. Select File from the Select property type field.
    5. Click Add.
    To add the Published on field:
    1. Click Add properties.
    2. Provide Published On in the Name and Display name fields.
    3. Select Date from the Select property type field.
    4. Click Add.
    To add the Author field:
    1. Click Add properties.
    2. Provide Author in the Name field.
    3. Provide Author in the Display name field.
    4. Select String from the Select property type field.
    5. Turn the Required slider on.
    6. Click Add.
  6. Click Save.

    The asset type is added.

Alternative steps

  • In Step 6, you can select one of the following from the Select property type to add the corresponding property for the asset type being created:
    Property type Description Inputs to be provided
    Boolean Includes a boolean value field with options, Yes or No. Select the default value that must be displayed for the field.

    Select whether this property is mandatory when adding an asset.

    Date time Includes a date time field. Select the default date and time that must be displayed in the field.

    Select whether this property is mandatory when adding an asset.

    Enum Includes a drop-down list. Provide the values that must be displayed in the Possible values field.

    You must provide a value and type a comma to provide the next value.

    Select the default value that must be displayed in the field.

    Select whether this property is mandatory when adding the asset.

    File Includes a file upload button that you can click to upload a file when you add the asset. Select whether this property is mandatory when adding the asset.
    Note: You cannot provide a default value for this field.
    Image Includes an image upload button that you can click to upload an image when you add the asset. Select whether this property is mandatory when adding the asset.
    Note: You cannot provide a default value for this field.
    Number Includes a number field. Provide the default value that must be displayed in the field.

    Select whether this property is mandatory when adding an asset.

    Rich text Includes a rich text field. Provide the default value, with required formatting, to be displayed in the field.

    Select whether this property is mandatory when adding the asset.

    String Includes a text box. Provide the default value that must displayed in the field.

    Select whether this property is mandatory when adding the asset.

    Tags Includes the tags field for the asset. Provide the default value that must displayed in the field.

    Select whether this property is mandatory when adding the asset.

    Note: When you create an asset type, the following properties are added by default:
    • Icon
    • Name
    • Version
    • Summary
    • Tags
    Ensure that you do not add duplicate of these default properties.
  • After you add the required list of properties, you can:
    • Edit the details of the field by clicking .
    • Move the field up or down by clicking or . These fields appear in the order they are created. You can modify the properties as per requirement.
    • Remove a field by clicking .

Next steps