You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.

The following feature is new in Ignition version 8.0.11
Click here to check out the other new features
This function is used in Python Scripting.

Description

Returns the name of the project where the function was called from. When called from the Gateway scope from a resource that originates from a singular project (reports, SFCs, etc.), will return that resources project.

Resources that run in the Gateway scope, but are configured in a singular project (such as a report), will use that project's name. 

When called from a scope that does not have an associated project (a Tag Event Script), the function will return the name of the Gateway scripting project. If a Gateway scripting project has not been configured, then returns an empty string. 

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.project.getProjectName()

  • Parameters

none

  • Returns

String The name of the currently running project.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code Snippet
# This code would display the name of the currently running project to the appropriate console, depending on scope (designer console, gateway console, etc.).
system.util.getLogger("myLogger").warn("You are running project: %s" % system.project.getProjectName())
Keywords

system project getprojectname, project.getprojectname

  • No labels