Use the vendor agent

Once installed, use the vendor agent to analyze and submit files to the aDolus system.

  1. Launch the command line interface to run the vendor agent.
  2. Use the following commands to analyze and submit your files to the aDolus system.
    In the code samples provided, you will need to make the following replacements:
      • [install path] is the location on your system that you extracted the vendor agent files to.
      • [file path] is the name and location of the file you want to analyze or submit.
      • [folder path] is the name and location of the folder whose files you want to analyze or submit.
      • [results .json file path] is the location and file on your system you want to save the JSON analysis results to.
      • [results folder path] is the location on your system you want to save the JSON analysis results file(s) to.

    Replace other file and directory placeholders as appropriate for your system and content.

Analyze a single product file and produce an analysis results JSON file

[install path]> .\Adolus.Sta.Agent.exe analyze -f "[file path]" -s "[results .json file path]"

Analyze all product files within a folder and produce a collection of analysis results JSON files

[install path]> .\Adolus.Sta.Agent.exe analyze -d "[folder path]" -s "[results folder path]"

 Note

You can easily read the analysis results JSON files before submitting them to the aDolus system. This allows you to clearly see the information gathered, which will be viewable in the web portal.

Submit an analysis results JSON file to the aDolus API

[install path]> .\Adolus.Sta.Agent.exe submit-product -f "[results .json file path]"

Submit all analysis results JSON files within a folder to the aDolus API

[install path]> .\Adolus.Sta.Agent.exe submit-product -d "[results folder path]"

Files successfully submitted with the submit-product action appear on the Product Files page in the web portal. Products submitted via the vendor agent are assigned the version status Supported by default.

 Important

To authenticate with the aDolus system, you must grant the vendor agent permission to act on behalf of your user account.

The first time you use the Vendor Agent to submit file analysis results (submit-product command), your default browser will be launched to the aDolus sign-in page. Signing in authenticates the user running this instance of the agent, which grants the agent the necessary permissions. The agent stores a token for subsequent use and proceeds with the requested submission command.

Your credentials are not stored on the system running the agent. Instead, a revocable token is issued and stored in the Windows Credential Manager. You can view and manage your issued tokens on the Agent Authentication page.

You can also use the vendor agent to submit any binary file to aDolus for analysis by our cloud-based tools. This is useful for analyzing files that have been produced by other organizations, as the files will not be marked as owned by your organization. This is the equivalent of using the Submit Files action in the web portal.

Submit a single file to the aDolus API

[install path]> .\Adolus.Sta.Agent.exe submit-file -f "[file path]"

Submit all files within a folder to the aDolus API

[install path]> .\Adolus.Sta.Agent.exe submit-file -d "[folder path]"

Files successfully submitted with the submit-file action appear on the Files page in the web portal.

For details on viewing your submitted files in the aDolus web portal, see the article View your submissions.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.