Configuring Auto-WriteUp™

FlexNet Code Insight 6.13.2

Auto-WriteUp™ configuration is stored in the following location on the FlexNet Code Insight Core Server:

<code_insight_install_dir>/config/core/Auto-WriteUp.properties

The following properties are supported:

Name

Value

groupOptions

A comma-separated list of any of the following options (including no options):

DO_VER
DO_ENV
SET_PRI
REF_PARENT_VER

maxHeaders

<integer>

useShortText

true/false

autoPublish

ALL_GROUPS/CODE_INSIGHT_GROUPS/COMPLETE_GROUPS

userRules

A comma separated list of file names or <no value>.

Important • Contact Flexera Software Support (https://flexeracommunity.force.com/customer/CCContactSupport) before editing the configuration file. Incorrect values may result in errors and a failed scan.

Property Definitions

The following are property definitions for Auto-WriteUp’s supported properties.

Property

Description

groupOptions

(comma separated list)

SET_PRI

Automatically assign priorities to groups created by Auto-WriteUp™. The following priorities are supported based on the license or set of licenses associated with the group:

P1: Known copyleft OSS licenses (such as GPL, LGPL, MPL).
P2: Unknown, proprietary, commercial, or modified licenses.
P3: Known permissive OSS licenses (such as Apache, MIT, BSD).

DO_VER

Create groups based on the component, version, and license of detected OSS content. When this option is omitted, Auto-WriteUp™ will group files based on the component and license only.

DO_ENV

Create separate groups for envelope issues.

Envelope issues (also known as embedded issues) are separate third- party content inside a parent component. Typically the third- party component is compiled, packaged, or copied inside the parent component (not to be confused with static or dynamic dependency linking). Envelope issues can be especially important if the third- party component is licensed differently than the parent component.

REF_PARENT_VER

Explicitly reference the version of the parent group when creating envelope groups. This option has no effect if the DO_ENV or the DO_VER options are omitted.

maxHeaders

(integer, default: 3)

The maximum number of headers to use when providing evidence for a specific license text in the As-Found-License-Text field of a group in the FlexNet Code Insight Detector Client. Typically, a single header refers to a URL or a file in the scanned code base.

useShortText

(true/false, default: true)

Specifies whether to use a short sample of the license text instead of the full license text when populating the As-Found-License-Text field of a group in the FlexNet Code Insight Detector Client.

autoPublish

(ALL_GROUPS/FlexNet Code Insight_GROUPS/COMPLETE_GROUPS, default: COMPLETE_GROUPS)

Specifies which groups will be published if the Auto-Publish System-Detected Inventory is enabled in the Project Details.

ALL_GROUPS

Publish all groups created by Auto-WriteUp.

FlexNet Code Insight_GROUPS

Publish all groups created by FlexNet Code Insight Rules.

COMPLETE_GROUPS

Publish any groups which contain licensing information (all groups created by FlexNet Code Insight Rules and a portion of groups created by auto-generated High-Volume Rules will contain licensing information).

userRules

(comma separated list)

A list of file names indicating which user-specified detection rules to load before scanning. This property may be left blank if no user-specified rules are present.

User-specified detection rules are saved in Microsoft® Excel® workbooks to the following directory on the FlexNet Code Insight Core Server:

<Code_Insight_install_dir>/config/core/rules/