It is possible to write your own Level Functions using Python, but first some definitions so we're on the same page.
Level Function
Level Functions define the job tree structure. As a typical tree structure, a Level Function may have a parent and/or children. Each Level Function is given jobs that match its parent and in turn hand down jobs that match itself to its children. If there is no parent, that is the Level Function is the root of the structure, then it processes all jobs. If there is no child Level Function then all jobs that match the Level Function become its children.
The function of a Level Function sorts jobs into different groups. The function runs on a per job basis (so be aware of performance issues) it is passed a single job at a time and returns the name of the group(s) it belongs to. By returning a list or tuple of strings a single job can appear in several groups. Group names are not set or stored anywhere, they are generated by the Level Functions themselves.
There are many built-in Level Functions, but you can also make your own custom levels using Python.
Level
A Level is what the Qube! UI calls the 'groups' referred to in the above Level Function definition.
Level name
A Level name is the text that is displayed in the tree structure at the Levels (branches of the tree). Level names are generated by the Level Function.
The Level Functions used within a particular structure act like ANDs, that is, for a job to be a leaf under a series of Level Functions it has to match all of them.
Creating a custom Level Function
As mentioned above, you can create your own custom Level Functions using Python.
- Click on the gear icon to the right of the Presets selector.
- In the dialog that appears select the "Level functions" tab.
- Add a new Level Function using the plus button a the bottom of the Level Function list.
- Double click on the new level function and give it a name, for this example call it "Submit Type".
- You will notice that in the code editor on the right a basic example of a Level Function is automatically filled.
- The Qube! UI pre-defines a variable job which you use to set another pre-defined variable level_name, you set it to either a string or list/tuple of strings.
Copy/paste the following text into the code editor.
Code Block theme Midnight linenumbers true language py if 'submitType' in job.packages().keys(): # If the job has a submitType value in it's package level_name = job.packages()['submitType'].value() # then set the level_name to the value of the submitType else: level_name = 'Unknown' # otherwise just set the level_name to Unknown- Close the dialog and add a Level to the job list.
- Using the Level Function selector choose your new level.
- Enjoy the fruits of your labor.
