Tutorial 1 - Your first Product#

Sign into DejaCode.

Create a Product#

  1. Select Products from the main menu bar.

2. Click the green Add Product button. Enter the values that you know, you can refer to Product model for details about each fields.

  1. Set a name, and click the Add Product button at the bottom of the form.

Note

You are ready to assign Inventory objects to your Product!

Import a Software Bill of Materials (SBOM) to your Product#

You have the flexibility to employ either your CycloneDX or SPDX Software Bill of Materials (SBOMs).

Alternatively, you can conveniently download one of the provided examples from the following GitHub repository.

On the Product details page, from the Scan dropdown, select Import Packages from manifest:

  • Click the Choose file/Browse button on the Manifest file field.

  • Select your SBOM (.cdx.json or .spdx.json) and click the Open button.

  • Check the Update existing packages with discovered packages data option.

  • Click the Import Packages button.

DejaCode presents the Imports tab. Refresh your screen from the browser to see the status of your import.

View your import results in the Inventory tab.

Note

Continue assigning packages to your Product as required.

Assign Packages to your Product#

From the Manage dropdown, select Packages:

  • Click the Add Package to Product button.

  • Enter the start of a package identifier, for example diagrams and select package diagrams-0.12.0.tar.gz. DejaCode gets the license mit from the package definition.

  • Click the Save button.

You can see the results by selecting the Inventory tab.

Select Packages from the main menu bar.

  • Locate one or more packages to be used in your Product.

  • Use the checkbox on the left to select your package(s).

  • Select the Product option from the Add to dropdown.

  • Select your product from the dropdown list.

  • Click the Add to Product button.

View your results in the Inventory tab.

Note

Continue assigning packages to your Product as required.

Review your progress#

Click the Attribution button:

  • Accept all the default attribution configuration settings.

  • Scroll down and click the Generate Attribution.

  • Explore the attribution document that DejaCode presents to you.

  • Save the document to your local file system using your browser File Save command.

Select Reports from the Tools dropdown:

  • Select an appropriate report such as 2-Product Package Analysis.

  • Enter your product Name and Version and click Rerun Report.

  • Explore the results that DejaCode presents to you.

  • Export the report to your local file system using the Export button.

Check for New Versions of your Product Packages#

Select Products from the main menu bar.

Click the Product name of the Product you are defining to open it.

From the Manage dropdown, select Check for new Package versions: New Package Versions are displayed on the Inventory tab. You can click on new versions and add them to DejaCode from the PurlDB.

Assign Catalog Components to your Product#

Select Products from the main menu bar.

Click the Product name of the Product you are defining to open it.

From the Manage dropdown, select Components:

  • Click the Add Component to Product button.

  • Enter the start of a Component, for example log and select a version of component Apache Log4J. DejaCode gets the license apache-2.0 from the component definition.

  • Click the Save button.

You can see the results by selecting the Inventory tab.

Select Components from the main menu bar.

  • Locate one or more components to be used in your Product.

  • Use the checkbox on the left to select your package(s).

  • Select the Product option from the Add to dropdown.

  • Select your product from the dropdown list.

  • Click the Add to Product button.

View your results in the Inventory tab.

Note

Continue assigning components to your Product as required.

Review your impact#

Click the Attribution button:

  • Accept all the default attribution configuration settings.

  • Scroll down and click the Generate Attribution.

  • Explore the attribution document that DejaCode presents to you.

  • Save the document to your local file system using your browser File Save command.

Select Reports from the Tools dropdown:

  • Select an appropriate report such as 2-Product Component Analysis.

  • Enter your product Name and Version and click Rerun Report.

  • Explore the results that DejaCode presents to you.

  • Export the report to your local file system using the Export button.

Assign Custom Components to your Product#

Select Products from the main menu bar.

Click the Product name of the Product you are defining to open it.

From the Manage dropdown, select Add custom Component: Enter the data fields that define your custom Component. * Click the Save button. Your results are displayed on the Inventory tab.

Click the Attribution button:

  • Accept all the default attribution configuration settings.

  • Scroll down and click the Generate Attribution.

  • Explore the attribution document that DejaCode presents to you.

  • Save the document to your local file system using your browser File Save command.

Select Reports from the Tools dropdown:

  • Select an appropriate report such as 2-Product Custom Component Analysis.

  • Enter your product Name and Version and click Rerun Report.

  • Explore the results that DejaCode presents to you.

  • Export the report to your local file system using the Export button.

Review the Licenses that Impact your Product#

Select Products from the main menu bar.

Click the Product name of the Product you are defining to open it.

From the Manage dropdown, select License Summary: Your Product Licenses are displayed on the License summary form. DejaCode displays the Usage Policy and all the Items for each License. Export the License summary by clicking the button Export as CSV.

Assign Everything Else to your Product#

Continue refining and reviewing your product.

In Tutorial 2 - Working with Packages, we’ll explore Packages in greater detail!