Manage the Script Executors in your organization.
Loading...
Loading...
Loading...
Loading...
Delete a Script Executor.
When a Script Executor is deleted, all Scripts that run during a Request fail. Process designers that have developed Scripts configured to use a deleted Script Executor are not notified of that Script Executor's deletion. When a Process designer reviews or edits the Script configuration settings for a Script configured to use a deleted Script Executor, that Script Executor does not display from the Language setting. Therefore, take caution when deleting a Script Executor.
Deleting a Script Executor from the Script Executors page cannot be undone.
Follow these steps to delete a Script Executor:
View your Script Executors. The Script Executors page displays.
Click Confirm.
Edit a Script Executor.
Follow these steps to edit a Script Executor:
Edit the following information about the Script Executor as necessary:
In the Name setting, edit the unique name for the Script Executor. This name displays from Script configuration settings, so enter a descriptive name that Process designers configuring their Scripts understand what customization this Script Executor provides. For example, if specific third-party classes have been appended to the Script Executor that provide access to that third-party's API or SDK, enter a name that ProcessMaker designers developing their Scripts understand how they can best use this Script Executor.
In the Description setting, edit the description for the Script Executor.
From the Language setting, select one of the following programming languages that the Script Executor uses to run Scripts:
PHP
Lua
JavaScript
Click Save and Build to build the Docker container from which the Script Executor runs Scripts. The Build Command Output setting displays below the Dockerfile setting as the Script Executor builds the Docker container in real-time. If the Docker container builds successfully, the following message displays: Executor Successfully Built. You can now close this window. If building the Docker container is unsuccessful, the following message displays: Error Building Executor. See Output Above.. The Build Command Output setting displays the Dockerfile error.
Click Close.
Click the Delete iconfor the Script Executor to delete. The Caution screen displays to confirm the deletion of the Script Executor.
. The Script Executors page displays.
Click the Edit iconfor the Script Executor to edit. The Script Executor settings display.
C# (requires the )
Java (requires the )
Python (requires the )
R (requires the )
After selecting a programming language, the default content to run Scripts using that language displays in the Dockerfile setting. The Dockerfile content includes the SDK for that language.
From the Dockerfile setting, append the default Dockerfile content with the the Script Executor runs when it builds the Docker container. Consider following . Do not edit the default Dockerfile content as this is necessary to run Scripts successfully in a Docker container using the selected programming language.
View the Script Executors in your organization.
ProcessMaker Platform displays all Script Executors in one location. Any Script Executor developed by any Administrator can be used in any Process model. This makes it easy to manage Scripts.
Follow these steps to view all Script Executors in your organization:
Log on to ProcessMaker Platform.
Click the Admin option from the top menu. The Users page displays.
The Script Executors page displays the following information in tabular format about Script Executors:
Language: The Language column displays for which Scripts the Script Executor runs based on its programming language.
Title: The Title column displays the name of the Script Executor.
Modified: The Modified column displays the date and time the Script Executor was last modified. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
ProcessMaker Platform provides the following Script Executors. Note that specific Script Executors require specific packages.
C# Executor: This is the default Script Executor to run Scripts developed using C#. Note that if the C# package is not installed, this Script Executor is not available.
Java Executor: This is the default Script Executor to run Scripts developed using Java. Note that if the Java package is not installed, this Script Executor is not available.
Node Executor: This is the default Script Executor to run Scripts developed using JavaScript.
LUA Executor: This is the default Script Executor to run Scripts developed using Lua.
Python Executor: This is the default Script Executor to run Scripts developed using Python. Note that if the Python package is not installed, this Script Executor is not available.
R Executor: This is the default Script Executor to run Scripts developed using R. Note that if the R package is not installed, this Script Executor is not available.
Click the +Script Executor button. See Create a New Script Executor.
Control how tabular information displays, including how to sort columns or how many items display per page.
Click the Script Executors icon from the left sidebar. The Script Executors page displays all Script Executors.
Click the Edit icon. See Edit a Script Executor.
Click the Delete icon. See Delete a Script Executor.
Create a Script Executor from which to run Scripts.
To create a new Script Executor is to build a new Docker container using a supported programming language from which the Script Executor runs Scripts. See a design example.
Follow these steps to create a new Script Executor:
View your Script Executors. The Script Executors page displays.
In the Name setting, enter the unique name for the Script Executor. This name displays from Script configuration settings, so enter a descriptive name that Process designers configuring their Scripts understand what customization this Script Executor provides. For example, if specific third-party classes have been appended to the Script Executor that provide access to that third-party's API or SDK, enter a name that Process designers developing their Scripts understand how they can best use this Script Executor.
In the Description setting, enter a description for the Script Executor.
From the Language setting, select one of the following programming languages that the Script Executor uses to run Scripts:
PHP
Lua
JavaScript
C# (requires the C# package)
Java (requires the Java package)
Python (requires the Python package)
R (requires the R package)
After selecting a programming language, the default Dockerfile content to run Scripts using that language displays in the Dockerfile setting. The Dockerfile content includes the SDK for that language.
From the Dockerfile setting, append the default Dockerfile content with the Docker commands the Script Executor runs when it builds the Docker container. Consider following best practices for writing Dockerfiles. Do not edit the default Dockerfile content as this is necessary to run Scripts successfully in a Docker container using the selected programming language.
Click Save and Build to build the Docker container from which the Script Executor runs Scripts. The Build Command Output setting displays below the Dockerfile setting as the Script Executor builds the Docker container in real-time. If the Docker container builds successfully, the following message displays: Executor Successfully Built. You can now close this window. If building the Docker container is unsuccessful, the following message displays: Error Building Executor. See Output Above.. The Build Command Output setting displays the Dockerfile error.
Click Close.
See an example in the following video how to use a Script Executor that includes a Docker RUN
command to package the Google Client class provided by Google into that Script Executor, thereby allowing Scripts using that Script Executor to successfully call the Google API.
Intended audience: Administrators, software developers, and coding engineers
Viewing time: 3 minutes; contains narration
Click the +Script Executor button. The Add New Script Executor screen displays.