Build plan: An ordered list of steps that the program will execute in a model build run.
Build step: Perform an action on the input OneLiner file to create the output OneLiner file and report completion status of: Success, Warning or Error. A log file with relevant details is created in every build step.
Build action – Open: Make the selected OneLiner file available as the input for the next build step. This action must be the first step in any build plan.
Build action – Apply: Apply the specified change file to the OneLiner file from the previous build step and the changed OneLiner file available as the input for the next build step. All the OneLiner change file formats: CHF, ADX and PJX are supported in this action.
Build action – Run: Execute a Python script program. The following command line parameters will be included when the script is launched:
-olxpath
“ASPENAPI.DLL_PATHNAME“
-fseed “SEED_OLR_CASE_PATHNAME“
-fi
“INPUT_OLR_CASE_PATHNAME“
-fo “OUTPUT_OLR_CASE_PATHNAME“
-flog
“LOG_FILE_PATH“
The script must generate the following two output files:
1. The output OneLiner case, with the pathname specified in the -fo command line parameter. The Model Builder tool will use this file as the input in the next build step.
2. The log file, with pathname specified in the -flog command line parameter. The log must be an XML format file with <ASPENOLX> as the root element and the <BUILDRESULT> element having the following required attributes:
a. ASPENOLX: as the root element
b. BUILDRESULT element having the required attribute of STATUS, which must have one of these values: OK, WARNING, ERROR
c. LOG element that contains the text to be displayed in the Model Builder log view.
The following is an example of the
Run build action log file:
<?xml version="1.0" encoding="UTF-8"?>
<ASPENOLX>
<BUILDRESULT STATUS="WARNING">
<LOG>Line missing length: [LINE] 1 'GLEN LYN' 132 kV-2 'CLAYTOR' 132 kV 1</LOG>
</BUILDRESULT>
</ASPENOLX>
Build action – Output: Copy and rename the output OneLiner model from the last step in the build plan to the specified output path name.
Work folder: The disk folder, where all the files in the model build are stored. That include the Build plan file (.ambx), the seed case, input and output files for each build step and all the log files.
Study horizon: an optional build plan attribute to indicate the desired time horizon of the studies in which the model will be applied. The Model builder tool will check the date against project-in-service-date and project-out-of-service date attributes of the change file in every Apply action
Scope group: Each scope group is an user-defined combination of area numbers, zones numbers and owner IDs having a unique name. User can assign any number of scope group to any Apply build action. The Model Builder tool will check the build step output change log and generate a report when not all OneLiner network objects that are added, deleted or modified in the build step are inside the specified scopes.