Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Scripts under the Project Library (called "Project Scripts") are a project-based resource that allows user created Python scripts to be configured. Objects and functions created in a project script can be called from anywhere in the project. Project Scripts are accessible from the Project Browser, under the Scripting item.

Additionally, a single project can be designated as the Gateway Scripting Project, meaning that scripts defined in the stated project can be called from the Gateway scope. 


Add a Script

To add a a project script, simply right click the Project Library item and click the New Script option.

Scripts and Packages

There are two main types of resources under the Project Library.

  • Scripts - Each script resource can contain many functions and objects.
  • Packages - Each Package effectively acts as a folder, allowing you to better organize each script resource.  

Usage Example

For example, let's suppose you added the following script module named myFuncs, whose body is shown below.

Code Block
def hello():
	return "Hi there!"

Once we save our project, we can now call this function from anywhere within the project using the following syntax

Code Block
titlePython - Calling the Project Script
titleDon't Forget to Save

Project scripts are not accessible to the other resources until the project is saved.

For example, we could open the Script Console (Tools menu > Script Console), write the following, and execute the script.

Each script resource can contain multiple functions and objects. Note that as you add new function definitions, the list on the right will populate, allowing you a quick way to navigate through long scripts. 

Project Libraries and Execution

Because Python is a dynamic language, any code inside of a project library must be run to build the function and class definitions. This is a common behavior across interpreters. Within Ignition, these project libraries will run under certain conditions. For example, such as when the Script Console in the Designer starts up, if changes are made to third-party libraries inside of the gateway's installation directory, when saving changes to these project libraries, and several other conditions. 

When this occurs, code inside of a project library is executed. Meaning classes and functions are defined, and any code that is not contained within either a class or function will execute. 

Because of this process, it's generally recommended that all code within a project library is wrapped inside of a function or class definition. 

Gateway Scripting Project

Project scripts are normally only accessible from the project they were defined in. Thus objects that exist in other scopes, such as Tags that exist in the Gateway scope, are unable to call project scripts. Attempting to do so will result in Gateway log errors stating that "global name 'yourScript' is not defined'.

The exception to this rule is the Gateway Scripting Project. This project is specified by the Gateway Scripting Project property, which is set in the Config section of the Gateway Webpage under Gateway Settings. Entering in the name of a project under this property allows the Gateway access to project scripts configured in the specified project. 

Thus, if the myFuncs library in the prior section was configured in a project named "Tester"

We could use that name in the Gateway Scripting Project.

After we save, Tags and other Gateway-scoped resources can then start calling any of the scripts from our project library in the "Tester" project. 

titleExpand for an example...


This example demonstrates how to call scripts in your Gateway Scripting Project from a Tag.

  1. Set up your Gateway Scripting Project under Config > Gateway Settings:
    Image Modified

  2. Open your Gateway Scripting Project and add a library called myFuncs.
  3. Define a new function in this library called thankYou:

    Code Block
    def thankYou(user):
    	system.gui.messageBox("Thanks for noticing me, " + user)
  4. Save your Gateway Scripting Project and exit.
  5. Open a new project.
  6. Choose a Tag and configure a Tag Event Script on the Alarm Acknowledged event.
  7. You can call any function within the myFuncs library in your Gateway Scripting Project:

    Code Block
    myFuncs.thankYou(user = ackedBy)

    You do not need to specify the name of your Gateway Scripting Project when calling any of its functions.