Run Python Scripts inside Your Application

Required Permissions

This section requires the Application Designer permission from your Domain's administrator.

Check What are the Design Tasks? to learn more about permissions to work with Design Mode and other tools.

Learn how to create a Custom Action executing Python code inside your application.

Under certain scenarios, the Designer must execute complex operations that default eLegere's tools don't cover. In these cases, Designers can configure a Python Script as Custom Actions. When launched, an Invoke Python Script Custom Action execute the operations that the Designer has coded in Python language.

Warning

Your eLegere installation's admin decides whether to install Python and enable Invoke Python Script Custom Actions. Check with your administrator if Invoke Python Script Custom Actions are allowed on your current eLegere installation.

In case the administrator has enabled Invoke Python Script Custom Actions, they have prepared a dedicated folder to store the scripts to be launched.

If Python is enabled, the Python language version depends on what version the administrator has decided to install with eLegere.

The possibility exists to run a separated virtual environment for Python within your eLegere installation. Check the Configuring a Virtual Environment for Python in eLegere document to learn how. It's strongly recommended to avoid conflict among different package sets.

Note

This document assumes the knowledge of Python programming language. The document explains only how to configure Custom Action launching Python script inside an application.

Follow the steps below to create a Invoke Python Script Custom Action.

  1. In Design Mode, click on the icon in the upper-right corner of any panel.

    The action leads to the Custom Actions panel.

  2. Click on the Enable Module toggle switch to activate the Custom Actions in your application.

  3. Click on the New Action drop-down menu button.

  4. Choose the Invoke Python Script type from the list of Custom Actions types. This action creates a Invoke Python Script Custom Action.

    This action creates the Invoke Python Script Custom Action to be configured.

  5. Insert in the Info section the required information

    • (1) Name Insert a name for the Invoke Python Script Custom Action.
    • (2) Description optional Insert a description for the Invoke Python Script Custom Action.
    • (3) Manual If enabled, the Users launch this Custom Action manually. If disabled, choose at (4) Event a triggering condition to launch the Custom Action. (By default, the toggle switch is enabled.)
    • (4) Event If (3) Manual is disabled, choose a trigger condition from the drop-down list.
    Event - Triggering Options

    For the Event option, when the Manual toggle-switch is disabled, choose a moment when the Custom Action runs.

    PRE ROW INSERT Before inserting a row.

    POST ROW INSERT After a row's insertion.

    PRE ROW UPDATE Before any changes apply to a row.

    POST ROW UPDATE After having edited a row.

    PRE ROW DELETE Before deleting a row.

    POST ROW DELETE After having deleted the row.

    PRE ATTACHMENT INSERT Before uploading an attachment to a row.

    POST ATTACHMENT INSERT After having uploaded an attachment to a row.

    POST MASTER INSERT After having inserted a row on the Master table.

    POST MASTER UPDATE After having saved an edited row on the Master table.

    POST MASTER DELETE After having deleted a row on the Master table.

    • (5) Async Enable to run the Custom Action in the background instead of waiting for its completition to use the application. (By default, the Async toggle-switch is enabled when (3) Manual is enabled. Otherwise, the toggle-switch is disabled.)
    • (6) Execution optional Click to open the Formula Editor. Insert a Formula to define the conditions for executing the Custom Action.
    • (7) Visibility optional Click to open the Formula Editor. Insert a Formula to define the conditions to display the Custom Action in the application.
    • (8) Refresh optional If enabled, the application refreshes the data on the table when the Custom Action has finished to run.
    • (9) Icon optional Choose an icon for the Custom Action.
    • (10) Context Decide if the User launches the Custom Action from the Custom Actions drop-down menu in the application or from the Row's Options (). Disabled if (3) Manual is disabled.
    • (11) Table Choose the table where the Custom Action runs.

  6. In the Parameters section, choose the settings for the Invoke Python Script.

    • (1) Insert the path to the Python script in the folder that your administrator has prepared.
    • (2) Click on New to define a value for a key in the Invoke Python Script
    • (3) Click on the Reset button to clear all the values and keys from the Script Parameters section.

    Clicking on New inserts a couple of key and value. Insert in the line the key and the value from the application to be passed to the Invoke Python Script.

  7. This step is optional. Follow this step if you want to block the use of one application while the Invoke Python Script Custom Action is running.

    In the Application Lock, click on the Enabled toggle switch to enable the application's locking. (By default, Enabled is turned OFF.)

    Choose one or more applications from the drop-down list to lock while the Custom Action is running.

  8. When you have completed the configuration, click on the Save button () in the top-left corner to save the Invoke Python Script Custom Action.

Success

You have configured a Invoke Python Script as Custom Action in your application. The action will execute the Python code.

Tip

If you want to disable the Invoke Python Script Custom Action without deleting it from the Application, click on the toggle switch next to the Custom Action's name to hide it from the users.

Tip

If you want to delete a Invoke Python Script Custom Action, click on the Remove in the Info section.

A window will ask for confirmation. Click Yes to confirm the deletion. (Click No to abort the deletion.)

Click on the Save button () in the top-left corner to save the deletion.