Automation Rules

The SBOM can have quality, completeness, accuracy, or compliance issues that require editing after generation.

To reduce toil, Interlynk supports automatic editing of the SBOM using Automation Rules.

Automation Rules can be configured uniquely for each environment. However, Interlynk supports copying rules from one environment to another.

Automation Rule

Automation Rule consists of a name, a set of conditions to match, and actions to take when those conditions are met.

The conditions and actions must apply to the same subject. The platform supports the Version or a specific Component as the subject of an Automation Rule.

Examples -

Subject

Component named log4j

Rule

When the Component Name is 'log4j' and License Expression is missing, set License Expression to 'Apache-2.0'

Subject

Version

Rule

When the Supplier Contact Name does not exist, set the Supplier Contact Name to 'Interlynk' AND Supplier Contact Email to '[e-mail]' and Supplier URL to 'https://www.interlynk.io'

Managing Rules

Creating Rule Manually

1. Click on the 'Products' side-navigation button

2. Click on the Product Name (or specific Environment icon of the Product)

3. Click on the 'Automation Rules' tab

4. Click on '+' Add Rule button

5. Enter a Rule Name

6. Select conditions to match

7. ℹ️ Once the first condition is specified, additional conditions will apply to the same subject
8. Add actions to take

9. ℹ️ Actions only apply to subjects that match the condition
10. Click 'Create' to complete

Creating Rule from Checks

1. Click on the 'Products' side-navigation button

2. Click on the Product Name (or specific Environment icon of the Product)

3. Click on the Version under 'Versions' list

4. Click on the 'Checks' tab

5. Click on the 'Fix' icon under Resolution

6. Setup the fix

7. Click on 'Save as Rule' to create an Automation Rule for this Check

Disable / Reorder Rule

1. Click on the 'Products' side-navigation button

2. Click on the Product Name (or specific Environment icon of the Product)

3. Click on the 'Automation Rules' tab

4. Toggle the 'Active' switch to disable a check

5. Select the drag handle and drag it on top of another drag handle to reorder the rules

Copy Rule to another Environment

1. Click on the 'Products' side-navigation button

2. Click on the Product Name (or specific Environment icon of the Product)

3. Click on the 'Automation Rules' tab

4. Click on Action '...'

5. Select Copy To [Other Environment Name] to Copy the rule

Disable Automation

1. Click on the 'Products' side-navigation button

2. Click on the Product Name (or specific Environment icon of the Product)

3. Click on the 'Settings' tab

4. Toggle the 'Automation' switch to disable applying Automation Rules

5. ℹ️ These settings are specific to the Environment, and to disable all Environments, you must switch to each one and disable Automation

Rules Library

The Platform ships with a library of rules that help set up the most common tasks, such as copying the Author's Name to the Supplier's Name.

These rules are disabled by default.

Applying Rules

Automatic Run

Automation Rules are always applied at the point of SBOM import. All changes resulting from Automation Rules are logged under SBOM's Change Log.

Manual Run

Manual Automation Run

1. Navigate to the Product Environment page
2. Click on the 'Versions' tab

3. Click on the '...' (Actions) for the desired version

4. Select 'Run Automation'