Managing projects

This guide outlines the lifecycle of an Enterprise Asset Library project: preparing the metadata, uploading the project, and installing it from the Enterprise Asset Library.

Preparing a project for the upload to the Enterprise Asset Library

Before uploading a project, you must embed specific metadata and documentation within the project files.

1. Create project metadata

Open the existing project you wish to publish. From the top navigation bar, expand the coding section and select Libraries. On the Libraries page, click on “Resources” in the top right corner. You must create a specific folder structure to store the project information. Inside lib folder, create a new folder named “metadata”. Inside the metadata folder, create a file named project.json. The project.json needs to have the following JSON structure

{
  "id": "MY_ID",
  "name": "The name shown in the UI",
  "description": "A description of the project shown underneath the name of the project",
  "version": "1.5.0",
  "tags": ["tag1", "tag2"]
}

Guideline on the fields:

  • Mandatory Fields: id, name, and version.

  • Optional Fields: All other fields are optional. If left empty, they will appear blank in the Enterprise Asset Library UI.

  • Versioning: The version field does not require a strict semantic versioning system. Accepted characters mirror DSS group name standards: letters, numbers, periods (.), hyphens (-), and underscores (_).

2. Add documentation

To provide a detailed overview of the project, create a README.md file inside the metadata folder. This file supports Markdown formatting. The content will be rendered and visible within the Enterprise Asset Library interface alongside the JSON metadata. This step is optional.

Note on project images: The project image currently set in your project settings will be automatically used as the thumbnail in the Enterprise Asset Library and will persist when the project is installed by other users.

3. Export the project

Once the project.json and README.md are configured, export the project as a standard DSS project archive (ZIP). Save the archive to your local machine.

Uploading to the Enterprise Asset Library

To publish a project, you must have Contributor rights on the target Enterprise Asset Library collection. Navigate to the Enterprise Asset Library and open the collection where you wish to upload the project. Click “New Asset” from the top right corner and select Upload project.

Note: If the collection is empty, this button also appears in the center of the screen.

Select the project archive you exported in the previous section. Click “Import”.

A modal will appear displaying the extracted metadata:

  • Left Pane: Displays the content of project.json.

  • Right Pane: Displays the rendered README.md.

Click “Create” to finalize the upload.

If you upload a project with an id that already exists in the Enterprise Asset Library, the system will detect it as an update. The modal will display the Previous Version alongside the New Version you are uploading. Proceeding will override the previous entry with the new version.

Installing a project from the Enterprise Asset Library

Any user with Reader rights on an Enterprise Asset Library collection can install projects from it. Navigate to the DSS Home Page. Click on “New Project”. In the dropdown menu, select Enterprise Asset Library projects. A modal will display all projects available to your user profile. Click on a project to view its details and click “Install” to import it into your instance.