SetEnvironmentVariable

You can use an environment variable to specify a general setting for a project. You can use the SetEnvironmentVariable command to create such an environment variable. If an environment variable with the name you specify already exists, the command will change its value and description; otherwise, a new environment variable will be created.

Note: You cannot change the type of an existing environment variable. If you specify a different type for an existing environment variable, the command will return an error.

Parameters

/Project

Optional

Specifies a project.

You can specify any of the following:

  • the full path to a local project
  • the path to a project on a server
  • the name of a project on a server (the /Server parameter must be specified)

If no project is specified, the command will process all the projects on the server.

/Name Optional Environment variable name.
/Value Optional

Environment variable value.

If it is not set, it is processed as an empty line.

/Type Optional

Environment variable type.

Possible values are String and ADOConnectionString. By default, this parameter is set to String.

/Description Optional Environment variable description.
/Server Optional Server address.
/Tenant Optional Tenant name.
/U Optional

User name.

If no user name is specified, Windows authentication will be 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.

Example of use:

SetEnvironmentVariable /Project="D:\Banking_eng" /Name="ImportPath" /Value="D:\123" – For a local project.

SetEnvironmentVariable /Project="https://localhost/1" /Name="ImportPath" /Value="D:\123" – For a project on a server.

11/15/2022 10:12:44 AM

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.