Script-Typicals: Basics
In Script-Typicals, you organize scripts that are to be executed by the EPLAN Platform after the project documentation has been generated in the Project Builder.
- Status: Define whether a script should be executed.
- Script: Look at the preview of the uploaded script content. It is not possible to edit scripts in the Designer.
- Parameters: Define the script parameters. The parameter values are either fixed contents or are designed by using configuration variables as well as formulas.
- References: Look at the usage points of a script.
General requirements for the use of scripts
- You have started the EPLAN Platform.
- You have signed in to EPLAN Cloud.
- You have signed into an organization.
- You have opened the Designer.
- You have opened a library.
In eBUILD, scripts can be used only if they have the attribute
Example: Simple script without parameters
public class <MyeBUILDScript>
{
[Start]
public void <FunctionName>(string ProjectName)
{
//<Enter your code text here>
return;
}
}
Furthermore, scripts with additional parameters can also be used in eBUILD. All existing script parameters, with the exception of the default parameter
Example: Simple script with parameters
public class <MyeBUILDScript>
{
[Start]
public void <FunctionName>(string ProjectName, string Para1, string Para2)
{
//<Enter your code text here>
return;
}
}
The parameters
Note
- The necessity to assign a value depends on the content of the script that is used and cannot be determined in eBUILD itself.
- The use of multiple script parameters with the same name is technically not allowed and is prevented by the Designer.
- An automatic readout of possibly existing script parameters is technically not possible. Script parameters must be created manually by the editor of the Script-Typical in the Designer in accordance with the stored script. Parameters that have already been created are not corrected when the script is updated via Replace. They must be adjusted if necessary.