PiXYZ STUDIO can run special plugins, to add custom functionalities and behavior.

A plugin is a kind of pre-defined process, that is based on Python scripts and executed through a custom User Interface.

Plugins for PiXYZ STUDIO can be developed by or for you.


There are 2 types of plugins in PiXYZ STUDIO:

  • Published Plugin
  • Unpublished plugin


NOTE                A PiXYZ STUDIO plugin (or scenario) is 100% customizable. Please contact PiXYZ Software if you are interested in the creation of a bespoke scenario, based on your specific Data Preparation process.


NOTE                These plugins can be used to run scenarios in batch mode (using a PiXYZ STUDIO.batch license).


Published Plugin

A published plugin, is an encapsulated, non-editable plugin that was created by a 3rd party, and ready to be installed and used. It comes as an archive file (*.pxzext file).

For the moment, a published plugin can be created by PiXYZ Software only, or its partners.


Unpublished Plugin

An unpublished plugin comes as a collection of files (python scripts, XML file,...) that define a plugin.

They can be developed directly by the user, following this topic: Creating a Plugin.


Default plugin

PiXYZ STUDIO comes with one default plugin, called Generate Proxy, for demonstration purposes.

It is listed in the last section of the Plugin Menu.

The files for this plugin are located here: C:\Program Files\PiXYZStudio\bin\plugins\GenerateProxy.


WARNING        Do not modify these files as it could modify the plugin's default behavior. If you wish to use it as a starting point for your own plugin, simply make a copy of the folder, and restart PiXYZ STUDIO.


Plugin folder locations

Plugins can be placed in several locations on a computer:

  • Program Files/PiXYZStudio/bin/plugins: folder where the default plugin Generate Proxy is located
  • %appdata%/PiXYZStudio/plugins: place a plugin folder here to restrain plugin access to the concerned user (see Creating a Plugin)
  • %programdata%/PiXYZStudio/plugins: place a plugin folder here for any computer user to be able to run it (see Creating a Plugin)


Related topics

Refer to the following topics for plugin creation and management: