CheckProjectsVersion

When updating ABBYY FlexiCapture 12, all document processing needs to be stopped. After updating ABBYY FlexiCapture 12, all the projects on the server must also be updated. Updating all of the projects may take a significant amount of time. However, document processing can be resumed even before all of the projects have been updated – the system will ignore any processing jobs in projects that have not yet been updated.

You can use the CheckProjectsVersion command to get information about the projects that have not yet been updated. Depending on the parameters you specify, running this command will display the following information:

  • The current version of the product – if no parameters are specified.
  • The number of projects on the server that need to be updated.
  • The projects that need to be updated.
  • The version of the product that was used to create a specific project.

Parameters:

/Project Optional

Specifies a project.
A project can be specified in any of the following ways:

  • Full local path to the project.
  • Path to the project on the server.
  • Name of the project on the server (this requires the /Server parameter to be specified).
    If a project is specified, the product version that was used to create it will be returned.
/Server Optional

Server address.

If a server is specified but no value for the /ListProjects flag is specified, the number of projects with earlier versions on the server will be returned.

/U Optional User name.
If this parameter is not specified, Windows authentication will be used.
/P Optional User password.
/Tenant Optional Tenant name.
/ListProjects Flag

If this parameter is specified, a list of projects on the server that need to be updated will be returned in the following format: <Tenant>  <Project Name> <Project Id in the Database> <Current project version>.

<Current project version> can be specified as:

  • Older
  • Newer
  • Unknown
  • Version number (if the version corresponds to the version specified in the version table in the database).

Note: If the /ListProjects flag is specified, the name of the default tenant need not be specified.

Note:   To get information about a project in a tenant, the tenant administrator credentials must be specified in the /U and /P parameters. The link to the project must be specified without the tenant name.

Example of use:

CheckProjectsVersion – Displays the current product version.

/CheckProjectsVersion /Server="https://FCSRV" /ListProjects – Displays the projects that have not been updated, together with their versions.

/CheckProjectsVersion /Server="https://FCSRV" /Project="IdProject” – Displays the version of the product that was used to create the project.

/CheckProjectsVersion /Project="https://FCSRV/idProject" /Tenant=tenant /U=admin /P=password – Displays the version of the product that was used to create the given project in the given tenant.

10.11.2020 12:08:03


Please leave your feedback about this article