obtain_NLMELicense {Certara.RsNLME} | R Documentation |
Obtain NLME License
Description
This function attempts to authenticate and obtain an NLME license using the specified installation directory and licensing tool.
Usage
obtain_NLMELicense(
InstallDir = Sys.getenv("INSTALLDIR"),
ForceAuth = FALSE,
ForceLicenseGet = FALSE,
verbose = getOption("verbose")
)
Arguments
InstallDir |
A character string specifying the directory
where the NLME Engine is installed e.g., |
ForceAuth |
A logical value indicating whether to force
re-authentication even if already authenticated. Default is |
ForceLicenseGet |
A logical value indicating whether to force obtaining
the license even if already licensed. Default is |
verbose |
A logical value indicating whether to print verbose output.
Default is |
Details
This function checks for the presence of the necessary
appsettings.json
file as indicated by the CAD_CONFIG_FILE
environment variable,
runs the licensing tool to authenticate the user, and attempts to obtain
an NLME license. It prints detailed messages if the verbose
parameter is set to TRUE
.
Value
A logical value indicating whether the license was successfully obtained.
Examples
result <- obtain_NLMELicense("C:/Program Files/Certara/NLME_Engine", verbose = TRUE)
if (result) {
message("License obtained successfully!")
} else {
message("Failed to obtain license.")
}