Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Table of Contents

Supported File Extensions

For a complete list of supported file extensions (binary files, source files, and archive files) that the Unified Agent supports, refer here.

Selecting a Plugin for Integration

Info

WhiteSource recommends using the Unified Agent.

...

Analyzing Archives Files

If you have Java/Ruby/Python archive files and you are willing to open them and extract descriptive information, then you can use this feature by providing values for the following parameters:

  • archiveExtractionDepth 
  • archiveIncludes 
  • archiveExcludes

The drill-down hierarchy is limited to a maximum of 10 and can be modified in the configuration file.
By default, the drill-down hierarchy level is zero - no drill down.
Supported archive types are as follows:

  • aar
  • car
  • ear
  • egg
  • gem
  • hpi
  • jar
  • nupkg
  • rar
  • rpm
  • sca
  • sda
  • tar
  • tar.bz2
  • tar.gz
  • tar.xz
  • tgz
  • war
  • whl
  • xz
  • zip

NOTES:

...


Table of Contents

Supported File Extensions

For a complete list of supported file extensions (binary files, source files, and archive files) that the Unified Agent supports, refer here.

Selecting a Plugin for Integration

Info

WhiteSource recommends using the Unified Agent.


Analyzing Archives Files

If you have Java/Ruby/Python archive files and you are willing to open them and extract descriptive information, then you can use this feature by providing values for the following parameters:

  • archiveExtractionDepth 
  • archiveIncludes 
  • archiveExcludes

The drill-down hierarchy is limited to a maximum of 10 and can be modified in the configuration file.
By default, the drill-down hierarchy level is zero - no drill down.
Supported archive types are as follows:

  • aar
  • car
  • ear
  • egg
  • gem
  • hpi
  • jar
  • nupkg
  • rar
  • rpm
  • sca
  • sda
  • tar
  • tar.bz2
  • tar.gz
  • tar.xz
  • tgz
  • war
  • whl
  • xz
  • zip

NOTES:

  • In case of Ruby .gem files, only the data.tar.gz file is extracted, and all the other content files are ignored.
  • In Ruby, one hierarchy level is defined to extract Ruby's .gem and data.tar.gz files.

Providing a Project Name Only in a Unified Agent Scan

Overview and Default Behavior

If a scanned project uses a configuration file that contains only a defined 'projectName' (where 'projectToken’, ‘productName’ and ‘productToken’ are left empty), then the Unified Agent adds the results to the first project it finds in the organization that contains the same project name.
If a multi-module project is scanned with the same configuration as described above, and a project with one of the module names already exists, then the Unified Agent adds the module data to this existing project.


Code Block
titleExample: Only 'projectName' is defined and 'projectToken’, ‘productName’ and ‘productToken’ are left empty
projectName=NewProject
projectToken=
 
productName=
productToken=

Changing the Default Behavior

In order to avoid overriding an existing project with the same name, from the Advanced Settings section of the Integrate page, select the checkbox Add project to default product when only project name is provided.

When this checkbox is selected, the following rules apply to all future scans:

  • When only 'projectName' is provided in the Unified Agent configuration (as demonstrated in the above example), the Unified Agent adds the project to a default product named 'My Product'. This rule is implemented only when the default product 'My Product' does not already contain a project with the same name.
  • If the default product 'My Product' already contains a project with the name specified in the 'projectName' parameter, then the Unified Agent returns an error to the user with the message "Project <PROJECT_NAME>' already exists in 'My Product'. A 'productToken' or 'productName' value should also be specified".
  • If a multi-module project is scanned, and a project with one of the module names already exists under your product, an error is returned and none of the projects are created as part of the scan.

Configuration Recommended Mode

...