Create rules to update components across all products

To ensure that changes you make to a component in one product version is persisted throughout your product portfolio, users with Admin privileges can create specific rules for each component directly in the Rules manager, or can automatically create rules when updating the component details.

For each rule, you can set conditions around the supplier name, component name, and component version. You can then set effects that will be applied when all of the conditions are true to persist the specified Level of support and EOS/EOL (End-of-Support and End-of-Life) information across all of your products. This lifecycle information can then be exported in your FDA SBOM report.

Add rule

1. If you haven't created any rules yet, you'll see a Create rule button. Click this to switch to the Edit rules mode to begin creating your rule. If you need to add more rules later, you'll need to be in this edit mode.

2. If you already have rules, click the Add another rule button to create a new rule at the top of the list. You can rearrange the rule's priority by dragging it lower in the list.

3. For each condition, make sure that the Enabled switch is turned on (is blue).

4. Set each condition by selecting the corresponding field and comparator, then specifying the expected matching value. As you add conditions, the rule name will be automatically updated in the following format, provided that particular condition is set: [Supplier name]/[Component name]/[Version]. For version ranges, the name will reflect the conditions specified in the following format: [Supplier name]/[Component name] [less than 10.1], such as Google Chrome less than 10.1. You cannot currently edit rule names. If this is important to you, let us know!

5. Click Add version condition to add additional version conditions. Each condition uses the AND logic, so everything must be true in order to apply the effects. You can set the version as either an exact match or set conditions for a version range. For an exact match, set the version as is equal to. For version ranges, you can set the following conditions: is less than and/or is greater than. You can specify either a version exact match or up to two version conditions for a version range.

6. Set each effect below the conditions by selecting the corresponding field, comparator, then specifying the expected matching value. For Level of support and EOS/EOL (end-of-support and end-of-life) information, you can specify either is equal to date, then select a specific date, or set it as is equal to text, then provide the respective text value.

7. When you're finished adding rules, updating rules, and/or changing rule priority, click Save & apply. Note that unsaved changes will only persist during your Helm session, so make sure to save and apply anything you don't want to be discarded.

8. After you confirm these changes, Helm will begin applying them to your existing SBOMs, and will apply them to any future SBOMs.

Manage rule

1. Click the Edit rules toggle button to edit rules.

2. Make any modifications to conditions and/or effects.

3. To change rule priority, click the drag icon next to the rule name to drag it to a different position in the list. Rule priority is determined by the order of the rules in the Rules manager. If multiple rules impact a component, the one highest in the list takes precedence.

4. To delete a rule, click the Delete action. You will be prompted to confirm, but this deletion will not take effect before you click Save & apply. Deleted rules will be unapplied from existing SBOMs, and will no longer be applied to future SBOMs. You cannot recover a deleted rule. Note that if you decide to delete the only rule you have, any unsaved changes that you have made will be automatically applied and the rule will be deleted. In that case, you'll now see a blank rule, so that you can add more rules in the future.

5. When you're finished making changes, click Save & apply. Note that unsaved changes will only persist during your Helm session, so make sure to save and apply anything you don't want to be discarded.

6. After you confirm these changes, Helm will begin applying them to your existing SBOMs, and will apply them to any future SBOMs.