This functionality is only available for certain module packages. Info / Copyright

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.

  1. Status: Define whether a script should be executed.
  2. Script: Look at the preview of the uploaded script content. It is not possible to edit scripts in the Designer.
  3. Parameters: Define the script parameters. The parameter values are either fixed contents or are designed by using configuration variables as well as formulas.
  4. References: Look at the usage points of a script.

ClosedGeneral 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 [Start] and at least the parameter ProjectName. The parameter ProjectName is automatically transferred by the generator and does not have to be defined as a script parameter in the Designer.

ClosedExample: 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 ProjectName must be defined in the Designer under Script-Typicals in the Parameter drop-down list.

ClosedExample: 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 Para1 and Para2 in the script example must be created in the Parameter drop-down list of a script in the same notation as specified by the script itself.

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.

Read more