Specifications

The getApplicationLicensing entry point serves to provide feedback about the third-party
application licensing state through a context menu on the scripted plug-in’s icon in the Elements
pane.
Testing special properties and entry points
SwitchScripter does not emulate central management of these special properties and entry points.
However it does allow testing the special entry points just like any other entry points, and it
treats the properties as regular properties (so you can enter a value in the Fixture pane). Thus
SwitchScripter fully supports developing and testing these special features; see Testing a script
on page 342.
Configurator guidelines
This topic introduces the mechanisms used to develop a Switch configurator for a third-party
application and it offers guidelines for adjusting third-party applications so that they can be
optimally configured and controlled from within Switch.
Limited to scripting
Although many of the built-in Switch configurators have historically been developed in the C++
programming language, this topic discusses configurators solely in the context of scripting
because:
Third-party developers have access to the Switch scripting API and not to the C++ API.
All new Switch configurators (including those developed by Enfocus) use scripting.
Definition of a configurator
Refer to configurators for a description of the configurator concept and its benefits.
More formally, a configurator is a scripted plug-in that defines the findApplicationPath entry
point and the special property “ApplicationPath”. A configurator may (but does not have to) also
define the getApplicationLicensing entry point, the licenseApplication entry point, and/or the
special property “ApplicationLicense”.
See entry points for Application discovery on page 348 and Application licensing on page 348,
Creating a scripted plug-in on page 345, and Obtaining permission on page 344.
For the avoidance of doubt:
• A script package assigned to a script element is not a configurator; its application discovery
entry points are never invoked and its special properties behave as regular properties.
• A flow element implementation that does not define the findApplicationPath entry point is
not a configurator.
• It is an error for a flow element implementation to define the findApplicationPath entry point
while not defining the special property “ApplicationPath” (because the flow implementation
would have no access to the application path it claims to require).
• It is meaningless (but not an error) for a flow element implementation to define the
getApplicationLicensing or licenseApplication entry points without defining the
findApplicationPath entry point since in that case the entry points will never be invoked.
• It is meaningless (but not an error) for a configurator to define the “ApplicationLicense”
property without defining the licenseApplication entry point since in that case the property
will never receive a value (there is no license context menu and the property is hidden).
347
Enfocus Switch 10