installPlugin

Back to index

Summary

Installs a plugin from a .jar or .zip file. Extracts the .jar or .zip file contents on the server and creates a project and a plugin.
url
Stringrequired
A locator (local file path or network URL) for the plugin to install. Enclose the IPV6 address in square brackets. Example: [<IPv6-ADDRESS>].
disableProjectTracking
Booleanoptional
If set to true when importing or exporting a project, even if the original project had change tracking enabled, make change tracking of the newly imported or exported project be disabled from its creation. If you don't need to track changes to the new project, this avoids the change tracking overhead that would otherwise slow down the import operation, and also saves having to subsequently disable change tracking of the reimported project.
force
Booleanoptional
If true, install should ignore a preexisting plugin.
reducedDetailChangeHistory
Booleanoptional
Set to 0 or false to prevent importing a large project that has change tracking enabled from automatically reducing the level of detail that it tracks for the change history of the import -- this will make the import operation take longer and put more load on the database, but will allow the Change History feature to still show the full detail of entities owned by the imported project that were created by the import operation.

Usage

Perl

$cmdr->installPlugin( "test-url" # url # optionals );

ectool

ectool installPlugin \ "test-url" `# url` \ # optionals

Examples

Perl

$cmdr->installPlugin("./myPlugin.jar", {disableProjectTracking => 1})

ectool

ectool installPlugin "./myPlugin.jar" --disableProjectTracking 1