Command line parameters

[arnoud]

The following optional command line parameters are supported:

• -partner <partnercode> (default is none or for ScanCircle app: previously selected partner)
  
• -reference <refcode>
  
• -language <langcode> (2-character language as supported by the ScanCircle website, e.g. en/nl/de/fr/es/it/pl/ee, default is current system setting or for ScanCircle app: previously selected language)
  
• -scanmode D|A|M|P (direct, automatic, manual, partner, default=A, direct is same as automatic but starts automatically so user doe not need to hit the Start button)
  
• -hidden (only performs the scan, no user interface)
  
• -nocopy (does not send a notification to the partner)
  
• -skip <nodes> (skip the indicated XML nodes, separated by semi-colons, join nodes below 'scan' using a period): intended and supported for security.status.uac (but may work with other nodes)
  
• -save [<path>] (save the scan file, if <path> is a directory or missing, the file name is <computername>-<volumeid>.xml in the specified or current directory)
  
• -output <path> (write the advice URL or error message to the specified file path)
  

This syntax is also shown when starting the scan program with incorrect parameters, e.g. scancircle.exe ?

The resulting advice URL is echoed to standard output (only visible if standard output is redirected) or to the specified output file path.

There are 2 versions of the portable scan program: .NET Framework 4 version (default for Windows 8+) or .NET Framework 2 version (default for older Windows versions). Please note that if you plan to run this on the client's computer, you need a way to update the scan program when a new version becomes available. Example (PARTNER = partner code, REF = reference code, LL = language code):

ScanCircle4.exe -partner PARTNER -reference REF -language LL -hidden -output %temp%\scancircle.txt

Otherwise use the ScanCircle app if installed. The carrot (^) is to escape the ampersand (&), otherwise it would be interpreted as a separator for multiple commands:

start scancircle://?partner=PARTNER^&reference=REF^&language=LL^&hidden^&output=%temp%\scancircle.txt

*** The following option does not yet work correctly in all situations ***
If you are not sure if the ScanCircle app is installed, you can use the following link (e.g. in emails to your customers), which will run the ScanCircle app if installed or redirect the user to your own scan page or the scan page in your ScanCircle partner environment (the language code and reference code are optional, other parameters are not supported, if your own scan page uses a URL parameter for the input field, it must be named "reference"):

https://app.scancircle.com[/LL]/PARTNER[/REF]

Also see this post about passing parameters in the scan program file name (used when downloading in browsers).

[arnoud]

In release 1.14 the parameters -manual and -autorun are replaced by -scanmode M resp D, but will be supported for a while longer.

[arnoud]

In release 1.42, the -skip option is added (mainly to skip the UAC check for scans run by the System user).

[arnoud]

In release 1.99 the Windows 10 app is added.

[arnoud]

In release 2.0, the -output parameter is added (because standard output does not work with the ScanCircle app)

[automatex]

I'd like to create a powershell script that will check if the ScanCircle app is installed. If not get it from the Windows store. If it is installed, see if there is an update before running ScanCircle.
In this, I have trouble finding the ScanCicle appx package name to do this as it seems "ScanCirle" is not doing it.
Also search in in Get-AppxPackage did not bring ScanCircle.
Can you provide this?

[arnoud]

We have had contact by email and it seems that "scancircle" (lowercase) is the correct package name. The version number could not yet be retrieved, but is shown in the Microsoft Store UI. If the script is finished, automatex will share it here. BTW, in ScanCircle release 2.8, the version number of the scan program is still 2.7.0.0 as it has not changed.