Automated building, deploying and/or verifying of libraries
Neuron Power Engineer provides a tool for the automated building (=generation) and deployment of a library. This tool can also be used to verify the state of the library.
Good to know |
---|
The tool is intended for usage by an experienced user of Neuron Power Engineer. A condition for the successful usage of the tool is the knowledge of the action to be executed as it would be executed in the graphical user interface of Neuron Power Engineer. The output of the tool is in English only. |
In this article: |
---|
Preparation
-
Make sure that Neuron Power Engineer is installed. Have the following information prepared:
-
The path to the Neuron Power Engineer installation directory
-
The path to a directory that will be used as the workspace
In case the directory does not exist, the tool creates it. If the optional parameter-checkEmptyWorkspace
is used (see the description of this parameter below), the directory must be empty. -
The information for the libraries that should be built, deployed and/or verified
-
The path to the log configuration file (see below for more information)
A sample configuration file is included in the installation of Neuron Power Engineer.
-
-
Open a command line: e.g.
cmd.exe
under Windows and navigate to the Neuron Power Engineer installation directory.
Invocation
Parameters that are placed within []
are optional. That means, if you skip the parameter, the default behavior is applied (see below under "Description of parameters"). When you want to use the parameter, do not enter the character [
and ]
(see the below examples).
Invocation for automated building
|
Invocation for automated deploying
|
Invocation for automated verification
This verification checks whether the contents of the library have changed since it was created by redetermining the contents of the library files index.idx
and index.md5
and comparing them with the rest of the library contents.
|
Combined invocation
It is possible to order the parameters as you like them. The best practice is to use the following order.
|
Invoking the tool under Linux is not officially supported. However, if you want to try invoking the tool under Linux nevertheless, replace the part NeuronPowerEngineerc --launcher.ini NeuronPowerEngineer.ini -application
of the above-mentioned invocation by NeuronPowerEngineer3 -application
. The remaining part of the invocation is identical to the above-mentioned invocation.
Description of parameters:
Parameter |
Description |
Example |
||||||
---|---|---|---|---|---|---|---|---|
|
library to be build or deployed, as it is declared within the library configuration (specified by the parameter It is only possible to deploy a library, if this library has already been built (= generated). In case of a combined invocation, the building is automatically done before the deploying. |
|
||||||
|
absolute path to a folder to which the library should be deployed By default, the following subfolder is specified for a library provider.
|
|
||||||
|
name (incl. path and extension) of the library to be verified This parameter might be the default path within a Neuron Power Engineer project where the library has already been generated. But it is also possible to specify a different path – in this case the path must contain the library. |
|
||||||
|
absolute path to the project |
|
||||||
|
the library configuration which declares the libraries to be build or deployed Mind the following (see the example to the right):
|
|
||||||
|
absolute path to a workspace to which the project should be imported
|
|
||||||
|
path to the log configuration file |
|
|
Example for combined invocation: Building and deploying all libraries of a library configuration |
---|
|
Example for combined invocation: Building, deploying and verifying a specific library |
---|
|
Log configuration file
This file is needed to configure the log4j logging mechanism. The file specifies how log events are output.
Sample log configuration file |
---|
|
Troubleshooting
The file that is specified in the log configuration file contains information about the building, deploying and verification. If the building, deploying or verification has not been successful, fix the problem according to the following table.
Return code |
Message |
Cause |
Solution |
---|---|---|---|
|
|
|
|
|
|
An argument or parameter is missing. |
Invoke the tool as specified above. |
|
|
The specified project does not exist. |
Specify an existing project. Or invoke the tool with the absolute path for the project. |
|
|
The workspace already contains data (e.g. one or more Neuron Power Engineer projects). |
Use an empty workspace or remove all existing data from the current one. |
|
|
The library to be verified is corrupted. |
Invoke the tool for a library that has been correctly built and deployed. |
|
|
The library could not be built. |
Check, if there are additional messages detailing the error cause. Depending on these details: Open the project in Neuron Power Engineer and fix the errors displayed in the Problems view. Invoke the tool as specified above. |
|
|
The library could not be deployed. |
Check the previous messages for error causes. Depending on these details: Open the project in Neuron Power Engineer and fix the errors displayed in the Problems view. Invoke the tool as specified above. Make sure that the library has already been built. |
|
|
An unexpected error has occurred. |
Contact Neuron. |
The following messages might detail the error cause why the library could not be built:
-
Could not find a library with name and version: name
-
Could not find the library definition file: name
-
Model rule checking failed
You might want to use the tool for automated rule checking before building the library in order to make sure that the library objects are not violating any rules.