DownloadProject

To archive a project or to transfer it to another environment, you must first download it into your file system using the DownloadProject command, which allows you to download projects together with any required working or training batches. By default, the DownloadProject command will download a project without any working batches but with all the training batches (no images will be downloaded, however). You can use additional command parameters to select which batches to download. The types of the downloaded batches will be preserved and they will be saved to their respective folders. To upload a project to the server, use the UploadProject command.

Parameters

Parameter	Type	Description
`/Source`	Optional	The path to a project on the local machine or on a server. If you specify a server but specify no project, all the projects available on the server are downloaded.
`/Target`	Optional	The local directory where the project is saved. If multiple projects are downloaded, multiple subdirectories are created in this directory, one for each project.
`/Server`	Optional	The server with the projects that you want to download.
`/Tenant`	Optional	Tenant name.
`/U`	Optional	User name. If no user name is specified, Windows authentication is used.
`/P`	Optional	Password.
`/Cert`	Optional	Certificate thumbprint used for mutual SSL authentication. This key is used to pass an encoded certificate hash for a server with Mutual SSL installed as a string.
`/CopyTrainingBatches`	Optional	Downloads training batches. The parameters may have any of the following values: `All` downloads all the training batches; `LayoutOnly` downloads all the field extraction training batches; `ClassifierOnly` downloads all the classifier training batches; `None` downloads only those training batches specified in the `/BatchIds` parameter (if any), otherwise no training batches are downloaded. The default value is `All`.
`/CopyBatches`	Flag	Downloads all the working batches regardless of the batch IDs specified in the `/BatchIds` parameter. The working batches are downloaded together with their images.
`/CopyTrainingSamples`	Flag	Downloads the contents of the training batches.
`/BatchIds`	Optional	The IDs of the batches to be downloaded.

To download only specific working or training batches, specify their ID in the /BatchIds parameter. If the /BatchesIds parameter is used in conjunction with the /CopyBatches or /CopyTrainingBatches parameter, all the working or training batches with the specified values are downloaded, regardless of the IDs specified in the /BatchIds parameter.

Example of use

DownloadProject /Source="https://FCSRV/1/SingleEntryPoint" /Target=D:\Projects /CopyTrainingBatches=none /BatchIds=1,2,3 /U=user /P=password – Downloads a project with the specified batches (training and classifier batches are downloaded without their images).
DownloadProject /Source="https://FCSRV/1/SingleEntryPoint" /Target=D:\Projects /CopyTrainingBatches=none /BatchIds=1,2,3 /CopyTrainingSamples /U=user /P=password – Downloads a project with the specified batches (training and classifier batches are downloaded together with their images).
DownloadProject /Server=https://FCSRV /Target=D:\Projects /CopyTrainingBatches=LayoutOnly /BatchIds=2,3,7954 /U=user /P=password – Downloads a project with all the field extraction training batches (without their images) and with the specified working or classifier batches.
DownloadProject /Source="https://FCSRV/1/SingleEntryPoint" /Target=D:\Projects /CopyTrainingBatches=All /CopyTrainingSamples /U=user /P=password – Downloads a project with all the training batches (together with their images).

Administrator's Guide

Administration Guide

Performance Guide

Troubleshooting

Cloud

Parameters

Example of use

​Parameters

​Example of use

Parameters

Example of use