Skip to main content
Version: Next

Command Line Usage

To automate your data workflows, ImportDocs has a console version: ImportDocsConsole.exe.

Location​

The executable is located in the same folder as the graphical version, typically: C:\Avanteam\Solution\PStudio.Administration\ImportDocsConsole.exe

Usage​

To see all available options, run the following command in a terminal:

ImportDocsConsole.exe /help

Required Parameters​

  1. Profile Name: The name of the Avanteam application (e.g.: "DEMO").
  2. Project Name: The name of the configuration you created and saved via ImportDocs.exe.

Example Command​

To launch the import of the "Import Factures" project on the "GEC" application:

ImportDocsConsole.exe "GEC" "Import Factures"

Optional Parameters​

  • [filepath]: You can pass a file path as the third argument to override the one defined in the saved project.
  • --archive: Moves the source file to an archive folder once the import is successful.
  • --range:X-Y: Limits the import to rows from X to Y.
ImportDocsConsole.exe "GEC" "Import Factures" "C:\Imports\Facture_2023_10_12.csv" --archive

It's common to use ImportDocsConsole.exe coupled with the Windows Task Scheduler for regular imports (for example every night).

Best Practice

When automating, make sure the user executing the scheduled task has access to network resources if source files are on a remote share.